// // Copyright (c) 2019 Vinnie Falco (vinnie.falco@gmail.com) // Copyright (c) 2020 Krystian Stasiowski (sdkrystian@gmail.com) // // Distributed under the Boost Software License, Version 1.0. (See accompanying // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) // // Official repository: https://github.com/boostorg/json // #ifndef BOOST_JSON_VALUE_HPP #define BOOST_JSON_VALUE_HPP #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace boost { namespace json { //---------------------------------------------------------- /** The type used to represent any JSON value This is a [Regular](https://en.cppreference.com/w/cpp/concepts/regular) type which works like a variant of the basic JSON data types: array, object, string, number, boolean, and null. @par Thread Safety Distinct instances may be accessed concurrently. Non-const member functions of a shared instance may not be called concurrently with any other member functions of that instance. */ class value { #ifndef BOOST_JSON_DOCS using scalar = detail::scalar; union { storage_ptr sp_; // must come first array arr_; object obj_; string str_; scalar sca_; }; #endif struct init_iter; #ifndef BOOST_JSON_DOCS // VFALCO doc toolchain incorrectly treats this as public friend struct detail::access; #endif explicit value( detail::unchecked_array&& ua) : arr_(std::move(ua)) { } explicit value( detail::unchecked_object&& uo) : obj_(std::move(uo)) { } value( detail::key_t const&, string_view s, storage_ptr sp) : str_(detail::key_t{}, s, std::move(sp)) { } value( detail::key_t const&, string_view s1, string_view s2, storage_ptr sp) : str_(detail::key_t{}, s1, s2, std::move(sp)) { } inline bool is_scalar() const noexcept { return sca_.k < json::kind::string; } public: /// Associated [Allocator](https://en.cppreference.com/w/cpp/named_req/Allocator) using allocator_type = container::pmr::polymorphic_allocator; /** Destructor. The value and all of its contents are destroyed. Any dynamically allocated memory that was allocated internally is freed. @par Complexity Constant, or linear in size for array or object. @par Exception Safety No-throw guarantee. */ BOOST_JSON_DECL ~value() noexcept; /** Constructors. Construct a new `value`. @li **(1)**--**(3)** the constructed value is null. @li **(4)** the constructed value contains a copy of `b`. @li **(5)**--**(9)** the constructed value contains a copy of `i`. @li **(10)**--**(14)** the constructed value contains a copy of `u`. @li **(15)** the constructed value contains a copy of `d`. @li **(16)**, **(19)** the constructed value contains a copy of the string `s`. @li **(17)** the constructed value contains a copy of the null-terminated string `s`. @li **(18)** the constructed value takes ownership of `s`'s storage. @li **(20)** if `*s.storage() == *sp` equivalent to **(18)**, otherwise equivalent to **(19)**. @li **(21)** the constructed value contains an empty string. @li **(22)** the constructed value takes ownership of `arr`'s storage. @li **(23)** the constructed value contains an element-wise copy of the array `arr`. @li **(24)** if `*arr.storage() == *sp` equivalent to **(22)**, otherwise equivalent to **(23)**. @li **(25)** the constructed value contains an empty array. @li **(26)** the constructed value takes ownership of `obj`'s storage. @li **(27)** the constructed value contains an element-wise copy of the object `obj`. @li **(28)** if `*obj.storage() == *sp` equivalent to **(26)**, otherwise equivalent to **(27)**. @li **(29)** the constructed value contains an empty object. @li **(30)** the constructed value's contents are formed by constructing from `init` and `sp` (see \<\\>). @li **(31)**, **(32)** the constructed value contains a copy of the contents of `other`. @li **(33)** the constructed value acquires ownership of the contents of `other`. @li **(34)** equivalent to **(33)** if `*sp == *other.storage()`; otherwise equivalent to **(32)**. @li **(35)** the constructed value acquires ownership of the contents of `other` using pilfer semantics. This is more efficient than move construction, when it is known that the moved-from object will be immediately destroyed afterwards. With **(2)**--**(17)**, **(19)**--**(21)**, **(23)**--**(25)**, {sp} **(27)**--**(30)**, **(32)**, and **(34)** the constructed value uses memory resource of `sp`. With **(18)**, **(22)**, **(26)**, {sp} **(31)**, **(33)**, and **(35)** it uses the memory resource of the argument (`s`, `arr`, obj`, or `value`). In either case the value will share the ownership of the memory resource. With **(1)** it uses the \<\\>. After **(18)**, **(22)**, **(26)**, and **(33)** the argument behaves as if newly constructed with its current storage pointer (i.e. becomes an empty string, array, object, or null value). After **(35)** `other` is not in a usable state and may only be destroyed. @par Complexity @li **(1)**--**(15)**, **(18)**, **(21)**, **(22)**, **(25)**, {sp} **(26)**, **(29)**, **(33)**, **(35)** constant. @li **(16)**, **(19)** linear in `s.size()`. @li **(17)** linear in `std::strlen(s)`. @li **(20)** if `*s.storage() == *sp` constant, otherwise linear in `s.size()`. @li **(23)** linear in `arr.size()`. @li **(24)** if `*arr.storage() == *sp` constant, otherwise linear in `arr.size()`. @li **(27)** linear in `obj.size()`. @li **(28)** if `*obj.storage() == *sp` constant, otherwise linear in `obj.size()`. @li **(30)** linear in `init.size()`. @li **(31)**, **(32)** linear in the size of `other`. @li **(34)** constant if `*sp == *other.storage()`; otherwise linear in the size of `other`. The size of `other` is either the size of the underlying container (if there is one), or can be considered to be 1. @par Exception Safety @li **(1)**--**(15)**, **(18)**, **(21)**, **(22)**, **(25)**, **(26)**, **(29)**, **(33)**, **(35)** no-throw guarantee. @li **(16)**, **(17)**, **(19)**, **(23)**, **(27)**, **(30)**--**(32)** strong guarantee. @li **(20)** if `*s.storage() == *sp` no-throw guarantee, otherwise strong guarantee. @li **(24)** if `*arr.storage() == *sp` no-throw guarantee, otherwise strong guarantee. @li **(28)** if `*obj.storage() == *sp` no-throw guarantee, otherwise strong guarantee. @li **(33)** if `*other.storage() == *sp` no-throw guarantee, otherwise strong guarantee. Calls to `memory_resource::allocate` may throw. @see @ref pilfer, [Valueless Variants Considered Harmful](http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2016/p0308r0.html). // @{ */ value() noexcept : sca_() { } /** Overload @param sp A pointer to the @ref boost::container::pmr::memory_resource to use. */ explicit value(storage_ptr sp) noexcept : sca_(std::move(sp)) { } /// Overload value( std::nullptr_t, storage_ptr sp = {}) noexcept : sca_(std::move(sp)) { } /** Overload @param b The boolean to construct with. @param sp */ #ifdef BOOST_JSON_DOCS value( bool b, storage_ptr sp = {}) noexcept; #else template::value>::type > value( T b, storage_ptr sp = {}) noexcept : sca_(b, std::move(sp)) { } #endif /** Overload @param i The number to construct with. @param sp */ value( signed char i, storage_ptr sp = {}) noexcept : sca_(static_cast( i), std::move(sp)) { } /// Overload value( short i, storage_ptr sp = {}) noexcept : sca_(static_cast( i), std::move(sp)) { } /// Overload value( int i, storage_ptr sp = {}) noexcept : sca_(static_cast(i), std::move(sp)) { } /// Overload value( long i, storage_ptr sp = {}) noexcept : sca_(static_cast(i), std::move(sp)) { } /// Overload value( long long i, storage_ptr sp = {}) noexcept : sca_(static_cast(i), std::move(sp)) { } /** Overload @param u The number to construct with. @param sp */ value( unsigned char u, storage_ptr sp = {}) noexcept : sca_(static_cast( u), std::move(sp)) { } /// Overload value( unsigned short u, storage_ptr sp = {}) noexcept : sca_(static_cast(u), std::move(sp)) { } /// Overload value( unsigned int u, storage_ptr sp = {}) noexcept : sca_(static_cast(u), std::move(sp)) { } /// Overload value( unsigned long u, storage_ptr sp = {}) noexcept : sca_(static_cast(u), std::move(sp)) { } /// Overload value( unsigned long long u, storage_ptr sp = {}) noexcept : sca_(static_cast(u), std::move(sp)) { } /** Overload @param d The number to construct with. @param sp */ value( double d, storage_ptr sp = {}) noexcept : sca_(d, std::move(sp)) { } /** Overload @param s The string to construct with. @param sp */ value( string_view s, storage_ptr sp = {}) : str_(s, std::move(sp)) { } /// Overload value( char const* s, storage_ptr sp = {}) : str_(s, std::move(sp)) { } /// Overload value( string s) noexcept : str_(std::move(s)) { } /// Overload value( string const& s, storage_ptr sp) : str_( s, std::move(sp)) { } /// Overload value( string&& s, storage_ptr sp) : str_( std::move(s), std::move(sp)) { } /// Overload value( string_kind_t, storage_ptr sp = {}) noexcept : str_(std::move(sp)) { } /** Overload @param arr The array to construct with. */ value(array arr) noexcept : arr_(std::move(arr)) { } /// Overload value( array const& arr, storage_ptr sp) : arr_( arr, std::move(sp)) { } /// Overload value( array&& arr, storage_ptr sp) : arr_( std::move(arr), std::move(sp)) { } /// Overload value( array_kind_t, storage_ptr sp = {}) noexcept : arr_(std::move(sp)) { } /** Overload @param obj The object to construct with. */ value(object obj) noexcept : obj_(std::move(obj)) { } /// Overload value( object const& obj, storage_ptr sp) : obj_( obj, std::move(sp) ) { } /// Overload value( object&& obj, storage_ptr sp) : obj_( std::move(obj), std::move(sp) ) { } /// Overload value( object_kind_t, storage_ptr sp = {}) noexcept : obj_(std::move(sp)) { } /** Overload @param init The initializer list to construct from. @param sp */ BOOST_JSON_DECL value( std::initializer_list init, storage_ptr sp = {}); /** Overload @param other Another `value`. */ value(value const& other) : value(other, other.storage()) { } /// Overload BOOST_JSON_DECL value( value const& other, storage_ptr sp); /// Overload BOOST_JSON_DECL value(value&& other) noexcept; /// Overload BOOST_JSON_DECL value( value&& other, storage_ptr sp); /// Overload value(pilfered other) noexcept { relocate(this, other.get()); ::new(&other.get().sca_) scalar(); } /// @} //------------------------------------------------------ // // Assignment // //------------------------------------------------------ /** Assignment. Replaces the contents of this value. @li **(1)** replaces with an element-wise copy of the contents of `other`. @li **(2)** replaces with the contents `other` using move semantics (see below). @li **(3)** replaces with the value formed by constructing from `init` and `this->storage()` (see \<\\>). @li **(4)** replaces with null. @li **(5)** replaces with the boolean value `b`. @li **(6)**--**(10)** replaces with the signed integer `i`. @li **(11)**--**(15)** replaces with the unsigned integer `u`. @li **(16)** replaces with the number `d`. @li **(17)**, **(19)** replaces with a copy of the string `s`. @li **(18)**, equivalent to `*this = string_view(s)`. @li **(20)** replaces with the string `s` using move semantics see below. @li **(21)** replaces with a copy of the array `arr`. @li **(22)** replaces with the array `arr` using move semantics (see below). @li **(23)** replaces with a copy of the object `obj`. @li **(24)** replaces with the object `obj` using move semantics (see below). Move assignment for `value` never changes the associated memory resource. Because of this if the memory resource of the assigned value differs from that of `*this`, the operation is equivalent to a copy. Otherwise, it replaces the underlying storage in constant time without the possibility of exceptions. @par Complexity @li **(1)** linear in the sizes of `*this` and `other`. @li **(2)** constant if `*this->storage() == *other.storage()`, otherwise linear in the sizes of `*this` and `other`. @li **(3)** linear in the sizes of `*this` and `init`. @li **(4)**--**(16)** linear in the size of `*this`. @li **(17)**, **(19)** linear in the size of `*this` and `s.size()`. @li **(18)** linear in the size of `*this` and `std::strlen(s)`. @li **(22)** constant if `*this->storage() == *s.storage()`, otherwise linear in the size of `*this` and `s.size()`. @li **(21)** linear in the size of `*this` and `arr.size()`. @li **(22)** constant if `*this->storage() == *arr.storage()`, otherwise linear in the size of `*this` and `arr.size()`. @li **(23)** linear in the size of `*this` and `obj.size()`. @li **(24)** constant if `*this->storage() == *obj.storage()`, otherwise linear in the size of `*this` and `obj.size()`. The size of `*this` is either the size of the underlying container (if there is one), or can be considered to be 1. @par Exception Safety @li **(1)**--**(3)**, **(17)**--**(24)** strong guarantee. @li **(4)**--**(16)** no-throw guarantee. Calls to `memory_resource::allocate` may throw. @param other The source value. @{ */ BOOST_JSON_DECL value& operator=(value const& other); /** Overload The contents of the value are replaced with the contents of `other` using move semantics: @li If `*other.storage() == *sp`, ownership of the underlying memory is transferred in constant time, with no possibility of exceptions. After assignment, the moved-from value becomes a null with its current storage pointer. @li If `*other.storage() != *sp`, an element-wise copy is performed if `other.is_structured() == true`, which may throw. In this case, the moved-from value is not changed. */ BOOST_JSON_DECL value& operator=(value&& other); /** Overload @param init The initializer list to assign from. */ BOOST_JSON_DECL value& operator=( std::initializer_list init); /// Overload value& operator=(std::nullptr_t) noexcept { if(is_scalar()) { sca_.k = json::kind::null; } else { ::new(&sca_) scalar( destroy()); } return *this; } /** Overload @param b The new value. */ #ifdef BOOST_JSON_DOCS value& operator=(bool b) noexcept; #else template::value>::type > value& operator=(T b) noexcept { if(is_scalar()) { sca_.b = b; sca_.k = json::kind::bool_; } else { ::new(&sca_) scalar( b, destroy()); } return *this; } #endif /** Overload @param i The new value. */ value& operator=(signed char i) noexcept { return operator=( static_cast(i)); } /// Overload value& operator=(short i) noexcept { return operator=( static_cast(i)); } /// Overload value& operator=(int i) noexcept { return operator=( static_cast(i)); } /// Overload value& operator=(long i) noexcept { return operator=( static_cast(i)); } /// Overload value& operator=(long long i) noexcept { if(is_scalar()) { sca_.i = i; sca_.k = json::kind::int64; } else { ::new(&sca_) scalar(static_cast< std::int64_t>(i), destroy()); } return *this; } /** Overload @param u The new value. */ value& operator=(unsigned char u) noexcept { return operator=(static_cast< unsigned long long>(u)); } /// Overload value& operator=(unsigned short u) noexcept { return operator=(static_cast< unsigned long long>(u)); } /// Overload value& operator=(unsigned int u) noexcept { return operator=(static_cast< unsigned long long>(u)); } /// Overload value& operator=(unsigned long u) noexcept { return operator=(static_cast< unsigned long long>(u)); } /// Overload value& operator=(unsigned long long u) noexcept { if(is_scalar()) { sca_.u = u; sca_.k = json::kind::uint64; } else { ::new(&sca_) scalar(static_cast< std::uint64_t>(u), destroy()); } return *this; } /** Overload @param d The new value. */ value& operator=(double d) noexcept { if(is_scalar()) { sca_.d = d; sca_.k = json::kind::double_; } else { ::new(&sca_) scalar( d, destroy()); } return *this; } /** Overload @param s The new string. */ BOOST_JSON_DECL value& operator=(string_view s); /// Overload BOOST_JSON_DECL value& operator=(char const* s); /// Overload BOOST_JSON_DECL value& operator=(string const& s); /** Overload The contents of the value are replaced with the contents of `s` using move semantics: @li If `*other.storage() == *this->storage()`, ownership of the underlying memory is transferred in constant time, with no possibility of exceptions. After assignment, the moved-from string becomes empty with its current storage pointer. @li If `*other.storage() != *this->storage()`, an element-wise copy is performed, which may throw. In this case, the moved-from string is not changed. @param s The string to move-assign from. */ BOOST_JSON_DECL value& operator=(string&& s); /** Overload Replace `*this` with a copy of the array `arr`. @par Exception Safety Strong guarantee. Calls to `memory_resource::allocate` may throw. @par Complexity Linear in the sum of sizes of `*this` and `arr` @param arr The new array. */ BOOST_JSON_DECL value& operator=(array const& arr); /** Overload The contents of the value are replaced with the contents of `arr` using move semantics: @li If `*arr.storage() == *this->storage()`, ownership of the underlying memory is transferred in constant time, with no possibility of exceptions. After assignment, the moved-from array becomes empty with its current storage pointer. @li If `*arr.storage() != *this->storage()`, an element-wise copy is performed, which may throw. In this case, the moved-from array is not changed. @par Complexity Constant, or linear in the size of `*this` plus `arr.size()`. @par Exception Safety Strong guarantee. Calls to `memory_resource::allocate` may throw. @param arr The array to move-assign from. */ BOOST_JSON_DECL value& operator=(array&& arr); /** Overload Replace `*this` with a copy of the obect `obj`. @par Exception Safety Strong guarantee. Calls to `memory_resource::allocate` may throw. @par Complexity Linear in the sum of sizes of `*this` and `obj` @param obj The new object. */ BOOST_JSON_DECL value& operator=(object const& obj); /** Overload The contents of the value are replaced with the contents of `obj` using move semantics: @li If `*obj.storage() == *this->storage()`, ownership of the underlying memory is transferred in constant time, with no possibility of exceptions. After assignment, the moved-from object becomes empty with its current storage pointer. @li If `*obj.storage() != *this->storage()`, an element-wise copy is performed, which may throw. In this case, the moved-from object is not changed. @par Complexity Constant, or linear in the size of `*this` plus `obj.size()`. @par Exception Safety Strong guarantee. Calls to `memory_resource::allocate` may throw. @param obj The object to move-assign from. */ BOOST_JSON_DECL value& operator=(object&& obj); /// @} //------------------------------------------------------ // // Modifiers // //------------------------------------------------------ /** Replace with a null value. The current value is destroyed and the kind is changed to kind::null. The associated memeory resource is kept unchanged. @par Complexity Linear in the size of `*this`. @par Exception Safety No-throw guarantee. */ void emplace_null() noexcept { *this = nullptr; } /** Replace with a `bool` value. The value is replaced with a `bool` initialized to `false`, destroying the previous contents, but keeping the memeory resource. @par Complexity Linear in the size of `*this`. @par Exception Safety No-throw guarantee. @return `this->get_bool()`. */ bool& emplace_bool() noexcept { *this = false; return sca_.b; } /** Replace with a `std::int64_t` value. The value is replaced with a `std::int64_t` initialized to zero, destroying the previous contents, but keeping the memeory resource. @par Complexity Linear in the size of `*this`. @par Exception Safety No-throw guarantee. @return `this->get_int64()`. */ std::int64_t& emplace_int64() noexcept { *this = std::int64_t{}; return sca_.i; } /** Replace with a `std::uint64_t` value. The value is replaced with a `std::uint64_t` initialized to zero, destroying the the previous contents, but keeping the memeory resource. @par Complexity Linear in the size of `*this`. @par Exception Safety No-throw guarantee. @return `this->get_uint64()`. */ std::uint64_t& emplace_uint64() noexcept { *this = std::uint64_t{}; return sca_.u; } /** Replace with a `double` value. The value is replaced with a `double` initialized to zero, destroying the previous contents, but keeping the memeory resource. @par Complexity Linear in the size of `*this`. @par Exception Safety No-throw guarantee. @return `this->get_double()`. */ double& emplace_double() noexcept { *this = double{}; return sca_.d; } /** Replace with an empty @ref string. The value is replaced with an empty @ref string using the current memory resource, destroying the previous contents. All previously obtained iterators and references obtained beforehand are invalidated. @par Complexity Linear in the size of `*this`. @par Exception Safety No-throw guarantee. @return `this->get_string()`. */ BOOST_JSON_DECL string& emplace_string() noexcept; /** Replace with an empty array. The value is replaced with an empty @ref array using the current memory resource, destroying the previous contents. All previously obtained iterators and references obtained beforehand are invalidated. @par Complexity Linear in the size of `*this`. @par Exception Safety No-throw guarantee. @return `this->get_array()`. */ BOOST_JSON_DECL array& emplace_array() noexcept; /** Replace with an empty @ref object. The value is replaced with an empty @ref array using the current memory resource, destroying the previous contents. All previously obtained iterators and references obtained beforehand are invalidated. @par Complexity Linear in the size of `*this`. @par Exception Safety No-throw guarantee. @return `this->get_object()`. */ BOOST_JSON_DECL object& emplace_object() noexcept; /** Swap the given values. Exchanges the contents of this value with another value. Ownership of the respective @ref boost::container::pmr::memory_resource objects is not transferred: @li If `this == &other`, this function has no effect. @li If `*other.storage() == *this->storage()`, ownership of the underlying memory is swapped in constant time, with no possibility of exceptions. All iterators and references remain valid. @li If `*other.storage() != *this->storage()`, the contents are logically swapped by making copies, which can throw. In this case all iterators and references are invalidated. @par Complexity Constant or linear in the sum of the sizes of the values. @par Exception Safety Strong guarantee. Calls to `memory_resource::allocate` may throw. @param other The value to swap with. */ BOOST_JSON_DECL void swap(value& other); /** Swap the given values. Exchanges the contents of value `lhs` with another value `rhs`. Ownership of the respective @ref boost::container::pmr::memory_resource objects is not transferred. @li If `&lhs == &rhs`, this function call has no effect. @li If `*lhs.storage() == *rhs.storage()`, ownership of the underlying memory is swapped in constant time, with no possibility of exceptions. All iterators and references remain valid. @li If `*lhs.storage() != *rhs.storage`, the contents are logically swapped by a copy, which can throw. In this case all iterators and references are invalidated. @par Complexity Constant or linear in the sum of the sizes of the values. @par Exception Safety Strong guarantee. Calls to `memory_resource::allocate` may throw. @param lhs The value to exchange. @param rhs The value to exchange. @see @ref value::swap */ friend void swap(value& lhs, value& rhs) { lhs.swap(rhs); } //------------------------------------------------------ // // Observers // //------------------------------------------------------ /** Returns the kind of this JSON value. This function returns the discriminating enumeration constant of type @ref json::kind corresponding to the underlying representation stored in the container. @par Complexity Constant. @par Exception Safety No-throw guarantee. */ json::kind kind() const noexcept { return static_cast( static_cast( sca_.k) & 0x3f); } /** Check if this is an @ref array. Returns `true` if the value's @ref kind() is `kind::array`. @returns `this->kind() == kind::array`. @par Complexity Constant. @par Exception Safety No-throw guarantee. */ bool is_array() const noexcept { return kind() == json::kind::array; } /** Check if this is an @ref object. Returns `true` if the value's @ref kind() is `kind::object`. @returns `this->kind() == kind::object`. @par Complexity Constant. @par Exception Safety No-throw guarantee. */ bool is_object() const noexcept { return kind() == json::kind::object; } /** Check if this is a @ref string. Returns `true` if the value's @ref kind() is `kind::string`. @returns `this->kind() == kind::string`. @par Complexity Constant. @par Exception Safety No-throw guarantee. */ bool is_string() const noexcept { return kind() == json::kind::string; } /** Check if this is a `std::int64_t`. Returns `true` if the value's @ref kind() is `kind::int64`. @returns `this->kind() == kind::int64`. @par Complexity Constant. @par Exception Safety No-throw guarantee. */ bool is_int64() const noexcept { return kind() == json::kind::int64; } /** Checks if this is a `std::uint64_t`. Returns `true` if the value's @ref kind() is `kind::uint64`. @returns `this->kind() == kind::uint64`. @par Complexity Constant. @par Exception Safety No-throw guarantee. */ bool is_uint64() const noexcept { return kind() == json::kind::uint64; } /** Check if this is a `double`. Returns `true` if the value's @ref kind() is `kind::double_`. @returns `this->kind() == kind::double_`. @par Complexity Constant. @par Exception Safety No-throw guarantee. */ bool is_double() const noexcept { return kind() == json::kind::double_; } /** Check if this is a `bool`. Returns `true` if the value's @ref kind() is `kind::bool_`. @returns `this->kind() == kind::bool_`. @par Complexity Constant. @par Exception Safety No-throw guarantee. */ bool is_bool() const noexcept { return kind() == json::kind::bool_; } /** Check if this is a null value. Returns `true` if the value's @ref kind() is `kind::null`. @returns `this->kind() == kind::null`. @par Complexity Constant. @par Exception Safety No-throw guarantee. */ bool is_null() const noexcept { return kind() == json::kind::null; } /** Checks if this is an @ref array or an @ref object. This function returns `true` if @ref kind() is either `kind::object` or `kind::array`. @par Complexity Constant. @par Exception Safety No-throw guarantee. */ bool is_structured() const noexcept { // VFALCO Could use bit 0x20 for this return kind() == json::kind::object || kind() == json::kind::array; } /** Check if this is not an @ref array or @ref object. This function returns `true` if @ref kind() is neither `kind::object` nor `kind::array`. @par Complexity Constant. @par Exception Safety No-throw guarantee. */ bool is_primitive() const noexcept { // VFALCO Could use bit 0x20 for this return sca_.k != json::kind::object && sca_.k != json::kind::array; } /** Check if this is a number. This function returns `true` when @ref kind() is one of `kind::int64`, `kind::uint64`, or `kind::double_`. @par Complexity Constant. @par Exception Safety No-throw guarantee. */ bool is_number() const noexcept { // VFALCO Could use bit 0x40 for this return kind() == json::kind::int64 || kind() == json::kind::uint64 || kind() == json::kind::double_; } //------------------------------------------------------ /** Return a pointer to the underlying @ref array. If `this->kind() == kind::array`, returns a pointer to the underlying array. Otherwise, returns `nullptr`. @par Example The return value is used in both a boolean context and to assign a variable: @code if( auto p = jv.if_array() ) return *p; @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ array const* if_array() const noexcept { if(kind() == json::kind::array) return &arr_; return nullptr; } array* if_array() noexcept { if(kind() == json::kind::array) return &arr_; return nullptr; } /// @} /** Return a pointer to the underlying @ref object. If `this->kind() == kind::object`, returns a pointer to the underlying object. Otherwise, returns `nullptr`. @par Example The return value is used in both a boolean context and to assign a variable: @code if( auto p = jv.if_object() ) return *p; @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ object const* if_object() const noexcept { if(kind() == json::kind::object) return &obj_; return nullptr; } object* if_object() noexcept { if(kind() == json::kind::object) return &obj_; return nullptr; } /// @} /** Return a pointer to the underlying @ref string. If `this->kind() == kind::string`, returns a pointer to the underlying object. Otherwise, returns `nullptr`. @par Example The return value is used in both a boolean context and to assign a variable: @code if( auto p = jv.if_string() ) return *p; @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ string const* if_string() const noexcept { if(kind() == json::kind::string) return &str_; return nullptr; } string* if_string() noexcept { if(kind() == json::kind::string) return &str_; return nullptr; } /// @} /** Return a pointer to the underlying `std::int64_t`. If `this->kind() == kind::int64`, returns a pointer to the underlying integer. Otherwise, returns `nullptr`. @par Example The return value is used in both a boolean context and to assign a variable: @code if( auto p = jv.if_int64() ) return *p; @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ std::int64_t const* if_int64() const noexcept { if(kind() == json::kind::int64) return &sca_.i; return nullptr; } std::int64_t* if_int64() noexcept { if(kind() == json::kind::int64) return &sca_.i; return nullptr; } /// @} /** Return a pointer to the underlying `std::uint64_t`. If `this->kind() == kind::uint64`, returns a pointer to the underlying unsigned integer. Otherwise, returns `nullptr`. @par Example The return value is used in both a boolean context and to assign a variable: @code if( auto p = jv.if_uint64() ) return *p; @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ std::uint64_t const* if_uint64() const noexcept { if(kind() == json::kind::uint64) return &sca_.u; return nullptr; } std::uint64_t* if_uint64() noexcept { if(kind() == json::kind::uint64) return &sca_.u; return nullptr; } /// @} /** Return a pointer to the underlying `double`. If `this->kind() == kind::double_`, returns a pointer to the underlying double. Otherwise, returns `nullptr`. @par Example The return value is used in both a boolean context and to assign a variable: @code if( auto p = jv.if_double() ) return *p; @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ double const* if_double() const noexcept { if(kind() == json::kind::double_) return &sca_.d; return nullptr; } double* if_double() noexcept { if(kind() == json::kind::double_) return &sca_.d; return nullptr; } /// @} /** Return a pointer to the underlying `bool` . If `this->kind() == kind::bool_`, returns a pointer to the underlying boolean. Otherwise, returns `nullptr`. @par Example The return value is used in both a boolean context and to assign a variable: @code if( auto p = jv.if_bool() ) return *p; @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ bool const* if_bool() const noexcept { if(kind() == json::kind::bool_) return &sca_.b; return nullptr; } bool* if_bool() noexcept { if(kind() == json::kind::bool_) return &sca_.b; return nullptr; } /// @} //------------------------------------------------------ /** Return the stored number cast to an arithmetic type. This function attempts to return the stored value converted to the arithmetic type `T` which may not be `bool`: @li If `T` is an integral type and the stored value is a number which can be losslessly converted, the conversion is performed without error and the converted number is returned. @li If `T` is an integral type and the stored value is a number which cannot be losslessly converted, then the operation fails with an error. @li If `T` is a floating point type and the stored value is a number, the conversion is performed without error. The converted number is returned, with a possible loss of precision. @li Otherwise, if the stored value is not a number; that is, if @ref is_number() returns `false`, then the operation fails with an error. @par Constraints @code std::is_arithmetic< T >::value && ! std::is_same< T, bool >::value @endcode @par Complexity Constant. @par Exception Safety @li **(1)**, **(2)** no-throw guarantee. @li **(3)** strong guarantee. @return The converted number. @param ec Set to the error, if any occurred. @return The converted number. @{ */ template #ifdef BOOST_JSON_DOCS T #else typename std::enable_if< std::is_arithmetic::value && ! std::is_same::value, T>::type #endif to_number(system::error_code& ec) const noexcept { error e; auto result = to_number(e); BOOST_JSON_FAIL(ec, e); return result; } template #ifdef BOOST_JSON_DOCS T #else typename std::enable_if< std::is_arithmetic::value && ! std::is_same::value, T>::type #endif to_number(std::error_code& ec) const noexcept { system::error_code jec; auto result = to_number(jec); ec = jec; return result; } /** Overload @throws boost::system::system_error Overload **(3)** reports errors by throwing an exception. */ template #ifdef BOOST_JSON_DOCS T #else typename std::enable_if< std::is_arithmetic::value && ! std::is_same::value, T>::type #endif to_number() const { return try_to_number().value(); } /// @} /** Return the stored number as @ref boost::system::result. This function attempts to return the stored value converted to the arithmetic type `T` which may not be `bool`: @li If `T` is an integral type and the stored value is a number which can be losslessly converted, the conversion is performed without error and `result` containing the converted number is returned. @li If `T` is an integral type and the stored value is a number which cannot be losslessly converted, then `result` containing the corresponding `error_code` is returned. @li If `T` is a floating point type and the stored value is a number, the conversion is performed without error. `result` containing the converted number, with a possible loss of precision, is returned. @li Otherwise, if the stored value is not a number; that is, if `this->is_number()` returns `false`, then `result` containing the corresponding `error_code` is returned. @par Constraints @code std::is_arithmetic< T >::value && ! std::is_same< T, bool >::value @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. @return `boost::system::result` with either the converted number or an `error_code`. */ template #ifdef BOOST_JSON_DOCS system::result #else typename std::enable_if< std::is_arithmetic::value && ! std::is_same::value, system::result >::type #endif try_to_number() const noexcept { system::error_code ec; T result = to_number(ec); if( ec ) return {system::in_place_error, ec}; return {system::in_place_value, result}; } //------------------------------------------------------ // // Accessors // //------------------------------------------------------ /** Return the associated memory resource. This function returns a smart pointer to the @ref boost::container::pmr::memory_resource used by the container. @par Complexity Constant. @par Exception Safety No-throw guarantee. */ storage_ptr const& storage() const noexcept { return sp_; } /** Return the associated allocator. This function returns an instance of @ref allocator_type constructed from the associated @ref boost::container::pmr::memory_resource. @par Complexity Constant. @par Exception Safety No-throw guarantee. */ allocator_type get_allocator() const noexcept { return sp_.get(); } //------------------------------------------------------ /** Return `result` with a reference to the underlying @ref array If @ref is_array() is `true`, the result contains a reference to the underlying @ref array, otherwise it contains an `error_code`. @par Example The return value can be used in both a boolean context and to assign a variable: @code if( auto r = jv.try_as_array() ) return *r; @endcode But can also be used to throw an exception on error: @code return jv.try_as_array().value(); @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ BOOST_JSON_DECL system::result try_as_array() noexcept; BOOST_JSON_DECL system::result try_as_array() const noexcept; /// @} /** Return `result` with a reference to the underlying @ref object. If @ref is_object() is `true`, the result contains a reference to the underlying @ref object, otherwise it contains an `error_code`. @par Example The return value can be used in both a boolean context and to assign a variable: @code if( auto r = jv.try_as_object() ) return *r; @endcode But can also be used to throw an exception on error: @code return jv.try_as_object().value(); @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ BOOST_JSON_DECL system::result try_as_object() noexcept; BOOST_JSON_DECL system::result try_as_object() const noexcept; /// @} /** Return `result` with a reference to the underlying @ref string. If @ref is_string() is `true`, the result contains a reference to the underlying @ref string, otherwise it contains an `error_code`. @par Example The return value can be used in both a boolean context and to assign a variable: @code if( auto r = jv.try_as_string() ) return *r; @endcode But can also be used to throw an exception on error: @code return jv.try_as_string().value(); @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ BOOST_JSON_DECL system::result try_as_string() noexcept; BOOST_JSON_DECL system::result try_as_string() const noexcept; /// @} /** Return `result` with the underlying `std::int64_t` If @ref is_int64() is `true`, the result contains a reference to **(1)** or a copy of **(2)** the underlying `std::int64_t`, otherwise it contains an `error_code`. @par Example The return value can be used in both a boolean context and to assign a variable: @code if( auto r = jv.try_as_int64() ) return *r; @endcode But can also be used to throw an exception on error: @code return jv.try_as_int64().value(); @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ BOOST_JSON_DECL system::result try_as_int64() noexcept; BOOST_JSON_DECL system::result try_as_int64() const noexcept; /// @} /** Return `result` with the underlying `std::uint64_t`. If @ref is_uint64() is `true`, the result contains a reference to **(1)** or a copy of **(2)** the underlying `std::uint64_t`, otherwise it contains an `error_code`. @par Example The return value can be used in both a boolean context and to assign a variable: @code if( auto r = jv.try_as_uint64() ) return *r; @endcode But can also be used to throw an exception on error: @code return jv.try_as_uint64().value(); @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ BOOST_JSON_DECL system::result try_as_uint64() noexcept; BOOST_JSON_DECL system::result try_as_uint64() const noexcept; /// @} /** Return `result` with the underlying `double` If @ref is_double() is `true`, the result contains a reference to **(1)** or a copy of **(2)** the underlying `double`, otherwise it contains an `error_code`. @par Example The return value can be used in both a boolean context and to assign a variable: @code if( auto r = jv.try_as_double() ) return *r; @endcode But can also be used to throw an exception on error: @code return jv.try_as_double().value(); @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ BOOST_JSON_DECL system::result try_as_double() noexcept; BOOST_JSON_DECL system::result try_as_double() const noexcept; /// @} /** Return `result` with the underlying `bool` If @ref is_bool() is `true`, the result contains a reference to **(1)** or a copy to **(2)** the underlying `bool`, otherwise it contains an `error_code`. @par Example The return value can be used in both a boolean context and to assign a variable: @code if( auto r = jv.try_as_bool() ) return *r; @endcode But can also be used to throw an exception on error: @code return jv.try_as_bool().value(); @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ BOOST_JSON_DECL system::result try_as_bool() noexcept; BOOST_JSON_DECL system::result try_as_bool() const noexcept; /// @} /** Return engaged `result` if the `value` is null. If @ref is_null() is `true`, the result is engaged, otherwise it contains an `error_code`. @par Example The return value can be used in both a boolean context and to assign a variable: @code if( auto r = jv.try_as_null() ) return *r; @endcode But can also be used to throw an exception on error: @code return jv.try_as_null().value(); @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. */ BOOST_JSON_DECL system::result try_as_null() const noexcept; //------------------------------------------------------ /** Return the underlying @ref object, or throw an exception. If @ref is_object() is `true`, returns a reference to the underlying @ref object, otherwise throws an exception. @par Exception Safety Strong guarantee. @throw boost::system::system_error `! this->is_object()`. @param loc @ref boost::source_location to use in thrown exception; the source location of the call site by default. @par Complexity Constant. @{ */ object& as_object(source_location const& loc = BOOST_CURRENT_LOCATION) & { auto& self = const_cast(*this); return const_cast( self.as_object(loc) ); } /// Overload object&& as_object(source_location const& loc = BOOST_CURRENT_LOCATION) && { return std::move( as_object(loc) ); } /// Overload BOOST_JSON_DECL object const& as_object(source_location const& loc = BOOST_CURRENT_LOCATION) const&; /// @} /** Return the underlying @ref array, or throw an exception. If @ref is_array() is `true`, returns a reference to the underlying @ref array, otherwise throws an exception. @par Exception Safety Strong guarantee. @throw boost::system::system_error `! this->is_array()`. @param loc @ref boost::source_location to use in thrown exception; the source location of the call site by default. @par Complexity Constant. @{ */ array& as_array(source_location const& loc = BOOST_CURRENT_LOCATION) & { auto& self = const_cast(*this); return const_cast( self.as_array(loc) ); } /// Overload array&& as_array(source_location const& loc = BOOST_CURRENT_LOCATION) && { return std::move( as_array(loc) ); } /// Overload BOOST_JSON_DECL array const& as_array(source_location const& loc = BOOST_CURRENT_LOCATION) const&; /// @} /** Return the underlying @ref string, or throw an exception. If @ref is_string() is `true`, returns a reference to the underlying @ref string, otherwise throws an exception. @par Exception Safety Strong guarantee. @throw boost::system::system_error `! this->is_string()`. @param loc @ref boost::source_location to use in thrown exception; the source location of the call site by default. @par Complexity Constant. @{ */ string& as_string(source_location const& loc = BOOST_CURRENT_LOCATION) & { auto& self = const_cast(*this); return const_cast( self.as_string(loc) ); } /// Overload string&& as_string(source_location const& loc = BOOST_CURRENT_LOCATION) && { return std::move( as_string(loc) ); } /// Overload BOOST_JSON_DECL string const& as_string(source_location const& loc = BOOST_CURRENT_LOCATION) const&; /// @} /** Return the underlying `std::int64_t`, or throw an exception. If @ref is_int64() is `true`, returns a reference to **(1)** or a copy of **(2)** the underlying `std::int64_t`, otherwise throws an exception. @note This function is the intended for direct access to the underlying object, __if__ it has the type `std::int64_t`. It does not convert the underlying object to the type `std::int64_t` even if a lossless conversion is possible. If you are not sure which kind your `value` has, and you only care about getting a `std::int64_t` number, consider using @ref to_number instead. @par Exception Safety Strong guarantee. @throw boost::system::system_error `! this->is_int64()`. @param loc @ref boost::source_location to use in thrown exception; the source location of the call site by default. @par Complexity Constant. @{ */ BOOST_JSON_DECL std::int64_t& as_int64(source_location const& loc = BOOST_CURRENT_LOCATION); /// Overload BOOST_JSON_DECL std::int64_t as_int64(source_location const& loc = BOOST_CURRENT_LOCATION) const; /// @} /** Return the underlying `std::uint64_t`, or throw an exception. If @ref is_uint64() is `true`, returns a reference to **(1)** or a copy of **(2)** the underlying `std::uint64_t`, otherwise throws an exception. @note This function is intended for direct access to the underlying object, __if__ it has the type `std::uint64_t`. It does not convert the underlying object to the type `std::uint64_t` even if a lossless conversion is possible. If you are not sure which kind your `value` has, and you only care about getting a `std::uint64_t` number, consider using @ref to_number instead. @par Exception Safety Strong guarantee. @throw boost::system::system_error `! this->is_uint64()`. @param loc @ref boost::source_location to use in thrown exception; the source location of the call site by default. @par Complexity Constant. @{ */ BOOST_JSON_DECL std::uint64_t& as_uint64(source_location const& loc = BOOST_CURRENT_LOCATION); /// Overload BOOST_JSON_DECL std::uint64_t as_uint64(source_location const& loc = BOOST_CURRENT_LOCATION) const; /// @} /** Return the underlying `double`, or throw an exception. If @ref is_double() is `true`, returns a reference to **(1)** or a copy of **(2)** the underlying `double`, otherwise throws an exception. @note This function is intended for direct access to the underlying object, __if__ it has the type `double`. It does not convert the underlying object to type `double` even if a lossless conversion is possible. If you are not sure which kind your `value` has, and you only care about getting a `double` number, consider using @ref to_number instead. @par Exception Safety Strong guarantee. @throw boost::system::system_error `! this->is_double()`. @param loc @ref boost::source_location to use in thrown exception; the source location of the call site by default. @par Complexity Constant. @{ */ BOOST_JSON_DECL double& as_double(source_location const& loc = BOOST_CURRENT_LOCATION); /// Overload BOOST_JSON_DECL double as_double(source_location const& loc = BOOST_CURRENT_LOCATION) const; /// @} /** Return the underlying `bool`, or throw an exception. If @ref is_bool() is `true`, returns a reference to **(1)** or a copy of **(2)** the underlying `bool`, otherwise throws an exception. @par Exception Safety Strong guarantee. @throw boost::system::system_error `! this->is_bool()`. @param loc @ref boost::source_location to use in thrown exception; the source location of the call site by default. @par Complexity Constant. @{ */ BOOST_JSON_DECL bool& as_bool(source_location const& loc = BOOST_CURRENT_LOCATION); /// Overload BOOST_JSON_DECL bool as_bool(source_location const& loc = BOOST_CURRENT_LOCATION) const; /// @} //------------------------------------------------------ /** Return the underlying @ref object, without checking. This is the fastest way to access the underlying representation when the kind is known in advance. @par Preconditions @code this->is_object() @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ object& get_object() & noexcept { BOOST_ASSERT(is_object()); return obj_; } object&& get_object() && noexcept { BOOST_ASSERT(is_object()); return std::move(obj_); } object const& get_object() const& noexcept { BOOST_ASSERT(is_object()); return obj_; } /// @} /** Return the underlying @ref array, without checking. This is the fastest way to access the underlying representation when the kind is known in advance. @par Preconditions @code this->is_array() @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ array& get_array() & noexcept { BOOST_ASSERT(is_array()); return arr_; } array&& get_array() && noexcept { BOOST_ASSERT(is_array()); return std::move(arr_); } array const& get_array() const& noexcept { BOOST_ASSERT(is_array()); return arr_; } /// @} /** Return the underlying @ref string, without checking. This is the fastest way to access the underlying representation when the kind is known in advance. @par Preconditions @code this->is_string() @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ string& get_string() & noexcept { BOOST_ASSERT(is_string()); return str_; } string&& get_string() && noexcept { BOOST_ASSERT(is_string()); return std::move(str_); } string const& get_string() const& noexcept { BOOST_ASSERT(is_string()); return str_; } /// @} /** Return the underlying `std::int64_t`, without checking. This is the fastest way to access the underlying representation when the kind is known in advance. @par Preconditions @code this->is_int64() @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ std::int64_t& get_int64() noexcept { BOOST_ASSERT(is_int64()); return sca_.i; } std::int64_t get_int64() const noexcept { BOOST_ASSERT(is_int64()); return sca_.i; } /// @} /** Return the underlying `std::uint64_t`, without checking. This is the fastest way to access the underlying representation when the kind is known in advance. @par Preconditions @code this->is_uint64() @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ std::uint64_t& get_uint64() noexcept { BOOST_ASSERT(is_uint64()); return sca_.u; } std::uint64_t get_uint64() const noexcept { BOOST_ASSERT(is_uint64()); return sca_.u; } /// @} /** Return the underlying `double`, without checking. This is the fastest way to access the underlying representation when the kind is known in advance. @par Preconditions @code this->is_double() @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ double& get_double() noexcept { BOOST_ASSERT(is_double()); return sca_.d; } double get_double() const noexcept { BOOST_ASSERT(is_double()); return sca_.d; } /// @} /** Return the underlying `bool`, without checking. This is the fastest way to access the underlying representation when the kind is known in advance. @par Preconditions @code this->is_bool() @endcode @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ bool& get_bool() noexcept { BOOST_ASSERT(is_bool()); return sca_.b; } bool get_bool() const noexcept { BOOST_ASSERT(is_bool()); return sca_.b; } /// @} //------------------------------------------------------ /** Access an element, with bounds checking. Returns `boost::system::result` containing a reference to the element of the underlying ccontainer, if such element exists. If the underlying value is not a container of the suitable type or the container doesn't have a corresponding element the result contains an `error_code`. , if `pos` is within its range. If `pos` is outside of that range, or the underlying value is not an object the Returns @ref boost::system::result containing a reference to the element of the underlying @ref array, if `pos` is within its range. If `pos` is outside of that range, or the underlying value is not an array the result contains an `error_code`. This function is used to access elements of the underlying container, or throw an exception if that could not be done. @li **(1)**, **(2)** require the underlying container to be an @ref object, and look for an element with the key `key`. @li **(3)**, **(4)** require the underlying container to be an @ref array, and look for an element at index `pos`. @par Exception Safety No-throw guarantee. @param key The key of the element to find. @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ BOOST_JSON_DECL boost::system::result try_at(string_view key) noexcept; BOOST_JSON_DECL boost::system::result try_at(string_view key) const noexcept; /** Overload @param pos A zero-based array index. */ BOOST_JSON_DECL boost::system::result try_at(std::size_t pos) noexcept; /// Overload BOOST_JSON_DECL boost::system::result try_at(std::size_t pos) const noexcept; /// @} /** Access an element, with bounds checking. This function is used to access elements of the underlying container, or throw an exception if that could not be done. @li **(1)**--**(3)** is equivalent to `this->as_object(loc).at(key, loc)`. @li **(4)**--**(6)** is equivalent to `this->as_array(loc).at(pos, loc)`. @par Complexity Constant. @par Exception Safety Strong guarantee. @param key The key of the element to find. @param loc @ref boost::source_location to use in thrown exception; the source location of the call site by default. @throw boost::system::system_error The underlying type of value is not the container type corresponding to the first argument (i.e. using an index with an @ref object). @throw boost::system::system_error An element corresponding to the first argument was not found. @see @ref as_array, @ref as_object. @{ */ value& at(string_view key, source_location const& loc = BOOST_CURRENT_LOCATION) & { return as_object(loc).at(key, loc); } /// Overload value&& at(string_view key, source_location const& loc = BOOST_CURRENT_LOCATION) && { return std::move( as_object(loc) ).at(key, loc); } /// Overload value const& at( string_view key, source_location const& loc = BOOST_CURRENT_LOCATION) const& { return as_object(loc).at(key, loc); } /** Overload @param pos A zero-based array index. @param loc */ value & at(std::size_t pos, source_location const& loc = BOOST_CURRENT_LOCATION) & { return as_array(loc).at(pos, loc); } /// Overload value&& at(std::size_t pos, source_location const& loc = BOOST_CURRENT_LOCATION) && { return std::move( as_array(loc) ).at(pos, loc); } /// Overload value const& at(std::size_t pos, source_location const& loc = BOOST_CURRENT_LOCATION) const& { return as_array(loc).at(pos, loc); } /// @} /** Access an element via JSON Pointer. This function is used to access a (potentially nested) element of the value using a JSON Pointer string. @par Complexity Linear in the sizes of `ptr` and underlying array, object, or string. @par Exception Safety No-throw guarantee. @param ptr JSON Pointer string. @return @ref boost::system::result containing either a reference to the element identified by `ptr` or a corresponding `error_code`. @see [RFC 6901 - JavaScript Object Notation (JSON) Pointer](https://datatracker.ietf.org/doc/html/rfc6901). @{ */ BOOST_JSON_DECL system::result try_at_pointer(string_view ptr) const noexcept; BOOST_JSON_DECL system::result try_at_pointer(string_view ptr) noexcept; /// @} /** Access an element via JSON Pointer. This function is used to access a (potentially nested) element of the value using a JSON Pointer string. @par Complexity Linear in the sizes of `ptr` and the underlying container. @par Exception Safety Strong guarantee. @param ptr JSON Pointer string. @param loc @ref boost::source_location to use in thrown exception; the source location of the call site by default. @return reference to the element identified by `ptr`. @throw boost::system::system_error if an error occurs. @see [RFC 6901 - JavaScript Object Notation (JSON) Pointer](https://datatracker.ietf.org/doc/html/rfc6901). @{ */ BOOST_JSON_DECL value const& at_pointer( string_view ptr, source_location const& loc = BOOST_CURRENT_LOCATION) const&; /// Overload inline value&& at_pointer( string_view ptr, source_location const& loc = BOOST_CURRENT_LOCATION) &&; /// Overload inline value& at_pointer( string_view ptr, source_location const& loc = BOOST_CURRENT_LOCATION) &; /// @} /** Access an element via JSON Pointer. This function is used to access a (potentially nested) element of the value using a JSON Pointer string. @par Complexity Linear in the sizes of `ptr` and underlying container. @par Exception Safety No-throw guarantee. @param ptr JSON Pointer string. @param ec Set to the error, if any occurred. @return pointer to the element identified by `ptr`. @see [RFC 6901 - JavaScript Object Notation (JSON) Pointer](https://datatracker.ietf.org/doc/html/rfc6901) @{ */ BOOST_JSON_DECL value const* find_pointer(string_view ptr, system::error_code& ec) const noexcept; BOOST_JSON_DECL value* find_pointer(string_view ptr, system::error_code& ec) noexcept; BOOST_JSON_DECL value const* find_pointer(string_view ptr, std::error_code& ec) const noexcept; BOOST_JSON_DECL value* find_pointer(string_view ptr, std::error_code& ec) noexcept; /// @} //------------------------------------------------------ /** Set an element via JSON Pointer. This function is used to insert or assign to a potentially nested element of the value using a JSON Pointer string. The function may create intermediate elements corresponding to pointer segments. The particular conditions when and what kind of intermediate element is created is governed by the `ptr` parameter. Each pointer token is considered in sequence. For each token - if the containing value is an @ref object, then a new `null` element is created with key equal to unescaped token string; otherwise - if the containing value is an @ref array, and the token represents a past-the-end marker, then a `null` element is appended to the array; otherwise - if the containing value is an @ref array, and the token represents a number, then if the difference between the number and array's size is smaller than `opts.max_created_elements`, then the size of the array is increased, so that the number can reference an element in the array; otherwise - if the containing value is of different @ref kind and `opts.replace_any_scalar` is `true`, or the value is `null`, then - if `opts.create_arrays` is `true` and the token either represents past-the-end marker or a number, then the value is replaced with an empty array and the token is considered again; otherwise - if `opts.create_objects` is `true`, then the value is replaced with an empty object and the token is considered again; otherwise - an error is produced. @par Complexity Linear in the sum of size of `ptr`, size of underlying array, object, or string and `opts.max_created_elements`. @par Exception Safety Basic guarantee. Calls to `memory_resource::allocate` may throw. @param sv JSON Pointer string. @param ref The value to assign to pointed element. @param opts The options for the algorithm. @return @ref boost::system::result containing either a reference to the element identified by `ptr` or a corresponding `error_code`. @see @ref set_pointer_options, [RFC 6901 - JavaScript Object Notation (JSON) Pointer](https://datatracker.ietf.org/doc/html/rfc6901). */ BOOST_JSON_DECL system::result try_set_at_pointer( string_view sv, value_ref ref, set_pointer_options const& opts = {} ); /** Set an element via JSON Pointer. This function is used to insert or assign to a potentially nested element of the value using a JSON Pointer string. The function may create intermediate elements corresponding to pointer segments. The particular conditions when and what kind of intermediate element is created is governed by the `ptr` parameter. Each pointer token is considered in sequence. For each token - if the containing value is an @ref object, then a new `null` element is created with key equal to unescaped token string; otherwise - if the containing value is an @ref array, and the token represents a past-the-end marker, then a `null` element is appended to the array; otherwise - if the containing value is an @ref array, and the token represents a number, then if the difference between the number and array's size is smaller than `opts.max_created_elements`, then the size of the array is increased, so that the number can reference an element in the array; otherwise - if the containing value is of different @ref kind and `opts.replace_any_scalar` is `true`, or the value is `null`, then - if `opts.create_arrays` is `true` and the token either represents past-the-end marker or a number, then the value is replaced with an empty array and the token is considered again; otherwise - if `opts.create_objects` is `true`, then the value is replaced with an empty object and the token is considered again; otherwise - an error is produced. @par Complexity Linear in the sum of size of `ptr`, size of underlying array, object, or string and `opts.max_created_elements`. @par Exception Safety Basic guarantee. Calls to `memory_resource::allocate` may throw. @param sv JSON Pointer string. @param ref The value to assign to pointed element. @param opts The options for the algorithm. @return Reference to the element identified by `ptr`. @throws boost::system::system_error Overload **(1)** reports errors by throwing exceptions. @see @ref set_pointer_options, [RFC 6901 - JavaScript Object Notation (JSON) Pointer](https://datatracker.ietf.org/doc/html/rfc6901">). @{ */ BOOST_JSON_DECL value& set_at_pointer( string_view sv, value_ref ref, set_pointer_options const& opts = {} ); /** Overload @param ec Set to the error, if any occurred. @param sv @param ref @param opts */ BOOST_JSON_DECL value* set_at_pointer( string_view sv, value_ref ref, system::error_code& ec, set_pointer_options const& opts = {} ); /// Overload BOOST_JSON_DECL value* set_at_pointer( string_view sv, value_ref ref, std::error_code& ec, set_pointer_options const& opts = {} ); /// @} //------------------------------------------------------ /** Check if two values are equal. Two values are equal when they are the same kind and their referenced values are equal, or when they are both integral types and their integral representations are equal. @par Complexity Constant or linear in the size of the underlying @ref array, @ref object, or @ref string. @par Exception Safety No-throw guarantee. */ // inline friend speeds up overload resolution friend bool operator==( value const& lhs, value const& rhs) noexcept { return lhs.equal(rhs); } /** Check if two values are not equal. Two values are equal when they are the same kind and their referenced values are equal, or when they are both integral types and their integral representations are equal. @par Complexity Constant or linear in the size of the underlying @ref array, @ref object, or @ref string. @par Exception Safety No-throw guarantee. */ friend bool operator!=( value const& lhs, value const& rhs) noexcept { return ! (lhs == rhs); } /** Serialize @ref value to an output stream. This function serializes a `value` as JSON text into the output stream. @return Reference to `os`. @par Complexity Constant or linear in the size of `jv`. @par Exception Safety Strong guarantee. Calls to `memory_resource::allocate` may throw. @param os The output stream to serialize to. @param jv The value to serialize. */ BOOST_JSON_DECL friend std::ostream& operator<<( std::ostream& os, value const& jv); /** Parse @ref value from an input stream. This function parses JSON from an input stream into a `value`. If parsing fails, @ref std::ios_base::failbit will be set for `is` and `jv` will be left unchanged. Regardless of whether @ref std::ios_base::skipws flag is set on `is`, consumes whitespace before and after JSON, because whitespace is considered a part of JSON. Behaves as [_FormattedInputFunction_](https://en.cppreference.com/w/cpp/named_req/FormattedInputFunction). @note This operator cannot assume that the stream only contains a single JSON document, which may result in **very underwhelming performance**, if the stream isn't cooperative. If you know that your input consists of a single JSON document, consider using @ref parse function instead. @return Reference to `is`. @par Complexity Linear in the size of JSON data. @par Exception Safety Basic guarantee. Calls to `memory_resource::allocate` may throw. The stream may throw as configured by @ref std::ios::exceptions. @param is The input stream to parse from. @param jv The value to parse into. @see @ref parse. */ BOOST_JSON_DECL friend std::istream& operator>>( std::istream& is, value& jv); /** Helper for @ref boost::hash support. Computes a hash value for `jv`. This function is used by `boost::hash`. Similar overloads for @ref array, @ref object, and @ref string do not exist, because those types are supported by `boost::hash` out of the box. @return hash value for `jv`. @param jv `value` for which a hash is to be computed. @see [Boost.ContainerHash](https://boost.org/libs/container_hash). */ #ifndef BOOST_JSON_DOCS template< class T, typename std::enable_if< std::is_same< detail::remove_cvref, value >::value >::type* = nullptr> friend std::size_t hash_value( T const& jv ) noexcept #else friend inline std::size_t hash_value( value const& jv ) noexcept #endif { return detail::hash_value_impl(jv); } private: static void relocate( value* dest, value const& src) noexcept { std::memcpy( static_cast(dest), &src, sizeof(src)); } BOOST_JSON_DECL storage_ptr destroy() noexcept; BOOST_JSON_DECL bool equal(value const& other) const noexcept; template auto to_number(error& e) const noexcept -> typename std::enable_if< std::is_signed::value && ! std::is_floating_point::value, T>::type { if(sca_.k == json::kind::int64) { auto const i = sca_.i; if( i >= (std::numeric_limits::min)() && i <= (std::numeric_limits::max)()) { e = {}; return static_cast(i); } e = error::not_exact; } else if(sca_.k == json::kind::uint64) { auto const u = sca_.u; if(u <= static_cast(( std::numeric_limits::max)())) { e = {}; return static_cast(u); } e = error::not_exact; } else if(sca_.k == json::kind::double_) { auto const d = sca_.d; if( d >= static_cast( (detail::to_number_limit::min)()) && d <= static_cast( (detail::to_number_limit::max)()) && static_cast(d) == d) { e = {}; return static_cast(d); } e = error::not_exact; } else { e = error::not_number; } return T{}; } template auto to_number(error& e) const noexcept -> typename std::enable_if< std::is_unsigned::value && ! std::is_same::value, T>::type { if(sca_.k == json::kind::int64) { auto const i = sca_.i; if( i >= 0 && static_cast(i) <= (std::numeric_limits::max)()) { e = {}; return static_cast(i); } e = error::not_exact; } else if(sca_.k == json::kind::uint64) { auto const u = sca_.u; if(u <= (std::numeric_limits::max)()) { e = {}; return static_cast(u); } e = error::not_exact; } else if(sca_.k == json::kind::double_) { auto const d = sca_.d; if( d >= 0 && d <= (detail::to_number_limit::max)() && static_cast(d) == d) { e = {}; return static_cast(d); } e = error::not_exact; } else { e = error::not_number; } return T{}; } template auto to_number(error& e) const noexcept -> typename std::enable_if< std::is_floating_point< T>::value, T>::type { if(sca_.k == json::kind::int64) { e = {}; return static_cast(sca_.i); } if(sca_.k == json::kind::uint64) { e = {}; return static_cast(sca_.u); } if(sca_.k == json::kind::double_) { e = {}; return static_cast(sca_.d); } e = error::not_number; return {}; } }; // Make sure things are as big as we think they should be #if BOOST_JSON_ARCH == 64 BOOST_CORE_STATIC_ASSERT( sizeof(value) == 24 ); #elif BOOST_JSON_ARCH == 32 BOOST_CORE_STATIC_ASSERT( sizeof(value) == 16 ); #else # error Unknown architecture #endif //---------------------------------------------------------- /** A key/value pair. This is the type of element used by the @ref object container. */ class key_value_pair { #ifndef BOOST_JSON_DOCS friend struct detail::access; using access = detail::access; #endif BOOST_JSON_DECL static char const empty_[1]; inline key_value_pair( pilfered k, pilfered v) noexcept; public: /** Assignment This type is not copy or move-assignable. The copy assignment operator is deleted. */ key_value_pair& operator=(key_value_pair const&) = delete; /** Destructor. The value is destroyed and all internally allocated memory is freed. */ ~key_value_pair() noexcept { auto const& sp = value_.storage(); if(sp.is_not_shared_and_deallocate_is_trivial()) return; if(key_ == empty_) return; sp->deallocate(const_cast(key_), len_ + 1, alignof(char)); } /** Constructors. Construct a key/value pair. @li **(1)** uses a copy of the characters of `key`, and constructs the value as if by `value(std::forward(args)...)`. @li **(2)** equivalent to `key_value_pair(p.first, p.second, sp)`. @li **(3)** equivalent to `key_value_pair(p.first, std::move(p.second), sp)`. @li **(4)** equivalent to `key_value_pair(other.key(), other.value(), sp)`. @li **(5)** equivalent to `key_value_pair(other.key(), other.value(), other.storage())`. @li **(6)** the pair s constructed by acquiring ownership of the contents of `other` using move semantics. @li **(7)** the pair is constructed by acquiring ownership of the contents of `other` using pilfer semantics. This is more efficient than move construction, when it is known that the moved-from object will be immediately destroyed afterwards. With **(2)**, **(3)**, **(4)** the pair uses the memory resource of `sp`. With **(5)**, **(6)**, **(7)** it uses the memory resource of `other.storage()`. With **(1)** it uses whatever memory resource `value(std::forward(args)...)` would use. In any case the pair acquires shared ownership of its memory resource After **(6)** `other` holds an empty key, and a null value with its current storage pointer. After **(7)** `other` is not in a usable state and may only be destroyed. @par Complexity Constant. @par Exception Safety Strong guarantee. Calls to `memory_resource::allocate` may throw. @param key The key string to use. @param args Optional arguments forwarded to the @ref value constructor. @throw boost::system::system_error The size of the key would exceed @ref string::max_size. @see @ref pilfer, [Valueless Variants Considered Harmful](http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2016/p0308r0.html). @{ */ template explicit key_value_pair( string_view key, Args&&... args) : value_(std::forward(args)...) { if(key.size() > string::max_size()) { BOOST_STATIC_CONSTEXPR source_location loc = BOOST_CURRENT_LOCATION; detail::throw_system_error( error::key_too_large, &loc ); } auto s = reinterpret_cast< char*>(value_.storage()-> allocate(key.size() + 1, alignof(char))); std::memcpy(s, key.data(), key.size()); s[key.size()] = 0; key_ = s; len_ = static_cast< std::uint32_t>(key.size()); } /** Overload @param p A `std::pair` with the key string and @ref value to construct with. @param sp A pointer to the @ref boost::container::pmr::memory_resource to use. */ explicit key_value_pair( std::pair< string_view, json::value> const& p, storage_ptr sp = {}) : key_value_pair( p.first, p.second, std::move(sp)) { } /// Overload explicit key_value_pair( std::pair< string_view, json::value>&& p, storage_ptr sp = {}) : key_value_pair( p.first, std::move(p).second, std::move(sp)) { } /** Overload @param other Another key/value pair. @param sp */ BOOST_JSON_DECL key_value_pair( key_value_pair const& other, storage_ptr sp); /// Overload key_value_pair( key_value_pair const& other) : key_value_pair(other, other.storage()) { } /// Overload key_value_pair( key_value_pair&& other) noexcept : value_(std::move(other.value_)) , key_(detail::exchange( other.key_, empty_)) , len_(detail::exchange( other.len_, 0)) { } /// Overload key_value_pair( pilfered other) noexcept : value_(pilfer(other.get().value_)) , key_(detail::exchange( other.get().key_, empty_)) , len_(detail::exchange( other.get().len_, 0)) { } /// @} /** The associated memory resource. Returns a pointer to the memory resource used to construct the value. @par Complexity Constant. @par Exception Safety No-throw guarantee. */ storage_ptr const& storage() const noexcept { return value_.storage(); } /** The pair's key. After construction, the key may not be modified. @par Complexity Constant. @par Exception Safety No-throw guarantee. */ string_view const key() const noexcept { return { key_, len_ }; } /** The pair's key as a null-terminated string. @par Complexity Constant. @par Exception Safety No-throw guarantee. */ char const* key_c_str() const noexcept { return key_; } /** The pair's value. @par Complexity Constant. @par Exception Safety No-throw guarantee. @{ */ json::value const& value() const& noexcept { return value_; } json::value&& value() && noexcept { return std::move( value() ); } json::value& value() & noexcept { return value_; } /// @} private: json::value value_; char const* key_; std::uint32_t len_; std::uint32_t next_; }; //---------------------------------------------------------- #ifdef BOOST_JSON_DOCS /** Tuple-like element access. This overload of `get` permits the key and value of a @ref key_value_pair to be accessed by index. For example: @code key_value_pair kvp("num", 42); string_view key = get<0>(kvp); value& jv = get<1>(kvp); @endcode @par Structured Bindings When using C++17 or greater, objects of type @ref key_value_pair may be used to initialize structured bindings: @code key_value_pair kvp("num", 42); auto& [key, value] = kvp; @endcode Depending on the value of `I`, the return type will be: @li `string_view const` if `I == 0`, or @li `value&`, `value const&`, or `value&&` if `I == 1`. Using any other value for `I` is ill-formed. @par Constraints `std::is_same_v< std::remove_cvref_t, key_value_pair >` @tparam I The element index to access. @return `kvp.key()` if `I == 0`, or `kvp.value()` if `I == 1`. @param kvp The @ref key_value_pair object to access. */ template< std::size_t I, class T> __see_below__ get(T&& kvp) noexcept; #else template auto get(key_value_pair const&) noexcept -> typename std::conditional::type { static_assert(I == 0, "key_value_pair index out of range"); } template auto get(key_value_pair&) noexcept -> typename std::conditional::type { static_assert(I == 0, "key_value_pair index out of range"); } template auto get(key_value_pair&&) noexcept -> typename std::conditional::type { static_assert(I == 0, "key_value_pair index out of range"); } /** Extracts a key_value_pair's key using tuple-like interface */ template<> inline string_view const get<0>(key_value_pair const& kvp) noexcept { return kvp.key(); } /** Extracts a key_value_pair's key using tuple-like interface */ template<> inline string_view const get<0>(key_value_pair& kvp) noexcept { return kvp.key(); } /** Extracts a key_value_pair's key using tuple-like interface */ template<> inline string_view const get<0>(key_value_pair&& kvp) noexcept { return kvp.key(); } /** Extracts a key_value_pair's value using tuple-like interface */ template<> inline value const& get<1>(key_value_pair const& kvp) noexcept { return kvp.value(); } /** Extracts a key_value_pair's value using tuple-like interface */ template<> inline value& get<1>(key_value_pair& kvp) noexcept { return kvp.value(); } /** Extracts a key_value_pair's value using tuple-like interface */ template<> inline value&& get<1>(key_value_pair&& kvp) noexcept { return std::move(kvp.value()); } #endif } // namespace json } // namespace boost #ifdef __clang__ # pragma clang diagnostic push # pragma clang diagnostic ignored "-Wmismatched-tags" #endif #ifndef BOOST_JSON_DOCS namespace std { /** Tuple-like size access for key_value_pair */ template<> struct tuple_size< ::boost::json::key_value_pair > : std::integral_constant { }; /** Tuple-like access for the key type of key_value_pair */ template<> struct tuple_element<0, ::boost::json::key_value_pair> { using type = ::boost::json::string_view const; }; /** Tuple-like access for the value type of key_value_pair */ template<> struct tuple_element<1, ::boost::json::key_value_pair> { using type = ::boost::json::value&; }; /** Tuple-like access for the value type of key_value_pair */ template<> struct tuple_element<1, ::boost::json::key_value_pair const> { using type = ::boost::json::value const&; }; } // std #endif // std::hash specialization #ifndef BOOST_JSON_DOCS namespace std { template <> struct hash< ::boost::json::value > { BOOST_JSON_DECL std::size_t operator()(::boost::json::value const& jv) const noexcept; }; } // std #endif #ifdef __clang__ # pragma clang diagnostic pop #endif // These are here because value, array, // and object form cyclic references. #include #include #include #include // These must come after array and object #include #endif