diff --git a/.clang-format b/.clang-format deleted file mode 100644 index 2a60a0a3..00000000 --- a/.clang-format +++ /dev/null @@ -1,22 +0,0 @@ -BasedOnStyle: LLVM -BreakBeforeBraces: Attach - -ColumnLimit: 120 # Match GitHub UI - -UseTab: Always -TabWidth: 4 -IndentWidth: 4 -AccessModifierOffset: -4 -ContinuationIndentWidth: 4 -NamespaceIndentation: All -IndentCaseLabels: false - -PointerAlignment: Left -AlwaysBreakTemplateDeclarations: Yes -SpaceAfterTemplateKeyword: false -AllowShortCaseLabelsOnASingleLine: true -AllowShortIfStatementsOnASingleLine: WithoutElse -AllowShortBlocksOnASingleLine: Always - -FixNamespaceComments: true -ReflowComments: false diff --git a/.clang-tidy b/.clang-tidy deleted file mode 100644 index b8147418..00000000 --- a/.clang-tidy +++ /dev/null @@ -1,42 +0,0 @@ -Checks: '-*, - bugprone-*, - cert-*, - clang-analyzer-*, - clang-diagnostic-*, - -clang-diagnostic-c++17-extensions, - google-*, - -google-runtime-references, - -google-readability-braces-around-statements, - hicpp-*, - -hicpp-braces-around-statements, - -hicpp-signed-bitwise, - misc-*, - -misc-non-private-member-variables-in-classes, - llvm-*, - modernize-*, - -modernize-use-trailing-return-type, - performance-*, - portability-*, - readability-*, - -readability-magic-numbers, - -readability-braces-around-statements, - -readability-uppercase-literal-suffix, - -misc-include-cleaner' - -CheckOptions: - - key: readability-identifier-naming.TypedefCase - value: lower_case - - key: readability-identifier-naming.StructCase - value: lower_case - - key: readability-identifier-naming.ClassCase - value: lower_case - - key: readability-identifier-naming.VariableCase - value: lower_case - - key: readability-identifier-naming.ParameterCase - value: lower_case - - key: readability-identifier-naming.FunctionCase - value: lower_case - - key: readability-identifier-naming.NamespaceCase - value: lower_case - - key: readability-identifier-naming.GlobalConstantCase - value: lower_case \ No newline at end of file diff --git a/.cmake-format b/.cmake-format deleted file mode 100644 index e2a32f9b..00000000 --- a/.cmake-format +++ /dev/null @@ -1,208 +0,0 @@ -# ---------------------------------- -# Options affecting listfile parsing -# ---------------------------------- -with section("parse"): - - # Specify structure for custom cmake functions - additional_commands = { 'foo': { 'flags': ['BAR', 'BAZ'], - 'kwargs': {'DEPENDS': '*', 'HEADERS': '*', 'SOURCES': '*'}}} - -# ----------------------------- -# Options effecting formatting. -# ----------------------------- -with section("format"): - - # How wide to allow formatted cmake files - line_width = 120 - - # How many spaces to tab for indent - tab_size = 2 - - # 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 = 12 - - # If a positional argument group contains more than this many arguments, then - # force it to a vertical layout. - max_pargs_hwrap = 24 - - # 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 = False - - # 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 = 12 - - # 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 = [] - - # 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 = False - - # 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 = True - -# ---------------------------- -# 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 - # scope - global_var_pattern = '[0-9A-Z][0-9A-Z_]+' - - # regular expression pattern describing valid names for variables with global - # scope (but internal semantic) - internal_var_pattern = '_[0-9A-Z][0-9A-Z_]+' - - # regular expression pattern describing valid names for variables with local - # scope - local_var_pattern = '[0-9a-z_]+' - - # regular expression pattern describing valid names for privatedirectory - # variables - private_var_pattern = '_[0-9a-z_]+' - - # regular expression pattern describing valid names for publicdirectory - # variables - public_var_pattern = '[0-9A-Z][0-9A-Z_]+' - - # regular expression pattern describing valid names for keywords used in - # functions or macros - keyword_pattern = '[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 = 1 - max_returns = 6 - max_branches = 12 - max_arguments = 5 - max_localvars = 15 - max_statements = 50 - -# ------------------------------- -# Options effecting 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/.editorconfig b/.editorconfig deleted file mode 100644 index 33af44c9..00000000 --- a/.editorconfig +++ /dev/null @@ -1,17 +0,0 @@ -root = true - -[!*.{h,cpp}] -indent_style = space -indent_size = 2 -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -[*.{h,cpp}] -indent_style = tab -trim_trailing_whitespace = true -insert_final_newline = true - -[*.md] -trim_trailing_whitespace = false diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index bdb0cabc..00000000 --- a/.gitattributes +++ /dev/null @@ -1,17 +0,0 @@ -# Auto detect text files and perform LF normalization -* text=auto - -# Custom for Visual Studio -*.cs diff=csharp - -# Standard to msysgit -*.doc diff=astextplain -*.DOC diff=astextplain -*.docx diff=astextplain -*.DOCX diff=astextplain -*.dot diff=astextplain -*.DOT diff=astextplain -*.pdf diff=astextplain -*.PDF diff=astextplain -*.rtf diff=astextplain -*.RTF diff=astextplain diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml deleted file mode 100644 index 72a55404..00000000 --- a/.github/FUNDING.yml +++ /dev/null @@ -1,2 +0,0 @@ -github: [Thalhammer,prince-chrismc] -patreon: Thalhammer diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml deleted file mode 100644 index b0a1e483..00000000 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ /dev/null @@ -1,84 +0,0 @@ -name: Bug Report 🐛 -description: File a bug report - -labels: ["bug"] -body: - - type: markdown - attributes: - value: | - Thanks for taking the time to fill out this bug report! - validations: - required: false - - type: textarea - id: what-happened - attributes: - label: What happened? - description: Also tell us, what did you expect to happen? Feel free to include some screenshots - placeholder: Tell us what you see! - value: "A bug happened!" - validations: - required: true - - type: textarea - id: reproduce - attributes: - label: How To Reproduce? - description: Please provide a small snippet to reproduce the issue - placeholder: Some C++ code or Shell code to recreate th problem - value: | - ```c++ - #include "jwt-cpp/jwt.h" - int main() { - return 0; - } - ``` - - type: dropdown - id: version - attributes: - label: Version - description: What version of our software are you running? - options: - - 0.7.1 - - 0.7.0 - - 0.6.0 - - 0.5.2 - - Older (please let us know if the "What happened" box) - validations: - required: true - - type: dropdown - id: operating-system - attributes: - label: What OS are you seeing the problem on? - multiple: true - options: - - Windows - - Linux - - MacOS - - Other (please let us know if the "What happened" box) - validations: - required: true - - type: dropdown - id: compiler - attributes: - label: What compiler are you seeing the problem on? - multiple: true - options: - - GCC - - Clang - - MSVC - - Other (please let us know if the "What happened" box) - validations: - required: true - - type: textarea - id: logs - attributes: - label: Relevant log output - description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. - render: shell - - type: checkboxes - id: terms - attributes: - label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com) - options: - - label: I agree to follow this project's Code of Conduct - required: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml deleted file mode 100644 index 1912553f..00000000 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ /dev/null @@ -1,20 +0,0 @@ -name: Feature Request 🧪 -description: Have a great idea? Find something is missing? -labels: ["enhancement"] -body: - - type: markdown - attributes: - value: | - We'd love to hear your idea(s)! - - type: input - id: question - attributes: - label: "What would you like to see added?" - validations: - required: true - - type: textarea - id: context - attributes: - label: Additional Context - validations: - required: true diff --git a/.github/ISSUE_TEMPLATE/support-question.yml b/.github/ISSUE_TEMPLATE/support-question.yml deleted file mode 100644 index 13912c03..00000000 --- a/.github/ISSUE_TEMPLATE/support-question.yml +++ /dev/null @@ -1,20 +0,0 @@ -name: Support Question 🤹 -description: Have some questions? We can offer help. -labels: ["question"] -body: - - type: markdown - attributes: - value: | - Don't hesitate to ask any question you might have! - - type: input - id: question - attributes: - label: "What's your question?" - validations: - required: true - - type: textarea - id: context - attributes: - label: Additional Context - validations: - required: true diff --git a/.github/actions/badge/action.yml b/.github/actions/badge/action.yml deleted file mode 100644 index acac7336..00000000 --- a/.github/actions/badge/action.yml +++ /dev/null @@ -1,31 +0,0 @@ -name: Regular badging sequence -description: Publishes a badge based on the job status -inputs: - category: - description: The subfolder where to group the badges - required: true - label: - description: The label to you in the badge (this should be unique for each badge in a category) - required: true - github_token: - description: The token to use to publish the changes - required: false - default: ${{ github.token }} -runs: - using: composite - steps: - - if: job.status == 'success' - uses: ./.github/actions/badge/write - with: - category: ${{ inputs.category }} - label: ${{ inputs.label }} - - if: job.status == 'failure' - uses: ./.github/actions/badge/write - with: - category: ${{ inputs.category }} - label: ${{ inputs.label }} - message: Failing - color: red - - uses: ./.github/actions/badge/publish - with: - github_token: ${{ inputs.github_token }} diff --git a/.github/actions/badge/publish/action.yml b/.github/actions/badge/publish/action.yml deleted file mode 100644 index 5d1c2577..00000000 --- a/.github/actions/badge/publish/action.yml +++ /dev/null @@ -1,18 +0,0 @@ -name: Publish a Badges -description: Publishes all badges -inputs: - github_token: - description: The token to use to publish the changes - required: false - default: ${{ github.token }} -runs: - using: composite - steps: - - uses: peaceiris/actions-gh-pages@v3 - with: - github_token: ${{ inputs.github_token }} - publish_branch: badges - publish_dir: ./badges - keep_files: true - user_name: "github-actions[bot]" - user_email: "github-actions[bot]@users.noreply.github.com" diff --git a/.github/actions/badge/write/action.yml b/.github/actions/badge/write/action.yml deleted file mode 100644 index 1e0384c8..00000000 --- a/.github/actions/badge/write/action.yml +++ /dev/null @@ -1,24 +0,0 @@ -name: Make a Badge -description: Creates a JSON file for use with Sheilds.io. The default is a "brightgreen" "Passing" badge -inputs: - category: - description: The subfolder where to group the badges - required: true - label: - description: The label to you in the badge (this should be unqie for each badge in a category) - required: true - message: - description: The message you wish to have in the badge - required: false - default: "Passing" - color: - description: The color you wish the badge to be - required: false - default: "brightgreen" -runs: - using: composite - steps: - - run: | - mkdir -p badges/${{ inputs.category }}/${{ inputs.label }} - echo '{ "schemaVersion": 1, "label": "${{ inputs.label }}", "message": "${{ inputs.message }}", "color": "${{ inputs.color }}" }' > badges/${{ inputs.category }}/${{ inputs.label }}/shields.json - shell: bash diff --git a/.github/actions/install/boost-json/action.yml b/.github/actions/install/boost-json/action.yml deleted file mode 100644 index 28504f9f..00000000 --- a/.github/actions/install/boost-json/action.yml +++ /dev/null @@ -1,17 +0,0 @@ -name: Install Boost.JSON -description: Install Boost.JSON for building test application -inputs: - version: - description: The desired Boost.JSON version to install - required: false - default: "1.78.0" -runs: - using: composite - steps: - - run: | - cd /tmp - wget https://github.com/boostorg/json/archive/boost-${{ inputs.version }}.tar.gz - tar -zxf /tmp/boost-${{ inputs.version }}.tar.gz - cd json-boost-${{ inputs.version }} - sudo cp -vR include/boost /usr/local/include - shell: bash diff --git a/.github/actions/install/cmake/action.yml b/.github/actions/install/cmake/action.yml deleted file mode 100644 index ad8c42e7..00000000 --- a/.github/actions/install/cmake/action.yml +++ /dev/null @@ -1,39 +0,0 @@ -name: Install CMake -description: Download, Build and Cache CMake -inputs: - version: - description: The desired CMake version to install - required: true - url: - description: "The corresponding URL to download the source code from" - required: true -runs: - using: composite - steps: - - name: Cache CMake - id: cache-cmake - uses: actions/cache@v4 - with: - path: cmake-${{ inputs.version }} - key: ${{ runner.name }}-${{ runner.os }}-${{ runner.arch }}-${{ job.container.id }}-cmake-${{ inputs.version }} - - name: Build cmake - if: steps.cache-cmake.outputs.cache-hit != 'true' - run: | - wget ${{ inputs.url }} - tar -zxf cmake-${{ inputs.version }}.tar.gz - cd cmake-${{ inputs.version }} - ./bootstrap - make -j $(nproc) - shell: bash - - name: Install cmake - run: | - cd cmake-${{ inputs.version }} - # Depending if we run in on a GitHub Actions or from within a Docker image we have different permissions - if [[ $EUID > 0 ]]; then - # If we are not root then we need to sudo - sudo make install - else - # Default docker image does not have users setup so we are only root and can not sudo - make install - fi - shell: bash diff --git a/.github/actions/install/danielaparker-jsoncons/action.yml b/.github/actions/install/danielaparker-jsoncons/action.yml deleted file mode 100644 index f8f18d72..00000000 --- a/.github/actions/install/danielaparker-jsoncons/action.yml +++ /dev/null @@ -1,18 +0,0 @@ -name: Install jsoncons -description: Install jsoncons for building test application -inputs: - version: - description: The desired jsoncons version to install - required: false - default: "1.3.2" -runs: - using: composite - steps: - - run: | - cd /tmp - wget https://github.com/danielaparker/jsoncons/archive/v${{ inputs.version }}.tar.gz - tar -zxf /tmp/v${{ inputs.version }}.tar.gz - cd jsoncons-${{ inputs.version }} - cmake . - sudo cmake --install . - shell: bash diff --git a/.github/actions/install/gtest/action.yml b/.github/actions/install/gtest/action.yml deleted file mode 100644 index 11a6c5f3..00000000 --- a/.github/actions/install/gtest/action.yml +++ /dev/null @@ -1,15 +0,0 @@ -name: Install GTest -description: Install and setup GTest for linking and building test application -runs: - using: composite - steps: - - run: sudo apt-get install libgtest-dev lcov - shell: bash - - run: (cd /usr/src/gtest && sudo `which cmake` .) - shell: bash - - run: sudo make -j $(nproc) -C /usr/src/gtest - shell: bash - - run: sudo ln -s /usr/src/gtest/libgtest.a /usr/lib/libgtest.a - shell: bash - - run: sudo ln -s /usr/src/gtest/libgtest_main.a /usr/lib/libgtest_main.a - shell: bash diff --git a/.github/actions/install/kazuho-picojson/action.yml b/.github/actions/install/kazuho-picojson/action.yml deleted file mode 100644 index caf88751..00000000 --- a/.github/actions/install/kazuho-picojson/action.yml +++ /dev/null @@ -1,17 +0,0 @@ -name: Install PicoJSON -description: Install PicoJSON for building test application -inputs: - version: - description: The desired PicoJSON version to install - required: false - default: "v1.3.0" -runs: - using: composite - steps: - - run: | - cd /tmp - wget https://github.com/kazuho/picojson/archive/${{ inputs.version }}.tar.gz - tar -zxf /tmp/${{ inputs.version }}.tar.gz - cd picojson-${{ inputs.version }} - sudo cp -v picojson.h /usr/local/include/picojson - shell: bash diff --git a/.github/actions/install/libressl/action.yml b/.github/actions/install/libressl/action.yml deleted file mode 100644 index 709ad701..00000000 --- a/.github/actions/install/libressl/action.yml +++ /dev/null @@ -1,19 +0,0 @@ -name: Install LibreSSL -description: Install and setup LibreSSL for linking and building test application -inputs: - version: - description: The desired LibreSSL version to install - required: false - default: "3.3.0" -runs: - using: composite - steps: - - run: | - wget https://raw.githubusercontent.com/libressl-portable/portable/v${{ inputs.version }}/FindLibreSSL.cmake -P cmake/ - cd /tmp - wget https://ftp.openbsd.org/pub/OpenBSD/LibreSSL/libressl-${{ inputs.version }}.tar.gz - tar -zvxf /tmp/libressl-${{ inputs.version }}.tar.gz - cd libressl-${{ inputs.version }} - ./configure - sudo make -j $(nproc) install - shell: bash diff --git a/.github/actions/install/nlohmann-json/action.yml b/.github/actions/install/nlohmann-json/action.yml deleted file mode 100644 index 80124924..00000000 --- a/.github/actions/install/nlohmann-json/action.yml +++ /dev/null @@ -1,18 +0,0 @@ -name: Install nlohmann-json -description: Install nlohmann-json for building test application -inputs: - version: - description: The desired nlohmann-json version to install - required: false - default: "3.12.0" -runs: - using: composite - steps: - - run: | - cd /tmp - wget https://github.com/nlohmann/json/archive/v${{ inputs.version }}.tar.gz - tar -zxf /tmp/v${{ inputs.version }}.tar.gz - cd json-${{ inputs.version }} - cmake . - sudo cmake --install . - shell: bash diff --git a/.github/actions/install/open-source-parsers-jsoncpp/action.yml b/.github/actions/install/open-source-parsers-jsoncpp/action.yml deleted file mode 100644 index 5eed4073..00000000 --- a/.github/actions/install/open-source-parsers-jsoncpp/action.yml +++ /dev/null @@ -1,22 +0,0 @@ -name: Install open-source-parsers/jsoncpp -description: Install open-source-parsers/jsoncpp for building test application -inputs: - version: - description: The desired open-source-parsers/jsoncpp version to install - required: false - default: "1.9.6" -runs: - using: composite - steps: - - run: | - cd /tmp - wget https://github.com/open-source-parsers/jsoncpp/archive/${{ inputs.version }}.tar.gz - tar -zxf /tmp/${{ inputs.version }}.tar.gz - cd jsoncpp-${{ inputs.version }} - # https://github.com/open-source-parsers/jsoncpp/blob/69098a18b9af0c47549d9a271c054d13ca92b006/include/PreventInSourceBuilds.cmake#L8 - mkdir build - cd build - cmake .. -DJSONCPP_WITH_TESTS=OFF -DBUILD_SHARED_LIBS=OFF -DBUILD_OBJECT_LIBS=OFF - cmake --build . - sudo cmake --install . - shell: bash diff --git a/.github/actions/install/openssl/action.yml b/.github/actions/install/openssl/action.yml deleted file mode 100644 index 83c03a29..00000000 --- a/.github/actions/install/openssl/action.yml +++ /dev/null @@ -1,21 +0,0 @@ -name: Install OpenSSL -description: Install and setup OpenSSL for linking and building test application -inputs: - version: - description: The desired OpenSSL version to install - required: false - default: "openssl-3.0.0" -runs: - using: composite - steps: - - run: | - cd /tmp - wget https://github.com/openssl/openssl/archive/refs/tags/${{ inputs.version }}.tar.gz - tar -zxf /tmp/${{ inputs.version }}.tar.gz - cd openssl-${{ inputs.version }} - ./config --prefix=/tmp --libdir=lib - make -j $(nproc) - sudo make -j $(nproc) install_sw - echo "OPENSSL_ROOT_DIR=/tmp" >> "$GITHUB_ENV" - echo "OpenSSL_ROOT=/tmp" >> "$GITHUB_ENV" - shell: bash diff --git a/.github/actions/install/wolfssl/action.yml b/.github/actions/install/wolfssl/action.yml deleted file mode 100644 index bced1474..00000000 --- a/.github/actions/install/wolfssl/action.yml +++ /dev/null @@ -1,22 +0,0 @@ -name: Install wolfSSL -description: Install and setup wolfSSL for linking and building test application -inputs: - version: - description: The desired stable wolfSSL version to install - required: false - default: "v4.8.1-stable" -runs: - using: composite - steps: - - run: | - cd /tmp - wget -O wolfssl.tar.gz https://github.com/wolfSSL/wolfssl/archive/${{ inputs.version }}.tar.gz - tar -zxf /tmp/wolfssl.tar.gz - cd wolfssl-* - autoreconf -fiv - ./configure --enable-opensslall --enable-opensslextra --disable-examples --disable-crypttests --enable-harden --enable-all --enable-all-crypto - make - sudo make install - shell: bash - - run: sudo rm -rf /usr/include/openssl - shell: bash diff --git a/.github/actions/process-linting-results/action.yml b/.github/actions/process-linting-results/action.yml deleted file mode 100644 index 55d35049..00000000 --- a/.github/actions/process-linting-results/action.yml +++ /dev/null @@ -1,26 +0,0 @@ -name: Process Linting Results -description: Add a comment to a pull request with when `git diff` present and save the changes as an artifact so they can be applied manually -inputs: - linter_name: - description: The name of the tool to credit in the comment - required: true -runs: - using: "composite" - steps: - - run: git add --update - shell: bash - - id: stage - #continue-on-error: true - uses: Thalhammer/patch-generator-action@v3 - - # Unfortunately the previous action reports a failure so nothing else can run - # partially a limitation on composite actions since `continue-on-error` is not - # yet supported - - if: steps.stage.outputs.result == 'dirty' - uses: actions-ecosystem/action-create-comment@v1 - with: - github_token: ${{ github.token }} - body: | - Hello, @${{ github.actor }}! `${{ inputs.linter_name }}` had some concerns :scream: - - run: exit $(git status -uno -s | wc -l) - shell: bash diff --git a/.github/actions/render/defaults/action.yml b/.github/actions/render/defaults/action.yml deleted file mode 100644 index 4942e00d..00000000 --- a/.github/actions/render/defaults/action.yml +++ /dev/null @@ -1,67 +0,0 @@ -name: "Render `defaults.h` Template" -description: "Generate the `defaults.h` header file for a JSON library" -inputs: - traits_name: - description: "Name of the traits structure to be used. Typically in the format `author_repository` or equivilant" - required: true - library_name: - description: "Name of the JSON library." - required: true - library_url: - description: "URL to the JSON library." - required: true - disable_default_traits: - description: "Set the macro to disable the default traits" - required: false - default: "true" -outputs: - file_path: - description: "Relative path which the 'defaults.h' was written to" - value: ${{ steps.script.outputs.result }} -runs: - using: composite - steps: - - uses: actions/setup-node@v3 - with: - node-version: 14 - - run: npm install mustache - shell: bash - - uses: actions/github-script@v6 - id: script - env: - TRAITS_NAME: ${{ inputs.traits_name }} - LIBRARY_NAME: ${{ inputs.library_name }} - LIBRARY_URL: ${{ inputs.library_url }} - DISABLE_DEFAULT_TRAITS: ${{ inputs.disable_default_traits }} - with: - result-encoding: string - script: | - const mustache = require('mustache') - const path = require('path') - const fs = require('fs') - - const { TRAITS_NAME, LIBRARY_NAME, LIBRARY_URL, DISABLE_DEFAULT_TRAITS } = process.env - console.log(`Rendering ${TRAITS_NAME}!`) - - const disableDefault = DISABLE_DEFAULT_TRAITS === 'true' - - const template = fs.readFileSync(path.join('include', 'jwt-cpp', 'traits', 'defaults.h.mustache'), 'utf8') - const content = mustache.render(template, { - traits_name: TRAITS_NAME, - traits_name_upper: TRAITS_NAME.toUpperCase(), - library_name: LIBRARY_NAME, - library_url: LIBRARY_URL, - disable_default_traits: disableDefault, - }) - // https://dmitripavlutin.com/replace-all-string-occurrences-javascript/ - function replaceAll(string, search, replace) { - return string.split(search).join(replace); - } - - const outputDir = path.join('include', 'jwt-cpp', 'traits', replaceAll(TRAITS_NAME, '_', '-')) - fs.mkdirSync(outputDir, { recursive: true }) - - const filePath = path.join(outputDir, 'defaults.h') - fs.writeFileSync(filePath, content) - - return filePath diff --git a/.github/actions/render/tests/action.yml b/.github/actions/render/tests/action.yml deleted file mode 100644 index fe1f5864..00000000 --- a/.github/actions/render/tests/action.yml +++ /dev/null @@ -1,44 +0,0 @@ -name: "Render `TraitsTests.cpp` Template" -description: "Generate the `TraitsTests.cpp` header file for a JSON library" -inputs: - traits_name: - description: "Name of the traits structure to be used. Typically in the format `author_repository` or equivilant" - required: true - test_suite_name: - description: "Name of the JSON library." - required: true -runs: - using: composite - steps: - - uses: actions/setup-node@v3 - with: - node-version: 14 - - run: npm install mustache - shell: bash - - uses: actions/github-script@v6 - env: - TRAITS_NAME: ${{ inputs.traits_name }} - SUITE_NAME: ${{ inputs.test_suite_name }} - with: - script: | - const mustache = require('mustache') - const path = require('path') - const fs = require('fs') - - const { TRAITS_NAME, SUITE_NAME } = process.env - console.log(`Rendering ${TRAITS_NAME}!`) - - // https://dmitripavlutin.com/replace-all-string-occurrences-javascript/ - function replaceAll(string, search, replace) { - return string.split(search).join(replace); - } - - const template = fs.readFileSync(path.join('tests', 'traits', 'TraitsTest.cpp.mustache'), 'utf8') - const content = mustache.render(template, { - traits_name: TRAITS_NAME, - traits_dir: replaceAll(TRAITS_NAME, '_', '-'), - test_suite_name: SUITE_NAME, - }) - const outputDir = path.join('tests', 'traits') - fs.mkdirSync(outputDir, { recursive: true }) - fs.writeFileSync(path.join(outputDir, `${SUITE_NAME}.cpp`), content) diff --git a/.github/logo.svg b/.github/logo.svg deleted file mode 100644 index 63017cb0..00000000 --- a/.github/logo.svg +++ /dev/null @@ -1,16 +0,0 @@ - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/.github/security.md b/.github/security.md deleted file mode 100644 index 76800013..00000000 --- a/.github/security.md +++ /dev/null @@ -1,21 +0,0 @@ -# Reporting Security Issues - -If you believe you have found a security vulnerability in JWT-CPP, we encourage you to let us know right away. -We will investigate all legitimate reports and do our best to quickly fix the problem. - -Please refer to the section below for our responsible disclosure policy: - -## Disclosure Policy - -Please contact one or more of the maintainers using the email advertised on our GitHub profiles: - -- [@Thalhammer](https://github.com/Thalhammer) -- [@prince-chrismc](https://github.com/prince-chrismc) - -Please provide as many details as possible about version, platform, and workflow as possible. -Having steps and reproducible code is better and is always greatly appreciated. - -## Supported Version - -Typically, fixes will be immediately released as a new patch release. However, older affected versions may receive -a new patch upon request. diff --git a/.github/workflows/cmake.yml b/.github/workflows/cmake.yml deleted file mode 100644 index d7318752..00000000 --- a/.github/workflows/cmake.yml +++ /dev/null @@ -1,275 +0,0 @@ -name: CMake CI - -on: - push: - branches: [master] - pull_request: - branches: [master] - paths: - - "CMakeLists.txt" - - "cmake/**" - - "include/jwt-cpp/**" - - "tests/cmake/**" - - ".github/actions/**" - - ".github/workflows/cmake.yml" - -jobs: - default-linux: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: lukka/get-cmake@latest - - - name: setup - run: | - cmake --preset release - sudo cmake --build --preset release --target install - - - name: test - working-directory: tests/cmake - run: | - cmake . -DTEST:STRING="defaults-enabled" -DCMAKE_FIND_DEBUG_MODE=1 - cmake --build . - - default-linux-with-examples: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: lukka/get-cmake@latest - - - name: setup - run: | - mkdir build - cd build - cmake .. -DJWT_BUILD_EXAMPLES=ON - sudo cmake --install . - - - name: test - working-directory: tests/cmake - run: | - cmake . -DTEST:STRING="defaults-enabled" - cmake --build . - - default-win: - runs-on: windows-latest - steps: - - uses: actions/checkout@v4 - - uses: lukka/get-cmake@latest - - run: choco install openssl - - - name: setup - run: | - cmake -E make_directory build - cd build - cmake .. -DJWT_BUILD_EXAMPLES=OFF - cmake --install . - - - name: test - run: | - cd tests/cmake - cmake . -DTEST:STRING="defaults-enabled" -DCMAKE_FIND_DEBUG_MODE=1 - cmake --build . - - min-req: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: ./.github/actions/install/cmake - with: - version: "3.14.7" - url: "https://cmake.org/files/v3.14/cmake-3.14.7.tar.gz" - - uses: ./.github/actions/install/gtest - - - name: setup - run: | - mkdir build - cd build - cmake .. -DJWT_BUILD_EXAMPLES=ON -DJWT_BUILD_TESTS=ON - sudo make install - - - name: test - run: | - cd tests/cmake - cmake . -DTEST:STRING="defaults-enabled" - cmake --build . - - preset-support-but-not-enough: - runs-on: ubuntu-22.04 - steps: - - uses: actions/checkout@v4 - - uses: ./.github/actions/install/cmake - with: - version: "3.24.4" - url: "https://cmake.org/files/v3.24/cmake-3.24.4.tar.gz" - - uses: ./.github/actions/install/gtest - - - name: setup - run: | - mkdir build - cd build - cmake .. -DJWT_BUILD_EXAMPLES=ON -DJWT_BUILD_TESTS=ON - sudo make install - - - name: test - run: | - cd tests/cmake - cmake . -DTEST:STRING="defaults-enabled" - cmake --build . - - custom-install-linux: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: lukka/get-cmake@latest - - - name: setup - run: | - mkdir build - cd build - cmake .. -DCMAKE_INSTALL_PREFIX:STRING="/opt/jwt-cpp" -DJWT_BUILD_EXAMPLES=OFF - make install - - - name: test - run: | - cd tests/cmake - cmake . -DCMAKE_PREFIX_PATH="/opt/jwt-cpp" -DTEST:STRING="defaults-enabled" -DCMAKE_FIND_DEBUG_MODE=1 - cmake --build . - - root-hint-install-linux: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: lukka/get-cmake@latest - - - name: setup - run: | - mkdir build - cd build - cmake .. -DCMAKE_INSTALL_PREFIX:STRING="/opt/jwt-cpp" -DJWT_BUILD_EXAMPLES=OFF - make install - - - name: test - run: | - cd tests/cmake - cmake . -Djwt-cpp_ROOT="/opt/jwt-cpp" -DTEST:STRING="defaults-enabled" -DCMAKE_FIND_DEBUG_MODE=1 - cmake --build . - - custom-install-win: - runs-on: windows-latest - steps: - - uses: actions/checkout@v4 - - uses: lukka/get-cmake@latest - - run: choco install openssl - - - name: setup - run: | - cmake -E make_directory build - cd build - cmake .. -DCMAKE_INSTALL_PREFIX:STRING="C:/jwt-cpp" -DJWT_BUILD_EXAMPLES=OFF - cmake --install . - - - name: test - run: | - cd tests/cmake - cmake . -DCMAKE_PREFIX_PATH="C:/jwt-cpp" -DTEST:STRING="defaults-enabled" -DCMAKE_FIND_DEBUG_MODE=1 - cmake --build . - - no-pico: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: lukka/get-cmake@latest - - - name: setup - run: | - mkdir build - cd build - cmake .. -DJWT_DISABLE_PICOJSON=ON -DJWT_BUILD_EXAMPLES=OFF - sudo make install - - - name: test - run: | - cd tests/cmake - cmake . -DCMAKE_PREFIX_PATH=/usr/local/cmake -DTEST:STRING="picojson-is-disabled" - cmake --build . - - no-base64: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: lukka/get-cmake@latest - - - name: setup - run: | - mkdir build - cd build - cmake .. -DJWT_DISABLE_BASE64=ON -DJWT_BUILD_EXAMPLES=OFF - sudo make install - - - name: test - run: | - cd tests/cmake - cmake . -DCMAKE_PREFIX_PATH=/usr/local/cmake -DTEST:STRING="base64-is-disabled" - cmake --build . - - with-libressl: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: lukka/get-cmake@latest - - uses: ./.github/actions/install/libressl - - - name: setup - run: | - mkdir build - cd build - cmake .. -DJWT_SSL_LIBRARY:STRING="LibreSSL" -DJWT_BUILD_EXAMPLES=OFF - sudo make install - - - name: test - run: | - cd tests/cmake - cmake . -DCMAKE_PREFIX_PATH=/usr/local/cmake -DCMAKE_MODULE_PATH=../../cmake -DTEST:STRING="libressl-is-used" - cmake --build . - - with-wolfssl: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: lukka/get-cmake@latest - - uses: ./.github/actions/install/wolfssl - with: - version: ab3bbf11e9d39b52e24bf42bbc6babc16d4a669b - - - name: setup - run: | - mkdir build - cd build - cmake .. -DJWT_SSL_LIBRARY:STRING="wolfSSL" -DJWT_BUILD_EXAMPLES=OFF - sudo make install - - - name: test - run: | - cd tests/cmake - cmake . -DTEST:STRING="wolfssl-is-used" - cmake --build . - - with-hunter: # This is actually testing the integration with the package management - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: lukka/get-cmake@latest - with: - cmakeVersion: "~3.25.0" # <--= optional, use most recent 3.25.x version - - - name: setup - run: | - mkdir build - cd build - cmake .. -DJWT_BUILD_TESTS=ON -DJWT_BUILD_EXAMPLES=ON -DJWT_ENABLE_COVERAGE=OFF -DHUNTER_ENABLED=ON - make - - - name: test - run: | - cd build - ./tests/jwt-cpp-test diff --git a/.github/workflows/cross-platform.yml b/.github/workflows/cross-platform.yml deleted file mode 100644 index a4f23a35..00000000 --- a/.github/workflows/cross-platform.yml +++ /dev/null @@ -1,33 +0,0 @@ -name: Cross-Platform CI - -on: - push: - branches: [master] - pull_request: - branches: [master] -jobs: - build: - runs-on: ${{ matrix.os }} - strategy: - matrix: - os: [macos-latest, windows-latest, ubuntu-latest] - - steps: - - uses: actions/checkout@v4 - - - name: configure - run: cmake --preset examples - - - name: build - run: cmake --build --preset examples - - - name: test - run: | - cmake --build --preset examples --target rsa-create-run - cmake --build --preset examples --target rsa-verify-run - - - if: github.event_name == 'push' && always() - uses: ./.github/actions/badge - with: - category: cross-platform - label: ${{ matrix.os }} diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml deleted file mode 100644 index 11f05e42..00000000 --- a/.github/workflows/documentation.yml +++ /dev/null @@ -1,25 +0,0 @@ -name: Documentation CI - -on: - push: - branches: [master] - -jobs: - build: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: ssciwr/doxygen-install@v1 - with: - version: "1.10.0" - - run: sudo apt install graphviz - - run: | - cmake . -DJWT_BUILD_DOCS=ON - cmake --build . --target jwt-docs - - if: github.event_name == 'push' - name: deploy - uses: peaceiris/actions-gh-pages@v3 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./build/html - force_orphan: true diff --git a/.github/workflows/jwt.yml b/.github/workflows/jwt.yml deleted file mode 100644 index 46eed971..00000000 --- a/.github/workflows/jwt.yml +++ /dev/null @@ -1,95 +0,0 @@ -name: JWT CI - -on: - push: - branches: [master] - pull_request: - branches: [master] - -jobs: - coverage: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: lukka/get-cmake@latest - - uses: ./.github/actions/install/gtest - - uses: ./.github/actions/install/danielaparker-jsoncons - - uses: ./.github/actions/install/boost-json - - uses: ./.github/actions/install/open-source-parsers-jsoncpp - - - name: configure - run: cmake --preset coverage - - name: run - run: cmake --build --preset coverage - - - uses: coverallsapp/github-action@v2 - with: - github-token: ${{ secrets.GITHUB_TOKEN }} - file: build/coverage.info - format: lcov - - fuzzing: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: lukka/get-cmake@latest - - - name: configure - run: cmake --preset ci-fuzzing - - name: build - run: cmake --build --preset ci-fuzzing - - - name: run - run: | - cmake --build --preset ci-fuzzing --target jwt-cpp-fuzz-BaseEncodeFuzz-run - cmake --build --preset ci-fuzzing --target jwt-cpp-fuzz-BaseDecodeFuzz-run - cmake --build --preset ci-fuzzing --target jwt-cpp-fuzz-TokenDecodeFuzz-run - - asan: - runs-on: ubuntu-latest - strategy: - fail-fast: false - matrix: - openssl: - - { tag: "openssl-3.0.5", name: "3.0.5" } - - { tag: "OpenSSL_1_1_1q", name: "1.1.1q" } - steps: - - uses: actions/checkout@v4 - - uses: lukka/get-cmake@latest - - uses: ./.github/actions/install/gtest - - uses: ./.github/actions/install/openssl - with: - version: ${{ matrix.openssl.tag }} - - - name: configure - run: cmake --preset ci-asan - - name: build - run: cmake --build --preset ci-asan - - - name: run - run: | - cmake --build --preset ci-asan --target private-claims-run - cmake --build --preset ci-asan --target rsa-create-run - cmake --build --preset ci-asan --target rsa-verify-run - cmake --build --preset ci-asan --target jwks-verify-run - cmake --build --preset ci-asan --target jwt-cpp-test-run - - ubsan: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: lukka/get-cmake@latest - - uses: ./.github/actions/install/gtest - - - name: configure - run: cmake --preset ci-ubsan - - name: build - run: cmake --build --preset ci-ubsan -DCMAKE_CXX_STANDARD=20 - - - name: run - run: | - cmake --build --preset ci-ubsan --target private-claims-run - cmake --build --preset ci-ubsan --target rsa-create-run - cmake --build --preset ci-ubsan --target rsa-verify-run - cmake --build --preset ci-ubsan --target jwks-verify-run - cmake --build --preset ci-ubsan --target jwt-cpp-test-run diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml deleted file mode 100644 index 1e4066ad..00000000 --- a/.github/workflows/lint.yml +++ /dev/null @@ -1,126 +0,0 @@ -name: Lint CI - -on: - push: - branches: [master] - pull_request: - branches: [master] - -jobs: - clang-format: - runs-on: ubuntu-22.04 - strategy: - fail-fast: false - matrix: - files: - - "include/jwt-cpp/*.h" - - "include/jwt-cpp/traits/**/*.h" - - "tests/*.cpp" - - "tests/**/*.cpp" - - "example/*.cpp" - - "example/**/*.cpp" - steps: - - run: | - sudo apt-get install clang-format-14 - shopt -s globstar - - uses: actions/checkout@v4 - - run: clang-format-14 -i ${{ matrix.files }} - - uses: ./.github/actions/process-linting-results - with: - linter_name: clang-format - - cmake-format: - runs-on: ubuntu-latest - strategy: - fail-fast: false - matrix: - files: ["**/CMakeLists.txt", "cmake/code-coverage.cmake"] - steps: - - uses: actions/setup-python@v5 - with: - python-version: "3.x" - - run: pip install cmakelang - - run: shopt -s globstar - - uses: actions/checkout@v4 - - run: cmake-format -i ${{ matrix.files }} - - uses: ./.github/actions/process-linting-results - with: - linter_name: cmake-format - - clang-tidy: - runs-on: ubuntu-latest - steps: - - uses: lukka/get-cmake@latest - - uses: actions/checkout@v4 - - name: configure - run: cmake --preset examples -DCMAKE_CXX_CLANG_TIDY="clang-tidy;-fix" - - name: run - run: cmake --build --preset examples - - uses: ./.github/actions/process-linting-results - with: - linter_name: clang-tidy - - render-defaults: - runs-on: ubuntu-22.04 - strategy: - fail-fast: false - matrix: - traits: - - { name: "boost_json", library: "Boost.JSON", url: "https://github.com/boostorg/json", disable_pico: true } - - { name: "danielaparker_jsoncons", library: "jsoncons", url: "https://github.com/danielaparker/jsoncons", disable_pico: true } - - { name: "kazuho_picojson", library: "picojson", url: "https://github.com/kazuho/picojson", disable_pico: false } - - { name: "nlohmann_json", library: "JSON for Modern C++", url: "https://github.com/nlohmann/json", disable_pico: true } - - { name: "open_source_parsers_jsoncpp", library: "jsoncpp", url: "https://github.com/open-source-parsers/jsoncpp", disable_pico: true } - name: render-defaults (${{ matrix.traits.name }}) - steps: - - uses: actions/checkout@v4 - - run: | - sudo apt-get install clang-format-14 - - uses: ./.github/actions/render/defaults - id: render - with: - traits_name: ${{ matrix.traits.name }} - library_name: ${{ matrix.traits.library }} - library_url: ${{ matrix.traits.url }} - disable_default_traits: ${{ matrix.traits.disable_pico }} - - run: clang-format-14 -i ${{ steps.render.outputs.file_path }} - - run: git add ${{ steps.render.outputs.file_path }} - - uses: ./.github/actions/process-linting-results - with: - linter_name: render-defaults - - render-tests: - runs-on: ubuntu-22.04 - strategy: - fail-fast: false - matrix: - traits: - # - { name: "boost_json", suite: "BoostJsonTest" } # Currently needs work arounds for API limitations - - { name: "danielaparker_jsoncons", suite: "JsonconsTest" } - # - { name: "kazuho_picojson", suite: "PicoJsonTest" } # Currently the default everything tests against this! - - { name: "nlohmann_json", suite: "NlohmannTest" } - - { name: "open_source_parsers_jsoncpp", suite: "OspJsoncppTest" } - name: render-tests (${{ matrix.traits.name }}) - steps: - - uses: actions/checkout@v4 - - run: | - sudo apt-get install clang-format-14 - shopt -s globstar - - uses: ./.github/actions/render/tests - with: - traits_name: ${{ matrix.traits.name }} - test_suite_name: ${{ matrix.traits.suite }} - - run: clang-format-14 -i tests/**/*.cpp - - run: git add tests/traits/* - - uses: ./.github/actions/process-linting-results - with: - linter_name: render-tests - - line-ending: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - run: git add --renormalize . - - uses: ./.github/actions/process-linting-results - with: - linter_name: line-ending diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index fc6a18ff..00000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,44 +0,0 @@ -name: Release CD - -on: - # Allows you to run this workflow manually from the Actions tab - workflow_dispatch: - # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#release - release: - types: [published] - -jobs: - nuget: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - name: Setup NuGet - uses: NuGet/setup-nuget@v1 - with: - nuget-api-key: ${{ secrets.nuget_api_key }} - - - name: Create NuGet pkg - working-directory: ./nuget - run: nuget pack jwt-cpp.nuspec - - - name: Publish NuGet pkg - working-directory: ./nuget - run: nuget push *.nupkg -Source 'https://api.nuget.org/v3/index.json' - - release-asset: - if: github.event_name != 'workflow_dispatch' - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - - run: tar --exclude='./.git' -vczf /tmp/jwt-cpp-${{ github.event.release.tag_name }}.tar.gz . - - uses: shogo82148/actions-upload-release-asset@v1 - with: - upload_url: ${{ github.event.release.upload_url }} - asset_path: /tmp/jwt-cpp-${{ github.event.release.tag_name }}.tar.gz - - - run: zip -x './.git/*' -r /tmp/jwt-cpp-${{ github.event.release.tag_name }}.zip . - - uses: shogo82148/actions-upload-release-asset@v1 - with: - upload_url: ${{ github.event.release.upload_url }} - asset_path: /tmp/jwt-cpp-${{ github.event.release.tag_name }}.zip diff --git a/.github/workflows/ssl.yml b/.github/workflows/ssl.yml deleted file mode 100644 index 4942653c..00000000 --- a/.github/workflows/ssl.yml +++ /dev/null @@ -1,113 +0,0 @@ -name: SSL Compatibility CI - -on: - push: - branches: [master] - pull_request: - branches: [master] - -jobs: - openssl: - runs-on: ubuntu-latest - strategy: - matrix: - openssl: - - { tag: "openssl-3.0.5", name: "3.0.5" } - - { tag: "OpenSSL_1_1_1q", name: "1.1.1q" } - - { tag: "OpenSSL_1_1_0i", name: "1.1.0i" } # Do not bump, there's a broken in the autoconfig script and it's not maintained - - { tag: "OpenSSL_1_0_2u", name: "1.0.2u" } - - { tag: "OpenSSL_1_0_1u", name: "1.0.1u" } - name: OpenSSL ${{ matrix.openssl.name }} - steps: - - uses: actions/checkout@v4 - - uses: lukka/get-cmake@latest - - uses: ./.github/actions/install/gtest - - uses: ./.github/actions/install/openssl - with: - version: ${{ matrix.openssl.tag }} - - - name: configure - run: cmake --preset unit-tests -DOPENSSL_ROOT_DIR=/tmp - - run: cmake --build --preset unit-tests - - name: test - run: ctest --preset unit-tests --output-on-failure - - - if: github.event_name == 'push' && always() - uses: ./.github/actions/badge - with: - category: openssl - label: ${{ matrix.openssl.name }} - - openssl-no-deprecated: - runs-on: ubuntu-latest - name: OpenSSL 3.0 No Deprecated - steps: - - uses: actions/checkout@v4 - - uses: lukka/get-cmake@latest - - uses: ./.github/actions/install/gtest - - uses: ./.github/actions/install/openssl - with: - version: "openssl-3.0.5" - - - name: configure - run: cmake --preset unit-tests -DOPENSSL_ROOT_DIR=/tmp -DCMAKE_CXX_FLAGS="-DOPENSSL_NO_DEPRECATED=1" -DCMAKE_C_FLAGS="-DOPENSSL_NO_DEPRECATED=1" - - run: cmake --build --preset unit-tests - - name: test - run: ctest --preset unit-tests - - libressl: - runs-on: ubuntu-latest - strategy: - fail-fast: false - matrix: - libressl: ["3.5.3", "3.4.3", "3.3.6"] - name: LibreSSL ${{ matrix.libressl }} - steps: - - uses: actions/checkout@v4 - - uses: lukka/get-cmake@latest - - uses: ./.github/actions/install/gtest - - uses: ./.github/actions/install/libressl - with: - version: ${{ matrix.libressl }} - - - name: configure - run: cmake --preset unit-tests -DJWT_SSL_LIBRARY:STRING=LibreSSL - - run: cmake --build --preset unit-tests - - name: test - run: ctest --preset unit-tests - - - if: github.event_name == 'push' && always() - uses: ./.github/actions/badge - with: - category: libressl - label: ${{ matrix.libressl }} - - wolfssl: - runs-on: ubuntu-latest - strategy: - matrix: - wolfssl: - - { ref: "v5.1.1-stable", name: "5.1.1"} - - { ref: "v5.2.0-stable", name: "5.2.0" } - - { ref: "v5.3.0-stable", name: "5.3.0"} - - { ref: "v5.7.0-stable", name: "5.7.0"} - name: wolfSSL ${{ matrix.wolfssl.name }} - steps: - - uses: actions/checkout@v4 - - uses: lukka/get-cmake@latest - - uses: ./.github/actions/install/gtest - - uses: ./.github/actions/install/wolfssl - with: - version: ${{ matrix.wolfssl.ref }} - - - name: configure - run: cmake --preset unit-tests -DJWT_SSL_LIBRARY:STRING=wolfSSL - - run: cmake --build --preset unit-tests - - name: test - run: ctest --preset unit-tests - - - if: github.event_name == 'push' && always() - uses: ./.github/actions/badge - with: - category: wolfssl - label: ${{ matrix.wolfssl.name }} diff --git a/.github/workflows/targets.yml b/.github/workflows/targets.yml deleted file mode 100644 index c58ab7ca..00000000 --- a/.github/workflows/targets.yml +++ /dev/null @@ -1,79 +0,0 @@ -name: Specific Targets CI - -on: - push: - branches: [master] - pull_request: - branches: [master] - paths: - - "CMakeLists.txt" - - "cmake/**" - - "include/jwt-cpp/**" - - "tests/cmake/**" - - ".github/actions/**" - - ".github/workflows/targets.yml" - -jobs: - gcc-4-8: - if: false # There's no existing image with node20 and gcc4.8 https://github.com/actions/checkout/issues/1809 - name: GCC 4.8 - runs-on: ubuntu-latest - container: - image: ubuntu:bionic-20230530 # 18.04 - env: - CC: /usr/bin/gcc-4.8 - CXX: /usr/bin/g++-4.8 - steps: - - run: | - apt-get update - apt-get install -y g++-4.8 wget make libssl-dev - - uses: actions/checkout@v3 # Can not be upgrade as v4 needs NodeJS 20 doesn't exist next to gcc-4.8 - - uses: ./.github/actions/install/cmake - with: - version: "3.26.3" - url: "https://cmake.org/files/v3.26/cmake-3.26.3.tar.gz" - - - name: setup - run: | - mkdir build - cd build - cmake .. - cmake --build . - cmake --install . - - name: test - working-directory: tests/cmake - run: | - CC=gcc-4.8 CXX=g++-4.8 cmake . -DTEST:STRING="defaults-enabled" - cmake --build . - - gcc-12: - name: GCC 12 - runs-on: ubuntu-latest - container: - image: ubuntu:jammy-20231004 # 22.04 - env: - CC: /usr/bin/gcc-12 - CXX: /usr/bin/g++-12 - steps: - - run: | - apt-get update - apt-get install -y g++-12 wget make libssl-dev - - uses: actions/checkout@v4 - - uses: ./.github/actions/install/cmake - with: - version: "3.26.3" - url: "https://cmake.org/files/v3.26/cmake-3.26.3.tar.gz" - - - name: setup - run: | - mkdir build - cd build - cmake .. - cmake --build . - cmake --install . - - - name: test - working-directory: tests/cmake - run: | - CC=gcc-12 CXX=g++-12 cmake . -DCMAKE_CXX_STANDARD=20 -DTEST:STRING="defaults-enabled" - cmake --build . diff --git a/.github/workflows/traits.yml b/.github/workflows/traits.yml deleted file mode 100644 index aedcb14a..00000000 --- a/.github/workflows/traits.yml +++ /dev/null @@ -1,85 +0,0 @@ -name: Traits CI - -on: - push: - branches: [master] - pull_request: - branches: [master] - -jobs: - traits: - name: Traits (${{ matrix.target.name }}) - runs-on: ubuntu-latest - strategy: - matrix: - target: - - { name: "danielaparker-jsoncons", tag: "1.3.2", version: "v1.3.2" } - - { name: "boost-json", tag: "1.78.0", version: "v1.80.0" } - - { name: "nlohmann-json", tag: "3.12.0", version: "v3.12.0" } - - { name: "kazuho-picojson", tag: "111c9be5188f7350c2eac9ddaedd8cca3d7bf394", version: "111c9be" } - - { name: "open-source-parsers-jsoncpp", tag: "1.9.6", version: "v1.9.6" } - steps: - - uses: actions/checkout@v4 - - uses: lukka/get-cmake@latest - - name: setup - run: | - mkdir build - cd build - cmake .. -DJWT_BUILD_EXAMPLES=OFF - sudo cmake --install . - - # Install the JSON library - - if: matrix.target.name == 'danielaparker-jsoncons' - uses: ./.github/actions/install/danielaparker-jsoncons - with: - version: ${{matrix.target.tag}} - - - if: matrix.target.name == 'boost-json' - uses: ./.github/actions/install/boost-json - with: - version: ${{matrix.target.tag}} - - - if: matrix.target.name == 'nlohmann-json' - uses: ./.github/actions/install/nlohmann-json - with: - version: ${{matrix.target.tag}} - - - if: matrix.target.name == 'kazuho-picojson' - run: rm -rf include/picojson - - if: matrix.target.name == 'kazuho-picojson' - uses: ./.github/actions/install/kazuho-picojson - with: - version: ${{matrix.target.tag}} - - - if: matrix.target.name == 'open-source-parsers-jsoncpp' - uses: ./.github/actions/install/open-source-parsers-jsoncpp - with: - version: ${{matrix.target.tag}} - - - name: test - working-directory: example/traits - run: | - cmake . -DCMAKE_FIND_DEBUG_MODE=1 - cmake --build . --target ${{ matrix.target.name }} - ./${{ matrix.target.name }} - - - name: badge success - if: github.event_name == 'push' && success() - uses: ./.github/actions/badge/write - with: - category: traits - label: ${{ matrix.target.name }} - message: ${{ matrix.target.version }} - color: lightblue # turquoise - - name: badge failure - if: github.event_name == 'push' && !success() - uses: ./.github/actions/badge/write - with: - category: traits - label: ${{ matrix.target.name }} - message: ${{ matrix.target.version }} - color: orange - - if: github.event_name == 'push' && always() - uses: ./.github/actions/badge/publish - with: - github_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitignore b/.gitignore deleted file mode 100644 index a594c29b..00000000 --- a/.gitignore +++ /dev/null @@ -1,320 +0,0 @@ -## Ignore Visual Studio temporary files, build results, and -## files generated by popular Visual Studio add-ons. - -# User-specific files -*.suo -*.user -*.userosscache -*.sln.docstates - -# User-specific files (MonoDevelop/Xamarin Studio) -*.userprefs - -# Build results -[Dd]ebug/ -[Dd]ebugPublic/ -[Rr]elease/ -[Rr]eleases/ -x64/ -x86/ -bld/ -[Bb]in/ -[Oo]bj/ -[Ll]og/ - -# Visual Studio 2015 cache/options directory -.vs/ -# Uncomment if you have tasks that create the project's static files in wwwroot -#wwwroot/ - -# MSTest test Results -[Tt]est[Rr]esult*/ -[Bb]uild[Ll]og.* - -# NUNIT -*.VisualState.xml -TestResult.xml - -# Build Results of an ATL Project -[Dd]ebugPS/ -[Rr]eleasePS/ -dlldata.c - -# DNX -project.lock.json -artifacts/ - -*_i.c -*_p.c -*_i.h -*.ilk -*.meta -*.obj -*.pch -*.pdb -*.pgc -*.pgd -*.rsp -*.sbr -*.tlb -*.tli -*.tlh -*.tmp -*.tmp_proj -*.log -*.vspscc -*.vssscc -.builds -*.pidb -*.svclog -*.scc - -# Chutzpah Test files -_Chutzpah* - -# Visual C++ cache files -ipch/ -*.aps -*.ncb -*.opendb -*.opensdf -*.sdf -*.cachefile -*.VC.db -*.VC.VC.opendb - -# Visual Studio profiler -*.psess -*.vsp -*.vspx -*.sap - -# TFS 2012 Local Workspace -$tf/ - -# Guidance Automation Toolkit -*.gpState - -# ReSharper is a .NET coding add-in -_ReSharper*/ -*.[Rr]e[Ss]harper -*.DotSettings.user - -# JustCode is a .NET coding add-in -.JustCode - -# TeamCity is a build add-in -_TeamCity* - -# DotCover is a Code Coverage Tool -*.dotCover - -# NCrunch -_NCrunch_* -.*crunch*.local.xml -nCrunchTemp_* - -# MightyMoose -*.mm.* -AutoTest.Net/ - -# Web workbench (sass) -.sass-cache/ - -# Installshield output folder -[Ee]xpress/ - -# DocProject is a documentation generator add-in -DocProject/buildhelp/ -DocProject/Help/*.HxT -DocProject/Help/*.HxC -DocProject/Help/*.hhc -DocProject/Help/*.hhk -DocProject/Help/*.hhp -DocProject/Help/Html2 -DocProject/Help/html - -# Click-Once directory -publish/ - -# Publish Web Output -*.[Pp]ublish.xml -*.azurePubxml -# TODO: Comment the next line if you want to checkin your web deploy settings -# but database connection strings (with potential passwords) will be unencrypted -*.pubxml -*.publishproj - -# Microsoft Azure Web App publish settings. Comment the next line if you want to -# checkin your Azure Web App publish settings, but sensitive information contained -# in these scripts will be unencrypted -PublishScripts/ - -# NuGet Packages -*.nupkg -# The packages folder can be ignored because of Package Restore -**/packages/* -# except build/, which is used as an MSBuild target. -!**/packages/build/ -# Uncomment if necessary however generally it will be regenerated when needed -#!**/packages/repositories.config -# NuGet v3's project.json files produces more ignoreable files -*.nuget.props -*.nuget.targets - -# Microsoft Azure Build Output -csx/ -*.build.csdef - -# Microsoft Azure Emulator -ecf/ -rcf/ - -# Windows Store app package directories and files -AppPackages/ -BundleArtifacts/ -Package.StoreAssociation.xml -_pkginfo.txt - -# Visual Studio cache files -# files ending in .cache can be ignored -*.[Cc]ache -# but keep track of directories ending in .cache -!*.[Cc]ache/ - -# Others -ClientBin/ -~$* -*~ -*.dbmdl -*.dbproj.schemaview -*.pfx -*.publishsettings -node_modules/ -orleans.codegen.cs - -# Since there are multiple workflows, uncomment next line to ignore bower_components -# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) -#bower_components/ - -# RIA/Silverlight projects -Generated_Code/ - -# Backup & report files from converting an old project file -# to a newer Visual Studio version. Backup files are not needed, -# because we have git ;-) -_UpgradeReport_Files/ -Backup*/ -UpgradeLog*.XML -UpgradeLog*.htm - -# SQL Server files -*.mdf -*.ldf - -# Business Intelligence projects -*.rdl.data -*.bim.layout -*.bim_*.settings - -# Microsoft Fakes -FakesAssemblies/ - -# GhostDoc plugin setting file -*.GhostDoc.xml - -# Node.js Tools for Visual Studio -.ntvs_analysis.dat - -# Visual Studio 6 build log -*.plg - -# Visual Studio 6 workspace options file -*.opt - -# Visual Studio LightSwitch build output -**/*.HTMLClient/GeneratedArtifacts -**/*.DesktopClient/GeneratedArtifacts -**/*.DesktopClient/ModelManifest.xml -**/*.Server/GeneratedArtifacts -**/*.Server/ModelManifest.xml -_Pvt_Extensions - -# Paket dependency manager -.paket/paket.exe -paket-files/ - -# FAKE - F# Make -.fake/ - -# JetBrains Rider -.idea/ -*.sln.iml - -# ========================= -# Operating System Files -# ========================= - -# OSX -# ========================= - -.DS_Store -.AppleDouble -.LSOverride - -# Thumbnails -._* - -# Files that might appear in the root of a volume -.DocumentRevisions-V100 -.fseventsd -.Spotlight-V100 -.TemporaryItems -.Trashes -.VolumeIcon.icns - -# Directories potentially created on remote AFP share -.AppleDB -.AppleDesktop -Network Trash Folder -Temporary Items -.apdisk - -# Windows -# ========================= - -# Windows image file caches -Thumbs.db -ehthumbs.db - -# Folder config file -Desktop.ini - -# Recycle Bin used on file shares -$RECYCLE.BIN/ - -# Windows Installer files -*.cab -*.msi -*.msm -*.msp - -# Windows shortcuts -*.lnk - -# Linux files -test -*.o -*.o.d - -# IDE-specific files -.vscode/ -.vscode/!extensions.json # Allow to provide recommended extensions - -# ClangD cache files -.cache - -build/* -package-lock.json - -CMakeUserPresets.json diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/.vscode/extensions.json b/.vscode/extensions.json deleted file mode 100644 index 59e6f7d8..00000000 --- a/.vscode/extensions.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "recommendations": [ - "ms-vscode.cpptools", - "ms-vscode.cpptools-extension-pack", - "ms-vscode.cmake-tools", - "twxs.cmake", - "matepek.vscode-catch2-test-adapter", - "GitHub.vscode-github-actions" - ] -} diff --git a/CMakeLists.txt b/CMakeLists.txt deleted file mode 100644 index c2231881..00000000 --- a/CMakeLists.txt +++ /dev/null @@ -1,174 +0,0 @@ -cmake_minimum_required(VERSION 3.14) -cmake_policy(VERSION 3.14) -if(POLICY CMP0135) # DOWNLOAD_EXTRACT_TIMESTAMP - cmake_policy(SET CMP0135 NEW) -endif() - -# HUNTER_ENABLED is always set if this package is included in a project using hunter (HunterGate sets it) In this case -# we will use hunter as well to stay consistent. If not the use can supply it on configure to force using hunter. -if(HUNTER_ENABLED) - include("cmake/HunterGate.cmake") - huntergate(URL "https://github.com/cpp-pm/hunter/archive/v0.23.314.tar.gz" SHA1 - "95c47c92f68edb091b5d6d18924baabe02a6962a") - message(STATUS "jwt-cpp: using hunter for dependency resolution") -endif() - -project(jwt-cpp LANGUAGES CXX) - -option(JWT_BUILD_EXAMPLES "Configure CMake to build examples (or not)" ON) -option(JWT_BUILD_TESTS "Configure CMake to build tests (or not)" OFF) -option(JWT_BUILD_DOCS "Adds a target for building the doxygen documentation" OFF) -option(JWT_ENABLE_COVERAGE "Enable code coverage testing" OFF) -option(JWT_ENABLE_FUZZING "Enable fuzz testing" OFF) - -option(JWT_DISABLE_PICOJSON "Do not provide the picojson template specialiaze" OFF) -option(JWT_DISABLE_BASE64 "Do not include the base64 implementation from this library" OFF) -include(CMakeDependentOption) -cmake_dependent_option(JWT_EXTERNAL_PICOJSON - "Use find_package() to locate picojson, provided to integrate with package managers" OFF - "NOT JWT_DISABLE_PICOJSON" OFF) -cmake_dependent_option(JWT_EXTERNAL_NLOHMANN_JSON - "Use find_package() to locate nlohman-json required for tests and examples" OFF - "JWT_BUILD_EXAMPLES OR JWT_BUILD_TESTS" OFF) - -set(JWT_SSL_LIBRARY_OPTIONS OpenSSL LibreSSL wolfSSL) -set(JWT_SSL_LIBRARY OpenSSL CACHE STRING "Determines which SSL library to build with") -set_property(CACHE JWT_SSL_LIBRARY PROPERTY STRINGS ${JWT_SSL_LIBRARY_OPTIONS}) - -set(JWT_JSON_TRAITS_OPTIONS boost-json danielaparker-jsoncons kazuho-picojson nlohmann-json open-source-parsers-jsoncpp) - -list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake") - -if(NOT JWT_SSL_LIBRARY IN_LIST JWT_SSL_LIBRARY_OPTIONS) - message(FATAL_ERROR "JWT_SSL_LIBRARY must be one of ${JWT_SSL_LIBRARY_OPTIONS}") -endif() - -# If Hunter is enabled, we configure it to resolve OpenSSL and warn the user if he selected an option not supported by -# hunter. We fall back to the system library in this case. -if(HUNTER_ENABLED) - if(${JWT_SSL_LIBRARY} MATCHES "OpenSSL") - hunter_add_package(OpenSSL) - elseif(${JWT_SSL_LIBRARY} MATCHES "LibreSSL") - message(WARNING "Hunter does not support LibreSSL yet, the system library will be used (if available)") - elseif(${JWT_SSL_LIBRARY} MATCHES "wolfSSL") - message(WARNING "Hunter does not support wolfSSL yet, the system library will be used (if available)") - endif() - if(JWT_EXTERNAL_PICOJSON) - message(WARNING "Hunter does not support picojson yet, the system library will be used (if available)") - endif() -endif() - -# Lookup dependencies -if(${JWT_SSL_LIBRARY} MATCHES "OpenSSL") - find_package(OpenSSL 1.0.1 REQUIRED) -elseif(${JWT_SSL_LIBRARY} MATCHES "LibreSSL") - find_package(LibreSSL 3.0.0 REQUIRED) -elseif(${JWT_SSL_LIBRARY} MATCHES "wolfSSL") - find_package(PkgConfig REQUIRED) - pkg_check_modules(wolfssl REQUIRED IMPORTED_TARGET wolfssl) - list(TRANSFORM wolfssl_INCLUDE_DIRS APPEND "/wolfssl") # This is required to access OpenSSL compatibility API -endif() - -if(NOT JWT_DISABLE_PICOJSON AND JWT_EXTERNAL_PICOJSON) - find_package(picojson 1.3.0 REQUIRED) -endif() - -if(JWT_BUILD_EXAMPLES OR JWT_BUILD_TESTS) - if(JWT_EXTERNAL_NLOHMANN_JSON) - message(STATUS "jwt-cpp: using find_package for nlohmann-json required for tests") - find_package(nlohmann_json CONFIG REQUIRED) - else() - message(STATUS "jwt-cpp: using FetchContent for nlohmann-json required for tests") - include(FetchContent) - fetchcontent_declare(nlohmann_json - URL https://github.com/nlohmann/json/releases/download/v3.12.0/json.tar.xz - URL_MD5 e155202b2a589137f6804724bd182f12) - fetchcontent_makeavailable(nlohmann_json) - endif() -endif() - -set(JWT_INCLUDE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/include) -set(JWT_HEADER_FILES ${JWT_INCLUDE_PATH}/jwt-cpp/jwt.h) -foreach(traits ${JWT_JSON_TRAITS_OPTIONS}) - list(APPEND JWT_HEADER_FILES ${JWT_INCLUDE_PATH}/jwt-cpp/traits/${traits}/defaults.h - ${JWT_INCLUDE_PATH}/jwt-cpp/traits/${traits}/traits.h) -endforeach() - -if(NOT JWT_DISABLE_BASE64) - list(APPEND JWT_HEADER_FILES ${JWT_INCLUDE_PATH}/jwt-cpp/base.h) -endif() - -add_library(jwt-cpp INTERFACE) -add_library(jwt-cpp::jwt-cpp ALIAS jwt-cpp) # To match export -target_compile_features(jwt-cpp INTERFACE cxx_std_11) -if(JWT_DISABLE_BASE64) - target_compile_definitions(jwt-cpp INTERFACE JWT_DISABLE_BASE64) -endif() -if(JWT_DISABLE_PICOJSON) - target_compile_definitions(jwt-cpp INTERFACE JWT_DISABLE_PICOJSON) -endif() - -include(GNUInstallDirs) -include(CMakePackageConfigHelpers) -target_include_directories(jwt-cpp INTERFACE $ - $) - -if(${JWT_SSL_LIBRARY} MATCHES "OpenSSL") - target_link_libraries(jwt-cpp INTERFACE OpenSSL::SSL OpenSSL::Crypto) -endif() - -if(${JWT_SSL_LIBRARY} MATCHES "LibreSSL") - target_link_libraries(jwt-cpp INTERFACE LibreSSL::TLS) -endif() - -if(${JWT_SSL_LIBRARY} MATCHES "wolfSSL") - target_link_libraries(jwt-cpp INTERFACE PkgConfig::wolfssl) - # This is required to access OpenSSL compatibility API - target_include_directories(jwt-cpp INTERFACE ${wolfssl_INCLUDE_DIRS}) - # This flag is required to have the mandatory header included automatically - # https://github.com/Thalhammer/jwt-cpp/pull/352#discussion_r1627971786 - # https://github.com/wolfSSL/wolfssl/blob/3b74a6402998a8b8839e25e31ba8ac74749aa9b0/wolfssl/wolfcrypt/settings.h#L58 - target_compile_definitions(jwt-cpp INTERFACE EXTERNAL_OPTS_OPENVPN) -endif() - -if(NOT JWT_DISABLE_PICOJSON AND JWT_EXTERNAL_PICOJSON) - target_link_libraries(jwt-cpp INTERFACE picojson::picojson) -endif() - -# Hunter needs relative paths so the files are placed correctly -if(NOT JWT_CMAKE_FILES_INSTALL_DIR) - set(JWT_CMAKE_FILES_INSTALL_DIR cmake) -endif() - -configure_package_config_file( - ${CMAKE_CURRENT_LIST_DIR}/cmake/jwt-cpp-config.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/jwt-cpp-config.cmake - INSTALL_DESTINATION ${JWT_CMAKE_FILES_INSTALL_DIR}) -write_basic_package_version_file(${CMAKE_CURRENT_BINARY_DIR}/jwt-cpp-config-version.cmake VERSION 0.7.1 - COMPATIBILITY ExactVersion) - -install(TARGETS jwt-cpp EXPORT jwt-cpp-targets PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) -install(EXPORT jwt-cpp-targets NAMESPACE jwt-cpp:: FILE jwt-cpp-targets.cmake - DESTINATION ${JWT_CMAKE_FILES_INSTALL_DIR}) -install(DIRECTORY ${JWT_INCLUDE_PATH}/jwt-cpp DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) -if(NOT JWT_EXTERNAL_PICOJSON AND NOT JWT_DISABLE_PICOJSON) - install(FILES ${JWT_INCLUDE_PATH}/picojson/picojson.h DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/picojson) -endif() -install(FILES ${CMAKE_CURRENT_BINARY_DIR}/jwt-cpp-config.cmake ${CMAKE_CURRENT_BINARY_DIR}/jwt-cpp-config-version.cmake - DESTINATION ${JWT_CMAKE_FILES_INSTALL_DIR}) - -if(JWT_BUILD_EXAMPLES) - add_subdirectory(example) -endif() - -if(JWT_BUILD_TESTS) - enable_testing() - add_subdirectory(tests) -endif() - -if(JWT_ENABLE_FUZZING) - add_subdirectory(tests/fuzz) -endif() - -if(JWT_BUILD_DOCS) - add_subdirectory(docs) -endif() diff --git a/CMakePresets.json b/CMakePresets.json deleted file mode 100644 index 03dc9225..00000000 --- a/CMakePresets.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "version": 6, - "cmakeMinimumRequired": { - "major": 3, - "minor": 25, - "patch": 0 - }, - "include": [ - "example/CMakePresets.json", - "tests/CMakePresets.json" - ], - "configurePresets": [ - { - "name": "dev", - "displayName": "Development", - "inherits": "debug", - "environment": { - "CMAKE_EXPORT_COMPILE_COMMANDS": "ON" - }, - "cacheVariables": { - "JWT_BUILD_EXAMPLES": "ON", - "JWT_BUILD_TESTS": "ON" - } - } - ], - "buildPresets": [ - { - "name": "dev", - "configurePreset": "dev", - "configuration": "Debug" - } - ] -} \ No newline at end of file diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 7d583cec..00000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2018 Dominik Thalhammer - -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/README.md b/README.md deleted file mode 100644 index 6412ada0..00000000 --- a/README.md +++ /dev/null @@ -1,149 +0,0 @@ -logo - -[![License Badge](https://img.shields.io/github/license/Thalhammer/jwt-cpp)](https://github.com/Thalhammer/jwt-cpp/blob/master/LICENSE) -[![Codacy Badge](https://api.codacy.com/project/badge/Grade/5f7055e294744901991fd0a1620b231d)](https://app.codacy.com/gh/Thalhammer/jwt-cpp/dashboard) -[![Linux Badge][Linux]][Cross-Platform] -[![MacOS Badge][MacOS]][Cross-Platform] -[![Windows Badge][Windows]][Cross-Platform] -[![Coverage Status](https://coveralls.io/repos/github/Thalhammer/jwt-cpp/badge.svg?branch=master)](https://coveralls.io/github/Thalhammer/jwt-cpp?branch=master) - -[![Documentation Badge](https://img.shields.io/badge/Documentation-master-blue)](https://thalhammer.github.io/jwt-cpp/) - -[![Stars Badge](https://img.shields.io/github/stars/Thalhammer/jwt-cpp?style=flat)](https://github.com/Thalhammer/jwt-cpp/stargazers) -[![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/Thalhammer/jwt-cpp?include_prereleases)](https://github.com/Thalhammer/jwt-cpp/releases) -[![ConanCenter package](https://repology.org/badge/version-for-repo/conancenter/jwt-cpp.svg)](https://repology.org/project/jwt-cpp/versions) -[![Vcpkg package](https://repology.org/badge/version-for-repo/vcpkg/jwt-cpp.svg)](https://repology.org/project/jwt-cpp/versions) - -[Linux]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Thalhammer/jwt-cpp/badges/cross-platform/ubuntu-latest/shields.json -[MacOS]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Thalhammer/jwt-cpp/badges/cross-platform/macos-latest/shields.json -[Windows]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Thalhammer/jwt-cpp/badges/cross-platform/windows-latest/shields.json -[Cross-Platform]: https://github.com/Thalhammer/jwt-cpp/actions?query=workflow%3A%22Cross-Platform+CI%22 - -## Overview - -A header only library for creating and validating [JSON Web Tokens](https://tools.ietf.org/html/rfc7519) in C++11. For a great introduction, [read this](https://jwt.io/introduction/). - -The objective is to deliver a versatile and universally applicable collection of algorithms, classes, and data structures, fostering adaptability and seamless integration with other libraries that you may already be employing. - -## Signature algorithms - -jwt-cpp comprehensively supports all algorithms specified in the standard. Its modular design facilitates the seamless [inclusion of additional algorithms](docs/signing.md#custom-signature-algorithms) without encountering any complications. Should you wish to contribute new algorithms, feel free to initiate a pull request or [open an issue](https://github.com/Thalhammer/jwt-cpp/issues/new). - -For completeness, here is a list of all supported algorithms: - -| HMSC | RSA | ECDSA | PSS | EdDSA | -| ----- | ----- | ------ | ----- | ------- | -| HS256 | RS256 | ES256 | PS256 | Ed25519 | -| HS384 | RS384 | ES384 | PS384 | Ed448 | -| HS512 | RS512 | ES512 | PS512 | | -| | | ES256K | | | - -## Getting Started - -Installation instructions can be found [here](docs/install.md). - -A simple example is decoding a token and printing all of its [claims](https://tools.ietf.org/html/rfc7519#section-4) let's ([try it out](https://jwt.io/#debugger-io?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXUyJ9.eyJpc3MiOiJhdXRoMCIsInNhbXBsZSI6InRlc3QifQ.lQm3N2bVlqt2-1L-FsOjtR6uE-L4E9zJutMWKIe1v1M)): - -```cpp -#include -#include - -int main() { - std::string const token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXUyJ9.eyJpc3MiOiJhdXRoMCIsInNhbXBsZSI6InRlc3QifQ.lQm3N2bVlqt2-1L-FsOjtR6uE-L4E9zJutMWKIe1v1M"; - auto decoded = jwt::decode(token); - - for(auto& e : decoded.get_payload_json()) - std::cout << e.first << " = " << e.second << '\n'; -} -``` - -You can build and run [this example](example/print-claims.cpp) locally after cloning the repository. -Running some commands, we can see the contents of the [JWT payload](https://datatracker.ietf.org/doc/html/rfc7519#section-3) - -```sh -cmake . -cmake --build . --target print-claims -./print-claims -# iss = "auth0" -# sample = "test" -``` - -You'll very quickly notice JWT are not encrypted but rather cryptographically signed to -provide [non-repudiation](https://csrc.nist.gov/glossary/term/non_repudiation). - -In order to verify a token you first build a verifier and use it to verify a decoded token. - -```cpp -auto verifier = jwt::verify() - .with_issuer("auth0") - .with_claim("sample", jwt::claim(std::string("test"))) - .allow_algorithm(jwt::algorithm::hs256{"secret"}); - -verifier.verify(decoded_token); -``` - -The verifier is stateless so you can reuse it for different tokens. - -Creating the token above (and signing it) is equally as easy. - -```cpp -auto token = jwt::create() - .set_type("JWS") - .set_issuer("auth0") - .set_payload_claim("sample", jwt::claim(std::string("test"))) - .sign(jwt::algorithm::hs256{"secret"}); -``` - -If you are looking to issue or verify more unique tokens, checkout out the [examples](https://github.com/Thalhammer/jwt-cpp/tree/master/example) working with RSA public and private keys, elliptic curve tokens, and much more! - -### Configuration Options - -Building on the goal of providing flexibility. - -#### SSL Compatibility - -jwt-cpp supports [OpenSSL](https://github.com/openssl/openssl), [LibreSSL](https://github.com/libressl-portable/portable), and [wolfSSL](https://github.com/wolfSSL/wolfssl). For a listed of tested versions, check [this page](docs/ssl.md) for more details. - -#### JSON Implementation - -There is no strict reliance on a specific JSON library in this context. Instead, the jwt-cpp utilizes a generic `jwt::basic_claim` that is templated based on type trait. This trait provides the semantic [JSON types](https://json-schema.org/understanding-json-schema/reference/type.html) for values, objects, arrays, strings, numbers, integers, and booleans, along with methods to seamlessly translate between them. - -This design offers flexibility in choosing the JSON library that best suits your needs. To leverage one of the provided JSON traits, refer to [docs/traits.md](docs/traits.md#selecting-a-json-library) for detailed guidance. - -##### Providing your own JSON Traits - -```cpp -jwt::basic_claim claim(json::object({{"json", true},{"example", 0}})); -``` - -To learn how to writes a trait's implementation, checkout the [these instructions](docs/traits.md#providing-your-own-json-traits) - -#### Base64 Options - -With regard to the base64 specifications for JWTs, this library includes `base.h` encompassing all necessary variants. While the library itself offers a proficient base64 implementation, it's worth noting that base64 implementations are widely available, exhibiting diverse performance levels. If you prefer to use your own base64 implementation, you have the option to define `JWT_DISABLE_BASE64` to exclude the jwt-cpp implementation. - -## Contributing - -If you have suggestions for improvement or if you've identified a bug, please don't hesitate to [open an issue](https://github.com/Thalhammer/jwt-cpp/issues/new) or contribute by creating a pull request. When reporting a bug, provide comprehensive details about your environment, including compiler version and other relevant information, to facilitate issue reproduction. Additionally, if you're introducing a new feature, ensure that you include corresponding test cases to validate its functionality. - -### Dependencies - -In order to use jwt-cpp you need the following tools. - -* libcrypto (openssl or compatible) -* libssl-dev (for the header files) -* a compiler supporting at least c++11 -* basic stl support - -In order to build the test cases you also need - -* gtest -* pthread - -## Troubleshooting - -See the [FAQs](docs/faqs.md) for tips. - -## Conference Coverage - -[![CppCon](https://img.youtube.com/vi/Oq4NW5idmiI/0.jpg)](https://www.youtube.com/watch?v=Oq4NW5idmiI) diff --git a/cmake/CMakePresets.json b/cmake/CMakePresets.json deleted file mode 100644 index 8c4fb85a..00000000 --- a/cmake/CMakePresets.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "version": 6, - "cmakeMinimumRequired": { - "major": 3, - "minor": 25, - "patch": 0 - }, - "configurePresets": [ - { - "name": "default", - "displayName": "Default Config", - "hidden": true, - "binaryDir": "${sourceDir}/build", - "cacheVariables": { - "JWT_BUILD_EXAMPLES": "OFF", - "JWT_BUILD_TESTS": "OFF" - } - }, - { - "name": "debug", - "displayName": "Debug", - "inherits": "default", - "cacheVariables": { - "CMAKE_BUILD_TYPE": "Debug" - } - }, - { - "name": "release", - "displayName": "Release", - "inherits": "default", - "cacheVariables": { - "CMAKE_BUILD_TYPE": "Release" - } - } - ], - "buildPresets": [ - { - "name": "debug", - "configurePreset": "debug", - "configuration": "Debug" - }, - { - "name": "release", - "configurePreset": "release", - "configuration": "Release" - } - ] -} \ No newline at end of file diff --git a/cmake/HunterGate.cmake b/cmake/HunterGate.cmake deleted file mode 100644 index 64ccde56..00000000 --- a/cmake/HunterGate.cmake +++ /dev/null @@ -1,537 +0,0 @@ -# Copyright (c) 2013-2019, Ruslan Baratov -# All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are met: -# -# * Redistributions of source code must retain the above copyright notice, this -# list of conditions and the following disclaimer. -# -# * Redistributions in binary form must reproduce the above copyright notice, -# this list of conditions and the following disclaimer in the documentation -# and/or other materials provided with the distribution. -# -# 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. - -# This is a gate file to Hunter package manager. -# Include this file using `include` command and add package you need, example: -# -# cmake_minimum_required(VERSION 3.2) -# -# include("cmake/HunterGate.cmake") -# HunterGate( -# URL "https://github.com/path/to/hunter/archive.tar.gz" -# SHA1 "798501e983f14b28b10cda16afa4de69eee1da1d" -# ) -# -# project(MyProject) -# -# hunter_add_package(Foo) -# hunter_add_package(Boo COMPONENTS Bar Baz) -# -# Projects: -# * https://github.com/hunter-packages/gate/ -# * https://github.com/ruslo/hunter - -option(HUNTER_ENABLED "Enable Hunter package manager support" ON) - -if(HUNTER_ENABLED) - if(CMAKE_VERSION VERSION_LESS "3.2") - message( - FATAL_ERROR - "At least CMake version 3.2 required for Hunter dependency management." - " Update CMake or set HUNTER_ENABLED to OFF." - ) - endif() -endif() - -include(CMakeParseArguments) # cmake_parse_arguments - -option(HUNTER_STATUS_PRINT "Print working status" ON) -option(HUNTER_STATUS_DEBUG "Print a lot info" OFF) -option(HUNTER_TLS_VERIFY "Enable/disable TLS certificate checking on downloads" ON) -set(HUNTER_ROOT "" CACHE FILEPATH "Override the HUNTER_ROOT.") - -set(HUNTER_ERROR_PAGE "https://hunter.readthedocs.io/en/latest/reference/errors") - -function(hunter_gate_status_print) - if(HUNTER_STATUS_PRINT OR HUNTER_STATUS_DEBUG) - foreach(print_message ${ARGV}) - message(STATUS "[hunter] ${print_message}") - endforeach() - endif() -endfunction() - -function(hunter_gate_status_debug) - if(HUNTER_STATUS_DEBUG) - foreach(print_message ${ARGV}) - string(TIMESTAMP timestamp) - message(STATUS "[hunter *** DEBUG *** ${timestamp}] ${print_message}") - endforeach() - endif() -endfunction() - -function(hunter_gate_error_page error_page) - message("------------------------------ ERROR ------------------------------") - message(" ${HUNTER_ERROR_PAGE}/${error_page}.html") - message("-------------------------------------------------------------------") - message("") - message(FATAL_ERROR "") -endfunction() - -function(hunter_gate_internal_error) - message("") - foreach(print_message ${ARGV}) - message("[hunter ** INTERNAL **] ${print_message}") - endforeach() - message("[hunter ** INTERNAL **] [Directory:${CMAKE_CURRENT_LIST_DIR}]") - message("") - hunter_gate_error_page("error.internal") -endfunction() - -function(hunter_gate_fatal_error) - cmake_parse_arguments(hunter "" "ERROR_PAGE" "" "${ARGV}") - if("${hunter_ERROR_PAGE}" STREQUAL "") - hunter_gate_internal_error("Expected ERROR_PAGE") - endif() - message("") - foreach(x ${hunter_UNPARSED_ARGUMENTS}) - message("[hunter ** FATAL ERROR **] ${x}") - endforeach() - message("[hunter ** FATAL ERROR **] [Directory:${CMAKE_CURRENT_LIST_DIR}]") - message("") - hunter_gate_error_page("${hunter_ERROR_PAGE}") -endfunction() - -function(hunter_gate_user_error) - hunter_gate_fatal_error(${ARGV} ERROR_PAGE "error.incorrect.input.data") -endfunction() - -function(hunter_gate_self root version sha1 result) - string(COMPARE EQUAL "${root}" "" is_bad) - if(is_bad) - hunter_gate_internal_error("root is empty") - endif() - - string(COMPARE EQUAL "${version}" "" is_bad) - if(is_bad) - hunter_gate_internal_error("version is empty") - endif() - - string(COMPARE EQUAL "${sha1}" "" is_bad) - if(is_bad) - hunter_gate_internal_error("sha1 is empty") - endif() - - string(SUBSTRING "${sha1}" 0 7 archive_id) - - if(EXISTS "${root}/cmake/Hunter") - set(hunter_self "${root}") - else() - set( - hunter_self - "${root}/_Base/Download/Hunter/${version}/${archive_id}/Unpacked" - ) - endif() - - set("${result}" "${hunter_self}" PARENT_SCOPE) -endfunction() - -# Set HUNTER_GATE_ROOT cmake variable to suitable value. -function(hunter_gate_detect_root) - # Check CMake variable - if(HUNTER_ROOT) - set(HUNTER_GATE_ROOT "${HUNTER_ROOT}" PARENT_SCOPE) - hunter_gate_status_debug("HUNTER_ROOT detected by cmake variable") - return() - endif() - - # Check environment variable - if(DEFINED ENV{HUNTER_ROOT}) - set(HUNTER_GATE_ROOT "$ENV{HUNTER_ROOT}" PARENT_SCOPE) - hunter_gate_status_debug("HUNTER_ROOT detected by environment variable") - return() - endif() - - # Check HOME environment variable - if(DEFINED ENV{HOME}) - set(HUNTER_GATE_ROOT "$ENV{HOME}/.hunter" PARENT_SCOPE) - hunter_gate_status_debug("HUNTER_ROOT set using HOME environment variable") - return() - endif() - - # Check SYSTEMDRIVE and USERPROFILE environment variable (windows only) - if(WIN32) - if(DEFINED ENV{SYSTEMDRIVE}) - set(HUNTER_GATE_ROOT "$ENV{SYSTEMDRIVE}/.hunter" PARENT_SCOPE) - hunter_gate_status_debug( - "HUNTER_ROOT set using SYSTEMDRIVE environment variable" - ) - return() - endif() - - if(DEFINED ENV{USERPROFILE}) - set(HUNTER_GATE_ROOT "$ENV{USERPROFILE}/.hunter" PARENT_SCOPE) - hunter_gate_status_debug( - "HUNTER_ROOT set using USERPROFILE environment variable" - ) - return() - endif() - endif() - - hunter_gate_fatal_error( - "Can't detect HUNTER_ROOT" - ERROR_PAGE "error.detect.hunter.root" - ) -endfunction() - -function(hunter_gate_download dir) - string( - COMPARE - NOTEQUAL - "$ENV{HUNTER_DISABLE_AUTOINSTALL}" - "" - disable_autoinstall - ) - if(disable_autoinstall AND NOT HUNTER_RUN_INSTALL) - hunter_gate_fatal_error( - "Hunter not found in '${dir}'" - "Set HUNTER_RUN_INSTALL=ON to auto-install it from '${HUNTER_GATE_URL}'" - "Settings:" - " HUNTER_ROOT: ${HUNTER_GATE_ROOT}" - " HUNTER_SHA1: ${HUNTER_GATE_SHA1}" - ERROR_PAGE "error.run.install" - ) - endif() - string(COMPARE EQUAL "${dir}" "" is_bad) - if(is_bad) - hunter_gate_internal_error("Empty 'dir' argument") - endif() - - string(COMPARE EQUAL "${HUNTER_GATE_SHA1}" "" is_bad) - if(is_bad) - hunter_gate_internal_error("HUNTER_GATE_SHA1 empty") - endif() - - string(COMPARE EQUAL "${HUNTER_GATE_URL}" "" is_bad) - if(is_bad) - hunter_gate_internal_error("HUNTER_GATE_URL empty") - endif() - - set(done_location "${dir}/DONE") - set(sha1_location "${dir}/SHA1") - - set(build_dir "${dir}/Build") - set(cmakelists "${dir}/CMakeLists.txt") - - hunter_gate_status_debug("Locking directory: ${dir}") - file(LOCK "${dir}" DIRECTORY GUARD FUNCTION) - hunter_gate_status_debug("Lock done") - - if(EXISTS "${done_location}") - # while waiting for lock other instance can do all the job - hunter_gate_status_debug("File '${done_location}' found, skip install") - return() - endif() - - file(REMOVE_RECURSE "${build_dir}") - file(REMOVE_RECURSE "${cmakelists}") - - file(MAKE_DIRECTORY "${build_dir}") # check directory permissions - - # Disabling languages speeds up a little bit, reduces noise in the output - # and avoids path too long windows error - file( - WRITE - "${cmakelists}" - "cmake_minimum_required(VERSION 3.2)\n" - "project(HunterDownload LANGUAGES NONE)\n" - "include(ExternalProject)\n" - "ExternalProject_Add(\n" - " Hunter\n" - " URL\n" - " \"${HUNTER_GATE_URL}\"\n" - " URL_HASH\n" - " SHA1=${HUNTER_GATE_SHA1}\n" - " DOWNLOAD_DIR\n" - " \"${dir}\"\n" - " TLS_VERIFY\n" - " ${HUNTER_TLS_VERIFY}\n" - " SOURCE_DIR\n" - " \"${dir}/Unpacked\"\n" - " CONFIGURE_COMMAND\n" - " \"\"\n" - " BUILD_COMMAND\n" - " \"\"\n" - " INSTALL_COMMAND\n" - " \"\"\n" - ")\n" - ) - - if(HUNTER_STATUS_DEBUG) - set(logging_params "") - else() - set(logging_params OUTPUT_QUIET) - endif() - - hunter_gate_status_debug("Run generate") - - # Need to add toolchain file too. - # Otherwise on Visual Studio + MDD this will fail with error: - # "Could not find an appropriate version of the Windows 10 SDK installed on this machine" - if(EXISTS "${CMAKE_TOOLCHAIN_FILE}") - get_filename_component(absolute_CMAKE_TOOLCHAIN_FILE "${CMAKE_TOOLCHAIN_FILE}" ABSOLUTE) - set(toolchain_arg "-DCMAKE_TOOLCHAIN_FILE=${absolute_CMAKE_TOOLCHAIN_FILE}") - else() - # 'toolchain_arg' can't be empty - set(toolchain_arg "-DCMAKE_TOOLCHAIN_FILE=") - endif() - - string(COMPARE EQUAL "${CMAKE_MAKE_PROGRAM}" "" no_make) - if(no_make) - set(make_arg "") - else() - # Test case: remove Ninja from PATH but set it via CMAKE_MAKE_PROGRAM - set(make_arg "-DCMAKE_MAKE_PROGRAM=${CMAKE_MAKE_PROGRAM}") - endif() - - execute_process( - COMMAND - "${CMAKE_COMMAND}" - "-H${dir}" - "-B${build_dir}" - "-G${CMAKE_GENERATOR}" - "${toolchain_arg}" - ${make_arg} - WORKING_DIRECTORY "${dir}" - RESULT_VARIABLE download_result - ${logging_params} - ) - - if(NOT download_result EQUAL 0) - hunter_gate_internal_error( - "Configure project failed." - "To reproduce the error run: ${CMAKE_COMMAND} -H${dir} -B${build_dir} -G${CMAKE_GENERATOR} ${toolchain_arg} ${make_arg}" - "In directory ${dir}" - ) - endif() - - hunter_gate_status_print( - "Initializing Hunter workspace (${HUNTER_GATE_SHA1})" - " ${HUNTER_GATE_URL}" - " -> ${dir}" - ) - execute_process( - COMMAND "${CMAKE_COMMAND}" --build "${build_dir}" - WORKING_DIRECTORY "${dir}" - RESULT_VARIABLE download_result - ${logging_params} - ) - - if(NOT download_result EQUAL 0) - hunter_gate_internal_error("Build project failed") - endif() - - file(REMOVE_RECURSE "${build_dir}") - file(REMOVE_RECURSE "${cmakelists}") - - file(WRITE "${sha1_location}" "${HUNTER_GATE_SHA1}") - file(WRITE "${done_location}" "DONE") - - hunter_gate_status_debug("Finished") -endfunction() - -# Must be a macro so master file 'cmake/Hunter' can -# apply all variables easily just by 'include' command -# (otherwise PARENT_SCOPE magic needed) -macro(HunterGate) - if(HUNTER_GATE_DONE) - # variable HUNTER_GATE_DONE set explicitly for external project - # (see `hunter_download`) - set_property(GLOBAL PROPERTY HUNTER_GATE_DONE YES) - endif() - - # First HunterGate command will init Hunter, others will be ignored - get_property(_hunter_gate_done GLOBAL PROPERTY HUNTER_GATE_DONE SET) - - if(NOT HUNTER_ENABLED) - # Empty function to avoid error "unknown function" - function(hunter_add_package) - endfunction() - - set( - _hunter_gate_disabled_mode_dir - "${CMAKE_CURRENT_LIST_DIR}/cmake/Hunter/disabled-mode" - ) - if(EXISTS "${_hunter_gate_disabled_mode_dir}") - hunter_gate_status_debug( - "Adding \"disabled-mode\" modules: ${_hunter_gate_disabled_mode_dir}" - ) - list(APPEND CMAKE_PREFIX_PATH "${_hunter_gate_disabled_mode_dir}") - endif() - elseif(_hunter_gate_done) - hunter_gate_status_debug("Secondary HunterGate (use old settings)") - hunter_gate_self( - "${HUNTER_CACHED_ROOT}" - "${HUNTER_VERSION}" - "${HUNTER_SHA1}" - _hunter_self - ) - include("${_hunter_self}/cmake/Hunter") - else() - set(HUNTER_GATE_LOCATION "${CMAKE_CURRENT_SOURCE_DIR}") - - string(COMPARE NOTEQUAL "${PROJECT_NAME}" "" _have_project_name) - if(_have_project_name) - hunter_gate_fatal_error( - "Please set HunterGate *before* 'project' command. " - "Detected project: ${PROJECT_NAME}" - ERROR_PAGE "error.huntergate.before.project" - ) - endif() - - cmake_parse_arguments( - HUNTER_GATE "LOCAL" "URL;SHA1;GLOBAL;FILEPATH" "" ${ARGV} - ) - - string(COMPARE EQUAL "${HUNTER_GATE_SHA1}" "" _empty_sha1) - string(COMPARE EQUAL "${HUNTER_GATE_URL}" "" _empty_url) - string( - COMPARE - NOTEQUAL - "${HUNTER_GATE_UNPARSED_ARGUMENTS}" - "" - _have_unparsed - ) - string(COMPARE NOTEQUAL "${HUNTER_GATE_GLOBAL}" "" _have_global) - string(COMPARE NOTEQUAL "${HUNTER_GATE_FILEPATH}" "" _have_filepath) - - if(_have_unparsed) - hunter_gate_user_error( - "HunterGate unparsed arguments: ${HUNTER_GATE_UNPARSED_ARGUMENTS}" - ) - endif() - if(_empty_sha1) - hunter_gate_user_error("SHA1 suboption of HunterGate is mandatory") - endif() - if(_empty_url) - hunter_gate_user_error("URL suboption of HunterGate is mandatory") - endif() - if(_have_global) - if(HUNTER_GATE_LOCAL) - hunter_gate_user_error("Unexpected LOCAL (already has GLOBAL)") - endif() - if(_have_filepath) - hunter_gate_user_error("Unexpected FILEPATH (already has GLOBAL)") - endif() - endif() - if(HUNTER_GATE_LOCAL) - if(_have_global) - hunter_gate_user_error("Unexpected GLOBAL (already has LOCAL)") - endif() - if(_have_filepath) - hunter_gate_user_error("Unexpected FILEPATH (already has LOCAL)") - endif() - endif() - if(_have_filepath) - if(_have_global) - hunter_gate_user_error("Unexpected GLOBAL (already has FILEPATH)") - endif() - if(HUNTER_GATE_LOCAL) - hunter_gate_user_error("Unexpected LOCAL (already has FILEPATH)") - endif() - endif() - - hunter_gate_detect_root() # set HUNTER_GATE_ROOT - - # Beautify path, fix probable problems with windows path slashes - get_filename_component( - HUNTER_GATE_ROOT "${HUNTER_GATE_ROOT}" ABSOLUTE - ) - hunter_gate_status_debug("HUNTER_ROOT: ${HUNTER_GATE_ROOT}") - if(NOT HUNTER_ALLOW_SPACES_IN_PATH) - string(FIND "${HUNTER_GATE_ROOT}" " " _contain_spaces) - if(NOT _contain_spaces EQUAL -1) - hunter_gate_fatal_error( - "HUNTER_ROOT (${HUNTER_GATE_ROOT}) contains spaces." - "Set HUNTER_ALLOW_SPACES_IN_PATH=ON to skip this error" - "(Use at your own risk!)" - ERROR_PAGE "error.spaces.in.hunter.root" - ) - endif() - endif() - - string( - REGEX - MATCH - "[0-9]+\\.[0-9]+\\.[0-9]+[-_a-z0-9]*" - HUNTER_GATE_VERSION - "${HUNTER_GATE_URL}" - ) - string(COMPARE EQUAL "${HUNTER_GATE_VERSION}" "" _is_empty) - if(_is_empty) - set(HUNTER_GATE_VERSION "unknown") - endif() - - hunter_gate_self( - "${HUNTER_GATE_ROOT}" - "${HUNTER_GATE_VERSION}" - "${HUNTER_GATE_SHA1}" - _hunter_self - ) - - set(_master_location "${_hunter_self}/cmake/Hunter") - if(EXISTS "${HUNTER_GATE_ROOT}/cmake/Hunter") - # Hunter downloaded manually (e.g. by 'git clone') - set(_unused "xxxxxxxxxx") - set(HUNTER_GATE_SHA1 "${_unused}") - set(HUNTER_GATE_VERSION "${_unused}") - else() - get_filename_component(_archive_id_location "${_hunter_self}/.." ABSOLUTE) - set(_done_location "${_archive_id_location}/DONE") - set(_sha1_location "${_archive_id_location}/SHA1") - - # Check Hunter already downloaded by HunterGate - if(NOT EXISTS "${_done_location}") - hunter_gate_download("${_archive_id_location}") - endif() - - if(NOT EXISTS "${_done_location}") - hunter_gate_internal_error("hunter_gate_download failed") - endif() - - if(NOT EXISTS "${_sha1_location}") - hunter_gate_internal_error("${_sha1_location} not found") - endif() - file(READ "${_sha1_location}" _sha1_value) - string(TOLOWER "${_sha1_value}" _sha1_value_lower) - string(TOLOWER "${HUNTER_GATE_SHA1}" _HUNTER_GATE_SHA1_lower) - string(COMPARE EQUAL "${_sha1_value_lower}" "${_HUNTER_GATE_SHA1_lower}" _is_equal) - if(NOT _is_equal) - hunter_gate_internal_error( - "Short SHA1 collision:" - " ${_sha1_value} (from ${_sha1_location})" - " ${HUNTER_GATE_SHA1} (HunterGate)" - ) - endif() - if(NOT EXISTS "${_master_location}") - hunter_gate_user_error( - "Master file not found:" - " ${_master_location}" - "try to update Hunter/HunterGate" - ) - endif() - endif() - include("${_master_location}") - set_property(GLOBAL PROPERTY HUNTER_GATE_DONE YES) - endif() -endmacro() diff --git a/cmake/code-coverage.cmake b/cmake/code-coverage.cmake deleted file mode 100644 index 5e630bc8..00000000 --- a/cmake/code-coverage.cmake +++ /dev/null @@ -1,12 +0,0 @@ -set(COVERAGE_CMAKE "${CMAKE_BINARY_DIR}/cmake/CodeCoverage.cmake") -if(NOT EXISTS ${COVERAGE_CMAKE}) - set(COVERAGE_URL "https://raw.githubusercontent.com/bilke/cmake-modules/master/CodeCoverage.cmake") - file(DOWNLOAD ${COVERAGE_URL} ${COVERAGE_CMAKE}) -endif() - -include(${COVERAGE_CMAKE}) - -function(setup_coverage TARGET) - target_compile_options(${TARGET} PRIVATE -g -O0 -fprofile-arcs -ftest-coverage) - target_link_libraries(${TARGET} PRIVATE gcov) -endfunction() diff --git a/cmake/jwt-cpp-config.cmake.in b/cmake/jwt-cpp-config.cmake.in deleted file mode 100644 index d0e7cd07..00000000 --- a/cmake/jwt-cpp-config.cmake.in +++ /dev/null @@ -1,20 +0,0 @@ -@PACKAGE_INIT@ - -set(JWT_DISABLE_PICOJSON @JWT_DISABLE_PICOJSON@) -set(JWT_EXTERNAL_PICOJSON @JWT_EXTERNAL_PICOJSON@) -set(JWT_SSL_LIBRARY @JWT_SSL_LIBRARY@) - -include(CMakeFindDependencyMacro) -if(${JWT_SSL_LIBRARY} MATCHES "wolfSSL") - find_dependency(PkgConfig REQUIRED) - pkg_check_modules(wolfssl REQUIRED IMPORTED_TARGET wolfssl) - list(TRANSFORM wolfssl_INCLUDE_DIRS APPEND "/wolfssl") # This is required to access OpenSSL compatibility API -else() - find_dependency(${JWT_SSL_LIBRARY} REQUIRED) -endif() - -if(NOT JWT_DISABLE_PICOJSON AND JWT_EXTERNAL_PICOJSON) - find_dependency(picojson REQUIRED) -endif() - -include("${CMAKE_CURRENT_LIST_DIR}/jwt-cpp-targets.cmake") diff --git a/cmake/private-find-boost-json.cmake b/cmake/private-find-boost-json.cmake deleted file mode 100644 index 70c7b6cc..00000000 --- a/cmake/private-find-boost-json.cmake +++ /dev/null @@ -1,16 +0,0 @@ -if(TARGET boost_json) - return() -endif() - -unset(BOOSTJSON_INCLUDE_DIR CACHE) -find_path(BOOSTJSON_INCLUDE_DIR "boost/json.hpp" "boost/json/src.hpp") -if(EXISTS "${BOOSTJSON_INCLUDE_DIR}/boost/json.hpp") - file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/private-boost-json.cpp.in" "#include ") - configure_file("${CMAKE_CURRENT_BINARY_DIR}/private-boost-json.cpp.in" private-boost-json.cpp COPYONLY) - add_library(boost_json "${BOOSTJSON_INCLUDE_DIR}/boost/json.hpp" - "${BOOSTJSON_INCLUDE_DIR}/boost/json/src.hpp" - "${CMAKE_CURRENT_BINARY_DIR}/private-boost-json.cpp") - target_include_directories(boost_json PUBLIC ${BOOSTJSON_INCLUDE_DIR}) - target_compile_definitions(boost_json PUBLIC BOOST_JSON_STANDALONE) - target_compile_features(boost_json PUBLIC cxx_std_17) -endif() diff --git a/cmake/private-find-kazuho-picojson.cmake b/cmake/private-find-kazuho-picojson.cmake deleted file mode 100644 index ccbed306..00000000 --- a/cmake/private-find-kazuho-picojson.cmake +++ /dev/null @@ -1,10 +0,0 @@ -if(TARGET kazuho_picojson) - return() -endif() - -unset(PICOJSON_INCLUDE_DIR CACHE) -find_path(PICOJSON_INCLUDE_DIR "picojson/picojson.h") -if(EXISTS "${PICOJSON_INCLUDE_DIR}/picojson/picojson.h") - add_library(kazuho_picojson INTERFACE) - target_include_directories(kazuho_picojson INTERFACE ${PICOJSON_INCLUDE_DIR}) -endif() diff --git a/cross-platform/macos-latest/shields.json b/cross-platform/macos-latest/shields.json new file mode 100644 index 00000000..e75c22d0 --- /dev/null +++ b/cross-platform/macos-latest/shields.json @@ -0,0 +1 @@ +{ "schemaVersion": 1, "label": "macos-latest", "message": "Passing", "color": "brightgreen" } diff --git a/cross-platform/ubuntu-latest/shields.json b/cross-platform/ubuntu-latest/shields.json new file mode 100644 index 00000000..22f429c4 --- /dev/null +++ b/cross-platform/ubuntu-latest/shields.json @@ -0,0 +1 @@ +{ "schemaVersion": 1, "label": "ubuntu-latest", "message": "Passing", "color": "brightgreen" } diff --git a/cross-platform/windows-latest/shields.json b/cross-platform/windows-latest/shields.json new file mode 100644 index 00000000..61d21f46 --- /dev/null +++ b/cross-platform/windows-latest/shields.json @@ -0,0 +1 @@ +{ "schemaVersion": 1, "label": "windows-latest", "message": "Passing", "color": "brightgreen" } diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index 3a5b63a8..00000000 --- a/docs/.gitignore +++ /dev/null @@ -1 +0,0 @@ -doxygen-awesome*.css diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt deleted file mode 100644 index 1c159155..00000000 --- a/docs/CMakeLists.txt +++ /dev/null @@ -1,23 +0,0 @@ -file(DOWNLOAD https://raw.githubusercontent.com/jothepro/doxygen-awesome-css/v2.2.1/doxygen-awesome.css - ${CMAKE_CURRENT_LIST_DIR}/doxygen-awesome.css - EXPECTED_HASH SHA256=9b5549928906e9974cc12dcdde9265e016dc2388ec72d5aa3209f4870914a0c8) -file(DOWNLOAD https://raw.githubusercontent.com/jothepro/doxygen-awesome-css/v2.2.1/doxygen-awesome-sidebar-only.css - ${CMAKE_CURRENT_LIST_DIR}/doxygen-awesome-sidebar-only.css - EXPECTED_HASH SHA256=998328b27193b7be007a431bc9be1a6f6855ff4d8fa722ecfdfed79a8931409f) - -execute_process(COMMAND doxygen --version RESULT_VARIABLE DOXYGEN_VERSION_RESULT - OUTPUT_VARIABLE DOXYGEN_VERSION_RAW_OUTPUT) -if(NOT DOXYGEN_VERSION_RESULT EQUAL 0) - message(AUTHOR_WARNING "Unable to get the version of doxygen") -else() - # Extracts the version from the output of the command run before - string(REGEX MATCH "^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)" DOXYGEN_VERSION_OUTPUT - "${DOXYGEN_VERSION_RAW_OUTPUT}") - message(STATUS "doxygen version detected : ${DOXYGEN_VERSION_OUTPUT}") -endif() - -add_custom_target(jwt-docs COMMAND doxygen ${CMAKE_CURRENT_LIST_DIR}/Doxyfile WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} - SOURCES ${CMAKE_CURRENT_LIST_DIR}/Doxyfile BYPRODUCTS ${CMAKE_BINARY_DIR}/html/index.html) -add_custom_command( - TARGET jwt-docs POST_BUILD COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan - "You can prview the documentation: ${CMAKE_BINARY_DIR}/html/index.html") diff --git a/docs/Doxyfile b/docs/Doxyfile deleted file mode 100644 index 20fd3322..00000000 --- a/docs/Doxyfile +++ /dev/null @@ -1,2857 +0,0 @@ -# Doxyfile 1.10.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 = JWT-CPP - -# 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 = v0.7.1 - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a -# quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = "A header only library for creating and validating JSON Web Tokens (JWT) in C++" - -# 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 = - -# 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 = build - -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 -# sub-directories (in 2 levels) under the output directory of each output format -# and will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to -# control the number of sub-directories. -# The default value is: NO. - -CREATE_SUBDIRS = NO - -# Controls the number of sub-directories that will be created when -# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every -# level increment doubles the number of directories, resulting in 4096 -# directories at level 8 which is the default and also the maximum value. The -# sub-directories are organized in 2 levels, the first level always has a fixed -# number of 16 directories. -# Minimum value: 0, maximum value: 8, default value: 8. -# This tag requires that the tag CREATE_SUBDIRS is set to YES. - -CREATE_SUBDIRS_LEVEL = 8 - -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII -# characters to appear in the names of generated files. If set to NO, non-ASCII -# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode -# U+3044. -# The default value is: NO. - -ALLOW_UNICODE_NAMES = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, -# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English -# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, -# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with -# English messages), Korean, Korean-en (Korean with English messages), Latvian, -# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, -# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, -# Swedish, Turkish, Ukrainian and Vietnamese. -# The default value is: English. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. - -ABBREVIATE_BRIEF = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. - -FULL_PATH_NAMES = YES - -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. - -JAVADOC_AUTOBRIEF = NO - -# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line -# such as -# /*************** -# as being the beginning of a Javadoc-style comment "banner". If set to NO, the -# Javadoc-style will behave just like regular comments and it will not be -# interpreted by doxygen. -# The default value is: NO. - -JAVADOC_BANNER = NO - -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) -# The default value is: NO. - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. - -MULTILINE_CPP_IS_BRIEF = NO - -# By default Python docstrings are displayed as preformatted text and doxygen's -# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the -# doxygen's special commands can be used and the contents of the docstring -# documentation blocks is shown as doxygen documentation. -# The default value is: YES. - -PYTHON_DOCSTRING = YES - -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new -# page for each member. If set to NO, the documentation of a member will be part -# of the file/class/namespace that contains it. -# The default value is: NO. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. - -TAB_SIZE = 4 - -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:^^" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". Note that you cannot put \n's in the value part of an alias -# to insert newlines (in the resulting output). You can put ^^ in the value part -# of an alias to insert a newline as if a physical newline was in the original -# file. When you need a literal { or } or , in the value part of an alias you -# have to escape them by means of a backslash (\), this can lead to conflicts -# with the commands \{ and \} for these it is advised to use the version @{ and -# @} or use a double escape (\\{ and \\}) - -ALIASES = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. For -# instance, some of the names that are used will be different. The list of all -# members will be omitted, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_FOR_C = 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: 5. -# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. - -TOC_INCLUDE_HEADINGS = 0 - -# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to -# generate identifiers for the Markdown headings. Note: Every identifier is -# unique. -# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a -# sequence number starting at 0 and GITHUB use the lower case version of title -# with any whitespace replaced by '-' and punctuation characters removed. -# The default value is: DOXYGEN. -# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. - -MARKDOWN_ID_STYLE = DOXYGEN - -# When enabled doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by putting a % sign in front of the word or -# globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - -AUTOLINK_SUPPORT = YES - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. -# The default value is: NO. - -BUILTIN_STL_SUPPORT = YES - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. -# The default value is: NO. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. - -DISTRIBUTE_GROUP_DOC = NO - -# If one adds a struct or class to a group and this option is enabled, then also -# any nested class or struct is added to the same group. By default this option -# is disabled and one has to add nested compounds explicitly via \ingroup. -# The default value is: NO. - -GROUP_NESTED_COMPOUNDS = NO - -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. - -SUBGROUPING = YES - -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions -# are shown inside the group in which they are included (e.g. using \ingroup) -# instead of on a separate page (for HTML and Man pages) or section (for LaTeX -# and RTF). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. - -INLINE_GROUPED_CLASSES = NO - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef fields will be shown inline in -# the documentation of the scope in which they are defined (i.e. file, -# namespace, or group documentation), provided this scope is documented. If set -# to NO, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. - -INLINE_SIMPLE_STRUCTS = NO - -# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or -# enum is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. - -TYPEDEF_HIDES_STRUCT = NO - -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This -# cache is used to resolve symbols given their name and scope. Since this can be -# an expensive process and often the same symbol appears multiple times in the -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# doxygen will become slower. If the cache is too large, memory is wasted. The -# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range -# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - -LOOKUP_CACHE_SIZE = 0 - -# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use -# during processing. When set to 0 doxygen will based this on the number of -# cores available in the system. You can set it explicitly to a value larger -# than 0 to get more control over the balance between CPU load and processing -# speed. At this moment only the input processing can be done using multiple -# threads. Since this is still an experimental feature the default is set to 1, -# which effectively disables parallel processing. Please report any issues you -# encounter. Generating dot graphs in parallel is controlled by the -# DOT_NUM_THREADS setting. -# Minimum value: 0, maximum value: 32, default value: 1. - -NUM_PROC_THREADS = 1 - -# If the TIMESTAMP tag is set different from NO then each generated page will -# contain the date or date and time when the page was generated. Setting this to -# NO can help when comparing the output of multiple runs. -# Possible values are: YES, NO, DATETIME and DATE. -# The default value is: NO. - -TIMESTAMP = NO - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. - -EXTRACT_ALL = NO - -# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will -# be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIVATE = NO - -# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual -# methods of a class will be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIV_VIRTUAL = NO - -# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal -# scope will be included in the documentation. -# The default value is: NO. - -EXTRACT_PACKAGE = NO - -# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be -# included in the documentation. -# The default value is: NO. - -EXTRACT_STATIC = NO - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO, -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. If set to YES, local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO, only methods in the interface are -# included. -# The default value is: NO. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. - -EXTRACT_ANON_NSPACES = NO - -# If this flag is set to YES, the name of an unnamed parameter in a declaration -# will be determined by the corresponding definition. By default unnamed -# parameters remain unnamed in the output. -# The default value is: YES. - -RESOLVE_UNNAMED_PARAMS = YES - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. If set -# to NO, these classes will be included in the various overviews. This option -# will also hide undocumented C++ concepts if enabled. This option has no effect -# if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# declarations. If set to NO, these declarations will be included in the -# documentation. -# The default value is: NO. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO, these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - -INTERNAL_DOCS = NO - -# With the correct setting of option CASE_SENSE_NAMES doxygen will better be -# able to match the capabilities of the underlying filesystem. In case the -# filesystem is case sensitive (i.e. it supports files in the same directory -# whose names only differ in casing), the option must be set to YES to properly -# deal with such files in case they appear in the input. For filesystems that -# are not case sensitive the option should be set to NO to properly deal with -# output files written for symbols that only differ in casing, such as for two -# classes, one named CLASS and the other named Class, and to also support -# references to files without having to specify the exact matching casing. On -# Windows (including Cygwin) and MacOS, users should typically set this option -# to NO, whereas on Linux or other Unix flavors it should typically be set to -# YES. -# Possible values are: SYSTEM, NO and YES. -# The default value is: SYSTEM. - -CASE_SENSE_NAMES = 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 = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. - -SORT_BY_SCOPE_NAME = NO - -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper -# type resolution of all parameters of a function it will reject a match between -# the prototype and the implementation of a member function even if there is -# only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo -# list. This list is created by putting \todo commands in the documentation. -# The default value is: YES. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test -# list. This list is created by putting \test commands in the documentation. -# The default value is: YES. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if ... \endif and \cond -# ... \endcond blocks. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES, the -# list will mention the files that were used to generate the documentation. -# The default value is: YES. - -SHOW_USED_FILES = YES - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This -# will remove the Files entry from the Quick Index and from the Folder Tree View -# (if specified). -# The default value is: YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. See also section "Changing the -# layout of pages" for information. -# -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. - -LAYOUT_FILE = - -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. -# For LaTeX the style of the bibliography can be controlled using -# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. See also \cite for info how to create references. - -CITE_BIB_FILES = - -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. - -WARNINGS = YES - -# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. - -WARN_IF_UNDOCUMENTED = YES - -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as 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 = NO - -# 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 = - -#--------------------------------------------------------------------------- -# 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 = include \ - example \ - README.md \ - docs \ - .github/security.md - -# 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 cfg_input_encoding -# "INPUT_ENCODING" for further information on supported encodings. - -INPUT_FILE_ENCODING = - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# read by doxygen. -# -# Note the list of default checked file patterns might differ from the list of -# default file extension mappings. -# -# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, -# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, -# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, -# *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to -# be provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, -# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. - -FILE_PATTERNS = *.c \ - *.cc \ - *.cxx \ - *.cpp \ - *.c++ \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ - *.idl \ - *.ddl \ - *.odl \ - *.h \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.cs \ - *.d \ - *.php \ - *.php4 \ - *.php5 \ - *.phtml \ - *.inc \ - *.m \ - *.markdown \ - *.md \ - *.mm \ - *.dox \ - *.py \ - *.pyw \ - *.f90 \ - *.f95 \ - *.f03 \ - *.f08 \ - *.f \ - *.for \ - *.tcl \ - *.vhd \ - *.vhdl \ - *.ucf \ - *.qsf - -# 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 = include/picojson/picojson.h \ - example/conan/README.md \ - example/traits/README.md - -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. -# The default value is: NO. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# ANamespace::AClass, ANamespace::*Test - -EXCLUDE_SYMBOLS = jwt::details \ - jwt::base::details \ - std - -# 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 = example - -# 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 = *.cpp - -# 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 = - -# 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 = README.md - -# The Fortran standard specifies that for fixed formatted Fortran code all -# characters from position 72 are to be considered as comment. A common -# extension is to allow longer lines before the automatic comment starts. The -# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can -# be processed before the automatic comment starts. -# Minimum value: 7, maximum value: 10000, default value: 72. - -FORTRAN_COMMENT_AFTER = 72 - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - -SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# multi-line macros, enums or list initialized variables directly into the -# documentation. -# The default value is: NO. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# entity all documented functions referencing it will be listed. -# The default value is: NO. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - -REFERENCES_LINK_SOURCE = YES - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see https://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. - -VERBATIM_HEADERS = YES - -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. - -ALPHABETICAL_INDEX = YES - -# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) -# that should be ignored while generating the index headers. The IGNORE_PREFIX -# tag works for classes, function and member names. The entity will be placed in -# the alphabetical list under the first letter of the entity name that remains -# after removing the prefix. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output -# The default value is: YES. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined -# cascading style sheets that are included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefore more robust against future updates. -# Doxygen will copy the style sheet files to the output directory. -# Note: The order of the extra style sheet files is of importance (e.g. the last -# style sheet in the list overrules the setting of the previous ones in the -# list). -# 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 = docs/doxygen-awesome.css \ - docs/doxygen-awesome-sidebar-only.css \ - docs/overrides.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 = - -# 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 generate light mode output, DARK always -# generate dark mode output, AUTO_LIGHT automatically set the mode according to -# the user preference, use light mode if no preference is set (the default), -# AUTO_DARK automatically set the mode according to the user preference, use -# dark mode if no preference is set and TOGGLE allow to 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 = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_VIRTUAL_FOLDER = doc - -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_SECT_FILTER_ATTRS = - -# The QHG_LOCATION tag can be used to specify the location (absolute path -# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to -# run qhelpgenerator on the generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -DISABLE_INDEX = NO - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that is generated for HTML Help). For this -# to work a browser that supports JavaScript, DHTML, CSS and frames is required -# (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can -# further fine tune the look of the index (see "Fine-tuning the output"). As an -# example, the default style sheet generated by doxygen has an example that -# shows how to put an image at the root of the tree instead of the PROJECT_NAME. -# Since the tree basically has the same information as the tab index, you could -# consider setting DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_TREEVIEW = YES - -# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the -# FULL_SIDEBAR option determines if the side bar is limited to only the treeview -# area (value NO) or if it should extend to the full height of the window (value -# YES). Setting this to YES gives a layout similar to -# https://docs.readthedocs.io with more room for contents, but less room for the -# project logo, title, and description. If either GENERATE_TREEVIEW or -# DISABLE_INDEX is set to NO, this option has no effect. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FULL_SIDEBAR = NO - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. -# -# Note that a value of 0 will completely suppress the enum values from appearing -# in the overview section. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. - -ENUM_VALUES_PER_LINE = 4 - -# 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 NathJax 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 = http://cdn.mathjax.org/mathjax/latest - -# 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 -# , /