summaryrefslogtreecommitdiffhomepage
path: root/vendor/toml++/impl/key.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/toml++/impl/key.hpp')
-rw-r--r--vendor/toml++/impl/key.hpp335
1 files changed, 335 insertions, 0 deletions
diff --git a/vendor/toml++/impl/key.hpp b/vendor/toml++/impl/key.hpp
new file mode 100644
index 0000000..575017a
--- /dev/null
+++ b/vendor/toml++/impl/key.hpp
@@ -0,0 +1,335 @@
+//# This file is a part of toml++ and is subject to the the terms of the MIT license.
+//# Copyright (c) Mark Gillard <mark.gillard@outlook.com.au>
+//# See https://github.com/marzer/tomlplusplus/blob/master/LICENSE for the full license text.
+// SPDX-License-Identifier: MIT
+#pragma once
+
+#include "source_region.hpp"
+#include "std_utility.hpp"
+#include "print_to_stream.hpp"
+#include "header_start.hpp"
+
+TOML_NAMESPACE_START
+{
+ /// \brief A key parsed from a TOML document.
+ ///
+ /// \detail These are used as the internal keys for a toml::table: \cpp
+ /// const toml::table tbl = R"(
+ /// a = 1
+ /// b = 2
+ /// c = 3
+ /// )"_toml;
+ ///
+ /// for (auto&& [k, v] : tbl)
+ /// std::cout << "key '"sv << k << "' defined at "sv << k.source() << "\n";
+ /// \ecpp
+ /// \out
+ /// key 'a' defined at line 2, column 5
+ /// key 'b' defined at line 3, column 7
+ /// key 'c' defined at line 4, column 9
+ /// \eout
+ class key
+ {
+ private:
+ std::string key_;
+ source_region source_;
+
+ public:
+ /// \brief Default constructor.
+ TOML_NODISCARD_CTOR
+ key() noexcept = default;
+
+ /// \brief Constructs a key from a string view and source region.
+ TOML_NODISCARD_CTOR
+ explicit key(std::string_view k, source_region&& src = {}) //
+ : key_{ k },
+ source_{ std::move(src) }
+ {}
+
+ /// \brief Constructs a key from a string view and source region.
+ TOML_NODISCARD_CTOR
+ explicit key(std::string_view k, const source_region& src) //
+ : key_{ k },
+ source_{ src }
+ {}
+
+ /// \brief Constructs a key from a string and source region.
+ TOML_NODISCARD_CTOR
+ explicit key(std::string&& k, source_region&& src = {}) noexcept //
+ : key_{ std::move(k) },
+ source_{ std::move(src) }
+ {}
+
+ /// \brief Constructs a key from a string and source region.
+ TOML_NODISCARD_CTOR
+ explicit key(std::string&& k, const source_region& src) noexcept //
+ : key_{ std::move(k) },
+ source_{ src }
+ {}
+
+ /// \brief Constructs a key from a c-string and source region.
+ TOML_NODISCARD_CTOR
+ explicit key(const char* k, source_region&& src = {}) //
+ : key_{ k },
+ source_{ std::move(src) }
+ {}
+
+ /// \brief Constructs a key from a c-string view and source region.
+ TOML_NODISCARD_CTOR
+ explicit key(const char* k, const source_region& src) //
+ : key_{ k },
+ source_{ src }
+ {}
+
+#if TOML_ENABLE_WINDOWS_COMPAT
+
+ /// \brief Constructs a key from a wide string view and source region.
+ ///
+ /// \availability This constructor is only available when #TOML_ENABLE_WINDOWS_COMPAT is enabled.
+ TOML_NODISCARD_CTOR
+ explicit key(std::wstring_view k, source_region&& src = {}) //
+ : key_{ impl::narrow(k) },
+ source_{ std::move(src) }
+ {}
+
+ /// \brief Constructs a key from a wide string and source region.
+ ///
+ /// \availability This constructor is only available when #TOML_ENABLE_WINDOWS_COMPAT is enabled.
+ TOML_NODISCARD_CTOR
+ explicit key(std::wstring_view k, const source_region& src) //
+ : key_{ impl::narrow(k) },
+ source_{ src }
+ {}
+
+#endif
+
+ /// \name String operations
+ /// @{
+
+ /// \brief Returns a view of the key's underlying string.
+ TOML_PURE_INLINE_GETTER
+ std::string_view str() const noexcept
+ {
+ return std::string_view{ key_ };
+ }
+
+ /// \brief Returns a view of the key's underlying string.
+ TOML_PURE_INLINE_GETTER
+ /*implicit*/ operator std::string_view() const noexcept
+ {
+ return str();
+ }
+
+ /// \brief Returns true if the key's underlying string is empty.
+ TOML_PURE_INLINE_GETTER
+ bool empty() const noexcept
+ {
+ return key_.empty();
+ }
+
+ /// \brief Returns a pointer to the start of the key's underlying string.
+ TOML_PURE_INLINE_GETTER
+ const char* data() const noexcept
+ {
+ return key_.data();
+ }
+
+ /// \brief Returns the length of the key's underlying string.
+ TOML_PURE_INLINE_GETTER
+ size_t length() const noexcept
+ {
+ return key_.length();
+ }
+
+ /// @}
+
+ /// \name Metadata
+ /// @{
+
+ /// \brief Returns the source region responsible for specifying this key during parsing.
+ TOML_PURE_INLINE_GETTER
+ const source_region& source() const noexcept
+ {
+ return source_;
+ }
+
+ /// @}
+
+ /// \name Equality and Comparison
+ /// \attention These operations only compare the underlying strings; source regions are ignored for the purposes of all comparison!
+ /// @{
+
+ /// \brief Returns true if `lhs.str() == rhs.str()`.
+ TOML_PURE_INLINE_GETTER
+ friend bool operator==(const key& lhs, const key& rhs) noexcept
+ {
+ return lhs.key_ == rhs.key_;
+ }
+
+ /// \brief Returns true if `lhs.str() != rhs.str()`.
+ TOML_PURE_INLINE_GETTER
+ friend bool operator!=(const key& lhs, const key& rhs) noexcept
+ {
+ return lhs.key_ != rhs.key_;
+ }
+
+ /// \brief Returns true if `lhs.str() < rhs.str()`.
+ TOML_PURE_INLINE_GETTER
+ friend bool operator<(const key& lhs, const key& rhs) noexcept
+ {
+ return lhs.key_ < rhs.key_;
+ }
+
+ /// \brief Returns true if `lhs.str() <= rhs.str()`.
+ TOML_PURE_INLINE_GETTER
+ friend bool operator<=(const key& lhs, const key& rhs) noexcept
+ {
+ return lhs.key_ <= rhs.key_;
+ }
+
+ /// \brief Returns true if `lhs.str() > rhs.str()`.
+ TOML_PURE_INLINE_GETTER
+ friend bool operator>(const key& lhs, const key& rhs) noexcept
+ {
+ return lhs.key_ > rhs.key_;
+ }
+
+ /// \brief Returns true if `lhs.str() >= rhs.str()`.
+ TOML_PURE_INLINE_GETTER
+ friend bool operator>=(const key& lhs, const key& rhs) noexcept
+ {
+ return lhs.key_ >= rhs.key_;
+ }
+
+ /// \brief Returns true if `lhs.str() == rhs`.
+ TOML_PURE_INLINE_GETTER
+ friend bool operator==(const key& lhs, std::string_view rhs) noexcept
+ {
+ return lhs.key_ == rhs;
+ }
+
+ /// \brief Returns true if `lhs.str() != rhs`.
+ TOML_PURE_INLINE_GETTER
+ friend bool operator!=(const key& lhs, std::string_view rhs) noexcept
+ {
+ return lhs.key_ != rhs;
+ }
+
+ /// \brief Returns true if `lhs.str() < rhs`.
+ TOML_PURE_INLINE_GETTER
+ friend bool operator<(const key& lhs, std::string_view rhs) noexcept
+ {
+ return lhs.key_ < rhs;
+ }
+
+ /// \brief Returns true if `lhs.str() <= rhs`.
+ TOML_PURE_INLINE_GETTER
+ friend bool operator<=(const key& lhs, std::string_view rhs) noexcept
+ {
+ return lhs.key_ <= rhs;
+ }
+
+ /// \brief Returns true if `lhs.str() > rhs`.
+ TOML_PURE_INLINE_GETTER
+ friend bool operator>(const key& lhs, std::string_view rhs) noexcept
+ {
+ return lhs.key_ > rhs;
+ }
+
+ /// \brief Returns true if `lhs.str() >= rhs`.
+ TOML_PURE_INLINE_GETTER
+ friend bool operator>=(const key& lhs, std::string_view rhs) noexcept
+ {
+ return lhs.key_ >= rhs;
+ }
+
+ /// \brief Returns true if `lhs == rhs.str()`.
+ TOML_PURE_INLINE_GETTER
+ friend bool operator==(std::string_view lhs, const key& rhs) noexcept
+ {
+ return lhs == rhs.key_;
+ }
+
+ /// \brief Returns true if `lhs != rhs.str()`.
+ TOML_PURE_INLINE_GETTER
+ friend bool operator!=(std::string_view lhs, const key& rhs) noexcept
+ {
+ return lhs != rhs.key_;
+ }
+
+ /// \brief Returns true if `lhs < rhs.str()`.
+ TOML_PURE_INLINE_GETTER
+ friend bool operator<(std::string_view lhs, const key& rhs) noexcept
+ {
+ return lhs < rhs.key_;
+ }
+
+ /// \brief Returns true if `lhs <= rhs.str()`.
+ TOML_PURE_INLINE_GETTER
+ friend bool operator<=(std::string_view lhs, const key& rhs) noexcept
+ {
+ return lhs <= rhs.key_;
+ }
+
+ /// \brief Returns true if `lhs > rhs.str()`.
+ TOML_PURE_INLINE_GETTER
+ friend bool operator>(std::string_view lhs, const key& rhs) noexcept
+ {
+ return lhs > rhs.key_;
+ }
+
+ /// \brief Returns true if `lhs >= rhs.str()`.
+ TOML_PURE_INLINE_GETTER
+ friend bool operator>=(std::string_view lhs, const key& rhs) noexcept
+ {
+ return lhs >= rhs.key_;
+ }
+
+ /// @}
+
+ /// \name Iteration
+ /// @{
+
+ /// \brief A const iterator for iterating over the characters in the key.
+ using const_iterator = const char*;
+
+ /// \brief A const iterator for iterating over the characters in the key.
+ using iterator = const_iterator;
+
+ /// \brief Returns an iterator to the first character in the key's backing string.
+ TOML_PURE_INLINE_GETTER
+ const_iterator begin() const noexcept
+ {
+ return key_.data();
+ }
+
+ /// \brief Returns an iterator to one-past-the-last character in the key's backing string.
+ TOML_PURE_INLINE_GETTER
+ const_iterator end() const noexcept
+ {
+ return key_.data() + key_.length();
+ }
+
+ /// @}
+
+ /// \brief Prints the key's underlying string out to the stream.
+ friend std::ostream& operator<<(std::ostream& lhs, const key& rhs)
+ {
+ impl::print_to_stream(lhs, rhs.key_);
+ return lhs;
+ }
+ };
+
+ /// \brief Metafunction for determining if a type is, or is a reference to, a toml::key.
+ template <typename T>
+ inline constexpr bool is_key = std::is_same_v<impl::remove_cvref<T>, toml::key>;
+
+ /// \brief Metafunction for determining if a type is, or is a reference to, a toml::key,
+ /// or is implicitly or explicitly convertible to one.
+ template <typename T>
+ inline constexpr bool is_key_or_convertible = is_key<T> //
+ || impl::is_constructible_or_convertible<toml::key, T>;
+}
+TOML_NAMESPACE_END;
+
+#include "header_end.hpp"
generated by cgit v1.2.3 (git 2.39.1) at 2026-03-12 22:17:09 +0000