From da2c6142ffa38e8f690225e21b5af9870f98675d Mon Sep 17 00:00:00 2001 From: Glyn Matthews Date: Sat, 3 Jan 2026 09:04:51 +0100 Subject: [PATCH 1/6] Add URL builder functions --- README.md | 26 +- examples/CMakeLists.txt | 1 + examples/example_14.cpp | 55 +++ include/skyr/unicode/details/to_u8.hpp | 32 +- include/skyr/url.hpp | 319 ++++++++++++++- tests/skyr/url/CMakeLists.txt | 1 + tests/skyr/url/url_with_methods_tests.cpp | 462 ++++++++++++++++++++++ 7 files changed, 868 insertions(+), 28 deletions(-) create mode 100644 examples/example_14.cpp create mode 100644 tests/skyr/url/url_with_methods_tests.cpp diff --git a/README.md b/README.md index 1e1f30db..0f24bd7c 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,9 @@ This library provides: * A ``skyr::url`` class that implements a generic URL parser, conforming with the [WhatWG URL specification](https://url.spec.whatwg.org/#url-class) * URL serialization and comparison +* **Immutable URL transformations** with `with_*` methods for functional-style URL building +* **URL sanitization** methods to remove credentials, fragments, and query parameters +* **`std::format` support** with custom format specifiers for URL components * Percent encoding and decoding functions * IDNA and Punycode functions for domain name parsing * Unicode conversion utilities @@ -36,7 +39,7 @@ This library provides: ## Using the library This project requires: -* A **C++23 compliant compiler** (GCC 13+, Clang 16+, MSVC 2022 17.6+) +* A **C++23 compliant compiler** (GCC 13+, Clang 19+, MSVC 2022+) * **No external dependencies** for core URL parsing ### ``vcpkg`` @@ -101,30 +104,25 @@ On Windows, replace the target with ``RUN_TESTS``: > cmake --build _build --target RUN_TESTS ``` -To install the library: +To install the library (optional): ```bash > cmake --build _build --target install ``` -## Testing and installing the project - -### Installing with `CMake` and `Ninja` +Or with a custom install prefix: ```bash -> cmake .. \ +> cmake \ + -B _build \ -G "Ninja" \ -DCMAKE_TOOLCHAIN_FILE=${VCPKG_ROOT}/vcpkg/scripts/buildsystems/vcpkg.cmake \ - -DCMAKE_INSTALL_PREFIX=$PREFIX -> ninja -> ninja test -> ninja install + -DCMAKE_INSTALL_PREFIX=/your/install/path \ + . +> cmake --build _build --target install ``` -Where `$PREFIX` is the location where you want to install the -library. Depending on the location of `$PREFIX`, you may need to run -the install command as an administrator (e.g. on Linux as `sudo`). - +**Note**: Depending on the install location, you may need administrator privileges (e.g., `sudo` on Linux). ## Example usage diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt index 0ece4458..a18515c8 100644 --- a/examples/CMakeLists.txt +++ b/examples/CMakeLists.txt @@ -20,6 +20,7 @@ foreach( example_11.cpp example_12.cpp example_13.cpp + example_14.cpp ) skyr_remove_extension(${file_name} example) add_executable(${example} ${file_name}) diff --git a/examples/example_14.cpp b/examples/example_14.cpp new file mode 100644 index 00000000..7843a505 --- /dev/null +++ b/examples/example_14.cpp @@ -0,0 +1,55 @@ +// Copyright 2025 Glyn Matthews. +// Distributed under the Boost Software License, Version 1.0. +// (See accompanying file LICENSE_1_0.txt of copy at +// http://www.boost.org/LICENSE_1_0.txt) + +#include + +#include + +int main() { + // Immutable URL transformations - original URL never changes + auto url = skyr::url("http://localhost:3000/api/v1/users"); + + std::cout << "Original URL:\n"; + std::cout << " " << url.href() << "\n\n"; + + // Individual transformations return new URLs + if (auto result = url.with_scheme("https")) { + std::cout << "Change scheme:\n"; + std::cout << " " << result->href() << "\n\n"; + } + + if (auto result = url.with_hostname("api.example.com")) { + std::cout << "Change hostname:\n"; + std::cout << " " << result->href() << "\n\n"; + } + + // Original URL is unchanged + std::cout << "Original still unchanged:\n"; + std::cout << " " << url.href() << "\n\n"; + + // Chain transformations with .and_then() + auto prod_url = url.with_scheme("https") + .and_then([](auto&& u) { return u.with_hostname("api.example.com"); }) + .and_then([](auto&& u) { return u.with_port(""); }) + .and_then([](auto&& u) { return u.with_pathname("/api/v2/users"); }) + .and_then([](auto&& u) { return u.with_search("limit=100"); }); + + if (prod_url) { + std::cout << "Chained transformations (dev → prod):\n"; + std::cout << " " << prod_url->href() << "\n\n"; + } + + // Build API endpoint + auto api_base = skyr::url("https://api.example.com"); + auto endpoint = + api_base.with_pathname("/v1/users").and_then([](auto&& u) { return u.with_search("page=2&limit=50"); }); + + if (endpoint) { + std::cout << "Build API endpoint:\n"; + std::cout << " " << endpoint->href() << "\n"; + } + + return 0; +} diff --git a/include/skyr/unicode/details/to_u8.hpp b/include/skyr/unicode/details/to_u8.hpp index 3957fbfd..15b5c59f 100644 --- a/include/skyr/unicode/details/to_u8.hpp +++ b/include/skyr/unicode/details/to_u8.hpp @@ -16,14 +16,38 @@ namespace skyr::details { template requires is_string_container -inline auto to_u8(const Source& source) -> std::expected { - return std::string(source); +auto to_u8(const Source& source) -> std::expected { + // For char arrays/pointers (null-terminated), find the actual end excluding null terminator + auto begin = std::cbegin(source); + auto end = std::cend(source); + + // If this is a null-terminated string, exclude the null terminator + if constexpr (is_char_array || is_char_pointer) { + // Find the actual end (before null terminator) + while (begin != end && *(end - 1) == char{0}) { + --end; + } + } + + return std::string(begin, end); } template requires is_string_container -inline auto to_u8(const Source& source) -> std::expected { - return std::string(std::cbegin(source), std::cend(source)); +auto to_u8(const Source& source) -> std::expected { + // For char8_t arrays/pointers (null-terminated), find the actual end excluding null terminator + auto begin = std::cbegin(source); + auto end = std::cend(source); + + // If this is a null-terminated string, exclude the null terminator + if constexpr (is_char_array || is_char_pointer) { + // Find the actual end (before null terminator) + while (begin != end && *(end - 1) == char8_t{0}) { + --end; + } + } + + return std::string(begin, end); } template diff --git a/include/skyr/url.hpp b/include/skyr/url.hpp index 895928f7..ee789c75 100644 --- a/include/skyr/url.hpp +++ b/include/skyr/url.hpp @@ -741,9 +741,10 @@ class url { /// \param hash The new hash string /// \returns An error on failure to parse the new URL auto set_hash(string_view hash) -> std::error_code { + auto url = url_; // Copy first to avoid self-move if (hash.empty()) { - url_.fragment = std::nullopt; - update_record(std::move(url_)); + url.fragment = std::nullopt; + update_record(std::move(url)); return {}; } @@ -751,9 +752,9 @@ class url { hash.remove_prefix(1); } - url_.fragment = ""; + url.fragment = ""; bool validation_error = false; - auto new_url = details::basic_parse(hash, &validation_error, nullptr, &url_, url_parse_state::fragment); + auto new_url = details::basic_parse(hash, &validation_error, nullptr, &url, url_parse_state::fragment); if (!new_url) { return new_url.error(); } @@ -894,6 +895,304 @@ class url { return result; } + // Immutable transformation methods (with_* methods) + + /// Returns a copy of this URL with the scheme changed + /// + /// \tparam Source The input string type + /// \param scheme The new URL scheme + /// \returns A new URL with the updated scheme, or an error on validation failure + template + requires is_u8_convertible + [[nodiscard]] auto with_scheme(const Source& scheme) const -> std::expected { + auto bytes = details::to_u8(scheme); + if (!bytes) { + return std::unexpected(make_error_code(url_parse_errc::invalid_unicode_character)); + } + return with_scheme(std::string_view(bytes.value())); + } + + /// Returns a copy of this URL with the scheme changed + /// + /// \param scheme The new URL scheme + /// \returns A new URL with the updated scheme, or an error on validation failure + [[nodiscard]] auto with_scheme(string_view scheme) const -> std::expected { + auto result = *this; + if (auto ec = result.set_protocol(scheme)) { + return std::unexpected(ec); + } + return result; + } + + /// Returns a copy of this URL with the hostname changed + /// + /// \tparam Source The input string type + /// \param hostname The new hostname + /// \returns A new URL with the updated hostname, or an error on validation failure + template + requires is_u8_convertible + [[nodiscard]] auto with_hostname(const Source& hostname) const -> std::expected { + auto bytes = details::to_u8(hostname); + if (!bytes) { + return std::unexpected(make_error_code(url_parse_errc::invalid_unicode_character)); + } + return with_hostname(std::string_view(bytes.value())); + } + + /// Returns a copy of this URL with the hostname changed + /// + /// \param hostname The new hostname + /// \returns A new URL with the updated hostname, or an error on validation failure + [[nodiscard]] auto with_hostname(string_view hostname) const -> std::expected { + auto result = *this; + if (auto ec = result.set_hostname(hostname)) { + return std::unexpected(ec); + } + return result; + } + + /// Returns a copy of this URL with the port changed + /// + /// \tparam Source The input string type + /// \param port The new port + /// \returns A new URL with the updated port, or an error on validation failure + template + requires is_u8_convertible + [[nodiscard]] auto with_port(const Source& port) const -> std::expected { + auto bytes = details::to_u8(port); + if (!bytes) { + return std::unexpected(make_error_code(url_parse_errc::invalid_unicode_character)); + } + return with_port(std::string_view(bytes.value())); + } + + /// Returns a copy of this URL with the port changed + /// + /// \tparam intT An integral type + /// \param port The new port number + /// \returns A new URL with the updated port, or an error on validation failure + template + requires std::is_integral_v + [[nodiscard]] auto with_port(intT port) const -> std::expected { + auto result = *this; + if (auto ec = result.set_port(port)) { + return std::unexpected(ec); + } + return result; + } + + /// Returns a copy of this URL with the port changed + /// + /// \param port The new port (empty string clears the port) + /// \returns A new URL with the updated port, or an error on validation failure + [[nodiscard]] auto with_port(string_view port) const -> std::expected { + auto result = *this; + if (auto ec = result.set_port(port)) { + return std::unexpected(ec); + } + return result; + } + + /// Returns a copy of this URL with the pathname changed + /// + /// \tparam Source The input string type + /// \param pathname The new pathname + /// \returns A new URL with the updated pathname, or an error on validation failure + template + requires is_u8_convertible + [[nodiscard]] auto with_pathname(const Source& pathname) const -> std::expected { + auto bytes = details::to_u8(pathname); + if (!bytes) { + return std::unexpected(make_error_code(url_parse_errc::invalid_unicode_character)); + } + return with_pathname(std::string_view(bytes.value())); + } + + /// Returns a copy of this URL with the pathname changed + /// + /// \param pathname The new pathname + /// \returns A new URL with the updated pathname, or an error on validation failure + [[nodiscard]] auto with_pathname(string_view pathname) const -> std::expected { + auto result = *this; + if (auto ec = result.set_pathname(pathname)) { + return std::unexpected(ec); + } + return result; + } + + /// Returns a copy of this URL with the query/search string changed + /// + /// \tparam Source The input string type + /// \param search The new query string (with or without leading '?') + /// \returns A new URL with the updated query, or an error on validation failure + template + requires is_u8_convertible + [[nodiscard]] auto with_search(const Source& search) const -> std::expected { + auto bytes = details::to_u8(search); + if (!bytes) { + return std::unexpected(make_error_code(url_parse_errc::invalid_unicode_character)); + } + return with_search(std::string_view(bytes.value())); + } + + /// Returns a copy of this URL with the query/search string changed + /// + /// \param search The new query string (with or without leading '?', empty clears query) + /// \returns A new URL with the updated query, or an error on validation failure + [[nodiscard]] auto with_search(string_view search) const -> std::expected { + auto result = *this; + if (auto ec = result.set_search(search)) { + return std::unexpected(ec); + } + return result; + } + + /// Alias for with_search() + /// + /// \tparam Source The input string type + /// \param query The new query string + /// \returns A new URL with the updated query, or an error on validation failure + template + requires is_u8_convertible + [[nodiscard]] auto with_query(const Source& query) const -> std::expected { + return with_search(query); + } + + /// Alias for with_search() + /// + /// \param query The new query string + /// \returns A new URL with the updated query, or an error on validation failure + [[nodiscard]] auto with_query(string_view query) const -> std::expected { + return with_search(query); + } + + /// Returns a copy of this URL with the fragment/hash changed + /// + /// \tparam Source The input string type + /// \param hash The new fragment (with or without leading '#') + /// \returns A new URL with the updated fragment, or an error on validation failure + template + requires is_u8_convertible + [[nodiscard]] auto with_hash(const Source& hash) const -> std::expected { + auto bytes = details::to_u8(hash); + if (!bytes) { + return std::unexpected(make_error_code(url_parse_errc::invalid_unicode_character)); + } + return with_hash(std::string_view(bytes.value())); + } + + /// Returns a copy of this URL with the fragment/hash changed + /// + /// \param hash The new fragment (with or without leading '#', empty clears fragment) + /// \returns A new URL with the updated fragment, or an error on validation failure + [[nodiscard]] auto with_hash(string_view hash) const -> std::expected { + auto result = *this; + if (auto ec = result.set_hash(hash)) { + return std::unexpected(ec); + } + return result; + } + + /// Alias for with_hash() + /// + /// \tparam Source The input string type + /// \param fragment The new fragment + /// \returns A new URL with the updated fragment, or an error on validation failure + template + requires is_u8_convertible + [[nodiscard]] auto with_fragment(const Source& fragment) const -> std::expected { + return with_hash(fragment); + } + + /// Alias for with_hash() + /// + /// \param fragment The new fragment + /// \returns A new URL with the updated fragment, or an error on validation failure + [[nodiscard]] auto with_fragment(string_view fragment) const -> std::expected { + return with_hash(fragment); + } + + /// Returns a copy of this URL with the username changed + /// + /// \tparam Source The input string type + /// \param username The new username + /// \returns A new URL with the updated username, or an error on validation failure + template + requires is_u8_convertible + [[nodiscard]] auto with_username(const Source& username) const -> std::expected { + auto bytes = details::to_u8(username); + if (!bytes) { + return std::unexpected(make_error_code(url_parse_errc::invalid_unicode_character)); + } + return with_username(std::string_view(bytes.value())); + } + + /// Returns a copy of this URL with the username changed + /// + /// \param username The new username + /// \returns A new URL with the updated username, or an error on validation failure + [[nodiscard]] auto with_username(string_view username) const -> std::expected { + auto result = *this; + if (auto ec = result.set_username(username)) { + return std::unexpected(ec); + } + return result; + } + + /// Returns a copy of this URL with the password changed + /// + /// \tparam Source The input string type + /// \param password The new password + /// \returns A new URL with the updated password, or an error on validation failure + template + requires is_u8_convertible + [[nodiscard]] auto with_password(const Source& password) const -> std::expected { + auto bytes = details::to_u8(password); + if (!bytes) { + return std::unexpected(make_error_code(url_parse_errc::invalid_unicode_character)); + } + return with_password(std::string_view(bytes.value())); + } + + /// Returns a copy of this URL with the password changed + /// + /// \param password The new password + /// \returns A new URL with the updated password, or an error on validation failure + [[nodiscard]] auto with_password(string_view password) const -> std::expected { + auto result = *this; + if (auto ec = result.set_password(password)) { + return std::unexpected(ec); + } + return result; + } + + /// Returns a copy of this URL with the host (hostname + port) changed + /// + /// \tparam Source The input string type + /// \param host The new host (can include port like "example.com:8080") + /// \returns A new URL with the updated host, or an error on validation failure + template + requires is_u8_convertible + [[nodiscard]] auto with_host(const Source& host) const -> std::expected { + auto bytes = details::to_u8(host); + if (!bytes) { + return std::unexpected(make_error_code(url_parse_errc::invalid_unicode_character)); + } + return with_host(std::string_view(bytes.value())); + } + + /// Returns a copy of this URL with the host (hostname + port) changed + /// + /// \param host The new host (can include port like "example.com:8080") + /// \returns A new URL with the updated host, or an error on validation failure + [[nodiscard]] auto with_host(string_view host) const -> std::expected { + auto result = *this; + if (auto ec = result.set_host(host)) { + return std::unexpected(ec); + } + return result; + } + /// Returns the underlying byte buffer /// /// \returns `href_.c_str()` @@ -1067,7 +1366,7 @@ namespace literals { /// \param str /// \param length /// \return A url -inline auto operator"" _url(const char* str, std::size_t length) { +inline auto operator""_url(const char* str, std::size_t length) { return url(std::string_view(str, length)); } @@ -1075,15 +1374,15 @@ inline auto operator"" _url(const char* str, std::size_t length) { ///// \param str ///// \param length ///// \return -// inline auto operator "" _url(const wchar_t *str, std::size_t length) { -// return url(std::wstring_view(str, length)); -//} +inline auto operator""_url(const wchar_t* str, std::size_t length) { + return url(std::wstring_view(str, length)); +} /// /// \param str /// \param length /// \return -inline auto operator"" _url(const char16_t* str, std::size_t length) { +inline auto operator""_url(const char16_t* str, std::size_t length) { return url(std::u16string_view(str, length)); } @@ -1091,7 +1390,7 @@ inline auto operator"" _url(const char16_t* str, std::size_t length) { /// \param str /// \param length /// \return -inline auto operator"" _url(const char32_t* str, std::size_t length) { +inline auto operator""_url(const char32_t* str, std::size_t length) { return url(std::u32string_view(str, length)); } } // namespace literals diff --git a/tests/skyr/url/CMakeLists.txt b/tests/skyr/url/CMakeLists.txt index f10e5f9a..88cdb7fb 100644 --- a/tests/skyr/url/CMakeLists.txt +++ b/tests/skyr/url/CMakeLists.txt @@ -10,6 +10,7 @@ foreach (file_name url_search_parameters_tests.cpp url_sanitize_tests.cpp url_format_tests.cpp + url_with_methods_tests.cpp wpt_conformance_tests.cpp ) skyr_create_test(${file_name} ${PROJECT_BINARY_DIR}/tests/url test_name) diff --git a/tests/skyr/url/url_with_methods_tests.cpp b/tests/skyr/url/url_with_methods_tests.cpp new file mode 100644 index 00000000..31bf5f13 --- /dev/null +++ b/tests/skyr/url/url_with_methods_tests.cpp @@ -0,0 +1,462 @@ +// Copyright 2025 Glyn Matthews. +// Distributed under the Boost Software License, Version 1.0. +// (See accompanying file LICENSE_1_0.txt of copy at +// http://www.boost.org/LICENSE_1_0.txt) + +#include + +#include + +#include + +TEST_CASE("url_with_methods_tests", "[url][with_methods]") { + using namespace std::string_literals; + + // Basic Functionality Tests + + SECTION("with_scheme_success") { + auto url = skyr::url("http://example.com/path"); + auto result = url.with_scheme("https"); + + REQUIRE(result.has_value()); + CHECK(result->scheme() == "https"); + CHECK(result->href() == "https://example.com/path"); + CHECK(url.scheme() == "http"); // Original unchanged + } + + SECTION("with_hostname_success") { + auto url = skyr::url("http://example.com:8080/path"); + auto result = url.with_hostname("newhost.com"); + + REQUIRE(result.has_value()); + CHECK(result->hostname() == "newhost.com"); + CHECK(result->port() == "8080"); // Port preserved + CHECK(result->href() == "http://newhost.com:8080/path"); + } + + SECTION("with_port_integer") { + auto url = skyr::url("http://example.com/"); + auto result = url.with_port(8080); + + REQUIRE(result.has_value()); + CHECK(result->port() == "8080"); + CHECK(result->href() == "http://example.com:8080/"); + } + + SECTION("with_port_string") { + auto url = skyr::url("http://example.com/"); + auto result = url.with_port("9000"); + + REQUIRE(result.has_value()); + CHECK(result->port() == "9000"); + } + + SECTION("with_port_clear") { + auto url = skyr::url("http://example.com:8080/"); + auto result = url.with_port(""); + + REQUIRE(result.has_value()); + CHECK(result->port().empty()); + CHECK(result->href() == "http://example.com/"); + } + + SECTION("with_pathname_success") { + auto url = skyr::url("http://example.com/old/path"); + auto result = url.with_pathname("/new/path"); + + REQUIRE(result.has_value()); + CHECK(result->pathname() == "/new/path"); + CHECK(result->href() == "http://example.com/new/path"); + } + + SECTION("with_search_with_question_mark") { + auto url = skyr::url("http://example.com/path"); + auto result = url.with_search("?foo=bar"); + + REQUIRE(result.has_value()); + CHECK(result->search() == "?foo=bar"); + } + + SECTION("with_search_without_question_mark") { + auto url = skyr::url("http://example.com/path"); + auto result = url.with_search("foo=bar"); + + REQUIRE(result.has_value()); + CHECK(result->search() == "?foo=bar"); + } + + SECTION("with_hash_with_hash_mark") { + auto url = skyr::url("http://example.com/path"); + auto result = url.with_hash("#section"); + + REQUIRE(result.has_value()); + CHECK(result->hash() == "#section"); + } + + SECTION("with_hash_without_hash_mark") { + auto url = skyr::url("http://example.com/path"); + auto result = url.with_hash("section"); + + REQUIRE(result.has_value()); + CHECK(result->hash() == "#section"); + } + + SECTION("with_username_success") { + auto url = skyr::url("http://example.com/"); + auto result = url.with_username("user"); + + REQUIRE(result.has_value()); + CHECK(result->username() == "user"); + CHECK(result->href() == "http://user@example.com/"); + } + + SECTION("with_password_success") { + auto url = skyr::url("http://user@example.com/"); + auto result = url.with_password("pass"); + + REQUIRE(result.has_value()); + CHECK(result->password() == "pass"); + CHECK(result->href() == "http://user:pass@example.com/"); + } + + SECTION("with_host_success") { + auto url = skyr::url("http://example.com/path"); + auto result = url.with_host("newhost.com:9000"); + + REQUIRE(result.has_value()); + CHECK(result->hostname() == "newhost.com"); + CHECK(result->port() == "9000"); + CHECK(result->href() == "http://newhost.com:9000/path"); + } + + // Error Handling Tests + + SECTION("with_scheme_invalid_transition") { + auto url = skyr::url("http://example.com/"); + auto result = url.with_scheme("mailto"); + + CHECK_FALSE(result.has_value()); + } + + SECTION("with_hostname_cannot_be_base") { + auto url = skyr::url("mailto:user@example.com"); + auto result = url.with_hostname("other.com"); + + CHECK_FALSE(result.has_value()); + } + + SECTION("with_port_invalid_number") { + auto url = skyr::url("http://example.com/"); + auto result = url.with_port("99999"); + + CHECK_FALSE(result.has_value()); + } + + SECTION("with_port_on_file_scheme") { + auto url = skyr::url("file:///path/to/file"); + auto result = url.with_port(8080); + + CHECK_FALSE(result.has_value()); + } + + SECTION("with_username_on_file_scheme") { + auto url = skyr::url("file:///path/to/file"); + auto result = url.with_username("user"); + + CHECK_FALSE(result.has_value()); + } + + SECTION("with_password_on_file_scheme") { + auto url = skyr::url("file:///path/to/file"); + auto result = url.with_password("pass"); + + CHECK_FALSE(result.has_value()); + } + + // Immutability Tests + + SECTION("with_hostname_is_immutable") { + auto url = skyr::url("http://example.com/path"); + auto result = url.with_hostname("other.com"); + + CHECK(url.hostname() == "example.com"); // Original unchanged + REQUIRE(result.has_value()); + CHECK(result->hostname() == "other.com"); + } + + SECTION("with_port_is_immutable") { + auto url = skyr::url("http://example.com:8080/"); + auto result = url.with_port(9000); + + CHECK(url.port() == "8080"); + REQUIRE(result.has_value()); + CHECK(result->port() == "9000"); + } + + SECTION("with_pathname_is_immutable") { + auto url = skyr::url("http://example.com/old"); + auto result = url.with_pathname("/new"); + + CHECK(url.pathname() == "/old"); + REQUIRE(result.has_value()); + CHECK(result->pathname() == "/new"); + } + + SECTION("with_search_is_immutable") { + auto url = skyr::url("http://example.com/?old=1"); + auto result = url.with_search("new=2"); + + CHECK(url.search() == "?old=1"); + REQUIRE(result.has_value()); + CHECK(result->search() == "?new=2"); + } + + SECTION("with_hash_is_immutable") { + auto url = skyr::url("http://example.com/#old"); + auto result = url.with_hash("new"); + + CHECK(url.hash() == "#old"); + REQUIRE(result.has_value()); + CHECK(result->hash() == "#new"); + } + + // Method Chaining Tests + + SECTION("chain_with_and_then") { + auto url = skyr::url("http://example.com/"); + + auto result = + url.with_hostname("newhost.com").and_then([](auto&& u) { return u.with_port(8080); }).and_then([](auto&& u) { + return u.with_pathname("/api/v1"); + }); + + REQUIRE(result.has_value()); + CHECK(result->href() == "http://newhost.com:8080/api/v1"); + } + + SECTION("chain_stops_on_first_error") { + auto url = skyr::url("http://example.com/"); + + auto result = url.with_port("99999") // Port out of range fails + .and_then([](auto&& u) { return u.with_hostname("other.com"); }); + + CHECK_FALSE(result.has_value()); + } + + SECTION("chain_with_transform") { + auto url = skyr::url("http://example.com/"); + + auto result = url.with_hostname("api.example.com").transform([](auto&& u) { return u.href(); }); + + REQUIRE(result.has_value()); + CHECK(result.value() == "http://api.example.com/"); + } + + SECTION("chain_multiple_components") { + auto url = skyr::url("http://localhost:3000/"); + + auto result = url.with_scheme("https") + .and_then([](auto&& u) { return u.with_hostname("api.production.com"); }) + .and_then([](auto&& u) { return u.with_port(8443); }) + .and_then([](auto&& u) { return u.with_pathname("/v2/users"); }) + .and_then([](auto&& u) { return u.with_search("limit=100"); }); + + REQUIRE(result.has_value()); + CHECK(result->href() == "https://api.production.com:8443/v2/users?limit=100"); + } + + // Integration with Existing Immutable Methods + + SECTION("combine_with_sanitize") { + auto url = skyr::url("http://user:pass@example.com:8080/path#fragment"); + + auto result = url.sanitize().with_port(9000); + + REQUIRE(result.has_value()); + CHECK(result->username().empty()); + CHECK(result->password().empty()); + CHECK(result->hash().empty()); + CHECK(result->port() == "9000"); + CHECK(result->href() == "http://example.com:9000/path"); + } + + SECTION("combine_with_without_query") { + auto url = skyr::url("http://example.com/path?foo=bar#fragment"); + + auto result = url.without_query().with_hash("newsection"); + + REQUIRE(result.has_value()); + CHECK(result->search().empty()); + CHECK(result->hash() == "#newsection"); + CHECK(result->href() == "http://example.com/path#newsection"); + } + + SECTION("combine_with_without_fragment") { + auto url = skyr::url("http://example.com/path?query=1#fragment"); + + auto result = url.without_fragment().with_pathname("/new"); + + REQUIRE(result.has_value()); + CHECK(result->hash().empty()); + CHECK(result->pathname() == "/new"); + CHECK(result->search() == "?query=1"); + } + + SECTION("complex_transformation_chain") { + auto url = skyr::url("http://user:pass@example.com:8080/old/path?debug=true&id=123#section"); + + auto result = url.sanitize() // Remove credentials & fragment + .without_params({"debug"}) // Remove debug param + .with_pathname("/api/v2/data") + .and_then([](auto&& u) { return u.with_search("format=json&id=123"); }); + + REQUIRE(result.has_value()); + CHECK(result->username().empty()); + CHECK(result->password().empty()); + CHECK(result->hash().empty()); + CHECK(result->pathname() == "/api/v2/data"); + CHECK(result->search() == "?format=json&id=123"); + } + + // Alias Tests + + SECTION("with_query_alias") { + auto url = skyr::url("http://example.com/"); + auto result1 = url.with_search("foo=bar"); + auto result2 = url.with_query("foo=bar"); + + REQUIRE(result1.has_value()); + REQUIRE(result2.has_value()); + CHECK(result1->href() == result2->href()); + } + + SECTION("with_fragment_alias") { + auto url = skyr::url("http://example.com/"); + auto result1 = url.with_hash("section"); + auto result2 = url.with_fragment("section"); + + REQUIRE(result1.has_value()); + REQUIRE(result2.has_value()); + CHECK(result1->href() == result2->href()); + } + + // Unicode Support Tests + + SECTION("with_hostname_utf8") { + auto url = skyr::url("http://example.com/"); + auto result = url.with_hostname(u8"münchen.de"); + + REQUIRE(result.has_value()); + // Should be punycoded + CHECK(result->hostname() == "xn--mnchen-3ya.de"); + } + + SECTION("with_search_utf8") { + auto url = skyr::url("http://example.com/"); + auto result = url.with_search(u8"query=café"); + + REQUIRE(result.has_value()); + // Should be percent-encoded + CHECK(result->search() == "?query=caf%C3%A9"); + } + + SECTION("with_pathname_utf8") { + auto url = skyr::url("http://example.com/"); + auto result = url.with_pathname(u8"/path/café"); + + REQUIRE(result.has_value()); + CHECK(result->pathname() == "/path/caf%C3%A9"); + } + + SECTION("with_username_utf8") { + auto url = skyr::url("http://example.com/"); + auto result = url.with_username(u8"usér"); + + REQUIRE(result.has_value()); + CHECK(result->username() == "us%C3%A9r"); + } + + // Edge Cases + + SECTION("with_search_clear") { + auto url = skyr::url("http://example.com/path?foo=bar"); + auto result = url.with_search(""); + + REQUIRE(result.has_value()); + CHECK(result->search().empty()); + CHECK(result->href() == "http://example.com/path"); + } + + SECTION("with_hash_clear") { + auto url = skyr::url("http://example.com/path#section"); + auto result = url.with_hash(""); + + REQUIRE(result.has_value()); + CHECK(result->hash().empty()); + CHECK(result->href() == "http://example.com/path"); + } + + SECTION("with_pathname_empty") { + auto url = skyr::url("http://example.com/path"); + auto result = url.with_pathname(""); + + REQUIRE(result.has_value()); + CHECK(result->pathname() == "/"); + } + + SECTION("with_username_clear") { + auto url = skyr::url("http://user@example.com/"); + auto result = url.with_username(""); + + REQUIRE(result.has_value()); + CHECK(result->username().empty()); + CHECK(result->href() == "http://example.com/"); + } + + SECTION("with_password_clear") { + auto url = skyr::url("http://user:pass@example.com/"); + auto result = url.with_password(""); + + REQUIRE(result.has_value()); + CHECK(result->password().empty()); + CHECK(result->href() == "http://user@example.com/"); + } + + // Error Recovery Pattern + + SECTION("error_recovery_with_or_else") { + auto url = skyr::url("http://example.com/"); + + auto result = url.with_port("99999") // Port out of range will fail + .or_else([&url](auto&& error) -> std::expected { + return url.with_port(8080); // Fallback to default + }); + + REQUIRE(result.has_value()); + CHECK(result->port() == "8080"); + CHECK(result->href() == "http://example.com:8080/"); + } + + // Real-world Use Cases + + SECTION("build_api_url") { + auto base_url = skyr::url("https://api.example.com"); + + auto api_url = + base_url.with_pathname("/v1/users").and_then([](auto&& u) { return u.with_search("page=2&limit=50"); }); + + REQUIRE(api_url.has_value()); + CHECK(api_url->href() == "https://api.example.com/v1/users?page=2&limit=50"); + } + + SECTION("switch_environment") { + auto dev_url = skyr::url("http://localhost:3000/api/users"); + + auto prod_url = dev_url.with_scheme("https") + .and_then([](auto&& u) { return u.with_hostname("api.production.com"); }) + .and_then([](auto&& u) { return u.with_port(""); }); // Clear non-default port + + REQUIRE(prod_url.has_value()); + CHECK(prod_url->href() == "https://api.production.com/api/users"); + } +} From 163c49d789d0f22ca685973bcb11087bf0252bf5 Mon Sep 17 00:00:00 2001 From: Glyn Matthews Date: Sat, 3 Jan 2026 10:11:17 +0100 Subject: [PATCH 2/6] Update Doxygen documentation --- docs/Doxyfile.in | 1297 +++++++++++------ docs/conf.py.in | 2 +- docs/core.rst | 39 +- docs/domain.rst | 12 +- docs/filesystem.rst | 4 +- docs/index.rst | 71 +- docs/network.rst | 4 +- docs/percent_encoding.rst | 4 +- docs/url.rst | 75 +- include/skyr/core/host.hpp | 2 +- include/skyr/domain/domain.hpp | 11 +- include/skyr/domain/punycode.hpp | 1 + include/skyr/network/ipv4_address.hpp | 1 + include/skyr/network/ipv6_address.hpp | 1 + .../percent_encoding/percent_decode_range.hpp | 2 +- include/skyr/url.hpp | 2 +- 16 files changed, 1006 insertions(+), 522 deletions(-) diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in index d4278a3d..23911191 100644 --- a/docs/Doxyfile.in +++ b/docs/Doxyfile.in @@ -1,7 +1,7 @@ -# Doxyfile 1.8.17 +# Doxyfile 1.15.0 # This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. +# 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. @@ -12,6 +12,16 @@ # 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 @@ -41,7 +51,7 @@ PROJECT_NAME = "Skyr URL" PROJECT_NUMBER = @skyr-url_VERSION@ # 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 +# for a project that appears at the top of each page and should give viewers a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = @@ -53,24 +63,42 @@ PROJECT_BRIEF = 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 +# entered, it will be relative to the location where Doxygen was started. If # left blank the current directory will be used. OUTPUT_DIRECTORY = -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. +# 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 cause +# 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 -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# 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. @@ -79,36 +107,28 @@ CREATE_SUBDIRS = 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 +# documentation generated by Doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. +# 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 -# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all generated output in the proper direction. -# Possible values are: None, LTR, RTL and Context. -# The default value is: None. - -OUTPUT_TEXT_DIRECTION = None - -# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# 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 +# 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 @@ -139,13 +159,13 @@ ABBREVIATE_BRIEF = "The $name class" \ 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 +# 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 +# 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. @@ -153,7 +173,7 @@ ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# 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. @@ -163,11 +183,11 @@ 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 +# 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. +# 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 = @@ -181,41 +201,42 @@ STRIP_FROM_PATH = 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 +# If the SHORT_NAMES tag is set to YES, Doxygen will generate much shorter (but +# less readable) file names. This can be useful if your file system 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.) +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen will interpret the +# first line (until the first dot, question mark or exclamation mark) 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 +# 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. +# 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.) +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will interpret the first +# line (until the first dot, question mark or exclamation mark) 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 +# 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 @@ -227,13 +248,21 @@ QT_AUTOBRIEF = 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 +# 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. @@ -250,25 +279,19 @@ TAB_SIZE = 4 # the documentation. An alias has the form: # name=value # For example adding -# "sideeffect=@par Side Effects:\n" +# "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:". You can put \n's in the value part of an alias to insert -# newlines (in the resulting output). You can put ^^ in the value part of an -# alias to insert a newline as if a physical newline was in the original file. -# When you need a literal { or } or , in the value part of an alias you have to -# escape them by means of a backslash (\), this can lead to conflicts with the -# commands \{ and \} for these it is advised to use the version @{ and @} or use -# a double escape (\\{ and \\}) +# "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 = -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. - -TCL_SUBST = - # 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 @@ -309,55 +332,92 @@ OPTIMIZE_OUTPUT_SLICE = NO # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, -# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, -# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# 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), VHDL, tcl. 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. +# 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. +# 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 +# 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 +# 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 +# If the MARKDOWN_STRICT tag is enabled then Doxygen treats text in comments as +# Markdown formatted also in cases where Doxygen's native markup format +# conflicts with that of Markdown. This is only relevant in cases where +# backticks are used. Doxygen's native markup style allows a single quote to end +# a text fragment started with a backtick and then treat it as a piece of quoted +# text, whereas in Markdown such text fragment is treated as verbatim and only +# ends when a second matching backtick is found. Also, Doxygen's native markup +# format requires double quotes to be escaped when they appear in a backtick +# section, whereas this is not needed for Markdown. +# The default value is: YES. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_STRICT = 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. +# Minimum value: 0, maximum value: 99, default value: 6. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. TOC_INCLUDE_HEADINGS = 0 -# When enabled doxygen tries to link words that correspond to documented +# 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. +# globally by setting AUTOLINK_SUPPORT to NO. Words listed in the +# AUTOLINK_IGNORE_WORDS tag are excluded from automatic linking. # The default value is: YES. AUTOLINK_SUPPORT = YES +# This tag specifies a list of words that, when matching the start of a word in +# the documentation, will suppress auto links generation, if it is enabled via +# AUTOLINK_SUPPORT. This list does not affect links explicitly created using \# +# or the \link or commands. +# This tag requires that the tag AUTOLINK_SUPPORT is set to YES. + +AUTOLINK_IGNORE_WORDS = + # 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 +# 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. +# versus func(std::string) {}). This also makes the inheritance and +# collaboration diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = YES @@ -369,16 +429,16 @@ BUILTIN_STL_SUPPORT = YES 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. +# https://www.riverbankcomputing.com/software) sources only. Doxygen will parse +# them like normal C++ but will assume all classes use public instead of private +# inheritance when no explicit protection keyword is present. # The default value is: NO. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. +# 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. @@ -387,7 +447,7 @@ SIP_SUPPORT = NO 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 +# 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. @@ -445,21 +505,42 @@ 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 +# 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 +# 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: 512, 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 +# 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. @@ -518,7 +599,14 @@ EXTRACT_LOCAL_METHODS = NO EXTRACT_ANON_NSPACES = NO -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# 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. @@ -526,22 +614,31 @@ EXTRACT_ANON_NSPACES = NO HIDE_UNDOC_MEMBERS = NO -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO, these classes will be included in the various overviews. This option -# has no effect if EXTRACT_ALL is enabled. +# 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 +# If the HIDE_UNDOC_NAMESPACES tag is set to YES, Doxygen will hide all +# undocumented namespaces that are normally visible in the namespace hierarchy. +# If set to NO, these namespaces will be included in the various overviews. This +# option has no effect if EXTRACT_ALL is enabled. +# The default value is: YES. + +HIDE_UNDOC_NAMESPACES = YES + +# 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 +# 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. @@ -555,30 +652,44 @@ HIDE_IN_BODY_DOCS = NO INTERNAL_DOCS = NO -# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file -# names in lower-case letters. If set to YES, upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# (including Cygwin) ands Mac users are advised to set this option to NO. -# The default value is: system dependent. +# 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 = NO -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# 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 +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then Doxygen will # append additional text to a page's title, such as Class Reference. If set to # YES the compound reference will be hidden. # The default value is: NO. HIDE_COMPOUND_REFERENCE= NO -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# 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. @@ -591,7 +702,7 @@ SHOW_INCLUDE_FILES = YES SHOW_GROUPED_MEMB_INC = NO -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# 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. @@ -603,14 +714,14 @@ FORCE_LOCAL_INCLUDES = NO INLINE_INFO = YES -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# 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 +# 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. @@ -618,7 +729,7 @@ SORT_MEMBER_DOCS = YES SORT_BRIEF_DOCS = NO -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# 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. @@ -630,7 +741,7 @@ SORT_BRIEF_DOCS = NO SORT_MEMBERS_CTORS_1ST = NO -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# 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. @@ -647,11 +758,11 @@ SORT_GROUP_NAMES = NO SORT_BY_SCOPE_NAME = NO -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# 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 +# 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. @@ -721,24 +832,25 @@ SHOW_FILES = 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 +# 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 +# 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 +# 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 +# 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. +# 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 +# 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 = @@ -753,19 +865,35 @@ LAYOUT_FILE = CITE_BIB_FILES = +# The EXTERNAL_TOOL_PATH tag can be used to extend the search path (PATH +# environment variable) so that external tools such as latex and gs can be +# found. +# Note: Directories specified with EXTERNAL_TOOL_PATH are added in front of the +# path already specified by the PATH variable, and are added in the order +# specified. +# Note: This option is particularly useful for macOS version 14 (Sonoma) and +# higher, when running Doxygen from Doxywizard, because in this case any user- +# defined changes to the PATH are ignored. A typical example on macOS is to set +# EXTERNAL_TOOL_PATH = /Library/TeX/texbin /usr/local/bin +# together with the standard path, the full search path used by doxygen when +# launching external tools will then become +# PATH=/Library/TeX/texbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin + +EXTERNAL_TOOL_PATH = + #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the +# 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 +# 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. @@ -773,49 +901,97 @@ QUIET = NO WARNINGS = YES -# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# 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 = NO -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. +# 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 or incomplete -# parameter documentation, but not about the absence of documentation. If -# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# 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 the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when -# a warning is encountered. +# 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 WARN_LAYOUT_FILE option is set to YES, Doxygen will warn about issues found +# while parsing the user defined layout file, such as missing or wrong elements. +# See also LAYOUT_FILE for details. If set to NO, problems with the layout file +# will be suppressed. +# The default value is: YES. + +WARN_LAYOUT_FILE = YES + +# 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 +# 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). +# 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 = @@ -838,29 +1014,42 @@ INPUT = @PROJECT_SOURCE_DIR@/include/skyr/ \ @PROJECT_SOURCE_DIR@/include/skyr/json/ # 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 +# 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. +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING # The default value is: UTF-8. INPUT_ENCODING = UTF-8 +# This tag can be used to specify the character encoding of the source files +# that Doxygen parses. The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). +# See also: INPUT_ENCODING for further information on supported encodings. + +INPUT_FILE_ENCODING = + # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not -# read by doxygen. +# read by Doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. # -# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, -# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, -# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, -# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), -# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen -# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd, -# *.vhdl, *.ucf, *.qsf and *.ice. +# 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++, *.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 \ @@ -917,7 +1106,7 @@ RECURSIVE = NO # 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 +# Note that relative paths are relative to the directory from which Doxygen is # run. EXCLUDE = @@ -942,10 +1131,7 @@ EXCLUDE_PATTERNS = # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* +# ANamespace::AClass, ANamespace::*Test EXCLUDE_SYMBOLS = @@ -975,7 +1161,7 @@ EXAMPLE_RECURSIVE = NO IMAGE_PATH = -# The INPUT_FILTER tag can be used to specify a program that doxygen should +# 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: # @@ -990,9 +1176,14 @@ IMAGE_PATH = # 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. +# properly processed by Doxygen. INPUT_FILTER = @@ -1005,7 +1196,7 @@ INPUT_FILTER = # # 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. +# properly processed by Doxygen. FILTER_PATTERNS = @@ -1027,10 +1218,28 @@ 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. +# and want to reuse the introduction page also for the Doxygen output. USE_MDFILE_AS_MAINPAGE = +# If the IMPLICIT_DIR_DOCS tag is set to YES, any README.md file found in sub- +# directories of the project's root, is used as the documentation for that sub- +# directory, except when the README.md starts with a \dir, \page or \mainpage +# command. If set to NO, the README.md file needs to start with an explicit \dir +# command in order to be used as directory documentation. +# The default value is: YES. + +IMPLICIT_DIR_DOCS = YES + +# 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 #--------------------------------------------------------------------------- @@ -1045,12 +1254,13 @@ USE_MDFILE_AS_MAINPAGE = SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. +# 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 +# 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. @@ -1088,7 +1298,7 @@ REFERENCES_LINK_SOURCE = 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 +# 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. @@ -1102,14 +1312,14 @@ SOURCE_TOOLTIPS = YES # 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 +# 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 +# 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. @@ -1128,17 +1338,11 @@ VERBATIM_HEADERS = YES ALPHABETICAL_INDEX = YES -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. +# 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 = @@ -1147,7 +1351,7 @@ IGNORE_PREFIX = # Configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# If the GENERATE_HTML tag is set to YES, Doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = NO @@ -1168,40 +1372,40 @@ HTML_OUTPUT = html 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 +# 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. +# 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 +# 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 +# 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 +# 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. +# 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. +# 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. +# 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. @@ -1211,13 +1415,18 @@ 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. +# created by Doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefore more robust against future updates. # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. +# 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 = @@ -1232,9 +1441,22 @@ HTML_EXTRA_STYLESHEET = 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 generates light mode output, DARK always +# generates dark mode output, AUTO_LIGHT automatically sets the mode according +# to the user preference, uses light mode if no preference is set (the default), +# AUTO_DARK automatically sets the mode according to the user preference, uses +# dark mode if no preference is set and TOGGLE allows a user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_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 colorwheel, see +# 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. @@ -1244,7 +1466,7 @@ HTML_EXTRA_FILES = HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A +# 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. @@ -1262,15 +1484,6 @@ HTML_COLORSTYLE_SAT = 100 HTML_COLORSTYLE_GAMMA = 80 -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to YES can help to show when doxygen was last run and thus if the -# documentation is up to date. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = NO - # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML # documentation will contain a main index with vertical navigation menus that # are dynamically created via JavaScript. If disabled, the navigation index will @@ -1290,6 +1503,33 @@ HTML_DYNAMIC_MENUS = 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 @@ -1305,10 +1545,11 @@ 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 +# 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. @@ -1325,6 +1566,13 @@ GENERATE_DOCSET = NO 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. @@ -1347,14 +1595,18 @@ DOCSET_PUBLISHER_ID = org.doxygen.Publisher DOCSET_PUBLISHER_NAME = Publisher -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# If the GENERATE_HTMLHELP tag is set to YES then Doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on -# Windows. +# 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 +# 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 @@ -1374,14 +1626,14 @@ 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. +# 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 master .chm file (NO). +# (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. @@ -1408,6 +1660,16 @@ BINARY_TOC = NO 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 @@ -1426,7 +1688,8 @@ 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). +# (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. @@ -1434,8 +1697,8 @@ 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). +# 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. @@ -1443,16 +1706,16 @@ 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). +# 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). +# 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 = @@ -1464,9 +1727,9 @@ QHP_CUST_FILTER_ATTRS = QHP_SECT_FILTER_ATTRS = -# The QHG_LOCATION tag can be used to specify the location of Qt's -# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the -# generated .qhp file. +# 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 = @@ -1509,18 +1772,39 @@ DISABLE_INDEX = NO # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. +# 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 more details information than the tab index, you +# could consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = NO +# When GENERATE_TREEVIEW is set to YES, the PAGE_OUTLINE_PANEL option determines +# if an additional navigation panel is shown at the right hand side of the +# screen, displaying an outline of the contents of the main page, similar to +# e.g. https://developer.android.com/reference If GENERATE_TREEVIEW is set to +# NO, this option has no effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +PAGE_OUTLINE_PANEL = YES + +# When GENERATE_TREEVIEW is set to YES, 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 e.g. https://docs.readthedocs.io with more room for +# contents, but less room for the project logo, title, and description. If +# GENERATE_TREEVIEW 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. +# 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. @@ -1529,6 +1813,12 @@ GENERATE_TREEVIEW = NO ENUM_VALUES_PER_LINE = 4 +# When the SHOW_ENUM_VALUES tag is set doxygen will show the specified +# enumeration values besides the enumeration mnemonics. +# The default value is: NO. + +SHOW_ENUM_VALUES = NO + # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. @@ -1536,33 +1826,40 @@ ENUM_VALUES_PER_LINE = 4 TREEVIEW_WIDTH = 250 -# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# 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 +# Doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 -# Use the FORMULA_TRANSPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands # to create new LaTeX commands to be used in formulas as building blocks. See # the section "Including formulas" for details. @@ -1580,50 +1877,90 @@ FORMULA_MACROFILE = 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, MathJax_3 and MathJax_4. +# 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. See the MathJax site (see: -# http://docs.mathjax.org/en/latest/output.html) for more details. +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# https://docs.mathjax.org/en/v2.7/output.html), MathJax version 3 (see: +# https://docs.mathjax.org/en/v3.2/output/index.html) and MathJax version 4 +# (see: +# https://docs.mathjax.org/en/v4.0/output/index.htm). # Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for MathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the HTML -# output directory using the MATHJAX_RELPATH option. The destination directory -# should contain the MathJax.js script. For instance, if the mathjax directory -# is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from https://www.mathjax.org before deployment. -# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. +# output directory using the MATHJAX_RELPATH option. For Mathjax version 2 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.s For Mathjax versions 3 +# and 4 the destination directory should contain the tex-.js script +# (where is either chtml or svg). 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 +# - in case of MathJax version 4: https://cdn.jsdelivr.net/npm/mathjax@4 # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/ # 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/tex.html): # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# https://docs.mathjax.org/en/v3.2/input/tex/extensions/): +# MATHJAX_EXTENSIONS = ams +# For example for MathJax version 4 (see +# https://docs.mathjax.org/en/v4.0/input/tex/extensions/): +# MATHJAX_EXTENSIONS = units +# Note that for Mathjax version 4 quite a few extensions are already +# automatically loaded. To disable a package in Mathjax version 4 one can use +# the package name prepended with a minus sign (- like MATHJAX_EXTENSIONS += +# -textmacros) # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an -# example see the documentation. +# 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 +# for more details: +# - MathJax version 2 (see: +# https://docs.mathjax.org/en/v2.7/) +# - MathJax version 3 (see: +# https://docs.mathjax.org/en/v3.2/) +# - MathJax version 4 (see: +# https://docs.mathjax.org/en/v4.0/) 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 +# 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 +# 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 @@ -1642,7 +1979,7 @@ SEARCHENGINE = YES # When the SERVER_BASED_SEARCH tag is enabled the search engine will be # implemented using a web server instead of a web client using JavaScript. There # are two flavors of web server based searching depending on the EXTERNAL_SEARCH -# setting. When disabled, doxygen will generate a PHP script for searching and +# setting. When disabled, Doxygen will generate a PHP script for searching and # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing # and searching needs to be provided by external tools. See the section # "External Indexing and Searching" for details. @@ -1651,7 +1988,7 @@ SEARCHENGINE = YES SERVER_BASED_SEARCH = NO -# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP +# When EXTERNAL_SEARCH tag is enabled Doxygen will no longer generate the PHP # script for searching. Instead the search results are written to an XML file # which needs to be processed by an external indexer. Doxygen will invoke an # external search engine pointed to by the SEARCHENGINE_URL option to obtain the @@ -1659,7 +1996,8 @@ SERVER_BASED_SEARCH = NO # # Doxygen ships with an example indexer (doxyindexer) and search engine # (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: https://xapian.org/). +# Xapian (see: +# https://xapian.org/). # # See the section "External Indexing and Searching" for details. # The default value is: NO. @@ -1672,8 +2010,9 @@ EXTERNAL_SEARCH = NO # # Doxygen ships with an example indexer (doxyindexer) and search engine # (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: https://xapian.org/). See the section "External Indexing and -# Searching" for details. +# Xapian (see: +# https://xapian.org/). See the section "External Indexing and Searching" for +# details. # This tag requires that the tag SEARCHENGINE is set to YES. SEARCHENGINE_URL = @@ -1694,7 +2033,7 @@ SEARCHDATA_FILE = searchdata.xml EXTERNAL_SEARCH_ID = -# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through Doxygen # projects other than the one defined by this configuration file, but that are # all added to the same external search index. Each project needs to have a # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of @@ -1708,7 +2047,7 @@ EXTRA_SEARCH_MAPPINGS = # Configuration options related to the LaTeX output #--------------------------------------------------------------------------- -# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. +# If the GENERATE_LATEX tag is set to YES, Doxygen will generate LaTeX output. # The default value is: YES. GENERATE_LATEX = NO @@ -1753,7 +2092,7 @@ MAKEINDEX_CMD_NAME = makeindex LATEX_MAKEINDEX_CMD = makeindex -# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX +# If the COMPACT_LATEX tag is set to YES, Doxygen generates more compact LaTeX # documents. This may be useful for small projects and may help to save some # trees in general. # The default value is: NO. @@ -1782,36 +2121,38 @@ PAPER_TYPE = a4 EXTRA_PACKAGES = -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the -# generated LaTeX document. The header should contain everything until the first -# chapter. If it is left blank doxygen will generate a standard header. See -# section "Doxygen usage" for information on how to let doxygen write the -# default header to a separate file. +# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for +# the generated LaTeX document. The header should contain everything until the +# first chapter. If it is left blank Doxygen will generate a standard header. It +# is highly recommended to start with a default header using +# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty +# and then modify the file new_header.tex. See also section "Doxygen usage" for +# information on how to generate the default header that Doxygen normally uses. # -# Note: Only use a user-defined header if you know what you are doing! The -# following commands have a special meaning inside the header: $title, -# $datetime, $date, $doxygenversion, $projectname, $projectnumber, -# $projectbrief, $projectlogo. Doxygen will replace $title with the empty -# string, for the replacement values of the other commands the user is referred -# to HTML_HEADER. +# Note: Only use a user-defined header if you know what you are doing! +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of Doxygen. The following +# commands have a special meaning inside the header (and footer): For a +# description of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_HEADER = -# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the -# generated LaTeX document. The footer should contain everything after the last -# chapter. If it is left blank doxygen will generate a standard footer. See +# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for +# the generated LaTeX document. The footer should contain everything after the +# last chapter. If it is left blank Doxygen will generate a standard footer. See # LATEX_HEADER for more information on how to generate a default footer and what -# special commands can be used inside the footer. -# -# Note: Only use a user-defined footer if you know what you are doing! +# 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. Note: Only use a user-defined footer if you know what you are +# doing! # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_FOOTER = # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined # LaTeX style sheets that are included after the standard style sheets created -# by doxygen. Using this option one can overrule certain style aspects. Doxygen +# by Doxygen. Using this option one can overrule certain style aspects. Doxygen # will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the @@ -1837,56 +2178,46 @@ LATEX_EXTRA_FILES = PDF_HYPERLINKS = YES -# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate -# the PDF file directly from the LaTeX files. Set this option to YES, to get a -# higher quality PDF documentation. +# If the USE_PDFLATEX tag is set to YES, Doxygen will use the engine as +# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX +# files. Set this option to YES, to get a higher quality PDF documentation. +# +# See also section LATEX_CMD_NAME for selecting the engine. # The default value is: YES. # This tag requires that the tag GENERATE_LATEX is set to YES. USE_PDFLATEX = YES -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode -# command to the generated LaTeX files. This will instruct LaTeX to keep running -# if errors occur, instead of asking the user for help. This option is also used -# when generating formulas in HTML. +# The LATEX_BATCHMODE tag signals the behavior of LaTeX in case of an error. +# Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch +# mode nothing is printed on the terminal, errors are scrolled as if is +# hit at every error; missing files that TeX tries to input or request from +# keyboard input (\read on a not open input stream) cause the job to abort, +# NON_STOP In nonstop mode the diagnostic message will appear on the terminal, +# but there is no possibility of user interaction just like in batch mode, +# SCROLL In scroll mode, TeX will stop only for missing files to input or if +# keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at +# each error, asking for user intervention. # The default value is: NO. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_BATCHMODE = NO -# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the +# If the LATEX_HIDE_INDICES tag is set to YES then Doxygen will not include the # index chapters (such as File Index, Compound Index, etc.) in the output. # The default value is: NO. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_HIDE_INDICES = NO -# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source -# code with syntax highlighting in the LaTeX output. -# -# Note that which sources are shown also depends on other settings such as -# SOURCE_BROWSER. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_SOURCE_CODE = NO - # The LATEX_BIB_STYLE tag can be used to specify the style to use for the # bibliography, e.g. plainnat, or ieeetr. See # https://en.wikipedia.org/wiki/BibTeX and \cite for more info. -# The default value is: plain. +# The default value is: plainnat. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_BIB_STYLE = plain -# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated -# page will contain the date and time when the page was generated. Setting this -# to NO can help when comparing the output of multiple runs. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_TIMESTAMP = NO - # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) # path from which the emoji images will be read. If a relative path is entered, # it will be relative to the LATEX_OUTPUT directory. If left blank the @@ -1899,7 +2230,7 @@ LATEX_EMOJI_DIRECTORY = # Configuration options related to the RTF output #--------------------------------------------------------------------------- -# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The +# If the GENERATE_RTF tag is set to YES, Doxygen will generate RTF output. The # RTF output is optimized for Word 97 and may not look too pretty with other RTF # readers/editors. # The default value is: NO. @@ -1914,7 +2245,7 @@ GENERATE_RTF = NO RTF_OUTPUT = rtf -# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF +# If the COMPACT_RTF tag is set to YES, Doxygen generates more compact RTF # documents. This may be useful for small projects and may help to save some # trees in general. # The default value is: NO. @@ -1934,38 +2265,36 @@ COMPACT_RTF = NO RTF_HYPERLINKS = NO -# Load stylesheet definitions from file. Syntax is similar to doxygen's +# Load stylesheet definitions from file. Syntax is similar to Doxygen's # configuration file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. # # See also section "Doxygen usage" for information on how to generate the -# default style sheet that doxygen normally uses. +# default style sheet that Doxygen normally uses. # This tag requires that the tag GENERATE_RTF is set to YES. RTF_STYLESHEET_FILE = # Set optional variables used in the generation of an RTF document. Syntax is -# similar to doxygen's configuration file. A template extensions file can be +# similar to Doxygen's configuration file. A template extensions file can be # generated using doxygen -e rtf extensionFile. # This tag requires that the tag GENERATE_RTF is set to YES. RTF_EXTENSIONS_FILE = -# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code -# with syntax highlighting in the RTF output. -# -# Note that which sources are shown also depends on other settings such as -# SOURCE_BROWSER. -# The default value is: NO. +# The RTF_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the RTF_OUTPUT output directory. +# Note that the files will be copied as-is; there are no commands or markers +# available. # This tag requires that the tag GENERATE_RTF is set to YES. -RTF_SOURCE_CODE = NO +RTF_EXTRA_FILES = #--------------------------------------------------------------------------- # Configuration options related to the man page output #--------------------------------------------------------------------------- -# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for +# If the GENERATE_MAN tag is set to YES, Doxygen will generate man pages for # classes and files. # The default value is: NO. @@ -1996,7 +2325,7 @@ MAN_EXTENSION = .3 MAN_SUBDIR = -# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, then it # will generate one additional man file for each entity documented in the real # man page(s). These additional files only source the real man page, but without # them the man command would be unable to find the correct page. @@ -2009,7 +2338,7 @@ MAN_LINKS = NO # Configuration options related to the XML output #--------------------------------------------------------------------------- -# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that +# If the GENERATE_XML tag is set to YES, Doxygen will generate an XML file that # captures the structure of the code including all documentation. # The default value is: NO. @@ -2023,7 +2352,7 @@ GENERATE_XML = YES XML_OUTPUT = xml -# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program +# If the XML_PROGRAMLISTING tag is set to YES, Doxygen will dump the program # listings (including syntax highlighting and cross-referencing information) to # the XML output. Note that enabling this will significantly increase the size # of the XML output. @@ -2032,7 +2361,7 @@ XML_OUTPUT = xml XML_PROGRAMLISTING = YES -# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include +# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, Doxygen will include # namespace members in file scope as well, matching the HTML output. # The default value is: NO. # This tag requires that the tag GENERATE_XML is set to YES. @@ -2043,7 +2372,7 @@ XML_NS_MEMB_FILE_SCOPE = NO # Configuration options related to the DOCBOOK output #--------------------------------------------------------------------------- -# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files +# If the GENERATE_DOCBOOK tag is set to YES, Doxygen will generate Docbook files # that can be used to generate PDF. # The default value is: NO. @@ -2057,32 +2386,49 @@ GENERATE_DOCBOOK = NO DOCBOOK_OUTPUT = docbook -# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the -# program listings (including syntax highlighting and cross-referencing -# information) to the DOCBOOK output. Note that enabling this will significantly -# increase the size of the DOCBOOK output. -# The default value is: NO. -# This tag requires that the tag GENERATE_DOCBOOK is set to YES. - -DOCBOOK_PROGRAMLISTING = NO - #--------------------------------------------------------------------------- # Configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- -# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an -# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures +# If the GENERATE_AUTOGEN_DEF tag is set to YES, Doxygen will generate an +# AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures # the structure of the code including all documentation. Note that this feature # is still experimental and incomplete at the moment. # The default value is: NO. GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# Configuration options related to Sqlite3 output +#--------------------------------------------------------------------------- + +# If the GENERATE_SQLITE3 tag is set to YES Doxygen will generate a Sqlite3 +# database with symbols found by Doxygen stored in tables. +# The default value is: NO. + +GENERATE_SQLITE3 = NO + +# The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database 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: sqlite3. +# This tag requires that the tag GENERATE_SQLITE3 is set to YES. + +SQLITE3_OUTPUT = sqlite3 + +# The SQLITE3_RECREATE_DB tag is set to YES, the existing doxygen_sqlite3.db +# database file will be recreated with each Doxygen run. If set to NO, Doxygen +# will warn if a database file is already found and not modify it. +# The default value is: YES. +# This tag requires that the tag GENERATE_SQLITE3 is set to YES. + +SQLITE3_RECREATE_DB = YES + #--------------------------------------------------------------------------- # Configuration options related to the Perl module output #--------------------------------------------------------------------------- -# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module +# If the GENERATE_PERLMOD tag is set to YES, Doxygen will generate a Perl module # file that captures the structure of the code including all documentation. # # Note that this feature is still experimental and incomplete at the moment. @@ -2090,7 +2436,7 @@ GENERATE_AUTOGEN_DEF = NO GENERATE_PERLMOD = NO -# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary +# If the PERLMOD_LATEX tag is set to YES, Doxygen will generate the necessary # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI # output from the Perl module output. # The default value is: NO. @@ -2120,13 +2466,13 @@ PERLMOD_MAKEVAR_PREFIX = # Configuration options related to the preprocessor #--------------------------------------------------------------------------- -# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all +# If the ENABLE_PREPROCESSING tag is set to YES, Doxygen will evaluate all # C-preprocessor directives found in the sources and include files. # The default value is: YES. ENABLE_PREPROCESSING = YES -# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names +# If the MACRO_EXPANSION tag is set to YES, Doxygen will expand all macro names # in the source code. If set to NO, only conditional compilation will be # performed. Macro expansion can be done in a controlled way by setting # EXPAND_ONLY_PREDEF to YES. @@ -2152,7 +2498,8 @@ SEARCH_INCLUDES = YES # The INCLUDE_PATH tag can be used to specify one or more directories that # contain include files that are not input files but should be processed by the -# preprocessor. +# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of +# RECURSIVE has no effect here. # This tag requires that the tag SEARCH_INCLUDES is set to YES. INCLUDE_PATH = @@ -2184,7 +2531,7 @@ PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS EXPAND_AS_DEFINED = -# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will +# If the SKIP_FUNCTION_MACROS tag is set to YES then Doxygen's preprocessor will # remove all references to function-like macros that are alone on a line, have # an all uppercase name, and do not end with a semicolon. Such function macros # are typically used for boiler-plate code, and will confuse the parser if not @@ -2208,26 +2555,26 @@ SKIP_FUNCTION_MACROS = YES # section "Linking to external documentation" for more information about the use # of tag files. # Note: Each tag file must have a unique name (where the name does NOT include -# the path). If a tag file is not located in the directory in which doxygen is +# the path). If a tag file is not located in the directory in which Doxygen is # run, you must also specify the path to the tagfile here. TAGFILES = -# When a file name is specified after GENERATE_TAGFILE, doxygen will create a +# When a file name is specified after GENERATE_TAGFILE, Doxygen will create a # tag file that is based on the input files it reads. See section "Linking to # external documentation" for more information about the usage of tag files. GENERATE_TAGFILE = -# If the ALLEXTERNALS tag is set to YES, all external class will be listed in -# the class index. If set to NO, only the inherited external classes will be -# listed. +# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces +# will be listed in the class and namespace index. If set to NO, only the +# inherited external classes will be listed. # The default value is: NO. ALLEXTERNALS = NO # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will be +# in the topic index. If set to NO, only the current project's groups will be # listed. # The default value is: YES. @@ -2241,99 +2588,111 @@ EXTERNAL_GROUPS = YES EXTERNAL_PAGES = YES #--------------------------------------------------------------------------- -# Configuration options related to the dot tool +# Configuration options related to diagram generator tools #--------------------------------------------------------------------------- -# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram -# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to -# NO turns the diagrams off. Note that this option also works with HAVE_DOT -# disabled, but it is recommended to install and use dot, since it yields more -# powerful graphs. -# The default value is: YES. - -CLASS_DIAGRAMS = YES - -# You can include diagrams made with dia in doxygen documentation. Doxygen will -# then run dia to produce the diagram and insert it in the documentation. The -# DIA_PATH tag allows you to specify the directory where the dia binary resides. -# If left empty dia is assumed to be found in the default search path. - -DIA_PATH = - # If set to YES the inheritance and collaboration graphs will hide inheritance # and usage relations if the target is undocumented or is not a class. # The default value is: YES. HIDE_UNDOC_RELATIONS = YES -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# If you set the HAVE_DOT tag to YES then Doxygen will assume the dot tool is # available from the path. This tool is part of Graphviz (see: -# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent +# https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent # Bell Labs. The other options in this section have no effect if this option is # set to NO # The default value is: NO. HAVE_DOT = NO -# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed -# to run in parallel. When set to 0 doxygen will base this on the number of +# The DOT_NUM_THREADS specifies the number of dot invocations Doxygen is allowed +# to run in parallel. When set to 0 Doxygen will base this on the number of # processors available in the system. You can set it explicitly to a value # larger than 0 to get control over the balance between CPU load and processing # speed. -# Minimum value: 0, maximum value: 32, default value: 0. +# Minimum value: 0, maximum value: 512, default value: 0. # This tag requires that the tag HAVE_DOT is set to YES. DOT_NUM_THREADS = 0 -# When you want a differently looking font in the dot files that doxygen -# generates you can specify the font name using DOT_FONTNAME. You need to make -# sure dot is able to find the font, which can be done by putting it in a -# standard location or by setting the DOTFONTPATH environment variable or by -# setting DOT_FONTPATH to the directory containing the font. -# The default value is: Helvetica. +# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of +# subgraphs. When you want a differently looking font in the dot files that +# Doxygen generates you can specify fontname, fontcolor and fontsize attributes. +# For details please see Node, +# Edge and Graph Attributes specification You need to make sure dot is able +# to find the font, which can be done by putting it in a standard location or by +# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the +# directory containing the font. Default graphviz fontsize is 14. +# The default value is: fontname=Helvetica,fontsize=10. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_FONTNAME = Helvetica +DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10" -# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of -# dot graphs. -# Minimum value: 4, maximum value: 24, default value: 10. +# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can +# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. Complete documentation about +# arrows shapes. +# The default value is: labelfontname=Helvetica,labelfontsize=10. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_FONTSIZE = 10 +DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10" -# By default doxygen will tell dot to use the default font as specified with -# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set -# the path where dot can find it using this tag. +# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes +# around nodes set 'shape=plain' or 'shape=plaintext' Shapes specification +# The default value is: shape=box,height=0.2,width=0.4. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" + +# You can set the path where dot can find font specified with fontname in +# DOT_COMMON_ATTR and others dot attributes. # This tag requires that the tag HAVE_DOT is set to YES. DOT_FONTPATH = -# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for -# each documented class showing the direct and indirect inheritance relations. -# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. +# If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then Doxygen will +# generate a graph for each documented class showing the direct and indirect +# inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and +# HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case +# the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the +# CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used. +# If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance +# relations will be shown as texts / links. Explicit enabling an inheritance +# graph or choosing a different representation for an inheritance graph of a +# specific class, can be accomplished by means of the command \inheritancegraph. +# Disabling an inheritance graph can be accomplished by means of the command +# \hideinheritancegraph. +# Possible values are: NO, YES, TEXT, GRAPH and BUILTIN. # The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. CLASS_GRAPH = YES -# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a +# If the COLLABORATION_GRAPH tag is set to YES then Doxygen will generate a # graph for each documented class showing the direct and indirect implementation # dependencies (inheritance, containment, and class references variables) of the -# class with other documented classes. +# class with other documented classes. Explicit enabling a collaboration graph, +# when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the +# command \collaborationgraph. Disabling a collaboration graph can be +# accomplished by means of the command \hidecollaborationgraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. COLLABORATION_GRAPH = YES -# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for -# groups, showing the direct groups dependencies. +# If the GROUP_GRAPHS tag is set to YES then Doxygen will generate a graph for +# groups, showing the direct groups dependencies. Explicit enabling a group +# dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means +# of the command \groupgraph. Disabling a directory graph can be accomplished by +# means of the command \hidegroupgraph. See also the chapter Grouping in the +# manual. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. GROUP_GRAPHS = YES -# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and +# If the UML_LOOK tag is set to YES, Doxygen will generate inheritance and # collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. # The default value is: NO. @@ -2350,10 +2709,41 @@ UML_LOOK = NO # but if the number exceeds 15, the total amount of fields shown is limited to # 10. # Minimum value: 0, maximum value: 100, default value: 10. -# This tag requires that the tag HAVE_DOT is set to YES. +# This tag requires that the tag UML_LOOK is set to YES. UML_LIMIT_NUM_FIELDS = 10 +# If the UML_LOOK tag is enabled, field labels are shown along the edge between +# two class nodes. If there are many fields and many nodes the graph may become +# too cluttered. The UML_MAX_EDGE_LABELS threshold limits the number of items to +# make the size more manageable. Set this to 0 for no limit. +# Minimum value: 0, maximum value: 100, default value: 10. +# This tag requires that the tag UML_LOOK is set to YES. + +UML_MAX_EDGE_LABELS = 10 + +# If the DOT_UML_DETAILS tag is set to NO, Doxygen will show attributes and +# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS +# tag is set to YES, Doxygen will add type and arguments for attributes and +# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, Doxygen +# will not generate fields with class member information in the UML graphs. The +# class diagrams will look similar to the default class diagrams but using UML +# notation for the relationships. +# Possible values are: NO, YES and NONE. +# The default value is: NO. +# This tag requires that the tag UML_LOOK is set to YES. + +DOT_UML_DETAILS = NO + +# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters +# to display on a single line. If the actual line length exceeds this threshold +# significantly it will be wrapped across multiple lines. Some heuristics are +# applied to avoid ugly line breaks. +# Minimum value: 0, maximum value: 1000, default value: 17. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_WRAP_THRESHOLD = 17 + # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and # collaboration graphs will show the relations between templates and their # instances. @@ -2363,24 +2753,29 @@ UML_LIMIT_NUM_FIELDS = 10 TEMPLATE_RELATIONS = NO # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to -# YES then doxygen will generate a graph for each documented file showing the +# YES then Doxygen will generate a graph for each documented file showing the # direct and indirect include dependencies of the file with other documented -# files. +# files. Explicit enabling an include graph, when INCLUDE_GRAPH is is set to NO, +# can be accomplished by means of the command \includegraph. Disabling an +# include graph can be accomplished by means of the command \hideincludegraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. INCLUDE_GRAPH = YES # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are -# set to YES then doxygen will generate a graph for each documented file showing +# set to YES then Doxygen will generate a graph for each documented file showing # the direct and indirect include dependencies of the file with other documented -# files. +# files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set +# to NO, can be accomplished by means of the command \includedbygraph. Disabling +# an included by graph can be accomplished by means of the command +# \hideincludedbygraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. INCLUDED_BY_GRAPH = YES -# If the CALL_GRAPH tag is set to YES then doxygen will generate a call +# If the CALL_GRAPH tag is set to YES then Doxygen will generate a call # dependency graph for every global function or class method. # # Note that enabling this option will significantly increase the time of a run. @@ -2392,7 +2787,7 @@ INCLUDED_BY_GRAPH = YES CALL_GRAPH = NO -# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller +# If the CALLER_GRAPH tag is set to YES then Doxygen will generate a caller # dependency graph for every global function or class method. # # Note that enabling this option will significantly increase the time of a run. @@ -2404,44 +2799,59 @@ CALL_GRAPH = NO CALLER_GRAPH = NO -# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical +# If the GRAPHICAL_HIERARCHY tag is set to YES then Doxygen will graphical # hierarchy of all classes instead of a textual one. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. GRAPHICAL_HIERARCHY = YES -# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the +# If the DIRECTORY_GRAPH tag is set to YES then Doxygen will show the # dependencies a directory has on other directories in a graphical way. The # dependency relations are determined by the #include relations between the -# files in the directories. +# files in the directories. Explicit enabling a directory graph, when +# DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command +# \directorygraph. Disabling a directory graph can be accomplished by means of +# the command \hidedirectorygraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. DIRECTORY_GRAPH = YES +# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels +# of child directories generated in directory dependency graphs by dot. +# Minimum value: 1, maximum value: 25, default value: 1. +# This tag requires that the tag DIRECTORY_GRAPH is set to YES. + +DIR_GRAPH_MAX_DEPTH = 1 + # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. For an explanation of the image formats see the section # output formats in the documentation of the dot tool (Graphviz (see: -# http://www.graphviz.org/)). -# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order -# to make the SVG files visible in IE 9+ (other browsers do not have this -# requirement). +# https://www.graphviz.org/)). +# +# Note the formats svg:cairo and svg:cairo:cairo cannot be used in combination +# with INTERACTIVE_SVG (the INTERACTIVE_SVG will be set to NO). # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, -# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and -# png:gdiplus:gdiplus. +# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus, +# png:gdiplus:gdiplus, svg:cairo, svg:cairo:cairo, svg:svg, svg:svg:core, +# gif:cairo, gif:cairo:gd, gif:cairo:gdiplus, gif:gdiplus, gif:gdiplus:gdiplus, +# gif:gd, gif:gd:gd, jpg:cairo, jpg:cairo:gd, jpg:cairo:gdiplus, jpg:gd, +# jpg:gd:gd, jpg:gdiplus and jpg:gdiplus:gdiplus. # The default value is: png. # This tag requires that the tag HAVE_DOT is set to YES. DOT_IMAGE_FORMAT = png -# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to -# enable generation of interactive SVG images that allow zooming and panning. +# If DOT_IMAGE_FORMAT is set to svg or svg:svg or svg:svg:core, then this option +# can be set to YES to enable generation of interactive SVG images that allow +# zooming and panning. # # Note that this requires a modern browser other than Internet Explorer. Tested # and working are Firefox, Chrome, Safari, and Opera. -# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make -# the SVG files visible. Older versions of IE do not have SVG support. +# +# Note This option will be automatically disabled when DOT_IMAGE_FORMAT is set +# to svg:cairo or svg:cairo:cairo. # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2460,11 +2870,12 @@ DOT_PATH = DOTFILE_DIRS = -# The MSCFILE_DIRS tag can be used to specify one or more directories that -# contain msc files that are included in the documentation (see the \mscfile -# command). +# You can include diagrams made with dia in Doxygen documentation. Doxygen will +# then run dia to produce the diagram and insert it in the documentation. The +# DIA_PATH tag allows you to specify the directory where the dia binary resides. +# If left empty dia is assumed to be found in the default search path. -MSCFILE_DIRS = +DIA_PATH = # The DIAFILE_DIRS tag can be used to specify one or more directories that # contain dia files that are included in the documentation (see the \diafile @@ -2472,28 +2883,34 @@ MSCFILE_DIRS = DIAFILE_DIRS = -# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the -# path where java can find the plantuml.jar file. If left blank, it is assumed -# PlantUML is not used or called during a preprocessing step. Doxygen will -# generate a warning when it encounters a \startuml command in this case and -# will not generate output for the diagram. +# When using PlantUML, the PLANTUML_JAR_PATH tag should be used to specify the +# path where java can find the plantuml.jar file or to the filename of jar file +# to be used. If left blank, it is assumed PlantUML is not used or called during +# a preprocessing step. Doxygen will generate a warning when it encounters a +# \startuml command in this case and will not generate output for the diagram. PLANTUML_JAR_PATH = -# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a -# configuration file for plantuml. +# When using PlantUML, the PLANTUML_CFG_FILE tag can be used to specify a +# configuration file for PlantUML. PLANTUML_CFG_FILE = -# When using plantuml, the specified paths are searched for files specified by -# the !include statement in a plantuml block. +# When using PlantUML, the specified paths are searched for files specified by +# the !include statement in a PlantUML block. PLANTUML_INCLUDE_PATH = +# The PLANTUMLFILE_DIRS tag can be used to specify one or more directories that +# contain PlantUml files that are included in the documentation (see the +# \plantumlfile command). + +PLANTUMLFILE_DIRS = + # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes # that will be shown in the graph. If the number of nodes in a graph becomes -# larger than this value, doxygen will truncate the graph, which is visualized -# by representing a node as a red box. Note that doxygen if the number of direct +# larger than this value, Doxygen will truncate the graph, which is visualized +# by representing a node as a red box. Note that if the number of direct # children of the root node in a graph is already larger than # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. @@ -2514,18 +2931,6 @@ DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 0 -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not seem -# to support this out of the box. -# -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_TRANSPARENT = NO - # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This # makes dot run faster, but since only newer versions of dot (>1.8.10) support @@ -2535,17 +2940,37 @@ DOT_TRANSPARENT = NO DOT_MULTI_TARGETS = NO -# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page +# If the GENERATE_LEGEND tag is set to YES Doxygen will generate a legend page # explaining the meaning of the various boxes and arrows in the dot generated # graphs. +# Note: This tag requires that UML_LOOK isn't set, i.e. the Doxygen internal +# graphical representation for inheritance and collaboration diagrams is used. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. GENERATE_LEGEND = YES -# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot +# If the DOT_CLEANUP tag is set to YES, Doxygen will remove the intermediate # files that are used to generate the various graphs. +# +# Note: This setting is not only used for dot files but also for msc temporary +# files. # The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. DOT_CLEANUP = YES + +# You can define message sequence charts within Doxygen comments using the \msc +# command. If the MSCGEN_TOOL tag is left empty (the default), then Doxygen will +# use a built-in version of mscgen tool to produce the charts. Alternatively, +# the MSCGEN_TOOL tag can also specify the name an external tool. For instance, +# specifying prog as the value, Doxygen will call the tool as prog -T +# -o . The external tool should support +# output file formats "png", "eps", "svg", and "ismap". + +MSCGEN_TOOL = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the \mscfile +# command). + +MSCFILE_DIRS = diff --git a/docs/conf.py.in b/docs/conf.py.in index 44db7d28..ec785834 100644 --- a/docs/conf.py.in +++ b/docs/conf.py.in @@ -68,7 +68,7 @@ master_doc = 'index' # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = 'en' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. diff --git a/docs/core.rst b/docs/core.rst index 8fe2bc97..d561ab65 100644 --- a/docs/core.rst +++ b/docs/core.rst @@ -6,12 +6,15 @@ Description The core of the ``skyr`` library is a ``skyr::parse`` function that parses an input string and creates a ``skyr::url_record`` -that contains a URL parts, and a ``skyr::serialize`` function +that contains URL parts, and a ``skyr::serialize`` function that composes a URL string from an existing ``skyr::url_record``. +The ``skyr::parse`` function returns ``std::expected`` +for type-safe error handling without exceptions. + Use these functions directly if your needs are simple. Use the ``skyr::url`` class for more complex operations, including -Unicode encoding and decoding. +Unicode encoding and decoding, URL transformations, and sanitization. Headers ------- @@ -31,20 +34,30 @@ Example #include #include #include - #include + #include int main() { - auto url = skyr::url_parse("http://example.org/"); - std::cout << url << std::endl; - std::cout << "Scheme: " << url.scheme << std::endl; - std::cout << "Hostname: " << url.host.value().to_string()); - std::cout << "Pathname: "; - for (const auto &path : url.path) { - << std::cout << "/" << path; - } - std::cout << std::endl; + auto result = skyr::parse("http://example.org/path/to/file"); + + if (result) { + const auto& url = result.value(); + + std::println("Scheme: {}", url.scheme); - std::cout << "Serializer: " << skyr::serialize(url) << std::endl; + if (url.host) { + std::println("Hostname: {}", url.host->serialize()); + } + + std::print("Pathname: "); + for (const auto& segment : url.path) { + std::print("/{}", segment); + } + std::println(""); + + std::println("Serialized: {}", skyr::serialize(url)); + } else { + std::println("Parse error: {}", result.error()); + } } API diff --git a/docs/domain.rst b/docs/domain.rst index 9f368e8c..be89ad81 100644 --- a/docs/domain.rst +++ b/docs/domain.rst @@ -25,7 +25,7 @@ Example .. code-block:: c++ #include - #include + #include int main() { using namespace std::string_literals; @@ -33,19 +33,17 @@ Example auto domain = "उदाहरण.परीक्षा"s; auto encoded = skyr::domain::domain_to_ascii(domain); if (encoded) { - std::cout << encoded.value() << std::endl; + std::println(encoded.value()); } } API --- -Domain to ASCII -^^^^^^^^^^^^^^^ +Domain Processing Functions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. doxygenfunction:: skyr::domain_to_ascii(std::string_view, bool) - -.. doxygenfunction:: skyr::domain_to_unicode(std::string_view, bool) +The library provides the following domain processing functions. See the header files for detailed documentation of all overloads. Error codes ^^^^^^^^^^^ diff --git a/docs/filesystem.rst b/docs/filesystem.rst index 99d5dab6..96dc702f 100644 --- a/docs/filesystem.rst +++ b/docs/filesystem.rst @@ -21,12 +21,12 @@ Example #include #include - #include + #include int main() { auto path = std::filesystem::path("/usr/bin/clang"); auto url = skyr::filesystem::from_path(path).value(); - std::cout << url << std::endl; + std::println(url); } API diff --git a/docs/index.rst b/docs/index.rst index 954f4690..d0c70ce8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,15 +14,18 @@ This library provides: - A `skyr::url` class that implements a generic URL parser, conforming with the WhatWG URL specification - URL serialization and comparison +- **Immutable URL transformations** with `with_*` methods for functional-style URL building +- **URL sanitization** methods to remove credentials, fragments, and query parameters +- **Custom `std::format` support** with format specifiers for URL components - Percent encoding and decoding functions - IDNA and Punycode functions for domain name parsing -- Basic Unicode conversion functions +- Unicode conversion utilities Quick Start ----------- -This project requires the availability of a C++17 compliant compiler -and standard library. +This project requires a **C++23 compliant compiler** (GCC 13+, Clang 19+, MSVC 2022+) +and has **zero external dependencies** for core URL parsing. 1. Download ``vcpkg`` and install the dependencies ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -45,36 +48,24 @@ and standard library. // url_test.cpp #include - #include - #include + #include + #include int main() { - using namespace skyr::literals; - - try { - auto url = - "http://sub.example.إختبار:8090/\xcf\x80?a=1&c=2&b=\xe2\x80\x8d\xf0\x9f\x8c\x88"_url; - - std::cout << "Protocol: " << url.protocol() << std::endl; - - std::cout << "Domain? " << std::boolalpha << url.is_domain() << std::endl; - std::cout << "Domain: " << url.hostname() << std::endl; - std::cout << "Domain: " - << skyr::domain_to_u8(url.hostname()).value() << std::endl; - - std::cout << "Port: " << url.port().value() << std::endl; - - std::cout << "Pathname: " - << skyr::percent_decode(url.pathname()).value() << std::endl; - - std::cout << "Search parameters" << std::endl; - const auto &search = url.search_parameters(); - for (const auto &[key, value] : search) { - std::cout << " " << "key: " << key << ", value = " << value << std::endl; - } - } - catch (const skyr::url_parse_error &e) { - std::cout << e.code().message() << std::endl; + auto url = skyr::url("http://sub.example.إختبار:8090/\xcf\x80?a=1&c=2&b=\xe2\x80\x8d\xf0\x9f\x8c\x88"); + + // Using std::format support + std::println("Scheme: {:s}", url); + std::println("Domain? {}", url.is_domain()); + std::println("Domain: {:h}", url); // Encoded (punycode) + std::println("Domain: {:hd}", url); // Decoded (unicode) + std::println("Port: {:p}", url); + std::println("Pathname: {:Pd}", url); // Decoded pathname + + std::println("\nSearch parameters:"); + const auto &search = url.search_parameters(); + for (const auto &[key, value] : search) { + std::println(" key: {}, value = {}", key, value); } } @@ -85,12 +76,12 @@ and standard library. # CMakeLists.txt + cmake_minimum_required(VERSION 3.21) project(my_project) - find_package(tl-expected CONFIG REQUIRED) find_package(skyr-url CONFIG REQUIRED) - set(CMAKE_CXX_STANDARD 17) + set(CMAKE_CXX_STANDARD 23) add_executable(url_test url_test.cpp) target_link_libraries(url_test PRIVATE skyr::skyr-url) @@ -112,13 +103,13 @@ and standard library. Design objectives ^^^^^^^^^^^^^^^^^ -* Uses modern C++17 features -* Cross-platform -* Easy to use and read -* Compliant to the the WhatWG URL standard -* Works naturally with Unicode strings -* Uses modern CMake and is available as a dependency using a package - manager +* Uses modern C++23 features (``std::expected``, ``std::format``, ``std::ranges``) +* Header-only library with zero external dependencies +* Cross-platform (Linux, macOS, Windows) +* Easy to use and read with immutable, functional-style API +* Compliant with the WhatWG URL specification +* Works naturally with Unicode strings (IDNA/Punycode support) +* Uses modern CMake and is available via vcpkg Documentation ------------- diff --git a/docs/network.rst b/docs/network.rst index 1f6d31d6..4b08c75f 100644 --- a/docs/network.rst +++ b/docs/network.rst @@ -20,7 +20,7 @@ Example .. code-block:: c++ #include - #include + #include #include int main() { @@ -28,7 +28,7 @@ Example auto url = "http://[1080:0:0:0:8:800:200C:417A]:8090/"_url; assert(url.is_ipv6_address()); - std::cout << "IPv6 Host: " << urlhostname() << std::endl; + std::println("IPv6 Host: {}", url.hostname()); } API diff --git a/docs/percent_encoding.rst b/docs/percent_encoding.rst index 6fe66c05..7a285500 100644 --- a/docs/percent_encoding.rst +++ b/docs/percent_encoding.rst @@ -22,13 +22,13 @@ Example #include #include - #include + #include int main() { using namespace skyr::literals; auto url = "http://www.example.org/\xcf\x80/"_url; - std::cout << skyr::percent_decode(url.pathname()).value() << std::endl; + std::println(skyr::percent_decode(url.pathname()).value()); } API diff --git a/docs/url.rst b/docs/url.rst index 05903d51..278d8b1f 100644 --- a/docs/url.rst +++ b/docs/url.rst @@ -5,8 +5,17 @@ Description ----------- The ``skyr::url`` class parses a URL in the constructor and provides -a rich interface to access and process the URL components. The -``skyr::url`` constructor throws a ``skyr::url_parse_error`` on failure. +a rich interface to access and process the URL components. The library +uses C++23 ``std::expected`` for error handling, providing type-safe +error propagation without exceptions. + +Key features: + +* Immutable URL transformations with ``with_*`` methods +* URL sanitization methods to remove credentials, fragments, and query parameters +* Custom ``std::format`` support with format specifiers for URL components +* Percent encoding and decoding +* IDNA and Punycode for internationalized domain names Headers ------- @@ -15,29 +24,67 @@ Headers #include -Example -------- +Basic Example +------------- .. code-block:: c++ #include - #include + #include int main() { - using namespace skyr::literals; + auto url = skyr::url("http://example.com/path?query=1"); - try { - auto url = "http://example.com/"_url; + std::println("Scheme: {}", url.scheme()); + std::println("Hostname: {}", url.hostname()); + std::println("Pathname: {}", url.pathname()); + std::println("Search: {}", url.search()); + } - std::cout << "Protocol: " << url.protocol() << std::endl; - std::cout << "Hostname: " << url.hostname() << std::endl; - std::cout << "Pathname: " << url.pathname() << std::endl; - } - catch (const skyr::url_parse_error &e) { - std::cout << e.code().message() << std::endl; +Immutable Transformations +-------------------------- + +.. code-block:: c++ + + #include + #include + + int main() { + auto dev_url = skyr::url("http://localhost:3000/api/v1/users"); + + // Transform development URL to production + auto prod_url = dev_url.with_scheme("https") + .and_then([](auto&& u) { return u.with_hostname("api.example.com"); }) + .and_then([](auto&& u) { return u.with_port(""); }) + .and_then([](auto&& u) { return u.with_pathname("/api/v2/users"); }); + + if (prod_url) { + std::println("Production: {}", prod_url->href()); } } +URL Sanitization +---------------- + +.. code-block:: c++ + + #include + #include + + int main() { + auto url = skyr::url("http://user:pass@example.com/path?debug=true&id=123#section"); + + // Remove credentials and fragment + auto safe_url = url.sanitize(); + std::println("{}", safe_url.href()); + // Output: http://example.com/path?debug=true&id=123 + + // Chain operations to remove specific parameters + auto clean_url = url.sanitize().without_params({"debug"}); + std::println("{}", clean_url.href()); + // Output: http://example.com/path?id=123 + } + API --- diff --git a/include/skyr/core/host.hpp b/include/skyr/core/host.hpp index 2851430e..783b5c66 100644 --- a/include/skyr/core/host.hpp +++ b/include/skyr/core/host.hpp @@ -60,7 +60,7 @@ class host { } /// Constructor - /// \param hsost An empty host + /// \param host An empty host constexpr explicit host(empty_host host) : host_(host) { } diff --git a/include/skyr/domain/domain.hpp b/include/skyr/domain/domain.hpp index 7636097d..e3d16b0d 100644 --- a/include/skyr/domain/domain.hpp +++ b/include/skyr/domain/domain.hpp @@ -245,8 +245,9 @@ inline auto domain_to_ascii(std::string_view domain_name, std::string* ascii_dom /// [IDNA processing](https://www.domain.org/reports/tr46/#Processing) /// /// \param domain_name A domain +/// \param ascii_domain Output pointer to store the ASCII domain /// \param be_strict Tells the processor to be strict -/// \param validation_error +/// \param validation_error Optional pointer to a bool that will be set if a validation error occurs /// \returns An ASCII domain, or an error inline auto domain_to_ascii(std::string_view domain_name, std::string* ascii_domain, bool be_strict, bool* validation_error) -> std::expected { @@ -264,6 +265,7 @@ inline auto domain_to_ascii(std::string_view domain_name, std::string* ascii_dom /// [IDNA processing](https://www.domain.org/reports/tr46/#Processing) /// /// \param domain_name A domain +/// \param ascii_domain Output pointer to store the ASCII domain /// \param be_strict Tells the processor to be strict /// \returns An ASCII domain, or an error inline auto domain_to_ascii(std::string_view domain_name, std::string* ascii_domain, bool be_strict) @@ -276,7 +278,8 @@ inline auto domain_to_ascii(std::string_view domain_name, std::string* ascii_dom /// [IDNA processing](https://www.domain.org/reports/tr46/#Processing) /// /// \param domain_name A domain -/// \param validation_error +/// \param ascii_domain Output pointer to store the ASCII domain +/// \param validation_error Optional pointer to a bool that will be set if a validation error occurs /// \returns An ASCII domain, or an error inline auto domain_to_ascii(std::string_view domain_name, std::string* ascii_domain, bool* validation_error) { return domain_to_ascii(domain_name, ascii_domain, false, validation_error); @@ -286,6 +289,7 @@ inline auto domain_to_ascii(std::string_view domain_name, std::string* ascii_dom /// [IDNA processing](https://www.domain.org/reports/tr46/#Processing) /// /// \param domain_name A domain +/// \param ascii_domain Output pointer to store the ASCII domain /// \returns An ASCII domain, or an error inline auto domain_to_ascii(std::string_view domain_name, std::string* ascii_domain) { [[maybe_unused]] bool validation_error = false; @@ -350,6 +354,8 @@ inline auto domain_to_u8_impl(domain_to_u8_context&& context) -> std::expected std::expected { @@ -360,6 +366,7 @@ inline auto domain_to_u8(std::string_view domain_name, std::string* u8_domain, [ /// Converts a Punycode encoded domain to UTF-8 /// /// \param domain_name A Punycode encoded domain +/// \param u8_domain Output pointer to store the UTF-8 domain /// \returns A valid UTF-8 encoded domain, or an error inline auto domain_to_u8(std::string_view domain_name, std::string* u8_domain) -> std::expected { [[maybe_unused]] bool validation_error = false; diff --git a/include/skyr/domain/punycode.hpp b/include/skyr/domain/punycode.hpp index d1888740..c6a886bb 100644 --- a/include/skyr/domain/punycode.hpp +++ b/include/skyr/domain/punycode.hpp @@ -151,6 +151,7 @@ inline auto punycode_encode(std::u32string_view input, std::string* output) -> s /// defined in [RFC 3492](https://tools.ietf.org/html/rfc3492) /// /// \param input An ASCII encoded domain to be decoded +/// \param output The output UTF-32 string to store the decoded result /// \returns The decoded UTF-8 domain, or an error template constexpr inline auto punycode_decode(StringView input, std::u32string* output) -> std::expected { diff --git a/include/skyr/network/ipv4_address.hpp b/include/skyr/network/ipv4_address.hpp index 06e5ece4..22580982 100644 --- a/include/skyr/network/ipv4_address.hpp +++ b/include/skyr/network/ipv4_address.hpp @@ -114,6 +114,7 @@ constexpr inline auto parse_ipv4_number(std::string_view input, bool* validation /// Parses an IPv4 address /// \param input An input string +/// \param validation_error Optional pointer to a bool that will be set if a validation error occurs /// \returns An `ipv4_address` object or an error constexpr inline auto parse_ipv4_address(std::string_view input, bool* validation_error) -> std::expected { diff --git a/include/skyr/network/ipv6_address.hpp b/include/skyr/network/ipv6_address.hpp index a4143ecc..1d72224b 100644 --- a/include/skyr/network/ipv6_address.hpp +++ b/include/skyr/network/ipv6_address.hpp @@ -158,6 +158,7 @@ constexpr inline auto hex_to_dec(charT byte) noexcept { /// Parses an IPv6 address /// \param input An input string +/// \param validation_error Optional pointer to a bool that will be set if a validation error occurs /// \returns An `ipv6_address` object or an error constexpr inline auto parse_ipv6_address(std::string_view input, bool* validation_error) -> std::expected { diff --git a/include/skyr/percent_encoding/percent_decode_range.hpp b/include/skyr/percent_encoding/percent_decode_range.hpp index dfbc878e..51b1ff9e 100644 --- a/include/skyr/percent_encoding/percent_decode_range.hpp +++ b/include/skyr/percent_encoding/percent_decode_range.hpp @@ -134,7 +134,7 @@ class percent_decode_range { using size_type = std::size_t; /// - /// \param range + /// \param s The string view to decode constexpr explicit percent_decode_range(std::string_view s) : it_(s) { } diff --git a/include/skyr/url.hpp b/include/skyr/url.hpp index ee789c75..642d7fe7 100644 --- a/include/skyr/url.hpp +++ b/include/skyr/url.hpp @@ -1339,7 +1339,7 @@ inline auto operator>(const url& lhs, const url& rhs) noexcept { /// /// \param lhs A `url` object /// \param rhs A `url` object -/// \returns `!(lhs > rhs) +/// \returns `!(lhs > rhs)` inline auto operator<=(const url& lhs, const url& rhs) noexcept { return !(lhs > rhs); } From 45afea2c1a02bcee449058e0175ae2a4f5674813 Mon Sep 17 00:00:00 2001 From: Glyn Matthews Date: Sat, 3 Jan 2026 10:18:50 +0100 Subject: [PATCH 3/6] Add automated documentation publishing workflow --- .github/workflows/documentation.yml | 67 +++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 .github/workflows/documentation.yml diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 00000000..4c9dafb6 --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,67 @@ +name: Documentation + +on: + push: + branches: + - main + workflow_dispatch: + +permissions: + contents: write + +jobs: + build-and-deploy: + name: Build and Deploy Documentation + runs-on: ubuntu-24.04 + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + with: + submodules: recursive + + - name: Install system dependencies + run: | + sudo apt-get update + sudo apt-get install -y \ + doxygen \ + pandoc \ + python3 \ + python3-pip \ + ninja-build + + - name: Install Python documentation dependencies + run: | + python3 -m pip install --upgrade pip + python3 -m pip install \ + sphinx \ + sphinx_bootstrap_theme \ + breathe \ + recommonmark + + - name: Install vcpkg + run: | + git clone https://github.com/Microsoft/vcpkg.git + ./vcpkg/bootstrap-vcpkg.sh + + - name: Configure CMake + run: | + cmake \ + -B build \ + -G Ninja \ + -DCMAKE_BUILD_TYPE=Release \ + -DCMAKE_TOOLCHAIN_FILE=${{ github.workspace }}/vcpkg/scripts/buildsystems/vcpkg.cmake \ + . + + - name: Build documentation + run: cmake --build build --target doc + + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v4 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./build/docs/html + publish_branch: gh-pages + user_name: 'github-actions[bot]' + user_email: 'github-actions[bot]@users.noreply.github.com' + commit_message: 'Deploy documentation from ${{ github.sha }}' From dd42cf19e3906d25661651f38880261235c28e6b Mon Sep 17 00:00:00 2001 From: Glyn Matthews Date: Sat, 3 Jan 2026 10:44:57 +0100 Subject: [PATCH 4/6] Update documentation --- CLAUDE.md | 4 +-- CMakeLists.txt | 32 ++++++++---------- cmake/skyr-url-functions.cmake | 24 ++----------- cmake/targets/skyr/CMakeLists.txt | 45 +++++++++++-------------- docs/filesystem.rst | 31 ++++++++++++++--- docs/json.rst | 44 ++++++++++++++++++++++-- docs/network.rst | 56 ++++++++++++++++++++++++++----- docs/percent_encoding.rst | 47 +++++++++++++++++++++----- 8 files changed, 190 insertions(+), 93 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 1657c933..39dfbee6 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -64,10 +64,10 @@ Key build options: - `skyr_BUILD_TESTS` (ON): Build tests - `skyr_BUILD_WPT` (OFF): Build Web Platform Tests runner - `skyr_BUILD_BENCHMARKS` (OFF): Build performance benchmarks -- `skyr_ENABLE_FILESYSTEM_FUNCTIONS` (ON): Enable filesystem::path conversion -- `skyr_ENABLE_JSON_FUNCTIONS` (ON): Enable JSON serialization - `skyr_BUILD_WITHOUT_EXCEPTIONS` (OFF): Build without exceptions +**Note**: Filesystem functions are always available (C++23 guarantees `std::filesystem`). JSON functions are automatically enabled when `nlohmann-json` is found. + ## Testing ### Run All Tests diff --git a/CMakeLists.txt b/CMakeLists.txt index 649909a2..0888ff18 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -35,8 +35,6 @@ option(skyr_BUILD_WITHOUT_EXCEPTIONS "Build without exceptions." OFF) option(skyr_BUILD_WITHOUT_RTTI "Build without RTTI." OFF) option(skyr_USE_STATIC_CRT "Use static C Runtime library (/MT or MTd)." ON) option(skyr_BUILD_WITH_LLVM_LIBCXX "Instruct Clang to use LLVM's implementation of C++ standard library" OFF) -option(skyr_ENABLE_FILESYSTEM_FUNCTIONS "Enable functions to convert URL to std::filesystem::path" ON) -option(skyr_ENABLE_JSON_FUNCTIONS "Enable functions to convert URL components to JSON" ON) option(skyr_ENABLE_SANITIZERS "Enable sanitizers (address, undefined, etc.) for tests and examples" OFF) option(skyr_CXX_STANDARD_LIBRARY "Path to non-system C++ standard library" "") @@ -51,13 +49,14 @@ if (skyr_IS_TOP_LEVEL_PROJECT) set(CMAKE_CXX_STANDARD_REQUIRED ON) endif() -if (skyr_ENABLE_JSON_FUNCTIONS) - find_package(nlohmann_json CONFIG) - if (NOT nlohmann_json_FOUND) - message(WARNING "nlohmann_json not found. Install with: vcpkg install nlohmann-json") - message(WARNING "JSON functions will be disabled.") - set(skyr_ENABLE_JSON_FUNCTIONS OFF) - endif() +# JSON functions are optional and only available if nlohmann_json is found +find_package(nlohmann_json CONFIG) +if (NOT nlohmann_json_FOUND) + message(WARNING "nlohmann_json not found. Install with: vcpkg install nlohmann-json") + message(WARNING "JSON functions will be disabled.") + set(skyr_HAS_JSON_SUPPORT OFF) +else() + set(skyr_HAS_JSON_SUPPORT ON) endif() if (skyr_USE_STATIC_CRT AND (CMAKE_CXX_COMPILER_ID MATCHES "MSVC" OR CMAKE_CXX_SIMULATE_ID MATCHES "MSVC")) @@ -129,11 +128,8 @@ write_basic_package_version_file( COMPATIBILITY SameMajorVersion ARCH_INDEPENDENT) -set(skyr_TARGETS skyr-url) -if (skyr_ENABLE_FILESYSTEM_FUNCTIONS) - list(APPEND skyr_TARGETS skyr-filesystem) -endif() -if (skyr_ENABLE_JSON_FUNCTIONS) +set(skyr_TARGETS skyr-url skyr-filesystem) +if (skyr_HAS_JSON_SUPPORT) list(APPEND skyr_TARGETS skyr-json) endif() @@ -177,10 +173,10 @@ install( include/skyr ) -if (skyr_ENABLE_FILESYSTEM_FUNCTIONS) - install(DIRECTORY "${PROJECT_SOURCE_DIR}/include/skyr/filesystem" DESTINATION include/skyr) -endif() +# Filesystem functions are always installed (C++23 guarantees std::filesystem) +install(DIRECTORY "${PROJECT_SOURCE_DIR}/include/skyr/filesystem" DESTINATION include/skyr) -if (skyr_ENABLE_JSON_FUNCTIONS) +# JSON functions are only installed if nlohmann_json is available +if (skyr_HAS_JSON_SUPPORT) install(DIRECTORY "${PROJECT_SOURCE_DIR}/include/skyr/json" DESTINATION include/skyr) endif() diff --git a/cmake/skyr-url-functions.cmake b/cmake/skyr-url-functions.cmake index a9a56964..b3b700f0 100644 --- a/cmake/skyr-url-functions.cmake +++ b/cmake/skyr-url-functions.cmake @@ -24,25 +24,5 @@ function(skyr_remove_extension file_name basename) endfunction() -function(skyr_check_filesystem compile_definitions) - check_cxx_source_compiles("#include -int main() { std::filesystem::path p{}; }" SKYR_USE_CXX17_FILESYSTEM) - if (SKYR_USE_CXX17_FILESYSTEM) - set(_compile_definitions "-DSKYR_USE_CXX17_FILESYSTEM") - else() - check_cxx_source_compiles("#include -int main() { std::experimental::filesystem::path p{}; }" SKYR_USE_CXX17_EXPERIMENTAL_FILESYSTEM) - if (SKYR_USE_CXX17_EXPERIMENTAL_FILESYSTEM) - set(_compile_definitions "-DSKYR_USE_CXX17_EXPERIMENTAL_FILESYSTEM") - if (${CMAKE_CXX_COMPILER_ID} MATCHES GNU OR ${CMAKE_CXX_COMPILER_ID} MATCHES Clang) - set(_compile_definitions "${_compile_definitions} -D_LIBCPP_NO_EXPERIMENTAL_DEPRECATION_WARNING_FILESYSTEM") - elseif (${CMAKE_CXX_COMPILER_ID} MATCHES MSVC) - set(_compile_definitions "${_compile_definitions} -D_SILENCE_EXPERIMENTAL_FILESYSTEM_DEPRECATION_WARNING") - endif() - else() - message(FATAL_ERROR "Filesystem operations are not supported") - endif() - endif() - - set(${compile_definitions} ${_compile_definitions} PARENT_SCOPE) -endfunction() +# Legacy filesystem check function removed +# C++23 guarantees std::filesystem support, so no checks are needed diff --git a/cmake/targets/skyr/CMakeLists.txt b/cmake/targets/skyr/CMakeLists.txt index c628b5e8..788b217c 100644 --- a/cmake/targets/skyr/CMakeLists.txt +++ b/cmake/targets/skyr/CMakeLists.txt @@ -28,43 +28,36 @@ add_library(skyr::url ALIAS skyr-url) ################################################# # skyr-filesystem +# Always available (C++23 guarantees std::filesystem) ################################################# -if (skyr_ENABLE_FILESYSTEM_FUNCTIONS) - add_library(skyr-filesystem INTERFACE) +add_library(skyr-filesystem INTERFACE) - target_compile_features(skyr-filesystem INTERFACE cxx_std_23) +target_compile_features(skyr-filesystem INTERFACE cxx_std_23) - skyr_check_filesystem(filesystem_definitions) - target_compile_definitions( - skyr-filesystem - INTERFACE - ${filesystem_definitions} - ) - - target_link_libraries( - skyr-filesystem - INTERFACE - skyr-url - ) +target_link_libraries( + skyr-filesystem + INTERFACE + skyr-url +) - target_include_directories( - skyr-filesystem - INTERFACE - $ - $ - $ - ) +target_include_directories( + skyr-filesystem + INTERFACE + $ + $ + $ +) - add_library(skyr::skyr-filesystem ALIAS skyr-filesystem) - add_library(skyr::filesystem ALIAS skyr-filesystem) -endif() +add_library(skyr::skyr-filesystem ALIAS skyr-filesystem) +add_library(skyr::filesystem ALIAS skyr-filesystem) ################################################# # skyr-json +# Optional - only available if nlohmann_json is found ################################################# -if (skyr_ENABLE_JSON_FUNCTIONS) +if (skyr_HAS_JSON_SUPPORT) add_library(skyr-json INTERFACE) target_compile_features(skyr-json INTERFACE cxx_std_23) diff --git a/docs/filesystem.rst b/docs/filesystem.rst index 96dc702f..d91cdbca 100644 --- a/docs/filesystem.rst +++ b/docs/filesystem.rst @@ -22,24 +22,45 @@ Example #include #include #include + #include int main() { + // Convert filesystem path to URL auto path = std::filesystem::path("/usr/bin/clang"); - auto url = skyr::filesystem::from_path(path).value(); - std::println(url); + auto url = skyr::filesystem::from_path(path); + if (url) { + std::println("URL: {}", url->href()); + // Output: file:///usr/bin/clang + } + + // Convert URL back to filesystem path + auto file_url = skyr::url("file:///home/user/documents/report.pdf"); + auto fs_path = skyr::filesystem::to_path(file_url); + if (fs_path) { + std::println("Path: {}", fs_path->string()); + // Output: /home/user/documents/report.pdf + } + + // Works with Unicode paths + auto unicode_path = std::filesystem::path("/tmp/тест.txt"); + auto unicode_url = skyr::filesystem::from_path(unicode_path); + if (unicode_url) { + std::println("Encoded URL: {}", unicode_url->href()); + // Output: file:///tmp/%D1%82%D0%B5%D1%81%D1%82.txt + } } API --- -Path -^^^^ +Path Functions +^^^^^^^^^^^^^^ .. doxygenfunction:: skyr::filesystem::from_path .. doxygenfunction:: skyr::filesystem::to_path -Error codes +Error Codes ^^^^^^^^^^^ .. doxygenenum:: skyr::filesystem::path_errc diff --git a/docs/json.rst b/docs/json.rst index 7f6f548e..bf04680b 100644 --- a/docs/json.rst +++ b/docs/json.rst @@ -6,7 +6,10 @@ Description The functions below convert between a URL query string and a JSON object. They depend on the -`nlohmann `_ library. +`nlohmann-json `_ library. + +This functionality is **optional** and only available when nlohmann-json +is installed. Headers ------- @@ -18,12 +21,47 @@ Headers Example ------- +.. code-block:: c++ + + #include + #include + #include + + int main() { + // Convert JSON object to URL query string + auto data = nlohmann::json{ + {"name", "John Doe"}, + {"age", "30"}, + {"tags", nlohmann::json::array({"developer", "c++"})}}; + + auto query = skyr::json::encode_query(data); + if (query) { + std::println("Query string: {}", query.value()); + // Output: name=John%20Doe&age=30&tags=developer&tags=c%2B%2B + } + + // Convert URL query string to JSON object + auto json_obj = skyr::json::decode_query("name=John%20Doe&age=30&tags=developer&tags=c%2B%2B"); + std::println("JSON object: {}", json_obj.dump(2)); + // Output: + // { + // "age": "30", + // "name": "John Doe", + // "tags": ["developer", "c++"] + // } + } + API --- -JSON -^^^^ +JSON Functions +^^^^^^^^^^^^^^ .. doxygenfunction:: skyr::json::encode_query .. doxygenfunction:: skyr::json::decode_query + +Error Codes +^^^^^^^^^^^ + +.. doxygenenum:: skyr::json::json_errc diff --git a/docs/network.rst b/docs/network.rst index 4b08c75f..626df4c4 100644 --- a/docs/network.rst +++ b/docs/network.rst @@ -4,7 +4,9 @@ Network Addresses Description ----------- -Two classes representing IPv4 and IPv6 addresses are provided. +The library provides two classes representing IPv4 and IPv6 addresses +according to the WhatWG URL specification. These addresses are parsed +and validated as part of URL hostname processing. Headers ------- @@ -20,28 +22,64 @@ Example .. code-block:: c++ #include + #include + #include #include - #include int main() { using namespace skyr::literals; - auto url = "http://[1080:0:0:0:8:800:200C:417A]:8090/"_url; - assert(url.is_ipv6_address()); - std::println("IPv6 Host: {}", url.hostname()); + // IPv4 addresses + auto ipv4_url = "http://192.168.1.1:8080/api"_url; + if (ipv4_url.is_ipv4_address()) { + std::println("IPv4 Host: {}", ipv4_url.hostname()); + // Output: 192.168.1.1 + } + + // IPv6 addresses (must be enclosed in brackets) + auto ipv6_url = "http://[1080:0:0:0:8:800:200C:417A]:8090/"_url; + if (ipv6_url.is_ipv6_address()) { + std::println("IPv6 Host: {}", ipv6_url.hostname()); + // Output: [1080:0:0:0:8:800:200c:417a] + } + + // Parse IPv4 address directly + auto ipv4 = skyr::parse_ipv4_address("192.0.2.1"); + if (ipv4) { + std::println("Parsed IPv4: {}", ipv4->serialize()); + // Output: 192.0.2.1 + } + + // Parse IPv6 address directly + auto ipv6 = skyr::parse_ipv6_address("2001:db8::1"); + if (ipv6) { + std::println("Parsed IPv6: {}", ipv6->serialize()); + // Output: 2001:db8::1 + } } API --- -IPv4 -^^^^ +IPv4 Address +^^^^^^^^^^^^ .. doxygenclass:: skyr::ipv4_address :members: -IPv6 -^^^^ +.. doxygenfunction:: skyr::parse_ipv4_address(std::string_view, bool*) + +IPv6 Address +^^^^^^^^^^^^ .. doxygenclass:: skyr::ipv6_address :members: + +.. doxygenfunction:: skyr::parse_ipv6_address(std::string_view, bool*) + +Error Codes +^^^^^^^^^^^ + +.. doxygenenum:: skyr::ipv4_address_errc + +.. doxygenenum:: skyr::ipv6_address_errc diff --git a/docs/percent_encoding.rst b/docs/percent_encoding.rst index 7a285500..1c130c12 100644 --- a/docs/percent_encoding.rst +++ b/docs/percent_encoding.rst @@ -4,8 +4,12 @@ Percent Encoding Description ----------- -The functions below allow percent encoding and decoding, most -commonly used in URL paths, query parameter and fragments. +The functions below allow percent encoding and decoding, commonly +used in URL components such as paths, query parameters, and fragments. + +Percent encoding converts characters that are not allowed in URLs +into a ``%`` followed by two hexadecimal digits representing the +character's byte value in UTF-8. Headers ------- @@ -20,23 +24,50 @@ Example .. code-block:: c++ - #include + #include #include #include int main() { - using namespace skyr::literals; + // Encode a string with special characters + auto encoded = skyr::percent_encode("Hello World! π = 3.14"); + std::println("Encoded: {}", encoded); + // Output: Hello%20World!%20%CF%80%20%3D%203.14 + + // Decode a percent-encoded string + auto decoded = skyr::percent_decode("Hello%20World!%20%CF%80%20%3D%203.14"); + if (decoded) { + std::println("Decoded: {}", decoded.value()); + // Output: Hello World! π = 3.14 + } + + // Using with URL components + auto path_component = "path/to/file with spaces.txt"; + auto encoded_path = skyr::percent_encode(path_component); + std::println("Encoded path: {}", encoded_path); + // Output: path%2Fto%2Ffile%20with%20spaces.txt - auto url = "http://www.example.org/\xcf\x80/"_url; - std::println(skyr::percent_decode(url.pathname()).value()); + // Common use case: building query parameters + auto key = "search query"; + auto value = "C++ & Rust"; + auto query = std::format("{}={}", + skyr::percent_encode(key), + skyr::percent_encode(value)); + std::println("Query: {}", query); + // Output: search%20query=C%2B%2B%20%26%20Rust } API --- -Percent encoding -^^^^^^^^^^^^^^^^ +Percent Encoding Functions +^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. doxygenfunction:: skyr::percent_encode .. doxygenfunction:: skyr::percent_decode + +Error Codes +^^^^^^^^^^^ + +.. doxygenenum:: skyr::percent_encoding::percent_encode_errc From c934557fccb83ba5e635d071ff29f9cf9cb6317b Mon Sep 17 00:00:00 2001 From: Glyn Matthews Date: Sat, 3 Jan 2026 14:05:17 +0100 Subject: [PATCH 5/6] Fix with_method_tests inputs --- tests/skyr/url/url_with_methods_tests.cpp | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/tests/skyr/url/url_with_methods_tests.cpp b/tests/skyr/url/url_with_methods_tests.cpp index 31bf5f13..6ef8f5fc 100644 --- a/tests/skyr/url/url_with_methods_tests.cpp +++ b/tests/skyr/url/url_with_methods_tests.cpp @@ -344,7 +344,7 @@ TEST_CASE("url_with_methods_tests", "[url][with_methods]") { SECTION("with_hostname_utf8") { auto url = skyr::url("http://example.com/"); - auto result = url.with_hostname(u8"münchen.de"); + auto result = url.with_hostname("m\xc3\xbcnchen.de"); REQUIRE(result.has_value()); // Should be punycoded @@ -353,7 +353,7 @@ TEST_CASE("url_with_methods_tests", "[url][with_methods]") { SECTION("with_search_utf8") { auto url = skyr::url("http://example.com/"); - auto result = url.with_search(u8"query=café"); + auto result = url.with_search("query=caf\xc3\xa9"); REQUIRE(result.has_value()); // Should be percent-encoded @@ -362,7 +362,7 @@ TEST_CASE("url_with_methods_tests", "[url][with_methods]") { SECTION("with_pathname_utf8") { auto url = skyr::url("http://example.com/"); - auto result = url.with_pathname(u8"/path/café"); + auto result = url.with_pathname("/path/caf\xc3\xa9"); REQUIRE(result.has_value()); CHECK(result->pathname() == "/path/caf%C3%A9"); @@ -370,7 +370,8 @@ TEST_CASE("url_with_methods_tests", "[url][with_methods]") { SECTION("with_username_utf8") { auto url = skyr::url("http://example.com/"); - auto result = url.with_username(u8"usér"); + // "usér" - é = 0xC3 0xA9 in UTF-8 + auto result = url.with_username("us\xc3\xa9r"); REQUIRE(result.has_value()); CHECK(result->username() == "us%C3%A9r"); From 7af4fa6f59af7032c718c1f957008495aa4a68c1 Mon Sep 17 00:00:00 2001 From: Glyn Matthews Date: Sun, 4 Jan 2026 09:09:57 +0100 Subject: [PATCH 6/6] Simplify includes by grouping headers --- docs/domain.rst | 5 ++--- docs/filesystem.rst | 4 ++-- docs/json.rst | 4 ++-- docs/network.rst | 6 ++---- docs/percent_encoding.rst | 6 ++---- include/skyr/domain.hpp | 15 +++++++++++++++ include/skyr/json.hpp | 10 ++++++++++ include/skyr/network.hpp | 11 +++++++++++ include/skyr/percent_encoding.hpp | 12 ++++++++++++ 9 files changed, 58 insertions(+), 15 deletions(-) create mode 100644 include/skyr/domain.hpp create mode 100644 include/skyr/json.hpp create mode 100644 include/skyr/network.hpp create mode 100644 include/skyr/percent_encoding.hpp diff --git a/docs/domain.rst b/docs/domain.rst index be89ad81..6f457a24 100644 --- a/docs/domain.rst +++ b/docs/domain.rst @@ -16,15 +16,14 @@ Headers .. code-block:: c++ - #include - #include + #include Example ------- .. code-block:: c++ - #include + #include #include int main() { diff --git a/docs/filesystem.rst b/docs/filesystem.rst index d91cdbca..b4f02808 100644 --- a/docs/filesystem.rst +++ b/docs/filesystem.rst @@ -12,7 +12,7 @@ Headers .. code-block:: c++ - #include + #include Example ------- @@ -20,7 +20,7 @@ Example .. code-block:: c++ #include - #include + #include #include #include diff --git a/docs/json.rst b/docs/json.rst index bf04680b..32784f7c 100644 --- a/docs/json.rst +++ b/docs/json.rst @@ -16,14 +16,14 @@ Headers .. code-block:: c++ - #include + #include Example ------- .. code-block:: c++ - #include + #include #include #include diff --git a/docs/network.rst b/docs/network.rst index 626df4c4..34d277d4 100644 --- a/docs/network.rst +++ b/docs/network.rst @@ -13,8 +13,7 @@ Headers .. code-block:: c++ - #include - #include + #include Example ------- @@ -22,8 +21,7 @@ Example .. code-block:: c++ #include - #include - #include + #include #include int main() { diff --git a/docs/percent_encoding.rst b/docs/percent_encoding.rst index 1c130c12..295b8fa1 100644 --- a/docs/percent_encoding.rst +++ b/docs/percent_encoding.rst @@ -16,16 +16,14 @@ Headers .. code-block:: c++ - #include - #include + #include Example ------- .. code-block:: c++ - #include - #include + #include #include int main() { diff --git a/include/skyr/domain.hpp b/include/skyr/domain.hpp new file mode 100644 index 00000000..ae9879a8 --- /dev/null +++ b/include/skyr/domain.hpp @@ -0,0 +1,15 @@ +// +// Created by Glyn Matthews on 03/01/2026. +// + +#ifndef SKYR_URL_DOMAIN_HPP +#define SKYR_URL_DOMAIN_HPP + +#include +#include +#include +#include +#include +#include + +#endif // SKYR_URL_DOMAIN_HPP diff --git a/include/skyr/json.hpp b/include/skyr/json.hpp new file mode 100644 index 00000000..b6cbd22c --- /dev/null +++ b/include/skyr/json.hpp @@ -0,0 +1,10 @@ +// +// Created by Glyn Matthews on 03/01/2026. +// + +#ifndef SKYR_URL_JSON_HPP +#define SKYR_URL_JSON_HPP + +#include + +#endif // SKYR_URL_JSON_HPP diff --git a/include/skyr/network.hpp b/include/skyr/network.hpp new file mode 100644 index 00000000..31976d20 --- /dev/null +++ b/include/skyr/network.hpp @@ -0,0 +1,11 @@ +// +// Created by Glyn Matthews on 03/01/2026. +// + +#ifndef SKYR_URL_NETWORK_HPP +#define SKYR_URL_NETWORK_HPP + +#include +#include + +#endif // SKYR_URL_NETWORK_HPP diff --git a/include/skyr/percent_encoding.hpp b/include/skyr/percent_encoding.hpp new file mode 100644 index 00000000..07e5b054 --- /dev/null +++ b/include/skyr/percent_encoding.hpp @@ -0,0 +1,12 @@ +// +// Created by Glyn Matthews on 03/01/2026. +// + +#ifndef SKYR_URL_PERCENT_ENCODING_HPP +#define SKYR_URL_PERCENT_ENCODING_HPP + +#include +#include +#include + +#endif // SKYR_URL_PERCENT_ENCODING_HPP