diff --git a/.clang-format b/.clang-format new file mode 100644 index 000000000..92735a1c7 --- /dev/null +++ b/.clang-format @@ -0,0 +1,74 @@ +--- +Language: Json +DisableFormat: true +--- +BasedOnStyle: WebKit +Language: Cpp +Standard: Cpp11 + +IndentWidth: 4 +SpacesBeforeTrailingComments: 1 +TabWidth: 8 +UseTab: Never +ContinuationIndentWidth: 4 +MaxEmptyLinesToKeep: 3 +BreakBeforeBinaryOperators: NonAssignment +BreakBeforeTernaryOperators: true +BreakConstructorInitializers: BeforeColon +BreakConstructorInitializersBeforeComma: true + +BreakBeforeBraces: Custom +BraceWrapping: + AfterClass: true + AfterControlStatement: false + AfterEnum: true + 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: true +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/.cmake-format.py b/.cmake-format.py new file mode 100644 index 000000000..d0101f7ef --- /dev/null +++ b/.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 + # 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 + use_tabchars = False + + # If 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/.codespellrc b/.codespellrc new file mode 100644 index 000000000..7f8bba7d5 --- /dev/null +++ b/.codespellrc @@ -0,0 +1,4 @@ +[codespell] +skip = *.wsdl,*.xsd,*.XSD,*.ts,./kdwsdl2cpp/libkode,./build-*,.git +interactive = 3 +ignore-words-list = crosssite,statics diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 000000000..07c5bc4a8 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,11 @@ +# SPDX-FileCopyrightText: 2026 Klarälvdalens Datakonsult AB, a KDAB Group company +# +# SPDX-License-Identifier: MIT + +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "daily" + open-pull-requests-limit: 5 diff --git a/.github/workflows/build-sanitizers.yml b/.github/workflows/build-sanitizers.yml new file mode 100644 index 000000000..6aabe0379 --- /dev/null +++ b/.github/workflows/build-sanitizers.yml @@ -0,0 +1,57 @@ +# SPDX-FileCopyrightText: 2023 Klarälvdalens Datakonsult AB, a KDAB Group company +# +# SPDX-License-Identifier: MIT + +name: CI (Sanitizers) + +on: + push: + branches: + - master + pull_request: + branches: + - master + +jobs: + build: + runs-on: ${{ matrix.os }} + strategy: + fail-fast: true + matrix: + os: + - ubuntu-24.04 + preset: ['dev-asan'] + include: + - preset: dev-asan + qt-flavor: asan_ubsan + steps: + - name: Checkout sources + uses: actions/checkout@v6 + + - name: Fetch Git submodule + run: git submodule update --init --recursive + + - name: Setup Sanitized Qt + uses: KDABLabs/sanitized-qt-action@v1 + with: + qt-tag: "v6.11.0-beta2" + qt-flavor: ${{ matrix.qt-flavor }} + + - name: Configure project + run: > + cmake --preset=${{ matrix.preset }} + -DKDSoap_QT6=ON + -DKDSoap_STATIC=ON + -DKDSoap_TESTS=ON + -DKDSoap_EXAMPLES=OFF + -DKDSoap_DOCS=OFF + + - name: Build Project + run: cmake --build ./build-${{ matrix.preset }} + + - name: Run tests on Linux (offscreen) + run: > + ctest --test-dir ./build-${{ matrix.preset }} --output-on-failure + -E 'kdsoap-test_wsdl_rpc' + env: + QT_QPA_PLATFORM: offscreen diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 000000000..b37b8312e --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,108 @@ +# SPDX-FileCopyrightText: 2023 Klarälvdalens Datakonsult AB, a KDAB Group company +# +# SPDX-License-Identifier: MIT + +name: CI + +on: + push: + branches: + - master + - kdsoap-2.1 + - kdsoap-2.2 + pull_request: + branches: + - master + - kdsoap-2.1 + - kdsoap-2.2 + workflow_dispatch: + +jobs: + build: + runs-on: ${{ matrix.os }} + strategy: + fail-fast: true + matrix: + os: + - ubuntu-22.04 + - windows-2022 + - macos-latest + + build_type: + - Debug + - Release + + link_type: + - static + - shared + + config: + - qt_version: "5.15" + - qt_version: "6.5.*" + - qt_version: "6.10.*" # Bump to latest freely + + exclude: + # There's no ARM binaries for Qt 5.15 via aqtinstall + - os: macos-latest + config: + qt_version: "5.15" + + steps: + - name: Install Qt with options and default aqtversion + uses: jurplel/install-qt-action@v4 + with: + aqtversion: null # use whatever the default is + modules: ${{ matrix.config.modules }} + version: ${{ matrix.config.qt_version }} + cache: true + + - name: Checkout sources + uses: actions/checkout@v6 + + - name: Fetch Git submodule + run: git submodule update --init --recursive + + - 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 + if: ${{ runner.os == 'Windows' }} + uses: ilammy/msvc-dev-cmd@v1 + + - name: Configure project + run: > + cmake -S . -B ./build -G Ninja + --warn-uninitialized -Werror=dev + -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} + -DKDSoap_QT6=${{ startsWith(matrix.config.qt_version, '6.') }} + -DKDSoap_STATIC=${{ matrix.build_type == 'static' }} + -DKDSoap_TESTS=${{ matrix.build_type == 'Debug' }} + -DKDSoap_EXAMPLES=${{ matrix.build_type == 'Debug' }} + -DKDSoap_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 + -E 'kdsoap-test_wsdl_rpc' + env: + QT_QPA_PLATFORM: offscreen + + - name: Run tests on Windows + if: ${{ matrix.build_type == 'Debug' && runner.os == 'Windows' }} + run: ctest --test-dir ./build -C ${{ matrix.build_type }} --output-on-failure + + - 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 + -E 'kdsoap-test_serverlib|kdsoap-test_wsdl_document' + + - 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/.github/workflows/create_release.yml b/.github/workflows/create_release.yml new file mode 100644 index 000000000..fd7b3fce5 --- /dev/null +++ b/.github/workflows/create_release.yml @@ -0,0 +1,48 @@ +# SPDX-FileCopyrightText: 2026 Klarälvdalens Datakonsult AB, a KDAB Group company +# +# SPDX-License-Identifier: MIT + +name: Create release + +on: + workflow_dispatch: + inputs: + sha1: + type: string + required: true + description: "sha1 to be tagged" + version: + type: string + required: true + description: "Desired numeric version (without any prefix/suffix)" + +permissions: + contents: write + actions: write + +jobs: + create_release: + runs-on: ubuntu-24.04 + steps: + - name: Checkout sources + uses: actions/checkout@v6 + with: + fetch-depth: 0 + + - name: Checkout CI tools + uses: actions/checkout@v6 + with: + repository: KDABLabs/ci-release-tools + path: ci-release-tools + ref: main + + - name: Setup git author name + run: | + git config --global user.email "github_actions@kdab" + git config --global user.name "KDAB GitHub Actions" + + - name: Create release + run: | + python3 ci-release-tools/src/create_release.py --repo KDSoap --version ${{ github.event.inputs.version }} --sha1 ${{ github.event.inputs.sha1 }} --repo-path . + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 000000000..2b9ea039b --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,69 @@ +# SPDX-FileCopyrightText: 2024 Klarälvdalens Datakonsult AB, a KDAB Group company +# +# SPDX-License-Identifier: MIT + +name: Deploy doxygen to GitHub Pages + +on: + push: + branches: + - kdsoap-2.2 + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Install Dependencies on Linux + run: | + sudo apt update -qq + sudo apt install -y doxygen + + - name: Install Qt + uses: jurplel/install-qt-action@v4 + with: + aqtversion: null # use whatever the default is + version: 5.15.2 + cache: true + + - name: Checkout sources + uses: actions/checkout@v6 + with: + submodules: recursive + + - name: Configure project + run: > + cmake -S . -B ./build -DKDSoap_DOCS=ON + + - name: Create docs + run: cmake --build ./build --target docs + + - name: Upload artifact + uses: actions/upload-pages-artifact@v4 + with: + path: build/docs/api/html/ + + # Deployment job, what was uploaded to artifact + deploy: + needs: build + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.github/workflows/tidyclazy.yml b/.github/workflows/tidyclazy.yml new file mode 100644 index 000000000..0b9b4a1a7 --- /dev/null +++ b/.github/workflows/tidyclazy.yml @@ -0,0 +1,71 @@ +# SPDX-FileCopyrightText: 2023 Klarälvdalens Datakonsult AB, a KDAB Group company +# +# SPDX-License-Identifier: MIT + +name: Tidy / Clazy / cppcheck + +on: + push: + branches: + - master + - kdsoap-2.1 + - kdsoap-2.2 + pull_request: + branches: + - master + - kdsoap-2.1 + - kdsoap-2.2 + +jobs: + build: + runs-on: ${{ matrix.os }} + strategy: + fail-fast: true + matrix: + os: + - ubuntu-latest + + config: + - name: clang-tidy + preset: "clang-tidy" + qt_version: "6.6" + + - name: clazy + preset: "clazy" + qt_version: "6.6" + apt_pgks: + - clazy + - cppcheck + + steps: + - name: Install Qt ${{ matrix.config.qt_version }} with options and default aqtversion + uses: jurplel/install-qt-action@v4 + with: + version: ${{ matrix.config.qt_version }} + cache: true + + - name: Install ninja-build tool (must be after Qt due PATH changes) + uses: turtlesec-no/get-ninja@main + + - name: Install dependencies on Ubuntu (${{ join(matrix.config.apt_pgks, ' ') }}) + if: ${{ runner.os == 'Linux' && matrix.config.apt_pgks }} + run: | + sudo apt update -qq + echo ${{ join(matrix.config.apt_pgks, ' ') }} | xargs sudo apt install -y + + - name: Checkout sources + uses: actions/checkout@v6 + + - name: Fetch Git submodules + run: git submodule update --init --recursive + + - name: Configure project + run: > + cmake --preset=${{ matrix.config.preset }} + + - name: Build Project + run: cmake --build --preset=${{ matrix.config.preset }} + + - name: Run cppcheck + if: ${{ matrix.config.preset == 'clazy' }} + run: cmake --build --preset=${{ matrix.config.preset }} --target cppcheck diff --git a/.gitignore b/.gitignore index 2802c2d95..fadc399b7 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,11 @@ Makefile +Makefile.* +*.pro.user +*.pro.user* +*.so +*.so.* +*.exe +moc_* *.moc *.obj *.directory @@ -7,14 +14,20 @@ lib bin generated .qmake.cache +.cache CMakeLists.txt.user +CMakeUserPresets.json _moc _obj +*.o .license.accepted CPackConfig.cmake autogen.pyc configure.bat configure.sh +.qmake.stash + +/build /include @@ -56,4 +69,5 @@ configure.sh /unittests/enum_escape/enum_escape /unittests/literal_true_false/literal_true_false /unittests/msexchange_noservice_wsdl/msexchange_noservice_wsdl - +/build-* +compile_commands.json diff --git a/.gitmodules b/.gitmodules index 9f4864d54..5ef7e3feb 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,3 @@ -[submodule "autogen"] - path = autogen - url = https://github.com/KDAB/autogen.git +[submodule "kdwsdl2cpp/libkode"] + path = kdwsdl2cpp/libkode + url = https://github.com/cornelius/libkode diff --git a/.krazy b/.krazy index d2121dc18..1c95fd027 100644 --- a/.krazy +++ b/.krazy @@ -1,28 +1,31 @@ -CHECKSETS qt4,c++,foss - -#exclude intrusive checks to investigate later -EXCLUDE constref,dpointer,inline,null,doublequote_chars +CHECKSETS qt5,c++,foss #KDAB-specific checks -EXTRA kdabcopyright +EXTRA kdabcopyright-reuse,fosslicense-reuse -#additional checks -EXTRA defines,null +#exclude checks now being done by clazy or clang-tools +EXCLUDE includes,strings,explicit,normalize,passbyvalue,operators,nullstrcompare,nullstrassign,doublequote_chars,qobject,sigsandslots,staticobjects,cpp +#exclude more checks +EXCLUDE qminmax,captruefalse,dpointer,inline,constref +#exclude spelling as codespell is much, much better tool +#too many false positives +EXCLUDE insecurenet +EXCLUDE spelling +EXCLUDE style #if you have a build subdir, skip it SKIP /build- -#no need to check 3rdparty stuff + +#skip 3rdparty +SKIP /libkode/ SKIP /kdwsdl2cpp/ -#skip autogen buildsystem -SKIP /autogen/|/autogen.py|/genignore.py -#nor examples -SKIP /examples/ -#nor testtools -SKIP /testtools/ -#skip generated headers -SKIP /include/ -#skip generated cmake -SKIP KDSoapConfig\.cmake\.in +SKIP /KDQName\.cpp|/KDQName\.h + +#skip scripts +SKIP /scripts/ +#skip other cmake +SKIP Doxyfile.cmake +SKIP \.cmake-format\.py #skip the borrowed code in the cmake subdir -SKIP /cmake/WriteBasicConfigVersionFile.cmake|/cmake/CMakePackageConfigHelpers.cmake|/cmake/InstallLocation.cmake|/cmake/InstallLocation.cmake|/cmake/Qt5Portability.cmake|/cmake/ECMGenerateHeaders.cmake +SKIP cmake/ECM|/cmake/KDAB/ diff --git a/.mdlrc b/.mdlrc new file mode 100644 index 000000000..3acbfecaa --- /dev/null +++ b/.mdlrc @@ -0,0 +1 @@ +style ".mdlrc.rb" diff --git a/.mdlrc.rb b/.mdlrc.rb new file mode 100644 index 000000000..3f9b24889 --- /dev/null +++ b/.mdlrc.rb @@ -0,0 +1,5 @@ +all +rule 'MD013', :line_length => 100, :tables => false +rule 'MD029', :style => :ordered +exclude_rule 'MD033' +exclude_rule 'MD041' diff --git a/.pep8 b/.pep8 new file mode 100644 index 000000000..9d54e0f10 --- /dev/null +++ b/.pep8 @@ -0,0 +1,2 @@ +[pycodestyle] +max_line_length = 120 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 000000000..f1d51decf --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,57 @@ +# See https://pre-commit.com for more information +# See https://pre-commit.com/hooks.html for more hooks + +ci: + autoupdate_schedule: monthly + +exclude: ^(cmake/ECM/|cmake/KDAB/|docs/api/doxygen-awesome.css) +repos: +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v6.0.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 + - id: check-symlinks + - id: destroyed-symlinks + - id: check-executables-have-shebangs +- repo: https://github.com/pre-commit/mirrors-clang-format + rev: v21.1.0 + hooks: + - id: clang-format +- repo: https://github.com/PyCQA/pylint + rev: v3.3.8 + hooks: + - id: pylint + exclude: ^(.cmake-format.py|conan/conanfile.py|scripts/genignore.py) +- repo: https://github.com/hhatto/autopep8 + rev: v2.3.2 + hooks: + - id: autopep8 + exclude: ^(.cmake-format.py|conan/conanfile.py) +- repo: https://github.com/codespell-project/codespell + rev: v2.4.1 + 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: v5.0.2 + hooks: + - id: reuse-lint-file diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 000000000..012925252 --- /dev/null +++ b/.pylintrc @@ -0,0 +1,596 @@ +[MASTER] + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. +extension-pkg-whitelist= + PyKDReports.KDReports, PyKDReportsQt6.KDReports, + PySide2.QtCore,PySide2.QtWidgets,PySide2.QtGui,PySide2.QtPrintSupport, + PySide6.QtCore,PySide6.QtWidgets,PySide6.QtGui,PySide6.QtPrintSupport + +# Specify a score threshold to be exceeded before program exits with error. +fail-under=10.0 + +# Add files or directories to the blacklist. They should be base names, not +# paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the blacklist. The +# regex matches against base names, not paths. +ignore-patterns=rc_assets.py,genignore.py + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use. +jobs=1 + +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python module names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED. +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable=print-statement, + parameter-unpacking, + unpacking-in-except, + old-raise-syntax, + backtick, + long-suffix, + old-ne-operator, + old-octal-literal, + import-star-module-level, + non-ascii-bytes-literal, + raw-checker-failed, + bad-inline-option, + locally-disabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + use-symbolic-message-instead, + apply-builtin, + basestring-builtin, + buffer-builtin, + cmp-builtin, + coerce-builtin, + execfile-builtin, + file-builtin, + long-builtin, + raw_input-builtin, + reduce-builtin, + standarderror-builtin, + unicode-builtin, + xrange-builtin, + coerce-method, + delslice-method, + getslice-method, + setslice-method, + no-absolute-import, + old-division, + dict-iter-method, + dict-view-method, + next-method-called, + metaclass-assignment, + indexing-exception, + raising-string, + reload-builtin, + oct-method, + hex-method, + nonzero-method, + cmp-method, + input-builtin, + round-builtin, + intern-builtin, + unichr-builtin, + map-builtin-not-iterating, + zip-builtin-not-iterating, + range-builtin-not-iterating, + filter-builtin-not-iterating, + using-cmp-argument, + eq-without-hash, + div-method, + idiv-method, + rdiv-method, + exception-message-attribute, + invalid-str-codec, + sys-max-int, + bad-python3-import, + deprecated-string-function, + deprecated-str-translate-call, + deprecated-itertools-function, + deprecated-types-field, + next-method-defined, + dict-items-not-iterating, + dict-keys-not-iterating, + dict-values-not-iterating, + deprecated-operator-function, + deprecated-urllib-function, + xreadlines-attribute, + deprecated-sys-function, + exception-escape, + comprehension-escape, + consider-using-f-string, + R0801,I1101,E0401 + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable=c-extension-no-member= + + +[REPORTS] + +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'error', 'warning', 'refactor', and 'convention' +# which contain the number of messages in each category, as well as 'statement' +# which is the total number of statements analyzed. This score is used by the +# global evaluation report (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +#msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=8 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit + + +[BASIC] + +# Naming style matching correct argument names. +argument-naming-style=camelCase + +# Regular expression matching correct argument names. Overrides argument- +# naming-style. +#argument-rgx= + +# Naming style matching correct attribute names. +attr-naming-style=camelCase + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= + +# Naming style matching correct class attribute names. +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. +#class-attribute-rgx= + +# Naming style matching correct class names. +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming- +# style. +#class-rgx= + +# Naming style matching correct constant names. +const-naming-style=camelCase + +# Regular expression matching correct constant names. Overrides const-naming- +# style. +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names. +function-naming-style=camelCase + +# Regular expression matching correct function names. Overrides function- +# naming-style. +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _ + +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs=^[a-z]?$ + +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no + +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. +#inlinevar-rgx= + +# Naming style matching correct method names. +method-naming-style=any + +# Regular expression matching correct method names. Overrides method-naming- +# style. +#method-rgx= + +# Naming style matching correct module names. +module-naming-style=any + +# Regular expression matching correct module names. Overrides module-naming- +# style. +#module-rgx= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty + +# Naming style matching correct variable names. +variable-naming-style=camelCase + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. +#variable-rgx="[a-z0-9_]{1,30}$" + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=120 + +# Maximum number of lines in a module. +max-module-lines=1000 + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[LOGGING] + +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes= + +# Regular expression of note tags to take in consideration. +#notes-rgx= + + +[SIMILARITIES] + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=yes + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. Available dictionaries: en_AG (hunspell), en_AU +# (hunspell), en_BS (hunspell), en_BW (hunspell), en_BZ (hunspell), en_CA +# (hunspell), en_DK (hunspell), en_GB (hunspell), en_GH (hunspell), en_HK +# (hunspell), en_IE (hunspell), en_IN (hunspell), en_JM (hunspell), en_MW +# (hunspell), en_NA (hunspell), en_NG (hunspell), en_NZ (hunspell), en_PH +# (hunspell), en_SG (hunspell), en_TT (hunspell), en_US (hunspell), en_ZA +# (hunspell), en_ZM (hunspell), en_ZW (hunspell). +spelling-dict= + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=no + +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members=.*connect + +# Tells whether missing members accessed in mixin class should be ignored. A +# mixin class is detected if its name ends with "mixin" (case insensitive). +ignore-mixin-members=yes + +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis). It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + +# List of decorators that change the signature of a decorated function. +signature-mutators= + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io + + +[CLASSES] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + __post_init__ + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=cls + + +[DESIGN] + +# Maximum number of arguments for function / method. +max-args=10 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=6 + +# Maximum number of branch for function / method body. +max-branches=20 + +# Maximum number of locals for function / method body. +max-locals=25 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=100 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[IMPORTS] + +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules=optparse,tkinter.tix + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled). +ext-import-graph= + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled). +import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled). +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "BaseException, Exception". +overgeneral-exceptions=BaseException, + Exception diff --git a/CMakeLists.txt b/CMakeLists.txt index 7be413fae..caf9c84b4 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,179 +1,341 @@ +# This file is part of the KD Soap project. +# +# SPDX-FileCopyrightText: 2012 Klarälvdalens Datakonsult AB, a KDAB Group company +# +# SPDX-License-Identifier: MIT +# + # This is the top-level CMakeLists.txt file for the KDSoap project. # # Pass the following variables to cmake to control the build: -# (See INSTALL-cmake.txt for more information) +# (See INSTALL.txt for more information) +# +# -DKDSoap_QT6=[true|false] +# Build against Qt6 rather than Qt5 +# Default=true # -# -DKDSoap_ENFORCE_QT4_BUILD=[true|false] -# Force building against Qt4, even if Qt5 is found. +# -DKDSoap_STATIC=[true|false] +# Build static libraries # Default=false # # -DKDSoap_TESTS=[true|false] # Build the test harness. # Default=false # -cmake_minimum_required(VERSION 2.8.7) -cmake_policy(SET CMP0020 NEW) +# -DKDSoap_EXAMPLES=[true|false] +# Build the examples. +# Default=true +# +# -DKDSoap_DOCS=[true|false] +# Build the API documentation. Enables the 'docs' build target. +# Default=false +# -if("${CMAKE_INSTALL_PREFIX}" STREQUAL "") - set(USE_DEFAULT_INSTALL_LOCATION True) -else() - set(USE_DEFAULT_INSTALL_LOCATION False) +cmake_minimum_required(VERSION 3.12) + +if(NOT EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/kdwsdl2cpp/libkode/common") + message(FATAL_ERROR "Please do git submodule update --init --recursive") endif() -project(KDSoap CXX) +# Allow using a non-KDAB install location. +set(KDAB_INSTALL + True + CACHE INTERNAL "Install to default KDAB Location" +) +if(DEFINED CMAKE_INSTALL_PREFIX) + if(NOT "${CMAKE_INSTALL_PREFIX}" STREQUAL "") + set(KDAB_INSTALL + False + CACHE INTERNAL "Install to non-KDAB Location" + ) + endif() +endif() -option( - ${PROJECT_NAME}_ENFORCE_QT4_BUILD - "Enable if you want to enforce a build with Qt4" - OFF +project( + KDSoap + DESCRIPTION "A Qt-based client-side and server-side SOAP component" + HOMEPAGE_URL "https://github.com/KDAB/KDSoap" + LANGUAGES CXX ) -if(CMAKE_VERSION VERSION_LESS "3.1") - if(CMAKE_COMPILER_IS_GNUCXX) - set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11") - endif () -else() - set(CMAKE_CXX_STANDARD 11) -endif() +file(STRINGS version.txt KDSOAP_VERSION_FILE) +list(GET KDSOAP_VERSION_FILE 0 ${PROJECT_NAME}_VERSION) + +string(REPLACE "." ";" KDSOAP_VERSION_LIST "${${PROJECT_NAME}_VERSION}") +list(GET KDSOAP_VERSION_LIST 0 ${PROJECT_NAME}_VERSION_MAJOR) +list(GET KDSOAP_VERSION_LIST 1 ${PROJECT_NAME}_VERSION_MINOR) +list(GET KDSOAP_VERSION_LIST 2 ${PROJECT_NAME}_VERSION_PATCH) + +set(PROJECT_VERSION ${${PROJECT_NAME}_VERSION}) #needed for ECM +set(${PROJECT_NAME}_SOVERSION ${${PROJECT_NAME}_VERSION_MAJOR}) -set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/ ${CMAKE_MODULE_PATH}") +include(FeatureSummary) option(${PROJECT_NAME}_STATIC "Build statically" 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}_QT6 "Build against Qt 6" ON) -set(${PROJECT_NAME}_VERSION_MAJOR 1) -set(${PROJECT_NAME}_VERSION_MINOR 7) -set(${PROJECT_NAME}_VERSION_PATCH 50) -set(${PROJECT_NAME}_VERSION ${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR}.${${PROJECT_NAME}_VERSION_PATCH}) -list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake) +list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/ECM/modules") +list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/KDAB/modules") -# setup default install locations -include(InstallLocation) - -# try Qt5 first, and prefer that (if found), but only if not disabled via option -if(NOT ${PROJECT_NAME}_ENFORCE_QT4_BUILD) - find_package(Qt5Core QUIET) -endif() - -if(Qt5Core_FOUND) - find_package(Qt5Network REQUIRED) - find_package(Qt5Widgets CONFIG) - set(QT_LIBRARIES Qt5::Core) - set(QT_USE_FILE "${CMAKE_CURRENT_SOURCE_DIR}/cmake/Qt5Portability.cmake") - - if(Qt5_POSITION_INDEPENDENT_CODE) - if(CMAKE_VERSION VERSION_LESS 2.8.9) - set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fPIC") - elseif(NOT CMAKE_VERSION VERSION_LESS 2.8.11) - if(Qt5Core_VERSION VERSION_LESS 5.1) - set_property(TARGET Qt5::Core PROPERTY INTERFACE_POSITION_INDEPENDENT_CODE ON) - endif() - else() - set(CMAKE_POSITION_INDEPENDENT_CODE ON) +include(ECMEnableSanitizers) + +# 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(CMAKE_COMPILE_WARNING_AS_ERROR) + # These -Wno-error flags are here to enable -Werror for clazy in CI + # it doesn't mean we endorse those warnings. + # MSVC is untested and probably will have a few hundered errors + if(CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang") + add_compile_options(-Wno-error=deprecated-declarations) + if(CMAKE_CXX_COMPILER_ID STREQUAL "Clang") + add_compile_options(-Wno-error=documentation -Wno-error=unused-private-field -Wno-error=c++20-extensions) + endif() endif() - endif() +endif() +if(${PROJECT_NAME}_QT6) + set(QT_VERSION_MAJOR 6) + set(QT_MIN_VERSION "6.0.0") + find_package(Qt6 ${QT_MIN_VERSION} CONFIG REQUIRED COMPONENTS Core Network) + list(APPEND QT_LIBRARIES Qt6::Core Qt6::Network) + set(${PROJECT_NAME}_LIBRARY_QTID "-qt6") + set(libkode_QT6 ON) else() - find_package(Qt4 4.7 QUIET REQUIRED QtCore QtMain) + set(QT_VERSION_MAJOR 5) + # Qt 5.9 required for QNetworkRequest::NoLessSafeRedirectPolicy + set(QT_MIN_VERSION "5.9.0") + find_package(Qt5 ${QT_MIN_VERSION} CONFIG REQUIRED COMPONENTS Core Network) + list(APPEND QT_LIBRARIES Qt5::Core Qt5::Network) + set(${PROJECT_NAME}_LIBRARY_QTID "") +endif() +include(KDQtInstallPaths) #to set QT_INSTALL_FOO variables + +find_path(BOOST_OPTIONAL_DIR NAMES boost/optional.hpp) +if(BOOST_OPTIONAL_DIR) + message(STATUS "Found boost/optional.hpp in ${BOOST_OPTIONAL_DIR}") + include_directories(${BOOST_OPTIONAL_DIR}) endif() set(CMAKE_INCLUDE_CURRENT_DIR TRUE) set(CMAKE_AUTOMOC TRUE) +set(CMAKE_AUTORCC ON) -add_definitions(-DQT_NO_CAST_TO_ASCII -DQT_NO_CAST_FROM_ASCII -DQT_NO_CAST_FROM_BYTEARRAY) -add_definitions(-DUSE_EXCEPTIONS -DQT_FATAL_ASSERT) +set(CMAKE_CXX_STANDARD 17) +set(CMAKE_CXX_STANDARD_REQUIRED ON) + +# Default to hidden visibility for symbols +set(CMAKE_C_VISIBILITY_PRESET hidden) +set(CMAKE_CXX_VISIBILITY_PRESET hidden) +set(CMAKE_VISIBILITY_INLINES_HIDDEN 1) + +include(KDCompilerFlags) + +add_definitions(-DQT_NO_CAST_TO_ASCII -DQT_NO_CAST_FROM_ASCII -DQT_NO_CAST_FROM_BYTEARRAY -DQURL_NO_CAST_FROM_STRING) +add_definitions(-DUSE_EXCEPTIONS -DQT_FATAL_ASSERT -DQT_NO_FOREACH) if(MSVC) - add_definitions(-D_SCL_SECURE_NO_WARNINGS) + add_definitions(-D_SCL_SECURE_NO_WARNINGS) endif() if(${PROJECT_NAME}_STATIC) - set(${PROJECT_NAME}_LIBRARY_MODE "STATIC") + set(${PROJECT_NAME}_LIBRARY_MODE "STATIC") else() - set(${PROJECT_NAME}_LIBRARY_MODE "SHARED") + set(${PROJECT_NAME}_LIBRARY_MODE "SHARED") +endif() + +if(KDAB_INSTALL) + if(UNIX) + set(CMAKE_INSTALL_PREFIX + "/usr/local/KDAB/${PROJECT_NAME}-${${PROJECT_NAME}_VERSION}" + CACHE INTERNAL "Install to default KDAB Location" + ) + elseif(WIN32) + set(CMAKE_INSTALL_PREFIX + "C:\\KDAB\\${PROJECT_NAME}-${${PROJECT_NAME}_VERSION}" + CACHE INTERNAL "Install to default KDAB Location" + ) + endif() endif() +# setup default install locations +include(KDInstallLocation) + if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR) - set(${PROJECT_NAME}_IS_ROOT_PROJECT TRUE) + set(${PROJECT_NAME}_IS_ROOT_PROJECT TRUE) - if(CMAKE_BUILD_TYPE MATCHES "Release") - add_definitions(-DNDEBUG) - endif() + if(CMAKE_BUILD_TYPE MATCHES "Release") + add_definitions(-DNDEBUG) + endif() - if(NOT CMAKE_BUILD_TYPE) - set(CMAKE_BUILD_TYPE "Debug" CACHE STRING "" FORCE) - endif() + message(STATUS "Building ${PROJECT_NAME} ${${PROJECT_NAME}_VERSION} in ${CMAKE_BUILD_TYPE} mode. " + "Installing to ${CMAKE_INSTALL_PREFIX}" + ) - if(USE_DEFAULT_INSTALL_LOCATION) - if(UNIX) - set(CMAKE_INSTALL_PREFIX "/usr/local/KDAB/${PROJECT_NAME}-${${PROJECT_NAME}_VERSION}") - elseif(WIN32) - set(CMAKE_INSTALL_PREFIX "C:\\KDAB\\${PROJECT_NAME}-${${PROJECT_NAME}_VERSION}") + 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 README.md DESTINATION ${INSTALL_DOC_DIR}) + if(NOT ${PROJECT_NAME}_QT6) + install(FILES kdsoap.pri kdwsdl2cpp.pri DESTINATION ${INSTALL_DOC_DIR}) + endif() + install(DIRECTORY LICENSES DESTINATION ${INSTALL_DOC_DIR}) + + # Generate library version files + include(ECMSetupVersion) + ecm_setup_version( + ${${PROJECT_NAME}_VERSION} + VARIABLE_PREFIX + KDSOAP + VERSION_HEADER + "${CMAKE_CURRENT_BINARY_DIR}/kdsoap_version.h" + PACKAGE_VERSION_FILE + "${CMAKE_CURRENT_BINARY_DIR}/KDSoap/KDSoap${${PROJECT_NAME}_LIBRARY_QTID}ConfigVersion.cmake" + SOVERSION + ${${PROJECT_NAME}_SOVERSION} + COMPATIBILITY + AnyNewerVersion + ) + if(${PROJECT_NAME}_QT6) + install(FILES "${CMAKE_CURRENT_BINARY_DIR}/kdsoap_version.h" + DESTINATION ${INSTALL_INCLUDE_DIR}/KDSoapClient-Qt6/KDSoapClient + ) + else() + install(FILES "${CMAKE_CURRENT_BINARY_DIR}/kdsoap_version.h" DESTINATION ${INSTALL_INCLUDE_DIR}/KDSoapClient) endif() - endif() - - 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") - - set(CMAKE_INSTALL_RPATH ${INSTALL_LIBRARY_DIR}) - set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE) - - install(FILES LICENSE.GPL.txt LICENSE.US.txt LICENSE.txt README.txt kdsoap.pri kdwsdl2cpp.pri DESTINATION ${INSTALL_DOC_DIR}) - - if(CMAKE_VERSION VERSION_LESS 2.8.8) - include("${CMAKE_SOURCE_DIR}/cmake/CMakePackageConfigHelpers.cmake") - else() - include(CMakePackageConfigHelpers) - endif() - - write_basic_package_version_file("${CMAKE_CURRENT_BINARY_DIR}/KDSoap/KDSoapConfigVersion.cmake" - VERSION ${${PROJECT_NAME}_VERSION} - COMPATIBILITY AnyNewerVersion - ) - - configure_file( - "${CMAKE_CURRENT_SOURCE_DIR}/KDSoapConfig-buildtree.cmake.in" - "${CMAKE_CURRENT_BINARY_DIR}/KDSoap/KDSoapConfig.cmake" - @ONLY - ) - file(COPY - "${CMAKE_CURRENT_SOURCE_DIR}/KDSoapMacros.cmake" - DESTINATION - "${CMAKE_CURRENT_BINARY_DIR}/KDSoap/" - ) - configure_package_config_file( - "${CMAKE_CURRENT_SOURCE_DIR}/KDSoapConfig.cmake.in" - "${CMAKE_CURRENT_BINARY_DIR}/install/KDSoapConfig.cmake" - INSTALL_DESTINATION "${INSTALL_LIBRARY_DIR}/cmake/KDSoap" - PATH_VARS INSTALL_INCLUDE_DIR - ) - - install(FILES - "${CMAKE_CURRENT_BINARY_DIR}/install/KDSoapConfig.cmake" - "${CMAKE_CURRENT_BINARY_DIR}/KDSoap/KDSoapConfigVersion.cmake" - KDSoapMacros.cmake - DESTINATION "${INSTALL_LIBRARY_DIR}/cmake/KDSoap" - ) - install(EXPORT KDSoapTargets NAMESPACE KDSoap:: - DESTINATION "${INSTALL_LIBRARY_DIR}/cmake/KDSoap" - ) + + configure_file( + "${CMAKE_CURRENT_SOURCE_DIR}/KDSoapConfig-buildtree.cmake.in" + "${CMAKE_CURRENT_BINARY_DIR}/KDSoap/KDSoap${${PROJECT_NAME}_LIBRARY_QTID}Config.cmake" @ONLY + ) + configure_file( + "${CMAKE_CURRENT_SOURCE_DIR}/KDSoapMacros.cmake.in" "${CMAKE_CURRENT_BINARY_DIR}/KDSoap/KDSoapMacros.cmake" + @ONLY + ) + configure_package_config_file( + "${CMAKE_CURRENT_SOURCE_DIR}/KDSoapConfig.cmake.in" + "${CMAKE_CURRENT_BINARY_DIR}/install/KDSoap${${PROJECT_NAME}_LIBRARY_QTID}Config.cmake" + INSTALL_DESTINATION "${INSTALL_LIBRARY_DIR}/cmake/KDSoap${${PROJECT_NAME}_LIBRARY_QTID}" + PATH_VARS INSTALL_INCLUDE_DIR + ) + + install( + FILES "${CMAKE_CURRENT_BINARY_DIR}/install/KDSoap${${PROJECT_NAME}_LIBRARY_QTID}Config.cmake" + "${CMAKE_CURRENT_BINARY_DIR}/KDSoap/KDSoap${${PROJECT_NAME}_LIBRARY_QTID}ConfigVersion.cmake" + "${CMAKE_CURRENT_BINARY_DIR}/KDSoap/KDSoapMacros.cmake" + DESTINATION "${INSTALL_LIBRARY_DIR}/cmake/KDSoap${${PROJECT_NAME}_LIBRARY_QTID}" + ) + + install( + EXPORT KDSoapTargets + NAMESPACE KDSoap:: + DESTINATION "${INSTALL_LIBRARY_DIR}/cmake/KDSoap${${PROJECT_NAME}_LIBRARY_QTID}" + ) + + #Install the kdsoap features file for qmake users + add_subdirectory(features) + + # 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) + ecm_generate_pri_file( + BASE_NAME + KDSoapClient + LIB_NAME + kdsoap${${PROJECT_NAME}_LIBRARY_QTID} + FILENAME_VAR + pri_client_filename + INCLUDE_INSTALL_DIR + ${INSTALL_INCLUDE_DIR} + ) + ecm_generate_pri_file( + BASE_NAME + KDSoapServer + LIB_NAME + kdsoap-server${${PROJECT_NAME}_LIBRARY_QTID} + FILENAME_VAR + pri_server_filename + INCLUDE_INSTALL_DIR + ${INSTALL_INCLUDE_DIR} + ) + install(FILES ${pri_client_filename} ${pri_server_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() + +if(${PROJECT_NAME}_TESTS) + enable_testing() endif() add_subdirectory(src) add_subdirectory(kdwsdl2cpp) -if(${PROJECT_NAME}_IS_ROOT_PROJECT) - export(TARGETS kdsoap kdsoap-server kdwsdl2cpp NAMESPACE KDSoap:: - FILE "${CMAKE_CURRENT_BINARY_DIR}/KDSoap/KDSoapTargets.cmake" - ) +if(${PROJECT_NAME}_IS_ROOT_PROJECT) + export( + TARGETS kdsoap kdsoap-server kdwsdl2cpp + NAMESPACE KDSoap:: + FILE "${CMAKE_CURRENT_BINARY_DIR}/KDSoap/KDSoapTargets.cmake" + ) +endif() - add_subdirectory(features) - if(${PROJECT_NAME}_TESTS) - enable_testing() +if(${PROJECT_NAME}_TESTS) add_subdirectory(testtools) add_subdirectory(unittests) - endif() - add_subdirectory(examples) 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) + + feature_summary(WHAT ALL INCLUDE_QUIET_PACKAGES FATAL_ON_MISSING_REQUIRED_PACKAGES) +endif() + +# TODO once cppcheck is passing change --error-exitcode=1 so CI step fails on new errors +add_custom_target( + cppcheck + COMMENT "Run cppcheck on sources" + USES_TERMINAL + WORKING_DIRECTORY ${PROJECT_BINARY_DIR} + COMMAND + ${CMAKE_COMMAND} -E env cppcheck --project=${PROJECT_BINARY_DIR}/compile_commands.json --enable=all + --error-exitcode=0 --language=c++ --inline-suppr --quiet --disable=missingInclude,unusedFunction + --check-level=exhaustive --library=qt.cfg -i3rdParty/ --suppress=*:*.moc --suppress=*:*moc_*.cpp -i/cmake/ECM/ + -i/cmake/KDAB/ -i/kdwsdl2cpp/libkode/ -i/scripts/ +) diff --git a/CMakePresets.json b/CMakePresets.json new file mode 100644 index 000000000..ffe3bbba9 --- /dev/null +++ b/CMakePresets.json @@ -0,0 +1,112 @@ +{ + "version": 5, + "configurePresets": [ + { + "name": "base", + "generator": "Ninja", + "binaryDir": "${sourceDir}/build-${presetName}", + "hidden": true, + "cacheVariables": { + "CMAKE_EXPORT_COMPILE_COMMANDS": "ON" + }, + "warnings": { + "uninitialized": true + }, + "errors": { + "dev": true + } + }, + { + "name": "static-base", + "hidden": true, + "generator": "Ninja", + "cacheVariables": { + "KDSoap_STATIC": "ON" + }, + "inherits": ["base"] + }, + { + "name": "dev", + "inherits": ["base"], + "cacheVariables": { + "CMAKE_BUILD_TYPE": "Debug", + "KDSoap_STATIC": "OFF", + "KDSoap_TESTS": "ON", + "KDSoap_EXAMPLES": "ON", + "KDSoap_QT6": "ON" + } + }, + { + "name": "dev-asan", + "inherits": ["dev"], + "cacheVariables": { + "ECM_ENABLE_SANITIZERS": "'address;undefined'" + } + }, + { + "name": "dev-tsan", + "inherits": ["dev"], + "cacheVariables": { + "ECM_ENABLE_SANITIZERS": "'thread'" + } + }, + { + "name": "dev-static", + "inherits": ["dev"], + "cacheVariables": { + "KDSoap_STATIC": "ON" + } + }, + { + "name": "clazy", + "inherits": "dev", + "cacheVariables": { + "KDSoap_EXAMPLES": "OFF", + "KDSoap_TESTS": "OFF", + "CMAKE_COMPILE_WARNING_AS_ERROR": "ON" + }, + "environment": { + "CXX": "clazy", + "CCACHE_DISABLE": "ON" + } + }, + { + "name": "clang-tidy", + "inherits": "dev", + "cacheVariables": { + "KDSoap_EXAMPLES": "OFF", + "KDSoap_TESTS": "OFF", + "CMAKE_CXX_CLANG_TIDY": "clang-tidy" + } + }, + { + "name": "release", + "inherits": "base", + "cacheVariables": { + "CMAKE_BUILD_TYPE": "Release" + } + }, + { + "name": "release-static", + "inherits": ["release"], + "cacheVariables": { + "KDSoap_STATIC": "ON" + } + } + ], + "buildPresets": [ + { + "name": "clazy", + "configurePreset": "clazy", + "environment": { + "CLAZY_CHECKS": "level2,no-qstring-allocations,no-fully-qualified-moc-types", + "CCACHE_DISABLE": "ON", + "CLAZY_IGNORE_DIRS": ".*libkode.*" + } + }, + { + "name": "clang-tidy", + "configurePreset": "clang-tidy" + } + ] +} diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt new file mode 100644 index 000000000..eae482aed --- /dev/null +++ b/CONTRIBUTORS.txt @@ -0,0 +1,7 @@ +Casper Meijn +Matt Broadstone +Raphaël Cotty +Rok Mandeljc +Ryan van der Bijl +Miklós Márton +Research & Engineering Center of St. Petersburg Electro-Technical University diff --git a/CPackIgnores.txt b/CPackIgnores.txt deleted file mode 100644 index 5882834eb..000000000 --- a/CPackIgnores.txt +++ /dev/null @@ -1,32 +0,0 @@ -/unittests/basic/basic$ -/unittests/basic/basic.app/ -/unittests/builtinhttp/builtinhttp$ -/unittests/builtinhttp/builtinhttp.app/ -/unittests/dwservice_12_wsdl/dwservice_12_wsdl$ -/unittests/dwservice_12_wsdl/dwservice_12_wsdl.app/ -/unittests/dwservice_combined_wsdl/dwservice_combined_wsdl$ -/unittests/dwservice_combined_wsdl/dwservice_combined_wsdl.app/ -/unittests/dwservice_wsdl/dwservice_wsdl$ -/unittests/dwservice_wsdl/dwservice_wsdl.app/ -/unittests/groupwise_wsdl/groupwise_wsdl$ -/unittests/groupwise_wsdl/groupwise_wsdl.app/ -/unittests/logbook_wsdl/logbook_wsdl$ -/unittests/logbook_wsdl/logbook_wsdl.app/ -/unittests/messagereader/messagereader$ -/unittests/messagereader/messagereader.app/ -/unittests/msexchange_wsdl/msexchange_wsdl$ -/unittests/msexchange_wsdl/msexchange_wsdl.app/ -/unittests/salesforce_wsdl/salesforce_wsdl$ -/unittests/salesforce_wsdl/salesforce_wsdl.app/ -/unittests/servertest/servertest$ -/unittests/servertest/servertest.app/ -/unittests/sugar_wsdl/sugar_wsdl$ -/unittests/sugar_wsdl/sugar_wsdl.app/ -/unittests/webcalls/webcalls$ -/unittests/webcalls/webcalls.app/ -/unittests/webcalls_wsdl/webcalls_wsdl$ -/unittests/webcalls_wsdl/webcalls_wsdl.app/ -/unittests/wsdl_document/wsdl_document$ -/unittests/wsdl_document/wsdl_document.app/ -/unittests/wsdl_rpc/wsdl_rpc$ -/unittests/wsdl_rpc/wsdl_rpc.app/ diff --git a/Doxyfile b/Doxyfile deleted file mode 100644 index 625187887..000000000 --- a/Doxyfile +++ /dev/null @@ -1,71 +0,0 @@ -PROJECT_NAME = "KD SOAP" -PROJECT_NUMBER = 1.7.50 -OUTPUT_DIRECTORY = doc -HTML_OUTPUT = refman -INHERIT_DOCS = NO -DISTRIBUTE_GROUP_DOC = YES -TAB_SIZE = 8 -EXTRACT_PRIVATE = YES -EXTRACT_STATIC = YES -HIDE_UNDOC_MEMBERS = YES -HIDE_UNDOC_CLASSES = YES -HIDE_FRIEND_COMPOUNDS = YES -CASE_SENSE_NAMES = NO -HIDE_SCOPE_NAMES = NO -SHOW_INCLUDE_FILES = YES -SORT_MEMBER_DOCS = NO -GENERATE_DEPRECATEDLIST= YES -ENABLED_SECTIONS = -MAX_INITIALIZER_LINES = 30 -SHOW_USED_FILES = YES -QUIET = YES -WARNINGS = YES -WARN_IF_UNDOCUMENTED = NO -WARN_IF_DOC_ERROR = YES -WARN_LOGFILE = doxygen.log -INPUT = src -ALIASES = "inv=\invariant" \ - "since_l=\nThis library was introduced in KD SOAP " \ - "since_c=\nThis class was introduced in KD SOAP " \ - "since_d=\nThis macro was introduced in KD SOAP " \ - "since_f=\nThis function was introduced in KD SOAP " \ - "since_e=\nThis enumeration was introduced in KD SOAP " \ - "since_p=\nThis property was introduced in KD SOAP " \ - "since_v=\nThis enumeration value was introduced in KD SOAP " \ - "since_t=\nThis typedef was introduced in KD SOAP " \ - "reimp=\internal" -FILE_PATTERNS = [a-zA-Z]*.cpp [a-zA-Z]*.h *.dox -RECURSIVE = YES -EXCLUDE = -EXCLUDE_PATTERNS = moc_*.cpp ui_*.h qrc_*.cpp -EXAMPLE_PATH = examples -EXAMPLE_PATTERNS = [a-z]*.cpp [a-z]*.h -EXAMPLE_RECURSIVE = YES -IMAGE_PATH = images -REFERENCED_BY_RELATION = NO -REFERENCES_RELATION = NO -VERBATIM_HEADERS = YES -GENERATE_HTML = YES -ENABLE_PREPROCESSING = YES -MACRO_EXPANSION = YES -EXPAND_ONLY_PREDEF = YES -SEARCH_INCLUDES = YES -INCLUDE_PATH = -PREDEFINED = \ - "DOXYGEN_PROPERTY(x)=Q_PROPERTY(x)" \ - "Q_PRIVATE_SLOT(x,y)=" \ - "KDAB_IMPLEMENT_SAFE_BOOL_OPERATOR(x):=public:operator unspecified_bool_type() const;" \ - "KDAB_USING_SAFE_BOOL_OPERATOR(x):=public:operator unspecified_bool_type() const;" \ - "CONST=" \ - DOXYGEN_RUN -EXPAND_AS_DEFINED = -SKIP_FUNCTION_MACROS = YES -TAGFILES = \ - qt4.tag=http://developer.qt.nokia.com/doc/qt-4.8 \ - libstdc++.tag=http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen -GENERATE_TAGFILE = kdsoap.tag -ALLEXTERNALS = NO -EXTERNAL_GROUPS = NO -PERL_PATH = /usr/bin/perl -HTML_FOOTER = images/footer.html -GENERATE_TODOLIST = NO diff --git a/FindKDSoap.cmake b/FindKDSoap.cmake index 0320cf9fb..5d17a6112 100644 --- a/FindKDSoap.cmake +++ b/FindKDSoap.cmake @@ -1,27 +1,36 @@ -# - Find KDSoap -# This module finds if KDSoap is installed. +# This file is part of the KD Soap project. # -# KDSoap_FOUND - Set to TRUE if KDSoap was found. -# KDSoap_LIBRARIES - Path to KDSoap libraries. -# KDSoap_INCLUDE_DIR - Path to the KDSoap include directory. -# KDSoap_CODEGENERATOR - Path to the KDSoap code generator. +# SPDX-FileCopyrightText: 2011 Klarälvdalens Datakonsult AB, a KDAB Group company +# +# SPDX-License-Identifier: MIT # -# Copyright (C) 2011-2018 Klaralvdalens Datakonsult AB, a KDAB Group company, info@kdab.com - -# Redistribution and use is allowed according to the terms of the BSD license include(FindPackageHandleStandardArgs) -find_library(KDSoap_LIBRARIES - NAMES KDSoap kdsoap - PATH_SUFFIXES bin) -find_path(KDSoap_INCLUDE_DIR - NAMES KDSoapClient/KDSoapValue.h - PATH_SUFFIXES include src) -find_program(KDSoap_CODEGENERATOR - NAMES kdwsdl2cpp - PATH_SUFFIXES bin) +find_library( + KDSoap_LIBRARIES + NAMES KDSoap kdsoap + PATH_SUFFIXES bin +) + +find_path( + KDSoap_INCLUDE_DIR + NAMES KDSoapClient/KDSoapValue.h + PATH_SUFFIXES include src +) + +find_program( + KDSoap_CODEGENERATOR + NAMES kdwsdl2cpp + PATH_SUFFIXES bin +) mark_as_advanced(KDSoap_LIBRARIES KDSoap_INCLUDE_DIR KDSoap_CODEGENERATOR) -find_package_handle_standard_args(KDSoap DEFAULT_MSG KDSoap_LIBRARIES KDSoap_INCLUDE_DIR KDSoap_CODEGENERATOR) +find_package_handle_standard_args( + KDSoap + DEFAULT_MSG + KDSoap_LIBRARIES + KDSoap_INCLUDE_DIR + KDSoap_CODEGENERATOR +) diff --git a/INSTALL-cmake.txt b/INSTALL-cmake.txt deleted file mode 100644 index 510f6d2b2..000000000 --- a/INSTALL-cmake.txt +++ /dev/null @@ -1,88 +0,0 @@ -These are the instructions for installing KD SOAP using the CMake buildsystem. -CMake version 2.8.7 or higher is required. - -KD SOAP 1.x requires a Qt version >= 4.6 with Network and XML support enabled. - -The same source code compiles with either Qt 4 or Qt 5. - -1) From the top directory of your KD SOAP 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 -DKDSOAP_STATIC=True -DCMAKE_BUILD_TYPE=Debug .. - cmake -DKDSOAP_STATIC=True -DCMAKE_BUILD_TYPE=Release .. - - To define the install-location use for example: - cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=C:/kdsoap .. - cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=/opt/kdsoap .. - -3) Unix - -set your LD_LIBRARY_PATH to point to your KD SOAP installation lib directory. - -If you do not have LD_LIBRARY_PATH set already then use this line: -LD_LIBRARY_PATH=/path/to/kdsoap/lib:$LD_LIBRARY_PATH -export LD_LIBRARY_PATH - -The above has to be added into your .bashrc or similar to remain. It may also of course be run from a shell just before building software using KD SOAP, 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 - -Add the path to KD SOAP lib into your LIB environment variable and the path -to KD SOAP bin into your PATH environment variable. - -Or run: - set PATH=\path\to\kdsoap\bin;%PATH% - set LIB=\path\to\kdsoap\lib;%LIB% - - -6) Build everything by typing: - -make # Unix, -nmake # Windows - - -7) (optionally:) Install KD SOAP: - - From your top-level KD SOAP directory just type - -make install # Unix, -nmake install # Windows - - This will copy the necessary files into the sub-directories of - your installation path: - For Unix/Linux, Mac: /usr/local/KDAB/KDSoap-VERSION/ - For Windows that is: C:\KDAB\KDSoap-VERSION\ - - -8) Symbian (Qt4 only) - -A CMake build is not available for Symbian platforms. Refer to the INSTALL.txt -file for instructions on using autotools for a Symbian install. - - -9) Have a look at the examples applications. They will get you started with KD SOAP. - -== Testing == -To build the testing harness, pass -DKDSoap_TESTS=true to CMake, like so: - % cmake -DKDSoap_TESTS=true - -Then run 'make test' to run the unit tests. - -== Force a Qt4 build == -On systems with both Qt4 and Qt5 available, the CMake buildsystem will always -attempt to use Qt5. To force a Qt build, pass -DKDSoap_ENFORCE_QT4_BUILD=true -to CMake, as in: - % cmake -DKDSoap_ENFORCE_QT4_BUILD=true diff --git a/INSTALL.txt b/INSTALL.txt index b23946b9d..c5f26f753 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -1,139 +1,103 @@ -KD SOAP 1.x requires a Qt version >= 4.6 with Network and XML support enabled. +These are the instructions for installing KD SOAP using the CMake buildsystem. +CMake version 3.3 or higher is required. -The same source code compiles with either Qt 4 or Qt 5. +The qmake (via autogen.py) buildsystem is removed starting with KDSoap version 2.0. -If you are using sources from github (via a git clone or a generated zip file), jump -to section 1-bis). Commercial users, start at section 1). +KD SOAP requires Qt with Network and XML support enabled. +Qt Version support: + * KD SOAP 1.9 or below requires Qt4.6 up to Qt5.15 + * KD SOAP 1.10 requires Qt5.7 up to Qt5.15 + * KD SOAP 2.0 or above requires Qt5.9 up to Qt6.x -1) From the top directory of your KD SOAP installation run the "configure" scripts. +Also note that Qt6 builds require a C++17 compliant compiler, +whereas Qt5 builds can get by with C++11 compliance. - On Windows use depending on the kind of build one of the following; - configure.bat -shared -debug - configure.bat -shared -release - configure.bat -static -debug - configure.bat -static -release +Please see the comments at the top of CMakeLists.txt for +the available configuration options you can pass to cmake. - On Unix use depending on the kind of build one of the following; - ./configure.sh -shared -debug - ./configure.sh -shared -release - ./configure.sh -static -debug - ./configure.sh -static -release +The installation directory defaults to c:\KDAB\KDSoap- on Windows +and /usr/local/KDAB/KDSoap- on non-Windows. You can change this +location by passing the option -DCMAKE_INSTALL_PREFIX=/install/path to cmake. - To define the install-location use for example; - configure.bat -shared -debug -prefix c:/kdsoap - ./configure.sh -shared -debug -prefix /opt/kdsoap +1) From the top directory of your KD SOAP installation create a build directory: - If this succeeded, jump to step 2. + mkdir build -1-bis) If you are building KD Soap from a github clone rather than a release tarball, -the configure.bat/configure.sh script doesn't exist (it's generated at release time), -you need to do this instead: + and change directory into that build directory: - First, a working Python (version2) is required and must be found in your - execute path. Either a 32-bit or 64-bit version of Python is fine, but run - python --version to make sure it is found and is python2 before continuing. + cd build - Now run autogen.py to create the configure tool. +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 -DKDSoap_STATIC=True -DCMAKE_BUILD_TYPE=Debug .. + cmake -DKDSoap_STATIC=True -DCMAKE_BUILD_TYPE=Release .. - On Windows: - python autogen.py [options] - On Linux: - ./autogen.py [options] + To define the install-location use for example: + cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=C:/kdsoap .. + cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=/opt/kdsoap .. -Pass the same options to autogen.py as you would for configure.sh/configure.bat -as shown above in step 1). +3) Unix -After running autogen.py, a configure.sh/configure.bat script will exist and -you can use that to re-configure later, as needed. Then you can continue on -to the platform-specific setup instructions in step 2, 3 or 4. + set your LD_LIBRARY_PATH to point to your KD SOAP installation lib directory. -2) Unix + If you do not have LD_LIBRARY_PATH set already, then in your terminal run: + % LD_LIBRARY_PATH=/path/to/kdsoap/lib:$LD_LIBRARY_PATH + % export LD_LIBRARY_PATH -set your LD_LIBRARY_PATH to point to your KD SOAP installation lib directory. + 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 KD SOAP, but in this case + your settings will only be available for this shell. -If you do not have LD_LIBRARY_PATH set already then use this line: -LD_LIBRARY_PATH=/path/to/kdsoap/lib:$LD_LIBRARY_PATH -export LD_LIBRARY_PATH +4) MacOS -The above has to be added into your .bashrc or similar to remain. It may also of course be run from a shell just before building software using KD SOAP, but in this case your settings will only be available for this shell. + Proceed as described above, but using DYLD_LIBRARY_PATH instead of LD_LIBRARY_PATH -If you want to install the libraries under the "lib64" folder then -set the QMAKE_ARGS environment variable to "LIB_SUFFIX=64" like so: -QMAKE_ARGS="LIB_SUFFIX=64" -export QMAKE_ARGS +5) Windows -3) MacOS + For running executables, add the path to the KD Soap dll (kdsoap\bin) into your PATH. + eg. set PATH=\path\to\kdsoap\bin;%PATH% -Proceed as described above, but using DYLD_LIBRARY_PATH instead -of LD_LIBRARY_PATH + For development, add the path to the KD Soap lib (kdsoaplib) into your LIB environment. + eg. set LIB=\path\to\kdsoap\lib;%LIB% -4) Windows +6) Build everything by typing: -Add the path to KD SOAP lib into your LIB environment variable and the path -to KD SOAP bin into your PATH environment variable. + From your top-level KD SOAP directory run: -Or run: -set PATH=\path\to\kdsoap\bin;%PATH% -set LIB=\path\to\kdsoap\lib;%LIB% + % make # Unix, Mac + % nmake # Windows +7) (optionally:) Install KD SOAP: -5) Build everything by typing: + From your top-level KD SOAP directory run: -make # Unix, -nmake # Windows + % 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 this is /usr/local/KDAB/KDSoap-VERSION/ + For Windows this is: C:\KDAB\KDSoap-VERSION\ -6) (optionally:) Install KD SOAP: - - From your top-level KD SOAP directory just type - -make install # Unix, -nmake install # Windows - - This will copy the necessary files into the sub-directories of - your installation path: - For Unix/Linux, Mac: /usr/local/KDAB/KDSoap-VERSION/ - For Windows that is: C:\KDAB\KDSoap-VERSION\ +8) Have a look at the examples applications. They will get you started with KD SOAP. +== Testing == +To build the testing harness, pass -DKDSoap_TESTS=true to CMake, like so: + % cmake -DKDSoap_TESTS=true -7) Symbian (Qt4 only) +Then run 'make test' to run the unit tests. -Here is a step by step introduction how to compile KD Soap with the Symbian-Toolchain on Windows. +== Using == +From your CMake project, add -1. Open a command prompt. -2. Setup environment - set QTDIR=c:\Qt\NokiaQtSDK_1_0_2\Symbian\SDK\ - set PATH=c:\Qt\NokiaQtSDK_1_0_2\Symbian\SDK\bin\;%PATH% - set QMAKESPEC=symbian-abld -3. Change to your KD Soap source-directory - cd c:\src\kdsoap\ -4. Run configuration - configure.bat -static -debug -5. Compile with - make release-gcce - make installer_sis -6. Depending on the Qt and Symbian^3 version you are using you maybe - get an error like - BLDMAKE ERROR: Can't find any RVCT installation. - This is a known qmake@Symbian^3 bug. You can workaround that bug - by installing python, saving following script in a file like e.g. - c:\fix.py and executing that script using "c:\fix.py c:\src\kdsoap\" + find_package(KDSoap CONFIG REQUIRED) -import os, sys, re -for root, subFolders, files in os.walk(sys.argv[1]): - for file in files: - if file == 'bld.inf': - path = os.path.join(root,file) - i = open(path).read() - o = open(path,"w") - o.write( re.sub("WINSCW GCCE ARMV5 ARMV6","WINSCW GCCE",i) ) - o.close() +or for Qt6 - This will replace in all generated bld.inf files the line - WINSCW GCCE ARMV5 ARMV6 - with - WINSCW GCCE - to workaround that known qmake+Symbian^3 bug. + find_package(KDSoap-qt6 CONFIG REQUIRED) +and link to the imported target KDSoap::kdsoap. +That's all you need to do (the imported target also brings in the include directories) -8) Have a look at the examples applications. They will get you started with KD SOAP. +You may also need to point the CMAKE_PREFIX_PATH environment variable depending +on where you installed KDSoap. diff --git a/KDSoapConfig-buildtree.cmake.in b/KDSoapConfig-buildtree.cmake.in index 9e522c579..bb3a27cc4 100644 --- a/KDSoapConfig-buildtree.cmake.in +++ b/KDSoapConfig-buildtree.cmake.in @@ -1,3 +1,10 @@ +# This file is part of the KD Soap project. +# +# SPDX-FileCopyrightText: 2013 Klarälvdalens Datakonsult AB, a KDAB Group company +# +# SPDX-License-Identifier: MIT +# + set(KDSoap_INCLUDE_DIRS "@INSTALL_INCLUDE_DIR@") diff --git a/KDSoapConfig.cmake.in b/KDSoapConfig.cmake.in index 2745bde39..3d0e10bfb 100644 --- a/KDSoapConfig.cmake.in +++ b/KDSoapConfig.cmake.in @@ -1,6 +1,17 @@ +# This file is part of the KD Soap project. +# +# SPDX-FileCopyrightText: 2012 Klarälvdalens Datakonsult AB, a KDAB Group company +# +# SPDX-License-Identifier: MIT +# @PACKAGE_INIT@ +include(CMakeFindDependencyMacro) + +find_dependency(Qt@QT_VERSION_MAJOR@Core @QT_MIN_VERSION@) +find_dependency(Qt@QT_VERSION_MAJOR@Network @QT_MIN_VERSION@) + set_and_check(KDSoap_INCLUDE_DIR "@PACKAGE_INSTALL_INCLUDE_DIR@") set(KDSoap_INCLUDE_DIRS "${KDSoap_INCLUDE_DIR}") @@ -8,4 +19,3 @@ set(KDSoap_CODEGENERATOR KDSoap::kdwsdl2cpp) include("${CMAKE_CURRENT_LIST_DIR}/KDSoapTargets.cmake") include("${CMAKE_CURRENT_LIST_DIR}/KDSoapMacros.cmake") - diff --git a/KDSoapMacros.cmake b/KDSoapMacros.cmake deleted file mode 100644 index 0609b456b..000000000 --- a/KDSoapMacros.cmake +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright (c) 2011-2018 Klarälvdalens Datakonsult AB, a KDAB Group company - -# Redistribution and use is allowed according to the terms of the BSD license. - -macro( KDSOAP_GENERATE_WSDL _sources ) - set(KDWSDL2CPP kdwsdl2cpp) - if (KDSOAP_KDWSDL2CPP_COMPILER) - set(KDWSDL2CPP ${KDSOAP_KDWSDL2CPP_COMPILER}) - elseif (TARGET KDSoap::kdwsdl2cpp) - set(KDWSDL2CPP KDSoap::kdwsdl2cpp) - endif() - set(_KSWSDL2CPP_OPTION) - if(KSWSDL2CPP_OPTION) - set(_KSWSDL2CPP_OPTION ${KSWSDL2CPP_OPTION}) - endif() - foreach (_source_FILE ${ARGN}) - get_filename_component(_tmp_FILE ${_source_FILE} ABSOLUTE) - get_filename_component(_basename ${_tmp_FILE} NAME_WE) - set(_header_wsdl_FILE ${CMAKE_CURRENT_BINARY_DIR}/wsdl_${_basename}.h) - set(_source_wsdl_FILE ${CMAKE_CURRENT_BINARY_DIR}/wsdl_${_basename}.cpp) - add_custom_command(OUTPUT ${_header_wsdl_FILE} - COMMAND ${KDWSDL2CPP} - ARGS ${_KSWSDL2CPP_OPTION} ${_tmp_FILE} -o ${_header_wsdl_FILE} - MAIN_DEPENDENCY ${_tmp_FILE} - DEPENDS ${_tmp_FILE} ${KDWSDL2CPP} ) - - add_custom_command(OUTPUT ${_source_wsdl_FILE} - COMMAND ${KDWSDL2CPP} - ARGS ${_KSWSDL2CPP_OPTION} -impl ${_header_wsdl_FILE} ${_tmp_FILE} -o ${_source_wsdl_FILE} - MAIN_DEPENDENCY ${_tmp_FILE} ${_header_wsdl_FILE} - DEPENDS ${_tmp_FILE} ${KDWSDL2CPP} ) - - set_source_files_properties(${_header_wsdl_FILE} ${_source_wsdl_FILE} PROPERTIES SKIP_AUTOMOC ON) - - if (Qt5Core_FOUND) - qt5_wrap_cpp(_sources_MOCS ${_header_wsdl_FILE}) - else() - qt4_wrap_cpp(_sources_MOCS ${_header_wsdl_FILE}) - endif() - list(APPEND ${_sources} ${_header_wsdl_FILE} ${_source_wsdl_FILE} ${_sources_MOCS}) - endforeach () -endmacro() - diff --git a/KDSoapMacros.cmake.in b/KDSoapMacros.cmake.in new file mode 100644 index 000000000..994fe20df --- /dev/null +++ b/KDSoapMacros.cmake.in @@ -0,0 +1,43 @@ +# This file is part of the KD Soap project. +# +# SPDX-FileCopyrightText: 2011 Klarälvdalens Datakonsult AB, a KDAB Group company +# +# SPDX-License-Identifier: MIT +# + +macro(KDSOAP_GENERATE_WSDL _sources) + set(KDWSDL2CPP kdwsdl2cpp) + if(KDSOAP_KDWSDL2CPP_COMPILER) + set(KDWSDL2CPP ${KDSOAP_KDWSDL2CPP_COMPILER}) + elseif(TARGET KDSoap::kdwsdl2cpp) + set(KDWSDL2CPP KDSoap::kdwsdl2cpp) + endif() + set(_KSWSDL2CPP_OPTION) + if(KSWSDL2CPP_OPTION) + set(_KSWSDL2CPP_OPTION ${KSWSDL2CPP_OPTION}) + endif() + foreach(_source_FILE ${ARGN}) + get_filename_component(_tmp_FILE ${_source_FILE} ABSOLUTE) + get_filename_component(_basename ${_tmp_FILE} NAME_WE) + set(_header_wsdl_FILE ${CMAKE_CURRENT_BINARY_DIR}/wsdl_${_basename}.h) + set(_source_wsdl_FILE ${CMAKE_CURRENT_BINARY_DIR}/wsdl_${_basename}.cpp) + add_custom_command(OUTPUT ${_header_wsdl_FILE} + COMMAND ${KDWSDL2CPP} + ARGS ${_KSWSDL2CPP_OPTION} ${_tmp_FILE} -o ${_header_wsdl_FILE} + MAIN_DEPENDENCY ${_tmp_FILE} + DEPENDS ${_tmp_FILE} ${KDWSDL2CPP}) + + add_custom_command(OUTPUT ${_source_wsdl_FILE} + COMMAND ${KDWSDL2CPP} + ARGS ${_KSWSDL2CPP_OPTION} -impl ${_header_wsdl_FILE} ${_tmp_FILE} -o ${_source_wsdl_FILE} + MAIN_DEPENDENCY ${_tmp_FILE} ${_header_wsdl_FILE} + DEPENDS ${_tmp_FILE} ${KDWSDL2CPP}) + + set_source_files_properties(${_header_wsdl_FILE} ${_source_wsdl_FILE} PROPERTIES + SKIP_AUTOMOC ON + SKIP_AUTOUIC ON + ) + qt@QT_VERSION_MAJOR@_wrap_cpp(_sources_MOCS ${_header_wsdl_FILE}) + list(APPEND ${_sources} ${_header_wsdl_FILE} ${_source_wsdl_FILE} ${_sources_MOCS}) + endforeach() +endmacro() diff --git a/LICENSE.AGPL3-modified.txt b/LICENSE.AGPL3-modified.txt deleted file mode 100644 index d6e1d4fca..000000000 --- a/LICENSE.AGPL3-modified.txt +++ /dev/null @@ -1,678 +0,0 @@ - The KD Soap Server Library is Copyright (C) 2010-2018 Klaralvdalens Datakonsult AB. - - You may use, distribute and copy the KD Soap Server Library under the terms of - the GNU Affero General Public License version 3, displayed below. - - Klaralvdalens Datakonsult AB grants you an additional permission under the GNU - Affero GPL version 3 section 7: - -If you modify this Program, or any covered work, by linking or -combining it with other code, such other code is not for that reason -alone subject to any of the requirements of the GNU Affero GPL -version 3. - -------------------------------------------------------------------------- - - - GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU Lesser General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU Affero General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Remote Network Interaction; Use with the GNU Lesser General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU Lesser General Public License that is incorporated pursuant to the -following paragraph. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Lesser General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU Lesser General Public License. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU Affero General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU Affero General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU AGPL, see -. - diff --git a/LICENSE.GPL.txt b/LICENSE.GPL.txt deleted file mode 100644 index 28a0fcc49..000000000 --- a/LICENSE.GPL.txt +++ /dev/null @@ -1,1030 +0,0 @@ - - The KD Soap Library is Copyright (C) 2010-2018 Klaralvdalens Datakonsult AB. - - You may use, distribute and copy the KD Soap Library under the terms of - the GNU General Public License version 2 or under the terms of GNU General - Public License version 3 both of which are displayed below. - - For the server-side library, see LICENSE.AGPL3-modified.txt - -------------------------------------------------------------------------- - - GNU GENERAL PUBLIC LICENSE - Version 2, June 1991 - - Copyright (C) 1989, 1991 Free Software Foundation, Inc. - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA - - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Library General Public License instead.) You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -this service if you wish), that you receive source code or can get it -if you want it, that you can change the software or use pieces of it -in new free programs; and that you know you can do these things. - - To protect your rights, we need to make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. You must make sure that they, too, receive or can get the -source code. And you must show them these terms so they know their -rights. - - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. - - The precise terms and conditions for copying, distribution and -modification follow. - - GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. - - 1. You may copy and distribute verbatim copies of the Program's -source code as you receive it, in any medium, provided that you -conspicuously and appropriately publish on each copy an appropriate -copyright notice and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. - -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. - - 2. You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. - - b) You must cause any work that you distribute or publish, that in - whole or in part contains or is derived from the Program or any - part thereof, to be licensed as a whole at no charge to all third - parties under the terms of this License. - - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you provide - a warranty) and that users may redistribute the program under - these conditions, and telling the user how to view a copy of this - License. (Exception: if the Program itself is interactive but - does not normally print such an announcement, your work based on - the Program is not required to print an announcement.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - - a) Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of Sections - 1 and 2 above on a medium customarily used for software interchange; or, - - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, - - c) Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. - -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. - - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. - - 5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. - - 7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - - 9. The Free Software Foundation may publish revised and/or new versions -of the General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - -Each version is given a distinguishing version number. If the Program -specifies a version number of this License which applies to it and "any -later version", you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. - - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. - - NO WARRANTY - - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY -FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN -OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES -PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED -OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS -TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE -PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, -REPAIR OR CORRECTION. - - 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, -INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING -OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED -TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY -YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER -PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE -POSSIBILITY OF SUCH DAMAGES. - - END OF TERMS AND CONDITIONS - - Appendix: How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) 19yy - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - -Also add information on how to contact you by electronic and paper mail. - -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: - - Gnomovision version 69, Copyright (C) 19yy name of author - Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, the commands you use may -be called something other than `show w' and `show c'; they could even be -mouse-clicks or menu items--whatever suits your program. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the program - `Gnomovision' (which makes passes at compilers) written by James Hacker. - - , 1 April 1989 - Ty Coon, President of Vice - -This General Public License does not permit incorporating your program into -proprietary programs. If your program is a subroutine library, you may -consider it more useful to permit linking proprietary applications with the -library. If this is what you want to do, use the GNU Library General -Public License instead of this License. - -------------------------------------------------------------------------- - - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for - software and other kinds of works. - - The licenses for most software and other practical works are designed - to take away your freedom to share and change the works. By contrast, - the GNU General Public License is intended to guarantee your freedom to - share and change all versions of a program--to make sure it remains free - software for all its users. We, the Free Software Foundation, use the - GNU General Public License for most of our software; it applies also to - any other work released this way by its authors. You can apply it to - your programs, too. - - When we speak of free software, we are referring to freedom, not - price. Our General Public Licenses are designed to make sure that you - have the freedom to distribute copies of free software (and charge for - them if you wish), that you receive source code or can get it if you - want it, that you can change the software or use pieces of it in new - free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you - these rights or asking you to surrender the rights. Therefore, you have - certain responsibilities if you distribute copies of the software, or if - you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether - gratis or for a fee, you must pass on to the recipients the same - freedoms that you received. You must make sure that they, too, receive - or can get the source code. And you must show them these terms so they - know their rights. - - Developers that use the GNU GPL protect your rights with two steps: - (1) assert copyright on the software, and (2) offer you this License - giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains - that there is no warranty for this free software. For both users' and - authors' sake, the GPL requires that modified versions be marked as - changed, so that their problems will not be attributed erroneously to - authors of previous versions. - - Some devices are designed to deny users access to install or run - modified versions of the software inside them, although the manufacturer - can do so. This is fundamentally incompatible with the aim of - protecting users' freedom to change the software. The systematic - pattern of such abuse occurs in the area of products for individuals to - use, which is precisely where it is most unacceptable. Therefore, we - have designed this version of the GPL to prohibit the practice for those - products. If such problems arise substantially in other domains, we - stand ready to extend this provision to those domains in future versions - of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. - States should not allow patents to restrict development and use of - software on general-purpose computers, but in those that do, we wish to - avoid the special danger that patents applied to a free program could - make it effectively proprietary. To prevent this, the GPL assures that - patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and - modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of - works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this - License. Each licensee is addressed as "you". "Licensees" and - "recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work - in a fashion requiring copyright permission, other than the making of an - exact copy. The resulting work is called a "modified version" of the - earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based - on the Program. - - To "propagate" a work means to do anything with it that, without - permission, would make you directly or secondarily liable for - infringement under applicable copyright law, except executing it on a - computer or modifying a private copy. Propagation includes copying, - distribution (with or without modification), making available to the - public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other - parties to make or receive copies. Mere interaction with a user through - a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" - to the extent that it includes a convenient and prominently visible - feature that (1) displays an appropriate copyright notice, and (2) - tells the user that there is no warranty for the work (except to the - extent that warranties are provided), that licensees may convey the - work under this License, and how to view a copy of this License. If - the interface presents a list of user commands or options, such as a - menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work - for making modifications to it. "Object code" means any non-source - form of a work. - - A "Standard Interface" means an interface that either is an official - standard defined by a recognized standards body, or, in the case of - interfaces specified for a particular programming language, one that - is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other - than the work as a whole, that (a) is included in the normal form of - packaging a Major Component, but which is not part of that Major - Component, and (b) serves only to enable use of the work with that - Major Component, or to implement a Standard Interface for which an - implementation is available to the public in source code form. A - "Major Component", in this context, means a major essential component - (kernel, window system, and so on) of the specific operating system - (if any) on which the executable work runs, or a compiler used to - produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all - the source code needed to generate, install, and (for an executable - work) run the object code and to modify the work, including scripts to - control those activities. However, it does not include the work's - System Libraries, or general-purpose tools or generally available free - programs which are used unmodified in performing those activities but - which are not part of the work. For example, Corresponding Source - includes interface definition files associated with source files for - the work, and the source code for shared libraries and dynamically - linked subprograms that the work is specifically designed to require, - such as by intimate data communication or control flow between those - subprograms and other parts of the work. - - The Corresponding Source need not include anything that users - can regenerate automatically from other parts of the Corresponding - Source. - - The Corresponding Source for a work in source code form is that - same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of - copyright on the Program, and are irrevocable provided the stated - conditions are met. This License explicitly affirms your unlimited - permission to run the unmodified Program. The output from running a - covered work is covered by this License only if the output, given its - content, constitutes a covered work. This License acknowledges your - rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not - convey, without conditions so long as your license otherwise remains - in force. You may convey covered works to others for the sole purpose - of having them make modifications exclusively for you, or provide you - with facilities for running those works, provided that you comply with - the terms of this License in conveying all material for which you do - not control copyright. Those thus making or running the covered works - for you must do so exclusively on your behalf, under your direction - and control, on terms that prohibit them from making any copies of - your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under - the conditions stated below. Sublicensing is not allowed; section 10 - makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological - measure under any applicable law fulfilling obligations under article - 11 of the WIPO copyright treaty adopted on 20 December 1996, or - similar laws prohibiting or restricting circumvention of such - measures. - - When you convey a covered work, you waive any legal power to forbid - circumvention of technological measures to the extent such circumvention - is effected by exercising rights under this License with respect to - the covered work, and you disclaim any intention to limit operation or - modification of the work as a means of enforcing, against the work's - users, your or third parties' legal rights to forbid circumvention of - technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you - receive it, in any medium, provided that you conspicuously and - appropriately publish on each copy an appropriate copyright notice; - keep intact all notices stating that this License and any - non-permissive terms added in accord with section 7 apply to the code; - keep intact all notices of the absence of any warranty; and give all - recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, - and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to - produce it from the Program, in the form of source code under the - terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent - works, which are not by their nature extensions of the covered work, - and which are not combined with it such as to form a larger program, - in or on a volume of a storage or distribution medium, is called an - "aggregate" if the compilation and its resulting copyright are not - used to limit the access or legal rights of the compilation's users - beyond what the individual works permit. Inclusion of a covered work - in an aggregate does not cause this License to apply to the other - parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms - of sections 4 and 5, provided that you also convey the - machine-readable Corresponding Source under the terms of this License, - in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded - from the Corresponding Source as a System Library, need not be - included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any - tangible personal property which is normally used for personal, family, - or household purposes, or (2) anything designed or sold for incorporation - into a dwelling. In determining whether a product is a consumer product, - doubtful cases shall be resolved in favor of coverage. For a particular - product received by a particular user, "normally used" refers to a - typical or common use of that class of product, regardless of the status - of the particular user or of the way in which the particular user - actually uses, or expects or is expected to use, the product. A product - is a consumer product regardless of whether the product has substantial - commercial, industrial or non-consumer uses, unless such uses represent - the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, - procedures, authorization keys, or other information required to install - and execute modified versions of a covered work in that User Product from - a modified version of its Corresponding Source. The information must - suffice to ensure that the continued functioning of the modified object - code is in no case prevented or interfered with solely because - modification has been made. - - If you convey an object code work under this section in, or with, or - specifically for use in, a User Product, and the conveying occurs as - part of a transaction in which the right of possession and use of the - User Product is transferred to the recipient in perpetuity or for a - fixed term (regardless of how the transaction is characterized), the - Corresponding Source conveyed under this section must be accompanied - by the Installation Information. But this requirement does not apply - if neither you nor any third party retains the ability to install - modified object code on the User Product (for example, the work has - been installed in ROM). - - The requirement to provide Installation Information does not include a - requirement to continue to provide support service, warranty, or updates - for a work that has been modified or installed by the recipient, or for - the User Product in which it has been modified or installed. Access to a - network may be denied when the modification itself materially and - adversely affects the operation of the network or violates the rules and - protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, - in accord with this section must be in a format that is publicly - documented (and with an implementation available to the public in - source code form), and must require no special password or key for - unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this - License by making exceptions from one or more of its conditions. - Additional permissions that are applicable to the entire Program shall - be treated as though they were included in this License, to the extent - that they are valid under applicable law. If additional permissions - apply only to part of the Program, that part may be used separately - under those permissions, but the entire Program remains governed by - this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option - remove any additional permissions from that copy, or from any part of - it. (Additional permissions may be written to require their own - removal in certain cases when you modify the work.) You may place - additional permissions on material, added by you to a covered work, - for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you - add to a covered work, you may (if authorized by the copyright holders of - that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further - restrictions" within the meaning of section 10. If the Program as you - received it, or any part of it, contains a notice stating that it is - governed by this License along with a term that is a further - restriction, you may remove that term. If a license document contains - a further restriction but permits relicensing or conveying under this - License, you may add to a covered work material governed by the terms - of that license document, provided that the further restriction does - not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you - must place, in the relevant source files, a statement of the - additional terms that apply to those files, or a notice indicating - where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the - form of a separately written license, or stated as exceptions; - the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly - provided under this License. Any attempt otherwise to propagate or - modify it is void, and will automatically terminate your rights under - this License (including any patent licenses granted under the third - paragraph of section 11). - - However, if you cease all violation of this License, then your - license from a particular copyright holder is reinstated (a) - provisionally, unless and until the copyright holder explicitly and - finally terminates your license, and (b) permanently, if the copyright - holder fails to notify you of the violation by some reasonable means - prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is - reinstated permanently if the copyright holder notifies you of the - violation by some reasonable means, this is the first time you have - received notice of violation of this License (for any work) from that - copyright holder, and you cure the violation prior to 30 days after - your receipt of the notice. - - Termination of your rights under this section does not terminate the - licenses of parties who have received copies or rights from you under - this License. If your rights have been terminated and not permanently - reinstated, you do not qualify to receive new licenses for the same - material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or - run a copy of the Program. Ancillary propagation of a covered work - occurring solely as a consequence of using peer-to-peer transmission - to receive a copy likewise does not require acceptance. However, - nothing other than this License grants you permission to propagate or - modify any covered work. These actions infringe copyright if you do - not accept this License. Therefore, by modifying or propagating a - covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically - receives a license from the original licensors, to run, modify and - propagate that work, subject to this License. You are not responsible - for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an - organization, or substantially all assets of one, or subdividing an - organization, or merging organizations. If propagation of a covered - work results from an entity transaction, each party to that - transaction who receives a copy of the work also receives whatever - licenses to the work the party's predecessor in interest had or could - give under the previous paragraph, plus a right to possession of the - Corresponding Source of the work from the predecessor in interest, if - the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the - rights granted or affirmed under this License. For example, you may - not impose a license fee, royalty, or other charge for exercise of - rights granted under this License, and you may not initiate litigation - (including a cross-claim or counterclaim in a lawsuit) alleging that - any patent claim is infringed by making, using, selling, offering for - sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this - License of the Program or a work on which the Program is based. The - work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims - owned or controlled by the contributor, whether already acquired or - hereafter acquired, that would be infringed by some manner, permitted - by this License, of making, using, or selling its contributor version, - but do not include claims that would be infringed only as a - consequence of further modification of the contributor version. For - purposes of this definition, "control" includes the right to grant - patent sublicenses in a manner consistent with the requirements of - this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free - patent license under the contributor's essential patent claims, to - make, use, sell, offer for sale, import and otherwise run, modify and - propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express - agreement or commitment, however denominated, not to enforce a patent - (such as an express permission to practice a patent or covenant not to - sue for patent infringement). To "grant" such a patent license to a - party means to make such an agreement or commitment not to enforce a - patent against the party. - - If you convey a covered work, knowingly relying on a patent license, - and the Corresponding Source of the work is not available for anyone - to copy, free of charge and under the terms of this License, through a - publicly available network server or other readily accessible means, - then you must either (1) cause the Corresponding Source to be so - available, or (2) arrange to deprive yourself of the benefit of the - patent license for this particular work, or (3) arrange, in a manner - consistent with the requirements of this License, to extend the patent - license to downstream recipients. "Knowingly relying" means you have - actual knowledge that, but for the patent license, your conveying the - covered work in a country, or your recipient's use of the covered work - in a country, would infringe one or more identifiable patents in that - country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or - arrangement, you convey, or propagate by procuring conveyance of, a - covered work, and grant a patent license to some of the parties - receiving the covered work authorizing them to use, propagate, modify - or convey a specific copy of the covered work, then the patent license - you grant is automatically extended to all recipients of the covered - work and works based on it. - - A patent license is "discriminatory" if it does not include within - the scope of its coverage, prohibits the exercise of, or is - conditioned on the non-exercise of one or more of the rights that are - specifically granted under this License. You may not convey a covered - work if you are a party to an arrangement with a third party that is - in the business of distributing software, under which you make payment - to the third party based on the extent of your activity of conveying - the work, and under which the third party grants, to any of the - parties who would receive the covered work from you, a discriminatory - patent license (a) in connection with copies of the covered work - conveyed by you (or copies made from those copies), or (b) primarily - for and in connection with specific products or compilations that - contain the covered work, unless you entered into that arrangement, - or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting - any implied license or other defenses to infringement that may - otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or - otherwise) that contradict the conditions of this License, they do not - excuse you from the conditions of this License. If you cannot convey a - covered work so as to satisfy simultaneously your obligations under this - License and any other pertinent obligations, then as a consequence you may - not convey it at all. For example, if you agree to terms that obligate you - to collect a royalty for further conveying from those to whom you convey - the Program, the only way you could satisfy both those terms and this - License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have - permission to link or combine any covered work with a work licensed - under version 3 of the GNU Affero General Public License into a single - combined work, and to convey the resulting work. The terms of this - License will continue to apply to the part which is the covered work, - but the special requirements of the GNU Affero General Public License, - section 13, concerning interaction through a network will apply to the - combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of - the GNU General Public License from time to time. Such new versions will - be similar in spirit to the present version, but may differ in detail to - address new problems or concerns. - - Each version is given a distinguishing version number. If the - Program specifies that a certain numbered version of the GNU General - Public License "or any later version" applies to it, you have the - option of following the terms and conditions either of that numbered - version or of any later version published by the Free Software - Foundation. If the Program does not specify a version number of the - GNU General Public License, you may choose any version ever published - by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future - versions of the GNU General Public License can be used, that proxy's - public statement of acceptance of a version permanently authorizes you - to choose that version for the Program. - - Later license versions may give you additional or different - permissions. However, no additional obligations are imposed on any - author or copyright holder as a result of your choosing to follow a - later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY - APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT - HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY - OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, - THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR - PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM - IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF - ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING - WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS - THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY - GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE - USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF - DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD - PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), - EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF - SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided - above cannot be given local legal effect according to their terms, - reviewing courts shall apply local law that most closely approximates - an absolute waiver of all civil liability in connection with the - Program, unless a warranty or assumption of liability accompanies a - copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest - possible use to the public, the best way to achieve this is to make it - free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest - to attach them to the start of each source file to most effectively - state the exclusion of warranty; and each file should have at least - the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - - Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short - notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - - The hypothetical commands `show w' and `show c' should show the appropriate - parts of the General Public License. Of course, your program's commands - might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, - if any, to sign a "copyright disclaimer" for the program, if necessary. - For more information on this, and how to apply and follow the GNU GPL, see - . - - The GNU General Public License does not permit incorporating your program - into proprietary programs. If your program is a subroutine library, you - may consider it more useful to permit linking proprietary applications with - the library. If this is what you want to do, use the GNU Lesser General - Public License instead of this License. But first, please read - . - -------------------------------------------------------------------------- diff --git a/LICENSE.LGPL.txt b/LICENSE.LGPL.txt deleted file mode 100644 index 0eff200e4..000000000 --- a/LICENSE.LGPL.txt +++ /dev/null @@ -1,518 +0,0 @@ - - KD SOAP is Copyright (C) 2010-2018 Klaralvdalens Datakonsult AB. - - You may use, distribute and copy KD SOAP under the terms of - GNU Lesser General Public License version 2.1, which is displayed below. - - For the server-side library, see LICENSE.AGPL3-modified.txt - -------------------------------------------------------------------------- - - GNU LESSER GENERAL PUBLIC LICENSE - Version 2.1, February 1999 - - Copyright (C) 1991, 1999 Free Software Foundation, Inc. - 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA - - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - -[This is the first released version of the Lesser GPL. It also counts - as the successor of the GNU Library Public License, version 2, hence - the version number 2.1.] - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -Licenses are intended to guarantee your freedom to share and change -free software--to make sure the software is free for all its users. - - This license, the Lesser General Public License, applies to some -specially designated software packages--typically libraries--of the -Free Software Foundation and other authors who decide to use it. You -can use it too, but we suggest you first think carefully about whether -this license or the ordinary General Public License is the better -strategy to use in any particular case, based on the explanations -below. - - When we speak of free software, we are referring to freedom of use, -not price. Our General Public Licenses are designed to make sure that -you have the freedom to distribute copies of free software (and charge -for this service if you wish); that you receive source code or can get -it if you want it; that you can change the software and use pieces of -it in new free programs; and that you are informed that you can do -these things. - - To protect your rights, we need to make restrictions that forbid -distributors to deny you these rights or to ask you to surrender these -rights. These restrictions translate to certain responsibilities for -you if you distribute copies of the library or if you modify it. - - For example, if you distribute copies of the library, whether gratis -or for a fee, you must give the recipients all the rights that we gave -you. You must make sure that they, too, receive or can get the source -code. If you link other code with the library, you must provide -complete object files to the recipients, so that they can relink them -with the library after making changes to the library and recompiling -it. And you must show them these terms so they know their rights. - - We protect your rights with a two-step method: (1) we copyright the -library, and (2) we offer you this license, which gives you legal -permission to copy, distribute and/or modify the library. - - To protect each distributor, we want to make it very clear that -there is no warranty for the free library. Also, if the library is -modified by someone else and passed on, the recipients should know -that what they have is not the original version, so that the original -author's reputation will not be affected by problems that might be -introduced by others. - - Finally, software patents pose a constant threat to the existence of -any free program. We wish to make sure that a company cannot -effectively restrict the users of a free program by obtaining a -restrictive license from a patent holder. Therefore, we insist that -any patent license obtained for a version of the library must be -consistent with the full freedom of use specified in this license. - - Most GNU software, including some libraries, is covered by the -ordinary GNU General Public License. This license, the GNU Lesser -General Public License, applies to certain designated libraries, and -is quite different from the ordinary General Public License. We use -this license for certain libraries in order to permit linking those -libraries into non-free programs. - - When a program is linked with a library, whether statically or using -a shared library, the combination of the two is legally speaking a -combined work, a derivative of the original library. The ordinary -General Public License therefore permits such linking only if the -entire combination fits its criteria of freedom. The Lesser General -Public License permits more lax criteria for linking other code with -the library. - - We call this license the "Lesser" General Public License because it -does Less to protect the user's freedom than the ordinary General -Public License. It also provides other free software developers Less -of an advantage over competing non-free programs. These disadvantages -are the reason we use the ordinary General Public License for many -libraries. However, the Lesser license provides advantages in certain -special circumstances. - - For example, on rare occasions, there may be a special need to -encourage the widest possible use of a certain library, so that it -becomes a de-facto standard. To achieve this, non-free programs must -be allowed to use the library. A more frequent case is that a free -library does the same job as widely used non-free libraries. In this -case, there is little to gain by limiting the free library to free -software only, so we use the Lesser General Public License. - - In other cases, permission to use a particular library in non-free -programs enables a greater number of people to use a large body of -free software. For example, permission to use the GNU C Library in -non-free programs enables many more people to use the whole GNU -operating system, as well as its variant, the GNU/Linux operating -system. - - Although the Lesser General Public License is Less protective of the -users' freedom, it does ensure that the user of a program that is -linked with the Library has the freedom and the wherewithal to run -that program using a modified version of the Library. - - The precise terms and conditions for copying, distribution and -modification follow. Pay close attention to the difference between a -"work based on the library" and a "work that uses the library". The -former contains code derived from the library, whereas the latter must -be combined with the library in order to run. - - GNU LESSER GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License Agreement applies to any software library or other -program which contains a notice placed by the copyright holder or -other authorized party saying it may be distributed under the terms of -this Lesser General Public License (also called "this License"). -Each licensee is addressed as "you". - - A "library" means a collection of software functions and/or data -prepared so as to be conveniently linked with application programs -(which use some of those functions and data) to form executables. - - The "Library", below, refers to any such software library or work -which has been distributed under these terms. A "work based on the -Library" means either the Library or any derivative work under -copyright law: that is to say, a work containing the Library or a -portion of it, either verbatim or with modifications and/or translated -straightforwardly into another language. (Hereinafter, translation is -included without limitation in the term "modification".) - - "Source code" for a work means the preferred form of the work for -making modifications to it. For a library, complete source code means -all the source code for all modules it contains, plus any associated -interface definition files, plus the scripts used to control -compilation and installation of the library. - - Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running a program using the Library is not restricted, and output from -such a program is covered only if its contents constitute a work based -on the Library (independent of the use of the Library in a tool for -writing it). Whether that is true depends on what the Library does -and what the program that uses the Library does. - - 1. You may copy and distribute verbatim copies of the Library's -complete source code as you receive it, in any medium, provided that -you conspicuously and appropriately publish on each copy an -appropriate copyright notice and disclaimer of warranty; keep intact -all the notices that refer to this License and to the absence of any -warranty; and distribute a copy of this License along with the -Library. - - You may charge a fee for the physical act of transferring a copy, -and you may at your option offer warranty protection in exchange for a -fee. - - 2. You may modify your copy or copies of the Library or any portion -of it, thus forming a work based on the Library, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) The modified work must itself be a software library. - - b) You must cause the files modified to carry prominent notices - stating that you changed the files and the date of any change. - - c) You must cause the whole of the work to be licensed at no - charge to all third parties under the terms of this License. - - d) If a facility in the modified Library refers to a function or a - table of data to be supplied by an application program that uses - the facility, other than as an argument passed when the facility - is invoked, then you must make a good faith effort to ensure that, - in the event an application does not supply such function or - table, the facility still operates, and performs whatever part of - its purpose remains meaningful. - - (For example, a function in a library to compute square roots has - a purpose that is entirely well-defined independent of the - application. Therefore, Subsection 2d requires that any - application-supplied function or table used by this function must - be optional: if the application does not supply it, the square - root function must still compute square roots.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Library, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Library, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote -it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Library. - -In addition, mere aggregation of another work not based on the Library -with the Library (or with a work based on the Library) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may opt to apply the terms of the ordinary GNU General Public -License instead of this License to a given copy of the Library. To do -this, you must alter all the notices that refer to this License, so -that they refer to the ordinary GNU General Public License, version 2, -instead of to this License. (If a newer version than version 2 of the -ordinary GNU General Public License has appeared, then you can specify -that version instead if you wish.) Do not make any other change in -these notices. - - Once this change is made in a given copy, it is irreversible for -that copy, so the ordinary GNU General Public License applies to all -subsequent copies and derivative works made from that copy. - - This option is useful when you wish to copy part of the code of -the Library into a program that is not a library. - - 4. You may copy and distribute the Library (or a portion or -derivative of it, under Section 2) in object code or executable form -under the terms of Sections 1 and 2 above provided that you accompany -it with the complete corresponding machine-readable source code, which -must be distributed under the terms of Sections 1 and 2 above on a -medium customarily used for software interchange. - - If distribution of object code is made by offering access to copy -from a designated place, then offering equivalent access to copy the -source code from the same place satisfies the requirement to -distribute the source code, even though third parties are not -compelled to copy the source along with the object code. - - 5. A program that contains no derivative of any portion of the -Library, but is designed to work with the Library by being compiled or -linked with it, is called a "work that uses the Library". Such a -work, in isolation, is not a derivative work of the Library, and -therefore falls outside the scope of this License. - - However, linking a "work that uses the Library" with the Library -creates an executable that is a derivative of the Library (because it -contains portions of the Library), rather than a "work that uses the -library". The executable is therefore covered by this License. -Section 6 states terms for distribution of such executables. - - When a "work that uses the Library" uses material from a header file -that is part of the Library, the object code for the work may be a -derivative work of the Library even though the source code is not. -Whether this is true is especially significant if the work can be -linked without the Library, or if the work is itself a library. The -threshold for this to be true is not precisely defined by law. - - If such an object file uses only numerical parameters, data -structure layouts and accessors, and small macros and small inline -functions (ten lines or less in length), then the use of the object -file is unrestricted, regardless of whether it is legally a derivative -work. (Executables containing this object code plus portions of the -Library will still fall under Section 6.) - - Otherwise, if the work is a derivative of the Library, you may -distribute the object code for the work under the terms of Section 6. -Any executables containing that work also fall under Section 6, -whether or not they are linked directly with the Library itself. - - 6. As an exception to the Sections above, you may also combine or -link a "work that uses the Library" with the Library to produce a -work containing portions of the Library, and distribute that work -under terms of your choice, provided that the terms permit -modification of the work for the customer's own use and reverse -engineering for debugging such modifications. - - You must give prominent notice with each copy of the work that the -Library is used in it and that the Library and its use are covered by -this License. You must supply a copy of this License. If the work -during execution displays copyright notices, you must include the -copyright notice for the Library among them, as well as a reference -directing the user to the copy of this License. Also, you must do one -of these things: - - a) Accompany the work with the complete corresponding - machine-readable source code for the Library including whatever - changes were used in the work (which must be distributed under - Sections 1 and 2 above); and, if the work is an executable linked - with the Library, with the complete machine-readable "work that - uses the Library", as object code and/or source code, so that the - user can modify the Library and then relink to produce a modified - executable containing the modified Library. (It is understood - that the user who changes the contents of definitions files in the - Library will not necessarily be able to recompile the application - to use the modified definitions.) - - b) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (1) uses at run time a - copy of the library already present on the user's computer system, - rather than copying library functions into the executable, and (2) - will operate properly with a modified version of the library, if - the user installs one, as long as the modified version is - interface-compatible with the version that the work was made with. - - c) Accompany the work with a written offer, valid for at least - three years, to give the same user the materials specified in - Subsection 6a, above, for a charge no more than the cost of - performing this distribution. - - d) If distribution of the work is made by offering access to copy - from a designated place, offer equivalent access to copy the above - specified materials from the same place. - - e) Verify that the user has already received a copy of these - materials or that you have already sent this user a copy. - - For an executable, the required form of the "work that uses the -Library" must include any data and utility programs needed for -reproducing the executable from it. However, as a special exception, -the materials to be distributed need not include anything that is -normally distributed (in either source or binary form) with the major -components (compiler, kernel, and so on) of the operating system on -which the executable runs, unless that component itself accompanies -the executable. - - It may happen that this requirement contradicts the license -restrictions of other proprietary libraries that do not normally -accompany the operating system. Such a contradiction means you cannot -use both them and the Library together in an executable that you -distribute. - - 7. You may place library facilities that are a work based on the -Library side-by-side in a single library together with other library -facilities not covered by this License, and distribute such a combined -library, provided that the separate distribution of the work based on -the Library and of the other library facilities is otherwise -permitted, and provided that you do these two things: - - a) Accompany the combined library with a copy of the same work - based on the Library, uncombined with any other library - facilities. This must be distributed under the terms of the - Sections above. - - b) Give prominent notice with the combined library of the fact - that part of it is a work based on the Library, and explaining - where to find the accompanying uncombined form of the same work. - - 8. You may not copy, modify, sublicense, link with, or distribute -the Library except as expressly provided under this License. Any -attempt otherwise to copy, modify, sublicense, link with, or -distribute the Library is void, and will automatically terminate your -rights under this License. However, parties who have received copies, -or rights, from you under this License will not have their licenses -terminated so long as such parties remain in full compliance. - - 9. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Library or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Library (or any work based on the -Library), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Library or works based on it. - - 10. Each time you redistribute the Library (or any work based on the -Library), the recipient automatically receives a license from the -original licensor to copy, distribute, link with or modify the Library -subject to these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties with -this License. - - 11. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Library at all. For example, if a patent -license would not permit royalty-free redistribution of the Library by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Library. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply, and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 12. If the distribution and/or use of the Library is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Library under this License -may add an explicit geographical distribution limitation excluding those -countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - - 13. The Free Software Foundation may publish revised and/or new -versions of the Lesser General Public License from time to time. -Such new versions will be similar in spirit to the present version, -but may differ in detail to address new problems or concerns. - -Each version is given a distinguishing version number. If the Library -specifies a version number of this License which applies to it and -"any later version", you have the option of following the terms and -conditions either of that version or of any later version published by -the Free Software Foundation. If the Library does not specify a -license version number, you may choose any version ever published by -the Free Software Foundation. - - 14. If you wish to incorporate parts of the Library into other free -programs whose distribution conditions are incompatible with these, -write to the author to ask for permission. For software which is -copyrighted by the Free Software Foundation, write to the Free -Software Foundation; we sometimes make exceptions for this. Our -decision will be guided by the two goals of preserving the free status -of all derivatives of our free software and of promoting the sharing -and reuse of software generally. - - NO WARRANTY - - 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO -WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. -EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR -OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY -KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE -LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME -THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN -WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY -AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU -FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR -CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE -LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING -RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A -FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF -SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH -DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Libraries - - If you develop a new library, and you want it to be of the greatest -possible use to the public, we recommend making it free software that -everyone can redistribute and change. You can do so by permitting -redistribution under these terms (or, alternatively, under the terms -of the ordinary General Public License). - - To apply these terms, attach the following notices to the library. -It is safest to attach them to the start of each source file to most -effectively convey the exclusion of warranty; and each file should -have at least the "copyright" line and a pointer to where the full -notice is found. - - - - Copyright (C) - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA - -Also add information on how to contact you by electronic and paper mail. - -You should also get your employer (if you work as a programmer) or -your school, if any, to sign a "copyright disclaimer" for the library, -if necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the - library `Frob' (a library for tweaking knobs) written by James - Random Hacker. - - , 1 April 1990 - Ty Coon, President of Vice - -That's all there is to it! diff --git a/LICENSE.US.txt b/LICENSE.US.txt deleted file mode 100644 index d9aed5e09..000000000 --- a/LICENSE.US.txt +++ /dev/null @@ -1,148 +0,0 @@ -KD Soap COMMERCIAL LICENSE AGREEMENT -FOR COMMERCIAL VERSIONS -March 27, 2002 - - -IMPORTANT-READ CAREFULLY: This Klaralvdalens Datakonsult AB End-User -License Agreement ("EULA") is a legal agreement between you (either an -individual or a legal entity) and Klaralvdalens Datakonsult AB -("KDAB") for the Klaralvdalens Datakonsult AB software product(s) -accompanying this EULA, which include(s) computer software and may -include "online" or electronic documentation, associated media, and -printed materials ("Licensed Product"). - -The Licensed Product is protected by copyright laws and international -copyright treaties, as well as other intellectual property laws and -treaties. The Licensed Product is licensed, not sold. - -By installing, copying, or otherwise using the Licensed Product, you -agree to be bound by the terms of this EULA. If you do not agree to -the terms of this EULA, do not install, copy, or otherwise use the -Licensed Product; you may, however, return it to your place of -purchase for a full refund. In addition, by installing, copying, or -otherwise using any updates or other components of the Licensed -Product that you receive separately as part of the Licensed Product -("Updates"), you agree to be bound by any additional license terms -that accompany such Updates. If you do not agree to the additional -license terms that accompany such Updates, you may not install, copy, -or otherwise use such Updates. - -Upon your acceptance of the terms and conditions of this EULA, KDAB -grants you the right to use the Licensed Product in the manner -provided below. - -KDAB grants to you as an individual a personal, nonexclusive, -nontransferable license to make and use copies of the Licensed Product -for the sole purposes of designing, developing, and testing your -software product(s) ("Applications"). You may install copies of the -Licensed Product on an unlimited number of computers provided that you -are the only individual using the Licensed Product. If you are an -entity, KDAB grants you the right to designate one, and only one, -individual within your organization who shall have the sole right to -use the Licensed Product in the manner provided above. You may at any -time, but not more frequently that once every six (6) months, -designate another individual to replace the current designated user by -notifying KDAB, so long as there is no more than one designated user -at any given time. - - -GENERAL TERMS THAT APPLY TO APPLICATIONS AND REDISTRIBUTABLES -KDAB grants you a nonexclusive, royalty-free right to reproduce and -distribute the object code form of any portion of the Licensed Product -("Redistributables") for execution on any operating system of a type -listed in the License Certificate ("Platforms"). Copies of -Redistributables may only be distributed with and for the sole purpose -of executing Applications permitted under this License Agreement that -you have created using the Licensed Product. Under no circumstances -may any copies of Redistributables be distributed separately. - -The license granted in this EULA for you to create your own -Applications and distribute them and the Redistributables (if any) to -your customers is subject to all of the following conditions: (i) all -copies of the Applications you create must bear a valid copyright -notice, either your own or the copyright notice that appears on the -Licensed Product; (ii) you may not remove or alter any copyright, -trademark or other proprietary rights notice contained in any portion -of the Licensed Product; (iii) Redistributables, if any, shall be -licensed to your customer "as is" (KDAB MAKES NO WARRANTIES OR -REPRESENTATIONS VIS-A-VIS YOUR CUSTOMER WITH RESPECT TO -REDISTRIBUTABLES, AND KDAB EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES -VIS-A-VIS YOUR CUSTOMER, WHETHER EXPRESS OR IMPLIED, ORAL OR WRITTEN, -INCLUDING, BUT NOT LIMITED TO ANY IMPLIED WARRANTY OF MERCHANTABILITY -OR FITNESS FOR ANY PARTICULAR PURPOSE, WHETHER OR NOT KDAB KNOWS, HAS -REASON TO KNOW, HAS BEEN ADVISED OR IS OTHERWISE AWARE OF SUCH -PURPOSE); (iv) you will indemnify and hold KDAB, its related companies -and its suppliers, harmless from and against any claims or liabilities -arising out of the use, reproduction or distribution of your -Applications; (v) your Applications must be written using a licensed, -registered copy of the Licensed Product; (vi) your Applications must -add primary and substantial functionality to the Licensed Product; -(vii) your Applications may not pass on functionality which in any way -makes it possible for others to create Applications with the Software; -(viii) your Applications may not compete with the Licensed Product; -(ix)) you may not use KDAB's or any of its suppliers' names, logos, or -trademarks to market your programs, except to state that your program -was written using the Licensed Product. - -LICENSEE'S BREACH OF CONTRACT -In addition to penalties, other sanctions and the like as stated in -the Swedish Copyright Act (1960:729), or successive legislation as it -may appear, the Licensee agrees to pay a Contractual Fine in case of -his/her/their breach of any of the above mentioned obligations, -including but not limited to, the Licensee's obligation to let only -one person per license use the Software as stated under above. The -Contractual Fine is EUR 5000 and is payable by the Licensee to the -Licenser immediately upon the Licenser having reasonably demonstrated -that the Licensee is in breach of his obligations in this Agreement. - -WARRANTY DISCLAIMER -THE LICENSED PRODUCT IS LICENSED TO YOU "AS IS". TO THE MAXIMUM -EXTENT PERMITTED BY APPLICABLE LAW, KDAB ON BEHALF OF ITSELF AND ITS -SUPPLIERS, DISCLAIMS ALL WARRANTIES AND CONDITIONS, EITHER EXPRESS OR -IMPLIED, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND -NON-INFRINGEMENT WITH REGARD TO THE LICENSED PRODUCT. THIS WARRANTY -DISCLAIMER NOTWITHSTANDING, YOU MAY HAVE SPECIFIC LEGAL RIGHTS WHICH -MAY VARY FROM STATE/JURISDICTION TO STATE/JURISDICTION. - - -LIMITATION OF LIABILITY -IF, KDAB'S WARRANTY DISCLAIMER NOTWITHSTANDING, KDAB IS HELD LIABLE TO -YOU, WHETHER IN CONTRACT, TORT OR ANY OTHER LEGAL THEORY, BASED ON THE -LICENSED PRODUCT, KDAB'S ENTIRE LIABILITY TO YOU AND YOUR EXCLUSIVE -REMEDY SHALL BE, AT KDAB'S OPTION, EITHER (A) RETURN OF THE PRICE YOU -PAID FOR THE LICENSED PRODUCT, OR (B) REPAIR OR REPLACEMENT OF THE -LICENSED PRODUCT, PROVIDED YOU RETURN TO KDAB ALL COPIES OF THE -LICENSED PRODUCT AS ORIGINALLY DELIVERED TO YOU. KDAB SHALL NOT UNDER -ANY CIRCUMSTANCES BE LIABLE TO YOU BASED ON FAILURE OF THE LICENSED -PRODUCT IF THE FAILURE RESULTED FROM ACCIDENT, ABUSE OR -MISAPPLICATION, NOR SHALL KDAB UNDER ANY CIRCUMSTANCES BE LIABLE FOR -SPECIAL DAMAGES, PUNITIVE OR EXEMPLARY DAMAGES, DAMAGES FOR LOSS OF -PROFITS OR INTERRUPTION OF BUSINESS OR FOR LOSS OR CORRUPTION OF DATA. -ANY AWARD OF DAMAGES FROM KDAB TO YOU SHALL NOT EXCEED THE TOTAL AMOUNT -YOU HAVE PAID TO KDAB IN CONNECTION WITH THIS EULA. - - -SUPPORT AND UPDATES -You will receive email based, software developer support and access to -Updates to the Licensed Product for one year from the date of initial -delivery, in accordance with KDAB support policies and procedures. -Such policies and procedures may be changed from time to time. - - -GENERAL PROVISIONS -This EULA may only be modified in writing signed by you and an -authorized officer of KDAB. All terms of any purchase order or other -ordering document shall be superseded by this EULA. If any provision -of the EULA is found void or unenforceable, the remainder will remain -valid and enforceable according to its terms. If any remedy provided -is determined to have failed for its essential purpose, all -limitations of liability and exclusions of damages set forth in this -EULA shall remain in effect. - -This EULA shall be construed, interpreted and governed by the laws of -Sweden, the venue to be Sunne Tingsratt. The EULA gives you specific -legal rights; you may have others, which vary from state to state and -from country to country. KDAB reserves all rights not specifically -granted in this EULA. - diff --git a/LICENSE.txt b/LICENSE.txt index c89e2e706..ef9c1db1b 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,104 +1,14 @@ -KD Soap COMMERCIAL LICENSE AGREEMENT -FOR COMMERCIAL VERSIONS -Version 1.0 +License +======= +The KD Soap Software is © Klarälvdalens Datakonsult AB (KDAB), and is +available under the terms of the MIT license. -Copyright of this license text (C) 2001 Trolltech AS and (C) 2002-2010 -Klaralvdalens Datakonsult AB. All rights reserved. License text used -with kind permission of Trolltech AS. The software and accompanying -material is Copyright (C) 2010-2018 Klaralvdalens Datakonsult AB. +Note that this project requires the 3rd party 'libkode' submodule +that is licensed separately with LGPL-2.0-or-later; however, libkode +is used for code-generation only and the resulting code can be made +available under any license. -This non-exclusive non-transferable License Agreement ("Agreement") is -between you ("Licensee") and Klaralvdalens Datakonsult AB (KDAB), and -pertains to the Klaralvdalens Datakonsult AB software product(s) -accompanying this Agreement, which include(s) computer software and -may include "online" or electronic documentation, associated media, -and printed materials, including the source code, example programs and -the documentation ("Software"). - - - COPYRIGHT AND RESTRICTIONS - -1. All intellectual property rights in the Software are owned by KDAB -and are protected by Swedish copyright laws, other applicable -copyright laws, and international treaty provisions. KDAB retains all -rights not expressly granted. No title, property rights or copyright -in the Software or in any modifications to the Software shall pass to -the Licensee under any circumstances. The Software is licensed, not -sold. - -2. By installing, copying, or otherwise using the Software, you agree -to be bound by the terms of this agreement. If you do not agree to the -terms of this Agreement, do not install, copy, or otherwise use the -Software. - -3. Upon your acceptance of the terms and conditions of this Agreement, -KDAB grants you the right to use the Software in the manner provided -below. - -4. KDAB grants to you as an individual a personal, nonexclusive, -non-transferable license to make and use copies of the Software for -the sole purposes of designing, developing, testing and distributing -your software product(s) ("Applications"). You may install copies of -the Software on an unlimited number of computers provided that you are -the only individual using the Software. If you are an entity, KDAB -grants you the right to designate one, and only one, individual within -your organization who shall have the sole right to use the Software in -the manner provided above. - -5. The license granted in this Agreement for you to create and -distribute your own Applications is subject to all of the following -conditions: (i) all copies of the Applications you create must bear a -valid copyright notice, either your own or the copyright notice that -appears on the Software; (ii) you may not remove or alter any -copyright, trademark or other proprietary rights notice contained in -any portion of the Software; (iii) you will indemnify and hold KDAB, its -related companies and its suppliers, harmless from and against any -claims or liabilities arising out of the use and/or reproduction of -your Applications; (iv) your Applications must be written using a -licensed, registered copy of the Software; (v) your Applications must -add primary and substantial functionality to the Software; (vi) your -Applications may not pass on functionality which in any way makes it -possible for others to create Applications with the Software; (vii) -your Applications may not compete with the Software; (viii) you may -not use KDAB's or any of its suppliers' names, logos, or trademarks to -market your programs, except to state that your program was written -using the Software. - -6. LICENSEE'S BREACH OF CONTRACT -In addition to penalties, other sanctions and the like as stated in -the Swedish Copyright Act (1960:729), or successive legislation as it -may appear, the Licensee agrees to pay a Contractual Fine in case of -his/her/their breach of any of the above mentioned obligations, -including but not limited to, the Licensee's obligation to let only -one person per license use the Software as stated under above. The -Contractual Fine is EUR 5000 and is payable by the Licensee to the -Licenser immediately upon the Licenser having reasonably demonstrated -that the Licensee is in breach of his obligations in this Agreement. - -7. WARRANTY DISCLAIMER -THE SOFTWARE IS LICENSED TO YOU "AS IS". TO THE MAXIMUM EXTENT -PERMITTED BY APPLICABLE LAW, KDAB ON BEHALF OF ITSELF AND ITS SUPPLIERS, -DISCLAIMS ALL WARRANTIES AND CONDITIONS, EITHER EXPRESS OR IMPLIED, -INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT WITH -REGARD TO THE SOFTWARE. - -8. LIMITATION OF LIABILITY -IF, KDAB'S WARRANTY DISCLAIMER NOTWITHSTANDING, KDAB IS HELD LIABLE TO -YOU BASED ON THE SOFTWARE, KDAB'S ENTIRE LIABILITY TO YOU AND YOUR -EXCLUSIVE REMEDY SHALL BE, AT REPAIR OR REPLACEMENT OF THE SOFTWARE, -PROVIDED YOU RETURN TO KDAB ALL COPIES OF THE SOFTWARE AS ORIGINALLY -DELIVERED TO YOU. KDAB SHALL NOT UNDER ANY CIRCUMSTANCES BE LIABLE TO -YOU BASED ON FAILURE OF THE SOFTWARE IF THE FAILURE RESULTED FROM -ACCIDENT, ABUSE OR MISAPPLICATION, NOR SHALL KDAB UNDER ANY -CIRCUMSTANCES BE LIABLE FOR SPECIAL DAMAGES, PUNITIVE OR EXEMPLARY -DAMAGES, DAMAGES FOR LOSS OF PROFITS OR INTERRUPTION OF BUSINESS OR -FOR LOSS OR CORRUPTION OF DATA. - -9. This Agreement may only be modified in writing signed by you and an -authorized officer of KDAB. All terms of any purchase order or other -ordering document shall be superseded by this Agreement. - -10. This Agreement shall be construed, interpreted and governed by the -laws of Sweden, the venue to be Sunne Tingsratt. +Various other freely distributable files are contained in the unittests +and are not used in the library code itself. +See the full license texts in the LICENSES folder. diff --git a/LICENSES/BSD-3-Clause.txt b/LICENSES/BSD-3-Clause.txt new file mode 100644 index 000000000..0741db789 --- /dev/null +++ b/LICENSES/BSD-3-Clause.txt @@ -0,0 +1,26 @@ +Copyright (c) . All rights reserved. + +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/LICENSES/GPL-2.0-only.txt b/LICENSES/GPL-2.0-only.txt new file mode 100644 index 000000000..17cb28643 --- /dev/null +++ b/LICENSES/GPL-2.0-only.txt @@ -0,0 +1,117 @@ +GNU GENERAL PUBLIC LICENSE +Version 2, June 1991 + +Copyright (C) 1989, 1991 Free Software Foundation, Inc. +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + +Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. + +Preamble + +The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. + +To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. + +For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. + +We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. + +Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. + +Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. + +The precise terms and conditions for copying, distribution and modification follow. + +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. + +1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. + +You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. + +2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. + + c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. + +3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. + +If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. + +4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. + +5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. + +6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. + +7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. + +This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. + +8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. + +9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. + +10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. + +NO WARRANTY + +11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +END OF TERMS AND CONDITIONS + +How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. + + one line to give the program's name and an idea of what it does. Copyright (C) yyyy name of author + + This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. + +signature of Ty Coon, 1 April 1989 Ty Coon, President of Vice diff --git a/LICENSES/LicenseRef-Microsoft.txt b/LICENSES/LicenseRef-Microsoft.txt new file mode 100644 index 000000000..2c9ea3b2f --- /dev/null +++ b/LICENSES/LicenseRef-Microsoft.txt @@ -0,0 +1,43 @@ +Permission to copy, display, perform, modify and distribute the +WS-Discovery Specification (the "Specification", which includes +WSDL and schema documents), and to authorize others to do the +foregoing, in any medium without fee or royalty is hereby granted +for the purpose of developing and evaluating the Specification. + +BEA Systems, Canon, Intel, Microsoft, and webMethods, Inc. +(collectively, the "Co-Developers") each agree to grant a license +to third parties, under royalty-free and other reasonable, +non-discriminatory terms and conditions, to their respective +essential Licensed Claims, which reasonable, non-discriminatory +terms and conditions may include, for example, but are not limited +to, an affirmation of the obligation to grant reciprocal licenses +under any of the licensee's patents that are necessary to implement +the Specification. + +DISCLAIMERS: + +THE SPECIFICATION IS PROVIDED "AS IS," AND THE CO-DEVELOPERS MAKE +NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING, +BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE, NON-INFRINGEMENT, OR TITLE; THAT THE CONTENTS +OF THE SPECIFICATION ARE SUITABLE FOR ANY PURPOSE; NOR THAT THE +IMPLEMENTATION OF SUCH CONTENTS WILL NOT INFRINGE ANY THIRD PARTY +PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS. + +THE CO-DEVELOPERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, +SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY +USE OF THE SPECIFICATION OR THE PERFORMANCE OR IMPLEMENTATION OF +THE CONTENTS THEREOF. + +You may remove these disclaimers from your modified versions of the +Specification provided that you effectively disclaim all warranties +and liabilities on behalf of all Co-developers and any copyright +holders in the copies of any such modified versions you distribute. + +The name and trademarks of the Co-developers may NOT be used in any +manner, including advertising or publicity pertaining to the +Specification or its contents without specific, written prior +permission. Title to copyright in the Specification will at all +times remain with Microsoft. + +No other rights are granted by implication, estoppel or otherwise. diff --git a/LICENSES/LicenseRef-Novell.txt b/LICENSES/LicenseRef-Novell.txt new file mode 100644 index 000000000..81a91b87a --- /dev/null +++ b/LICENSES/LicenseRef-Novell.txt @@ -0,0 +1,36 @@ + +Use and redistribution of this work is subject to the developer license +agreement through which this work is made available. Pursuant to that license +agreement, Novell hereby grants You a royalty-free, non-exclusive license to +include Novell's sample code in Your product(s) that interoperate with the +applicable Novell product, and worldwide distribution rights to market, +distribute, or sell Novell's sample code as a component of Your product. + +THE WORK 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 NOVELL OR 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 WORK OR THE USE OR OTHER DEALINGS IN THE WORK. + + +Alternatively, the contents of this file may be used under the terms of +GNU General Public License Version 2 (the "GPL") as explained below. +If you wish to allow use of your version of this file only under the terms +of the GPL, and not to allow others to use your version of this file under +the provisions appearing above, indicate your decision by deleting the +provisions above and replace them with the notice and other provisions required +by the GPL. If you do not delete the provisions above, a recipient may use +your version of this file under the above provisions of the GPL. + + +This file is free software; you can redistribute it and/or modify it under the +terms of version 2 of the GNU General Public License as published by the +Free Software Foundation. This program is distributed in the hope that it will +be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +for more details. You should have received a copy of the GNU General Public License +along with this program; if not, contact Novell, Inc. + +To contact Novell about this file by physical or electronic mail, you may find +current contact information at www.novell.com. diff --git a/LICENSES/LicenseRef-OASIS.txt b/LICENSES/LicenseRef-OASIS.txt new file mode 100644 index 000000000..a41202afc --- /dev/null +++ b/LICENSES/LicenseRef-OASIS.txt @@ -0,0 +1,15 @@ +All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website. + +This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English. + +The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns. + +This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. + +OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. + +OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include such claims on its website, but disclaims any obligation to do so. + +OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims. + +The name "OASIS" is trademarks of OASIS, the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see http://www.oasis-open.org/who/trademark.php for above guidance. diff --git a/LICENSES/LicenseRef-SportingExchange.txt b/LICENSES/LicenseRef-SportingExchange.txt new file mode 100644 index 000000000..cbdbfd25c --- /dev/null +++ b/LICENSES/LicenseRef-SportingExchange.txt @@ -0,0 +1,6 @@ +The presentation, distribution or other dissemination of the information contained herein by The Sporting Exchange Limited (Betfair) is not a license, either expressly or impliedly, to any intellectual property owned or controlled by Betfair. +Save as provided by statute and to the fullest extent permitted by law, the following provisions set out the entire liability of Betfair (including any liability for the acts and omissions of its employees, agents and sub-contractors) to the User in respect of the use of its WSDL file whether in contract, tort, statute, equity or otherwise: +(a) The User acknowledges and agrees that (except as expressly provided in this Agreement) the WSDL is provided "AS IS" without warranties of any kind (whether express or implied); +(b) All conditions, warranties, terms and undertakings (whether express or implied, statutory or otherwise relating to the delivery, performance, quality, uninterrupted use, fitness for purpose, occurrence or reliability of the WSDL are hereby excluded to the fullest extent permitted by law; and +(c) Betfair shall not be liable to the User for loss of profit (whether direct or indirect), loss of contracts or goodwill, lost advertising, loss of data or any type of special, indirect, consequential or economic loss (including loss or damage suffered by the User as a result of an action brought by a third party) even if such loss was reasonably foreseeable or Betfair had been advised of the possibility of the User incurring such loss. +No exclusion or limitation set out in this Agreement shall apply in the case of fraud or fraudulent concealment, death or personal injury resulting from the negligence of either party or any of its employees, agents or sub-contractors; and/or any breach of the obligations implied by (as appropriate) section 12 of the Sale of Goods Act 1979, section 2 of the Supply of Goods and Services Act 1982 or section 8 of the Supply of Goods (Implied Terms) Act 1973. diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt new file mode 100644 index 000000000..2071b23b0 --- /dev/null +++ b/LICENSES/MIT.txt @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) + +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/LICENSES/W3C.txt b/LICENSES/W3C.txt new file mode 100644 index 000000000..a485d1021 --- /dev/null +++ b/LICENSES/W3C.txt @@ -0,0 +1,29 @@ +W3C SOFTWARE NOTICE AND LICENSE + +This work (and included software, documentation such as READMEs, or other related items) is being provided by the copyright holders under the following license. + +License + +By obtaining, using and/or copying this work, you (the licensee) agree that you have read, understood, and will comply with the following terms and conditions. + +Permission to copy, modify, and distribute this software and its documentation, with or without modification, for any purpose and without fee or royalty is hereby granted, provided that you include the following on ALL copies of the software and documentation or portions thereof, including modifications: + + The full text of this NOTICE in a location viewable to users of the redistributed or derivative work. + + Any pre-existing intellectual property disclaimers, notices, or terms and conditions. If none exist, the W3C Software Short Notice should be included (hypertext is preferred, text is permitted) within the body of any redistributed or derivative code. + + Notice of any changes or modifications to the files, including the date changes were made. (We recommend you provide URIs to the location from which the code is derived.) + +Disclaimers + +THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS. + +COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION. + +The name and trademarks of copyright holders may NOT be used in advertising or publicity pertaining to the software without specific, written prior permission. Title to copyright in this software and any associated documentation will at all times remain with copyright holders. + +Notes + +This version: http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231 + +This formulation of W3C's notice and license became active on December 31 2002. This version removes the copyright ownership notice such that this license can be used with materials other than those owned by the W3C, reflects that ERCIM is now a host of the W3C, includes references to this specific dated version of the license, and removes the ambiguous grant of "use". Otherwise, this version is the same as the previous version and is written so as to preserve the Free Software Foundation's assessment of GPL compatibility and OSI's certification under the Open Source Definition. diff --git a/README-commercial.txt b/README-commercial.txt deleted file mode 100644 index 565a1b503..000000000 --- a/README-commercial.txt +++ /dev/null @@ -1,42 +0,0 @@ -Introduction -============ -KD Soap is a Qt-based client-side and server-side SOAP component. - -It can be used to create client applications for web services and also provides -the means to create web services without the need for any further component such -as a dedicated web server. - -For more information, see http://www.kdab.com/kdab-products/kd-soap - -Contributing -============ -KDAB will happily accept external contributions, but substantial -contributions will require a signed Copyright Assignment Agreement. -Contact info@kdab.com for more information. - -Licensing -========= -Copyright (C) 2010-2018 Klarälvdalens Datakonsult AB, a KDAB Group company, - -Commercial licensing terms are available in the included file - LICENSE.txt (for non-US customers) -or - LICENSE.US.txt (for US customers) -, respectively. - -For terms of redistribution, refer to the license agreement. - -About KDAB -========== -KD Soap is supported and maintained by Klarälvdalens Datakonsult AB (KDAB). - -KDAB, the Qt experts, provide 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. - - -KD SOAP and the KD SOAP logo are registered trademarks of Klaralvdalens Datakonsult AB -in the European Union, the United States, and/or other countries. Other product and -company names and logos may be trademarks or registered trademarks of their respective companies. diff --git a/README.md b/README.md new file mode 100644 index 000000000..7b5f5ca64 --- /dev/null +++ b/README.md @@ -0,0 +1,91 @@ +
+ + +
+ +# Introduction + +KD Soap is a Qt-based client-side and server-side SOAP component. + +It can be used to create client applications for web services and also provides +the means to create web services without the need for any further component such +as a dedicated web server. + +KD Soap targets C++ programmers who use Qt in their applications. + +For more information, see + +## Using KD Soap + +KD Soap requires Qt 5.9.0 or newer, and a compiler with C++11 support. +Qt6 support is added starting with KD Soap version 2.0, and requires +a compiler with C++17 support. + +See [INSTALL.txt](INSTALL.txt) for installation instructions using CMake. + +Learn more at our: + +* [online API reference](https://kdab.github.io/KDSoap) +* [programmers manual with examples](docs/manual/kdsoap.pdf) +* [sorted example programs](examples/) + +## Contact + +* See our official home page: +* Visit us on GitHub: +* Email info@kdab.com with questions about this product. + +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) + +## Get Involved + +KDAB will happily accept external contributions. + +Please submit your contributions or issue reports from our GitHub space at +. + +Thanks to our [contributors](CONTRIBUTORS.txt). + +## License + +The KD Soap Software is © Klarälvdalens Datakonsult AB (KDAB), and is +available under the terms of the [MIT](LICENSES/MIT.txt) license. + +Contact KDAB at for any licensing queries. + +Note that this project requires the 3rd party 'libkode' submodule +that is licensed separately with LGPL-2.0-or-later; however, libkode +is used for code-generation only and the resulting code can be made +available under any license. + +Various other freely distributable files are contained in the unittests +and are not used in the library code itself. + +## About KDAB + +KD Soap is supported and maintained by Klarälvdalens Datakonsult AB (KDAB). + +The [KDAB](https://www.kdab.com) Group is a globally recognized provider for software consulting, +development and training, specializing in embedded devices and complex cross-platform desktop +applications. In addition to being leading experts in Qt, C++ and 3D technologies for over +two decades, KDAB provides deep expertise across the stack, including Linux, Rust and modern UI +frameworks. With 100+ employees from 20 countries and offices in Sweden, Germany, USA, France +and UK, KDAB serves clients around the world. + +Please visit [the KDAB website](https://www.kdab.com) to meet the people who write code like this. + +[Blogs and publications](https://www.kdab.com/resources) + +[Videos (Tutorials and more)](https://www.youtube.com/@KDABtv) + +[Software Developer Training for Qt, Modern C++, Rust, OpenGL and more](https://training.kdab.com) + +[Software Consulting and Development Services for Embedded and Desktop Applications](https://www.kdab.com/services/) + +KD SOAP and the KD SOAP logo are registered trademarks of Klaralvdalens Datakonsult AB +in the European Union, the United States, and/or other countries. Other product and +company names and logos may be trademarks or registered trademarks of their respective companies. diff --git a/README.txt b/README.txt deleted file mode 100644 index 9a31f43a3..000000000 --- a/README.txt +++ /dev/null @@ -1,69 +0,0 @@ -# KD Soap [![Logo](https://github.com/KDAB/KDSoap/blob/master/images/kdsoap-medium.png)](http://www.kdab.com/products/kd-soap) -Introduction -============ -KD Soap is a Qt-based client-side and server-side SOAP component. - -It can be used to create client applications for web services and also provides -the means to create web services without the need for any further component such -as a dedicated web server. - -KD Soap targets C++ programmers who use Qt in their applications. - -For more information, see http://www.kdab.com/kdab-products/kd-soap - -Using KD Soap -============= -KD Soap requires Qt 4.7.0 or newer. - -See INSTALL.txt or INSTALL-cmake.txt for installation instructions. -(Note that the qmake and CMake buildsystems are fully supported) - -After reading the introductory overview files in doc/ -you will find more information at three places: - - detailed browsable API reference: doc/refman/index.html - or: http://docs.kdab.com/kdsoap - programmers manual with examples: doc/manual/kdsoap.pdf - our sorted example programs: examples/ - -Contact -======= -* Join our mailing list: https://mail.kdab.com/mailman/listinfo/kdsoap-interest -* See our official home page: http://www.kdab.com/products/kd-soap -* Visit us on GitHub: https://github.com/KDAB/KDSoap - -Get Involved -============ -KDAB will happily accept external contributions, but substantial -contributions will require a signed Copyright Assignment Agreement. -Contact info@kdab.com for more information. - -Please submit your contributions or issue reports from our GitHub space at -https://github.com/KDAB/KDSoap - -License -======= -KD Soap is (C) 2010-2018, Klaralvdalens Datakonsult AB, and is available -under the terms of: -* the LGPL (see LICENSE.LGPL.txt for details) - (except libkdsoap-server, see LICENSE.AGPL3-modified.txt) -* the GPL (see LICENSE.GPL.txt for details) - (except libkdsoap-server, see LICENSE.AGPL3-modified.txt) -* the KDAB commercial license, provided that you buy a license. - please contact sales@kdab.com if you are interested in buying commercial licenses. - -About KDAB -========== -KD Soap is supported and maintained by Klarälvdalens Datakonsult AB (KDAB). - -KDAB, the Qt experts, provide 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. - -Please visit http://www.kdab.com to meet the people who write code like this. - -KD SOAP and the KD SOAP logo are registered trademarks of Klaralvdalens Datakonsult AB -in the European Union, the United States, and/or other countries. Other product and -company names and logos may be trademarks or registered trademarks of their respective companies. diff --git a/REUSE.toml b/REUSE.toml new file mode 100644 index 000000000..4524a211b --- /dev/null +++ b/REUSE.toml @@ -0,0 +1,94 @@ +version = 1 +SPDX-PackageName = "KDSoap" +SPDX-PackageSupplier = "" +SPDX-PackageDownloadLocation = "https://www.github.com/KDAB/KDSoap" + +#misc source code +[[annotations]] +path = ["unittests/**/**.xsd", "unittests/**/**.wsdl", "unittests/**/**.XSD", "unittests/**/**.xml", "testtools/**.qrc", "examples/**/**.qrc", "examples/**/**.wsdl", "**.html", "**.css", "docs/manual/**.pdf", "**.bat", "**.pem"] +precedence = "aggregate" +SPDX-FileCopyrightText = "Klarälvdalens Datakonsult AB, a KDAB Group company " +SPDX-License-Identifier = "MIT" + +#artwork +[[annotations]] +path = ["images/**.png", "docs/api/**.png", "docs/**.png", "docs/**.odg", "examples/**/**.mng", "examples/**/**.gif"] +precedence = "aggregate" +SPDX-FileCopyrightText = "Klarälvdalens Datakonsult AB, a KDAB Group company " +SPDX-License-Identifier = "MIT" + +#misc documentation +[[annotations]] +path = ["**md", "**.txt", "**.html", "docs/manual/**.pdf"] +precedence = "aggregate" +SPDX-FileCopyrightText = "Klarälvdalens Datakonsult AB, a KDAB Group company " +SPDX-License-Identifier = "MIT" + +#misc config files +[[annotations]] +path = ["CMakePresets.json", ".pre-commit-config.yaml", ".codespellrc", ".krazy", ".cmake-format.py", ".clang-format", ".clang-tidy", ".clazy", ".codedocs", ".gitignore", ".gitmodules", ".mdlrc", ".mdlrc.rb", ".pep8", ".pylintrc", "docs/api/Doxyfile.cmake", "distro/**", "REUSE.toml"] +precedence = "aggregate" +SPDX-FileCopyrightText = "Klarälvdalens Datakonsult AB, a KDAB Group company " +SPDX-License-Identifier = "BSD-3-Clause" + +[[annotations]] +path = "kdwsdl2cpp/schemas/soapenc-1.1.xsd" +precedence = "aggregate" +SPDX-FileCopyrightText = "2001 DevelopMentor and 2001 W3C (Massachusetts Institute of Technology, Institut National de Recherche en Informatique et en Automatique, Keio University). All Rights Reserved." +SPDX-License-Identifier = "W3C" + +[[annotations]] +path = "kdwsdl2cpp/schemas/soapenc-1.2.xsd" +precedence = "aggregate" +SPDX-FileCopyrightText = "2003 W3C(R) (MIT, ERCIM, Keio), All Rights Reserved." +SPDX-License-Identifier = "W3C" + +[[annotations]] +path = "kdwsdl2cpp/schemas/schemas.qrc" +precedence = "aggregate" +SPDX-FileCopyrightText = "2005 Tobias Koenig " +SPDX-License-Identifier = "MIT" + +#3rdparty +[[annotations]] +path = "cmake/ECM/modules/**" +precedence = "aggregate" +SPDX-FileCopyrightText = "The KDE Project" +SPDX-License-Identifier = "BSD-3-Clause" + +[[annotations]] +path = ["unittests/groupwise_wsdl/**.xsd", "unittests/groupwise_wsdl/**.wsdl"] +precedence = "aggregate" +SPDX-FileCopyrightText = "2005-2006 Novell, Inc All Rights reserved." +SPDX-License-Identifier = "GPL-2.0-only OR LicenseRef-Novell" + +[[annotations]] +path = "unittests/salesforce_wsdl/**.wsdl" +precedence = "aggregate" +SPDX-FileCopyrightText = "1999-2010 salesforce.com, inc. All Rights reserved." +SPDX-License-Identifier = "BSD-3-Clause" + +[[annotations]] +path = ["unittests/soap_over_udp/**.wsdl", "unittests/soap_over_udp/docs.oasis-open.org/ws-dd/discovery/1.1/os/wsdd-discovery-1.1-schema-os.xsd", "unittests/soap_over_udp/www.w3.org/2006/03/addressing/ws-addr.xsd"] +precedence = "aggregate" +SPDX-FileCopyrightText = "2009 OASIS(r) All Rights reserved." +SPDX-License-Identifier = "LicenseRef-OASIS" + +[[annotations]] +path = "unittests/webcalls_wsdl/**.wsdl" +precedence = "aggregate" +SPDX-FileCopyrightText = "2003-2004 The Sporting Exchange Limited. All rights reserved." +SPDX-License-Identifier = "LicenseRef-SportingExchange" + +[[annotations]] +path = ["unittests/ws_discovery_wsdl/schemas.xmlsoap.org/ws/2005/04/discovery/ws-discovery.xsd", "unittests/ws_discovery_wsdl/schemas.xmlsoap.org/ws/2004/08/addressing", "unittests/ws_discovery_wsdl/**.wsdl"] +precedence = "aggregate" +SPDX-FileCopyrightText = "pyright © 2002-2004 BEA Systems Inc., International Business Machines Corporation, Microsoft Corporation, Inc, SAP AG, and Sun Microsystems, Inc.. All rights reserved." +SPDX-License-Identifier = "LicenseRef-Microsoft" + +# doxygen awesome +[[annotations]] +path = "docs/api/doxygen-awesome.css" +precedence = "aggregate" +SPDX-FileCopyrightText = "2021 - 2023 jothepro" +SPDX-License-Identifier = "MIT" diff --git a/ReadMe.md b/ReadMe.md deleted file mode 120000 index c3ca07460..000000000 --- a/ReadMe.md +++ /dev/null @@ -1 +0,0 @@ -README.txt \ No newline at end of file diff --git a/add_license_blurb.sh b/add_license_blurb.sh deleted file mode 100755 index e40f6380a..000000000 --- a/add_license_blurb.sh +++ /dev/null @@ -1,94 +0,0 @@ -#!/bin/bash - -origAuthor="" -moreAuthors="" -#AUTHORS: sets author variables for use in the file header -# origAuthor = is the fullname and email of the person who created the file -# moreAuthors = is a list (fullname and email) of other people who contributed -# more than once to the file since creation. -# newLine = if moreAuthors is not empty, newLine will contain a newline char. -AUTHORS() { - origAuthor="`git log --format='%aN <%aE>' --reverse $1 | grep 'kdab\.com' | head -1 | awk '{printf(" Author: "); for(i=1;i -f1` - moreAuthors=`git log --format='%aN <%aE>' $FILE | grep -v $origEmail | grep 'kdab\.com' | sort | uniq -c | sort -nr | \ - awk '{ \ - if($1>1) {\ - printf(" Author: "); \ - for(i=2;i "$FILE".tmp -/**************************************************************************** -** Copyright (C) $thisYear Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com. -** All rights reserved. -** -** This file is part of the KD Soap library. -** -** Licensees holding valid commercial KD Soap licenses may use this file in -** accordance with the KD Soap Commercial License Agreement provided with -** the Software. -** -** This file may be distributed and/or modified under the terms of the -** GNU Lesser General Public License version 2.1 and version 3 as published by the -** Free Software Foundation and appearing in the file LICENSE.LGPL.txt included. -** -** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE -** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. -** -** Contact info@kdab.com if any conditions of this licensing are not -** clear to you. -** -**********************************************************************/ - -EOF - cat "$FILE" >> "$FILE".tmp - mv "$FILE".tmp "$FILE" -done - -#remove the following exit if you want to add a header to CMakeLists.txt files -exit - -find "$@" -name 'CMakeLists.txt' | while read FILE; do - if grep -qiE "Copyright \(C\) [0-9, -]{4,} Klar.*lvdalens Datakonsult AB" "$FILE" ; then continue; fi - AUTHORS $FILE - cat < "$FILE".tmp -# -# Copyright (C) $thisYear Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com. -# All rights reserved. -# -# This file is part of the KD Soap library. -# -# Licensees holding valid commercial KD Soap licenses may use this file in -# accordance with the KD Soap Commercial License Agreement provided with -# the Software. -# -# This file may be distributed and/or modified under the terms of the -# GNU Lesser General Public License version 2.1 and version 3 as published by the -# Free Software Foundation and appearing in the file LICENSE.LGPL.txt included. -# -# This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE -# WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. -# -# Contact info@kdab.com if any conditions of this licensing are not -# clear to you. -# - -EOF - cat "$FILE" >> "$FILE".tmp - mv "$FILE".tmp "$FILE" -done diff --git a/autogen.py b/autogen.py deleted file mode 100755 index 018d94663..000000000 --- a/autogen.py +++ /dev/null @@ -1,9 +0,0 @@ -#!/usr/bin/env python -from autogen.autogen import autogen - -project = "KDSoap" -version = "1.7.50" -subprojects = ["KDSoapClient", "KDSoapServer"] -prefixed = False - -autogen(project, version, subprojects, prefixed, policyVersion = 2) diff --git a/autogen/.gitignore b/autogen/.gitignore deleted file mode 100644 index 0d20b6487..000000000 --- a/autogen/.gitignore +++ /dev/null @@ -1 +0,0 @@ -*.pyc diff --git a/autogen/__init__.py b/autogen/__init__.py deleted file mode 100644 index e69de29bb..000000000 diff --git a/autogen/autogen.py b/autogen/autogen.py deleted file mode 100644 index f8ae0a921..000000000 --- a/autogen/autogen.py +++ /dev/null @@ -1,123 +0,0 @@ -import os, sys, subprocess - -if sys.version_info[0] != 2: - print ("Autogen detected that you are not using Python2.") - print ("Please make sure you have Python2 installed and run:") - print (" python2 autogen.py") - sys.exit(0) - -from cpack import CPackGenerateConfiguration -from configure import ConfigureScriptGenerator -from header import ForwardHeaderGenerator - -def parseSvnInfo( stdout ): - lines = stdout.splitlines() - repositoryUrl = [line for line in lines if line.startswith('URL:')][0].split( ':', 1 )[ 1 ] - isTagged = repositoryUrl.find( 'tags/' ) != -1 - repositoryRevision = [line for line in lines if line.startswith('Revision:')][0].split( ':', 1 )[ 1 ].strip() - return isTagged, repositoryRevision - -def checkVCS( sourceDirectory ): - repositoryType = '' - for i in xrange( 20 ): - listing = os.listdir( sourceDirectory + '/..' * i ) - if '.svn' in listing: - repositoryType = 'svn' - break - elif '.git' in listing: - repositoryType = 'git' - break - - isTagged = False - repositoryRevision = "unknown" - try: - if repositoryType == 'git': - p = subprocess.Popen( ["git", "describe", "--exact-match"], cwd = sourceDirectory, stdout = subprocess.PIPE, stderr = subprocess.PIPE ) - stdout, stderr = p.communicate() - if p.returncode == 0: - # git tag - isTagged = True - repositoryRevision = stdout.strip() - if p.returncode != 0: - p = subprocess.Popen( ["git", "svn", "info"], cwd = sourceDirectory, stdout = subprocess.PIPE, stderr = subprocess.PIPE ) - stdout, stderr = p.communicate() - if p.returncode == 0: - # git-svn revision - isTagged, repositoryRevision = parseSvnInfo( stdout ) - if p.returncode != 0: - p = subprocess.Popen( ["git", "rev-parse", "HEAD"], cwd = sourceDirectory, stdout = subprocess.PIPE, stderr = subprocess.PIPE ) - stdout, stderr = p.communicate() - if p.returncode == 0: - # svn revision - repositoryRevision = stdout.strip()[:8] - elif repositoryType == 'svn': - p = subprocess.Popen( ["svn", "info"], cwd = sourceDirectory, stdout = subprocess.PIPE, stderr = subprocess.PIPE ) - stdout, stderr = p.communicate() - if p.returncode == 0: - isTagged, repositoryRevision = parseSvnInfo( stdout ) - else: - raise Exception("Unknown repository type") - except: - print( "Error: Not a valid SVN or Git repository: {0}".format( sourceDirectory ) ) - sys.exit( 1 ) - - return ( repositoryRevision, isTagged ) - -def autogen(project, version, subprojects, prefixed, forwardHeaderMap = {}, steps=["generate-cpack", "generate-configure", "generate-forward-headers"], installPrefix="$$INSTALL_PREFIX", policyVersion = 1): - global __policyVersion - __policyVersion = policyVersion - sourceDirectory = os.path.abspath( os.path.dirname( os.path.dirname( __file__ ) ) ) - buildDirectory = os.getcwd() - - print( "-- Using source directory: {0}".format( sourceDirectory ) ) - - ( repositoryRevision, isTagged ) = checkVCS( sourceDirectory ) - - print( "-- Using repository information: revision={0} isTagged={1}".format( repositoryRevision, isTagged ) ) - - if "generate-cpack" in steps: - licensePath = os.path.join( sourceDirectory, "LICENSE.txt" ) - - # if this is a tag, use the tagname provided in repositoryRevision so that cpack can generate the correct filename - if isTagged: - realVersion = repositoryRevision.replace( project.lower() + "-", "" ) - else: - realVersion = version - - cpackConfigurationGenerator = CPackGenerateConfiguration( project, realVersion, sourceDirectory, - buildDirectory, repositoryRevision, licensePath, isTaggedRevision = isTagged ) - cpackConfigurationGenerator.run() - - if "generate-configure" in steps: - configureScriptGenerator = ConfigureScriptGenerator( project, sourceDirectory, version ) - configureScriptGenerator.run() - - includePath = os.path.join( sourceDirectory, "include" ) - srcPath = os.path.join( sourceDirectory, "src" ) - - if subprojects and "generate-cpack" in steps: - forwardHeaderGenerator = ForwardHeaderGenerator( - copy = True, path = sourceDirectory, includepath = includePath, srcpath = srcPath, - project = project, subprojects = subprojects, prefix = installPrefix, prefixed = prefixed, - additionalHeaders = forwardHeaderMap - ) - forwardHeaderGenerator.run() - - print( "-- Auto-generation done." ) - - with file( ".license.accepted", 'a' ): - os.utime( ".license.accepted", None ) - print( "-- License marked as accepted." ) - - print( "-- Wrote build files to: {0}".format( buildDirectory ) ) - print( "-- Now running configure script." ) - print( "" ) - sys.stdout.flush() - - configureFile = 'configure.bat' if sys.platform == 'win32' else 'configure.sh' - configurePath = os.path.join( sourceDirectory, configureFile ) - os.execvp( configurePath, [configurePath] + sys.argv[1:] ) - -def policyVersion(): - global __policyVersion - return __policyVersion diff --git a/autogen/configure.bat.in b/autogen/configure.bat.in deleted file mode 100644 index 71642e745..000000000 --- a/autogen/configure.bat.in +++ /dev/null @@ -1,350 +0,0 @@ -@echo off -set PRODUCT_CAP=@PRODUCT_UPPERCASE@ -set product_low=@PRODUCT_LOWERCASE@ -set Product_mix=@PRODUCT_MIXEDCASE@ -set Product_Space="@PRODUCT_MIXEDCASE_SPACED@" - -set VERSION=@VERSION@ - -set SOURCE_DIR=%~dp0 -set PACKSCRIPTS_DIR=../admin/packscripts - -set shared=yes -set debug=no -set release=yes -set debug_and_release=no -set prefix= -set unittests=no -set static_qt=no -set host_qmake= -set target_qmake= -set QMAKE_ARGS= - -if exist %PACKSCRIPTS_DIR% ( - set unittests=yes - goto :CheckLicenseComplete -) - -if exist .license.accepted goto :CheckLicenseComplete - -set license_file= - -if exist %SOURCE_DIR%\LICENSE.@PRODUCT_LICENSE_FREE@.txt ( - if exist %SOURCE_DIR%\LICENSE.US.txt ( - if exist %SOURCE_DIR%\LICENSE.txt ( - echo. - echo Please choose your license. - echo. - echo Type 1 for the @PRODUCT_LICENSE_FREE_NAME@ ^(@PRODUCT_LICENSE_FREE@^). - echo Type 2 for the %Product_Space% Commercial License for USA/Canada. - echo Type 3 for the %Product_Space% Commercial License for anywhere outside USA/Canada. - echo Anything else cancels. - echo. - set /p license=Select: - ) - ) else ( - license=1 - ) -) else ( - if exist %SOURCE_DIR%\LICENSE.US.txt ( - license=2 - ) else ( - if exist %SOURCE_DIR%\LICENSE.txt ( - license=3 - ) else ( - echo "Couldn't find license file, aborting" - exit /B 1 - ) - ) -) - -if "%license%" == "1" ( - set license_name="@PRODUCT_LICENSE_FREE_NAME@ (@PRODUCT_LICENSE_FREE@)" - set license_file=LICENSE.@PRODUCT_LICENSE_FREE@.txt - goto :CheckLicense -) else ( - if "%license%" == "2" ( - set license_name="%Product_Space% USA/Canada Commercial License" - set license_file=LICENSE.US.txt - goto :CheckLicense - ) else ( - if "%license%" == "3" ( - set license_name="%Product_Space% Commercial License" - set license_file=LICENSE.txt - goto :CheckLicense - ) else ( - exit /B 1 - ) - ) -) - -:CheckLicense -echo. -echo License Agreement -echo. -echo You are licensed to use this software under the terms of -echo the %license_name%. -echo. -echo Type '?' to view the %license_name%. -echo Type 'yes' to accept this license offer. -echo Type 'no' to decline this license offer. -echo. -set /p answer=Do you accept the terms of this license? - -if "%answer%" == "no" goto :CheckLicenseFailed -if "%answer%" == "yes" ( - echo. > .license.accepted - goto :CheckLicenseComplete -) -if "%answer%" == "?" more %SOURCE_DIR%\%license_file% -goto :CheckLicense - -:CheckLicenseFailed -echo You are not licensed to use this software. -exit /B 1 - -:CheckLicenseComplete - -rem This is the batch equivalent of KDAB_QT_PATH=`qmake -query QT_INSTALL_PREFIX`... -for /f "tokens=*" %%V in ('qmake -query QT_INSTALL_PREFIX') do set KDAB_QT_PATH=%%V - -if "%KDAB_QT_PATH%" == "" ( - echo You need to add qmake to the PATH - exit /B 1 -) - -echo Qt found: %KDAB_QT_PATH% - -del /Q /S Makefile* 2> NUL -del /Q /S debug 2> NUL -del /Q /S release 2> NUL -if exist src\src.pro ( - del /Q lib 2> NUL - del /Q bin 2> NUL -) -:Options -if "%1" == "" goto :EndOfOptions - -if "%1" == "-prefix" goto :Prefix -if "%1" == "/prefix" goto :Prefix - -if "%1" == "-override-version" goto :OverrideVersion -if "%1" == "/override-version" goto :OverrideVersion - -if "%1" == "-unittests" goto :Unittests -if "%1" == "/unittests" goto :Unittests - -if "%1" == "-no-unittests" goto :NoUnittests -if "%1" == "/no-unittests" goto :NoUnittests - -if "%1" == "-shared" goto :Shared -if "%1" == "/shared" goto :Shared - -if "%1" == "-static" goto :Static -if "%1" == "/static" goto :Static - -if "%1" == "-qt_static" goto :QT_Static -if "%1" == "/qt_static" goto :QT_Static - -if "%1" == "-release" goto :Release -if "%1" == "/release" goto :Release - -if "%1" == "-debug_and_release" goto :Debug_And_Release -if "%1" == "/debug_and_release" goto :Debug_And_Release - -if "%1" == "-debug" goto :Debug -if "%1" == "/debug" goto :Debug - -if "%1" == "-hostqmake" goto :HostQMake -if "%1" == "/hostqmake" goto :HostQMake - -if "%1" == "-qmake" goto :QMake -if "%1" == "/qmake" goto :QMake - -if "%1" == "-help" goto :Help -if "%1" == "/help" goto :Help -if "%1" == "--help" goto :Help -if "%1" == "/?" goto :Help - -echo Unknown option: %1 -goto :usage - -:OptionWithArg -shift -:OptionNoArg -shift -goto :Options - -:Prefix - set prefix="%2" - goto :OptionWithArg - echo Installation not supported, -prefix option ignored - goto :OptionWithArg -rem goto :usage -:OverrideVersion - set VERSION=%2 - goto :OptionWithArg -:Unittests - set unittests=yes - goto :OptionNoArg -:NoUnittests - set unittests=no - goto :OptionNoArg -:Shared - set shared=yes - goto :OptionNoArg -:Static - set shared=no - goto :OptionNoArg -:Release - set release=yes - set debug=no - set debug_and_release=no - goto :OptionNoArg - -:Debug_And_Release - set release=no - set debug=no - set debug_and_release=yes - goto :OptionNoArg -:Debug - set debug=yes - set release=no - set debug_and_release=no - goto :OptionNoArg -:QT_Static -if "%STATIC_BUILD_SUPPORTED%" == "true" ( - set qt_static=yes - goto :OptionNoArg -) else ( - echo Static build not supported, -static option not allowed - goto :usage -) -:HostQMake - set host_qmake=%2 - goto :OptionWithArg -:QMake - set target_qmake=%2 - goto :OptionWithArg -:Unittests -:Help - goto :usage - -:EndOfOptions - -if "%debug_and_release%" == "yes" ( - set QMAKE_ARGS=%QMAKE_ARGS% CONFIG+=debug_and_release CONFIG+=build_all - goto :END_BUILDTYPE -) - -if "%release%" == "yes" ( - if "%debug%" == "yes" ( - set QMAKE_ARGS=%QMAKE_ARGS% CONFIG+=debug_and_release CONFIG+=build_all - set release="yes (combined)" - set debug="yes (combined)" - ) else ( - set QMAKE_ARGS=%QMAKE_ARGS% CONFIG+=release CONFIG-=debug CONFIG-=debug_and_release - ) -) else ( - if "%debug%" == "yes" ( - set QMAKE_ARGS=%QMAKE_ARGS% CONFIG-=release CONFIG+=debug CONFIG-=debug_and_release - ) else ( - echo "Internal error. At least one of debug and release must be set" - goto :CleanEnd - ) -) -:END_BUILDTYPE - -if "%shared%" == "yes" ( - set QMAKE_ARGS=%QMAKE_ARGS% CONFIG+=shared -) else ( - set QMAKE_ARGS=%QMAKE_ARGS% CONFIG+=static - rem This is needed too, when Qt is static, otherwise it sets -DQT_DLL and linking fails. - if "%qt_static%" == "yes" ( - set QMAKE_ARGS=%QMAKE_ARGS% CONFIG+=qt_static - ) -) - -if "%unittests%" == "yes" ( - set QMAKE_ARGS=%QMAKE_ARGS% CONFIG+=unittests -) - -set default_prefix=C:\\KDAB\\%Product_mix%-%VERSION% - -if "%prefix%" == "" ( - set prefix="%default_prefix%" -) -set QMAKE_ARGS=%QMAKE_ARGS% %PRODUCT_CAP%_INSTALL_PREFIX=%prefix% - -set QMAKE_ARGS=%QMAKE_ARGS% VERSION=%VERSION% -set QMAKE_ARGS=%QMAKE_ARGS% CONFIG+=%product_low%_target - -if exist "%KDAB_QT_PATH%\include\Qt\private" ( - set QMAKE_ARGS=%QMAKE_ARGS% CONFIG+=have_private_qt_headers - set QMAKE_ARGS=%QMAKE_ARGS% INCLUDEPATH+=%KDAB_QT_PATH%/include/Qt/private -) else ( - rem echo KDAB_QT_PATH must point to an installation that has private headers installed. - rem echo Some features will not be available. -) - -if not "%host_qmake%" == "" ( - set HOST_QMAKE_ARGS=%QMAKE_ARGS% - set QMAKE_ARGS=%QMAKE_ARGS% CONFIG+=crosscompiling CONFIG+=win32crosscompiling -) - -echo %Product_mix% v%VERSION% configuration: -echo. -echo Debug...................: %debug% (default: no) -echo Release.................: %release% (default: yes) -echo Shared build............: %shared% (default: yes) -echo Compiled-In Unit Tests..: %unittests% (default: no) -echo. - -if "%target_qmake%" == "" set target_qmake=%KDAB_QT_PATH%\bin\qmake - -%target_qmake% %SOURCE_DIR%\%product_low%.pro -recursive %QMAKE_ARGS% "%PRODUCT_CAP%_BASE=%CD%" - -if errorlevel 1 ( - echo qmake failed - goto :CleanEnd -) - -if not "%host_qmake%" == "" ( - mkdir kdwsdl2cpp - cd kdwsdl2cpp - %host_qmake% %SOURCE_DIR%\kdwsdl2cpp -recursive %HOST_QMAKE_ARGS% -) - -echo Ok, now run nmake (for Visual Studio) or mingw32-make (for mingw) to build the framework. -goto :end - -:usage -IF "%1" NEQ "" echo %0: unknown option "%1" -echo usage: %0 [options] -echo where options include: -echo. -echo -prefix ^ -echo set installation prefix to ^, used by make install -echo. -echo -release / -debug -echo build in debug/release mode (default is release) -echo. -echo -static / -shared -echo build static/shared libraries (default shared) -echo. -echo -unittests / -no-unittests -echo enable/disable compiled-in unittests (default is disabled) -echo -echo -qmake ^ -echo explicitly sets the qmake location, instead of using the -echo qmake in the path. -echo. -echo -hostqmake ^ -echo when cross-compiling, the qmake in the path will be used for -echo compiling the product's code, but the host qmake will be used -echo to compile the host tools (code generators). -echo. - -:CleanEnd - -:end diff --git a/autogen/configure.py b/autogen/configure.py deleted file mode 100644 index 867e22d29..000000000 --- a/autogen/configure.py +++ /dev/null @@ -1,56 +0,0 @@ -import os.path, sys - -class ConfigureScriptGenerator(): - def __init__( self, project, path, version, install = True, static = True ): - self.__project = project - self.__path = path - self.__version = version - self.__staticSupported = static - autogen_dir = os.path.dirname( __file__ ) - self.__winTemplate = os.path.abspath( autogen_dir + "/configure.bat.in" ) - self.__unixTemplate = os.path.abspath( autogen_dir + "/configure.sh.in" ) - if not os.path.exists( self.__path + "/LICENSE.GPL.txt") and not os.path.exists( self.__path + "/LICENSE.LGPL.txt" ): - print "no free license (LICENSE.GPL.txt or LICENSE.LGPL.txt) exists" - sys.exit( 1 ) - self.__freeLicense = "LGPL" if os.path.exists( self.__path + "/LICENSE.LGPL.txt" ) else "GPL" - self.__licenseName = { 'GPL': 'GNU General Public License', - 'LGPL': 'GNU Lesser General Public License' } - - def run( self ): - self.__generateFile( self.__unixTemplate, os.path.abspath( self.__path + "/configure.sh" ), "unix" ) - self.__generateFile( self.__winTemplate, os.path.abspath( self.__path + "/configure.bat" ), "win32" ) - - def __replaceValues( self, value ): - mixedname = self.__project - mixedname = mixedname.replace( "KD", "KD " ) - value = value.replace( "@VERSION@", self.__version ) - strStaticSupported = 'false' - if self.__staticSupported: - strStaticSupported = 'true' - value = value.replace( "@STATIC_BUILD_SUPPORTED@", strStaticSupported ) - value = value.replace( "@PRODUCT_UPPERCASE@", self.__project.upper() ) - value = value.replace( "@PRODUCT_LOWERCASE@", self.__project.lower() ) - value = value.replace( "@PRODUCT_MIXEDCASE@", self.__project ) - value = value.replace( "@PRODUCT_MIXEDCASE_SPACED@", mixedname ) - value = value.replace( "@PRODUCT_LICENSE_FREE@", self.__freeLicense ) - value = value.replace( "@PRODUCT_LICENSE_FREE_NAME@", self.__licenseName[self.__freeLicense] ) - return value - - def __generateFile( self, templateFile, outputFile, platformString ): - if platformString == "win32": - lineSep = "\r\n" - else: - lineSep = "\n" - - with open( outputFile, "wb" ) as fOutput: - with open(os.path.dirname(__file__) + '/' + os.path.basename(outputFile) + '.in') as configureFile: - configure = configureFile.read().splitlines() - for line in ( configure ): - fOutput.write( self.__replaceValues( line.rstrip() ) + lineSep ) - - # make file executable for Unix - if platformString != "win32": - try: - os.chmod( outputFile, 0755 ) - except SyntaxError: # Python 2.6 says syntax error on Windows, ignore it - print "ignoring failing os.chmod call, configure.sh won't be executable" diff --git a/autogen/configure.sh.in b/autogen/configure.sh.in deleted file mode 100755 index 489d46156..000000000 --- a/autogen/configure.sh.in +++ /dev/null @@ -1,340 +0,0 @@ -#!/bin/bash -PRODUCT=@PRODUCT_UPPERCASE@ -Product=@PRODUCT_MIXEDCASE@ -product=@PRODUCT_LOWERCASE@ -ProductSpace="@PRODUCT_MIXEDCASE_SPACED@" - -VERSION=@VERSION@ - -STATIC_BUILD_SUPPORTED=@STATIC_BUILD_SUPPORTED@ - -SOURCE_DIR=`dirname "$0"` -PACKSCRIPTS_DIR="$SOURCE_DIR"/../admin/packscripts - -hide_symbols=yes -shared=yes -debug=no -release=yes -prefix= -unittests=no -hostqmake= -targetqmake= - -[ -d "$PACKSCRIPTS_DIR" ] && unittests=yes - -function die { - echo "$1" 1>&2 - exit 1 -} - -function check_license { - - [ -d "$PACKSCRIPTS_DIR" ] && return 0 - [ -f .license.accepted ] && return 0 - - if [ -f "$SOURCE_DIR"/LICENSE.@PRODUCT_LICENSE_FREE@.txt -a -f "$SOURCE_DIR"/LICENSE.US.txt -a -f "$SOURCE_DIR"/LICENSE.txt ] ; then - echo - echo "Please choose your license." - echo - echo "Type 1 for the @PRODUCT_LICENSE_FREE_NAME@ (@PRODUCT_LICENSE_FREE@)." - echo "Type 2 for the $ProductSpace Commercial License for USA/Canada." - echo "Type 3 for the $ProductSpace Commercial License for anywhere outside USA/Canada." - echo "Anything else cancels." - echo - echo -n "Select: " - read license - - elif [ -f "$SOURCE_DIR"/LICENSE.@PRODUCT_LICENSE_FREE@.txt ] ; then - license="1" - - elif [ -f "$SOURCE_DIR"/LICENSE.US.txt ] ; then - license="2" - - elif [ -f "$SOURCE_DIR"/LICENSE.txt ] ; then - license="3" - else - die "Couldn't find license file, aborting" - fi - - if [ "$license" = "1" ]; then - license_name="@PRODUCT_LICENSE_FREE_NAME@ (@PRODUCT_LICENSE_FREE@)" - license_file="$SOURCE_DIR"/LICENSE.@PRODUCT_LICENSE_FREE@.txt - elif [ "$license" = "2" ]; then - license_name="$ProductSpace USA/Canada Commercial License" - license_file="$SOURCE_DIR"/LICENSE.US.txt - elif [ "$license" = "3" ]; then - license_name="$ProductSpace Commercial License" - license_file="$SOURCE_DIR"/LICENSE.txt - else - return 1 - fi - - while true ; do - cat <&2 - echo "usage: $0 [options]" 1>&2 - cat <&2 -where options include: - -EOF -cat <&2 - -prefix - install $ProductSpace into -EOF -cat <&2 - - -release / -debug - build in debug/release mode -EOF -if [ "$STATIC_BUILD_SUPPORTED" = "true" ]; then - cat <&2 - - -static / -shared - build static/shared libraries -EOF -fi -cat <&2 - - -[no-]hide-symbols (Unix only) - reduce the number of exported symbols - - -[no-]unittests - enable/disable compiled-in unittests - - -qmake - explicitly sets the qmake location, instead of using the - qmake in the path. - - -hostqmake - when cross-compiling, the qmake in the path will be used for - compiling the product's code, but the host qmake will be used - to compile the host tools (code generators). - - -spec - compile $ProductSpace for specific Qt-supported target - -EOF - exit 1 -} - - -while [ $# -ne 0 ] ; do - case "$1" in - -prefix) - shift - if [ $# -eq 0 ] ; then - echo "-prefix needs an argument" 2>&1 - usage - fi - prefix="$1" - ;; - -no-hide-symbols) - hide_symbols=no - ;; - -hide-symbols) - hide_symbols=yes - ;; - -override-version) # undocumented by design - shift - if [ $# -eq 0 ] ; then - echo "-override-version needs an argument" 2>&1 - usage - fi - VERSION="$1" - ;; - -no-unittests) - unittests=no - ;; - -unittests) - unittests=yes - ;; - -shared) - shared=yes - ;; - -static) - if [ "$STATIC_BUILD_SUPPORTED" != "true" ]; then - echo "Static build not supported, -static option not allowed" 2>&1 - usage - fi - shared=no - ;; - -debug) - debug=yes - release=no - ;; - -release) - debug=no - release=yes - ;; - -spec) - shift - if [ $# -eq 0 ] ; then - echo "-spec needs an argument" 2>&1 - usage - fi - SPEC="-spec $1" - ;; - -hostqmake) - shift - if [ $# -eq 0 ] ; then - echo "-hostqmake needs an argument" 2>&1 - usage - fi - hostqmake="$1" - ;; - -qmake) - shift - if [ $# -eq 0 ] ; then - echo "-make needs an argument" 2>&1 - usage - fi - targetqmake="$1" - ;; - *) - usage "$1" - ;; - esac - shift -done - -if [ -n "$targetqmake" ] ; then - if [ -z "$QTDIR" ] ; then - QTDIR="$($targetqmake -query QT_INSTALL_PREFIX)" - if [ $? -ne 0 ] ; then - die "$targetqmake -query QT_INSTALL_PREFIX gave an error" - fi - fi -else - for qmk in qmake qmake-qt5 qmake-qt4 - do - which "$qmk" >/dev/null 2>&1 - if [ $? -eq 0 -a -z "$targetqmake" ] ; then - QTDIR="$($qmk -query QT_INSTALL_PREFIX)" - if [ $? -eq 0 ] ; then - targetqmake=$qmk - break - fi - fi - done - [ -z "$targetqmake" ] && die "You need qmake or qmake-qt5 or qmake-qt4 in the PATH" -fi - - -find . -name debug -o -name release -o -name Makefile\* | xargs rm -rf - -if [ -f src/src.pro ] ; then - rm -rf lib bin -fi - -default_prefix=/usr/local/KDAB/$Product-$VERSION -if [ -z "$prefix" ] ; then - prefix="$default_prefix" -fi - -QMAKE_ARGS="$QMAKE_ARGS VERSION=$VERSION" -QMAKE_ARGS="$QMAKE_ARGS CONFIG+=${product}_target" - -if [ "$debug" = "yes" ]; then - QMAKE_ARGS="$QMAKE_ARGS CONFIG-=release CONFIG+=debug CONFIG-=debug_and_release" -fi - -if [ "$release" = "yes" ]; then - QMAKE_ARGS="$QMAKE_ARGS CONFIG+=release CONFIG-=debug CONFIG-=debug_and_release" -fi - -[ "$hide_symbols" = "yes" ] && QMAKE_ARGS="$QMAKE_ARGS CONFIG+=hide_symbols" - -[ "$unittests" = "yes" ] && QMAKE_ARGS="$QMAKE_ARGS CONFIG+=unittests" - -if [ "$shared" = "yes" ]; then - QMAKE_ARGS="$QMAKE_ARGS CONFIG-=static CONFIG-=staticlib CONFIG+=shared" -else - QMAKE_ARGS="$QMAKE_ARGS CONFIG+=static CONFIG+=staticlib CONFIG-=shared" -fi - -if [ -d "$QTDIR/include/Qt/private" ] ; then - QMAKE_ARGS="$QMAKE_ARGS CONFIG+=have_private_qt_headers" - QMAKE_ARGS="$QMAKE_ARGS INCLUDEPATH+=$QTDIR/include/Qt/private" -#else - #echo "QTDIR must point to an installation that has private headers installed." - #echo "Some features will not be available." -fi - -QMAKE_ARGS="$QMAKE_ARGS ${PRODUCT}_INSTALL_PREFIX=$prefix" - -# This must be the last line that touches QMAKE_ARGS -if [ "$hostqmake" != "" ] ; then - HOST_QMAKE_ARGS="$QMAKE_ARGS" - QMAKE_ARGS="$QMAKE_ARGS CONFIG+=crosscompiling" -fi - - -cat <&2 -$ProductSpace v$VERSION configuration: -EOF - -cat <&2 - Install Prefix.............: $prefix - (default: $default_prefix) -EOF - -cat <&2 - Debug......................: $debug (default: no) - Release....................: $release (default: yes) -EOF -if [ "$STATIC_BUILD_SUPPORTED" = "true" ]; then - cat <&2 - Shared build...............: $shared (default: yes) -EOF -fi -if [ "$SPEC" != "" ]; then - cat <&2 - Spec.......................: ${SPEC#-spec } -EOF -fi -if [ "$hostqmake" != "" ]; then - cat <&2 - Host qmake................: ${hostqmake} -EOF -fi -cat <&2 - Compiled-In Unit Tests.....: $unittests (default: no) - Restricted symbol export - (shared build only)......: $hide_symbols (default: yes) - -EOF - -"$targetqmake" ${SPEC} "$SOURCE_DIR"/$product.pro -recursive $QMAKE_ARGS "${PRODUCT}_BASE=`pwd`" || die "qmake failed" - -if [ "$hostqmake" != "" -a -d "$SOURCE_DIR"/kdwsdl2cpp ]; then - [ -d kdwsdl2cpp ] || mkdir kdwsdl2cpp - cd kdwsdl2cpp - $hostqmake "$SOURCE_DIR"/kdwsdl2cpp -recursive $HOST_QMAKE_ARGS || die "host qmake failed" -fi - -echo "Ok, now run make, then make install to install into $prefix" diff --git a/autogen/cpack.cmake.in b/autogen/cpack.cmake.in deleted file mode 100644 index 08ed1c2ba..000000000 --- a/autogen/cpack.cmake.in +++ /dev/null @@ -1,46 +0,0 @@ -SET(CPACK_PACKAGE_NAME "@CPACK_PACKAGE_NAME@") -SET(CPACK_PACKAGE_NAME_SIMPLIFIED "@CPACK_PACKAGE_NAME_SIMPLIFIED@") -SET(CPACK_PACKAGE_VERSION_MAJOR "@CPACK_PACKAGE_VERSION_MAJOR@") -SET(CPACK_PACKAGE_VERSION_MINOR "@CPACK_PACKAGE_VERSION_MINOR@") -SET(CPACK_PACKAGE_VERSION_PATCH "@CPACK_PACKAGE_VERSION_PATCH@") -SET(CPACK_INSTALL_DIRECTORY "@CPACK_INSTALL_DIRECTORY@") -SET(CPACK_PACKAGE_VENDOR "KDAB") - -SET(CPACK_PACKAGE_VERSION "${CPACK_PACKAGE_VERSION_MAJOR}.${CPACK_PACKAGE_VERSION_MINOR}.${CPACK_PACKAGE_VERSION_PATCH}") -GET_FILENAME_COMPONENT(CPACK_INSTALLED_DIRECTORIES "${CPACK_INSTALL_DIRECTORY}" REALPATH) -LIST(APPEND CPACK_INSTALLED_DIRECTORIES ".") - -SET(CPACK_PACKAGE_FILE_NAME "${CPACK_PACKAGE_NAME_SIMPLIFIED}-${CPACK_PACKAGE_VERSION}-source") -SET(CPACK_PACKAGE_NAME_AND_VERSION "${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION}-Source") -SET(CPACK_PACKAGE_INSTALL_DIRECTORY "${CPACK_PACKAGE_FILE_NAME}") - -IF(WIN32) - SET(CPACK_GENERATOR "@CPACK_GENERATOR_WINDOWS@") - SET(CPACK_NSIS_DISPLAY_NAME "${CPACK_PACKAGE_NAME_AND_VERSION}") - SET(CPACK_NSIS_PACKAGE_NAME "${CPACK_PACKAGE_NAME_AND_VERSION}") - SET(CPACK_PACKAGE_INSTALL_REGISTRY_KEY "${CPACK_PACKAGE_NAME_AND_VERSION}") - SET(CPACK_NSIS_INSTALL_ROOT "C:\\KDAB") # use "$PROGRAMFILES" to get "C:\Program Files" or similar - SET(CPACK_NSIS_URL_INFO_ABOUT "http://www.kdab.com") - SET(CPACK_NSIS_MENU_LINKS - "LICENSE.txt" "License" - "LICENSE.@PRODUCT_LICENSE_FREE@.txt" "License (@PRODUCT_LICENSE_FREE@)" - "LICENSE.US.txt" "License (US)" - "README.txt" "Readme") - SET(CPACK_PACKAGE_INSTALL_DIRECTORY "${CPACK_PACKAGE_NAME_AND_VERSION}") -ELSEIF(APPLE) - SET(CPACK_GENERATOR "@CPACK_GENERATOR_APPLE@") - SET(CPACK_SYSTEM_NAME "OSX") -ELSE() - SET(CPACK_GENERATOR "@CPACK_GENERATOR_ELSE@") -ENDIF() - -SET(CPACK_TOPLEVEL_TAG "${CPACK_SYSTEM_NAME}") -SET(CPACK_RESOURCE_FILE_LICENSE "@CPACK_RESOURCE_FILE_LICENSE@") -FILE(TO_CMAKE_PATH "${CPACK_INSTALL_DIRECTORY}" XPLATFORM_INSTALL_DIR) # to get forward slashes on Windows -SET(CPACK_IGNORE_FILES "^${XPLATFORM_INSTALL_DIR}/autogen.py$" "^${XPLATFORM_INSTALL_DIR}/genignore.py$" - "^${XPLATFORM_INSTALL_DIR}/CPackIgnores.txt$" - "/\\.svn/" "/\\.git/" "\\.cache$" "/[\\._]moc/" "/[\\._]obj/" "[\\._]ui/" - "[\\._]qrc/" "\\.pdb$" "\\.zip$" "\\.exe$" "\\.tar" "Makefile" "CPack" - "\\.license\\.accepted$" "/bin/" "/lib/" "/b/" - "/debug/" "/release/" "-source/" "/autogen/" @CPACK_EXTRA_IGNORE_FILES@) -SET(CPACK_PACKAGE_DESCRIPTION "") diff --git a/autogen/cpack.py b/autogen/cpack.py deleted file mode 100644 index f2c6279ce..000000000 --- a/autogen/cpack.py +++ /dev/null @@ -1,77 +0,0 @@ -from datetime import datetime -import os.path - -class CPackGenerateConfiguration(): - def __init__( self, projectName, version, sourceDirectory, buildDirectory, revision, - licenseFile, isTaggedRevision = False ): - self._projectName = projectName - self._sourceDirectory = sourceDirectory - self._buildDirectory = buildDirectory - self._revision = revision - self._licenseFile = licenseFile - self._isTaggedRevision = isTaggedRevision - versionList = version.split( "." ) - assert( isinstance( versionList, list ) and len( versionList ) == 3 ) - self._versionList = versionList - self._generators = { 'WINDOWS': 'NSIS', 'APPLE': 'ZIP', 'ELSE': 'TBZ2' } - - def fixCMakeWindowsPaths( self, path ): - return path.replace( '\\', '\\\\' ) - - def ignoreString( self ): - ignores = str() - try: - with open( os.path.join( self._sourceDirectory, 'CPackIgnores.txt' ) ) as ignoresFile: - for ignore in ignoresFile: - # using ${CPACK_INSTALL_DIRECTORY} or similar seems to be the only way to specify - # "absolute" *sub*directory names. XPLATFORM_INSTALL_DIR is set by us and like - # CPACK_INSTALL_DIRECTORY, but with forward slashes instead of backslashes. - ignores += '\n "^${XPLATFORM_INSTALL_DIR}' + ignore[ :-1 ] + '"' - except: - pass # It's not mandatory to add ignores - return ignores - - def _formattedConfiguration( self ): - with open(os.path.dirname(__file__) + '/cpack.cmake.in') as configFile: - config = configFile.read() - - # Can't do this with str.format because of CMake's variable escaping conflicting - # with Python's format escaping - packageName = self._projectName - packageNameSimplified = packageName.lower().replace( ' ', '_' ) - config = config.replace( "@CPACK_PACKAGE_NAME@", packageName, 1 ) - config = config.replace( "@CPACK_PACKAGE_NAME_SIMPLIFIED@", packageNameSimplified, 1 ) - - versionList = self._versionList - config = config.replace( "@CPACK_PACKAGE_VERSION_MAJOR@", versionList[0] or 1, 1 ) - config = config.replace( "@CPACK_PACKAGE_VERSION_MINOR@", versionList[1] or 0, 1 ) - patchVersion = versionList[2] or 0 - if not self._isTaggedRevision: - patchVersion += '-r' + self._revision - config = config.replace( "@CPACK_PACKAGE_VERSION_PATCH@", patchVersion, 1 ) - installDirectory = self.fixCMakeWindowsPaths( self._sourceDirectory ) - config = config.replace( "@CPACK_INSTALL_DIRECTORY@", installDirectory, 1 ) - config = config.replace( "@CPACK_EXTRA_IGNORE_FILES@", self.ignoreString(), 1 ) - - licenseFile = self._licenseFile - - if not licenseFile: - licenseFile = os.path.join( self._buildDirectory, "CPackGeneratedLicense.txt" ) - with open( licenseFile, 'w' ) as license: - license.write( '{0} - Copyright {1}, All Rights Reserved.'.format( packageName, datetime.now().year ) ) - else: - licenseFile = os.path.abspath( licenseFile ) # NSIS apparently requires an absolute path to find the license file - licenseFile = self.fixCMakeWindowsPaths( licenseFile ) - - config = config.replace( "@CPACK_RESOURCE_FILE_LICENSE@", licenseFile ) - - for platform in ( 'WINDOWS', 'APPLE', 'ELSE' ): - generator = self._generators[ platform ] - config = config.replace( "@CPACK_GENERATOR_%s@" % platform, generator ) - - return config - - def run( self ): - config = os.path.join( self._buildDirectory, 'CPackConfig.cmake' ) - with open( config, 'w' ) as configFile: - configFile.write( self._formattedConfiguration() ) diff --git a/autogen/header.py b/autogen/header.py deleted file mode 100644 index 5854d881a..000000000 --- a/autogen/header.py +++ /dev/null @@ -1,199 +0,0 @@ -from shutil import copyfile, rmtree -from string import Template -import os.path -import re -import sys -import autogen - -class ForwardHeaderGenerator(): - def __init__( self, copy, path, includepath, srcpath, project, subprojects, prefix, - prefixed, cleanIncludeDir = True, additionalHeaders = {} ): - self.copy = copy - self.path = path - self.includepath = includepath - self.srcpath = srcpath - self.project = project - self.subprojects = subprojects - self.prefix = prefix - self.prefixed = prefixed - self.cleanIncludeDir = cleanIncludeDir - self.additionalHeaders = additionalHeaders - self.__projectFile = "" - - def run( self ): - self.createProject() - - def _isValidHeaderFile( self, filename ): - if ( filename.endswith( ".h" ) ): - if filename.startswith( "moc_" ): - return False - if filename.startswith( "ui_" ): - return False - if filename.startswith( "qrc_" ): - return False; - if filename.endswith( "_p.h" ): - return False - return True - else: - return False - - def _suggestedHeaderNames( self, project, header ): - regex = re.compile( "(?:class\s+[{0}|{1}][_0-9A-Z]*_EXPORT|MAKEINCLUDES_EXPORT)\s+([a-zA-Z_][A-Za-z0-9_]*)" - .format( project.upper(), self.project.upper() ) ) - regex2 = re.compile( "(?:class\s+MAKEINCLUDES_EXPORT)\s+([a-zA-Z_][A-Za-z0-9_]*)" ) - regex3 = re.compile( "(?:\\\\file)\s+([a-zA-Z_][A-Za-z0-9_]*)" ) - - f = open( header, "r" ) - classNames = set() - - for line in f.readlines(): - line = line.strip() - - className = None - noPrefix = False - if ( regex.match( line ) ): - className = regex.match( line ).groups()[0] - noPrefix = False - else: - if regex2.match( line ): - className = regex2.match( line ).groups()[0] - noPrefix = False - else: - if ( None != regex3.search( line ) ): - className = regex3.search( line ).groups()[0] - noPrefix = True - - if not className: - continue - - if self.prefixed and not noPrefix: - className = project + className - - classNames.add( className ) - - f.close() - - return classNames - - def _addForwardHeader( self, targetPath, fileName, projectFile ): - INCLUDE_STR = "#include \"{0}\"" - newHeader = open( targetPath, "wb" ) - newHeader.write( INCLUDE_STR.format( fileName ) + os.linesep ) - newHeader.close() - - basename = os.path.basename( targetPath ) - projectFile.write( basename + " \\" + os.linesep ) - - def _createForwardHeader( self, header, projectFile, project ): - path = os.path.dirname( header ) - basename = os.path.basename( header ) - classNames = self._suggestedHeaderNames( project, header ) - - if len( classNames ) > 0: - for classname in classNames: - fHeaderName = os.path.abspath( path + "/" + classname ) - self._addForwardHeader( fHeaderName, basename, projectFile ) - - projectFile.write( basename + " \\" + os.linesep ) - elif not basename in self.additionalHeaders.values(): # only create "foo" for "foo.h" if additionalHeaders doesn't overrides it - sanitizedBasename = basename.replace( ".h", "" ) - - #fHeaderName = os.path.abspath( self.includepath + "/" + sanitizedBasename ) - #self._addForwardHeader( fHeaderName, basename, self.__projectFile ) - - fHeaderNameProjectDir = os.path.dirname( os.path.abspath( header ) ) + "/" + sanitizedBasename; - self._addForwardHeader( fHeaderNameProjectDir, "{0}".format( basename ), projectFile ) - projectFile.write( basename + " \\" + os.linesep ) - - def createProject( self ): - if ( not os.path.exists( self.path ) ): - errStr = Template( "Error, the directory $DIR does not exist!" ) - errStr = errStr.substitute( DIR = self.path ) - raise BaseException( errStr ) - - if self.cleanIncludeDir and os.path.exists( self.includepath ): - rmtree( self.includepath ) - if not os.path.exists( self.includepath ): - os.mkdir( self.includepath ) - - if autogen.policyVersion() >= 2: - includeProjectName = os.path.basename( self.includepath.rstrip( "/" ) ) - else: - includeProjectName = self.project - profilename = os.path.abspath( self.includepath ) + "/" + includeProjectName + ".pro" - projectFile = open( profilename, "wb" ) - self.__projectFile = projectFile - lines = [] - lines.append( "TEMPLATE = subdirs" + os.linesep ) - lines.append( "SUBDIRS = " ) - - for subProject in self.subprojects: - line = subProject - if ( subProject != self.subprojects[ -1 ] ): - line += " \\" - lines.append( line + os.linesep ) - - projectFile.writelines( lines ) - projectFile.write( os.linesep ) - - projectFile.write( "INSTALL_HEADERS.files = " ) - - for subProject in self.subprojects: - self._createSubproject( subProject ) - - for fileName, includePath in self.additionalHeaders.items(): - targetPath = os.path.join( self.includepath, fileName ) - self._addForwardHeader( targetPath , includePath, projectFile ) - - self._copyHeaders( self.srcpath, self.includepath, projectFile, self.project, self.prefixed ) - installPath = "{0}/include".format( self.prefix ) - self._projectFile_finalize( projectFile, installPath ) - projectFile.close() - - def _createSubproject( self, project ): - inclPath = os.path.abspath( self.includepath + "/" + project ) - srcPath = os.path.abspath( self.srcpath + "/" + project ) - os.mkdir( inclPath ) - profilename = os.path.abspath( self.includepath ) + "/" + project + "/" + project + ".pro" - projectFile = open( profilename, "wb" ) - projectFile.write( "TEMPLATE = subdirs" + os.linesep ) - projectFile.write( "INSTALL_HEADERS.files = " ) - self._copyHeaders( srcPath, inclPath, projectFile, project, self.prefixed ) - installPath = "{0}/include/{1}".format( self.prefix, project ) - self._projectFile_finalize( projectFile, installPath ) - projectFile.close() - - def _projectFile_finalize( self, projectFile, installPath ): - projectFile.write( os.linesep ) - #projectFile.write( "message( $$INSTALL_HEADERS.path )" + os.linesep ) - projectFile.write( "INSTALL_HEADERS.path = {0}".format( installPath ) + os.linesep ) - #projectFile.write( "message( $$INSTALL_HEADERS.path )" + os.linesep ) - projectFile.write( "INSTALLS += INSTALL_HEADERS" + os.linesep ) - - def _copyHeaders( self, srcDir, destDir, projectFile, project, prefixed = False ): - rootDir = srcDir == self.srcpath - dir = os.listdir( srcDir ) - headersForCatchAll = [] - for filename in dir: - if ( rootDir ): - if ( filename in self.subprojects ): - continue - file = os.path.abspath( srcDir + "/" + filename ) - if os.path.isdir( file ): - self._copyHeaders( file, destDir, projectFile, project, prefixed ) - else: - if self._isValidHeaderFile( filename ): - destfile = os.path.abspath( destDir + "/" + filename ) - srcfile = os.path.abspath( srcDir + "/" + filename ) - copyfile( srcfile, destfile ) - self._createForwardHeader( destfile, projectFile, project ) - headersForCatchAll.append( filename ) - # Create "catch all" convenience header including all headers: - if len( headersForCatchAll ) > 0: - catchAllFileName = os.path.abspath( destDir + "/" + os.path.basename( destDir ) ) - catchAllContent = ["#include \"%s\"%s" % (header, os.linesep) for header in headersForCatchAll] - catchAllFile = open( catchAllFileName, "wb" ) - catchAllFile.writelines( catchAllContent ) - catchAllFile.close() - projectFile.write( os.path.basename( catchAllFileName ) + " \\" + os.linesep ) - diff --git a/cmake/CMakePackageConfigHelpers.cmake b/cmake/CMakePackageConfigHelpers.cmake deleted file mode 100644 index 48039e522..000000000 --- a/cmake/CMakePackageConfigHelpers.cmake +++ /dev/null @@ -1,227 +0,0 @@ -# - CONFIGURE_PACKAGE_CONFIG_FILE(), WRITE_BASIC_PACKAGE_VERSION_FILE() -# -# CONFIGURE_PACKAGE_CONFIG_FILE( INSTALL_DESTINATION -# [PATH_VARS ... ] -# [NO_SET_AND_CHECK_MACRO] -# [NO_CHECK_REQUIRED_COMPONENTS_MACRO]) -# -# CONFIGURE_PACKAGE_CONFIG_FILE() should be used instead of the plain -# CONFIGURE_FILE() command when creating the Config.cmake or -config.cmake -# file for installing a project or library. It helps making the resulting package -# relocatable by avoiding hardcoded paths in the installed Config.cmake file. -# -# In a FooConfig.cmake file there may be code like this to make the -# install destinations know to the using project: -# set(FOO_INCLUDE_DIR "@CMAKE_INSTALL_FULL_INCLUDEDIR@" ) -# set(FOO_DATA_DIR "@CMAKE_INSTALL_PREFIX@/@RELATIVE_DATA_INSTALL_DIR@" ) -# set(FOO_ICONS_DIR "@CMAKE_INSTALL_PREFIX@/share/icons" ) -# ...logic to determine installedPrefix from the own location... -# set(FOO_CONFIG_DIR "${installedPrefix}/@CONFIG_INSTALL_DIR@" ) -# All 4 options shown above are not sufficient, since the first 3 hardcode -# the absolute directory locations, and the 4th case works only if the logic -# to determine the installedPrefix is correct, and if CONFIG_INSTALL_DIR contains -# a relative path, which in general cannot be guaranteed. -# This has the effect that the resulting FooConfig.cmake file would work poorly -# under Windows and OSX, where users are used to choose the install location -# of a binary package at install time, independent from how CMAKE_INSTALL_PREFIX -# was set at build/cmake time. -# -# Using CONFIGURE_PACKAGE_CONFIG_FILE() helps. If used correctly, it makes the -# resulting FooConfig.cmake file relocatable. -# Usage: -# 1. write a FooConfig.cmake.in file as you are used to -# 2. insert a line containing only the string "@PACKAGE_INIT@" -# 3. instead of SET(FOO_DIR "@SOME_INSTALL_DIR@"), use SET(FOO_DIR "@PACKAGE_SOME_INSTALL_DIR@") -# (this must be after the @PACKAGE_INIT@ line) -# 4. instead of using the normal CONFIGURE_FILE(), use CONFIGURE_PACKAGE_CONFIG_FILE() -# -# The and arguments are the input and output file, the same way -# as in CONFIGURE_FILE(). -# -# The given to INSTALL_DESTINATION must be the destination where the FooConfig.cmake -# file will be installed to. This can either be a relative or absolute path, both work. -# -# The variables to given as PATH_VARS are the variables which contain -# install destinations. For each of them the macro will create a helper variable -# PACKAGE_. These helper variables must be used -# in the FooConfig.cmake.in file for setting the installed location. They are calculated -# by CONFIGURE_PACKAGE_CONFIG_FILE() so that they are always relative to the -# installed location of the package. This works both for relative and also for absolute locations. -# For absolute locations it works only if the absolute location is a subdirectory -# of CMAKE_INSTALL_PREFIX. -# -# By default configure_package_config_file() also generates two helper macros, -# set_and_check() and check_required_components() into the FooConfig.cmake file. -# -# set_and_check() should be used instead of the normal set() -# command for setting directories and file locations. Additionally to setting the -# variable it also checks that the referenced file or directory actually exists -# and fails with a FATAL_ERROR otherwise. This makes sure that the created -# FooConfig.cmake file does not contain wrong references. -# When using the NO_SET_AND_CHECK_MACRO, this macro is not generated into the -# FooConfig.cmake file. -# -# check_required_components() should be called at the end of the -# FooConfig.cmake file if the package supports components. -# This macro checks whether all requested, non-optional components have been found, -# and if this is not the case, sets the Foo_FOUND variable to FALSE, so that the package -# is considered to be not found. -# It does that by testing the Foo__FOUND variables for all requested -# required components. -# When using the NO_CHECK_REQUIRED_COMPONENTS option, this macro is not generated -# into the FooConfig.cmake file. -# -# For an example see below the documentation for WRITE_BASIC_PACKAGE_VERSION_FILE(). -# -# -# WRITE_BASIC_PACKAGE_VERSION_FILE( filename VERSION major.minor.patch COMPATIBILITY (AnyNewerVersion|SameMajorVersion|ExactVersion) ) -# -# Writes a file for use as ConfigVersion.cmake file to . -# See the documentation of FIND_PACKAGE() for details on this. -# filename is the output filename, it should be in the build tree. -# major.minor.patch is the version number of the project to be installed -# The COMPATIBILITY mode AnyNewerVersion means that the installed package version -# will be considered compatible if it is newer or exactly the same as the requested version. -# This mode should be used for packages which are fully backward compatible, -# also across major versions. -# If SameMajorVersion is used instead, then the behaviour differs from AnyNewerVersion -# in that the major version number must be the same as requested, e.g. version 2.0 will -# not be considered compatible if 1.0 is requested. -# This mode should be used for packages which guarantee backward compatibility within the -# same major version. -# If ExactVersion is used, then the package is only considered compatible if the requested -# version matches exactly its own version number (not considering the tweak version). -# For example, version 1.2.3 of a package is only considered compatible to requested version 1.2.3. -# This mode is for packages without compatibility guarantees. -# If your project has more elaborated version matching rules, you will need to write your -# own custom ConfigVersion.cmake file instead of using this macro. -# -# Internally, this macro executes configure_file() to create the resulting -# version file. Depending on the COMPATIBLITY, either the file -# BasicConfigVersion-SameMajorVersion.cmake.in or BasicConfigVersion-AnyNewerVersion.cmake.in -# is used. Please note that these two files are internal to CMake and you should -# not call configure_file() on them yourself, but they can be used as starting -# point to create more sophisticted custom ConfigVersion.cmake files. -# -# -# Example using both configure_package_config_file() and write_basic_package_version_file(): -# CMakeLists.txt: -# set(INCLUDE_INSTALL_DIR include/ ... CACHE ) -# set(LIB_INSTALL_DIR lib/ ... CACHE ) -# set(SYSCONFIG_INSTALL_DIR etc/foo/ ... CACHE ) -# ... -# include(CMakePackageConfigHelpers) -# configure_package_config_file(FooConfig.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/FooConfig.cmake -# INSTALL_DESTINATION ${LIB_INSTALL_DIR}/Foo/cmake -# PATH_VARS INCLUDE_INSTALL_DIR SYSCONFIG_INSTALL_DIR) -# write_basic_package_version_file(${CMAKE_CURRENT_BINARY_DIR}/FooConfigVersion.cmake -# VERSION 1.2.3 -# COMPATIBILITY SameMajorVersion ) -# install(FILES ${CMAKE_CURRENT_BINARY_DIR}/FooConfig.cmake ${CMAKE_CURRENT_BINARY_DIR}/FooConfigVersion.cmake -# DESTINATION ${LIB_INSTALL_DIR}/Foo/cmake ) -# -# With a FooConfig.cmake.in: -# set(FOO_VERSION x.y.z) -# ... -# @PACKAGE_INIT@ -# ... -# set_and_check(FOO_INCLUDE_DIR "@PACKAGE_INCLUDE_INSTALL_DIR@") -# set_and_check(FOO_SYSCONFIG_DIR "@PACKAGE_SYSCONFIG_INSTALL_DIR@") -# -# check_required_components(Foo) - - -#============================================================================= -# Copyright 2012 Alexander Neundorf -# -# Distributed under the OSI-approved BSD License (the "License"); -# see accompanying file Copyright.txt for details. -# -# This software is distributed WITHOUT ANY WARRANTY; without even the -# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. -# See the License for more information. -#============================================================================= -# (To distribute this file outside of CMake, substitute the full -# License text for the above reference.) - -include(CMakeParseArguments) - -include(WriteBasicConfigVersionFile) - -macro(WRITE_BASIC_PACKAGE_VERSION_FILE) - write_basic_config_version_file(${ARGN}) -endmacro() - - -function(CONFIGURE_PACKAGE_CONFIG_FILE _inputFile _outputFile) - set(options NO_SET_AND_CHECK_MACRO NO_CHECK_REQUIRED_COMPONENTS_MACRO) - set(oneValueArgs INSTALL_DESTINATION ) - set(multiValueArgs PATH_VARS ) - - cmake_parse_arguments(CCF "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN}) - - if(CCF_UNPARSED_ARGUMENTS) - message(FATAL_ERROR "Unknown keywords given to CONFIGURE_PACKAGE_CONFIG_FILE(): \"${CCF_UNPARSED_ARGUMENTS}\"") - endif() - - if(NOT CCF_INSTALL_DESTINATION) - message(FATAL_ERROR "No INSTALL_DESTINATION given to CONFIGURE_PACKAGE_CONFIG_FILE()") - endif() - - if(IS_ABSOLUTE "${CCF_INSTALL_DESTINATION}") - set(absInstallDir "${CCF_INSTALL_DESTINATION}") - else() - set(absInstallDir "${CMAKE_INSTALL_PREFIX}/${CCF_INSTALL_DESTINATION}") - endif() - file(RELATIVE_PATH PACKAGE_RELATIVE_PATH "${absInstallDir}" "${CMAKE_INSTALL_PREFIX}" ) - - foreach(var ${CCF_PATH_VARS}) - if(NOT DEFINED ${var}) - message(FATAL_ERROR "Variable ${var} does not exist") - else() - if(IS_ABSOLUTE "${${var}}") - string(REPLACE "${CMAKE_INSTALL_PREFIX}" "\${PACKAGE_PREFIX_DIR}" - PACKAGE_${var} "${${var}}") - else() - set(PACKAGE_${var} "\${PACKAGE_PREFIX_DIR}/${${var}}") - endif() - endif() - endforeach() - - set(PACKAGE_INIT " -####### Expanded from @PACKAGE_INIT@ by configure_package_config_file() ####### -get_filename_component(PACKAGE_PREFIX_DIR \"\${CMAKE_CURRENT_LIST_DIR}/${PACKAGE_RELATIVE_PATH}\" ABSOLUTE) -") - - if(NOT CCF_NO_SET_AND_CHECK_MACRO) - set(PACKAGE_INIT "${PACKAGE_INIT} -macro(set_and_check _var _file) - set(\${_var} \"\${_file}\") - if(NOT EXISTS \"\${_file}\") - message(FATAL_ERROR \"File or directory \${_file} referenced by variable \${_var} does not exist !\") - endif() -endmacro() -") - endif() - - - if(NOT CCF_NO_CHECK_REQUIRED_COMPONENTS_MACRO) - set(PACKAGE_INIT "${PACKAGE_INIT} -macro(check_required_components _NAME) - foreach(comp \${\${_NAME}_FIND_COMPONENTS}) - if(NOT \${_NAME}_\${comp}_FOUND) - if(\${_NAME}_FIND_REQUIRED_\${comp}) - set(\${_NAME}_FOUND FALSE) - endif() - endif() - endforeach(comp) -endmacro() -") - endif() - - set(PACKAGE_INIT "${PACKAGE_INIT} -####################################################################################") - - configure_file("${_inputFile}" "${_outputFile}" @ONLY) - -endfunction() diff --git a/cmake/COPYING-CMAKE-SCRIPTS b/cmake/COPYING-CMAKE-SCRIPTS deleted file mode 100644 index 4b417765f..000000000 --- a/cmake/COPYING-CMAKE-SCRIPTS +++ /dev/null @@ -1,22 +0,0 @@ -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 copyright - notice, this list of conditions and the following disclaimer. -2. Redistributions in binary form must reproduce the copyright - notice, this list of conditions and the following disclaimer in the - documentation and/or other materials provided with the distribution. -3. The name of the author may not be used to endorse or promote products - derived from this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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/cmake/ECM/modules/BSD-3-Clause.txt b/cmake/ECM/modules/BSD-3-Clause.txt new file mode 100644 index 000000000..d583b4aa8 --- /dev/null +++ b/cmake/ECM/modules/BSD-3-Clause.txt @@ -0,0 +1,28 @@ +Copyright (c) . All rights reserved. + +This license applies to the CMake ECM modules only. + +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/cmake/ECM/modules/ECMEnableSanitizers.cmake b/cmake/ECM/modules/ECMEnableSanitizers.cmake new file mode 100644 index 000000000..ae920d66b --- /dev/null +++ b/cmake/ECM/modules/ECMEnableSanitizers.cmake @@ -0,0 +1,167 @@ +# SPDX-FileCopyrightText: 2014 Mathieu Tarral +# +# SPDX-License-Identifier: BSD-3-Clause + +#[=======================================================================[.rst: +ECMEnableSanitizers +------------------- + +Enable compiler sanitizer flags. + +The following sanitizers are supported: + +- Address Sanitizer +- Memory Sanitizer +- Thread Sanitizer +- Leak Sanitizer +- Undefined Behaviour Sanitizer + +All of them are implemented in Clang, depending on your version, and +there is an work in progress in GCC, where some of them are currently +implemented. + +This module will check your current compiler version to see if it +supports the sanitizers that you want to enable + +Usage +===== + +Simply add:: + + include(ECMEnableSanitizers) + +to your ``CMakeLists.txt``. Note that this module is included in +:kde-module:`KDECompilerSettings`, so projects using that module do not need to also +include this one. + +The sanitizers are not enabled by default. Instead, you must set +``ECM_ENABLE_SANITIZERS`` (either in your ``CMakeLists.txt`` or on the +command line) to a semicolon-separated list of sanitizers you wish to enable. +The options are: + +- address +- memory +- thread +- leak +- undefined +- fuzzer + +The sanitizers "address", "memory" and "thread" are mutually exclusive. You +cannot enable two of them in the same build. + +"leak" requires the "address" sanitizer. + +.. note:: + + To reduce the overhead induced by the instrumentation of the sanitizers, it + is advised to enable compiler optimizations (``-O1`` or higher). + +Example +======= + +This is an example of usage:: + + mkdir build + cd build + cmake -DECM_ENABLE_SANITIZERS='address;leak;undefined' .. + +.. note:: + + Most of the sanitizers will require Clang. To enable it, use:: + + -DCMAKE_CXX_COMPILER=clang++ + +Since 1.3.0. +#]=======================================================================] + +# MACRO check_compiler_version +#----------------------------- +macro (check_compiler_version gcc_required_version clang_required_version msvc_required_version) + if ( + ( + CMAKE_CXX_COMPILER_ID MATCHES "GNU" + AND + CMAKE_CXX_COMPILER_VERSION VERSION_LESS ${gcc_required_version} + ) + OR + ( + CMAKE_CXX_COMPILER_ID MATCHES "Clang" + AND + CMAKE_CXX_COMPILER_VERSION VERSION_LESS ${clang_required_version} + ) + OR + ( + CMAKE_CXX_COMPILER_ID MATCHES "MSVC" + AND + CMAKE_CXX_COMPILER_VERSION VERSION_LESS ${msvc_required_version} + ) + ) + # error ! + message(STATUS "You ask to enable the sanitizer ${CUR_SANITIZER}, + but your compiler ${CMAKE_CXX_COMPILER_ID} version ${CMAKE_CXX_COMPILER_VERSION} + does not support it ! + You should use at least GCC ${gcc_required_version}, Clang ${clang_required_version} + or MSVC ${msvc_required_version} + (99.99 means not implemented yet)") + endif () +endmacro () + +# MACRO check_compiler_support +#------------------------------ +macro (enable_sanitizer_flags sanitize_option) + if (${sanitize_option} MATCHES "address") + check_compiler_version("4.8" "3.1" "19.28") + if (CMAKE_CXX_COMPILER_ID MATCHES "MSVC") + set(XSAN_COMPILE_FLAGS "-fsanitize=address") + else() + set(XSAN_COMPILE_FLAGS "-fsanitize=address -fno-omit-frame-pointer -fno-optimize-sibling-calls") + set(XSAN_LINKER_FLAGS "asan") + endif() + elseif (${sanitize_option} MATCHES "thread") + check_compiler_version("4.8" "3.1" "99.99") + set(XSAN_COMPILE_FLAGS "-fsanitize=thread") + set(XSAN_LINKER_FLAGS "tsan") + elseif (${sanitize_option} MATCHES "memory") + check_compiler_version("99.99" "3.1" "99.99") + set(XSAN_COMPILE_FLAGS "-fsanitize=memory") + elseif (${sanitize_option} MATCHES "leak") + check_compiler_version("4.9" "3.4" "99.99") + set(XSAN_COMPILE_FLAGS "-fsanitize=leak") + set(XSAN_LINKER_FLAGS "lsan") + elseif (${sanitize_option} MATCHES "undefined") + check_compiler_version("4.9" "3.1" "99.99") + set(XSAN_COMPILE_FLAGS "-fsanitize=undefined -fno-omit-frame-pointer -fno-optimize-sibling-calls") + elseif (${sanitize_option} MATCHES "fuzzer") + check_compiler_version("99.99" "6.0" "99.99") + set(XSAN_COMPILE_FLAGS "-fsanitize=fuzzer") + else () + message(FATAL_ERROR "Compiler sanitizer option \"${sanitize_option}\" not supported.") + endif () +endmacro () + +if (ECM_ENABLE_SANITIZERS) + if (CMAKE_CXX_COMPILER_ID MATCHES "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES "Clang" OR CMAKE_CXX_COMPILER_ID MATCHES "MSVC") + # for each element of the ECM_ENABLE_SANITIZERS list + foreach ( CUR_SANITIZER ${ECM_ENABLE_SANITIZERS} ) + # lowercase filter + string(TOLOWER ${CUR_SANITIZER} CUR_SANITIZER) + # check option and enable appropriate flags + enable_sanitizer_flags ( ${CUR_SANITIZER} ) + # TODO: GCC will not link pthread library if enabled ASan + if(CMAKE_C_COMPILER_ID MATCHES "Clang") + set( CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${XSAN_COMPILE_FLAGS}" ) + endif() + set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${XSAN_COMPILE_FLAGS}" ) + if(CMAKE_CXX_COMPILER_ID MATCHES "GNU") + link_libraries(${XSAN_LINKER_FLAGS}) + endif() + if (CMAKE_CXX_COMPILER_ID MATCHES "Clang") + string(REPLACE "-Wl,--no-undefined" "" CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS}") + string(REPLACE "-Wl,--no-undefined" "" CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS}") + endif () + endforeach() + else() + message(STATUS "Tried to enable sanitizers (-DECM_ENABLE_SANITIZERS=${ECM_ENABLE_SANITIZERS}), \ +but compiler (${CMAKE_CXX_COMPILER_ID}) does not have sanitizer support") + endif() +endif() diff --git a/cmake/ECM/modules/ECMGenerateHeaders.cmake b/cmake/ECM/modules/ECMGenerateHeaders.cmake new file mode 100644 index 000000000..ddd6066c3 --- /dev/null +++ b/cmake/ECM/modules/ECMGenerateHeaders.cmake @@ -0,0 +1,222 @@ +# SPDX-FileCopyrightText: 2013 Aleix Pol Gonzalez +# SPDX-FileCopyrightText: 2014 Alex Merry +# SPDX-FileCopyrightText: 2015 Patrick Spendrin +# +# SPDX-License-Identifier: BSD-3-Clause + +#[=======================================================================[.rst: +ECMGenerateHeaders +------------------ + +Generate C/C++ CamelCase forwarding headers. + +:: + + ecm_generate_headers( + HEADER_NAMES [ [...]] + [ORIGINAL ] + [HEADER_EXTENSION ] + [OUTPUT_DIR ] + [PREFIX ] + [REQUIRED_HEADERS ] + [COMMON_HEADER ] + [RELATIVE ]) + +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, +``.`` 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 +. + +``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 "`` 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 "$") + +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. +#]=======================================================================] + +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}") + get_source_file_property(_generated "${_actualheader}" GENERATED) + if (NOT _generated AND 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/cmake/ECM/modules/ECMGeneratePriFile.cmake b/cmake/ECM/modules/ECMGeneratePriFile.cmake new file mode 100644 index 000000000..8910cd9e5 --- /dev/null +++ b/cmake/ECM/modules/ECMGeneratePriFile.cmake @@ -0,0 +1,256 @@ +# SPDX-FileCopyrightText: 2014 David Faure +# +# 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 + LIB_NAME + [VERSION ] # since 5.83 + [DEPS " [ [...]]"] + [FILENAME_VAR ] + [INCLUDE_INSTALL_DIRS [ [...]]] # since 5.92 + [INCLUDE_INSTALL_DIR ] # deprecated since 5.92 + [LIB_INSTALL_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}/`` 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/cmake/ECM/modules/ECMQueryQmake.cmake b/cmake/ECM/modules/ECMQueryQmake.cmake new file mode 100644 index 000000000..4277eeeac --- /dev/null +++ b/cmake/ECM/modules/ECMQueryQmake.cmake @@ -0,0 +1,51 @@ +if (${ECM_GLOBAL_FIND_VERSION} VERSION_GREATER_EQUAL 5.93) + message(DEPRECATION "ECMQueryQmake.cmake is deprecated since 5.93, please use ECMQueryQt.cmake instead.") +endif() + +include(${CMAKE_CURRENT_LIST_DIR}/QtVersionOption.cmake) +find_package(Qt${QT_MAJOR_VERSION}Core QUIET) + +if (Qt5Core_FOUND) + set(_qmake_executable_default "qmake-qt5") +endif () +if (TARGET Qt5::qmake) + get_target_property(_qmake_executable_default Qt5::qmake LOCATION) +endif() +set(QMAKE_EXECUTABLE ${_qmake_executable_default} + CACHE FILEPATH "Location of the Qt5 qmake executable") + +# Helper method +# This is not public API (yet)! +# Usage: query_qmake( [TRY]) +# Passing TRY will result in the method not failing fatal if no qmake executable +# has been found, but instead simply returning an empty string +function(query_qmake result_variable qt_variable) + set(options TRY) + set(oneValueArgs ) + set(multiValueArgs ) + + cmake_parse_arguments(ARGS "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN}) + + if(NOT QMAKE_EXECUTABLE) + if(ARGS_TRY) + set(${result_variable} "" PARENT_SCOPE) + message(STATUS "No qmake Qt5 binary found. Can't check ${qt_variable}") + return() + else() + message(FATAL_ERROR "No qmake Qt5 binary found. Can't check ${qt_variable} as required") + endif() + endif() + execute_process( + COMMAND ${QMAKE_EXECUTABLE} -query "${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: ${QMAKE_EXECUTABLE} -query \"${qt_variable}\"") + message(FATAL_ERROR "QMake call failed: ${return_code}") + endif() +endfunction() diff --git a/cmake/ECM/modules/ECMQueryQt.cmake b/cmake/ECM/modules/ECMQueryQt.cmake new file mode 100644 index 000000000..639b2b571 --- /dev/null +++ b/cmake/ECM/modules/ECMQueryQt.cmake @@ -0,0 +1,98 @@ +# SPDX-FileCopyrightText: 2014 Rohan Garg +# SPDX-FileCopyrightText: 2014 Alex Merry +# SPDX-FileCopyrightText: 2014-2016 Aleix Pol +# SPDX-FileCopyrightText: 2017 Friedrich W. H. Kossebau +# SPDX-FileCopyrightText: 2022 Ahmad Samir +# +# 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( [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 ``/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) + set(_exec_name_text "Qt5 qmake") + if(TARGET Qt5::qmake) + get_target_property(_qmake_executable_default Qt5::qmake LOCATION) + + set(QUERY_EXECUTABLE ${_qmake_executable_default}) + set(_cli_option "-query") + endif() +elseif(QT_MAJOR_VERSION STREQUAL "6") + # QUIET to accommodate the TRY option + find_package(Qt6 COMPONENTS CoreTools QUIET CONFIG) + set(_exec_name_text "Qt6 qtpaths") + if (TARGET Qt6::qtpaths) + get_target_property(_qtpaths_executable Qt6::qtpaths LOCATION) + + set(QUERY_EXECUTABLE ${_qtpaths_executable}) + 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/cmake/ECM/modules/ECMSetupVersion.cmake b/cmake/ECM/modules/ECMSetupVersion.cmake new file mode 100644 index 000000000..7164c9a0b --- /dev/null +++ b/cmake/ECM/modules/ECMSetupVersion.cmake @@ -0,0 +1,213 @@ +# SPDX-FileCopyrightText: 2014 Alex Merry +# SPDX-FileCopyrightText: 2012 Alexander Neundorf +# +# SPDX-License-Identifier: BSD-3-Clause + +#[=======================================================================[.rst: +ECMSetupVersion +--------------- + +Handle library version information. + +:: + + ecm_setup_version( + VARIABLE_PREFIX + [SOVERSION ] + [VERSION_HEADER ] + [PACKAGE_VERSION_FILE [COMPATIBILITY ]] ) + +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 ```` argument is of the form ``..`` +(or ``...``), The following CMake variables are +set:: + + _VERSION_MAJOR - + _VERSION_MINOR - + _VERSION_PATCH - + _VERSION - + _SOVERSION - , or if SOVERSION was not given + +For backward-compatibility also this variable is set (only if the minimum required +version of ECM is < 5.83):: + + _VERSION_STRING - (use _VERSION instead) + +If CMake policy CMP0048 is not ``NEW``, the following CMake variables will also +be set:: + + PROJECT_VERSION_MAJOR - + PROJECT_VERSION_MINOR - + PROJECT_VERSION_PATCH - + PROJECT_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 - (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:: + + _VERSION_MAJOR - as an integer + _VERSION_MINOR - as an integer + _VERSION_PATCH - as an integer + _VERSION_STRING - as a C string + _VERSION - the version as an integer + +``_VERSION`` has ```` in the bottom 8 bits, ```` in the +next 8 bits and ```` in the remaining bits. Note that ```` and +```` 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 ] + [SOVERSION ] + [VERSION_HEADER ] + [PACKAGE_VERSION_FILE ] ) + +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 DEFINED ESV_SOVERSION) # use DEFINED, so "0" as valid SO version is not evaluated to FALSE + 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/cmake/ECM/modules/ECMUninstallTarget.cmake b/cmake/ECM/modules/ECMUninstallTarget.cmake new file mode 100644 index 000000000..7298012da --- /dev/null +++ b/cmake/ECM/modules/ECMUninstallTarget.cmake @@ -0,0 +1,50 @@ +# SPDX-FileCopyrightText: 2015 Alex Merry +# +# 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/cmake/ECM/modules/ECMVersionHeader.h.in b/cmake/ECM/modules/ECMVersionHeader.h.in new file mode 100644 index 000000000..c0ed6c06f --- /dev/null +++ b/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/cmake/ECM/modules/QtVersionOption.cmake b/cmake/ECM/modules/QtVersionOption.cmake new file mode 100644 index 000000000..0ea036585 --- /dev/null +++ b/cmake/ECM/modules/QtVersionOption.cmake @@ -0,0 +1,43 @@ +# SPDX-FileCopyrightText: 2021 Volker Krause +# +# 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. + +If the ECM version passed to find_package was at least 5.240.0 Qt6 is picked by default. +Otherwise Qt5 is picked. + +``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() + if (ECM_GLOBAL_FIND_VERSION VERSION_GREATER_EQUAL 5.240) + option(BUILD_WITH_QT6 "Build against Qt 6" ON) + else() + option(BUILD_WITH_QT6 "Build against Qt 6" OFF) + endif() + + if (BUILD_WITH_QT6) + set(QT_MAJOR_VERSION 6) + else() + set(QT_MAJOR_VERSION 5) + endif() +endif() diff --git a/cmake/ECM/modules/ecm_uninstall.cmake.in b/cmake/ECM/modules/ecm_uninstall.cmake.in new file mode 100644 index 000000000..379239ba6 --- /dev/null +++ b/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/cmake/ECMGenerateHeaders.cmake b/cmake/ECMGenerateHeaders.cmake deleted file mode 100644 index 2ce373ee4..000000000 --- a/cmake/ECMGenerateHeaders.cmake +++ /dev/null @@ -1,221 +0,0 @@ -#.rst: -# ECMGenerateHeaders -# ------------------ -# -# Generate C/C++ CamelCase forwarding headers. -# -# :: -# -# ecm_generate_headers( -# HEADER_NAMES [ [...]] -# [ORIGINAL ] -# [OUTPUT_DIR ] -# [PREFIX ] -# [REQUIRED_HEADERS ] -# [COMMON_HEADER ] -# [RELATIVE ]) -# -# For each CamelCase header name passed to HEADER_NAMES, a file of that name -# will be generated that will include a version with ``.h`` 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 -# . -# -# ORIGINAL specifies how the name of the original header is written: lowercased -# or also camelcased. The default is LOWERCASE. Since 1.8.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 "`` 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 "$") -# -# 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. - -#============================================================================= -# Copyright 2013 Aleix Pol Gonzalez -# Copyright 2014 Alex Merry -# Copyright 2015 Patrick Spendrin -# -# Distributed under the OSI-approved BSD License (the "License"); -# see accompanying file COPYING-CMAKE-SCRIPTS for details. -# -# This software is distributed WITHOUT ANY WARRANTY; without even the -# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. -# See the License for more information. -#============================================================================= -# (To distribute this file outside of extra-cmake-modules, substitute the full -# License text for the above reference.) - -include(CMakeParseArguments) - -function(ECM_GENERATE_HEADERS camelcase_forwarding_headers_var) - set(options) - set(oneValueArgs ORIGINAL 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_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() - - 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}.h") - 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}.h\"\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}.h) - 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 (NOT EGH_REQUIRED_HEADERS STREQUAL "") - set(${EGH_REQUIRED_HEADERS} ${_REQUIRED_HEADERS} PARENT_SCOPE) - endif () -endfunction() diff --git a/cmake/InstallLocation.cmake b/cmake/InstallLocation.cmake deleted file mode 100644 index 5a4b1c7b5..000000000 --- a/cmake/InstallLocation.cmake +++ /dev/null @@ -1,28 +0,0 @@ -# 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}) -endif() diff --git a/cmake/KDAB/modules/KDCompilerFlags.cmake b/cmake/KDAB/modules/KDCompilerFlags.cmake new file mode 100644 index 000000000..9331d0739 --- /dev/null +++ b/cmake/KDAB/modules/KDCompilerFlags.cmake @@ -0,0 +1,88 @@ +# +# SPDX-FileCopyrightText: 2021 Klarälvdalens Datakonsult AB, a KDAB Group company +# +# SPDX-License-Identifier: BSD-3-Clause +# + +# Compiler settings + +include(KDFunctions) + +if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_CXX_COMPILER_ID MATCHES "Clang") + kd_add_flag_if_supported(-Wunused-but-set-variable UNUSED_BUT_SET) + kd_add_flag_if_supported(-Wlogical-op LOGICAL_OP) + kd_add_flag_if_supported(-Wsizeof-pointer-memaccess POINTER_MEMACCESS) + kd_add_flag_if_supported(-Wreorder REORDER) + kd_add_flag_if_supported(-Wformat-security FORMAT_SECURITY) + kd_add_flag_if_supported(-Wsuggest-override SUGGEST_OVERRIDE) + + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -pedantic -Woverloaded-virtual -Winit-self") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wmissing-include-dirs -Wunused -Wundef -Wpointer-arith") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wmissing-noreturn -Werror=return-type -Wswitch") + if(CMAKE_CXX_COMPILER_ID MATCHES "Clang") + # -Wgnu-zero-variadic-macro-arguments (part of -pedantic) is triggered by every qCDebug() call + # and therefore results in a lot of noise. This warning is only notifying us that clang is + # emulating the GCC behaviour instead of the exact standard wording so we can safely ignore it + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-gnu-zero-variadic-macro-arguments") + endif() +endif() + +if(CMAKE_CXX_COMPILER_ID MATCHES "Clang") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Qunused-arguments -Wdocumentation") +endif() +if(CMAKE_C_COMPILER_ID MATCHES "Clang") + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Qunused-arguments -Wdocumentation") +endif() + +# Do not treat the operator name keywords and, bitand, bitor, compl, not, or and xor as synonyms as keywords. +# They're not supported under Visual Studio out of the box thus using them limits the portability of code +if(CMAKE_COMPILER_IS_GNUCXX + OR CMAKE_C_COMPILER_ID MATCHES "Clang" + OR (CMAKE_C_COMPILER_ID STREQUAL "Intel" AND NOT WIN32) +) + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-operator-names") +endif() + +if(MSVC) + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /permissive-") #use strict C++ compliance + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /wd4244") #conversion from __int64 to int possible loss of data + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /wd4267") #conversion from size_t to int possible loss of data + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /Zc:__cplusplus") #for an accurate __cplusplus macro +endif() + +if(WIN32) + add_definitions(-DUNICODE -D_UNICODE -D_USING_V110_SDK71_=1) +endif() + +if(QNXNTO) + add_definitions(-D_QNX_SOURCE) +endif() + +if(CYGWIN) + add_definitions(-D_GNU_SOURCE) +endif() + +if((CMAKE_CXX_COMPILER_ID STREQUAL "GNU" AND NOT APPLE) + OR (CMAKE_CXX_COMPILER_ID MATCHES "Clang" AND NOT APPLE) + OR (CMAKE_CXX_COMPILER_ID STREQUAL "Intel" AND NOT WIN32) +) + # Linker warnings should be treated as errors + set(CMAKE_SHARED_LINKER_FLAGS "-Wl,--fatal-warnings ${CMAKE_SHARED_LINKER_FLAGS}") + set(CMAKE_MODULE_LINKER_FLAGS "-Wl,--fatal-warnings ${CMAKE_MODULE_LINKER_FLAGS}") + + string(TOUPPER "CMAKE_CXX_FLAGS_${CMAKE_BUILD_TYPE}" compileflags) + if("${CMAKE_CXX_FLAGS} ${${compileflags}}" MATCHES "-fsanitize") + set(sanitizers_enabled TRUE) + else() + set(sanitizers_enabled FALSE) + endif() + + if(APPLE OR LINUX) #explicitly, not OpenBSD (or FreeBSD?) + # cannot enable this for clang + sanitizers + if(NOT sanitizers_enabled OR NOT CMAKE_CXX_COMPILER_ID MATCHES "Clang") + # Do not allow undefined symbols, even in non-symbolic shared libraries + set(CMAKE_SHARED_LINKER_FLAGS "-Wl,--no-undefined ${CMAKE_SHARED_LINKER_FLAGS}") + set(CMAKE_MODULE_LINKER_FLAGS "-Wl,--no-undefined ${CMAKE_MODULE_LINKER_FLAGS}") + endif() + endif() +endif() diff --git a/cmake/KDAB/modules/KDFunctions.cmake b/cmake/KDAB/modules/KDFunctions.cmake new file mode 100644 index 000000000..38faeb3bb --- /dev/null +++ b/cmake/KDAB/modules/KDFunctions.cmake @@ -0,0 +1,42 @@ +# +# SPDX-FileCopyrightText: 2021 Klarälvdalens Datakonsult AB, a KDAB Group company +# +# SPDX-License-Identifier: BSD-3-Clause +# +if(POLICY CMP0057) + cmake_policy(SET CMP0057 NEW) # if() supports IN_LIST +endif() + +get_property(_supported_languages GLOBAL PROPERTY ENABLED_LANGUAGES) +if("C" IN_LIST _supported_languages) + include(CheckCCompilerFlag) + set(KD_C_PROJECT True SCOPE GLOBAL) +endif() +if("CXX" IN_LIST _supported_languages) + include(CheckCXXCompilerFlag) + set(KD_CXX_PROJECT True SCOPE GLOBAL) +endif() + +# If the condition is true, add the specified value to the arguments at the parent scope +function(kd_append_if condition value) + if(${condition}) + foreach(variable ${ARGN}) + set(${variable} + "${${variable}} ${value}" + PARENT_SCOPE + ) + endforeach() + endif() +endfunction() + +# Add C and C++ compiler command line option +macro(kd_add_flag_if_supported flag name) + if(KD_C_PROJECT) + check_c_compiler_flag("-Werror ${flag}" "C_SUPPORTS_${name}") + kd_append_if("C_SUPPORTS_${name}" "${flag}" CMAKE_C_FLAGS) + endif() + if(KD_CXX_PROJECT) + check_cxx_compiler_flag("-Werror ${flag}" "CXX_SUPPORTS_${name}") + kd_append_if("CXX_SUPPORTS_${name}" "${flag}" CMAKE_CXX_FLAGS) + endif() +endmacro() diff --git a/cmake/KDAB/modules/KDInstallLocation.cmake b/cmake/KDAB/modules/KDInstallLocation.cmake new file mode 100644 index 000000000..4b6e9d195 --- /dev/null +++ b/cmake/KDAB/modules/KDInstallLocation.cmake @@ -0,0 +1,41 @@ +# +# SPDX-FileCopyrightText: 2012 Klarälvdalens Datakonsult AB, a KDAB Group company +# +# 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/cmake/KDAB/modules/KDQtInstallPaths.cmake b/cmake/KDAB/modules/KDQtInstallPaths.cmake new file mode 100644 index 000000000..6e0470161 --- /dev/null +++ b/cmake/KDAB/modules/KDQtInstallPaths.cmake @@ -0,0 +1,58 @@ +# +# SPDX-FileCopyrightText: 2016 Klarälvdalens Datakonsult AB, a KDAB Group company +# Author: Allen Winter +# +# 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() + +# use qtpaths if qmake not found +if(TARGET Qt${QT_VERSION_MAJOR}::qmake) + get_target_property(QT_QMAKE_EXECUTABLE Qt${QT_VERSION_MAJOR}::qmake LOCATION) +elseif(TARGET Qt${QT_VERSION_MAJOR}::qtpaths) + get_target_property(QT_QMAKE_EXECUTABLE Qt${QT_VERSION_MAJOR}::qtpaths 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/cmake/Qt5Portability.cmake b/cmake/Qt5Portability.cmake deleted file mode 100644 index 313b845ac..000000000 --- a/cmake/Qt5Portability.cmake +++ /dev/null @@ -1,32 +0,0 @@ - -include_directories(${Qt5Widgets_INCLUDE_DIRS}) - -if(QT_USE_QTNETWORK) - find_package(Qt5Network REQUIRED) - list(APPEND QT_LIBRARIES Qt5::Network) - include_directories(${Qt5Network_INCLUDE_DIRS}) -endif() - -if(QT_USE_QTXML) - find_package(Qt5Xml REQUIRED) - list(APPEND QT_LIBRARIES Qt5::Xml) - include_directories(${Qt5Xml_INCLUDE_DIRS}) -endif() - -if(QT_USE_QTTEST) - find_package(Qt5Test REQUIRED) - list(APPEND QT_LIBRARIES Qt5::Test) - include_directories(${Qt5Test_INCLUDE_DIRS}) -endif() - -macro(qt4_wrap_ui) - qt5_wrap_ui(${ARGN}) -endmacro() - -macro(qt4_wrap_cpp) - qt5_wrap_cpp(${ARGN}) -endmacro() - -macro(qt4_add_resources) - qt5_add_resources(${ARGN}) -endmacro() diff --git a/cmake/WriteBasicConfigVersionFile.cmake b/cmake/WriteBasicConfigVersionFile.cmake deleted file mode 100644 index 038cb5798..000000000 --- a/cmake/WriteBasicConfigVersionFile.cmake +++ /dev/null @@ -1,44 +0,0 @@ -# WRITE_BASIC_CONFIG_VERSION_FILE( filename VERSION major.minor.patch COMPATIBILITY (AnyNewerVersion|SameMajorVersion) ) -# -# Deprecated, see WRITE_BASIC_PACKAGE_VERSION_FILE(), it is identical. - -#============================================================================= -# Copyright 2008-2011 Alexander Neundorf, -# Copyright 2004-2009 Kitware, Inc. -# -# Distributed under the OSI-approved BSD License (the "License"); -# see accompanying file Copyright.txt for details. -# -# This software is distributed WITHOUT ANY WARRANTY; without even the -# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. -# See the License for more information. -#============================================================================= -# (To distribute this file outside of CMake, substitute the full -# License text for the above reference.) - -include(CMakeParseArguments) - -function(WRITE_BASIC_CONFIG_VERSION_FILE _filename) - - set(options ) - set(oneValueArgs VERSION COMPATIBILITY ) - set(multiValueArgs ) - - cmake_parse_arguments(CVF "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN}) - - if(CVF_UNPARSED_ARGUMENTS) - message(FATAL_ERROR "Unknown keywords given to WRITE_BASIC_CONFIG_VERSION_FILE(): \"${CVF_UNPARSED_ARGUMENTS}\"") - endif(CVF_UNPARSED_ARGUMENTS) - - set(versionTemplateFile "${CMAKE_ROOT}/Modules/BasicConfigVersion-${CVF_COMPATIBILITY}.cmake.in") - if(NOT EXISTS "${versionTemplateFile}") - message(FATAL_ERROR "Bad COMPATIBILITY value used for WRITE_BASIC_CONFIG_VERSION_FILE(): \"${CVF_COMPATIBILITY}\"") - endif() - - if("${CVF_VERSION}" STREQUAL "") - message(FATAL_ERROR "No VERSION specified for WRITE_BASIC_CONFIG_VERSION_FILE()") - endif() - - configure_file("${versionTemplateFile}" "${_filename}" @ONLY) - -endfunction(WRITE_BASIC_CONFIG_VERSION_FILE) diff --git a/conan/README.txt b/conan/README.txt new file mode 100644 index 000000000..93c49fec1 --- /dev/null +++ b/conan/README.txt @@ -0,0 +1,14 @@ +In the following example we assume you have the kdsoap source available in +/path/to/kdsoap-source. replace '/path/to/kdsoap-source' to fit your needs. + +$ conan create -s build_type=Release -o kdsoap:build_examples=True -o kdsoap:build_tests=True /path/to/kdsoap-source/conan kdab/stable + +configuration options: + * build_static + Builds static versions of the libraries. Default=False + + * build_tests + Build the test harness. Default=False + + * build_examples + Build the examples. Default=True diff --git a/conan/conanfile.py b/conan/conanfile.py new file mode 100644 index 000000000..1b0c06ca5 --- /dev/null +++ b/conan/conanfile.py @@ -0,0 +1,59 @@ +# This file is part of the KD Soap project. +# +# SPDX-FileCopyrightText: 2010 Klarälvdalens Datakonsult AB, a KDAB Group company +# +# SPDX-License-Identifier: MIT +# + +from conans import ConanFile, CMake, tools + +class KdsoapConan(ConanFile): + name = "KDSoap" + version = "2.2.0" + license = ("https://raw.githubusercontent.com/KDAB/KDSoap/master/LICENSES/MIT.txt") + author = "Klaralvdalens Datakonsult AB (KDAB) info@kdab.com" + url = "https://github.com/KDAB/KDSoap.git" + description = "KD Soap is a Qt-based client-side and server-side SOAP component." + generators = "cmake" + options = dict({ + "build_static": [True, False], + "build_examples": [True, False], + "build_tests": [True, False], + }) + default_options = dict({ + "build_static": False, + "build_examples": True, + "build_tests": False, + }) + settings = "build_type" + + def requirements(self): + self.requires("qt/5.13.2@kdab/stable") + + def source(self): + git = tools.Git(folder="") + git.clone(self.url) + git.checkout("kdsoap-%s-release"%self.version) + + def configure(self): + # Use same qt configuration for all kdab packages + # ~$ conan create -ks -o qt:qttools=True -o qt:qtsvg=True -o qt:qtdeclarative=True -o qt:qtremoteobjects=True -o qt:qtscxml=True . 5.13.2@kdab/stable + self.options["qt"].qtsvg = True + self.options["qt"].qtdeclarative = True + self.options["qt"].qtremoteobjects = True + self.options["qt"].qtscxml = True + self.options["qt"].qttools = True + + def build(self): + self.cmake = CMake(self) + self.cmake.definitions["KDSoap_STATIC"] = self.options.build_static + self.cmake.definitions["KDSoap_EXAMPLES"] = self.options.build_examples + self.cmake.definitions["KDSoap_TESTS"] = self.options.build_tests + self.cmake.configure() + self.cmake.build() + + def package(self): + self.cmake.install() + + def package_info(self): + self.env_info.CMAKE_PREFIX_PATH.append(self.package_folder) diff --git a/debian.changelog b/debian.changelog deleted file mode 100644 index 98c242000..000000000 --- a/debian.changelog +++ /dev/null @@ -1,53 +0,0 @@ -kdsoap (1.7.0) final; urgency=low - - * 1.7.0 final release - - -- Allen Winter Mon, 01 Mar 2018 16:00:00 -0500 - -kdsoap (1.6.0) final; urgency=low - - * 1.6.0 final release - - -- Allen Winter Mon, 01 May 2017 16:00:00 -0500 - -kdsoap (1.5.1) final; urgency=low - - * 1.5.1 bug fix release for 1.5 - - -- Allen Winter Mon, 06 Jun 2016 13:00:00 -0500 - -kdsoap (1.5.0) final; urgency=low - - * 1.5.0 final release - - -- Allen Winter Thu, 03 Mar 2016 11:30:00 -0500 - -kdsoap (1.4.99) final; urgency=low - - * 1.5.0 RC1 release - - -- Allen Winter Mon, 29 Feb 2016 12:00:00 -0500 - -kdsoap (1.4.0) final; urgency=low - - * 1.4.0 final release - - -- Allen Winter Thu, 25 Jun 2015 12:30:00 -0500 - -kdsoap (1.3.98) final; urgency=low - - * 1.4.0 RC1 release - - -- Allen Winter Tue, 12 Aug 2014 12:30:00 -0500 - -kdsoap (1.3.1) final; urgency=low - - * 1.3.1 bug release for 1.3 - - -- Allen Winter Thu, 07 Aug 2014 13:00:00 -0500 - -kdsoap (1.3.0) final; urgency=low - - * 1.3.0 final release - - -- Allen Winter Mon, 04 Aug 2014 16:00:00 -0500 diff --git a/debian.compat b/debian.compat deleted file mode 100644 index ec635144f..000000000 --- a/debian.compat +++ /dev/null @@ -1 +0,0 @@ -9 diff --git a/debian.control b/debian.control deleted file mode 100644 index a9180fb7b..000000000 --- a/debian.control +++ /dev/null @@ -1,15 +0,0 @@ -Source: kdsoap -Section: Miscellaneous -Priority: optional -Maintainer: Allen Winter -Build-Depends: debhelper (>=9), cdbs, cmake, libqt4-dev -Standards-Version: 3.9.6 -Homepage: https://github.com/KDAB/KDSoap - -Package: kdsoap -Architecture: any -Depends: ${misc:Depends}, ${shlibs:Depends}, ${misc:Depends} -Description: A Qt-based client-side and server-side SOAP component - KDSoap can be used to create client applications for web services - and also provides the means to create web services without the need - for any further component such as a dedicated web server. diff --git a/debian.rules b/debian.rules deleted file mode 100644 index f3d803d97..000000000 --- a/debian.rules +++ /dev/null @@ -1,3 +0,0 @@ -#!/usr/bin/make -f -include /usr/share/cdbs/1/rules/debhelper.mk -include /usr/share/cdbs/1/class/cmake.mk \ No newline at end of file diff --git a/deploy/release-kdsoap.sh b/deploy/release-kdsoap.sh new file mode 100755 index 000000000..3c1d77947 --- /dev/null +++ b/deploy/release-kdsoap.sh @@ -0,0 +1,259 @@ +#!/bin/bash + +# This file is part of the KD Soap project. +# +# SPDX-FileCopyrightText: 2024 Klarälvdalens Datakonsult AB, a KDAB Group company +# +# SPDX-License-Identifier: MIT +# + +#Exit if any undefined variable is used. +set -u +#Exit this script if it any subprocess exits non-zero. +set -e +#If any process in a pipeline fails, the return value is a failure. +set -o pipefail + +PROJECT=kdsoap +FORMAL_PROJECT=KDSoap #also used for the CMake options +SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd) +TOP=$(dirname "$SCRIPT_DIR") + +#function HELP +# print a help message and exit +HELP() { + echo + echo "Usage: $(basename "$0") [-f] X.Y.Z" + echo + echo "Create the tars/zips and sign for project release X.Y.Z" + echo " Options:" + echo " -f Force everything to run, even if the tag for X.Y.Z has already been pushed." + echo + exit 0 +} + +#git clone if needed, then update +GIT_UPDATE() { + mkdir -p "$1" + pushd "$1" + git init + set +e + git remote add origin "$3" + set -e + git fetch + git checkout master + git submodule update --init --recursive + popd +} + +#compare 2 version strings +verlte() { + printf '%s\n' "$1" "$2" | sort -C -V +} + +#function SYNCECM: $1 is "KDAB" or "ECM"; $2 is the fullpath to the official version +SYNCECM() { + set +e + echo -n "Comparing $1 cmake modules to upstream: " + savepwd=$(pwd) + if (test ! -d "$TOP/cmake/$1/modules"); then + echo "FAIL" + echo " This project does not have the $1 CMake modules collected under cmake/$1/modules. Please deal with this first" + exit 1 + fi + cd "$TOP/cmake/$1/modules" + whiteList="" + for m in *.cmake; do + if [ -n "$whiteList" ]; then + if [[ $m =~ $whiteList ]]; then + echo "SKIPPING $m" + continue + fi + fi + if (test -f "$2/modules/$m"); then + module="modules" + diff "$m" "$2/modules/$m" 2>&1 + savestat=$? + else + if (test -f "$2/find-modules/$m"); then + module="find-modules" + diff "$m" "$2/find-modules/$m" 2>&1 + savestat=$? + else + echo "What is $m doing here?" + exit 1 + fi + fi + if (test $savestat -ne 0); then + echo "FAIL. Differences encountered in upstream $m" + echo " Upstream: $2/$module/$m" + echo " $PROJECT: cmake/$1/modules/$m" + echo "Please sync the $PROJECT version before continuing (review changes first!)" + exit 1 + fi + done + echo "OK" + cd "$savepwd" + set -e +} + +options=$(getopt -o "hf" --long "help,force" -- "$@") +eval set -- "$options" +force=0 +while true; do + case "$1" in + -h | --help) + HELP + ;; + -f | --force) + force=1 + shift + ;; + --) + shift + break + ;; + *) + echo "Internal error!" + exit 1 + ;; + esac +done + +if (test $# -ne 1); then + HELP +fi + +#compute X(major), Y(minor), Z(patchlevel) +if [[ ! $1 =~ ^[0-9]*\.[0-9]*\.[0-9]*$ ]]; then + echo "\"$1\" is not a valid version string of the form X.Y.Z" + exit 1 +fi +X=$(echo "$1" | cut -d. -f1) +Y=$(echo "$1" | cut -d. -f2) +Z=$(echo "$1" | cut -d. -f3) + +#set the branch and tag +branch=$PROJECT-$X.$Y +tag=$branch.$Z +release=$X.$Y.$Z + +cd "$TOP" || exit 1 +tbranch=$(sed -e 's,.*/,,' "$TOP/.git/HEAD") +if (test "$tbranch" != "$branch"); then + echo "please git checkout $branch first" + exit +fi + +#Sanity Checking + +# Update doxyfile +if ! command -v doxygen &>/dev/null; then + echo "doxygen is not installed or not in your PATH. please fix." + exit 1 +fi + +#CI uses 1.12.0 at this time +minDoxyVersion="1.12.0" +export PATH=/usr/local/opt/doxygen-$minDoxyVersion/bin:$PATH +doxyVersion=$(doxygen -version | awk '{print $1}') +if ! verlte "$minDoxyVersion" "$doxyVersion"; then + echo "please install doxygen version $minDoxyVersion or higher" + exit 1 +fi + +echo -n "Ensuring Doxyfile.cmake is up-to-date: " +doxygen -u docs/api/Doxyfile.cmake >/dev/null 2>&1 +set +e +diff docs/api/Doxyfile.cmake docs/api/Doxyfile.cmake.bak >/dev/null 2>&1 +if (test $? -ne 0); then + echo "Doxyfile.cmake has been updated by 'doxygen -u'. Please deal with this first" + exit 1 +else + echo "OK" + rm -f docs/api/Doxyfile.cmake.bak +fi +set -e + +### KDAB cmake modules are synced +kdabECM="$HOME/projects/kdecm" +GIT_UPDATE "$kdabECM" "master" "ssh://codereview.kdab.com:29418/kdab/extra-cmake-modules" +SYNCECM "KDAB" "$kdabECM" +### KDE cmake modules are synced +kdeECM="$HOME/projects/extra-cmake-modules" +GIT_UPDATE "$kdeECM" "master" "git@invent.kde.org:frameworks/extra-cmake-modules" +SYNCECM "ECM" "$kdeECM" + +### pre-commit checking +echo "Pre-commit checking: " +pre-commit run --all-files +if (test $? -ne 0); then + echo "There are pre-commit issues. Please deal with this first" + exit 1 +else + echo "OK" +fi + +if (test "$(git tag -l | grep -c "$tag$")" -ne 1); then + echo "please create the git tag $tag first:" + echo "git tag -m \"$FORMAL_PROJECT $release\" $tag" + exit +fi + +if (test $force -eq 0 -a "$(git ls-remote --tags origin | grep -c "refs/tags/$tag$")" -gt 0); then + echo "The tag for $tag has already been pushed." + echo "Change the release number you provided on the command line." + echo 'Or, if you simply want to re-create the tar and zips use the "-f" option.' + exit +fi + +# create the API documentation +rm -rf build-docs "$PROJECT-$release-doc.zip" +mkdir build-docs +cd build-docs || exit 1 +cmake -G Ninja --warn-uninitialized -Werror=dev -D"$FORMAL_PROJECT"_DOCS=True .. +cmake --build . --target=docs +cd docs/api/html || exit 1 +7z a "$TOP/$PROJECT-$release-doc.zip" . +cd "$TOP" || exit 1 + +# create tar.gz version of the source +rm -rf "$PROJECT-$release" +mkdir -p "$PROJECT-$release/kdwsdl2cpp" +#copy in the submodules by-hand as git archive won't deal with submodules +git submodule update --recursive --init +cp -r kdwsdl2cpp/libkode "$PROJECT-$release/kdwsdl2cpp" +#copy in the generated API documentation +mkdir -p "$PROJECT-$release/docs" +cp -r "$TOP/build-docs/docs/api/html" "$PROJECT-$release/docs" +mv "$PROJECT-$release/docs/html" "$PROJECT-$release/docs/refman" +cp "$TOP/build-docs/docs/api/$PROJECT.tags" "$PROJECT-$release" +#tar up everything else +git archive --format=tar --prefix="$PROJECT-$release/" "$PROJECT-$X.$Y" >"$PROJECT-$release.tar" +tar -rf "$PROJECT-$release.tar" "$PROJECT-$release" +gzip -f "$PROJECT-$release.tar" +rm -rf build-docs + +# create the zip version of the tarball +tar xvfz "$PROJECT-$release.tar.gz" +7z a "$PROJECT-$release.zip" "$PROJECT-$release" +rm -rf "$PROJECT-$release" + +# sign the tarballs +gpg --yes --local-user "KDAB Products" --armor --detach-sign "$PROJECT-$release.tar.gz" +gpg --yes --local-user "KDAB Products" --armor --detach-sign "$PROJECT-$release.zip" + +# final cleaning +#anything to clean? + +# sanity +files="\ +$PROJECT-$release.tar.gz \ +$PROJECT-$release.tar.gz.asc \ +$PROJECT-$release.zip \ +$PROJECT-$release.zip.asc \ +$PROJECT-$release-doc.zip \ +" +for f in $files; do + ls -l "$f" +done diff --git a/qt5-kdsoap.spec b/distro/qt5-kdsoap.spec similarity index 68% rename from qt5-kdsoap.spec rename to distro/qt5-kdsoap.spec index 485ed78b3..baf5119eb 100644 --- a/qt5-kdsoap.spec +++ b/distro/qt5-kdsoap.spec @@ -1,11 +1,12 @@ Name: qt5-kdsoap -Version: 1.7.0 +Version: 2.2.0 Release: 1 Summary: A Qt5-based client-side and server-side SOAP component -Source: %{name}-%{version}.tar.gz -Url: http://github.com/KDAB/KDSoap +Source0: %{name}-%{version}.tar.gz +Source1: %{name}-%{version}.tar.gz.asc +Url: https://github.com/KDAB/KDSoap Group: System/Libraries -License: GPL-2.0+ +License: MIT BuildRoot: %{_tmppath}/%{name}-%{version}-build Vendor: Klaralvdalens Datakonsult AB (KDAB) Packager: Klaralvdalens Datakonsult AB (KDAB) @@ -45,11 +46,11 @@ This package contains header files and associated tools and libraries to develop programs which need to access web services using the SOAP protocol. %prep -%setup -q +%autosetup %build touch .license.accepted -cmake . -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_SKIP_RPATH=True -DCMAKE_BUILD_TYPE=Release +cmake . -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_SKIP_RPATH=True -DCMAKE_BUILD_TYPE=Release -DKDSoap_QT6=False %__make %{?_smp_mflags} %post -p /sbin/ldconfig @@ -70,16 +71,44 @@ cmake . -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_SKIP_RPATH=True -DCMAKE_BUILD_TYPE=R %files devel %defattr(-,root,root) %{_bindir}/kdwsdl2cpp -%{_prefix}/share/mkspecs %{_includedir}/KDSoapClient %{_includedir}/KDSoapServer %dir %{_libdir}/cmake/KDSoap %{_libdir}/cmake/KDSoap/* %{_libdir}/libkdsoap.so %{_libdir}/libkdsoap-server.so +%if 0%{?sle_version} >= 150200 && 0%{?is_opensuse} +%{_libdir}/qt5/mkspecs/modules/* +%endif +%{_prefix}/share/mkspecs/ +%if 0%{?suse_version} > 1500 +%{_libdir}/qt5/mkspecs/modules/* +%endif +%if 0%{?fedora} > 28 +%{_libdir}/qt5/mkspecs/modules/* +%endif +%if %{defined rhel} +%{_libdir}/qt5/mkspecs/modules/* +%endif %changelog -* Mon Mar 01 2018 Allen Winter 1.7.0 +* Sun Jan 07 2024 Allen Winter 2.2.0 + 2.2.0 +* Mon Sep 12 2022 Allen Winter 2.1.1 + 2.1.1 +* Sun Sep 11 2022 Allen Winter 2.1.0 + 2.1.0 +* Tue Jun 29 2021 Allen Winter 2.0.0 + 2.0.0 +* Tue Dec 22 2020 Allen Winter 1.10.0 + 1.10.0 +* Wed Sep 30 2020 Allen Winter 1.9.1 + 1.9.1 +* Mon Feb 17 2020 Allen Winter 1.9.0 + 1.9.0 +* Fri May 17 2019 Allen Winter 1.8.0-1 + 1.8.0 +* Thu Mar 01 2018 Allen Winter 1.7.0 1.7.0 * Mon May 01 2017 Allen Winter 1.6.0 1.6.0 diff --git a/kdsoap.spec b/distro/qt6-kdsoap.spec similarity index 50% rename from kdsoap.spec rename to distro/qt6-kdsoap.spec index 43f4071a1..d079078a6 100644 --- a/kdsoap.spec +++ b/distro/qt6-kdsoap.spec @@ -1,25 +1,27 @@ -Name: kdsoap -Version: 1.7.0 +Name: qt6-kdsoap +Version: 2.2.0 Release: 1 -Summary: A Qt-based client-side and server-side SOAP component -Source: %{name}-%{version}.tar.gz -Url: http://github.com/KDAB/KDSoap -Group: System Environment/Libraries -License: LGPL-2.1+ +Summary: A Qt6-based client-side and server-side SOAP component +Source0: %{name}-%{version}.tar.gz +Source1: %{name}-%{version}.tar.gz.asc +Url: https://github.com/KDAB/KDSoap +Group: System/Libraries +License: MIT BuildRoot: %{_tmppath}/%{name}-%{version}-build Vendor: Klaralvdalens Datakonsult AB (KDAB) Packager: Klaralvdalens Datakonsult AB (KDAB) +BuildRequires: cmake %if %{defined suse_version} -BuildRequires: libqt4-devel +BuildRequires: libqt6-qtbase-devel %endif %if %{defined fedora} -BuildRequires: gcc-c++ qt-devel desktop-file-utils +BuildRequires: gcc-c++ qt6-qtbase-devel desktop-file-utils %endif %if %{defined rhel} -BuildRequires: gcc-c++ qt-devel desktop-file-utils +BuildRequires: gcc-c++ qt6-qtbase-devel desktop-file-utils %endif %description @@ -36,7 +38,7 @@ Authors: %package devel Summary: Development files for %{name} -Group: Development/System +Group: Development/Libraries/C and C++ Requires: %{name} = %{version} %description devel @@ -44,15 +46,11 @@ This package contains header files and associated tools and libraries to develop programs which need to access web services using the SOAP protocol. %prep -%setup -q +%autosetup %build touch .license.accepted -%if "%{_lib}"=="lib64" -QMAKE_ARGS="LIB_SUFFIX=64" ./configure.sh -shared -release -prefix %{buildroot}/usr -%else -./configure.sh -shared -release -prefix %{buildroot}/usr -%endif +cmake . -DCMAKE_INSTALL_PREFIX=/usr -DKDSoap_QT6=True -DCMAKE_SKIP_RPATH=True -DCMAKE_BUILD_TYPE=Release %__make %{?_smp_mflags} %post -p /sbin/ldconfig @@ -66,28 +64,44 @@ QMAKE_ARGS="LIB_SUFFIX=64" ./configure.sh -shared -release -prefix %{buildroot}/ %files %defattr(-,root,root) -%{_prefix}/share/doc/KDSoap -%{_libdir}/libkdsoap.so.* -%{_libdir}/libkdsoap-server.so.* +%{_prefix}/share/doc/KDSoap-qt6 +%{_libdir}/libkdsoap-qt6.so.* +%{_libdir}/libkdsoap-server-qt6.so.* %files devel %defattr(-,root,root) -%{_bindir}/kdwsdl2cpp -%{_prefix}/share/mkspecs -%{_includedir}/KDSoapClient -%{_includedir}/KDSoapServer -%{_libdir}/libkdsoap.so -%{_libdir}/libkdsoap-server.so +%{_bindir}/kdwsdl2cpp-qt6 +%{_includedir}/KDSoapClient-Qt6 +%{_includedir}/KDSoapServer-Qt6 +%dir %{_libdir}/cmake/KDSoap-qt6 +%{_libdir}/cmake/KDSoap-qt6/* +%{_libdir}/libkdsoap-qt6.so +%{_libdir}/libkdsoap-server-qt6.so +%{_libdir}/qt6/mkspecs/modules/* %changelog -* Mon Mar 01 2018 Allen Winter 1.7.0 +* Sun Jan 07 2024 Allen Winter 2.2.0 + 2.2.0 +* Mon Sep 12 2022 Allen Winter 2.1.1 + 2.1.1 +* Sun Sep 11 2022 Allen Winter 2.1.0 + 2.1.0 +* Tue Jun 29 2021 Allen Winter 2.0.0 + 2.0.0 +* Tue Dec 22 2020 Allen Winter 1.10.0 + 1.10.0 +* Wed Sep 30 2020 Allen Winter 1.9.1 + 1.9.1 +* Mon Feb 17 2020 Allen Winter 1.9.0 + 1.9.0 +* Fri May 17 2019 Allen Winter 1.8.0-1 + 1.8.0 +* Thu Mar 01 2018 Allen Winter 1.7.0 1.7.0 * Mon May 01 2017 Allen Winter 1.6.0 1.6.0 -* Tue Jun 06 2016 Allen Winter 1.5.1 +* Tue Jun 07 2016 Allen Winter 1.5.1 1.5.1 bug fix -* Thu Mar 03 2016 Allen Winter 1.5.0 - 1.5.0 Final * Mon Feb 29 2016 Allen Winter 1.4.99 1.5.0 RC1 * Thu Jun 25 2015 Allen Winter 1.4.0 diff --git a/doc/CHANGES_1_8.txt b/doc/CHANGES_1_8.txt deleted file mode 100644 index a39bbdd65..000000000 --- a/doc/CHANGES_1_8.txt +++ /dev/null @@ -1,29 +0,0 @@ -General: -======== -* Fix internally-created faults lacking an XML element name (so e.g. toXml() would abort) - -Client-side: -============ -* Add support for timing out requests (default 30 minutes, configurable with KDSoapClientInterface::setTimeout()) -* Add support for soap 1.2 faults in faultAsString() -* Improve detection of soap 1.2 faults in HTTP response -* Stricter namespace check for Fault elements being received -* Report client-generated faults as SOAP 1.2 if selected -* Fix error code when authentication failed -* Autodeletion of jobs is now configurable (github pull #125) -* Add error details in faultAsString() - and the generated lastError() - coming from the SOAP 1.2 detail element. - -Server-side: -============ -* New method KDSoapServerObjectInterface::additionalHttpResponseHeaderItems to let server objects return additional http headers. - This can be used to implement support for CORS, using KDSoapServerCustomVerbRequestInterface to implement OPTIONS response, - with "Access-Control-Allow-Origin" in the headers of the response (github issue #117). -* Don't generate two job classes with the same name, when two bindings have the same operation name. Prefix one of them with the binding name (github issue #139 part 1) -* Prepend this-> in method class to avoid compilation error when the variable and the method have the same name (github issue #139 part 2) - -WSDL parser / code generator changes, applying to both client and server side: -================================================================ -* Fix double-handling of empty elements -* Fix fault elements being generated in the wrong namespace, must be SOAP-ENV:Fault (github issue #81). -* Added import-path argument for setting the local path to get (otherwise downloaded) files from. -* Added -help-on-missing option to kdwsdl2cpp to display extra help on missing types. diff --git a/doc/config/footer.html b/doc/config/footer.html deleted file mode 100644 index 677e0f71a..000000000 --- a/doc/config/footer.html +++ /dev/null @@ -1,9 +0,0 @@ -
- - - - - -
Copyright © 2010-2018, Klarälvdalens Datakonsult ABKD Soap
- - diff --git a/doc/CHANGES_1_1.txt b/docs/CHANGES_1_1.txt similarity index 99% rename from doc/CHANGES_1_1.txt rename to docs/CHANGES_1_1.txt index 7e0e173da..791d5b767 100644 --- a/doc/CHANGES_1_1.txt +++ b/docs/CHANGES_1_1.txt @@ -7,4 +7,3 @@ Response parsing in KDSoapMessage: implement type conversion based on type infor Fix compilation error when the name of a wsdl:service contains a '-'. NEW: server side support - diff --git a/docs/CHANGES_1_10.txt b/docs/CHANGES_1_10.txt new file mode 100644 index 000000000..98a8ca028 --- /dev/null +++ b/docs/CHANGES_1_10.txt @@ -0,0 +1,18 @@ +General: +======== +* No longer supporting Qt 4 +* Minimum Qt version is 5.7 +* Minimum CMake version is 3.0.2 +* qmake buildsystem -- no longer prompt for license choice. + users should carefully consider their choice of license +* The qmake buildsystem is deprecated + +CMake buildsystem: +================== +* Generates .pri files for qmake users +* Installs library pdb files with MSVC builds +* fix library versioning for RelWithDebInfo on Windows (Version 1.10.1) + +WSDL parser / code generator changes, applying to both client and server side: +================================================================ +* Add commandline options to turn off generation of the sync/async/asyncjobs APIs. This improves compilation times. (#225) diff --git a/doc/CHANGES_1_2.txt b/docs/CHANGES_1_2.txt similarity index 100% rename from doc/CHANGES_1_2.txt rename to docs/CHANGES_1_2.txt diff --git a/doc/CHANGES_1_3.txt b/docs/CHANGES_1_3.txt similarity index 92% rename from doc/CHANGES_1_3.txt rename to docs/CHANGES_1_3.txt index 25f2bca87..3a466dbe2 100644 --- a/doc/CHANGES_1_3.txt +++ b/docs/CHANGES_1_3.txt @@ -20,7 +20,7 @@ Client-side: * Fix namespace of the main element in messages being sent, the NS from the schema must be used rather than the NS from the WSDL, when both exist (github issue4). * Fix assert when the response message is empty (github issue1). -* Set attribute xsi:nil="true" in empty elements, as per http://www.w3.org/TR/xmlschema-1/#xsi_nil +* Set attribute xsi:nil="true" in empty elements, as per https://www.w3.org/TR/xmlschema-1/#xsi_nil * Fix missing setters for headers, when generating multiple classes * Fix job classes to be per-binding, when multiple bindings are generated. @@ -36,12 +36,12 @@ Server-side: (fix compilation error, and set version to SOAP_1_2 in the 1.2 binding) (SOAP-44). * Fix handling of requests in RPC mode. * Fix small memory leak if the device returned from processFileRequest can not be accessed (SOAP-48). -* Clean incoming path recieved via HTTP from "./" and "../" (SOAP-49). +* Clean incoming path received via HTTP from "./" and "../" (SOAP-49). * Add ability to set custom ssl configuration for new connections. Code generator changes, applying to both client and server side: ================================================================ -* Support for SOAP-1.2 encoding namespace (http://www.w3.org/2003/05/soap-encoding) +* Support for SOAP-1.2 encoding namespace (https://www.w3.org/2003/05/soap-encoding) * Improve parsing of soap-enc:array restrictions, to use the correct element names, when specified * Fix parsing of , which sometimes didn't encode the parameters. * Fix generation of classes with nested namespaces (A::B::C) diff --git a/doc/CHANGES_1_4.txt b/docs/CHANGES_1_4.txt similarity index 98% rename from doc/CHANGES_1_4.txt rename to docs/CHANGES_1_4.txt index 57be56cf9..a767ec4e1 100644 --- a/doc/CHANGES_1_4.txt +++ b/docs/CHANGES_1_4.txt @@ -30,11 +30,10 @@ Code generator changes, applying to both client and server side: * Only set xsi:nil="true" on elements that are marked as nillable in the WSDL file. * Omit non-nillable empty elements of a complex type. * Support for minOccurs=0 for elements and use=optional for attributes: - omit such elements/attributes when they haven't been set by the C++ code explicitely. (SOAP-93/SOAP-80) + omit such elements/attributes when they haven't been set by the C++ code explicitly. (SOAP-93/SOAP-80) optionally wrap them in a boost::optional or use raw pointers so apps can find out the element is missing (issue43). * Support for attributes marked as "prohibited", ensuring they are not settable nor sent in the request. (SOAP-102) * Generate element automatically if there's none in the WSDL file. (SOAP-60/issue9) * Implement support for inheritance between complex types, using QSharedPointer as internal storage. (issue26/SOAP-87/SOAP-62) * Implement support for substitutionGroup, in order to send the correct element name (SOAP-87 followup, SOAP-97). * Fix crash when parsing elements without a type. - diff --git a/doc/CHANGES_1_5.txt b/docs/CHANGES_1_5.txt similarity index 99% rename from doc/CHANGES_1_5.txt rename to docs/CHANGES_1_5.txt index 2ec9910d8..5fc2b72a6 100644 --- a/doc/CHANGES_1_5.txt +++ b/docs/CHANGES_1_5.txt @@ -64,4 +64,3 @@ WSDL parser / code generator changes, applying to both client and server side: * Relative paths to schemas being imported or included are now resolved based on the location of the parent file rather than the location of the toplevel WSDL file. - diff --git a/doc/CHANGES_1_5_1.txt b/docs/CHANGES_1_5_1.txt similarity index 98% rename from doc/CHANGES_1_5_1.txt rename to docs/CHANGES_1_5_1.txt index a9b59c43a..1166ff89a 100644 --- a/doc/CHANGES_1_5_1.txt +++ b/docs/CHANGES_1_5_1.txt @@ -4,7 +4,7 @@ General: Client-side: ============ -* +* Server-side: ============ @@ -13,4 +13,3 @@ Server-side: WSDL parser / code generator changes, applying to both client and server side: ================================================================ * RPC mode: escape part names which look like C++ keywords (e.g. "delete") - diff --git a/doc/CHANGES_1_6.txt b/docs/CHANGES_1_6.txt similarity index 99% rename from doc/CHANGES_1_6.txt rename to docs/CHANGES_1_6.txt index bd415d804..b8ca63c2d 100644 --- a/doc/CHANGES_1_6.txt +++ b/docs/CHANGES_1_6.txt @@ -9,9 +9,8 @@ Client-side: Server-side: ============ -* +* WSDL parser / code generator changes, applying to both client and server side: ================================================================ * Fix deserialization of optional lists (the associated nil variable wasn't set to false) - diff --git a/doc/CHANGES_1_7.txt b/docs/CHANGES_1_7.txt similarity index 100% rename from doc/CHANGES_1_7.txt rename to docs/CHANGES_1_7.txt diff --git a/docs/CHANGES_1_8.txt b/docs/CHANGES_1_8.txt new file mode 100644 index 000000000..cbcac3d36 --- /dev/null +++ b/docs/CHANGES_1_8.txt @@ -0,0 +1,60 @@ +General: +======== +* Fix internally-created faults lacking an XML element name (so e.g. toXml() would abort) +* KDSoapMessage::messageAddressingProperties() is now correctly filled in when receiving a message with WS-Addressing in the header + +Client-side: +============ +* Add support for timing out requests (default 30 minutes, configurable with KDSoapClientInterface::setTimeout()) +* Add support for soap 1.2 faults in faultAsString() +* Improve detection of soap 1.2 faults in HTTP response +* Stricter namespace check for Fault elements being received +* Report client-generated faults as SOAP 1.2 if selected +* Fix error code when authentication failed +* Autodeletion of jobs is now configurable (github pull #125) +* Add error details in faultAsString() - and the generated lastError() - coming from the SOAP 1.2 detail element. +* Fix memory leak in KDSoapClientInterface::callNoReply +* Add support for WS-UsernameToken, see KDSoapAuthentication +* Extend KDSOAP_DEBUG functionality (e.g. "KDSOAP_DEBUG=http,reformat" will now print http-headers and pretty-print the xml) +* Add support for specifying requestHeaders as part of KDSoapJob via KDSoapJob::setRequestHeaders() +* Rename the missing KDSoapJob::returnHeaders() to KDSoapJob::replyHeaders(), and provide an implementation +* Make KDSoapClientInterface::soapVersion() const +* Add lastFaultCode() for error handling after sync calls. Same as lastErrorCode() but it returns a QString rather than an int. +* Add conversion operator from KDDateTime to QVariant to void implicit conversion to base QDateTime (github issue #123). + +Server-side: +============ +* New method KDSoapServerObjectInterface::additionalHttpResponseHeaderItems to let server objects return additional http headers. + This can be used to implement support for CORS, using KDSoapServerCustomVerbRequestInterface to implement OPTIONS response, + with "Access-Control-Allow-Origin" in the headers of the response (github issue #117). +* Don't generate two job classes with the same name, when two bindings have the same operation name. Prefix one of them with the binding name (github issue #139 part 1) +* Prepend this-> in method class to avoid compilation error when the variable and the method have the same name (github issue #139 part 2) + +WSDL parser / code generator changes, applying to both client and server side: +================================================================ +* Source incompatible change: all deserialize() functions now require a KDSoapValue instead of a + QVariant. If you use a deserialize(QVariant) function, you need to port your code to use + KDSoapValue::setValue(QVariant) before deserialize() +* Source incompatible change: all serialize() functions now return a KDSoapValue instead of a + QVariant. If you use a QVariant serialize() function, you need to port your code to use + QVariant KDSoapValue::value() after serialize() +* Source incompatible change: xs:QName is now represented by KDQName instead of QString, which + allows the namespace to be extracted. The old behaviour is available via KDQName::qname(). +* Fix double-handling of empty elements +* Fix fault elements being generated in the wrong namespace, must be SOAP-ENV:Fault (github issue #81). +* Added import-path argument for setting the local path to get (otherwise downloaded) files from. +* Added -help-on-missing option to kdwsdl2cpp to display extra help on missing types. +* Added C++17 std::optional as possible return value for optional elements. +* Added -both to create both header(.h) and implementation(.cpp) files in one run +* Added -namespaceMapping @mapping.txt to import url=code mappings, affects C++ class name generation +* Added functionality to prevent downloading the same WSDL/XSD file twice in one run +* Added "hasValueFor{MemberName}()" accessor function, for optional elements +* Generated services now include soapVersion() and endpoint() accessors to match the setSoapVersion(...) and setEndpoint(...) mutators +* Added support for generating messages for WSDL files without services or bindings +* Fix erroneous QT_BEGIN_NAMESPACE around forward-declarations like Q17__DialogType. +* KDSoapValue now stores the namespace declarations during parsing of a message and writes + namespace declarations during sending of a message +* Avoid serialize crash with required polymorphic types, if the required variable wasn't actually provided +* Fix generated code for restriction to base class (it wouldn't compile) +* Prepend "undef daylight" and "undef timezone" to all generated files, to fix compilation errors in wsdl files that use those names, due to nasty Windows macros +* Added generation for default attribute values. diff --git a/docs/CHANGES_1_9.txt b/docs/CHANGES_1_9.txt new file mode 100644 index 000000000..b829ba1b4 --- /dev/null +++ b/docs/CHANGES_1_9.txt @@ -0,0 +1,34 @@ +General: +======== +* C++11 is now required. Qt4 is still supported, but this is the last release with support for Qt4. +* Fix rpath for Unix/Linux/macOS (#181). +* Improve cmake usage by setting the install interface directories on the library targets (#196). + You can just link to KDSoap::kdsoap and you'll get the correct include paths now. +* New installing file for Conan (WIP - see conan folder) + +In release 1.9.1: +----------------- +* Restore previous EULA (LICENSE.txt and LICENSE.US.txt) +* remove unittests: onvif_org_event, onvif_ptz, onvif.org WSDL +* Fix static linking examples and unittests in the CMake buildsystem +* small buildsystem improvements + +Client-side: +============ +* Add support for selecting WS-Addressing namespace for send messages (#176). +* Fix WS-Addressing spec compliance (#193) +* Add support for implementing SOAP-over-UDP clients (see KDSoapUdpClient). + +Server-side: +============ + +WSDL parser / code generator changes, applying to both client and server side: +================================================================ +* Add override indicator to generated files. This requires c++11 for users of generated files. +* Add option for loading PKCS12 certificates (#190). +* Remove all special handling of soap/encoding namespace, which fixes the use of soapenc:string and soapenc:integer for instance (#179). +* Fix compilation error due to missing QSharedPointer include in generated code (#170). + +Examples: +======== +* The holidays examples have been replaced with bank-lookup examples. Less fun, but the holidays web service no longer exists... diff --git a/docs/CHANGES_2_0.txt b/docs/CHANGES_2_0.txt new file mode 100644 index 000000000..622ea7288 --- /dev/null +++ b/docs/CHANGES_2_0.txt @@ -0,0 +1,24 @@ + +General: +======== +* Supports Qt6 in addition to Qt5 +* Minimum Qt version is 5.9 +* The qmake buildsystem (via autogen.py) is removed. +* buildsystem: a new 'docs' target is created when CMake -DKDSoap_DOCS=True. +* buildsystem: the API manual is now generated in build/docs vice source/docs. +* buildsystem: added an uninstall target +* buildsystem: generate and install kdsoap-version.h +* The API manual is generated+installed in qch format for Qt assistant. + +Client-side: +============ +* Added options to the KDSoapClient specifying the SOAP action sending method + +Server-side: +============ + +WSDL parser / code generator changes, applying to both client and server side: +================================================================ +* Fix generated code in case a variable is called "d" or "q" (#118) +* Fix generated code for an enumeration type with a length restriction (#234) +* Avoid potential type collisions in nested complexTypes (#239) diff --git a/docs/CHANGES_2_1.txt b/docs/CHANGES_2_1.txt new file mode 100644 index 000000000..34517a10d --- /dev/null +++ b/docs/CHANGES_2_1.txt @@ -0,0 +1,19 @@ + +General: +======== +* Re-license project to MIT and remove the commercial offering +* buildsystem - Increase minimum CMake version to 3.12.0 +* buildsystem - Build in Release mode by default (in non-developer situations) + +Client-side: +============ +* Generate "explicit" in front of service and job constructors (issue #206) + +Server-side: +============ +* Disable HTTP/2 support (which Qt 6 enables by default), it causes trouble with some SOAP servers (issue #246). +* Improve parsing of GET argument to avoid misinterpreting queries (possible security issue #247). + +WSDL parser / code generator changes, applying to both client and server side: +================================================================ +* diff --git a/docs/CHANGES_2_1_1.txt b/docs/CHANGES_2_1_1.txt new file mode 100644 index 000000000..27018ac6c --- /dev/null +++ b/docs/CHANGES_2_1_1.txt @@ -0,0 +1,18 @@ + +General: +======== +* buildsystem - undo co-installability of Qt5 and Qt6 headers. + It would require that kdwsdl2cpp generates #include + which in turn would break the build of KDSoap itself, so this gets tricky. + +Client-side: +============ +* + +Server-side: +============ +* + +WSDL parser / code generator changes, applying to both client and server side: +================================================================ +* diff --git a/docs/CHANGES_2_2.txt b/docs/CHANGES_2_2.txt new file mode 100644 index 000000000..f2c1e7a7f --- /dev/null +++ b/docs/CHANGES_2_2.txt @@ -0,0 +1,18 @@ + +General: +======== +* buildsystem - Add co-installability of Qt5 and Qt6 headers back. + Installs Qt6 headers into their own subdirectory so client code still works, but can be co-installed with Qt5 again. + +Client-side: +============ +* Add KDSoapClientInterface::setMessageAddressingProperties() so that WS-Addressing support can be used with WSDL-generated services (issue #254) +* Don't require a SOAP action in order to write addressing properties (also issue #254) + +Server-side: +============ +* + +WSDL parser / code generator changes, applying to both client and server side: +================================================================ +* Improve -import-path support by using the import path in more places in the code diff --git a/docs/CHANGES_2_3.txt b/docs/CHANGES_2_3.txt new file mode 100644 index 000000000..0b69a59c7 --- /dev/null +++ b/docs/CHANGES_2_3.txt @@ -0,0 +1,17 @@ + +General: +======== +* C++17 is now required. Qt-5.15 is still supported, in addition to the latest Qt6 versions. +* KDSoap now looks for Qt6 by default, rather than Qt5. If your Qt5 build broke, pass -DKDSoap_QT6=OFF to CMake. + +Client-side: +============ +* + +Server-side: +============ +* Support for RFC 7233 (Range Requests) +* To avoid mixing up raw-xml requests in the same server object (#288), KDSoap now creates a server object for each incoming connection. + Make sure your server object is ready to be created multiple times (this was already a requirement when enabling multi-threading with setThreadPool()). +* Improve security when handling requests to download files, to make sure we never go outside the base directory (#314) +* Fix memory leak in KDSoapServer on shutdown (the sockets were not always deleted) diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt new file mode 100644 index 000000000..4623d072d --- /dev/null +++ b/docs/CMakeLists.txt @@ -0,0 +1,20 @@ +# This file is part of the KD Soap project. +# +# SPDX-FileCopyrightText: 2021 Klarälvdalens Datakonsult AB, a KDAB Group company +# +# SPDX-License-Identifier: MIT +# + +# 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/docs/api/CMakeLists.txt b/docs/api/CMakeLists.txt new file mode 100644 index 000000000..71dd0694d --- /dev/null +++ b/docs/api/CMakeLists.txt @@ -0,0 +1,91 @@ +# This file is part of the KD Soap project. +# +# SPDX-FileCopyrightText: 2021 Klarälvdalens Datakonsult AB, a KDAB Group company +# +# SPDX-License-Identifier: MIT +# + +# 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() + +# latex +set(HAVE_LATEX "NO") +find_package(LATEX) +set_package_properties( + LATEX PROPERTIES + TYPE OPTIONAL + DESCRIPTION "A document preparation system" + URL "https://www.latex-project.org" + PURPOSE "Provides for building a PS or PDF version of the API documentation" +) +if(LATEX_FOUND) + if(MAKEINDEX_COMPILER) + set(HAVE_LATEX "YES") + else() + message(STATUS "The LaTeX makeindex compiler could not be located. " + "Unable to generate the buildsystem for LaTex documentation generation." + ) + endif() +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 "") +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/kdsoap-api.qch + COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile + DEPENDS ${_dox_deps} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile + WORKING_DIRECTORY ${CMAKE_BINARY_DIR} + COMMENT "Generate the .qch file" +) +add_custom_target( + kdsoap-api.qch ALL + DEPENDS ${DOXYGEN_OUTPUT_DIR}/qch/kdsoap-api.qch + COMMENT "Target to generate the .qch file" +) +add_custom_target( + docs + DEPENDS kdsoap-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/kdsoap-api.qch + DESTINATION ${QCH_INSTALL_DIR} +) +install( + FILES ${DOXYGEN_OUTPUT_DIR}/kdsoap.tags + DESTINATION ${INSTALL_DOC_DIR} +) diff --git a/docs/api/Doxyfile.cmake b/docs/api/Doxyfile.cmake new file mode 100644 index 000000000..e4b93b839 --- /dev/null +++ b/docs/api/Doxyfile.cmake @@ -0,0 +1,2868 @@ +# Doxyfile 1.12.0 + +# This file describes the settings to be used by the documentation system +# Doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). +# +# Note: +# +# Use Doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use Doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "KD SOAP 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 = @KDSoap_VERSION_MAJOR@.@KDSoap_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 = @CMAKE_SOURCE_DIR@/images/kdsoap-medium.png + +# With the PROJECT_ICON tag one can specify an icon that is included in the tabs +# when the HTML document is shown. Doxygen will copy the logo to the output +# directory. + +PROJECT_ICON = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where Doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = @DOXYGEN_OUTPUT_DIR@ + +# If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096 +# sub-directories (in 2 levels) under the output directory of each output format +# and will distribute the generated files over these directories. Enabling this +# option can be useful when feeding Doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# number of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + +# If the ALLOW_UNICODE_NAMES tag is set to YES, Doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by Doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with +# English messages), Korean, Korean-en (Korean with English messages), Latvian, +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, +# Swedish, Turkish, Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, Doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, Doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The \$name class" \ + "The \$name widget" \ + "The \$name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, Doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, Doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = 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:^^" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = "inv=\invariant" \ + "since_l=\nThis library was introduced in KD SOAP" \ + "since_c=\nThis class was introduced in KD SOAP" \ + "since_d=\nThis macro was introduced in KD SOAP" \ + "since_f=\nThis function was introduced in KD SOAP" \ + "since_e=\nThis enumeration was introduced in KD SOAP" \ + "since_p=\nThis property was introduced in KD SOAP" \ + "since_v=\nThis enumeration value was introduced in KD SOAP" \ + "since_t=\nThis typedef was introduced in KD SOAP" \ + "reimp=\internal" + +# 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++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make Doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by Doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then Doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by Doxygen, so you can +# mix Doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 6. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to +# generate identifiers for the Markdown headings. Note: Every identifier is +# unique. +# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a +# sequence number starting at 0 and GITHUB use the lower case version of title +# with any whitespace replaced by '-' and punctuation characters removed. +# The default value is: DOXYGEN. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_ID_STYLE = DOXYGEN + +# When enabled Doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let Doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also makes the inheritance and +# collaboration diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software) sources only. Doxygen will parse +# them like normal C++ but will assume all classes use public instead of private +# inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# Doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then Doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = 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 of threads Doxygen is allowed to use +# during processing. When set to 0 Doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +# If the TIMESTAMP tag is set different from NO then each generated page will +# contain the date or date and time when the page was generated. Setting this to +# NO can help when comparing the output of multiple runs. +# Possible values are: YES, NO, DATETIME and DATE. +# The default value is: NO. + +TIMESTAMP = YES + +#--------------------------------------------------------------------------- +# 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 this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = 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 + +# With the correct setting of option CASE_SENSE_NAMES Doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and macOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. + +CASE_SENSE_NAMES = 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_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES then Doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = 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 ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# Doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by Doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by Doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents Doxygen's defaults, run Doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run Doxygen from a directory containing a file called +# DoxygenLayout.xml, Doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +# The EXTERNAL_TOOL_PATH tag can be used to extend the search path (PATH +# environment variable) so that external tools such as latex and gs can be +# found. +# Note: Directories specified with EXTERNAL_TOOL_PATH are added in front of the +# path already specified by the PATH variable, and are added in the order +# specified. +# Note: This option is particularly useful for macOS version 14 (Sonoma) and +# higher, when running Doxygen from Doxywizard, because in this case any user- +# defined changes to the PATH are ignored. A typical example on macOS is to set +# EXTERNAL_TOOL_PATH = /Library/TeX/texbin /usr/local/bin +# together with the standard path, the full search path used by doxygen when +# launching external tools will then become +# PATH=/Library/TeX/texbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin + +EXTERNAL_TOOL_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by Doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by Doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then Doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, Doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, Doxygen will warn about incomplete +# function parameter documentation. If set to NO, Doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, Doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = YES + +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, Doxygen will warn about +# undocumented enumeration values. If set to NO, Doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + +# If the WARN_AS_ERROR tag is set to YES then Doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then Doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the Doxygen process Doxygen will return with a non-zero status. +# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then Doxygen behaves +# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined Doxygen will not +# write the warning messages in between other messages but write them at the end +# of a run, in case a WARN_LOGFILE is defined the warning messages will be +# besides being in the defined file also be shown at the end of a run, unless +# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case +# the behavior will remain as with the setting FAIL_ON_WARNINGS. +# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that Doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# See also: WARN_LINE_FORMAT +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of Doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). + +WARN_LOGFILE = 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@/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. +# See also: INPUT_FILE_ENCODING +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# This tag can be used to specify the character encoding of the source files +# that Doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING) if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). +# See also: INPUT_ENCODING for further information on supported encodings. + +INPUT_FILE_ENCODING = + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by Doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, +# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, +# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, +# *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to +# be provided as Doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.cpp \ + *.h \ + *.dox \ + *.md \ + *.gif + +# 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 = moc_*.cpp \ + ui_*.h \ + qrc_*.cpp + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# ANamespace::AClass, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = examples + +# 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 = [a-z]*.cpp \ + [a-z]*.h + +# 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 = YES + +# 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 = "@CMAKE_SOURCE_DIR@/images" \ + "@CMAKE_CURRENT_SOURCE_DIR@" + +# The INPUT_FILTER tag can be used to specify a program that Doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that Doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by Doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=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 = + +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# multi-line macros, enums or list initialized variables directly into the +# documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct Doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = 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 IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) +# that should be ignored while generating the index headers. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# 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). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/doxygen-awesome.css + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = "@CMAKE_CURRENT_SOURCE_DIR@/kdab-logo-22x22.png" \ + "@CMAKE_SOURCE_DIR@/images/kdsoap-small.png" \ + "@CMAKE_SOURCE_DIR@/images/kdsoap-medium.png" + +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generates light mode output, DARK always +# generates dark mode output, AUTO_LIGHT automatically sets the mode according +# to the user preference, uses light mode if no preference is set (the default), +# AUTO_DARK automatically sets the mode according to the user preference, uses +# dark mode if no preference is set and TOGGLE allows a user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = LIGHT + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use gray-scales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be +# dynamically folded and expanded in the generated HTML source code. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_CODE_FOLDING = YES + +# If the HTML_COPY_CLIPBOARD tag is set to YES then Doxygen will show an icon in +# the top right corner of code and text fragments that allows the user to copy +# its content to the clipboard. Note this only works if supported by the browser +# and the web page is served via a secure context (see: +# https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file: +# protocol. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COPY_CLIPBOARD = YES + +# Doxygen stores a couple of settings persistently in the browser (via e.g. +# cookies). By default these settings apply to all HTML pages generated by +# Doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store +# the settings under a project specific key, such that the user preferences will +# be stored separately. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_PROJECT_COOKIE = + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, Doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then Doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by Doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# Doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# The SITEMAP_URL tag is used to specify the full URL of the place where the +# generated documentation will be placed on the server by the user during the +# deployment of the documentation. The generated sitemap is called sitemap.xml +# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL +# is specified no sitemap is generated. For information about the sitemap +# protocol see https://www.sitemaps.org +# This tag requires that the tag GENERATE_HTML is set to YES. + +SITEMAP_URL = + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = @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/kdsoap-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.@KDSoap_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@-@KDSoap_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 (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty Doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = @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 (see "Fine-tuning the output"). As an +# example, the default style sheet generated by Doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATE_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# Doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# When the SHOW_ENUM_VALUES tag is set doxygen will show the specified +# enumeration values besides the enumeration mnemonics. +# The default value is: NO. + +SHOW_ENUM_VALUES = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, Doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the OBFUSCATE_EMAILS tag is set to YES, Doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, Doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of 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 + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for MathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = 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 +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with JavaScript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled Doxygen will generate a search box for +# the HTML output. The underlying search engine uses JavaScript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the JavaScript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /