json.hpp.re2c 362.5 KB
Newer Older
1 2 3
/*
    __ _____ _____ _____
 __|  |   __|     |   | |  JSON for Modern C++
N
Niels 已提交
4
|  |  |__   |  |  | | | |  version 2.0.7
5 6 7
|_____|_____|_____|_|___|  https://github.com/nlohmann/json

Licensed under the MIT License <http://opensource.org/licenses/MIT>.
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
Copyright (c) 2013-2016 Niels Lohmann <http://nlohmann.me>.

Permission is hereby  granted, free of charge, to any  person obtaining a copy
of this software and associated  documentation files (the "Software"), to deal
in the Software  without restriction, including without  limitation the rights
to  use, copy,  modify, merge,  publish, distribute,  sublicense, and/or  sell
copies  of  the Software,  and  to  permit persons  to  whom  the Software  is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE  IS PROVIDED "AS  IS", WITHOUT WARRANTY  OF ANY KIND,  EXPRESS OR
IMPLIED,  INCLUDING BUT  NOT  LIMITED TO  THE  WARRANTIES OF  MERCHANTABILITY,
FITNESS FOR  A PARTICULAR PURPOSE AND  NONINFRINGEMENT. IN NO EVENT  SHALL THE
AUTHORS  OR COPYRIGHT  HOLDERS  BE  LIABLE FOR  ANY  CLAIM,  DAMAGES OR  OTHER
LIABILITY, WHETHER IN AN ACTION OF  CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE  OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
N
Niels 已提交
27 28
*/

N
Niels 已提交
29 30
#ifndef NLOHMANN_JSON_HPP
#define NLOHMANN_JSON_HPP
N
cleanup  
Niels 已提交
31

N
Niels 已提交
32 33 34 35 36 37 38 39 40
#include <algorithm> // all_of, for_each, transform
#include <array> // array
#include <cassert> // assert
#include <cctype> // isdigit
#include <ciso646> // and, not, or
#include <cmath> // isfinite, signbit
#include <cstddef> // nullptr_t, ptrdiff_t, size_t
#include <cstdint> // int64_t, uint64_t
#include <cstdlib> // strtod, strtof, strtold, strtoul
N
Niels 已提交
41
#include <cstring> // strlen
N
Niels 已提交
42 43 44 45 46 47
#include <functional> // function, hash, less
#include <initializer_list> // initializer_list
#include <iomanip> // setw
#include <iostream> // istream, ostream
#include <iterator> // advance, begin, bidirectional_iterator_tag, distance, end, inserter, iterator, iterator_traits, next, random_access_iterator_tag, reverse_iterator
#include <limits> // numeric_limits
N
Niels 已提交
48
#include <locale> // locale
N
Niels 已提交
49 50 51 52 53 54 55 56 57
#include <map> // map
#include <memory> // addressof, allocator, allocator_traits, unique_ptr
#include <numeric> // accumulate
#include <sstream> // stringstream
#include <stdexcept> // domain_error, invalid_argument, out_of_range
#include <string> // getline, stoi, string, to_string
#include <type_traits> // add_pointer, enable_if, is_arithmetic, is_base_of, is_const, is_constructible, is_convertible, is_floating_point, is_integral, is_nothrow_move_assignable, std::is_nothrow_move_constructible, std::is_pointer, std::is_reference, std::is_same, remove_const, remove_pointer, remove_reference
#include <utility> // declval, forward, make_pair, move, pair, swap
#include <vector> // vector
N
cleanup  
Niels 已提交
58

N
Niels 已提交
59 60 61
// exclude unsupported compilers
#if defined(__clang__)
    #define CLANG_VERSION (__clang_major__ * 10000 + __clang_minor__ * 100 + __clang_patchlevel__)
N
math...  
Niels 已提交
62
    #if CLANG_VERSION < 30400
N
Niels 已提交
63 64
        #error "unsupported Clang version - see https://github.com/nlohmann/json#supported-compilers"
    #endif
N
Niels 已提交
65
#elif defined(__GNUC__)
N
Niels 已提交
66
    #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
N
math...  
Niels 已提交
67
    #if GCC_VERSION < 40900
N
Niels 已提交
68 69 70 71
        #error "unsupported GCC version - see https://github.com/nlohmann/json#supported-compilers"
    #endif
#endif

72 73 74 75 76 77
// disable float-equal warnings on GCC/clang
#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
    #pragma GCC diagnostic push
    #pragma GCC diagnostic ignored "-Wfloat-equal"
#endif

N
Niels 已提交
78 79 80 81 82 83 84 85 86
// allow for portable deprecation warnings
#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
    #define JSON_DEPRECATED __attribute__((deprecated))
#elif defined(_MSC_VER)
    #define JSON_DEPRECATED __declspec(deprecated)
#else
    #define JSON_DEPRECATED
#endif

N
cleanup  
Niels 已提交
87
/*!
N
Niels 已提交
88
@brief namespace for Niels Lohmann
N
cleanup  
Niels 已提交
89
@see https://github.com/nlohmann
N
Niels 已提交
90
@since version 1.0.0
N
cleanup  
Niels 已提交
91 92 93 94
*/
namespace nlohmann
{

N
Niels 已提交
95

96 97
/*!
@brief unnamed namespace with internal helper functions
N
Niels 已提交
98
@since version 1.0.0
99 100
*/
namespace
N
Niels 已提交
101
{
102 103
/*!
@brief Helper to determine whether there's a key_type for T.
N
Niels 已提交
104 105 106 107 108

Thus helper is used to tell associative containers apart from other containers
such as sequence containers. For instance, `std::map` passes the test as it
contains a `mapped_type`, whereas `std::vector` fails the test.

109
@sa http://stackoverflow.com/a/7728728/266378
N
Niels 已提交
110
@since version 1.0.0, overworked in version 2.0.6
111
*/
N
Niels 已提交
112
template<typename T>
N
Niels 已提交
113
struct has_mapped_type
N
Niels 已提交
114 115
{
  private:
116 117 118 119
    template <typename U, typename = typename U::mapped_type>
    static int detect(U&&);

    static void detect(...);
N
Niels 已提交
120
  public:
121 122
    static constexpr bool value =
        std::is_integral<decltype(detect(std::declval<T>()))>::value;
N
Niels 已提交
123
};
124

N
Niels 已提交
125
}
N
Niels 已提交
126

N
cleanup  
Niels 已提交
127
/*!
N
Niels 已提交
128
@brief a class to store JSON values
N
cleanup  
Niels 已提交
129

N
Niels 已提交
130
@tparam ObjectType type for JSON objects (`std::map` by default; will be used
N
Niels 已提交
131
in @ref object_t)
N
Niels 已提交
132
@tparam ArrayType type for JSON arrays (`std::vector` by default; will be used
N
Niels 已提交
133
in @ref array_t)
N
Niels 已提交
134
@tparam StringType type for JSON strings and object keys (`std::string` by
N
Niels 已提交
135
default; will be used in @ref string_t)
N
Niels 已提交
136
@tparam BooleanType type for JSON booleans (`bool` by default; will be used
N
Niels 已提交
137
in @ref boolean_t)
N
Niels 已提交
138
@tparam NumberIntegerType type for JSON integer numbers (`int64_t` by
N
Niels 已提交
139
default; will be used in @ref number_integer_t)
N
Niels 已提交
140 141
@tparam NumberUnsignedType type for JSON unsigned integer numbers (@c
`uint64_t` by default; will be used in @ref number_unsigned_t)
N
Niels 已提交
142
@tparam NumberFloatType type for JSON floating-point numbers (`double` by
N
Niels 已提交
143
default; will be used in @ref number_float_t)
N
Niels 已提交
144
@tparam AllocatorType type of the allocator to use (`std::allocator` by
N
Niels 已提交
145
default)
N
Niels 已提交
146

N
Niels 已提交
147 148
@requirement The class satisfies the following concept requirements:
- Basic
N
Niels 已提交
149 150 151 152 153
 - [DefaultConstructible](http://en.cppreference.com/w/cpp/concept/DefaultConstructible):
   JSON values can be default constructed. The result will be a JSON null value.
 - [MoveConstructible](http://en.cppreference.com/w/cpp/concept/MoveConstructible):
   A JSON value can be constructed from an rvalue argument.
 - [CopyConstructible](http://en.cppreference.com/w/cpp/concept/CopyConstructible):
N
Niels 已提交
154
   A JSON value can be copy-constructed from an lvalue expression.
N
Niels 已提交
155 156 157 158 159 160
 - [MoveAssignable](http://en.cppreference.com/w/cpp/concept/MoveAssignable):
   A JSON value van be assigned from an rvalue argument.
 - [CopyAssignable](http://en.cppreference.com/w/cpp/concept/CopyAssignable):
   A JSON value can be copy-assigned from an lvalue expression.
 - [Destructible](http://en.cppreference.com/w/cpp/concept/Destructible):
   JSON values can be destructed.
N
Niels 已提交
161
- Layout
N
Niels 已提交
162 163 164 165 166
 - [StandardLayoutType](http://en.cppreference.com/w/cpp/concept/StandardLayoutType):
   JSON values have
   [standard layout](http://en.cppreference.com/w/cpp/language/data_members#Standard_layout):
   All non-static data members are private and standard layout types, the class
   has no virtual functions or (virtual) base classes.
N
Niels 已提交
167
- Library-wide
N
Niels 已提交
168 169 170 171 172 173 174 175 176 177 178 179
 - [EqualityComparable](http://en.cppreference.com/w/cpp/concept/EqualityComparable):
   JSON values can be compared with `==`, see @ref
   operator==(const_reference,const_reference).
 - [LessThanComparable](http://en.cppreference.com/w/cpp/concept/LessThanComparable):
   JSON values can be compared with `<`, see @ref
   operator<(const_reference,const_reference).
 - [Swappable](http://en.cppreference.com/w/cpp/concept/Swappable):
   Any JSON lvalue or rvalue of can be swapped with any lvalue or rvalue of
   other compatible types, using unqualified function call @ref swap().
 - [NullablePointer](http://en.cppreference.com/w/cpp/concept/NullablePointer):
   JSON values can be compared against `std::nullptr_t` objects which are used
   to model the `null` value.
N
Niels 已提交
180
- Container
N
Niels 已提交
181 182 183 184 185
 - [Container](http://en.cppreference.com/w/cpp/concept/Container):
   JSON values can be used like STL containers and provide iterator access.
 - [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer);
   JSON values can be used like STL containers and provide reverse iterator
   access.
N
Niels 已提交
186

187 188 189 190 191 192 193
@invariant The member variables @a m_value and @a m_type have the following
relationship:
- If `m_type == value_t::object`, then `m_value.object != nullptr`.
- If `m_type == value_t::array`, then `m_value.array != nullptr`.
- If `m_type == value_t::string`, then `m_value.string != nullptr`.
The invariants are checked by member function assert_invariant().

N
Niels 已提交
194
@internal
N
Niels 已提交
195
@note ObjectType trick from http://stackoverflow.com/a/9860911
N
Niels 已提交
196
@endinternal
N
Niels 已提交
197

198 199
@see [RFC 7159: The JavaScript Object Notation (JSON) Data Interchange
Format](http://rfc7159.net/rfc7159)
N
Niels 已提交
200

N
Niels 已提交
201
@since version 1.0.0
N
Niels 已提交
202 203

@nosubgrouping
N
cleanup  
Niels 已提交
204 205 206 207 208 209
*/
template <
    template<typename U, typename V, typename... Args> class ObjectType = std::map,
    template<typename U, typename... Args> class ArrayType = std::vector,
    class StringType = std::string,
    class BooleanType = bool,
210 211
    class NumberIntegerType = std::int64_t,
    class NumberUnsignedType = std::uint64_t,
N
Niels 已提交
212
    class NumberFloatType = double,
N
Niels 已提交
213
    template<typename U> class AllocatorType = std::allocator
N
cleanup  
Niels 已提交
214 215 216
    >
class basic_json
{
217 218
  private:
    /// workaround type for MSVC
N
Niels 已提交
219 220
    using basic_json_t = basic_json<ObjectType, ArrayType, StringType,
          BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType,
N
Niels 已提交
221
          AllocatorType>;
222 223

  public:
N
Niels 已提交
224 225 226
    // forward declarations
    template<typename Base> class json_reverse_iterator;
    class json_pointer;
227

N
cleanup  
Niels 已提交
228 229 230 231
    /////////////////////
    // container types //
    /////////////////////

N
Niels 已提交
232
    /// @name container types
N
Niels 已提交
233 234
    /// The canonic container types to use @ref basic_json like any other STL
    /// container.
N
Niels 已提交
235 236
    /// @{

N
Niels 已提交
237
    /// the type of elements in a basic_json container
N
cleanup  
Niels 已提交
238
    using value_type = basic_json;
N
Niels 已提交
239

N
Niels 已提交
240
    /// the type of an element reference
N
Niels 已提交
241
    using reference = value_type&;
N
Niels 已提交
242
    /// the type of an element const reference
N
Niels 已提交
243
    using const_reference = const value_type&;
N
Niels 已提交
244

N
Niels 已提交
245
    /// a type to represent differences between iterators
N
Niels 已提交
246
    using difference_type = std::ptrdiff_t;
N
Niels 已提交
247
    /// a type to represent container sizes
N
Niels 已提交
248 249 250
    using size_type = std::size_t;

    /// the allocator type
N
Niels 已提交
251
    using allocator_type = AllocatorType<basic_json>;
N
Niels 已提交
252

N
cleanup  
Niels 已提交
253
    /// the type of an element pointer
N
Niels 已提交
254
    using pointer = typename std::allocator_traits<allocator_type>::pointer;
N
cleanup  
Niels 已提交
255
    /// the type of an element const pointer
N
Niels 已提交
256
    using const_pointer = typename std::allocator_traits<allocator_type>::const_pointer;
N
Niels 已提交
257

N
Niels 已提交
258 259 260 261 262
    /// an iterator for a basic_json container
    class iterator;
    /// a const iterator for a basic_json container
    class const_iterator;
    /// a reverse iterator for a basic_json container
N
Niels 已提交
263
    using reverse_iterator = json_reverse_iterator<typename basic_json::iterator>;
N
Niels 已提交
264
    /// a const reverse iterator for a basic_json container
N
Niels 已提交
265
    using const_reverse_iterator = json_reverse_iterator<typename basic_json::const_iterator>;
N
Niels 已提交
266

N
Niels 已提交
267 268 269
    /// @}


N
Niels 已提交
270 271 272
    /*!
    @brief returns the allocator associated with the container
    */
273
    static allocator_type get_allocator()
N
Niels 已提交
274 275 276 277 278
    {
        return allocator_type();
    }


N
cleanup  
Niels 已提交
279 280 281 282
    ///////////////////////////
    // JSON value data types //
    ///////////////////////////

N
Niels 已提交
283
    /// @name JSON value data types
N
Niels 已提交
284 285
    /// The data types to store a JSON value. These types are derived from
    /// the template arguments passed to class @ref basic_json.
N
Niels 已提交
286 287
    /// @{

N
Niels 已提交
288 289 290 291 292 293 294 295
    /*!
    @brief a type for an object

    [RFC 7159](http://rfc7159.net/rfc7159) describes JSON objects as follows:
    > An object is an unordered collection of zero or more name/value pairs,
    > where a name is a string and a value is a string, number, boolean, null,
    > object, or array.

N
Niels 已提交
296 297 298 299 300
    To store objects in C++, a type is defined by the template parameters
    described below.

    @tparam ObjectType  the container to store objects (e.g., `std::map` or
    `std::unordered_map`)
N
Niels 已提交
301 302
    @tparam StringType the type of the keys or names (e.g., `std::string`).
    The comparison function `std::less<StringType>` is used to order elements
N
Niels 已提交
303 304 305
    inside the container.
    @tparam AllocatorType the allocator to use for objects (e.g.,
    `std::allocator`)
N
Niels 已提交
306 307 308 309

    #### Default type

    With the default values for @a ObjectType (`std::map`), @a StringType
N
Niels 已提交
310 311
    (`std::string`), and @a AllocatorType (`std::allocator`), the default
    value for @a object_t is:
N
Niels 已提交
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327

    @code {.cpp}
    std::map<
      std::string, // key_type
      basic_json, // value_type
      std::less<std::string>, // key_compare
      std::allocator<std::pair<const std::string, basic_json>> // allocator_type
    >
    @endcode

    #### Behavior

    The choice of @a object_t influences the behavior of the JSON class. With
    the default type, objects have the following behavior:

    - When all names are unique, objects will be interoperable in the sense
N
Niels 已提交
328 329
      that all software implementations receiving that object will agree on
      the name-value mappings.
N
Niels 已提交
330 331 332 333 334
    - When the names within an object are not unique, later stored name/value
      pairs overwrite previously stored name/value pairs, leaving the used
      names unique. For instance, `{"key": 1}` and `{"key": 2, "key": 1}` will
      be treated as equal and both stored as `{"key": 1}`.
    - Internally, name/value pairs are stored in lexicographical order of the
N
Niels 已提交
335 336 337
      names. Objects will also be serialized (see @ref dump) in this order.
      For instance, `{"b": 1, "a": 2}` and `{"a": 2, "b": 1}` will be stored
      and serialized as `{"a": 2, "b": 1}`.
N
Niels 已提交
338 339 340 341 342 343 344 345 346 347 348 349
    - When comparing objects, the order of the name/value pairs is irrelevant.
      This makes objects interoperable in the sense that they will not be
      affected by these differences. For instance, `{"b": 1, "a": 2}` and
      `{"a": 2, "b": 1}` will be treated as equal.

    #### Limits

    [RFC 7159](http://rfc7159.net/rfc7159) specifies:
    > An implementation may set limits on the maximum depth of nesting.

    In this class, the object's limit of nesting is not constraint explicitly.
    However, a maximum depth of nesting may be introduced by the compiler or
N
Niels 已提交
350 351
    runtime environment. A theoretical limit can be queried by calling the
    @ref max_size function of a JSON object.
N
Niels 已提交
352 353 354

    #### Storage

355
    Objects are stored as pointers in a @ref basic_json type. That is, for any
N
Niels 已提交
356 357
    access to object values, a pointer of type `object_t*` must be
    dereferenced.
N
Niels 已提交
358

359 360
    @sa @ref array_t -- type for an array value

N
Niels 已提交
361
    @since version 1.0.0
N
Niels 已提交
362

N
Niels 已提交
363 364 365 366 367
    @note The order name/value pairs are added to the object is *not*
    preserved by the library. Therefore, iterating an object may return
    name/value pairs in a different order than they were originally stored. In
    fact, keys will be traversed in alphabetical order as `std::map` with
    `std::less` is used by default. Please note this behavior conforms to [RFC
N
Niels 已提交
368 369
    7159](http://rfc7159.net/rfc7159), because any order implements the
    specified "unordered" nature of JSON objects.
N
Niels 已提交
370
    */
N
Niels 已提交
371 372 373 374 375
    using object_t = ObjectType<StringType,
          basic_json,
          std::less<StringType>,
          AllocatorType<std::pair<const StringType,
          basic_json>>>;
N
Niels 已提交
376 377 378 379 380 381 382

    /*!
    @brief a type for an array

    [RFC 7159](http://rfc7159.net/rfc7159) describes JSON arrays as follows:
    > An array is an ordered sequence of zero or more values.

N
Niels 已提交
383 384 385 386 387
    To store objects in C++, a type is defined by the template parameters
    explained below.

    @tparam ArrayType  container type to store arrays (e.g., `std::vector` or
    `std::list`)
N
Niels 已提交
388
    @tparam AllocatorType allocator to use for arrays (e.g., `std::allocator`)
N
Niels 已提交
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408

    #### Default type

    With the default values for @a ArrayType (`std::vector`) and @a
    AllocatorType (`std::allocator`), the default value for @a array_t is:

    @code {.cpp}
    std::vector<
      basic_json, // value_type
      std::allocator<basic_json> // allocator_type
    >
    @endcode

    #### Limits

    [RFC 7159](http://rfc7159.net/rfc7159) specifies:
    > An implementation may set limits on the maximum depth of nesting.

    In this class, the array's limit of nesting is not constraint explicitly.
    However, a maximum depth of nesting may be introduced by the compiler or
N
Niels 已提交
409 410
    runtime environment. A theoretical limit can be queried by calling the
    @ref max_size function of a JSON array.
N
Niels 已提交
411 412 413

    #### Storage

414
    Arrays are stored as pointers in a @ref basic_json type. That is, for any
N
Niels 已提交
415
    access to array values, a pointer of type `array_t*` must be dereferenced.
416 417 418

    @sa @ref object_t -- type for an object value

N
Niels 已提交
419
    @since version 1.0.0
N
Niels 已提交
420
    */
N
Niels 已提交
421
    using array_t = ArrayType<basic_json, AllocatorType<basic_json>>;
N
Niels 已提交
422 423 424 425 426 427 428

    /*!
    @brief a type for a string

    [RFC 7159](http://rfc7159.net/rfc7159) describes JSON strings as follows:
    > A string is a sequence of zero or more Unicode characters.

N
Niels 已提交
429
    To store objects in C++, a type is defined by the template parameter
N
Niels 已提交
430 431
    described below. Unicode values are split by the JSON class into
    byte-sized characters during deserialization.
N
Niels 已提交
432

N
Niels 已提交
433 434
    @tparam StringType  the container to store strings (e.g., `std::string`).
    Note this container is used for keys/names in objects, see @ref object_t.
N
Niels 已提交
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461

    #### Default type

    With the default values for @a StringType (`std::string`), the default
    value for @a string_t is:

    @code {.cpp}
    std::string
    @endcode

    #### String comparison

    [RFC 7159](http://rfc7159.net/rfc7159) states:
    > Software implementations are typically required to test names of object
    > members for equality. Implementations that transform the textual
    > representation into sequences of Unicode code units and then perform the
    > comparison numerically, code unit by code unit, are interoperable in the
    > sense that implementations will agree in all cases on equality or
    > inequality of two strings. For example, implementations that compare
    > strings with escaped characters unconverted may incorrectly find that
    > `"a\\b"` and `"a\u005Cb"` are not equal.

    This implementation is interoperable as it does compare strings code unit
    by code unit.

    #### Storage

462 463
    String values are stored as pointers in a @ref basic_json type. That is,
    for any access to string values, a pointer of type `string_t*` must be
N
Niels 已提交
464
    dereferenced.
465

N
Niels 已提交
466
    @since version 1.0.0
N
Niels 已提交
467
    */
N
cleanup  
Niels 已提交
468
    using string_t = StringType;
N
Niels 已提交
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489

    /*!
    @brief a type for a boolean

    [RFC 7159](http://rfc7159.net/rfc7159) implicitly describes a boolean as a
    type which differentiates the two literals `true` and `false`.

    To store objects in C++, a type is defined by the template parameter @a
    BooleanType which chooses the type to use.

    #### Default type

    With the default values for @a BooleanType (`bool`), the default value for
    @a boolean_t is:

    @code {.cpp}
    bool
    @endcode

    #### Storage

490 491
    Boolean values are stored directly inside a @ref basic_json type.

N
Niels 已提交
492
    @since version 1.0.0
N
Niels 已提交
493
    */
N
cleanup  
Niels 已提交
494
    using boolean_t = BooleanType;
N
Niels 已提交
495 496 497 498 499

    /*!
    @brief a type for a number (integer)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
500 501 502 503 504 505 506 507 508 509 510 511 512
    > The representation of numbers is similar to that used in most
    > programming languages. A number is represented in base 10 using decimal
    > digits. It contains an integer component that may be prefixed with an
    > optional minus sign, which may be followed by a fraction part and/or an
    > exponent part. Leading zeros are not allowed. (...) Numeric values that
    > cannot be represented in the grammar below (such as Infinity and NaN)
    > are not permitted.

    This description includes both integer and floating-point numbers.
    However, C++ allows more precise storage if it is known whether the number
    is a signed integer, an unsigned integer or a floating-point number.
    Therefore, three different types, @ref number_integer_t, @ref
    number_unsigned_t and @ref number_float_t are used.
N
Niels 已提交
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530

    To store integer numbers in C++, a type is defined by the template
    parameter @a NumberIntegerType which chooses the type to use.

    #### Default type

    With the default values for @a NumberIntegerType (`int64_t`), the default
    value for @a number_integer_t is:

    @code {.cpp}
    int64_t
    @endcode

    #### Default behavior

    - The restrictions about leading zeros is not enforced in C++. Instead,
      leading zeros in integer literals lead to an interpretation as octal
      number. Internally, the value will be stored as decimal number. For
N
Niels 已提交
531 532
      instance, the C++ integer literal `010` will be serialized to `8`.
      During deserialization, leading zeros yield an error.
N
Niels 已提交
533 534 535 536 537 538 539 540 541 542
    - Not-a-number (NaN) values will be serialized to `null`.

    #### Limits

    [RFC 7159](http://rfc7159.net/rfc7159) specifies:
    > An implementation may set limits on the range and precision of numbers.

    When the default type is used, the maximal integer number that can be
    stored is `9223372036854775807` (INT64_MAX) and the minimal integer number
    that can be stored is `-9223372036854775808` (INT64_MIN). Integer numbers
N
Niels 已提交
543 544 545 546
    that are out of range will yield over/underflow when used in a
    constructor. During deserialization, too large or small integer numbers
    will be automatically be stored as @ref number_unsigned_t or @ref
    number_float_t.
N
Niels 已提交
547 548 549 550 551 552 553 554 555 556 557

    [RFC 7159](http://rfc7159.net/rfc7159) further states:
    > Note that when such software is used, numbers that are integers and are
    > in the range \f$[-2^{53}+1, 2^{53}-1]\f$ are interoperable in the sense
    > that implementations will agree exactly on their numeric values.

    As this range is a subrange of the exactly supported range [INT64_MIN,
    INT64_MAX], this class's integer type is interoperable.

    #### Storage

558 559 560 561
    Integer number values are stored directly inside a @ref basic_json type.

    @sa @ref number_float_t -- type for number values (floating-point)

562 563
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
564
    @since version 1.0.0
N
Niels 已提交
565
    */
N
cleanup  
Niels 已提交
566
    using number_integer_t = NumberIntegerType;
N
Niels 已提交
567

568 569 570 571
    /*!
    @brief a type for a number (unsigned)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
    > The representation of numbers is similar to that used in most
    > programming languages. A number is represented in base 10 using decimal
    > digits. It contains an integer component that may be prefixed with an
    > optional minus sign, which may be followed by a fraction part and/or an
    > exponent part. Leading zeros are not allowed. (...) Numeric values that
    > cannot be represented in the grammar below (such as Infinity and NaN)
    > are not permitted.

    This description includes both integer and floating-point numbers.
    However, C++ allows more precise storage if it is known whether the number
    is a signed integer, an unsigned integer or a floating-point number.
    Therefore, three different types, @ref number_integer_t, @ref
    number_unsigned_t and @ref number_float_t are used.

    To store unsigned integer numbers in C++, a type is defined by the
    template parameter @a NumberUnsignedType which chooses the type to use.
588 589 590

    #### Default type

N
Niels 已提交
591 592
    With the default values for @a NumberUnsignedType (`uint64_t`), the
    default value for @a number_unsigned_t is:
593 594 595 596 597 598 599 600 601 602

    @code {.cpp}
    uint64_t
    @endcode

    #### Default behavior

    - The restrictions about leading zeros is not enforced in C++. Instead,
      leading zeros in integer literals lead to an interpretation as octal
      number. Internally, the value will be stored as decimal number. For
N
Niels 已提交
603 604
      instance, the C++ integer literal `010` will be serialized to `8`.
      During deserialization, leading zeros yield an error.
605 606 607 608 609 610 611 612
    - Not-a-number (NaN) values will be serialized to `null`.

    #### Limits

    [RFC 7159](http://rfc7159.net/rfc7159) specifies:
    > An implementation may set limits on the range and precision of numbers.

    When the default type is used, the maximal integer number that can be
N
Niels 已提交
613 614 615 616 617
    stored is `18446744073709551615` (UINT64_MAX) and the minimal integer
    number that can be stored is `0`. Integer numbers that are out of range
    will yield over/underflow when used in a constructor. During
    deserialization, too large or small integer numbers will be automatically
    be stored as @ref number_integer_t or @ref number_float_t.
618 619 620 621 622 623 624

    [RFC 7159](http://rfc7159.net/rfc7159) further states:
    > Note that when such software is used, numbers that are integers and are
    > in the range \f$[-2^{53}+1, 2^{53}-1]\f$ are interoperable in the sense
    > that implementations will agree exactly on their numeric values.

    As this range is a subrange (when considered in conjunction with the
N
Niels 已提交
625 626
    number_integer_t type) of the exactly supported range [0, UINT64_MAX],
    this class's integer type is interoperable.
627 628 629 630 631 632 633 634 635 636 637

    #### Storage

    Integer number values are stored directly inside a @ref basic_json type.

    @sa @ref number_float_t -- type for number values (floating-point)
    @sa @ref number_integer_t -- type for number values (integer)

    @since version 2.0.0
    */
    using number_unsigned_t = NumberUnsignedType;
N
Niels 已提交
638

N
Niels 已提交
639 640 641 642
    /*!
    @brief a type for a number (floating-point)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
643 644 645 646 647 648 649 650 651 652 653 654 655
    > The representation of numbers is similar to that used in most
    > programming languages. A number is represented in base 10 using decimal
    > digits. It contains an integer component that may be prefixed with an
    > optional minus sign, which may be followed by a fraction part and/or an
    > exponent part. Leading zeros are not allowed. (...) Numeric values that
    > cannot be represented in the grammar below (such as Infinity and NaN)
    > are not permitted.

    This description includes both integer and floating-point numbers.
    However, C++ allows more precise storage if it is known whether the number
    is a signed integer, an unsigned integer or a floating-point number.
    Therefore, three different types, @ref number_integer_t, @ref
    number_unsigned_t and @ref number_float_t are used.
N
Niels 已提交
656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671

    To store floating-point numbers in C++, a type is defined by the template
    parameter @a NumberFloatType which chooses the type to use.

    #### Default type

    With the default values for @a NumberFloatType (`double`), the default
    value for @a number_float_t is:

    @code {.cpp}
    double
    @endcode

    #### Default behavior

    - The restrictions about leading zeros is not enforced in C++. Instead,
N
Niels 已提交
672 673
      leading zeros in floating-point literals will be ignored. Internally,
      the value will be stored as decimal number. For instance, the C++
N
Niels 已提交
674 675 676 677 678 679 680 681 682 683
      floating-point literal `01.2` will be serialized to `1.2`. During
      deserialization, leading zeros yield an error.
    - Not-a-number (NaN) values will be serialized to `null`.

    #### Limits

    [RFC 7159](http://rfc7159.net/rfc7159) states:
    > This specification allows implementations to set limits on the range and
    > precision of numbers accepted. Since software that implements IEEE
    > 754-2008 binary64 (double precision) numbers is generally available and
N
Niels 已提交
684 685 686
    > widely used, good interoperability can be achieved by implementations
    > that expect no more precision or range than these provide, in the sense
    > that implementations will approximate JSON numbers within the expected
N
Niels 已提交
687 688 689 690
    > precision.

    This implementation does exactly follow this approach, as it uses double
    precision floating-point numbers. Note values smaller than
N
Niels 已提交
691
    `-1.79769313486232e+308` and values greater than `1.79769313486232e+308`
N
Niels 已提交
692 693 694 695
    will be stored as NaN internally and be serialized to `null`.

    #### Storage

696 697 698 699 700
    Floating-point number values are stored directly inside a @ref basic_json
    type.

    @sa @ref number_integer_t -- type for number values (integer)

701 702
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
703
    @since version 1.0.0
N
Niels 已提交
704
    */
N
cleanup  
Niels 已提交
705 706
    using number_float_t = NumberFloatType;

N
Niels 已提交
707 708
    /// @}

N
cleanup  
Niels 已提交
709

N
Niels 已提交
710 711 712
    ///////////////////////////
    // JSON type enumeration //
    ///////////////////////////
N
Niels 已提交
713

N
Niels 已提交
714
    /*!
N
Niels 已提交
715
    @brief the JSON type enumeration
N
Niels 已提交
716

N
Niels 已提交
717
    This enumeration collects the different JSON types. It is internally used
718 719
    to distinguish the stored values, and the functions @ref is_null(), @ref
    is_object(), @ref is_array(), @ref is_string(), @ref is_boolean(), @ref
N
Niels 已提交
720 721 722 723 724 725 726 727 728 729 730 731 732
    is_number() (with @ref is_number_integer(), @ref is_number_unsigned(), and
    @ref is_number_float()), @ref is_discarded(), @ref is_primitive(), and
    @ref is_structured() rely on it.

    @note There are three enumeration entries (number_integer,
    number_unsigned, and number_float), because the library distinguishes
    these three types for numbers: @ref number_unsigned_t is used for unsigned
    integers, @ref number_integer_t is used for signed integers, and @ref
    number_float_t is used for floating-point numbers or to approximate
    integers which do not fit in the limits of their respective type.

    @sa @ref basic_json(const value_t value_type) -- create a JSON value with
    the default value for a given type
733

N
Niels 已提交
734
    @since version 1.0.0
N
Niels 已提交
735
    */
N
Niels 已提交
736 737
    enum class value_t : uint8_t
    {
N
Niels 已提交
738 739 740 741 742
        null,            ///< null value
        object,          ///< object (unordered set of name/value pairs)
        array,           ///< array (ordered collection of values)
        string,          ///< string value
        boolean,         ///< boolean value
N
Niels 已提交
743
        number_integer,  ///< number value (signed integer)
N
Niels 已提交
744 745 746
        number_unsigned, ///< number value (unsigned integer)
        number_float,    ///< number value (floating-point)
        discarded        ///< discarded by the the parser callback function
N
Niels 已提交
747 748
    };

N
Niels 已提交
749

N
Niels 已提交
750
  private:
N
Niels 已提交
751

752 753
    /// helper for exception-safe object creation
    template<typename T, typename... Args>
N
Cleanup  
Niels 已提交
754
    static T* create(Args&& ... args)
755 756
    {
        AllocatorType<T> alloc;
N
cleanup  
Niels 已提交
757
        auto deleter = [&](T * object)
N
Cleanup  
Niels 已提交
758 759 760
        {
            alloc.deallocate(object, 1);
        };
761 762
        std::unique_ptr<T, decltype(deleter)> object(alloc.allocate(1), deleter);
        alloc.construct(object.get(), std::forward<Args>(args)...);
N
Niels 已提交
763
        assert(object.get() != nullptr);
764 765 766
        return object.release();
    }

N
cleanup  
Niels 已提交
767 768 769 770
    ////////////////////////
    // JSON value storage //
    ////////////////////////

771 772 773
    /*!
    @brief a JSON value

N
Niels 已提交
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
    The actual storage for a JSON value of the @ref basic_json class. This
    union combines the different storage types for the JSON value types
    defined in @ref value_t.

    JSON type | value_t type    | used type
    --------- | --------------- | ------------------------
    object    | object          | pointer to @ref object_t
    array     | array           | pointer to @ref array_t
    string    | string          | pointer to @ref string_t
    boolean   | boolean         | @ref boolean_t
    number    | number_integer  | @ref number_integer_t
    number    | number_unsigned | @ref number_unsigned_t
    number    | number_float    | @ref number_float_t
    null      | null            | *no value is stored*

    @note Variable-length types (objects, arrays, and strings) are stored as
    pointers. The size of the union should not exceed 64 bits if the default
    value types are used.
792

N
Niels 已提交
793
    @since version 1.0.0
794
    */
N
cleanup  
Niels 已提交
795 796 797 798 799 800 801 802
    union json_value
    {
        /// object (stored with pointer to save storage)
        object_t* object;
        /// array (stored with pointer to save storage)
        array_t* array;
        /// string (stored with pointer to save storage)
        string_t* string;
N
Niels 已提交
803
        /// boolean
N
cleanup  
Niels 已提交
804 805 806
        boolean_t boolean;
        /// number (integer)
        number_integer_t number_integer;
807 808
        /// number (unsigned integer)
        number_unsigned_t number_unsigned;
N
Niels 已提交
809
        /// number (floating-point)
N
cleanup  
Niels 已提交
810 811 812
        number_float_t number_float;

        /// default constructor (for null values)
N
Niels 已提交
813
        json_value() = default;
N
cleanup  
Niels 已提交
814
        /// constructor for booleans
815
        json_value(boolean_t v) noexcept : boolean(v) {}
N
cleanup  
Niels 已提交
816
        /// constructor for numbers (integer)
817
        json_value(number_integer_t v) noexcept : number_integer(v) {}
818 819
        /// constructor for numbers (unsigned)
        json_value(number_unsigned_t v) noexcept : number_unsigned(v) {}
N
Niels 已提交
820
        /// constructor for numbers (floating-point)
821
        json_value(number_float_t v) noexcept : number_float(v) {}
N
Niels 已提交
822
        /// constructor for empty values of a given type
823
        json_value(value_t t)
N
Niels 已提交
824 825 826
        {
            switch (t)
            {
827
                case value_t::object:
N
Niels 已提交
828
                {
829
                    object = create<object_t>();
N
Niels 已提交
830 831
                    break;
                }
N
cleanup  
Niels 已提交
832

833
                case value_t::array:
N
Niels 已提交
834
                {
835
                    array = create<array_t>();
N
Niels 已提交
836 837
                    break;
                }
N
cleanup  
Niels 已提交
838

839
                case value_t::string:
N
Niels 已提交
840
                {
841
                    string = create<string_t>("");
N
Niels 已提交
842 843
                    break;
                }
N
cleanup  
Niels 已提交
844

845
                case value_t::boolean:
N
Niels 已提交
846 847 848 849 850
                {
                    boolean = boolean_t(false);
                    break;
                }

851
                case value_t::number_integer:
N
Niels 已提交
852 853 854 855
                {
                    number_integer = number_integer_t(0);
                    break;
                }
N
Niels 已提交
856

857 858 859 860 861
                case value_t::number_unsigned:
                {
                    number_unsigned = number_unsigned_t(0);
                    break;
                }
N
Niels 已提交
862

863
                case value_t::number_float:
N
Niels 已提交
864 865 866 867
                {
                    number_float = number_float_t(0.0);
                    break;
                }
868 869 870 871 872

                default:
                {
                    break;
                }
N
Niels 已提交
873 874
            }
        }
N
Niels 已提交
875 876

        /// constructor for strings
877
        json_value(const string_t& value)
N
Niels 已提交
878
        {
879
            string = create<string_t>(value);
N
Niels 已提交
880 881 882
        }

        /// constructor for objects
883
        json_value(const object_t& value)
N
Niels 已提交
884
        {
885
            object = create<object_t>(value);
N
Niels 已提交
886 887 888
        }

        /// constructor for arrays
889
        json_value(const array_t& value)
N
Niels 已提交
890
        {
891
            array = create<array_t>(value);
N
Niels 已提交
892
        }
N
cleanup  
Niels 已提交
893 894
    };

895 896 897 898 899 900 901 902 903 904 905 906 907 908 909
    /*!
    @brief checks the class invariants

    This function asserts the class invariants. It needs to be called at the
    end of every constructor to make sure that created objects respect the
    invariant. Furthermore, it has to be called each time the type of a JSON
    value is changed, because the invariant expresses a relationship between
    @a m_type and @a m_value.
    */
    void assert_invariant() const
    {
        assert(m_type != value_t::object or m_value.object != nullptr);
        assert(m_type != value_t::array or m_value.array != nullptr);
        assert(m_type != value_t::string or m_value.string != nullptr);
    }
N
Niels 已提交
910 911

  public:
N
Niels 已提交
912 913 914 915
    //////////////////////////
    // JSON parser callback //
    //////////////////////////

N
Niels 已提交
916 917 918 919 920
    /*!
    @brief JSON callback events

    This enumeration lists the parser events that can trigger calling a
    callback function of type @ref parser_callback_t during parsing.
921

N
Niels 已提交
922 923
    @image html callback_events.png "Example when certain parse events are triggered"

N
Niels 已提交
924
    @since version 1.0.0
N
Niels 已提交
925
    */
N
Niels 已提交
926 927
    enum class parse_event_t : uint8_t
    {
N
Niels 已提交
928 929 930 931 932 933 934 935 936 937 938 939
        /// the parser read `{` and started to process a JSON object
        object_start,
        /// the parser read `}` and finished processing a JSON object
        object_end,
        /// the parser read `[` and started to process a JSON array
        array_start,
        /// the parser read `]` and finished processing a JSON array
        array_end,
        /// the parser read a key of a value in an object
        key,
        /// the parser finished reading a JSON value
        value
N
Niels 已提交
940 941
    };

N
Niels 已提交
942 943 944 945
    /*!
    @brief per-element parser callback type

    With a parser callback function, the result of parsing a JSON text can be
N
Niels 已提交
946
    influenced. When passed to @ref parse(std::istream&, const
N
Niels 已提交
947
    parser_callback_t) or @ref parse(const char*, const parser_callback_t),
N
Niels 已提交
948 949 950 951 952
    it is called on certain events (passed as @ref parse_event_t via parameter
    @a event) with a set recursion depth @a depth and context JSON value
    @a parsed. The return value of the callback function is a boolean
    indicating whether the element that emitted the callback shall be kept or
    not.
N
Niels 已提交
953 954 955 956 957 958 959 960 961 962 963 964 965 966

    We distinguish six scenarios (determined by the event type) in which the
    callback function can be called. The following table describes the values
    of the parameters @a depth, @a event, and @a parsed.

    parameter @a event | description | parameter @a depth | parameter @a parsed
    ------------------ | ----------- | ------------------ | -------------------
    parse_event_t::object_start | the parser read `{` and started to process a JSON object | depth of the parent of the JSON object | a JSON value with type discarded
    parse_event_t::key | the parser read a key of a value in an object | depth of the currently parsed JSON object | a JSON string containing the key
    parse_event_t::object_end | the parser read `}` and finished processing a JSON object | depth of the parent of the JSON object | the parsed JSON object
    parse_event_t::array_start | the parser read `[` and started to process a JSON array | depth of the parent of the JSON array | a JSON value with type discarded
    parse_event_t::array_end | the parser read `]` and finished processing a JSON array | depth of the parent of the JSON array | the parsed JSON array
    parse_event_t::value | the parser finished reading a JSON value | depth of the value | the parsed JSON value

N
Niels 已提交
967 968
    @image html callback_events.png "Example when certain parse events are triggered"

N
Niels 已提交
969 970
    Discarding a value (i.e., returning `false`) has different effects
    depending on the context in which function was called:
N
Niels 已提交
971 972 973

    - Discarded values in structured types are skipped. That is, the parser
      will behave as if the discarded value was never read.
N
Niels 已提交
974 975
    - In case a value outside a structured type is skipped, it is replaced
      with `null`. This case happens if the top-level element is skipped.
N
Niels 已提交
976

N
Niels 已提交
977
    @param[in] depth  the depth of the recursion during parsing
N
Niels 已提交
978

N
Niels 已提交
979
    @param[in] event  an event of type parse_event_t indicating the context in
N
Niels 已提交
980 981 982 983 984 985 986 987 988 989
    the callback function has been called

    @param[in,out] parsed  the current intermediate parse result; note that
    writing to this value has no effect for parse_event_t::key events

    @return Whether the JSON value which called the function during parsing
    should be kept (`true`) or not (`false`). In the latter case, it is either
    skipped completely or replaced by an empty discarded object.

    @sa @ref parse(std::istream&, parser_callback_t) or
N
Niels 已提交
990
    @ref parse(const char*, parser_callback_t) for examples
991

N
Niels 已提交
992
    @since version 1.0.0
N
Niels 已提交
993
    */
N
Niels 已提交
994 995 996
    using parser_callback_t = std::function<bool(int depth,
                              parse_event_t event,
                              basic_json& parsed)>;
N
Niels 已提交
997

N
cleanup  
Niels 已提交
998 999 1000 1001 1002

    //////////////////
    // constructors //
    //////////////////

N
Niels 已提交
1003
    /// @name constructors and destructors
N
Niels 已提交
1004 1005
    /// Constructors of class @ref basic_json, copy/move constructor, copy
    /// assignment, static functions creating objects, and the destructor.
N
Niels 已提交
1006 1007
    /// @{

N
Niels 已提交
1008 1009 1010
    /*!
    @brief create an empty value with a given type

N
Niels 已提交
1011 1012 1013 1014 1015
    Create an empty JSON value with a given type. The value will be default
    initialized with an empty value which depends on the type:

    Value type  | initial value
    ----------- | -------------
N
Niels 已提交
1016 1017 1018 1019 1020 1021
    null        | `null`
    boolean     | `false`
    string      | `""`
    number      | `0`
    object      | `{}`
    array       | `[]`
N
Niels 已提交
1022

1023
    @param[in] value_type  the type of the value to create
N
Niels 已提交
1024 1025 1026

    @complexity Constant.

N
Niels 已提交
1027
    @throw std::bad_alloc if allocation for object, array, or string value
N
Niels 已提交
1028
    fails
N
Niels 已提交
1029 1030 1031

    @liveexample{The following code shows the constructor for different @ref
    value_t values,basic_json__value_t}
1032 1033 1034 1035 1036 1037

    @sa @ref basic_json(std::nullptr_t) -- create a `null` value
    @sa @ref basic_json(boolean_t value) -- create a boolean value
    @sa @ref basic_json(const string_t&) -- create a string value
    @sa @ref basic_json(const object_t&) -- create a object value
    @sa @ref basic_json(const array_t&) -- create a array value
N
Niels 已提交
1038 1039 1040 1041
    @sa @ref basic_json(const number_float_t) -- create a number
    (floating-point) value
    @sa @ref basic_json(const number_integer_t) -- create a number (integer)
    value
1042 1043
    @sa @ref basic_json(const number_unsigned_t) -- create a number (unsigned)
    value
1044

N
Niels 已提交
1045
    @since version 1.0.0
N
Niels 已提交
1046
    */
1047 1048
    basic_json(const value_t value_type)
        : m_type(value_type), m_value(value_type)
1049 1050 1051
    {
        assert_invariant();
    }
N
cleanup  
Niels 已提交
1052

N
Niels 已提交
1053
    /*!
N
Niels 已提交
1054
    @brief create a null object
N
Niels 已提交
1055

N
Niels 已提交
1056 1057
    Create a `null` JSON value. It either takes a null pointer as parameter
    (explicitly creating `null`) or no parameter (implicitly creating `null`).
N
Niels 已提交
1058 1059
    The passed null pointer itself is not read -- it is only used to choose
    the right constructor.
N
Niels 已提交
1060 1061 1062

    @complexity Constant.

N
Niels 已提交
1063 1064 1065
    @exceptionsafety No-throw guarantee: this constructor never throws
    exceptions.

N
Niels 已提交
1066 1067
    @liveexample{The following code shows the constructor with and without a
    null pointer parameter.,basic_json__nullptr_t}
1068

N
Niels 已提交
1069
    @since version 1.0.0
N
Niels 已提交
1070
    */
N
Niels 已提交
1071
    basic_json(std::nullptr_t = nullptr) noexcept
N
Niels 已提交
1072
        : basic_json(value_t::null)
1073 1074 1075
    {
        assert_invariant();
    }
N
cleanup  
Niels 已提交
1076

N
Niels 已提交
1077 1078 1079 1080 1081
    /*!
    @brief create an object (explicit)

    Create an object JSON value with a given content.

1082
    @param[in] val  a value for the object
N
Niels 已提交
1083

1084
    @complexity Linear in the size of the passed @a val.
N
Niels 已提交
1085

N
Niels 已提交
1086
    @throw std::bad_alloc if allocation for object value fails
N
Niels 已提交
1087

N
Niels 已提交
1088 1089
    @liveexample{The following code shows the constructor with an @ref
    object_t parameter.,basic_json__object_t}
N
Niels 已提交
1090

1091 1092 1093
    @sa @ref basic_json(const CompatibleObjectType&) -- create an object value
    from a compatible STL container

N
Niels 已提交
1094
    @since version 1.0.0
N
Niels 已提交
1095
    */
1096 1097
    basic_json(const object_t& val)
        : m_type(value_t::object), m_value(val)
1098 1099 1100
    {
        assert_invariant();
    }
N
cleanup  
Niels 已提交
1101

N
Niels 已提交
1102 1103 1104 1105
    /*!
    @brief create an object (implicit)

    Create an object JSON value with a given content. This constructor allows
N
Niels 已提交
1106 1107
    any type @a CompatibleObjectType that can be used to construct values of
    type @ref object_t.
N
Niels 已提交
1108

N
Niels 已提交
1109 1110 1111 1112 1113
    @tparam CompatibleObjectType An object type whose `key_type` and
    `value_type` is compatible to @ref object_t. Examples include `std::map`,
    `std::unordered_map`, `std::multimap`, and `std::unordered_multimap` with
    a `key_type` of `std::string`, and a `value_type` from which a @ref
    basic_json value can be constructed.
N
Niels 已提交
1114

1115
    @param[in] val  a value for the object
N
Niels 已提交
1116

1117
    @complexity Linear in the size of the passed @a val.
N
Niels 已提交
1118

N
Niels 已提交
1119
    @throw std::bad_alloc if allocation for object value fails
N
Niels 已提交
1120 1121 1122 1123

    @liveexample{The following code shows the constructor with several
    compatible object type parameters.,basic_json__CompatibleObjectType}

1124 1125
    @sa @ref basic_json(const object_t&) -- create an object value

N
Niels 已提交
1126
    @since version 1.0.0
N
Niels 已提交
1127
    */
N
Niels 已提交
1128 1129 1130
    template<class CompatibleObjectType, typename std::enable_if<
                 std::is_constructible<typename object_t::key_type, typename CompatibleObjectType::key_type>::value and
                 std::is_constructible<basic_json, typename CompatibleObjectType::mapped_type>::value, int>::type = 0>
1131
    basic_json(const CompatibleObjectType& val)
N
Niels 已提交
1132 1133
        : m_type(value_t::object)
    {
1134 1135
        using std::begin;
        using std::end;
1136
        m_value.object = create<object_t>(begin(val), end(val));
1137
        assert_invariant();
N
Niels 已提交
1138
    }
N
cleanup  
Niels 已提交
1139

N
Niels 已提交
1140 1141 1142 1143 1144
    /*!
    @brief create an array (explicit)

    Create an array JSON value with a given content.

1145
    @param[in] val  a value for the array
N
Niels 已提交
1146

1147
    @complexity Linear in the size of the passed @a val.
N
Niels 已提交
1148

N
Niels 已提交
1149
    @throw std::bad_alloc if allocation for array value fails
N
Niels 已提交
1150 1151 1152 1153

    @liveexample{The following code shows the constructor with an @ref array_t
    parameter.,basic_json__array_t}

1154 1155 1156
    @sa @ref basic_json(const CompatibleArrayType&) -- create an array value
    from a compatible STL containers

N
Niels 已提交
1157
    @since version 1.0.0
N
Niels 已提交
1158
    */
1159 1160
    basic_json(const array_t& val)
        : m_type(value_t::array), m_value(val)
1161 1162 1163
    {
        assert_invariant();
    }
N
cleanup  
Niels 已提交
1164

N
Niels 已提交
1165 1166 1167 1168
    /*!
    @brief create an array (implicit)

    Create an array JSON value with a given content. This constructor allows
N
Niels 已提交
1169 1170
    any type @a CompatibleArrayType that can be used to construct values of
    type @ref array_t.
N
Niels 已提交
1171

N
Niels 已提交
1172 1173 1174 1175 1176
    @tparam CompatibleArrayType An object type whose `value_type` is
    compatible to @ref array_t. Examples include `std::vector`, `std::deque`,
    `std::list`, `std::forward_list`, `std::array`, `std::set`,
    `std::unordered_set`, `std::multiset`, and `unordered_multiset` with a
    `value_type` from which a @ref basic_json value can be constructed.
N
Niels 已提交
1177

1178
    @param[in] val  a value for the array
N
Niels 已提交
1179

1180
    @complexity Linear in the size of the passed @a val.
N
Niels 已提交
1181

N
Niels 已提交
1182
    @throw std::bad_alloc if allocation for array value fails
N
Niels 已提交
1183 1184 1185 1186

    @liveexample{The following code shows the constructor with several
    compatible array type parameters.,basic_json__CompatibleArrayType}

1187 1188
    @sa @ref basic_json(const array_t&) -- create an array value

N
Niels 已提交
1189
    @since version 1.0.0
N
Niels 已提交
1190
    */
N
Niels 已提交
1191 1192 1193 1194 1195 1196 1197 1198
    template<class CompatibleArrayType, typename std::enable_if<
                 not std::is_same<CompatibleArrayType, typename basic_json_t::iterator>::value and
                 not std::is_same<CompatibleArrayType, typename basic_json_t::const_iterator>::value and
                 not std::is_same<CompatibleArrayType, typename basic_json_t::reverse_iterator>::value and
                 not std::is_same<CompatibleArrayType, typename basic_json_t::const_reverse_iterator>::value and
                 not std::is_same<CompatibleArrayType, typename array_t::iterator>::value and
                 not std::is_same<CompatibleArrayType, typename array_t::const_iterator>::value and
                 std::is_constructible<basic_json, typename CompatibleArrayType::value_type>::value, int>::type = 0>
1199
    basic_json(const CompatibleArrayType& val)
N
Niels 已提交
1200 1201
        : m_type(value_t::array)
    {
1202 1203
        using std::begin;
        using std::end;
1204
        m_value.array = create<array_t>(begin(val), end(val));
1205
        assert_invariant();
N
Niels 已提交
1206
    }
N
cleanup  
Niels 已提交
1207

N
Niels 已提交
1208 1209 1210 1211 1212
    /*!
    @brief create a string (explicit)

    Create an string JSON value with a given content.

1213
    @param[in] val  a value for the string
N
Niels 已提交
1214

1215
    @complexity Linear in the size of the passed @a val.
N
Niels 已提交
1216

N
Niels 已提交
1217
    @throw std::bad_alloc if allocation for string value fails
N
Niels 已提交
1218

N
Niels 已提交
1219 1220
    @liveexample{The following code shows the constructor with an @ref
    string_t parameter.,basic_json__string_t}
N
Niels 已提交
1221

1222 1223 1224 1225 1226
    @sa @ref basic_json(const typename string_t::value_type*) -- create a
    string value from a character pointer
    @sa @ref basic_json(const CompatibleStringType&) -- create a string value
    from a compatible string container

N
Niels 已提交
1227
    @since version 1.0.0
N
Niels 已提交
1228
    */
1229 1230
    basic_json(const string_t& val)
        : m_type(value_t::string), m_value(val)
1231 1232 1233
    {
        assert_invariant();
    }
N
cleanup  
Niels 已提交
1234

N
Niels 已提交
1235 1236 1237
    /*!
    @brief create a string (explicit)

N
Niels 已提交
1238
    Create a string JSON value with a given content.
N
Niels 已提交
1239

1240
    @param[in] val  a literal value for the string
N
Niels 已提交
1241

1242
    @complexity Linear in the size of the passed @a val.
N
Niels 已提交
1243

N
Niels 已提交
1244
    @throw std::bad_alloc if allocation for string value fails
N
Niels 已提交
1245 1246 1247 1248

    @liveexample{The following code shows the constructor with string literal
    parameter.,basic_json__string_t_value_type}

1249 1250 1251 1252
    @sa @ref basic_json(const string_t&) -- create a string value
    @sa @ref basic_json(const CompatibleStringType&) -- create a string value
    from a compatible string container

N
Niels 已提交
1253
    @since version 1.0.0
N
Niels 已提交
1254
    */
1255 1256
    basic_json(const typename string_t::value_type* val)
        : basic_json(string_t(val))
1257 1258 1259
    {
        assert_invariant();
    }
N
cleanup  
Niels 已提交
1260

N
Niels 已提交
1261 1262 1263 1264 1265
    /*!
    @brief create a string (implicit)

    Create a string JSON value with a given content.

1266
    @param[in] val  a value for the string
N
Niels 已提交
1267 1268

    @tparam CompatibleStringType an string type which is compatible to @ref
N
Niels 已提交
1269
    string_t, for instance `std::string`.
N
Niels 已提交
1270

1271
    @complexity Linear in the size of the passed @a val.
N
Niels 已提交
1272

N
Niels 已提交
1273
    @throw std::bad_alloc if allocation for string value fails
N
Niels 已提交
1274 1275 1276 1277

    @liveexample{The following code shows the construction of a string value
    from a compatible type.,basic_json__CompatibleStringType}

1278 1279 1280 1281
    @sa @ref basic_json(const string_t&) -- create a string value
    @sa @ref basic_json(const typename string_t::value_type*) -- create a
    string value from a character pointer

N
Niels 已提交
1282
    @since version 1.0.0
N
Niels 已提交
1283
    */
N
Niels 已提交
1284 1285
    template<class CompatibleStringType, typename std::enable_if<
                 std::is_constructible<string_t, CompatibleStringType>::value, int>::type = 0>
1286 1287
    basic_json(const CompatibleStringType& val)
        : basic_json(string_t(val))
1288 1289 1290
    {
        assert_invariant();
    }
N
cleanup  
Niels 已提交
1291

N
Niels 已提交
1292 1293 1294 1295 1296
    /*!
    @brief create a boolean (explicit)

    Creates a JSON boolean type from a given value.

1297
    @param[in] val  a boolean value to store
N
Niels 已提交
1298 1299 1300 1301 1302

    @complexity Constant.

    @liveexample{The example below demonstrates boolean
    values.,basic_json__boolean_t}
1303

N
Niels 已提交
1304
    @since version 1.0.0
N
Niels 已提交
1305
    */
N
Niels 已提交
1306
    basic_json(boolean_t val) noexcept
1307
        : m_type(value_t::boolean), m_value(val)
1308 1309 1310
    {
        assert_invariant();
    }
N
cleanup  
Niels 已提交
1311

N
Niels 已提交
1312 1313 1314
    /*!
    @brief create an integer number (explicit)

N
Niels 已提交
1315
    Create an integer number JSON value with a given content.
N
Niels 已提交
1316

N
Niels 已提交
1317
    @tparam T A helper type to remove this function via SFINAE in case @ref
N
Niels 已提交
1318 1319 1320
    number_integer_t is the same as `int`. In this case, this constructor
    would have the same signature as @ref basic_json(const int value). Note
    the helper type @a T is not visible in this constructor's interface.
N
Niels 已提交
1321

1322
    @param[in] val  an integer to create a JSON number from
N
Niels 已提交
1323

N
Niels 已提交
1324 1325
    @complexity Constant.

N
Niels 已提交
1326
    @liveexample{The example below shows the construction of an integer
N
Niels 已提交
1327
    number value.,basic_json__number_integer_t}
N
Niels 已提交
1328

1329 1330 1331 1332
    @sa @ref basic_json(const int) -- create a number value (integer)
    @sa @ref basic_json(const CompatibleNumberIntegerType) -- create a number
    value (integer) from a compatible number type

N
Niels 已提交
1333
    @since version 1.0.0
N
Niels 已提交
1334
    */
N
Niels 已提交
1335 1336 1337
    template<typename T, typename std::enable_if<
                 not (std::is_same<T, int>::value) and
                 std::is_same<T, number_integer_t>::value, int>::type = 0>
N
Niels 已提交
1338
    basic_json(const number_integer_t val) noexcept
1339
        : m_type(value_t::number_integer), m_value(val)
1340 1341 1342
    {
        assert_invariant();
    }
N
cleanup  
Niels 已提交
1343

N
Niels 已提交
1344
    /*!
N
Niels 已提交
1345 1346
    @brief create an integer number from an enum type (explicit)

N
Niels 已提交
1347
    Create an integer number JSON value with a given content.
N
Niels 已提交
1348

1349
    @param[in] val  an integer to create a JSON number from
N
Niels 已提交
1350

N
Niels 已提交
1351 1352 1353
    @note This constructor allows to pass enums directly to a constructor. As
    C++ has no way of specifying the type of an anonymous enum explicitly, we
    can only rely on the fact that such values implicitly convert to int. As
N
Niels 已提交
1354 1355
    int may already be the same type of number_integer_t, we may need to
    switch off the constructor @ref basic_json(const number_integer_t).
N
Niels 已提交
1356 1357 1358

    @complexity Constant.

N
Niels 已提交
1359
    @liveexample{The example below shows the construction of an integer
N
Niels 已提交
1360
    number value from an anonymous enum.,basic_json__const_int}
N
Niels 已提交
1361

1362 1363 1364 1365 1366
    @sa @ref basic_json(const number_integer_t) -- create a number value
    (integer)
    @sa @ref basic_json(const CompatibleNumberIntegerType) -- create a number
    value (integer) from a compatible number type

N
Niels 已提交
1367
    @since version 1.0.0
N
Niels 已提交
1368
    */
N
Niels 已提交
1369
    basic_json(const int val) noexcept
N
Niels 已提交
1370
        : m_type(value_t::number_integer),
1371
          m_value(static_cast<number_integer_t>(val))
1372 1373 1374
    {
        assert_invariant();
    }
N
Niels 已提交
1375

N
Niels 已提交
1376 1377 1378
    /*!
    @brief create an integer number (implicit)

N
Niels 已提交
1379
    Create an integer number JSON value with a given content. This constructor
N
Niels 已提交
1380 1381
    allows any type @a CompatibleNumberIntegerType that can be used to
    construct values of type @ref number_integer_t.
N
Niels 已提交
1382

N
Niels 已提交
1383
    @tparam CompatibleNumberIntegerType An integer type which is compatible to
N
Niels 已提交
1384 1385
    @ref number_integer_t. Examples include the types `int`, `int32_t`,
    `long`, and `short`.
N
Niels 已提交
1386

1387
    @param[in] val  an integer to create a JSON number from
N
Niels 已提交
1388 1389 1390

    @complexity Constant.

N
Niels 已提交
1391 1392
    @liveexample{The example below shows the construction of several integer
    number values from compatible
N
Niels 已提交
1393 1394
    types.,basic_json__CompatibleIntegerNumberType}

1395 1396 1397 1398
    @sa @ref basic_json(const number_integer_t) -- create a number value
    (integer)
    @sa @ref basic_json(const int) -- create a number value (integer)

N
Niels 已提交
1399
    @since version 1.0.0
N
Niels 已提交
1400
    */
N
Niels 已提交
1401
    template<typename CompatibleNumberIntegerType, typename std::enable_if<
N
Niels 已提交
1402
                 std::is_constructible<number_integer_t, CompatibleNumberIntegerType>::value and
N
Niels 已提交
1403 1404
                 std::numeric_limits<CompatibleNumberIntegerType>::is_integer and
                 std::numeric_limits<CompatibleNumberIntegerType>::is_signed,
N
Niels 已提交
1405
                 CompatibleNumberIntegerType>::type = 0>
1406
    basic_json(const CompatibleNumberIntegerType val) noexcept
N
Niels 已提交
1407
        : m_type(value_t::number_integer),
1408
          m_value(static_cast<number_integer_t>(val))
1409 1410 1411
    {
        assert_invariant();
    }
N
cleanup  
Niels 已提交
1412

1413 1414 1415 1416 1417
    /*!
    @brief create an unsigned integer number (explicit)

    Create an unsigned integer number JSON value with a given content.

N
Niels 已提交
1418 1419
    @tparam T  helper type to compare number_unsigned_t and unsigned int (not
    visible in) the interface.
1420 1421 1422 1423 1424 1425 1426 1427 1428 1429

    @param[in] val  an integer to create a JSON number from

    @complexity Constant.

    @sa @ref basic_json(const CompatibleNumberUnsignedType) -- create a number
    value (unsigned integer) from a compatible number type

    @since version 2.0.0
    */
N
Niels 已提交
1430 1431 1432
    template<typename T, typename std::enable_if<
                 not (std::is_same<T, int>::value) and
                 std::is_same<T, number_unsigned_t>::value, int>::type = 0>
N
Niels 已提交
1433
    basic_json(const number_unsigned_t val) noexcept
1434
        : m_type(value_t::number_unsigned), m_value(val)
1435 1436 1437
    {
        assert_invariant();
    }
N
Niels 已提交
1438

1439 1440 1441
    /*!
    @brief create an unsigned number (implicit)

N
Niels 已提交
1442 1443 1444
    Create an unsigned number JSON value with a given content. This
    constructor allows any type @a CompatibleNumberUnsignedType that can be
    used to construct values of type @ref number_unsigned_t.
1445

N
Niels 已提交
1446 1447
    @tparam CompatibleNumberUnsignedType An integer type which is compatible
    to @ref number_unsigned_t. Examples may include the types `unsigned int`,
N
Niels 已提交
1448
    `uint32_t`, or `unsigned short`.
1449 1450 1451 1452 1453 1454 1455 1456 1457 1458

    @param[in] val  an unsigned integer to create a JSON number from

    @complexity Constant.

    @sa @ref basic_json(const number_unsigned_t) -- create a number value
    (unsigned)

    @since version 2.0.0
    */
N
Niels 已提交
1459 1460 1461 1462 1463
    template<typename CompatibleNumberUnsignedType, typename std::enable_if <
                 std::is_constructible<number_unsigned_t, CompatibleNumberUnsignedType>::value and
                 std::numeric_limits<CompatibleNumberUnsignedType>::is_integer and
                 not std::numeric_limits<CompatibleNumberUnsignedType>::is_signed,
                 CompatibleNumberUnsignedType>::type = 0>
1464 1465 1466
    basic_json(const CompatibleNumberUnsignedType val) noexcept
        : m_type(value_t::number_unsigned),
          m_value(static_cast<number_unsigned_t>(val))
1467 1468 1469
    {
        assert_invariant();
    }
1470

N
Niels 已提交
1471 1472 1473 1474 1475
    /*!
    @brief create a floating-point number (explicit)

    Create a floating-point number JSON value with a given content.

1476
    @param[in] val  a floating-point value to create a JSON number from
N
Niels 已提交
1477

1478
    @note [RFC 7159](http://www.rfc-editor.org/rfc/rfc7159.txt), section 6
N
Niels 已提交
1479
    disallows NaN values:
N
Niels 已提交
1480 1481
    > Numeric values that cannot be represented in the grammar below (such as
    > Infinity and NaN) are not permitted.
N
Niels 已提交
1482 1483
    In case the parameter @a val is not a number, a JSON null value is created
    instead.
N
Niels 已提交
1484

N
Niels 已提交
1485
    @complexity Constant.
N
Niels 已提交
1486 1487 1488

    @liveexample{The following example creates several floating-point
    values.,basic_json__number_float_t}
1489 1490 1491 1492

    @sa @ref basic_json(const CompatibleNumberFloatType) -- create a number
    value (floating-point) from a compatible number type

N
Niels 已提交
1493
    @since version 1.0.0
N
Niels 已提交
1494
    */
N
Niels 已提交
1495
    basic_json(const number_float_t val) noexcept
1496
        : m_type(value_t::number_float), m_value(val)
N
Niels 已提交
1497 1498
    {
        // replace infinity and NAN by null
1499
        if (not std::isfinite(val))
N
Niels 已提交
1500 1501 1502 1503
        {
            m_type = value_t::null;
            m_value = json_value();
        }
1504 1505

        assert_invariant();
N
Niels 已提交
1506
    }
N
cleanup  
Niels 已提交
1507

N
Niels 已提交
1508 1509 1510 1511
    /*!
    @brief create an floating-point number (implicit)

    Create an floating-point number JSON value with a given content. This
N
Niels 已提交
1512 1513
    constructor allows any type @a CompatibleNumberFloatType that can be used
    to construct values of type @ref number_float_t.
N
Niels 已提交
1514

N
Niels 已提交
1515 1516 1517
    @tparam CompatibleNumberFloatType A floating-point type which is
    compatible to @ref number_float_t. Examples may include the types `float`
    or `double`.
N
Niels 已提交
1518

1519
    @param[in] val  a floating-point to create a JSON number from
N
Niels 已提交
1520

1521
    @note [RFC 7159](http://www.rfc-editor.org/rfc/rfc7159.txt), section 6
N
Niels 已提交
1522
    disallows NaN values:
N
Niels 已提交
1523 1524
    > Numeric values that cannot be represented in the grammar below (such as
    > Infinity and NaN) are not permitted.
N
Niels 已提交
1525 1526
    In case the parameter @a val is not a number, a JSON null value is
    created instead.
N
Niels 已提交
1527 1528 1529

    @complexity Constant.

N
Niels 已提交
1530
    @liveexample{The example below shows the construction of several
N
Niels 已提交
1531 1532 1533
    floating-point number values from compatible
    types.,basic_json__CompatibleNumberFloatType}

1534 1535 1536
    @sa @ref basic_json(const number_float_t) -- create a number value
    (floating-point)

N
Niels 已提交
1537
    @since version 1.0.0
N
Niels 已提交
1538
    */
N
Niels 已提交
1539
    template<typename CompatibleNumberFloatType, typename = typename std::enable_if<
N
Niels 已提交
1540
                 std::is_constructible<number_float_t, CompatibleNumberFloatType>::value and
N
Niels 已提交
1541
                 std::is_floating_point<CompatibleNumberFloatType>::value>::type>
1542 1543
    basic_json(const CompatibleNumberFloatType val) noexcept
        : basic_json(number_float_t(val))
1544 1545 1546
    {
        assert_invariant();
    }
N
cleanup  
Niels 已提交
1547

N
Niels 已提交
1548 1549 1550 1551 1552 1553 1554 1555 1556 1557
    /*!
    @brief create a container (array or object) from an initializer list

    Creates a JSON value of type array or object from the passed initializer
    list @a init. In case @a type_deduction is `true` (default), the type of
    the JSON value to be created is deducted from the initializer list @a init
    according to the following rules:

    1. If the list is empty, an empty JSON object value `{}` is created.
    2. If the list consists of pairs whose first element is a string, a JSON
N
Niels 已提交
1558 1559
       object value is created where the first elements of the pairs are
       treated as keys and the second elements are as values.
N
Niels 已提交
1560 1561 1562
    3. In all other cases, an array is created.

    The rules aim to create the best fit between a C++ initializer list and
N
Niels 已提交
1563
    JSON values. The rationale is as follows:
N
Niels 已提交
1564 1565

    1. The empty initializer list is written as `{}` which is exactly an empty
N
Niels 已提交
1566
       JSON object.
N
Niels 已提交
1567
    2. C++ has now way of describing mapped types other than to list a list of
N
Niels 已提交
1568 1569 1570
       pairs. As JSON requires that keys must be of type string, rule 2 is the
       weakest constraint one can pose on initializer lists to interpret them
       as an object.
N
Niels 已提交
1571
    3. In all other cases, the initializer list could not be interpreted as
N
Niels 已提交
1572
       JSON object type, so interpreting it as JSON array type is safe.
N
Niels 已提交
1573

N
Niels 已提交
1574 1575
    With the rules described above, the following JSON values cannot be
    expressed by an initializer list:
N
Niels 已提交
1576

N
Niels 已提交
1577 1578 1579 1580 1581
    - the empty array (`[]`): use @ref array(std::initializer_list<basic_json>)
      with an empty initializer list in this case
    - arrays whose elements satisfy rule 2: use @ref
      array(std::initializer_list<basic_json>) with the same initializer list
      in this case
N
Niels 已提交
1582 1583 1584 1585 1586

    @note When used without parentheses around an empty initializer list, @ref
    basic_json() is called instead of this function, yielding the JSON null
    value.

N
Niels 已提交
1587
    @param[in] init  initializer list with JSON values
N
Niels 已提交
1588

N
Niels 已提交
1589 1590 1591
    @param[in] type_deduction internal parameter; when set to `true`, the type
    of the JSON value is deducted from the initializer list @a init; when set
    to `false`, the type provided via @a manual_type is forced. This mode is
N
Niels 已提交
1592 1593
    used by the functions @ref array(std::initializer_list<basic_json>) and
    @ref object(std::initializer_list<basic_json>).
N
Niels 已提交
1594

N
Niels 已提交
1595 1596
    @param[in] manual_type internal parameter; when @a type_deduction is set
    to `false`, the created JSON value will use the provided type (only @ref
N
Niels 已提交
1597 1598 1599
    value_t::array and @ref value_t::object are valid); when @a type_deduction
    is set to `true`, this parameter has no effect

N
Niels 已提交
1600 1601
    @throw std::domain_error if @a type_deduction is `false`, @a manual_type
    is `value_t::object`, but @a init contains an element which is not a pair
N
Niels 已提交
1602 1603
    whose first element is a string; example: `"cannot create object from
    initializer list"`
N
Niels 已提交
1604 1605 1606 1607

    @complexity Linear in the size of the initializer list @a init.

    @liveexample{The example below shows how JSON values are created from
N
Niels 已提交
1608
    initializer lists.,basic_json__list_init_t}
N
Niels 已提交
1609

N
Niels 已提交
1610
    @sa @ref array(std::initializer_list<basic_json>) -- create a JSON array
1611
    value from an initializer list
N
Niels 已提交
1612
    @sa @ref object(std::initializer_list<basic_json>) -- create a JSON object
1613 1614
    value from an initializer list

N
Niels 已提交
1615
    @since version 1.0.0
N
Niels 已提交
1616
    */
N
Niels 已提交
1617 1618
    basic_json(std::initializer_list<basic_json> init,
               bool type_deduction = true,
N
Niels 已提交
1619
               value_t manual_type = value_t::array)
N
cleanup  
Niels 已提交
1620
    {
N
Niels 已提交
1621 1622
        // check if each element is an array with two elements whose first
        // element is a string
N
Niels 已提交
1623 1624
        bool is_an_object = std::all_of(init.begin(), init.end(),
                                        [](const basic_json & element)
N
cleanup  
Niels 已提交
1625
        {
N
Niels 已提交
1626 1627
            return element.is_array() and element.size() == 2 and element[0].is_string();
        });
N
cleanup  
Niels 已提交
1628 1629 1630 1631 1632 1633 1634

        // adjust type if type deduction is not wanted
        if (not type_deduction)
        {
            // if array is wanted, do not create an object though possible
            if (manual_type == value_t::array)
            {
1635
                is_an_object = false;
N
cleanup  
Niels 已提交
1636 1637 1638
            }

            // if object is wanted but impossible, throw an exception
1639
            if (manual_type == value_t::object and not is_an_object)
N
cleanup  
Niels 已提交
1640
            {
N
Niels 已提交
1641
                throw std::domain_error("cannot create object from initializer list");
N
cleanup  
Niels 已提交
1642 1643 1644
            }
        }

1645
        if (is_an_object)
N
cleanup  
Niels 已提交
1646 1647 1648
        {
            // the initializer list is a list of pairs -> create object
            m_type = value_t::object;
N
Niels 已提交
1649
            m_value = value_t::object;
N
Niels 已提交
1650

N
Niels 已提交
1651
            std::for_each(init.begin(), init.end(), [this](const basic_json & element)
N
cleanup  
Niels 已提交
1652
            {
N
Niels 已提交
1653
                m_value.object->emplace(*(element[0].m_value.string), element[1]);
N
Niels 已提交
1654
            });
N
cleanup  
Niels 已提交
1655 1656 1657 1658 1659
        }
        else
        {
            // the initializer list describes an array -> create array
            m_type = value_t::array;
N
Niels 已提交
1660
            m_value.array = create<array_t>(init);
N
cleanup  
Niels 已提交
1661
        }
1662 1663

        assert_invariant();
N
cleanup  
Niels 已提交
1664 1665
    }

N
Niels 已提交
1666 1667 1668 1669 1670 1671 1672
    /*!
    @brief explicitly create an array from an initializer list

    Creates a JSON array value from a given initializer list. That is, given a
    list of values `a, b, c`, creates the JSON value `[a, b, c]`. If the
    initializer list is empty, the empty array `[]` is created.

N
Niels 已提交
1673 1674
    @note This function is only needed to express two edge cases that cannot
    be realized with the initializer list constructor (@ref
N
Niels 已提交
1675 1676
    basic_json(std::initializer_list<basic_json>, bool, value_t)). These cases
    are:
N
Niels 已提交
1677
    1. creating an array whose elements are all pairs whose first element is a
N
Niels 已提交
1678
    string -- in this case, the initializer list constructor would create an
N
Niels 已提交
1679
    object, taking the first elements as keys
N
Niels 已提交
1680
    2. creating an empty array -- passing the empty initializer list to the
N
Niels 已提交
1681 1682
    initializer list constructor yields an empty object

N
Niels 已提交
1683
    @param[in] init  initializer list with JSON values to create an array from
N
Niels 已提交
1684 1685 1686 1687 1688 1689
    (optional)

    @return JSON array value

    @complexity Linear in the size of @a init.

N
Niels 已提交
1690
    @liveexample{The following code shows an example for the `array`
N
Niels 已提交
1691 1692
    function.,array}

1693 1694 1695 1696 1697
    @sa @ref basic_json(std::initializer_list<basic_json>, bool, value_t) --
    create a JSON value from an initializer list
    @sa @ref object(std::initializer_list<basic_json>) -- create a JSON object
    value from an initializer list

N
Niels 已提交
1698
    @since version 1.0.0
N
Niels 已提交
1699
    */
N
Niels 已提交
1700 1701
    static basic_json array(std::initializer_list<basic_json> init =
                                std::initializer_list<basic_json>())
N
cleanup  
Niels 已提交
1702
    {
N
Niels 已提交
1703
        return basic_json(init, false, value_t::array);
N
cleanup  
Niels 已提交
1704 1705
    }

N
Niels 已提交
1706 1707 1708 1709
    /*!
    @brief explicitly create an object from an initializer list

    Creates a JSON object value from a given initializer list. The initializer
N
Niels 已提交
1710
    lists elements must be pairs, and their first elements must be strings. If
N
Niels 已提交
1711 1712 1713
    the initializer list is empty, the empty object `{}` is created.

    @note This function is only added for symmetry reasons. In contrast to the
1714 1715 1716
    related function @ref array(std::initializer_list<basic_json>), there are
    no cases which can only be expressed by this function. That is, any
    initializer list @a init can also be passed to the initializer list
N
Niels 已提交
1717 1718
    constructor @ref basic_json(std::initializer_list<basic_json>, bool,
    value_t).
N
Niels 已提交
1719

N
Niels 已提交
1720
    @param[in] init  initializer list to create an object from (optional)
N
Niels 已提交
1721 1722 1723 1724

    @return JSON object value

    @throw std::domain_error if @a init is not a pair whose first elements are
1725 1726
    strings; thrown by
    @ref basic_json(std::initializer_list<basic_json>, bool, value_t)
N
Niels 已提交
1727 1728 1729

    @complexity Linear in the size of @a init.

N
Niels 已提交
1730
    @liveexample{The following code shows an example for the `object`
N
Niels 已提交
1731 1732
    function.,object}

1733 1734 1735 1736 1737
    @sa @ref basic_json(std::initializer_list<basic_json>, bool, value_t) --
    create a JSON value from an initializer list
    @sa @ref array(std::initializer_list<basic_json>) -- create a JSON array
    value from an initializer list

N
Niels 已提交
1738
    @since version 1.0.0
N
Niels 已提交
1739
    */
N
Niels 已提交
1740 1741
    static basic_json object(std::initializer_list<basic_json> init =
                                 std::initializer_list<basic_json>())
N
cleanup  
Niels 已提交
1742
    {
N
Niels 已提交
1743
        return basic_json(init, false, value_t::object);
N
cleanup  
Niels 已提交
1744 1745
    }

N
Niels 已提交
1746 1747 1748
    /*!
    @brief construct an array with count copies of given value

N
Niels 已提交
1749 1750
    Constructs a JSON array value by creating @a cnt copies of a passed value.
    In case @a cnt is `0`, an empty array is created. As postcondition,
1751
    `std::distance(begin(),end()) == cnt` holds.
N
Niels 已提交
1752

1753 1754
    @param[in] cnt  the number of JSON copies of @a val to create
    @param[in] val  the JSON value to copy
N
Niels 已提交
1755

1756
    @complexity Linear in @a cnt.
N
Niels 已提交
1757 1758 1759 1760

    @liveexample{The following code shows examples for the @ref
    basic_json(size_type\, const basic_json&)
    constructor.,basic_json__size_type_basic_json}
1761

N
Niels 已提交
1762
    @since version 1.0.0
N
Niels 已提交
1763
    */
1764
    basic_json(size_type cnt, const basic_json& val)
N
Niels 已提交
1765 1766
        : m_type(value_t::array)
    {
1767
        m_value.array = create<array_t>(cnt, val);
1768
        assert_invariant();
N
Niels 已提交
1769
    }
N
Niels 已提交
1770

N
Niels 已提交
1771 1772 1773 1774 1775
    /*!
    @brief construct a JSON container given an iterator range

    Constructs the JSON value with the contents of the range `[first, last)`.
    The semantics depends on the different types a JSON value can have:
N
Niels 已提交
1776
    - In case of primitive types (number, boolean, or string), @a first must
N
Niels 已提交
1777 1778
      be `begin()` and @a last must be `end()`. In this case, the value is
      copied. Otherwise, std::out_of_range is thrown.
N
Niels 已提交
1779 1780
    - In case of structured types (array, object), the constructor behaves as
      similar versions for `std::vector`.
N
Niels 已提交
1781
    - In case of a null type, std::domain_error is thrown.
N
Niels 已提交
1782 1783 1784 1785 1786 1787 1788

    @tparam InputIT an input iterator type (@ref iterator or @ref
    const_iterator)

    @param[in] first begin of the range to copy from (included)
    @param[in] last end of the range to copy from (excluded)

N
Niels 已提交
1789 1790
    @pre Iterators @a first and @a last must be initialized. **This
         precondition is enforced with an assertion.**
N
Niels 已提交
1791

N
Niels 已提交
1792
    @throw std::domain_error if iterators are not compatible; that is, do not
N
Niels 已提交
1793
    belong to the same JSON value; example: `"iterators are not compatible"`
N
Niels 已提交
1794
    @throw std::out_of_range if iterators are for a primitive type (number,
N
Niels 已提交
1795 1796
    boolean, or string) where an out of range error can be detected easily;
    example: `"iterators out of range"`
N
Niels 已提交
1797
    @throw std::bad_alloc if allocation for object, array, or string fails
N
Niels 已提交
1798 1799
    @throw std::domain_error if called with a null value; example: `"cannot
    use construct with iterators from null"`
N
Niels 已提交
1800 1801 1802 1803 1804

    @complexity Linear in distance between @a first and @a last.

    @liveexample{The example below shows several ways to create JSON values by
    specifying a subrange with iterators.,basic_json__InputIt_InputIt}
1805

N
Niels 已提交
1806
    @since version 1.0.0
N
Niels 已提交
1807
    */
N
Niels 已提交
1808 1809 1810
    template<class InputIT, typename std::enable_if<
                 std::is_same<InputIT, typename basic_json_t::iterator>::value or
                 std::is_same<InputIT, typename basic_json_t::const_iterator>::value, int>::type = 0>
N
Niels 已提交
1811
    basic_json(InputIT first, InputIT last)
N
Niels 已提交
1812
    {
N
Niels 已提交
1813 1814 1815
        assert(first.m_object != nullptr);
        assert(last.m_object != nullptr);

N
Niels 已提交
1816
        // make sure iterator fits the current value
N
Niels 已提交
1817
        if (first.m_object != last.m_object)
N
Niels 已提交
1818
        {
N
Niels 已提交
1819
            throw std::domain_error("iterators are not compatible");
N
Niels 已提交
1820 1821
        }

N
Niels 已提交
1822 1823 1824
        // copy type from first iterator
        m_type = first.m_object->m_type;

N
Niels 已提交
1825
        // check if iterator range is complete for primitive values
N
Niels 已提交
1826 1827 1828
        switch (m_type)
        {
            case value_t::boolean:
1829 1830
            case value_t::number_float:
            case value_t::number_integer:
1831
            case value_t::number_unsigned:
N
Niels 已提交
1832 1833
            case value_t::string:
            {
1834
                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
N
Niels 已提交
1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853
                {
                    throw std::out_of_range("iterators out of range");
                }
                break;
            }

            default:
            {
                break;
            }
        }

        switch (m_type)
        {
            case value_t::number_integer:
            {
                m_value.number_integer = first.m_object->m_value.number_integer;
                break;
            }
N
Niels 已提交
1854

1855 1856 1857 1858 1859
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = first.m_object->m_value.number_unsigned;
                break;
            }
N
Niels 已提交
1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874

            case value_t::number_float:
            {
                m_value.number_float = first.m_object->m_value.number_float;
                break;
            }

            case value_t::boolean:
            {
                m_value.boolean = first.m_object->m_value.boolean;
                break;
            }

            case value_t::string:
            {
N
Niels 已提交
1875
                m_value = *first.m_object->m_value.string;
N
Niels 已提交
1876 1877 1878 1879 1880
                break;
            }

            case value_t::object:
            {
1881
                m_value.object = create<object_t>(first.m_it.object_iterator, last.m_it.object_iterator);
N
Niels 已提交
1882 1883 1884 1885 1886
                break;
            }

            case value_t::array:
            {
1887
                m_value.array = create<array_t>(first.m_it.array_iterator, last.m_it.array_iterator);
N
Niels 已提交
1888 1889 1890 1891 1892
                break;
            }

            default:
            {
N
Niels 已提交
1893
                throw std::domain_error("cannot use construct with iterators from " + first.m_object->type_name());
N
Niels 已提交
1894 1895
            }
        }
1896 1897

        assert_invariant();
N
Niels 已提交
1898 1899
    }

N
Niels 已提交
1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913
    /*!
    @brief construct a JSON value given an input stream

    @param[in,out] i  stream to read a serialized JSON value from
    @param[in] cb a parser callback function of type @ref parser_callback_t
    which is used to control the deserialization by filtering unwanted values
    (optional)

    @complexity Linear in the length of the input. The parser is a predictive
    LL(1) parser. The complexity can be higher if the parser callback function
    @a cb has a super-linear complexity.

    @note A UTF-8 byte order mark is silently ignored.

N
Niels 已提交
1914 1915 1916 1917 1918 1919 1920
    @deprecated This constructor is deprecated and will be removed in version
      3.0.0 to unify the interface of the library. Deserialization will be
      done by stream operators or by calling one of the `parse` functions,
      e.g. @ref parse(std::istream&, const parser_callback_t). That is, calls
      like `json j(i);` for an input stream @a i need to be replaced by
      `json j = json::parse(i);`. See the example below.

N
Niels 已提交
1921 1922 1923 1924
    @liveexample{The example below demonstrates constructing a JSON value from
    a `std::stringstream` with and without callback
    function.,basic_json__istream}

N
Niels 已提交
1925 1926
    @since version 2.0.0, deprecated in version 2.0.3, to be removed in
           version 3.0.0
N
Niels 已提交
1927
    */
N
Niels 已提交
1928
    JSON_DEPRECATED
N
Niels 已提交
1929
    explicit basic_json(std::istream& i, const parser_callback_t cb = nullptr)
N
Niels 已提交
1930 1931
    {
        *this = parser(i, cb).parse();
1932
        assert_invariant();
N
Niels 已提交
1933 1934
    }

N
cleanup  
Niels 已提交
1935 1936 1937 1938
    ///////////////////////////////////////
    // other constructors and destructor //
    ///////////////////////////////////////

N
Niels 已提交
1939 1940
    /*!
    @brief copy constructor
N
Niels 已提交
1941

N
Niels 已提交
1942 1943
    Creates a copy of a given JSON value.

N
Niels 已提交
1944
    @param[in] other  the JSON value to copy
N
Niels 已提交
1945 1946 1947

    @complexity Linear in the size of @a other.

N
Niels 已提交
1948 1949 1950
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
1951 1952 1953
    - The complexity is linear.
    - As postcondition, it holds: `other == basic_json(other)`.

N
Niels 已提交
1954
    @throw std::bad_alloc if allocation for object, array, or string fails.
N
Niels 已提交
1955 1956

    @liveexample{The following code shows an example for the copy
N
Niels 已提交
1957
    constructor.,basic_json__basic_json}
1958

N
Niels 已提交
1959
    @since version 1.0.0
N
Niels 已提交
1960
    */
1961
    basic_json(const basic_json& other)
N
cleanup  
Niels 已提交
1962 1963
        : m_type(other.m_type)
    {
1964 1965 1966
        // check of passed value is valid
        other.assert_invariant();

N
cleanup  
Niels 已提交
1967 1968
        switch (m_type)
        {
1969
            case value_t::object:
N
cleanup  
Niels 已提交
1970
            {
N
Niels 已提交
1971
                m_value = *other.m_value.object;
N
cleanup  
Niels 已提交
1972 1973
                break;
            }
N
Niels 已提交
1974

1975
            case value_t::array:
N
cleanup  
Niels 已提交
1976
            {
N
Niels 已提交
1977
                m_value = *other.m_value.array;
N
cleanup  
Niels 已提交
1978 1979
                break;
            }
N
Niels 已提交
1980

1981
            case value_t::string:
N
cleanup  
Niels 已提交
1982
            {
N
Niels 已提交
1983
                m_value = *other.m_value.string;
N
cleanup  
Niels 已提交
1984 1985
                break;
            }
N
Niels 已提交
1986

1987
            case value_t::boolean:
N
cleanup  
Niels 已提交
1988
            {
N
Niels 已提交
1989
                m_value = other.m_value.boolean;
N
cleanup  
Niels 已提交
1990 1991
                break;
            }
N
Niels 已提交
1992

1993
            case value_t::number_integer:
N
cleanup  
Niels 已提交
1994
            {
N
Niels 已提交
1995
                m_value = other.m_value.number_integer;
N
cleanup  
Niels 已提交
1996 1997
                break;
            }
N
Niels 已提交
1998

1999 2000 2001 2002 2003
            case value_t::number_unsigned:
            {
                m_value = other.m_value.number_unsigned;
                break;
            }
N
Niels 已提交
2004

2005
            case value_t::number_float:
N
cleanup  
Niels 已提交
2006
            {
N
Niels 已提交
2007
                m_value = other.m_value.number_float;
N
cleanup  
Niels 已提交
2008 2009
                break;
            }
2010 2011 2012 2013 2014

            default:
            {
                break;
            }
N
cleanup  
Niels 已提交
2015
        }
2016 2017

        assert_invariant();
N
cleanup  
Niels 已提交
2018 2019
    }

N
Niels 已提交
2020 2021 2022 2023 2024 2025 2026
    /*!
    @brief move constructor

    Move constructor. Constructs a JSON value with the contents of the given
    value @a other using move semantics. It "steals" the resources from @a
    other and leaves it as JSON null value.

N
Niels 已提交
2027
    @param[in,out] other  value to move to this object
N
Niels 已提交
2028 2029 2030 2031 2032 2033 2034

    @post @a other is a JSON null value

    @complexity Constant.

    @liveexample{The code below shows the move constructor explicitly called
    via std::move.,basic_json__moveconstructor}
2035

N
Niels 已提交
2036
    @since version 1.0.0
N
Niels 已提交
2037
    */
2038
    basic_json(basic_json&& other) noexcept
N
Niels 已提交
2039 2040
        : m_type(std::move(other.m_type)),
          m_value(std::move(other.m_value))
N
cleanup  
Niels 已提交
2041
    {
2042 2043 2044
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2045
        // invalidate payload
N
cleanup  
Niels 已提交
2046 2047
        other.m_type = value_t::null;
        other.m_value = {};
2048 2049

        assert_invariant();
N
cleanup  
Niels 已提交
2050 2051
    }

N
Niels 已提交
2052 2053
    /*!
    @brief copy assignment
N
Niels 已提交
2054

N
Niels 已提交
2055
    Copy assignment operator. Copies a JSON value via the "copy and swap"
N
Niels 已提交
2056 2057
    strategy: It is expressed in terms of the copy constructor, destructor,
    and the swap() member function.
N
Niels 已提交
2058

N
Niels 已提交
2059
    @param[in] other  value to copy from
N
Niels 已提交
2060 2061 2062

    @complexity Linear.

N
Niels 已提交
2063 2064 2065
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2066 2067
    - The complexity is linear.

N
Niels 已提交
2068 2069 2070 2071
    @liveexample{The code below shows and example for the copy assignment. It
    creates a copy of value `a` which is then swapped with `b`. Finally\, the
    copy of `a` (which is the null value after the swap) is
    destroyed.,basic_json__copyassignment}
N
Niels 已提交
2072

N
Niels 已提交
2073
    @since version 1.0.0
N
Niels 已提交
2074
    */
2075
    reference& operator=(basic_json other) noexcept (
N
Niels 已提交
2076 2077 2078 2079 2080
        std::is_nothrow_move_constructible<value_t>::value and
        std::is_nothrow_move_assignable<value_t>::value and
        std::is_nothrow_move_constructible<json_value>::value and
        std::is_nothrow_move_assignable<json_value>::value
    )
N
cleanup  
Niels 已提交
2081
    {
2082 2083 2084
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2085
        using std::swap;
C
Colin Hirsch 已提交
2086 2087
        swap(m_type, other.m_type);
        swap(m_value, other.m_value);
2088 2089

        assert_invariant();
N
cleanup  
Niels 已提交
2090 2091 2092
        return *this;
    }

N
Niels 已提交
2093 2094
    /*!
    @brief destructor
N
Niels 已提交
2095

N
Niels 已提交
2096
    Destroys the JSON value and frees all allocated memory.
N
Niels 已提交
2097 2098 2099

    @complexity Linear.

N
Niels 已提交
2100 2101 2102
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2103 2104
    - The complexity is linear.
    - All stored elements are destroyed and all memory is freed.
2105

N
Niels 已提交
2106
    @since version 1.0.0
N
Niels 已提交
2107
    */
N
Niels 已提交
2108
    ~basic_json()
N
cleanup  
Niels 已提交
2109
    {
2110 2111
        assert_invariant();

N
cleanup  
Niels 已提交
2112 2113
        switch (m_type)
        {
2114
            case value_t::object:
N
cleanup  
Niels 已提交
2115
            {
N
Niels 已提交
2116
                AllocatorType<object_t> alloc;
N
Niels 已提交
2117 2118
                alloc.destroy(m_value.object);
                alloc.deallocate(m_value.object, 1);
N
cleanup  
Niels 已提交
2119 2120
                break;
            }
N
Niels 已提交
2121

2122
            case value_t::array:
N
cleanup  
Niels 已提交
2123
            {
N
Niels 已提交
2124
                AllocatorType<array_t> alloc;
N
Niels 已提交
2125 2126
                alloc.destroy(m_value.array);
                alloc.deallocate(m_value.array, 1);
N
cleanup  
Niels 已提交
2127 2128
                break;
            }
N
Niels 已提交
2129

2130
            case value_t::string:
N
cleanup  
Niels 已提交
2131
            {
N
Niels 已提交
2132
                AllocatorType<string_t> alloc;
N
Niels 已提交
2133
                alloc.destroy(m_value.string);
N
Niels 已提交
2134
                alloc.deallocate(m_value.string, 1);
N
cleanup  
Niels 已提交
2135 2136
                break;
            }
N
Niels 已提交
2137 2138

            default:
N
cleanup  
Niels 已提交
2139
            {
N
Niels 已提交
2140
                // all other types need no specific destructor
N
cleanup  
Niels 已提交
2141 2142 2143 2144 2145
                break;
            }
        }
    }

N
Niels 已提交
2146
    /// @}
N
cleanup  
Niels 已提交
2147 2148 2149 2150 2151 2152

  public:
    ///////////////////////
    // object inspection //
    ///////////////////////

N
Niels 已提交
2153
    /// @name object inspection
N
Niels 已提交
2154
    /// Functions to inspect the type of a JSON value.
N
Niels 已提交
2155 2156
    /// @{

N
cleanup  
Niels 已提交
2157
    /*!
N
Niels 已提交
2158 2159
    @brief serialization

N
Niels 已提交
2160
    Serialization function for JSON values. The function tries to mimic
N
Niels 已提交
2161
    Python's `json.dumps()` function, and currently supports its @a indent
N
Niels 已提交
2162
    parameter.
N
cleanup  
Niels 已提交
2163

N
Niels 已提交
2164
    @param[in] indent If indent is nonnegative, then array elements and object
N
Niels 已提交
2165
    members will be pretty-printed with that indent level. An indent level of
N
Niels 已提交
2166 2167
    `0` will only insert newlines. `-1` (the default) selects the most compact
    representation.
N
cleanup  
Niels 已提交
2168

N
Niels 已提交
2169 2170 2171 2172 2173
    @return string containing the serialization of the JSON value

    @complexity Linear.

    @liveexample{The following example shows the effect of different @a indent
N
Niels 已提交
2174
    parameters to the result of the serialization.,dump}
N
Niels 已提交
2175

N
cleanup  
Niels 已提交
2176
    @see https://docs.python.org/2/library/json.html#json.dump
N
Niels 已提交
2177

N
Niels 已提交
2178
    @since version 1.0.0
N
cleanup  
Niels 已提交
2179
    */
N
Niels 已提交
2180
    string_t dump(const int indent = -1) const
N
cleanup  
Niels 已提交
2181
    {
N
Niels 已提交
2182
        std::stringstream ss;
N
Niels 已提交
2183
        // fix locale problems
N
Niels 已提交
2184
        ss.imbue(std::locale::classic());
N
Niels 已提交
2185

2186 2187 2188 2189 2190 2191
        // 6, 15 or 16 digits of precision allows round-trip IEEE 754
        // string->float->string, string->double->string or string->long
        // double->string; to be safe, we read this value from
        // std::numeric_limits<number_float_t>::digits10
        ss.precision(std::numeric_limits<double>::digits10);

N
cleanup  
Niels 已提交
2192 2193
        if (indent >= 0)
        {
N
Niels 已提交
2194
            dump(ss, true, static_cast<unsigned int>(indent));
N
cleanup  
Niels 已提交
2195 2196 2197
        }
        else
        {
N
Niels 已提交
2198
            dump(ss, false, 0);
N
cleanup  
Niels 已提交
2199
        }
N
Niels 已提交
2200 2201

        return ss.str();
N
cleanup  
Niels 已提交
2202 2203
    }

N
Niels 已提交
2204 2205 2206 2207 2208 2209 2210
    /*!
    @brief return the type of the JSON value (explicit)

    Return the type of the JSON value as a value from the @ref value_t
    enumeration.

    @return the type of the JSON value
N
Niels 已提交
2211 2212 2213

    @complexity Constant.

N
Niels 已提交
2214 2215 2216
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2217
    @liveexample{The following code exemplifies `type()` for all JSON
N
Niels 已提交
2218
    types.,type}
N
Niels 已提交
2219

N
Niels 已提交
2220
    @since version 1.0.0
N
Niels 已提交
2221
    */
N
Niels 已提交
2222
    constexpr value_t type() const noexcept
N
cleanup  
Niels 已提交
2223 2224 2225 2226
    {
        return m_type;
    }

N
Niels 已提交
2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237
    /*!
    @brief return whether type is primitive

    This function returns true iff the JSON type is primitive (string, number,
    boolean, or null).

    @return `true` if type is primitive (string, number, boolean, or null),
    `false` otherwise.

    @complexity Constant.

N
Niels 已提交
2238 2239 2240
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2241
    @liveexample{The following code exemplifies `is_primitive()` for all JSON
N
Niels 已提交
2242
    types.,is_primitive}
N
Niels 已提交
2243

N
Niels 已提交
2244 2245 2246 2247 2248 2249
    @sa @ref is_structured() -- returns whether JSON value is structured
    @sa @ref is_null() -- returns whether JSON value is `null`
    @sa @ref is_string() -- returns whether JSON value is a string
    @sa @ref is_boolean() -- returns whether JSON value is a boolean
    @sa @ref is_number() -- returns whether JSON value is a number

N
Niels 已提交
2250
    @since version 1.0.0
N
Niels 已提交
2251
    */
N
Niels 已提交
2252
    constexpr bool is_primitive() const noexcept
N
Niels 已提交
2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266
    {
        return is_null() or is_string() or is_boolean() or is_number();
    }

    /*!
    @brief return whether type is structured

    This function returns true iff the JSON type is structured (array or
    object).

    @return `true` if type is structured (array or object), `false` otherwise.

    @complexity Constant.

N
Niels 已提交
2267 2268 2269
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2270
    @liveexample{The following code exemplifies `is_structured()` for all JSON
N
Niels 已提交
2271
    types.,is_structured}
N
Niels 已提交
2272

N
Niels 已提交
2273 2274 2275 2276
    @sa @ref is_primitive() -- returns whether value is primitive
    @sa @ref is_array() -- returns whether value is an array
    @sa @ref is_object() -- returns whether value is an object

N
Niels 已提交
2277
    @since version 1.0.0
N
Niels 已提交
2278
    */
N
Niels 已提交
2279
    constexpr bool is_structured() const noexcept
N
Niels 已提交
2280 2281 2282 2283
    {
        return is_array() or is_object();
    }

N
Niels 已提交
2284 2285 2286 2287 2288
    /*!
    @brief return whether value is null

    This function returns true iff the JSON value is null.

N
Niels 已提交
2289
    @return `true` if type is null, `false` otherwise.
N
Niels 已提交
2290 2291 2292

    @complexity Constant.

N
Niels 已提交
2293 2294 2295
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2296
    @liveexample{The following code exemplifies `is_null()` for all JSON
N
Niels 已提交
2297
    types.,is_null}
N
Niels 已提交
2298

N
Niels 已提交
2299
    @since version 1.0.0
N
Niels 已提交
2300
    */
N
Niels 已提交
2301
    constexpr bool is_null() const noexcept
N
Niels 已提交
2302 2303 2304 2305
    {
        return m_type == value_t::null;
    }

N
Niels 已提交
2306 2307 2308 2309 2310
    /*!
    @brief return whether value is a boolean

    This function returns true iff the JSON value is a boolean.

N
Niels 已提交
2311
    @return `true` if type is boolean, `false` otherwise.
N
Niels 已提交
2312 2313 2314

    @complexity Constant.

N
Niels 已提交
2315 2316 2317
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2318
    @liveexample{The following code exemplifies `is_boolean()` for all JSON
N
Niels 已提交
2319
    types.,is_boolean}
N
Niels 已提交
2320

N
Niels 已提交
2321
    @since version 1.0.0
N
Niels 已提交
2322
    */
N
Niels 已提交
2323
    constexpr bool is_boolean() const noexcept
N
Niels 已提交
2324 2325 2326 2327
    {
        return m_type == value_t::boolean;
    }

N
Niels 已提交
2328 2329 2330 2331 2332 2333
    /*!
    @brief return whether value is a number

    This function returns true iff the JSON value is a number. This includes
    both integer and floating-point values.

2334 2335
    @return `true` if type is number (regardless whether integer, unsigned
    integer or floating-type), `false` otherwise.
N
Niels 已提交
2336 2337 2338

    @complexity Constant.

N
Niels 已提交
2339 2340 2341
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2342
    @liveexample{The following code exemplifies `is_number()` for all JSON
N
Niels 已提交
2343
    types.,is_number}
N
Niels 已提交
2344

N
Niels 已提交
2345
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
2346
    integer number
N
Niels 已提交
2347 2348
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2349 2350
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
2351
    @since version 1.0.0
N
Niels 已提交
2352
    */
N
Niels 已提交
2353
    constexpr bool is_number() const noexcept
N
Niels 已提交
2354
    {
N
Niels 已提交
2355
        return is_number_integer() or is_number_float();
N
Niels 已提交
2356 2357
    }

N
Niels 已提交
2358 2359 2360
    /*!
    @brief return whether value is an integer number

N
Niels 已提交
2361
    This function returns true iff the JSON value is an integer or unsigned
2362
    integer number. This excludes floating-point values.
N
Niels 已提交
2363

N
Niels 已提交
2364
    @return `true` if type is an integer or unsigned integer number, `false`
2365
    otherwise.
N
Niels 已提交
2366 2367 2368

    @complexity Constant.

N
Niels 已提交
2369 2370 2371
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2372
    @liveexample{The following code exemplifies `is_number_integer()` for all
N
Niels 已提交
2373
    JSON types.,is_number_integer}
N
Niels 已提交
2374 2375

    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
2376 2377
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2378 2379
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
2380
    @since version 1.0.0
N
Niels 已提交
2381
    */
N
Niels 已提交
2382
    constexpr bool is_number_integer() const noexcept
N
Niels 已提交
2383
    {
2384 2385
        return m_type == value_t::number_integer or m_type == value_t::number_unsigned;
    }
N
Niels 已提交
2386

2387 2388 2389
    /*!
    @brief return whether value is an unsigned integer number

N
Niels 已提交
2390 2391
    This function returns true iff the JSON value is an unsigned integer
    number. This excludes floating-point and (signed) integer values.
2392 2393 2394 2395 2396

    @return `true` if type is an unsigned integer number, `false` otherwise.

    @complexity Constant.

N
Niels 已提交
2397 2398 2399
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2400
    @liveexample{The following code exemplifies `is_number_unsigned()` for all
N
Niels 已提交
2401 2402
    JSON types.,is_number_unsigned}

2403
    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
2404
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
2405 2406 2407 2408 2409
    integer number
    @sa @ref is_number_float() -- check if value is a floating-point number

    @since version 2.0.0
    */
N
Niels 已提交
2410
    constexpr bool is_number_unsigned() const noexcept
2411 2412
    {
        return m_type == value_t::number_unsigned;
N
Niels 已提交
2413 2414
    }

N
Niels 已提交
2415 2416 2417 2418
    /*!
    @brief return whether value is a floating-point number

    This function returns true iff the JSON value is a floating-point number.
2419
    This excludes integer and unsigned integer values.
N
Niels 已提交
2420

N
Niels 已提交
2421
    @return `true` if type is a floating-point number, `false` otherwise.
N
Niels 已提交
2422 2423 2424

    @complexity Constant.

N
Niels 已提交
2425 2426 2427
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2428
    @liveexample{The following code exemplifies `is_number_float()` for all
N
Niels 已提交
2429
    JSON types.,is_number_float}
N
Niels 已提交
2430 2431 2432

    @sa @ref is_number() -- check if value is number
    @sa @ref is_number_integer() -- check if value is an integer number
N
Niels 已提交
2433 2434
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2435

N
Niels 已提交
2436
    @since version 1.0.0
N
Niels 已提交
2437
    */
N
Niels 已提交
2438
    constexpr bool is_number_float() const noexcept
N
Niels 已提交
2439 2440 2441 2442
    {
        return m_type == value_t::number_float;
    }

N
Niels 已提交
2443 2444 2445 2446 2447
    /*!
    @brief return whether value is an object

    This function returns true iff the JSON value is an object.

N
Niels 已提交
2448
    @return `true` if type is object, `false` otherwise.
N
Niels 已提交
2449 2450 2451

    @complexity Constant.

N
Niels 已提交
2452 2453 2454
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2455
    @liveexample{The following code exemplifies `is_object()` for all JSON
N
Niels 已提交
2456
    types.,is_object}
N
Niels 已提交
2457

N
Niels 已提交
2458
    @since version 1.0.0
N
Niels 已提交
2459
    */
N
Niels 已提交
2460
    constexpr bool is_object() const noexcept
N
Niels 已提交
2461 2462 2463 2464
    {
        return m_type == value_t::object;
    }

N
Niels 已提交
2465 2466 2467 2468 2469
    /*!
    @brief return whether value is an array

    This function returns true iff the JSON value is an array.

N
Niels 已提交
2470
    @return `true` if type is array, `false` otherwise.
N
Niels 已提交
2471 2472 2473

    @complexity Constant.

N
Niels 已提交
2474 2475 2476
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2477
    @liveexample{The following code exemplifies `is_array()` for all JSON
N
Niels 已提交
2478
    types.,is_array}
N
Niels 已提交
2479

N
Niels 已提交
2480
    @since version 1.0.0
N
Niels 已提交
2481
    */
N
Niels 已提交
2482
    constexpr bool is_array() const noexcept
N
Niels 已提交
2483 2484 2485 2486
    {
        return m_type == value_t::array;
    }

N
Niels 已提交
2487 2488 2489 2490 2491
    /*!
    @brief return whether value is a string

    This function returns true iff the JSON value is a string.

N
Niels 已提交
2492
    @return `true` if type is string, `false` otherwise.
N
Niels 已提交
2493 2494 2495

    @complexity Constant.

N
Niels 已提交
2496 2497 2498
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2499
    @liveexample{The following code exemplifies `is_string()` for all JSON
N
Niels 已提交
2500
    types.,is_string}
N
Niels 已提交
2501

N
Niels 已提交
2502
    @since version 1.0.0
N
Niels 已提交
2503
    */
N
Niels 已提交
2504
    constexpr bool is_string() const noexcept
N
Niels 已提交
2505 2506 2507 2508
    {
        return m_type == value_t::string;
    }

N
Niels 已提交
2509 2510 2511 2512 2513 2514
    /*!
    @brief return whether value is discarded

    This function returns true iff the JSON value was discarded during parsing
    with a callback function (see @ref parser_callback_t).

N
Niels 已提交
2515 2516 2517 2518
    @note This function will always be `false` for JSON values after parsing.
    That is, discarded values can only occur during parsing, but will be
    removed when inside a structured value or replaced by null in other cases.

N
Niels 已提交
2519 2520 2521 2522
    @return `true` if type is discarded, `false` otherwise.

    @complexity Constant.

N
Niels 已提交
2523 2524 2525
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2526
    @liveexample{The following code exemplifies `is_discarded()` for all JSON
N
Niels 已提交
2527
    types.,is_discarded}
N
Niels 已提交
2528

N
Niels 已提交
2529
    @since version 1.0.0
N
Niels 已提交
2530
    */
N
Niels 已提交
2531
    constexpr bool is_discarded() const noexcept
N
Niels 已提交
2532 2533 2534 2535
    {
        return m_type == value_t::discarded;
    }

N
Niels 已提交
2536 2537 2538 2539 2540 2541 2542 2543 2544 2545
    /*!
    @brief return the type of the JSON value (implicit)

    Implicitly return the type of the JSON value as a value from the @ref
    value_t enumeration.

    @return the type of the JSON value

    @complexity Constant.

N
Niels 已提交
2546 2547 2548
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2549 2550
    @liveexample{The following code exemplifies the @ref value_t operator for
    all JSON types.,operator__value_t}
N
Niels 已提交
2551

N
Niels 已提交
2552
    @since version 1.0.0
N
Niels 已提交
2553
    */
N
Niels 已提交
2554
    constexpr operator value_t() const noexcept
N
Niels 已提交
2555 2556 2557 2558
    {
        return m_type;
    }

N
Niels 已提交
2559 2560
    /// @}

N
Niels 已提交
2561
  private:
N
Niels 已提交
2562 2563 2564
    //////////////////
    // value access //
    //////////////////
N
cleanup  
Niels 已提交
2565

N
Niels 已提交
2566
    /// get an object (explicit)
N
Niels 已提交
2567 2568 2569
    template<class T, typename std::enable_if<
                 std::is_convertible<typename object_t::key_type, typename T::key_type>::value and
                 std::is_convertible<basic_json_t, typename T::mapped_type>::value, int>::type = 0>
2570
    T get_impl(T*) const
N
cleanup  
Niels 已提交
2571
    {
N
Niels 已提交
2572 2573 2574 2575 2576 2577 2578 2579
        if (is_object())
        {
            return T(m_value.object->begin(), m_value.object->end());
        }
        else
        {
            throw std::domain_error("type must be object, but is " + type_name());
        }
N
Niels 已提交
2580 2581 2582
    }

    /// get an object (explicit)
2583
    object_t get_impl(object_t*) const
N
Niels 已提交
2584
    {
N
Niels 已提交
2585 2586 2587 2588 2589 2590 2591 2592
        if (is_object())
        {
            return *(m_value.object);
        }
        else
        {
            throw std::domain_error("type must be object, but is " + type_name());
        }
N
cleanup  
Niels 已提交
2593 2594
    }

N
Niels 已提交
2595
    /// get an array (explicit)
N
Niels 已提交
2596 2597 2598 2599 2600 2601
    template<class T, typename std::enable_if<
                 std::is_convertible<basic_json_t, typename T::value_type>::value and
                 not std::is_same<basic_json_t, typename T::value_type>::value and
                 not std::is_arithmetic<T>::value and
                 not std::is_convertible<std::string, T>::value and
                 not has_mapped_type<T>::value, int>::type = 0>
2602
    T get_impl(T*) const
N
cleanup  
Niels 已提交
2603
    {
N
cleanup  
Niels 已提交
2604
        if (is_array())
N
cleanup  
Niels 已提交
2605
        {
2606 2607 2608
            T to_vector;
            std::transform(m_value.array->begin(), m_value.array->end(),
                           std::inserter(to_vector, to_vector.end()), [](basic_json i)
N
Niels 已提交
2609
            {
2610 2611 2612 2613 2614 2615 2616
                return i.get<typename T::value_type>();
            });
            return to_vector;
        }
        else
        {
            throw std::domain_error("type must be array, but is " + type_name());
N
cleanup  
Niels 已提交
2617 2618 2619
        }
    }

N
Niels 已提交
2620
    /// get an array (explicit)
N
Niels 已提交
2621 2622 2623
    template<class T, typename std::enable_if<
                 std::is_convertible<basic_json_t, T>::value and
                 not std::is_same<basic_json_t, T>::value, int>::type = 0>
2624
    std::vector<T> get_impl(std::vector<T>*) const
N
cleanup  
Niels 已提交
2625
    {
N
cleanup  
Niels 已提交
2626
        if (is_array())
N
cleanup  
Niels 已提交
2627
        {
2628 2629 2630 2631
            std::vector<T> to_vector;
            to_vector.reserve(m_value.array->size());
            std::transform(m_value.array->begin(), m_value.array->end(),
                           std::inserter(to_vector, to_vector.end()), [](basic_json i)
N
Niels 已提交
2632
            {
2633 2634 2635 2636 2637 2638 2639
                return i.get<T>();
            });
            return to_vector;
        }
        else
        {
            throw std::domain_error("type must be array, but is " + type_name());
N
cleanup  
Niels 已提交
2640 2641 2642
        }
    }

N
Niels 已提交
2643
    /// get an array (explicit)
N
Niels 已提交
2644 2645 2646
    template<class T, typename std::enable_if<
                 std::is_same<basic_json, typename T::value_type>::value and
                 not has_mapped_type<T>::value, int>::type = 0>
2647
    T get_impl(T*) const
N
Niels 已提交
2648
    {
N
Niels 已提交
2649 2650 2651 2652 2653 2654 2655 2656
        if (is_array())
        {
            return T(m_value.array->begin(), m_value.array->end());
        }
        else
        {
            throw std::domain_error("type must be array, but is " + type_name());
        }
N
Niels 已提交
2657 2658
    }

N
Niels 已提交
2659
    /// get an array (explicit)
2660
    array_t get_impl(array_t*) const
N
Niels 已提交
2661
    {
N
Niels 已提交
2662 2663 2664 2665 2666 2667 2668 2669
        if (is_array())
        {
            return *(m_value.array);
        }
        else
        {
            throw std::domain_error("type must be array, but is " + type_name());
        }
N
Niels 已提交
2670 2671 2672
    }

    /// get a string (explicit)
N
Niels 已提交
2673 2674
    template<typename T, typename std::enable_if<
                 std::is_convertible<string_t, T>::value, int>::type = 0>
2675
    T get_impl(T*) const
N
cleanup  
Niels 已提交
2676
    {
N
Niels 已提交
2677 2678 2679 2680 2681 2682 2683 2684
        if (is_string())
        {
            return *m_value.string;
        }
        else
        {
            throw std::domain_error("type must be string, but is " + type_name());
        }
N
cleanup  
Niels 已提交
2685 2686
    }

N
Niels 已提交
2687
    /// get a number (explicit)
N
Niels 已提交
2688 2689
    template<typename T, typename std::enable_if<
                 std::is_arithmetic<T>::value, int>::type = 0>
2690
    T get_impl(T*) const
N
cleanup  
Niels 已提交
2691 2692 2693
    {
        switch (m_type)
        {
2694
            case value_t::number_integer:
N
Niels 已提交
2695
            {
N
cleanup  
Niels 已提交
2696
                return static_cast<T>(m_value.number_integer);
N
Niels 已提交
2697
            }
N
Niels 已提交
2698

2699 2700 2701 2702
            case value_t::number_unsigned:
            {
                return static_cast<T>(m_value.number_unsigned);
            }
2703 2704

            case value_t::number_float:
N
Niels 已提交
2705
            {
N
cleanup  
Niels 已提交
2706
                return static_cast<T>(m_value.number_float);
N
Niels 已提交
2707
            }
2708

N
cleanup  
Niels 已提交
2709
            default:
N
Niels 已提交
2710
            {
N
Niels 已提交
2711
                throw std::domain_error("type must be number, but is " + type_name());
N
Niels 已提交
2712 2713 2714 2715 2716
            }
        }
    }

    /// get a boolean (explicit)
N
Niels 已提交
2717
    constexpr boolean_t get_impl(boolean_t*) const
N
Niels 已提交
2718
    {
N
Niels 已提交
2719 2720 2721
        return is_boolean()
               ? m_value.boolean
               : throw std::domain_error("type must be boolean, but is " + type_name());
N
cleanup  
Niels 已提交
2722 2723
    }

N
Niels 已提交
2724
    /// get a pointer to the value (object)
N
Niels 已提交
2725 2726 2727 2728 2729 2730
    object_t* get_impl_ptr(object_t*) noexcept
    {
        return is_object() ? m_value.object : nullptr;
    }

    /// get a pointer to the value (object)
N
Niels 已提交
2731
    constexpr const object_t* get_impl_ptr(const object_t*) const noexcept
N
Niels 已提交
2732 2733 2734 2735 2736
    {
        return is_object() ? m_value.object : nullptr;
    }

    /// get a pointer to the value (array)
N
Niels 已提交
2737
    array_t* get_impl_ptr(array_t*) noexcept
N
Niels 已提交
2738 2739 2740 2741
    {
        return is_array() ? m_value.array : nullptr;
    }

N
Niels 已提交
2742
    /// get a pointer to the value (array)
N
Niels 已提交
2743
    constexpr const array_t* get_impl_ptr(const array_t*) const noexcept
N
Niels 已提交
2744 2745 2746 2747 2748 2749 2750 2751 2752 2753
    {
        return is_array() ? m_value.array : nullptr;
    }

    /// get a pointer to the value (string)
    string_t* get_impl_ptr(string_t*) noexcept
    {
        return is_string() ? m_value.string : nullptr;
    }

N
Niels 已提交
2754
    /// get a pointer to the value (string)
N
Niels 已提交
2755
    constexpr const string_t* get_impl_ptr(const string_t*) const noexcept
N
Niels 已提交
2756 2757 2758 2759 2760
    {
        return is_string() ? m_value.string : nullptr;
    }

    /// get a pointer to the value (boolean)
N
Niels 已提交
2761 2762 2763 2764 2765 2766
    boolean_t* get_impl_ptr(boolean_t*) noexcept
    {
        return is_boolean() ? &m_value.boolean : nullptr;
    }

    /// get a pointer to the value (boolean)
N
Niels 已提交
2767
    constexpr const boolean_t* get_impl_ptr(const boolean_t*) const noexcept
N
Niels 已提交
2768 2769 2770 2771 2772
    {
        return is_boolean() ? &m_value.boolean : nullptr;
    }

    /// get a pointer to the value (integer number)
N
Niels 已提交
2773
    number_integer_t* get_impl_ptr(number_integer_t*) noexcept
N
Niels 已提交
2774 2775 2776 2777
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }

N
Niels 已提交
2778
    /// get a pointer to the value (integer number)
N
Niels 已提交
2779
    constexpr const number_integer_t* get_impl_ptr(const number_integer_t*) const noexcept
N
Niels 已提交
2780 2781 2782
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }
N
Niels 已提交
2783

2784 2785 2786 2787 2788
    /// get a pointer to the value (unsigned number)
    number_unsigned_t* get_impl_ptr(number_unsigned_t*) noexcept
    {
        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
    }
N
Niels 已提交
2789

2790
    /// get a pointer to the value (unsigned number)
N
Niels 已提交
2791
    constexpr const number_unsigned_t* get_impl_ptr(const number_unsigned_t*) const noexcept
2792 2793 2794
    {
        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
    }
N
Niels 已提交
2795

N
Niels 已提交
2796 2797 2798 2799 2800 2801
    /// get a pointer to the value (floating-point number)
    number_float_t* get_impl_ptr(number_float_t*) noexcept
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

N
Niels 已提交
2802
    /// get a pointer to the value (floating-point number)
N
Niels 已提交
2803
    constexpr const number_float_t* get_impl_ptr(const number_float_t*) const noexcept
N
Niels 已提交
2804 2805 2806 2807
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

N
Niels 已提交
2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819
    /*!
    @brief helper function to implement get_ref()

    This funcion helps to implement get_ref() without code duplication for
    const and non-const overloads

    @tparam ThisType will be deduced as `basic_json` or `const basic_json`

    @throw std::domain_error if ReferenceType does not match underlying value
    type of the current JSON
    */
    template<typename ReferenceType, typename ThisType>
2820
    static ReferenceType get_ref_impl(ThisType& obj)
D
dariomt 已提交
2821
    {
N
Niels 已提交
2822
        // helper type
N
Niels 已提交
2823 2824
        using PointerType = typename std::add_pointer<ReferenceType>::type;

N
Niels 已提交
2825
        // delegate the call to get_ptr<>()
2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836
        auto ptr = obj.template get_ptr<PointerType>();

        if (ptr != nullptr)
        {
            return *ptr;
        }
        else
        {
            throw std::domain_error("incompatible ReferenceType for get_ref, actual type is " +
                                    obj.type_name());
        }
D
dariomt 已提交
2837 2838
    }

N
Niels 已提交
2839
  public:
N
Niels 已提交
2840 2841

    /// @name value access
N
Niels 已提交
2842
    /// Direct access to the stored value of a JSON value.
N
Niels 已提交
2843 2844
    /// @{

N
Niels 已提交
2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856
    /*!
    @brief get a value (explicit)

    Explicit type conversion between the JSON value and a compatible value.

    @tparam ValueType non-pointer type compatible to the JSON value, for
    instance `int` for JSON integer numbers, `bool` for JSON booleans, or
    `std::vector` types for JSON arrays

    @return copy of the JSON value, converted to type @a ValueType

    @throw std::domain_error in case passed type @a ValueType is incompatible
N
Niels 已提交
2857
    to JSON; example: `"type must be object, but is null"`
N
Niels 已提交
2858 2859 2860

    @complexity Linear in the size of the JSON value.

N
Niels 已提交
2861
    @liveexample{The example below shows several conversions from JSON values
N
Niels 已提交
2862 2863 2864
    to other types. There a few things to note: (1) Floating-point numbers can
    be converted to integers\, (2) A JSON array can be converted to a standard
    `std::vector<short>`\, (3) A JSON object can be converted to C++
N
Niels 已提交
2865
    associative containers such as `std::unordered_map<std::string\,
N
Niels 已提交
2866 2867 2868 2869 2870 2871 2872 2873 2874
    json>`.,get__ValueType_const}

    @internal
    The idea of using a casted null pointer to choose the correct
    implementation is from <http://stackoverflow.com/a/8315197/266378>.
    @endinternal

    @sa @ref operator ValueType() const for implicit conversion
    @sa @ref get() for pointer-member access
N
Niels 已提交
2875

N
Niels 已提交
2876
    @since version 1.0.0
N
Niels 已提交
2877
    */
N
Niels 已提交
2878 2879
    template<typename ValueType, typename std::enable_if<
                 not std::is_pointer<ValueType>::value, int>::type = 0>
N
Niels 已提交
2880
    ValueType get() const
N
Niels 已提交
2881
    {
N
Niels 已提交
2882
        return get_impl(static_cast<ValueType*>(nullptr));
N
Niels 已提交
2883 2884
    }

N
Niels 已提交
2885 2886 2887 2888 2889 2890
    /*!
    @brief get a pointer value (explicit)

    Explicit pointer access to the internally stored JSON value. No copies are
    made.

N
Niels 已提交
2891 2892
    @warning The pointer becomes invalid if the underlying JSON object
    changes.
N
Niels 已提交
2893 2894

    @tparam PointerType pointer type; must be a pointer to @ref array_t, @ref
N
Niels 已提交
2895
    object_t, @ref string_t, @ref boolean_t, @ref number_integer_t,
2896
    @ref number_unsigned_t, or @ref number_float_t.
N
Niels 已提交
2897

N
Niels 已提交
2898 2899
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
2900 2901 2902 2903 2904 2905 2906 2907 2908

    @complexity Constant.

    @liveexample{The example below shows how pointers to internal values of a
    JSON value can be requested. Note that no type conversions are made and a
    `nullptr` is returned if the value and the requested pointer type does not
    match.,get__PointerType}

    @sa @ref get_ptr() for explicit pointer-member access
N
Niels 已提交
2909

N
Niels 已提交
2910
    @since version 1.0.0
N
Niels 已提交
2911
    */
N
Niels 已提交
2912 2913
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
2914 2915 2916 2917 2918 2919 2920 2921 2922 2923
    PointerType get() noexcept
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

    /*!
    @brief get a pointer value (explicit)
    @copydoc get()
    */
N
Niels 已提交
2924 2925
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
2926
    constexpr const PointerType get() const noexcept
N
Niels 已提交
2927 2928 2929 2930 2931 2932 2933 2934
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

    /*!
    @brief get a pointer value (implicit)

N
Niels 已提交
2935
    Implicit pointer access to the internally stored JSON value. No copies are
N
Niels 已提交
2936 2937 2938 2939 2940 2941
    made.

    @warning Writing data to the pointee of the result yields an undefined
    state.

    @tparam PointerType pointer type; must be a pointer to @ref array_t, @ref
N
Niels 已提交
2942
    object_t, @ref string_t, @ref boolean_t, @ref number_integer_t,
N
Niels 已提交
2943 2944
    @ref number_unsigned_t, or @ref number_float_t. Enforced by a static
    assertion.
N
Niels 已提交
2945

N
Niels 已提交
2946 2947
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
2948 2949 2950 2951 2952 2953 2954

    @complexity Constant.

    @liveexample{The example below shows how pointers to internal values of a
    JSON value can be requested. Note that no type conversions are made and a
    `nullptr` is returned if the value and the requested pointer type does not
    match.,get_ptr}
N
Niels 已提交
2955

N
Niels 已提交
2956
    @since version 1.0.0
N
Niels 已提交
2957
    */
N
Niels 已提交
2958 2959
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
2960 2961
    PointerType get_ptr() noexcept
    {
N
Niels 已提交
2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976
        // get the type of the PointerType (remove pointer and const)
        using pointee_t = typename std::remove_const<typename
                          std::remove_pointer<typename
                          std::remove_const<PointerType>::type>::type>::type;
        // make sure the type matches the allowed types
        static_assert(
            std::is_same<object_t, pointee_t>::value
            or std::is_same<array_t, pointee_t>::value
            or std::is_same<string_t, pointee_t>::value
            or std::is_same<boolean_t, pointee_t>::value
            or std::is_same<number_integer_t, pointee_t>::value
            or std::is_same<number_unsigned_t, pointee_t>::value
            or std::is_same<number_float_t, pointee_t>::value
            , "incompatible pointer type");

N
Niels 已提交
2977 2978 2979 2980 2981 2982 2983 2984
        // delegate the call to get_impl_ptr<>()
        return get_impl_ptr(static_cast<PointerType>(nullptr));
    }

    /*!
    @brief get a pointer value (implicit)
    @copydoc get_ptr()
    */
N
Niels 已提交
2985 2986 2987
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value and
                 std::is_const<typename std::remove_pointer<PointerType>::type>::value, int>::type = 0>
N
Niels 已提交
2988
    constexpr const PointerType get_ptr() const noexcept
N
Niels 已提交
2989
    {
N
Niels 已提交
2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004
        // get the type of the PointerType (remove pointer and const)
        using pointee_t = typename std::remove_const<typename
                          std::remove_pointer<typename
                          std::remove_const<PointerType>::type>::type>::type;
        // make sure the type matches the allowed types
        static_assert(
            std::is_same<object_t, pointee_t>::value
            or std::is_same<array_t, pointee_t>::value
            or std::is_same<string_t, pointee_t>::value
            or std::is_same<boolean_t, pointee_t>::value
            or std::is_same<number_integer_t, pointee_t>::value
            or std::is_same<number_unsigned_t, pointee_t>::value
            or std::is_same<number_float_t, pointee_t>::value
            , "incompatible pointer type");

N
Niels 已提交
3005 3006
        // delegate the call to get_impl_ptr<>() const
        return get_impl_ptr(static_cast<const PointerType>(nullptr));
N
Niels 已提交
3007 3008
    }

N
Niels 已提交
3009
    /*!
D
dariomt 已提交
3010 3011
    @brief get a reference value (implicit)

N
Niels 已提交
3012 3013
    Implict reference access to the internally stored JSON value. No copies
    are made.
D
dariomt 已提交
3014 3015 3016 3017

    @warning Writing data to the referee of the result yields an undefined
    state.

N
Niels 已提交
3018 3019
    @tparam ReferenceType reference type; must be a reference to @ref array_t,
    @ref object_t, @ref string_t, @ref boolean_t, @ref number_integer_t, or
N
Niels 已提交
3020
    @ref number_float_t. Enforced by static assertion.
D
dariomt 已提交
3021

N
Niels 已提交
3022 3023 3024
    @return reference to the internally stored JSON value if the requested
    reference type @a ReferenceType fits to the JSON value; throws
    std::domain_error otherwise
D
dariomt 已提交
3025

N
Niels 已提交
3026 3027
    @throw std::domain_error in case passed type @a ReferenceType is
    incompatible with the stored JSON value
D
dariomt 已提交
3028 3029

    @complexity Constant.
N
Niels 已提交
3030 3031 3032

    @liveexample{The example shows several calls to `get_ref()`.,get_ref}

N
Niels 已提交
3033
    @since version 1.1.0
D
dariomt 已提交
3034
    */
N
Niels 已提交
3035 3036
    template<typename ReferenceType, typename std::enable_if<
                 std::is_reference<ReferenceType>::value, int>::type = 0>
D
dariomt 已提交
3037 3038
    ReferenceType get_ref()
    {
N
Niels 已提交
3039 3040
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
D
dariomt 已提交
3041 3042 3043 3044 3045 3046
    }

    /*!
    @brief get a reference value (implicit)
    @copydoc get_ref()
    */
N
Niels 已提交
3047 3048 3049
    template<typename ReferenceType, typename std::enable_if<
                 std::is_reference<ReferenceType>::value and
                 std::is_const<typename std::remove_reference<ReferenceType>::type>::value, int>::type = 0>
3050
    ReferenceType get_ref() const
D
dariomt 已提交
3051
    {
N
Niels 已提交
3052 3053
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
D
dariomt 已提交
3054 3055
    }

N
Niels 已提交
3056 3057 3058
    /*!
    @brief get a value (implicit)

N
Niels 已提交
3059 3060
    Implicit type conversion between the JSON value and a compatible value.
    The call is realized by calling @ref get() const.
N
Niels 已提交
3061 3062 3063

    @tparam ValueType non-pointer type compatible to the JSON value, for
    instance `int` for JSON integer numbers, `bool` for JSON booleans, or
N
Niels 已提交
3064 3065 3066
    `std::vector` types for JSON arrays. The character type of @ref string_t
    as well as an initializer list of this type is excluded to avoid
    ambiguities as these types implicitly convert to `std::string`.
N
Niels 已提交
3067 3068 3069 3070 3071 3072 3073 3074

    @return copy of the JSON value, converted to type @a ValueType

    @throw std::domain_error in case passed type @a ValueType is incompatible
    to JSON, thrown by @ref get() const

    @complexity Linear in the size of the JSON value.

N
Niels 已提交
3075
    @liveexample{The example below shows several conversions from JSON values
N
Niels 已提交
3076 3077 3078
    to other types. There a few things to note: (1) Floating-point numbers can
    be converted to integers\, (2) A JSON array can be converted to a standard
    `std::vector<short>`\, (3) A JSON object can be converted to C++
N
Niels 已提交
3079
    associative containers such as `std::unordered_map<std::string\,
N
Niels 已提交
3080
    json>`.,operator__ValueType}
N
Niels 已提交
3081

N
Niels 已提交
3082
    @since version 1.0.0
N
Niels 已提交
3083
    */
N
Niels 已提交
3084 3085 3086
    template < typename ValueType, typename std::enable_if <
                   not std::is_pointer<ValueType>::value and
                   not std::is_same<ValueType, typename string_t::value_type>::value
3087
#ifndef _MSC_VER  // Fix for issue #167 operator<< abiguity under VS2015
N
Niels 已提交
3088
                   and not std::is_same<ValueType, std::initializer_list<typename string_t::value_type>>::value
3089
#endif
N
Niels 已提交
3090
                   , int >::type = 0 >
N
Niels 已提交
3091
    operator ValueType() const
N
cleanup  
Niels 已提交
3092
    {
N
Niels 已提交
3093 3094
        // delegate the call to get<>() const
        return get<ValueType>();
N
cleanup  
Niels 已提交
3095 3096
    }

N
Niels 已提交
3097 3098
    /// @}

N
cleanup  
Niels 已提交
3099 3100 3101 3102 3103

    ////////////////////
    // element access //
    ////////////////////

N
Niels 已提交
3104
    /// @name element access
N
Niels 已提交
3105
    /// Access to the JSON value.
N
Niels 已提交
3106 3107
    /// @{

N
Niels 已提交
3108 3109 3110 3111 3112 3113 3114 3115 3116 3117
    /*!
    @brief access specified array element with bounds checking

    Returns a reference to the element at specified location @a idx, with
    bounds checking.

    @param[in] idx  index of the element to access

    @return reference to the element at index @a idx

N
Niels 已提交
3118 3119
    @throw std::domain_error if the JSON value is not an array; example:
    `"cannot use at() with string"`
N
Niels 已提交
3120
    @throw std::out_of_range if the index @a idx is out of range of the array;
N
Niels 已提交
3121
    that is, `idx >= size()`; example: `"array index 7 is out of range"`
N
Niels 已提交
3122 3123 3124 3125

    @complexity Constant.

    @liveexample{The example below shows how array elements can be read and
N
Niels 已提交
3126
    written using `at()`.,at__size_type}
N
Niels 已提交
3127

N
Niels 已提交
3128
    @since version 1.0.0
N
Niels 已提交
3129
    */
3130
    reference at(size_type idx)
N
cleanup  
Niels 已提交
3131 3132
    {
        // at only works for arrays
3133 3134
        if (is_array())
        {
N
Niels 已提交
3135 3136 3137 3138
            try
            {
                return m_value.array->at(idx);
            }
3139
            catch (std::out_of_range&)
N
Niels 已提交
3140 3141 3142 3143
            {
                // create better exception explanation
                throw std::out_of_range("array index " + std::to_string(idx) + " is out of range");
            }
3144 3145 3146 3147 3148
        }
        else
        {
            throw std::domain_error("cannot use at() with " + type_name());
        }
N
cleanup  
Niels 已提交
3149 3150
    }

N
Niels 已提交
3151 3152 3153
    /*!
    @brief access specified array element with bounds checking

N
Niels 已提交
3154 3155
    Returns a const reference to the element at specified location @a idx,
    with bounds checking.
N
Niels 已提交
3156 3157 3158 3159 3160

    @param[in] idx  index of the element to access

    @return const reference to the element at index @a idx

N
Niels 已提交
3161 3162
    @throw std::domain_error if the JSON value is not an array; example:
    `"cannot use at() with string"`
N
Niels 已提交
3163
    @throw std::out_of_range if the index @a idx is out of range of the array;
N
Niels 已提交
3164
    that is, `idx >= size()`; example: `"array index 7 is out of range"`
N
Niels 已提交
3165 3166 3167 3168

    @complexity Constant.

    @liveexample{The example below shows how array elements can be read using
N
Niels 已提交
3169
    `at()`.,at__size_type_const}
N
Niels 已提交
3170

N
Niels 已提交
3171
    @since version 1.0.0
N
Niels 已提交
3172
    */
3173
    const_reference at(size_type idx) const
N
cleanup  
Niels 已提交
3174 3175
    {
        // at only works for arrays
3176 3177
        if (is_array())
        {
N
Niels 已提交
3178 3179 3180 3181
            try
            {
                return m_value.array->at(idx);
            }
3182
            catch (std::out_of_range&)
N
Niels 已提交
3183 3184 3185 3186
            {
                // create better exception explanation
                throw std::out_of_range("array index " + std::to_string(idx) + " is out of range");
            }
3187 3188 3189 3190 3191
        }
        else
        {
            throw std::domain_error("cannot use at() with " + type_name());
        }
3192 3193
    }

N
Niels 已提交
3194 3195 3196 3197 3198 3199 3200 3201 3202 3203
    /*!
    @brief access specified object element with bounds checking

    Returns a reference to the element at with specified key @a key, with
    bounds checking.

    @param[in] key  key of the element to access

    @return reference to the element at key @a key

N
Niels 已提交
3204 3205
    @throw std::domain_error if the JSON value is not an object; example:
    `"cannot use at() with boolean"`
N
Niels 已提交
3206
    @throw std::out_of_range if the key @a key is is not stored in the object;
N
Niels 已提交
3207
    that is, `find(key) == end()`; example: `"key "the fast" not found"`
N
Niels 已提交
3208 3209 3210 3211

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3212
    written using `at()`.,at__object_t_key_type}
N
Niels 已提交
3213 3214 3215 3216

    @sa @ref operator[](const typename object_t::key_type&) for unchecked
    access by reference
    @sa @ref value() for access by value with a default value
N
Niels 已提交
3217

N
Niels 已提交
3218
    @since version 1.0.0
N
Niels 已提交
3219
    */
3220
    reference at(const typename object_t::key_type& key)
3221 3222
    {
        // at only works for objects
3223 3224
        if (is_object())
        {
N
Niels 已提交
3225 3226 3227 3228
            try
            {
                return m_value.object->at(key);
            }
3229
            catch (std::out_of_range&)
N
Niels 已提交
3230 3231 3232 3233
            {
                // create better exception explanation
                throw std::out_of_range("key '" + key + "' not found");
            }
3234 3235 3236 3237 3238
        }
        else
        {
            throw std::domain_error("cannot use at() with " + type_name());
        }
3239 3240
    }

N
Niels 已提交
3241 3242 3243
    /*!
    @brief access specified object element with bounds checking

N
Niels 已提交
3244 3245
    Returns a const reference to the element at with specified key @a key,
    with bounds checking.
N
Niels 已提交
3246 3247 3248 3249 3250

    @param[in] key  key of the element to access

    @return const reference to the element at key @a key

N
Niels 已提交
3251 3252
    @throw std::domain_error if the JSON value is not an object; example:
    `"cannot use at() with boolean"`
N
Niels 已提交
3253
    @throw std::out_of_range if the key @a key is is not stored in the object;
N
Niels 已提交
3254
    that is, `find(key) == end()`; example: `"key "the fast" not found"`
N
Niels 已提交
3255 3256 3257 3258

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3259
    `at()`.,at__object_t_key_type_const}
N
Niels 已提交
3260 3261 3262 3263

    @sa @ref operator[](const typename object_t::key_type&) for unchecked
    access by reference
    @sa @ref value() for access by value with a default value
N
Niels 已提交
3264

N
Niels 已提交
3265
    @since version 1.0.0
N
Niels 已提交
3266
    */
3267
    const_reference at(const typename object_t::key_type& key) const
3268 3269
    {
        // at only works for objects
3270 3271
        if (is_object())
        {
N
Niels 已提交
3272 3273 3274 3275
            try
            {
                return m_value.object->at(key);
            }
3276
            catch (std::out_of_range&)
N
Niels 已提交
3277 3278 3279 3280
            {
                // create better exception explanation
                throw std::out_of_range("key '" + key + "' not found");
            }
3281 3282 3283 3284 3285
        }
        else
        {
            throw std::domain_error("cannot use at() with " + type_name());
        }
N
cleanup  
Niels 已提交
3286 3287
    }

N
Niels 已提交
3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300
    /*!
    @brief access specified array element

    Returns a reference to the element at specified location @a idx.

    @note If @a idx is beyond the range of the array (i.e., `idx >= size()`),
    then the array is silently filled up with `null` values to make `idx` a
    valid reference to the last stored element.

    @param[in] idx  index of the element to access

    @return reference to the element at index @a idx

N
Niels 已提交
3301 3302
    @throw std::domain_error if JSON is not an array or null; example:
    `"cannot use operator[] with string"`
N
Niels 已提交
3303 3304 3305 3306 3307

    @complexity Constant if @a idx is in the range of the array. Otherwise
    linear in `idx - size()`.

    @liveexample{The example below shows how array elements can be read and
N
Niels 已提交
3308
    written using `[]` operator. Note the addition of `null`
N
Niels 已提交
3309
    values.,operatorarray__size_type}
N
Niels 已提交
3310

N
Niels 已提交
3311
    @since version 1.0.0
N
Niels 已提交
3312
    */
3313
    reference operator[](size_type idx)
N
cleanup  
Niels 已提交
3314
    {
N
Niels 已提交
3315
        // implicitly convert null value to an empty array
N
cleanup  
Niels 已提交
3316
        if (is_null())
N
Niels 已提交
3317 3318
        {
            m_type = value_t::array;
3319
            m_value.array = create<array_t>();
3320
            assert_invariant();
N
Niels 已提交
3321 3322
        }

N
Niels 已提交
3323
        // operator[] only works for arrays
N
cleanup  
Niels 已提交
3324
        if (is_array())
N
cleanup  
Niels 已提交
3325
        {
N
Niels 已提交
3326 3327
            // fill up array with null values if given idx is outside range
            if (idx >= m_value.array->size())
N
cleanup  
Niels 已提交
3328
            {
N
Niels 已提交
3329 3330 3331
                m_value.array->insert(m_value.array->end(),
                                      idx - m_value.array->size() + 1,
                                      basic_json());
N
cleanup  
Niels 已提交
3332
            }
N
cleanup  
Niels 已提交
3333

N
cleanup  
Niels 已提交
3334 3335 3336
            return m_value.array->operator[](idx);
        }
        else
N
Niels 已提交
3337
        {
N
cleanup  
Niels 已提交
3338
            throw std::domain_error("cannot use operator[] with " + type_name());
N
Niels 已提交
3339
        }
N
cleanup  
Niels 已提交
3340 3341
    }

N
Niels 已提交
3342 3343 3344 3345 3346 3347 3348 3349 3350
    /*!
    @brief access specified array element

    Returns a const reference to the element at specified location @a idx.

    @param[in] idx  index of the element to access

    @return const reference to the element at index @a idx

N
Niels 已提交
3351 3352
    @throw std::domain_error if JSON is not an array; example: `"cannot use
    operator[] with null"`
N
Niels 已提交
3353 3354 3355 3356

    @complexity Constant.

    @liveexample{The example below shows how array elements can be read using
N
Niels 已提交
3357
    the `[]` operator.,operatorarray__size_type_const}
N
Niels 已提交
3358

N
Niels 已提交
3359
    @since version 1.0.0
N
Niels 已提交
3360
    */
3361
    const_reference operator[](size_type idx) const
N
cleanup  
Niels 已提交
3362
    {
N
Niels 已提交
3363
        // const operator[] only works for arrays
N
Niels 已提交
3364 3365 3366 3367 3368 3369 3370 3371
        if (is_array())
        {
            return m_value.array->operator[](idx);
        }
        else
        {
            throw std::domain_error("cannot use operator[] with " + type_name());
        }
N
cleanup  
Niels 已提交
3372 3373
    }

N
Niels 已提交
3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386
    /*!
    @brief access specified object element

    Returns a reference to the element at with specified key @a key.

    @note If @a key is not found in the object, then it is silently added to
    the object and filled with a `null` value to make `key` a valid reference.
    In case the value was `null` before, it is converted to an object.

    @param[in] key  key of the element to access

    @return reference to the element at key @a key

N
Niels 已提交
3387
    @throw std::domain_error if JSON is not an object or null; example:
N
Niels 已提交
3388
    `"cannot use operator[] with string"`
N
Niels 已提交
3389 3390 3391 3392

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3393
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
3394 3395 3396 3397

    @sa @ref at(const typename object_t::key_type&) for access by reference
    with range checking
    @sa @ref value() for access by value with a default value
N
Niels 已提交
3398

N
Niels 已提交
3399
    @since version 1.0.0
N
Niels 已提交
3400
    */
3401
    reference operator[](const typename object_t::key_type& key)
N
cleanup  
Niels 已提交
3402
    {
N
Niels 已提交
3403
        // implicitly convert null value to an empty object
N
cleanup  
Niels 已提交
3404
        if (is_null())
N
Niels 已提交
3405 3406
        {
            m_type = value_t::object;
3407
            m_value.object = create<object_t>();
3408
            assert_invariant();
N
Niels 已提交
3409 3410
        }

N
Niels 已提交
3411
        // operator[] only works for objects
N
Niels 已提交
3412 3413 3414 3415 3416 3417 3418 3419
        if (is_object())
        {
            return m_value.object->operator[](key);
        }
        else
        {
            throw std::domain_error("cannot use operator[] with " + type_name());
        }
N
cleanup  
Niels 已提交
3420 3421
    }

3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434
    /*!
    @brief read-only access specified object element

    Returns a const reference to the element at with specified key @a key. No
    bounds checking is performed.

    @warning If the element with key @a key does not exist, the behavior is
    undefined.

    @param[in] key  key of the element to access

    @return const reference to the element at key @a key

N
Niels 已提交
3435 3436 3437
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

N
Niels 已提交
3438 3439
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    operator[] with null"`
3440 3441 3442 3443

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3444
    the `[]` operator.,operatorarray__key_type_const}
3445 3446 3447 3448 3449

    @sa @ref at(const typename object_t::key_type&) for access by reference
    with range checking
    @sa @ref value() for access by value with a default value

N
Niels 已提交
3450
    @since version 1.0.0
3451 3452 3453
    */
    const_reference operator[](const typename object_t::key_type& key) const
    {
N
Niels 已提交
3454
        // const operator[] only works for objects
N
Niels 已提交
3455 3456 3457 3458 3459 3460 3461 3462 3463
        if (is_object())
        {
            assert(m_value.object->find(key) != m_value.object->end());
            return m_value.object->find(key)->second;
        }
        else
        {
            throw std::domain_error("cannot use operator[] with " + type_name());
        }
3464 3465
    }

N
Niels 已提交
3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478
    /*!
    @brief access specified object element

    Returns a reference to the element at with specified key @a key.

    @note If @a key is not found in the object, then it is silently added to
    the object and filled with a `null` value to make `key` a valid reference.
    In case the value was `null` before, it is converted to an object.

    @param[in] key  key of the element to access

    @return reference to the element at key @a key

N
Niels 已提交
3479
    @throw std::domain_error if JSON is not an object or null; example:
N
Niels 已提交
3480
    `"cannot use operator[] with string"`
N
Niels 已提交
3481 3482 3483 3484

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3485
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
3486 3487 3488 3489

    @sa @ref at(const typename object_t::key_type&) for access by reference
    with range checking
    @sa @ref value() for access by value with a default value
N
Niels 已提交
3490

N
Niels 已提交
3491
    @since version 1.0.0
N
Niels 已提交
3492
    */
N
Niels 已提交
3493
    template<typename T, std::size_t n>
N
Niels 已提交
3494
    reference operator[](T * (&key)[n])
3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519
    {
        return operator[](static_cast<const T>(key));
    }

    /*!
    @brief read-only access specified object element

    Returns a const reference to the element at with specified key @a key. No
    bounds checking is performed.

    @warning If the element with key @a key does not exist, the behavior is
    undefined.

    @note This function is required for compatibility reasons with Clang.

    @param[in] key  key of the element to access

    @return const reference to the element at key @a key

    @throw std::domain_error if JSON is not an object; example: `"cannot use
    operator[] with null"`

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3520
    the `[]` operator.,operatorarray__key_type_const}
3521 3522 3523 3524 3525 3526 3527 3528

    @sa @ref at(const typename object_t::key_type&) for access by reference
    with range checking
    @sa @ref value() for access by value with a default value

    @since version 1.0.0
    */
    template<typename T, std::size_t n>
N
Niels 已提交
3529
    const_reference operator[](T * (&key)[n]) const
3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547
    {
        return operator[](static_cast<const T>(key));
    }

    /*!
    @brief access specified object element

    Returns a reference to the element at with specified key @a key.

    @note If @a key is not found in the object, then it is silently added to
    the object and filled with a `null` value to make `key` a valid reference.
    In case the value was `null` before, it is converted to an object.

    @param[in] key  key of the element to access

    @return reference to the element at key @a key

    @throw std::domain_error if JSON is not an object or null; example:
N
Niels 已提交
3548
    `"cannot use operator[] with string"`
3549 3550 3551 3552

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3553
    written using the `[]` operator.,operatorarray__key_type}
3554 3555 3556 3557 3558

    @sa @ref at(const typename object_t::key_type&) for access by reference
    with range checking
    @sa @ref value() for access by value with a default value

N
Niels 已提交
3559
    @since version 1.1.0
3560 3561 3562
    */
    template<typename T>
    reference operator[](T* key)
N
cleanup  
Niels 已提交
3563
    {
N
Niels 已提交
3564
        // implicitly convert null to object
N
cleanup  
Niels 已提交
3565
        if (is_null())
N
Niels 已提交
3566 3567
        {
            m_type = value_t::object;
N
Niels 已提交
3568
            m_value = value_t::object;
3569
            assert_invariant();
N
Niels 已提交
3570 3571
        }

N
cleanup  
Niels 已提交
3572
        // at only works for objects
N
Niels 已提交
3573 3574 3575 3576 3577 3578 3579 3580
        if (is_object())
        {
            return m_value.object->operator[](key);
        }
        else
        {
            throw std::domain_error("cannot use operator[] with " + type_name());
        }
N
cleanup  
Niels 已提交
3581 3582
    }

3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595
    /*!
    @brief read-only access specified object element

    Returns a const reference to the element at with specified key @a key. No
    bounds checking is performed.

    @warning If the element with key @a key does not exist, the behavior is
    undefined.

    @param[in] key  key of the element to access

    @return const reference to the element at key @a key

N
Niels 已提交
3596 3597 3598
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

N
Niels 已提交
3599 3600
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    operator[] with null"`
3601 3602 3603 3604

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3605
    the `[]` operator.,operatorarray__key_type_const}
3606 3607 3608 3609 3610

    @sa @ref at(const typename object_t::key_type&) for access by reference
    with range checking
    @sa @ref value() for access by value with a default value

N
Niels 已提交
3611
    @since version 1.1.0
3612
    */
3613 3614
    template<typename T>
    const_reference operator[](T* key) const
3615 3616
    {
        // at only works for objects
N
Niels 已提交
3617 3618 3619 3620 3621 3622 3623 3624 3625
        if (is_object())
        {
            assert(m_value.object->find(key) != m_value.object->end());
            return m_value.object->find(key)->second;
        }
        else
        {
            throw std::domain_error("cannot use operator[] with " + type_name());
        }
3626 3627
    }

N
Niels 已提交
3628 3629 3630
    /*!
    @brief access specified object element with default value

N
Niels 已提交
3631 3632
    Returns either a copy of an object's element at the specified key @a key
    or a given default value if no element with key @a key exists.
N
Niels 已提交
3633 3634

    The function is basically equivalent to executing
3635
    @code {.cpp}
N
Niels 已提交
3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660
    try {
        return at(key);
    } catch(std::out_of_range) {
        return default_value;
    }
    @endcode

    @note Unlike @ref at(const typename object_t::key_type&), this function
    does not throw if the given key @a key was not found.

    @note Unlike @ref operator[](const typename object_t::key_type& key), this
    function does not implicitly add an element to the position defined by @a
    key. This function is furthermore also applicable to const objects.

    @param[in] key  key of the element to access
    @param[in] default_value  the value to return if @a key is not found

    @tparam ValueType type compatible to JSON values, for instance `int` for
    JSON integer numbers, `bool` for JSON booleans, or `std::vector` types for
    JSON arrays. Note the type of the expected value at @a key and the default
    value @a default_value must be compatible.

    @return copy of the element at key @a key or @a default_value if @a key
    is not found

N
Niels 已提交
3661 3662
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    value() with null"`
N
Niels 已提交
3663 3664 3665 3666 3667 3668 3669 3670 3671 3672

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be queried
    with a default value.,basic_json__value}

    @sa @ref at(const typename object_t::key_type&) for access by reference
    with range checking
    @sa @ref operator[](const typename object_t::key_type&) for unchecked
    access by reference
N
Niels 已提交
3673

N
Niels 已提交
3674
    @since version 1.0.0
N
Niels 已提交
3675
    */
N
Niels 已提交
3676 3677
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700
    ValueType value(const typename object_t::key_type& key, ValueType default_value) const
    {
        // at only works for objects
        if (is_object())
        {
            // if key is found, return value and given default value otherwise
            const auto it = find(key);
            if (it != end())
            {
                return *it;
            }
            else
            {
                return default_value;
            }
        }
        else
        {
            throw std::domain_error("cannot use value() with " + type_name());
        }
    }

    /*!
N
Niels 已提交
3701
    @brief overload for a default value of type const char*
N
Niels 已提交
3702
    @copydoc basic_json::value(const typename object_t::key_type&, ValueType) const
N
Niels 已提交
3703 3704 3705 3706 3707 3708
    */
    string_t value(const typename object_t::key_type& key, const char* default_value) const
    {
        return value(key, string_t(default_value));
    }

N
Niels 已提交
3709 3710 3711
    /*!
    @brief access specified object element via JSON Pointer with default value

N
Niels 已提交
3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726
    Returns either a copy of an object's element at the specified key @a key
    or a given default value if no element with key @a key exists.

    The function is basically equivalent to executing
    @code {.cpp}
    try {
        return at(ptr);
    } catch(std::out_of_range) {
        return default_value;
    }
    @endcode

    @note Unlike @ref at(const json_pointer&), this function does not throw
    if the given key @a key was not found.

N
Niels 已提交
3727 3728 3729 3730 3731 3732 3733 3734
    @param[in] ptr  a JSON pointer to the element to access
    @param[in] default_value  the value to return if @a ptr found no value

    @tparam ValueType type compatible to JSON values, for instance `int` for
    JSON integer numbers, `bool` for JSON booleans, or `std::vector` types for
    JSON arrays. Note the type of the expected value at @a key and the default
    value @a default_value must be compatible.

N
Niels 已提交
3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745
    @return copy of the element at key @a key or @a default_value if @a key
    is not found

    @throw std::domain_error if JSON is not an object; example: `"cannot use
    value() with null"`

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be queried
    with a default value.,basic_json__value_ptr}

N
Niels 已提交
3746
    @sa @ref operator[](const json_pointer&) for unchecked access by reference
N
Niels 已提交
3747

N
Niels 已提交
3748 3749
    @since version 2.0.2
    */
N
Niels 已提交
3750 3751
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774
    ValueType value(const json_pointer& ptr, ValueType default_value) const
    {
        // at only works for objects
        if (is_object())
        {
            // if pointer resolves a value, return it or use default value
            try
            {
                return ptr.get_checked(this);
            }
            catch (std::out_of_range&)
            {
                return default_value;
            }
        }
        else
        {
            throw std::domain_error("cannot use value() with " + type_name());
        }
    }

    /*!
    @brief overload for a default value of type const char*
N
Niels 已提交
3775
    @copydoc basic_json::value(const json_pointer&, ValueType) const
N
Niels 已提交
3776 3777 3778 3779 3780 3781
    */
    string_t value(const json_pointer& ptr, const char* default_value) const
    {
        return value(ptr, string_t(default_value));
    }

N
Niels 已提交
3782 3783 3784 3785 3786 3787
    /*!
    @brief access the first element

    Returns a reference to the first element in the container. For a JSON
    container `c`, the expression `c.front()` is equivalent to `*c.begin()`.

N
Niels 已提交
3788
    @return In case of a structured type (array or object), a reference to the
N
Niels 已提交
3789 3790 3791 3792 3793
    first element is returned. In cast of number, string, or boolean values, a
    reference to the value is returned.

    @complexity Constant.

N
Niels 已提交
3794
    @pre The JSON value must not be `null` (would throw `std::out_of_range`)
N
Niels 已提交
3795 3796
    or an empty array or object (undefined behavior, **guarded by
    assertions**).
N
Niels 已提交
3797 3798 3799
    @post The JSON value remains unchanged.

    @throw std::out_of_range when called on `null` value
N
Niels 已提交
3800

N
Niels 已提交
3801
    @liveexample{The following code shows an example for `front()`.,front}
N
Niels 已提交
3802

N
Niels 已提交
3803
    @sa @ref back() -- access the last element
N
Niels 已提交
3804

N
Niels 已提交
3805
    @since version 1.0.0
N
Niels 已提交
3806
    */
3807
    reference front()
N
Niels 已提交
3808 3809 3810 3811
    {
        return *begin();
    }

N
Niels 已提交
3812 3813 3814
    /*!
    @copydoc basic_json::front()
    */
3815
    const_reference front() const
N
Niels 已提交
3816 3817 3818 3819
    {
        return *cbegin();
    }

N
Niels 已提交
3820 3821 3822 3823
    /*!
    @brief access the last element

    Returns a reference to the last element in the container. For a JSON
N
Niels 已提交
3824 3825 3826 3827 3828 3829
    container `c`, the expression `c.back()` is equivalent to
    @code {.cpp}
    auto tmp = c.end();
    --tmp;
    return *tmp;
    @endcode
N
Niels 已提交
3830

N
Niels 已提交
3831
    @return In case of a structured type (array or object), a reference to the
N
Niels 已提交
3832 3833 3834 3835 3836
    last element is returned. In cast of number, string, or boolean values, a
    reference to the value is returned.

    @complexity Constant.

N
Niels 已提交
3837
    @pre The JSON value must not be `null` (would throw `std::out_of_range`)
N
Niels 已提交
3838 3839
    or an empty array or object (undefined behavior, **guarded by
    assertions**).
N
Niels 已提交
3840
    @post The JSON value remains unchanged.
N
Niels 已提交
3841

N
Niels 已提交
3842
    @throw std::out_of_range when called on `null` value.
N
Niels 已提交
3843

N
Niels 已提交
3844 3845 3846
    @liveexample{The following code shows an example for `back()`.,back}

    @sa @ref front() -- access the first element
N
Niels 已提交
3847

N
Niels 已提交
3848
    @since version 1.0.0
N
Niels 已提交
3849
    */
3850
    reference back()
N
Niels 已提交
3851 3852 3853 3854 3855 3856
    {
        auto tmp = end();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
3857 3858 3859
    /*!
    @copydoc basic_json::back()
    */
3860
    const_reference back() const
N
Niels 已提交
3861 3862 3863 3864 3865 3866
    {
        auto tmp = cend();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
3867 3868 3869
    /*!
    @brief remove element given an iterator

N
Niels 已提交
3870 3871 3872
    Removes the element specified by iterator @a pos. The iterator @a pos must
    be valid and dereferenceable. Thus the `end()` iterator (which is valid,
    but is not dereferenceable) cannot be used as a value for @a pos.
N
Niels 已提交
3873

N
Niels 已提交
3874
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
3875 3876 3877
    will be `null`.

    @param[in] pos iterator to the element to remove
N
Niels 已提交
3878 3879
    @return Iterator following the last removed element. If the iterator @a
    pos refers to the last element, the `end()` iterator is returned.
N
Niels 已提交
3880

3881
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
3882

N
Niels 已提交
3883 3884 3885
    @post Invalidates iterators and references at or after the point of the
    erase, including the `end()` iterator.

N
Niels 已提交
3886 3887
    @throw std::domain_error if called on a `null` value; example: `"cannot
    use erase() with null"`
N
Niels 已提交
3888
    @throw std::domain_error if called on an iterator which does not belong to
N
Niels 已提交
3889
    the current JSON value; example: `"iterator does not fit current value"`
N
Niels 已提交
3890
    @throw std::out_of_range if called on a primitive type with invalid
N
Niels 已提交
3891 3892
    iterator (i.e., any iterator which is not `begin()`); example: `"iterator
    out of range"`
N
Niels 已提交
3893 3894 3895 3896 3897 3898 3899

    @complexity The complexity depends on the type:
    - objects: amortized constant
    - arrays: linear in distance between pos and the end of the container
    - strings: linear in the length of the string
    - other types: constant

N
Niels 已提交
3900
    @liveexample{The example shows the result of `erase()` for different JSON
N
Niels 已提交
3901
    types.,erase__IteratorType}
N
Niels 已提交
3902

3903
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
3904
    the given range
N
Niels 已提交
3905
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
3906
    from an object at the given key
N
Niels 已提交
3907 3908
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
3909

N
Niels 已提交
3910
    @since version 1.0.0
N
Niels 已提交
3911
    */
N
Niels 已提交
3912 3913 3914 3915
    template<class IteratorType, typename std::enable_if<
                 std::is_same<IteratorType, typename basic_json_t::iterator>::value or
                 std::is_same<IteratorType, typename basic_json_t::const_iterator>::value, int>::type
             = 0>
3916
    IteratorType erase(IteratorType pos)
3917 3918
    {
        // make sure iterator fits the current value
N
Niels 已提交
3919
        if (this != pos.m_object)
3920
        {
N
Niels 已提交
3921
            throw std::domain_error("iterator does not fit current value");
3922 3923
        }

3924
        IteratorType result = end();
3925 3926 3927 3928

        switch (m_type)
        {
            case value_t::boolean:
3929 3930
            case value_t::number_float:
            case value_t::number_integer:
3931
            case value_t::number_unsigned:
3932 3933
            case value_t::string:
            {
3934
                if (not pos.m_it.primitive_iterator.is_begin())
3935 3936 3937 3938
                {
                    throw std::out_of_range("iterator out of range");
                }

N
cleanup  
Niels 已提交
3939
                if (is_string())
3940
                {
3941 3942 3943
                    AllocatorType<string_t> alloc;
                    alloc.destroy(m_value.string);
                    alloc.deallocate(m_value.string, 1);
3944 3945 3946 3947
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
3948
                assert_invariant();
3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965
                break;
            }

            case value_t::object:
            {
                result.m_it.object_iterator = m_value.object->erase(pos.m_it.object_iterator);
                break;
            }

            case value_t::array:
            {
                result.m_it.array_iterator = m_value.array->erase(pos.m_it.array_iterator);
                break;
            }

            default:
            {
N
Niels 已提交
3966
                throw std::domain_error("cannot use erase() with " + type_name());
3967 3968 3969 3970 3971 3972
            }
        }

        return result;
    }

N
Niels 已提交
3973 3974 3975
    /*!
    @brief remove elements given an iterator range

N
Niels 已提交
3976 3977 3978
    Removes the element specified by the range `[first; last)`. The iterator
    @a first does not need to be dereferenceable if `first == last`: erasing
    an empty range is a no-op.
N
Niels 已提交
3979

N
Niels 已提交
3980
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
3981 3982 3983 3984 3985
    will be `null`.

    @param[in] first iterator to the beginning of the range to remove
    @param[in] last iterator past the end of the range to remove
    @return Iterator following the last removed element. If the iterator @a
N
Niels 已提交
3986
    second refers to the last element, the `end()` iterator is returned.
N
Niels 已提交
3987

3988
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
3989

N
Niels 已提交
3990 3991 3992
    @post Invalidates iterators and references at or after the point of the
    erase, including the `end()` iterator.

N
Niels 已提交
3993 3994
    @throw std::domain_error if called on a `null` value; example: `"cannot
    use erase() with null"`
N
Niels 已提交
3995
    @throw std::domain_error if called on iterators which does not belong to
N
Niels 已提交
3996
    the current JSON value; example: `"iterators do not fit current value"`
N
Niels 已提交
3997
    @throw std::out_of_range if called on a primitive type with invalid
N
Niels 已提交
3998 3999
    iterators (i.e., if `first != begin()` and `last != end()`); example:
    `"iterators out of range"`
N
Niels 已提交
4000 4001 4002 4003 4004 4005 4006 4007

    @complexity The complexity depends on the type:
    - objects: `log(size()) + std::distance(first, last)`
    - arrays: linear in the distance between @a first and @a last, plus linear
      in the distance between @a last and end of the container
    - strings: linear in the length of the string
    - other types: constant

N
Niels 已提交
4008
    @liveexample{The example shows the result of `erase()` for different JSON
N
Niels 已提交
4009
    types.,erase__IteratorType_IteratorType}
N
Niels 已提交
4010

4011
    @sa @ref erase(IteratorType) -- removes the element at a given position
N
Niels 已提交
4012
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4013
    from an object at the given key
N
Niels 已提交
4014 4015
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4016

N
Niels 已提交
4017
    @since version 1.0.0
N
Niels 已提交
4018
    */
N
Niels 已提交
4019 4020 4021 4022
    template<class IteratorType, typename std::enable_if<
                 std::is_same<IteratorType, typename basic_json_t::iterator>::value or
                 std::is_same<IteratorType, typename basic_json_t::const_iterator>::value, int>::type
             = 0>
4023
    IteratorType erase(IteratorType first, IteratorType last)
4024 4025
    {
        // make sure iterator fits the current value
N
Niels 已提交
4026
        if (this != first.m_object or this != last.m_object)
4027
        {
N
Niels 已提交
4028
            throw std::domain_error("iterators do not fit current value");
4029 4030
        }

4031
        IteratorType result = end();
4032 4033 4034 4035

        switch (m_type)
        {
            case value_t::boolean:
4036 4037
            case value_t::number_float:
            case value_t::number_integer:
4038
            case value_t::number_unsigned:
4039 4040
            case value_t::string:
            {
4041
                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
4042 4043 4044 4045
                {
                    throw std::out_of_range("iterators out of range");
                }

N
cleanup  
Niels 已提交
4046
                if (is_string())
4047
                {
4048 4049 4050
                    AllocatorType<string_t> alloc;
                    alloc.destroy(m_value.string);
                    alloc.deallocate(m_value.string, 1);
4051 4052 4053 4054
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
4055
                assert_invariant();
4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074
                break;
            }

            case value_t::object:
            {
                result.m_it.object_iterator = m_value.object->erase(first.m_it.object_iterator,
                                              last.m_it.object_iterator);
                break;
            }

            case value_t::array:
            {
                result.m_it.array_iterator = m_value.array->erase(first.m_it.array_iterator,
                                             last.m_it.array_iterator);
                break;
            }

            default:
            {
N
Niels 已提交
4075
                throw std::domain_error("cannot use erase() with " + type_name());
4076 4077 4078 4079 4080 4081
            }
        }

        return result;
    }

N
Niels 已提交
4082 4083 4084 4085 4086 4087 4088
    /*!
    @brief remove element from a JSON object given a key

    Removes elements from a JSON object with the key value @a key.

    @param[in] key value of the elements to remove

N
Niels 已提交
4089
    @return Number of elements removed. If @a ObjectType is the default
N
Niels 已提交
4090 4091
    `std::map` type, the return value will always be `0` (@a key was not
    found) or `1` (@a key was found).
N
Niels 已提交
4092 4093 4094

    @post References and iterators to the erased elements are invalidated.
    Other references and iterators are not affected.
N
Niels 已提交
4095

N
Niels 已提交
4096 4097
    @throw std::domain_error when called on a type other than JSON object;
    example: `"cannot use erase() with null"`
N
Niels 已提交
4098 4099 4100

    @complexity `log(size()) + count(key)`

N
Niels 已提交
4101
    @liveexample{The example shows the effect of `erase()`.,erase__key_type}
N
Niels 已提交
4102

4103 4104
    @sa @ref erase(IteratorType) -- removes the element at a given position
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4105 4106 4107
    the given range
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4108

N
Niels 已提交
4109
    @since version 1.0.0
N
Niels 已提交
4110
    */
4111
    size_type erase(const typename object_t::key_type& key)
4112
    {
N
Niels 已提交
4113
        // this erase only works for objects
N
Niels 已提交
4114 4115 4116 4117 4118 4119 4120 4121
        if (is_object())
        {
            return m_value.object->erase(key);
        }
        else
        {
            throw std::domain_error("cannot use erase() with " + type_name());
        }
4122 4123
    }

N
Niels 已提交
4124 4125 4126 4127 4128 4129 4130
    /*!
    @brief remove element from a JSON array given an index

    Removes element from a JSON array at the index @a idx.

    @param[in] idx index of the element to remove

N
Niels 已提交
4131 4132
    @throw std::domain_error when called on a type other than JSON array;
    example: `"cannot use erase() with null"`
N
Niels 已提交
4133 4134
    @throw std::out_of_range when `idx >= size()`; example: `"array index 17
    is out of range"`
N
Niels 已提交
4135 4136 4137

    @complexity Linear in distance between @a idx and the end of the container.

N
Niels 已提交
4138
    @liveexample{The example shows the effect of `erase()`.,erase__size_type}
N
Niels 已提交
4139

4140 4141
    @sa @ref erase(IteratorType) -- removes the element at a given position
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4142
    the given range
N
Niels 已提交
4143
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4144 4145
    from an object at the given key

N
Niels 已提交
4146
    @since version 1.0.0
N
Niels 已提交
4147
    */
4148
    void erase(const size_type idx)
N
Niels 已提交
4149 4150
    {
        // this erase only works for arrays
N
cleanup  
Niels 已提交
4151
        if (is_array())
N
Niels 已提交
4152
        {
N
cleanup  
Niels 已提交
4153 4154
            if (idx >= size())
            {
N
Niels 已提交
4155
                throw std::out_of_range("array index " + std::to_string(idx) + " is out of range");
N
cleanup  
Niels 已提交
4156
            }
N
Niels 已提交
4157

N
cleanup  
Niels 已提交
4158 4159 4160
            m_value.array->erase(m_value.array->begin() + static_cast<difference_type>(idx));
        }
        else
N
Niels 已提交
4161
        {
N
cleanup  
Niels 已提交
4162
            throw std::domain_error("cannot use erase() with " + type_name());
N
Niels 已提交
4163 4164 4165
        }
    }

N
Niels 已提交
4166 4167 4168 4169 4170 4171 4172 4173 4174 4175
    /// @}


    ////////////
    // lookup //
    ////////////

    /// @name lookup
    /// @{

N
Niels 已提交
4176 4177 4178 4179
    /*!
    @brief find an element in a JSON object

    Finds an element in a JSON object with key equivalent to @a key. If the
N
Niels 已提交
4180 4181
    element is not found or the JSON value is not an object, end() is
    returned.
N
Niels 已提交
4182 4183 4184 4185 4186 4187 4188 4189

    @param[in] key key value of the element to search for

    @return Iterator to an element with key equivalent to @a key. If no such
    element is found, past-the-end (see end()) iterator is returned.

    @complexity Logarithmic in the size of the JSON object.

N
Niels 已提交
4190
    @liveexample{The example shows how `find()` is used.,find__key_type}
N
Niels 已提交
4191

N
Niels 已提交
4192
    @since version 1.0.0
N
Niels 已提交
4193
    */
4194
    iterator find(typename object_t::key_type key)
N
Niels 已提交
4195 4196 4197
    {
        auto result = end();

N
cleanup  
Niels 已提交
4198
        if (is_object())
N
Niels 已提交
4199 4200 4201 4202 4203 4204 4205
        {
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4206 4207 4208 4209
    /*!
    @brief find an element in a JSON object
    @copydoc find(typename object_t::key_type)
    */
4210
    const_iterator find(typename object_t::key_type key) const
N
Niels 已提交
4211 4212 4213
    {
        auto result = cend();

N
cleanup  
Niels 已提交
4214
        if (is_object())
N
Niels 已提交
4215 4216 4217 4218 4219 4220 4221
        {
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235
    /*!
    @brief returns the number of occurrences of a key in a JSON object

    Returns the number of elements with key @a key. If ObjectType is the
    default `std::map` type, the return value will always be `0` (@a key was
    not found) or `1` (@a key was found).

    @param[in] key key value of the element to count

    @return Number of elements with key @a key. If the JSON value is not an
    object, the return value will be `0`.

    @complexity Logarithmic in the size of the JSON object.

N
Niels 已提交
4236
    @liveexample{The example shows how `count()` is used.,count}
N
Niels 已提交
4237

N
Niels 已提交
4238
    @since version 1.0.0
N
Niels 已提交
4239
    */
4240
    size_type count(typename object_t::key_type key) const
4241 4242
    {
        // return 0 for all nonobject types
N
Niels 已提交
4243
        return is_object() ? m_value.object->count(key) : 0;
4244 4245
    }

N
Niels 已提交
4246 4247
    /// @}

N
Niels 已提交
4248

N
cleanup  
Niels 已提交
4249 4250 4251 4252
    ///////////////
    // iterators //
    ///////////////

N
Niels 已提交
4253 4254 4255
    /// @name iterators
    /// @{

N
Niels 已提交
4256 4257
    /*!
    @brief returns an iterator to the first element
N
Niels 已提交
4258 4259 4260 4261 4262 4263 4264 4265 4266

    Returns an iterator to the first element.

    @image html range-begin-end.svg "Illustration from cppreference.com"

    @return iterator to the first element

    @complexity Constant.

N
Niels 已提交
4267 4268 4269
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
4270 4271
    - The complexity is constant.

N
Niels 已提交
4272 4273 4274 4275 4276
    @liveexample{The following code shows an example for `begin()`.,begin}

    @sa @ref cbegin() -- returns a const iterator to the beginning
    @sa @ref end() -- returns an iterator to the end
    @sa @ref cend() -- returns a const iterator to the end
N
Niels 已提交
4277

N
Niels 已提交
4278
    @since version 1.0.0
N
Niels 已提交
4279
    */
N
Niels 已提交
4280
    iterator begin() noexcept
N
cleanup  
Niels 已提交
4281 4282 4283 4284 4285 4286
    {
        iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4287
    /*!
N
Niels 已提交
4288
    @copydoc basic_json::cbegin()
N
Niels 已提交
4289
    */
N
Niels 已提交
4290
    const_iterator begin() const noexcept
N
cleanup  
Niels 已提交
4291
    {
N
Niels 已提交
4292
        return cbegin();
N
cleanup  
Niels 已提交
4293 4294
    }

N
Niels 已提交
4295 4296
    /*!
    @brief returns a const iterator to the first element
N
Niels 已提交
4297 4298 4299 4300 4301 4302 4303 4304 4305

    Returns a const iterator to the first element.

    @image html range-begin-end.svg "Illustration from cppreference.com"

    @return const iterator to the first element

    @complexity Constant.

N
Niels 已提交
4306 4307 4308
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
4309 4310 4311
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).begin()`.

N
Niels 已提交
4312 4313 4314 4315 4316
    @liveexample{The following code shows an example for `cbegin()`.,cbegin}

    @sa @ref begin() -- returns an iterator to the beginning
    @sa @ref end() -- returns an iterator to the end
    @sa @ref cend() -- returns a const iterator to the end
N
Niels 已提交
4317

N
Niels 已提交
4318
    @since version 1.0.0
N
Niels 已提交
4319
    */
N
Niels 已提交
4320
    const_iterator cbegin() const noexcept
N
cleanup  
Niels 已提交
4321 4322 4323 4324 4325 4326
    {
        const_iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4327 4328
    /*!
    @brief returns an iterator to one past the last element
N
Niels 已提交
4329 4330 4331 4332 4333 4334 4335 4336 4337

    Returns an iterator to one past the last element.

    @image html range-begin-end.svg "Illustration from cppreference.com"

    @return iterator one past the last element

    @complexity Constant.

N
Niels 已提交
4338 4339 4340
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
4341 4342
    - The complexity is constant.

N
Niels 已提交
4343 4344 4345 4346 4347
    @liveexample{The following code shows an example for `end()`.,end}

    @sa @ref cend() -- returns a const iterator to the end
    @sa @ref begin() -- returns an iterator to the beginning
    @sa @ref cbegin() -- returns a const iterator to the beginning
N
Niels 已提交
4348

N
Niels 已提交
4349
    @since version 1.0.0
N
Niels 已提交
4350
    */
N
Niels 已提交
4351
    iterator end() noexcept
N
cleanup  
Niels 已提交
4352 4353 4354 4355 4356 4357
    {
        iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
4358
    /*!
N
Niels 已提交
4359
    @copydoc basic_json::cend()
N
Niels 已提交
4360
    */
N
Niels 已提交
4361
    const_iterator end() const noexcept
N
cleanup  
Niels 已提交
4362
    {
N
Niels 已提交
4363
        return cend();
N
cleanup  
Niels 已提交
4364 4365
    }

N
Niels 已提交
4366 4367
    /*!
    @brief returns a const iterator to one past the last element
N
Niels 已提交
4368 4369 4370 4371 4372 4373 4374 4375 4376

    Returns a const iterator to one past the last element.

    @image html range-begin-end.svg "Illustration from cppreference.com"

    @return const iterator one past the last element

    @complexity Constant.

N
Niels 已提交
4377 4378 4379
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
4380 4381 4382
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).end()`.

N
Niels 已提交
4383 4384 4385 4386 4387
    @liveexample{The following code shows an example for `cend()`.,cend}

    @sa @ref end() -- returns an iterator to the end
    @sa @ref begin() -- returns an iterator to the beginning
    @sa @ref cbegin() -- returns a const iterator to the beginning
N
Niels 已提交
4388

N
Niels 已提交
4389
    @since version 1.0.0
N
Niels 已提交
4390
    */
N
Niels 已提交
4391
    const_iterator cend() const noexcept
N
cleanup  
Niels 已提交
4392 4393 4394 4395 4396 4397
    {
        const_iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
4398
    /*!
N
Niels 已提交
4399 4400 4401 4402 4403 4404 4405 4406
    @brief returns an iterator to the reverse-beginning

    Returns an iterator to the reverse-beginning; that is, the last element.

    @image html range-rbegin-rend.svg "Illustration from cppreference.com"

    @complexity Constant.

N
Niels 已提交
4407 4408 4409
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4410 4411 4412
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(end())`.

N
Niels 已提交
4413 4414 4415 4416 4417
    @liveexample{The following code shows an example for `rbegin()`.,rbegin}

    @sa @ref crbegin() -- returns a const reverse iterator to the beginning
    @sa @ref rend() -- returns a reverse iterator to the end
    @sa @ref crend() -- returns a const reverse iterator to the end
N
Niels 已提交
4418

N
Niels 已提交
4419
    @since version 1.0.0
N
Niels 已提交
4420
    */
N
Niels 已提交
4421
    reverse_iterator rbegin() noexcept
N
Niels 已提交
4422 4423 4424 4425
    {
        return reverse_iterator(end());
    }

N
Niels 已提交
4426
    /*!
N
Niels 已提交
4427
    @copydoc basic_json::crbegin()
N
Niels 已提交
4428
    */
N
Niels 已提交
4429
    const_reverse_iterator rbegin() const noexcept
N
Niels 已提交
4430
    {
N
Niels 已提交
4431
        return crbegin();
N
Niels 已提交
4432 4433
    }

N
Niels 已提交
4434
    /*!
N
Niels 已提交
4435 4436 4437 4438 4439 4440 4441 4442 4443
    @brief returns an iterator to the reverse-end

    Returns an iterator to the reverse-end; that is, one before the first
    element.

    @image html range-rbegin-rend.svg "Illustration from cppreference.com"

    @complexity Constant.

N
Niels 已提交
4444 4445 4446
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4447 4448 4449
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(begin())`.

N
Niels 已提交
4450 4451 4452 4453 4454
    @liveexample{The following code shows an example for `rend()`.,rend}

    @sa @ref crend() -- returns a const reverse iterator to the end
    @sa @ref rbegin() -- returns a reverse iterator to the beginning
    @sa @ref crbegin() -- returns a const reverse iterator to the beginning
N
Niels 已提交
4455

N
Niels 已提交
4456
    @since version 1.0.0
N
Niels 已提交
4457
    */
N
Niels 已提交
4458
    reverse_iterator rend() noexcept
N
Niels 已提交
4459 4460 4461 4462
    {
        return reverse_iterator(begin());
    }

N
Niels 已提交
4463
    /*!
N
Niels 已提交
4464
    @copydoc basic_json::crend()
N
Niels 已提交
4465
    */
N
Niels 已提交
4466
    const_reverse_iterator rend() const noexcept
N
Niels 已提交
4467
    {
N
Niels 已提交
4468
        return crend();
N
Niels 已提交
4469 4470
    }

N
Niels 已提交
4471
    /*!
N
Niels 已提交
4472 4473 4474 4475 4476 4477 4478 4479 4480
    @brief returns a const reverse iterator to the last element

    Returns a const iterator to the reverse-beginning; that is, the last
    element.

    @image html range-rbegin-rend.svg "Illustration from cppreference.com"

    @complexity Constant.

N
Niels 已提交
4481 4482 4483
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4484 4485 4486
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).rbegin()`.

N
Niels 已提交
4487 4488 4489 4490 4491
    @liveexample{The following code shows an example for `crbegin()`.,crbegin}

    @sa @ref rbegin() -- returns a reverse iterator to the beginning
    @sa @ref rend() -- returns a reverse iterator to the end
    @sa @ref crend() -- returns a const reverse iterator to the end
N
Niels 已提交
4492

N
Niels 已提交
4493
    @since version 1.0.0
N
Niels 已提交
4494
    */
N
Niels 已提交
4495
    const_reverse_iterator crbegin() const noexcept
N
Niels 已提交
4496 4497 4498 4499
    {
        return const_reverse_iterator(cend());
    }

N
Niels 已提交
4500
    /*!
N
Niels 已提交
4501 4502 4503 4504 4505 4506 4507 4508 4509
    @brief returns a const reverse iterator to one before the first

    Returns a const reverse iterator to the reverse-end; that is, one before
    the first element.

    @image html range-rbegin-rend.svg "Illustration from cppreference.com"

    @complexity Constant.

N
Niels 已提交
4510 4511 4512
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4513 4514 4515
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).rend()`.

N
Niels 已提交
4516 4517 4518 4519 4520
    @liveexample{The following code shows an example for `crend()`.,crend}

    @sa @ref rend() -- returns a reverse iterator to the end
    @sa @ref rbegin() -- returns a reverse iterator to the beginning
    @sa @ref crbegin() -- returns a const reverse iterator to the beginning
N
Niels 已提交
4521

N
Niels 已提交
4522
    @since version 1.0.0
N
Niels 已提交
4523
    */
N
Niels 已提交
4524
    const_reverse_iterator crend() const noexcept
N
Niels 已提交
4525 4526 4527 4528
    {
        return const_reverse_iterator(cbegin());
    }

N
cleanup  
Niels 已提交
4529 4530 4531 4532 4533 4534 4535 4536
  private:
    // forward declaration
    template<typename IteratorType> class iteration_proxy;

  public:
    /*!
    @brief wrapper to access iterator member functions in range-based for

N
Niels 已提交
4537
    This function allows to access @ref iterator::key() and @ref
N
Niels 已提交
4538 4539 4540
    iterator::value() during range-based for loops. In these loops, a
    reference to the JSON values is returned, so there is no access to the
    underlying iterator.
N
cleanup  
Niels 已提交
4541 4542 4543

    @note The name of this function is not yet final and may change in the
    future.
N
cleanup  
Niels 已提交
4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557
    */
    static iteration_proxy<iterator> iterator_wrapper(reference cont)
    {
        return iteration_proxy<iterator>(cont);
    }

    /*!
    @copydoc iterator_wrapper(reference)
    */
    static iteration_proxy<const_iterator> iterator_wrapper(const_reference cont)
    {
        return iteration_proxy<const_iterator>(cont);
    }

N
Niels 已提交
4558 4559
    /// @}

N
cleanup  
Niels 已提交
4560 4561 4562 4563 4564

    //////////////
    // capacity //
    //////////////

N
Niels 已提交
4565 4566 4567
    /// @name capacity
    /// @{

N
Niels 已提交
4568 4569
    /*!
    @brief checks whether the container is empty
N
Niels 已提交
4570 4571 4572

    Checks if a JSON value has no elements.

N
Niels 已提交
4573
    @return The return value depends on the different types and is
N
Niels 已提交
4574 4575 4576
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
4577 4578 4579 4580 4581 4582
            null        | `true`
            boolean     | `false`
            string      | `false`
            number      | `false`
            object      | result of function `object_t::empty()`
            array       | result of function `array_t::empty()`
N
Niels 已提交
4583

N
Niels 已提交
4584 4585 4586 4587
    @note This function does not return whether a string stored as JSON value
    is empty - it returns whether the JSON container itself is empty which is
    false in the case of a string.

N
Niels 已提交
4588 4589
    @complexity Constant, as long as @ref array_t and @ref object_t satisfy
    the Container concept; that is, their `empty()` functions have constant
N
Niels 已提交
4590
    complexity.
N
Niels 已提交
4591

N
Niels 已提交
4592 4593 4594
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
4595 4596 4597
    - The complexity is constant.
    - Has the semantics of `begin() == end()`.

N
Niels 已提交
4598
    @liveexample{The following code uses `empty()` to check if a JSON
N
Niels 已提交
4599
    object contains any elements.,empty}
N
Niels 已提交
4600

N
Niels 已提交
4601 4602
    @sa @ref size() -- returns the number of elements

N
Niels 已提交
4603
    @since version 1.0.0
N
Niels 已提交
4604
    */
4605
    bool empty() const noexcept
N
cleanup  
Niels 已提交
4606 4607 4608
    {
        switch (m_type)
        {
4609
            case value_t::null:
N
cleanup  
Niels 已提交
4610
            {
N
Niels 已提交
4611
                // null values are empty
N
cleanup  
Niels 已提交
4612 4613
                return true;
            }
N
Niels 已提交
4614

4615
            case value_t::array:
N
cleanup  
Niels 已提交
4616
            {
N
Niels 已提交
4617
                // delegate call to array_t::empty()
N
cleanup  
Niels 已提交
4618 4619
                return m_value.array->empty();
            }
N
Niels 已提交
4620

4621
            case value_t::object:
N
cleanup  
Niels 已提交
4622
            {
N
Niels 已提交
4623
                // delegate call to object_t::empty()
N
cleanup  
Niels 已提交
4624 4625
                return m_value.object->empty();
            }
N
Niels 已提交
4626

N
Niels 已提交
4627 4628 4629 4630 4631 4632
            default:
            {
                // all other types are nonempty
                return false;
            }
        }
N
cleanup  
Niels 已提交
4633 4634
    }

N
Niels 已提交
4635 4636
    /*!
    @brief returns the number of elements
N
Niels 已提交
4637 4638 4639

    Returns the number of elements in a JSON value.

N
Niels 已提交
4640
    @return The return value depends on the different types and is
N
Niels 已提交
4641 4642 4643
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
4644 4645 4646 4647
            null        | `0`
            boolean     | `1`
            string      | `1`
            number      | `1`
N
Niels 已提交
4648 4649 4650
            object      | result of function object_t::size()
            array       | result of function array_t::size()

N
Niels 已提交
4651 4652 4653 4654
    @note This function does not return the length of a string stored as JSON
    value - it returns the number of elements in the JSON value which is 1 in
    the case of a string.

N
Niels 已提交
4655 4656 4657
    @complexity Constant, as long as @ref array_t and @ref object_t satisfy
    the Container concept; that is, their size() functions have constant
    complexity.
N
Niels 已提交
4658

N
Niels 已提交
4659 4660 4661
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
4662 4663 4664
    - The complexity is constant.
    - Has the semantics of `std::distance(begin(), end())`.

N
Niels 已提交
4665
    @liveexample{The following code calls `size()` on the different value
N
Niels 已提交
4666
    types.,size}
N
Niels 已提交
4667

N
Niels 已提交
4668 4669 4670
    @sa @ref empty() -- checks whether the container is empty
    @sa @ref max_size() -- returns the maximal number of elements

N
Niels 已提交
4671
    @since version 1.0.0
N
Niels 已提交
4672
    */
4673
    size_type size() const noexcept
N
cleanup  
Niels 已提交
4674 4675 4676
    {
        switch (m_type)
        {
4677
            case value_t::null:
N
cleanup  
Niels 已提交
4678
            {
N
Niels 已提交
4679
                // null values are empty
N
cleanup  
Niels 已提交
4680 4681
                return 0;
            }
N
Niels 已提交
4682

4683
            case value_t::array:
N
cleanup  
Niels 已提交
4684
            {
N
Niels 已提交
4685
                // delegate call to array_t::size()
N
cleanup  
Niels 已提交
4686 4687
                return m_value.array->size();
            }
N
Niels 已提交
4688

4689
            case value_t::object:
N
cleanup  
Niels 已提交
4690
            {
N
Niels 已提交
4691
                // delegate call to object_t::size()
N
cleanup  
Niels 已提交
4692 4693
                return m_value.object->size();
            }
N
Niels 已提交
4694

N
Niels 已提交
4695 4696 4697 4698 4699 4700
            default:
            {
                // all other types have size 1
                return 1;
            }
        }
N
cleanup  
Niels 已提交
4701 4702
    }

N
Niels 已提交
4703 4704
    /*!
    @brief returns the maximum possible number of elements
N
Niels 已提交
4705 4706 4707 4708 4709

    Returns the maximum number of elements a JSON value is able to hold due to
    system or library implementation limitations, i.e. `std::distance(begin(),
    end())` for the JSON value.

N
Niels 已提交
4710
    @return The return value depends on the different types and is
N
Niels 已提交
4711 4712 4713
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
4714 4715 4716 4717 4718 4719
            null        | `0` (same as `size()`)
            boolean     | `1` (same as `size()`)
            string      | `1` (same as `size()`)
            number      | `1` (same as `size()`)
            object      | result of function `object_t::max_size()`
            array       | result of function `array_t::max_size()`
N
Niels 已提交
4720

N
Niels 已提交
4721 4722
    @complexity Constant, as long as @ref array_t and @ref object_t satisfy
    the Container concept; that is, their `max_size()` functions have constant
N
Niels 已提交
4723
    complexity.
N
Niels 已提交
4724

N
Niels 已提交
4725 4726 4727
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
4728 4729 4730 4731
    - The complexity is constant.
    - Has the semantics of returning `b.size()` where `b` is the largest
      possible JSON value.

N
Niels 已提交
4732
    @liveexample{The following code calls `max_size()` on the different value
N
Niels 已提交
4733
    types. Note the output is implementation specific.,max_size}
N
Niels 已提交
4734

N
Niels 已提交
4735 4736
    @sa @ref size() -- returns the number of elements

N
Niels 已提交
4737
    @since version 1.0.0
N
Niels 已提交
4738
    */
4739
    size_type max_size() const noexcept
N
cleanup  
Niels 已提交
4740 4741 4742
    {
        switch (m_type)
        {
4743
            case value_t::array:
N
cleanup  
Niels 已提交
4744
            {
N
Niels 已提交
4745
                // delegate call to array_t::max_size()
N
cleanup  
Niels 已提交
4746 4747
                return m_value.array->max_size();
            }
N
Niels 已提交
4748

4749
            case value_t::object:
N
cleanup  
Niels 已提交
4750
            {
N
Niels 已提交
4751
                // delegate call to object_t::max_size()
N
cleanup  
Niels 已提交
4752 4753
                return m_value.object->max_size();
            }
N
Niels 已提交
4754

N
Niels 已提交
4755 4756
            default:
            {
4757 4758
                // all other types have max_size() == size()
                return size();
N
Niels 已提交
4759 4760
            }
        }
N
cleanup  
Niels 已提交
4761 4762
    }

N
Niels 已提交
4763 4764
    /// @}

N
cleanup  
Niels 已提交
4765 4766 4767 4768 4769

    ///////////////
    // modifiers //
    ///////////////

N
Niels 已提交
4770 4771 4772
    /// @name modifiers
    /// @{

N
Niels 已提交
4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792
    /*!
    @brief clears the contents

    Clears the content of a JSON value and resets it to the default value as
    if @ref basic_json(value_t) would have been called:

    Value type  | initial value
    ----------- | -------------
    null        | `null`
    boolean     | `false`
    string      | `""`
    number      | `0`
    object      | `{}`
    array       | `[]`

    @note Floating-point numbers are set to `0.0` which will be serialized to
    `0`. The vale type remains @ref number_float_t.

    @complexity Linear in the size of the JSON value.

N
Niels 已提交
4793
    @liveexample{The example below shows the effect of `clear()` to different
N
Niels 已提交
4794
    JSON types.,clear}
N
Niels 已提交
4795

N
Niels 已提交
4796
    @since version 1.0.0
N
Niels 已提交
4797
    */
4798
    void clear() noexcept
N
cleanup  
Niels 已提交
4799 4800 4801
    {
        switch (m_type)
        {
4802
            case value_t::number_integer:
N
cleanup  
Niels 已提交
4803
            {
N
Niels 已提交
4804
                m_value.number_integer = 0;
N
cleanup  
Niels 已提交
4805 4806
                break;
            }
N
Niels 已提交
4807

4808 4809 4810 4811 4812 4813
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = 0;
                break;
            }

4814
            case value_t::number_float:
N
cleanup  
Niels 已提交
4815
            {
N
Niels 已提交
4816
                m_value.number_float = 0.0;
N
cleanup  
Niels 已提交
4817 4818
                break;
            }
N
Niels 已提交
4819

4820
            case value_t::boolean:
N
cleanup  
Niels 已提交
4821
            {
N
Niels 已提交
4822
                m_value.boolean = false;
N
cleanup  
Niels 已提交
4823 4824
                break;
            }
N
Niels 已提交
4825

4826
            case value_t::string:
N
cleanup  
Niels 已提交
4827 4828 4829 4830
            {
                m_value.string->clear();
                break;
            }
N
Niels 已提交
4831

4832
            case value_t::array:
N
cleanup  
Niels 已提交
4833 4834 4835 4836
            {
                m_value.array->clear();
                break;
            }
N
Niels 已提交
4837

4838
            case value_t::object:
N
cleanup  
Niels 已提交
4839 4840 4841 4842
            {
                m_value.object->clear();
                break;
            }
4843 4844 4845 4846 4847

            default:
            {
                break;
            }
N
cleanup  
Niels 已提交
4848 4849 4850
        }
    }

4851 4852 4853
    /*!
    @brief add an object to an array

4854
    Appends the given element @a val to the end of the JSON value. If the
4855
    function is called on a JSON null value, an empty array is created before
4856
    appending @a val.
4857

N
Niels 已提交
4858
    @param[in] val the value to add to the JSON array
4859

N
Niels 已提交
4860 4861
    @throw std::domain_error when called on a type other than JSON array or
    null; example: `"cannot use push_back() with number"`
4862 4863 4864

    @complexity Amortized constant.

N
Niels 已提交
4865 4866 4867
    @liveexample{The example shows how `push_back()` and `+=` can be used to
    add elements to a JSON array. Note how the `null` value was silently
    converted to a JSON array.,push_back}
N
Niels 已提交
4868

N
Niels 已提交
4869
    @since version 1.0.0
4870
    */
4871
    void push_back(basic_json&& val)
N
cleanup  
Niels 已提交
4872 4873
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
4874
        if (not(is_null() or is_array()))
N
cleanup  
Niels 已提交
4875
        {
N
Niels 已提交
4876
            throw std::domain_error("cannot use push_back() with " + type_name());
N
cleanup  
Niels 已提交
4877 4878 4879
        }

        // transform null object into an array
N
cleanup  
Niels 已提交
4880
        if (is_null())
N
cleanup  
Niels 已提交
4881 4882
        {
            m_type = value_t::array;
N
Niels 已提交
4883
            m_value = value_t::array;
4884
            assert_invariant();
N
cleanup  
Niels 已提交
4885 4886 4887
        }

        // add element to array (move semantics)
4888
        m_value.array->push_back(std::move(val));
N
cleanup  
Niels 已提交
4889
        // invalidate object
4890
        val.m_type = value_t::null;
N
cleanup  
Niels 已提交
4891 4892
    }

4893 4894 4895 4896
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
4897
    reference operator+=(basic_json&& val)
N
Niels 已提交
4898
    {
4899
        push_back(std::move(val));
N
Niels 已提交
4900 4901 4902
        return *this;
    }

4903 4904 4905 4906
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
4907
    void push_back(const basic_json& val)
N
cleanup  
Niels 已提交
4908 4909
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
4910
        if (not(is_null() or is_array()))
N
cleanup  
Niels 已提交
4911
        {
N
Niels 已提交
4912
            throw std::domain_error("cannot use push_back() with " + type_name());
N
cleanup  
Niels 已提交
4913 4914 4915
        }

        // transform null object into an array
N
cleanup  
Niels 已提交
4916
        if (is_null())
N
cleanup  
Niels 已提交
4917 4918
        {
            m_type = value_t::array;
N
Niels 已提交
4919
            m_value = value_t::array;
4920
            assert_invariant();
N
cleanup  
Niels 已提交
4921 4922 4923
        }

        // add element to array
4924
        m_value.array->push_back(val);
N
cleanup  
Niels 已提交
4925 4926
    }

4927 4928 4929 4930
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
4931
    reference operator+=(const basic_json& val)
N
cleanup  
Niels 已提交
4932
    {
4933
        push_back(val);
N
cleanup  
Niels 已提交
4934 4935 4936
        return *this;
    }

4937 4938 4939
    /*!
    @brief add an object to an object

4940
    Inserts the given element @a val to the JSON object. If the function is
N
Niels 已提交
4941 4942
    called on a JSON null value, an empty object is created before inserting
    @a val.
4943

4944
    @param[in] val the value to add to the JSON object
4945 4946

    @throw std::domain_error when called on a type other than JSON object or
N
Niels 已提交
4947
    null; example: `"cannot use push_back() with number"`
4948 4949 4950

    @complexity Logarithmic in the size of the container, O(log(`size()`)).

N
Niels 已提交
4951 4952 4953
    @liveexample{The example shows how `push_back()` and `+=` can be used to
    add elements to a JSON object. Note how the `null` value was silently
    converted to a JSON object.,push_back__object_t__value}
N
Niels 已提交
4954

N
Niels 已提交
4955
    @since version 1.0.0
4956
    */
4957
    void push_back(const typename object_t::value_type& val)
N
cleanup  
Niels 已提交
4958 4959
    {
        // push_back only works for null objects or objects
N
cleanup  
Niels 已提交
4960
        if (not(is_null() or is_object()))
N
cleanup  
Niels 已提交
4961
        {
N
Niels 已提交
4962
            throw std::domain_error("cannot use push_back() with " + type_name());
N
cleanup  
Niels 已提交
4963 4964 4965
        }

        // transform null object into an object
N
cleanup  
Niels 已提交
4966
        if (is_null())
N
cleanup  
Niels 已提交
4967 4968
        {
            m_type = value_t::object;
N
Niels 已提交
4969
            m_value = value_t::object;
4970
            assert_invariant();
N
cleanup  
Niels 已提交
4971 4972 4973
        }

        // add element to array
4974
        m_value.object->insert(val);
N
cleanup  
Niels 已提交
4975 4976
    }

4977 4978 4979 4980
    /*!
    @brief add an object to an object
    @copydoc push_back(const typename object_t::value_type&)
    */
4981
    reference operator+=(const typename object_t::value_type& val)
N
cleanup  
Niels 已提交
4982
    {
4983
        push_back(val);
N
Niels 已提交
4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032
        return *this;
    }

    /*!
    @brief add an object to an object

    This function allows to use `push_back` with an initializer list. In case

    1. the current value is an object,
    2. the initializer list @a init contains only two elements, and
    3. the first element of @a init is a string,

    @a init is converted into an object element and added using
    @ref push_back(const typename object_t::value_type&). Otherwise, @a init
    is converted to a JSON value and added using @ref push_back(basic_json&&).

    @param init  an initializer list

    @complexity Linear in the size of the initializer list @a init.

    @note This function is required to resolve an ambiguous overload error,
          because pairs like `{"key", "value"}` can be both interpreted as
          `object_t::value_type` or `std::initializer_list<basic_json>`, see
          https://github.com/nlohmann/json/issues/235 for more information.

    @liveexample{The example shows how initializer lists are treated as
    objects when possible.,push_back__initializer_list}
    */
    void push_back(std::initializer_list<basic_json> init)
    {
        if (is_object() and init.size() == 2 and init.begin()->is_string())
        {
            const string_t key = *init.begin();
            push_back(typename object_t::value_type(key, *(init.begin() + 1)));
        }
        else
        {
            push_back(basic_json(init));
        }
    }

    /*!
    @brief add an object to an object
    @copydoc push_back(std::initializer_list<basic_json>)
    */
    reference operator+=(std::initializer_list<basic_json> init)
    {
        push_back(init);
        return *this;
N
cleanup  
Niels 已提交
5033 5034
    }

N
Niels 已提交
5035 5036 5037
    /*!
    @brief inserts element

5038
    Inserts element @a val before iterator @a pos.
N
Niels 已提交
5039 5040 5041

    @param[in] pos iterator before which the content will be inserted; may be
    the end() iterator
5042 5043
    @param[in] val element to insert
    @return iterator pointing to the inserted @a val.
N
Niels 已提交
5044

N
Niels 已提交
5045 5046
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
N
Niels 已提交
5047 5048
    @throw std::domain_error if @a pos is not an iterator of *this; example:
    `"iterator does not fit current value"`
N
Niels 已提交
5049 5050 5051 5052

    @complexity Constant plus linear in the distance between pos and end of the
    container.

N
Niels 已提交
5053
    @liveexample{The example shows how `insert()` is used.,insert}
N
Niels 已提交
5054

N
Niels 已提交
5055
    @since version 1.0.0
N
Niels 已提交
5056
    */
5057
    iterator insert(const_iterator pos, const basic_json& val)
N
Niels 已提交
5058 5059
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5060
        if (is_array())
N
Niels 已提交
5061
        {
N
cleanup  
Niels 已提交
5062 5063 5064 5065 5066
            // check if iterator pos fits to this JSON value
            if (pos.m_object != this)
            {
                throw std::domain_error("iterator does not fit current value");
            }
N
Niels 已提交
5067

N
cleanup  
Niels 已提交
5068 5069
            // insert to array and return iterator
            iterator result(this);
5070
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, val);
N
cleanup  
Niels 已提交
5071 5072 5073
            return result;
        }
        else
N
Niels 已提交
5074
        {
N
cleanup  
Niels 已提交
5075
            throw std::domain_error("cannot use insert() with " + type_name());
N
Niels 已提交
5076 5077 5078 5079 5080 5081 5082
        }
    }

    /*!
    @brief inserts element
    @copydoc insert(const_iterator, const basic_json&)
    */
5083
    iterator insert(const_iterator pos, basic_json&& val)
N
Niels 已提交
5084
    {
5085
        return insert(pos, val);
N
Niels 已提交
5086 5087 5088 5089 5090
    }

    /*!
    @brief inserts elements

5091
    Inserts @a cnt copies of @a val before iterator @a pos.
N
Niels 已提交
5092 5093 5094

    @param[in] pos iterator before which the content will be inserted; may be
    the end() iterator
5095 5096
    @param[in] cnt number of copies of @a val to insert
    @param[in] val element to insert
N
Niels 已提交
5097
    @return iterator pointing to the first element inserted, or @a pos if
5098
    `cnt==0`
N
Niels 已提交
5099

N
Niels 已提交
5100 5101
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
N
Niels 已提交
5102 5103
    @throw std::domain_error if @a pos is not an iterator of *this; example:
    `"iterator does not fit current value"`
N
Niels 已提交
5104

5105
    @complexity Linear in @a cnt plus linear in the distance between @a pos
N
Niels 已提交
5106 5107
    and end of the container.

N
Niels 已提交
5108
    @liveexample{The example shows how `insert()` is used.,insert__count}
N
Niels 已提交
5109

N
Niels 已提交
5110
    @since version 1.0.0
N
Niels 已提交
5111
    */
5112
    iterator insert(const_iterator pos, size_type cnt, const basic_json& val)
N
Niels 已提交
5113 5114
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5115
        if (is_array())
N
Niels 已提交
5116
        {
N
cleanup  
Niels 已提交
5117 5118 5119 5120 5121
            // check if iterator pos fits to this JSON value
            if (pos.m_object != this)
            {
                throw std::domain_error("iterator does not fit current value");
            }
N
Niels 已提交
5122

N
cleanup  
Niels 已提交
5123 5124
            // insert to array and return iterator
            iterator result(this);
5125
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, cnt, val);
N
cleanup  
Niels 已提交
5126 5127 5128
            return result;
        }
        else
N
Niels 已提交
5129
        {
N
cleanup  
Niels 已提交
5130
            throw std::domain_error("cannot use insert() with " + type_name());
N
Niels 已提交
5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143
        }
    }

    /*!
    @brief inserts elements

    Inserts elements from range `[first, last)` before iterator @a pos.

    @param[in] pos iterator before which the content will be inserted; may be
    the end() iterator
    @param[in] first begin of the range of elements to insert
    @param[in] last end of the range of elements to insert

N
Niels 已提交
5144 5145
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
N
Niels 已提交
5146 5147
    @throw std::domain_error if @a pos is not an iterator of *this; example:
    `"iterator does not fit current value"`
N
Niels 已提交
5148
    @throw std::domain_error if @a first and @a last do not belong to the same
N
Niels 已提交
5149
    JSON value; example: `"iterators do not fit"`
N
Niels 已提交
5150
    @throw std::domain_error if @a first or @a last are iterators into
N
Niels 已提交
5151 5152 5153
    container for which insert is called; example: `"passed iterators may not
    belong to container"`

N
Niels 已提交
5154 5155 5156 5157 5158 5159
    @return iterator pointing to the first element inserted, or @a pos if
    `first==last`

    @complexity Linear in `std::distance(first, last)` plus linear in the
    distance between @a pos and end of the container.

N
Niels 已提交
5160
    @liveexample{The example shows how `insert()` is used.,insert__range}
N
Niels 已提交
5161

N
Niels 已提交
5162
    @since version 1.0.0
N
Niels 已提交
5163 5164 5165 5166
    */
    iterator insert(const_iterator pos, const_iterator first, const_iterator last)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5167
        if (not is_array())
N
Niels 已提交
5168 5169 5170 5171 5172 5173 5174 5175 5176 5177
        {
            throw std::domain_error("cannot use insert() with " + type_name());
        }

        // check if iterator pos fits to this JSON value
        if (pos.m_object != this)
        {
            throw std::domain_error("iterator does not fit current value");
        }

N
Niels 已提交
5178
        // check if range iterators belong to the same JSON object
N
Niels 已提交
5179 5180
        if (first.m_object != last.m_object)
        {
N
Niels 已提交
5181
            throw std::domain_error("iterators do not fit");
N
Niels 已提交
5182 5183 5184 5185 5186 5187 5188 5189 5190
        }

        if (first.m_object == this or last.m_object == this)
        {
            throw std::domain_error("passed iterators may not belong to container");
        }

        // insert to array and return iterator
        iterator result(this);
N
Niels 已提交
5191 5192 5193 5194
        result.m_it.array_iterator = m_value.array->insert(
                                         pos.m_it.array_iterator,
                                         first.m_it.array_iterator,
                                         last.m_it.array_iterator);
N
Niels 已提交
5195 5196 5197
        return result;
    }

N
Niels 已提交
5198 5199 5200 5201 5202 5203 5204 5205 5206
    /*!
    @brief inserts elements

    Inserts elements from initializer list @a ilist before iterator @a pos.

    @param[in] pos iterator before which the content will be inserted; may be
    the end() iterator
    @param[in] ilist initializer list to insert the values from

N
Niels 已提交
5207 5208
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
N
Niels 已提交
5209 5210
    @throw std::domain_error if @a pos is not an iterator of *this; example:
    `"iterator does not fit current value"`
N
Niels 已提交
5211

N
Niels 已提交
5212 5213 5214
    @return iterator pointing to the first element inserted, or @a pos if
    `ilist` is empty

N
Niels 已提交
5215 5216
    @complexity Linear in `ilist.size()` plus linear in the distance between
    @a pos and end of the container.
N
Niels 已提交
5217

N
Niels 已提交
5218
    @liveexample{The example shows how `insert()` is used.,insert__ilist}
N
Niels 已提交
5219

N
Niels 已提交
5220
    @since version 1.0.0
N
Niels 已提交
5221 5222 5223 5224
    */
    iterator insert(const_iterator pos, std::initializer_list<basic_json> ilist)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5225
        if (not is_array())
N
Niels 已提交
5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241
        {
            throw std::domain_error("cannot use insert() with " + type_name());
        }

        // check if iterator pos fits to this JSON value
        if (pos.m_object != this)
        {
            throw std::domain_error("iterator does not fit current value");
        }

        // insert to array and return iterator
        iterator result(this);
        result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, ilist);
        return result;
    }

N
Niels 已提交
5242 5243
    /*!
    @brief exchanges the values
N
Niels 已提交
5244 5245 5246 5247 5248 5249 5250 5251 5252 5253

    Exchanges the contents of the JSON value with those of @a other. Does not
    invoke any move, copy, or swap operations on individual elements. All
    iterators and references remain valid. The past-the-end iterator is
    invalidated.

    @param[in,out] other JSON value to exchange the contents with

    @complexity Constant.

N
Niels 已提交
5254 5255
    @liveexample{The example below shows how JSON values can be swapped with
    `swap()`.,swap__reference}
N
Niels 已提交
5256

N
Niels 已提交
5257
    @since version 1.0.0
N
Niels 已提交
5258
    */
5259
    void swap(reference other) noexcept (
N
Niels 已提交
5260 5261 5262 5263 5264
        std::is_nothrow_move_constructible<value_t>::value and
        std::is_nothrow_move_assignable<value_t>::value and
        std::is_nothrow_move_constructible<json_value>::value and
        std::is_nothrow_move_assignable<json_value>::value
    )
N
cleanup  
Niels 已提交
5265 5266 5267
    {
        std::swap(m_type, other.m_type);
        std::swap(m_value, other.m_value);
5268
        assert_invariant();
N
cleanup  
Niels 已提交
5269 5270
    }

N
Niels 已提交
5271 5272 5273 5274 5275 5276 5277 5278 5279 5280
    /*!
    @brief exchanges the values

    Exchanges the contents of a JSON array with those of @a other. Does not
    invoke any move, copy, or swap operations on individual elements. All
    iterators and references remain valid. The past-the-end iterator is
    invalidated.

    @param[in,out] other array to exchange the contents with

N
Niels 已提交
5281 5282
    @throw std::domain_error when JSON value is not an array; example: `"cannot
    use swap() with string"`
N
Niels 已提交
5283 5284 5285

    @complexity Constant.

N
Niels 已提交
5286 5287
    @liveexample{The example below shows how arrays can be swapped with
    `swap()`.,swap__array_t}
N
Niels 已提交
5288

N
Niels 已提交
5289
    @since version 1.0.0
N
Niels 已提交
5290
    */
5291
    void swap(array_t& other)
N
cleanup  
Niels 已提交
5292 5293
    {
        // swap only works for arrays
N
cleanup  
Niels 已提交
5294 5295 5296 5297 5298
        if (is_array())
        {
            std::swap(*(m_value.array), other);
        }
        else
N
cleanup  
Niels 已提交
5299
        {
N
Niels 已提交
5300
            throw std::domain_error("cannot use swap() with " + type_name());
N
cleanup  
Niels 已提交
5301 5302 5303
        }
    }

5304 5305 5306 5307 5308 5309 5310 5311 5312 5313
    /*!
    @brief exchanges the values

    Exchanges the contents of a JSON object with those of @a other. Does not
    invoke any move, copy, or swap operations on individual elements. All
    iterators and references remain valid. The past-the-end iterator is
    invalidated.

    @param[in,out] other object to exchange the contents with

N
Niels 已提交
5314 5315
    @throw std::domain_error when JSON value is not an object; example:
    `"cannot use swap() with string"`
5316 5317 5318

    @complexity Constant.

N
Niels 已提交
5319 5320
    @liveexample{The example below shows how objects can be swapped with
    `swap()`.,swap__object_t}
N
Niels 已提交
5321

N
Niels 已提交
5322
    @since version 1.0.0
5323
    */
5324
    void swap(object_t& other)
N
cleanup  
Niels 已提交
5325 5326
    {
        // swap only works for objects
N
cleanup  
Niels 已提交
5327 5328 5329 5330 5331
        if (is_object())
        {
            std::swap(*(m_value.object), other);
        }
        else
N
cleanup  
Niels 已提交
5332
        {
N
Niels 已提交
5333
            throw std::domain_error("cannot use swap() with " + type_name());
N
cleanup  
Niels 已提交
5334 5335 5336
        }
    }

5337 5338 5339 5340 5341 5342 5343 5344 5345 5346
    /*!
    @brief exchanges the values

    Exchanges the contents of a JSON string with those of @a other. Does not
    invoke any move, copy, or swap operations on individual elements. All
    iterators and references remain valid. The past-the-end iterator is
    invalidated.

    @param[in,out] other string to exchange the contents with

N
Niels 已提交
5347 5348
    @throw std::domain_error when JSON value is not a string; example: `"cannot
    use swap() with boolean"`
5349 5350 5351

    @complexity Constant.

N
Niels 已提交
5352 5353
    @liveexample{The example below shows how strings can be swapped with
    `swap()`.,swap__string_t}
N
Niels 已提交
5354

N
Niels 已提交
5355
    @since version 1.0.0
5356
    */
5357
    void swap(string_t& other)
N
cleanup  
Niels 已提交
5358 5359
    {
        // swap only works for strings
N
cleanup  
Niels 已提交
5360 5361 5362 5363 5364
        if (is_string())
        {
            std::swap(*(m_value.string), other);
        }
        else
N
cleanup  
Niels 已提交
5365
        {
N
Niels 已提交
5366
            throw std::domain_error("cannot use swap() with " + type_name());
N
cleanup  
Niels 已提交
5367 5368 5369
        }
    }

N
Niels 已提交
5370 5371
    /// @}

N
cleanup  
Niels 已提交
5372 5373 5374 5375 5376

    //////////////////////////////////////////
    // lexicographical comparison operators //
    //////////////////////////////////////////

N
Niels 已提交
5377 5378 5379
    /// @name lexicographical comparison operators
    /// @{

N
Niels 已提交
5380 5381 5382 5383 5384 5385 5386
  private:
    /*!
    @brief comparison operator for JSON types

    Returns an ordering that is similar to Python:
    - order: null < boolean < number < object < array < string
    - furthermore, each type is not smaller than itself
N
Niels 已提交
5387

N
Niels 已提交
5388
    @since version 1.0.0
N
Niels 已提交
5389
    */
N
Niels 已提交
5390
    friend bool operator<(const value_t lhs, const value_t rhs) noexcept
N
Niels 已提交
5391
    {
5392
        static constexpr std::array<uint8_t, 8> order = {{
N
Niels 已提交
5393 5394 5395 5396 5397 5398
                0, // null
                3, // object
                4, // array
                5, // string
                1, // boolean
                2, // integer
5399 5400
                2, // unsigned
                2, // float
N
Niels 已提交
5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413
            }
        };

        // discarded values are not comparable
        if (lhs == value_t::discarded or rhs == value_t::discarded)
        {
            return false;
        }

        return order[static_cast<std::size_t>(lhs)] < order[static_cast<std::size_t>(rhs)];
    }

  public:
N
Niels 已提交
5414 5415
    /*!
    @brief comparison: equal
N
Niels 已提交
5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431

    Compares two JSON values for equality according to the following rules:
    - Two JSON values are equal if (1) they are from the same type and (2)
      their stored values are the same.
    - Integer and floating-point numbers are automatically converted before
      comparison. Floating-point numbers are compared indirectly: two
      floating-point numbers `f1` and `f2` are considered equal if neither
      `f1 > f2` nor `f2 > f1` holds.
    - Two JSON null values are equal.

    @param[in] lhs  first JSON value to consider
    @param[in] rhs  second JSON value to consider
    @return whether the values @a lhs and @a rhs are equal

    @complexity Linear.

5432 5433
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__equal}
N
Niels 已提交
5434

N
Niels 已提交
5435
    @since version 1.0.0
N
Niels 已提交
5436
    */
N
Niels 已提交
5437
    friend bool operator==(const_reference lhs, const_reference rhs) noexcept
N
cleanup  
Niels 已提交
5438
    {
F
Florian Weber 已提交
5439 5440
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
5441

F
Florian Weber 已提交
5442
        if (lhs_type == rhs_type)
N
cleanup  
Niels 已提交
5443
        {
F
Florian Weber 已提交
5444
            switch (lhs_type)
N
cleanup  
Niels 已提交
5445
            {
5446
                case value_t::array:
N
Niels 已提交
5447
                {
N
cleanup  
Niels 已提交
5448
                    return *lhs.m_value.array == *rhs.m_value.array;
N
Niels 已提交
5449
                }
5450
                case value_t::object:
N
Niels 已提交
5451
                {
N
cleanup  
Niels 已提交
5452
                    return *lhs.m_value.object == *rhs.m_value.object;
N
Niels 已提交
5453
                }
5454
                case value_t::null:
N
Niels 已提交
5455
                {
N
cleanup  
Niels 已提交
5456
                    return true;
N
Niels 已提交
5457
                }
5458
                case value_t::string:
N
Niels 已提交
5459
                {
N
cleanup  
Niels 已提交
5460
                    return *lhs.m_value.string == *rhs.m_value.string;
N
Niels 已提交
5461
                }
5462
                case value_t::boolean:
N
Niels 已提交
5463
                {
N
cleanup  
Niels 已提交
5464
                    return lhs.m_value.boolean == rhs.m_value.boolean;
N
Niels 已提交
5465
                }
5466
                case value_t::number_integer:
N
Niels 已提交
5467
                {
N
cleanup  
Niels 已提交
5468
                    return lhs.m_value.number_integer == rhs.m_value.number_integer;
N
Niels 已提交
5469
                }
5470 5471 5472 5473
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned == rhs.m_value.number_unsigned;
                }
5474
                case value_t::number_float:
N
Niels 已提交
5475
                {
5476
                    return lhs.m_value.number_float == rhs.m_value.number_float;
N
Niels 已提交
5477
                }
5478
                default:
N
Niels 已提交
5479
                {
N
Niels 已提交
5480
                    return false;
N
Niels 已提交
5481
                }
N
cleanup  
Niels 已提交
5482 5483
            }
        }
F
Florian Weber 已提交
5484 5485
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
N
Niels 已提交
5486
            return static_cast<number_float_t>(lhs.m_value.number_integer) == rhs.m_value.number_float;
F
Florian Weber 已提交
5487 5488 5489
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
5490
            return lhs.m_value.number_float == static_cast<number_float_t>(rhs.m_value.number_integer);
F
Florian Weber 已提交
5491
        }
5492 5493 5494
        else if (lhs_type == value_t::number_unsigned and rhs_type == value_t::number_float)
        {
            return static_cast<number_float_t>(lhs.m_value.number_unsigned) == rhs.m_value.number_float;
F
Florian Weber 已提交
5495
        }
5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_unsigned)
        {
            return lhs.m_value.number_float == static_cast<number_float_t>(rhs.m_value.number_unsigned);
        }
        else if (lhs_type == value_t::number_unsigned and rhs_type == value_t::number_integer)
        {
            return static_cast<number_integer_t>(lhs.m_value.number_unsigned) == rhs.m_value.number_integer;
        }
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_unsigned)
        {
            return lhs.m_value.number_integer == static_cast<number_integer_t>(rhs.m_value.number_unsigned);
        }

N
cleanup  
Niels 已提交
5509 5510 5511
        return false;
    }

N
Niels 已提交
5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526
    /*!
    @brief comparison: equal

    The functions compares the given JSON value against a null pointer. As the
    null pointer can be used to initialize a JSON value to null, a comparison
    of JSON value @a v with a null pointer should be equivalent to call
    `v.is_null()`.

    @param[in] v  JSON value to consider
    @return whether @a v is null

    @complexity Constant.

    @liveexample{The example compares several JSON types to the null pointer.
    ,operator__equal__nullptr_t}
N
Niels 已提交
5527

N
Niels 已提交
5528
    @since version 1.0.0
N
Niels 已提交
5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543
    */
    friend bool operator==(const_reference v, std::nullptr_t) noexcept
    {
        return v.is_null();
    }

    /*!
    @brief comparison: equal
    @copydoc operator==(const_reference, std::nullptr_t)
    */
    friend bool operator==(std::nullptr_t, const_reference v) noexcept
    {
        return v.is_null();
    }

N
Niels 已提交
5544 5545
    /*!
    @brief comparison: not equal
N
Niels 已提交
5546 5547 5548 5549 5550 5551 5552 5553 5554

    Compares two JSON values for inequality by calculating `not (lhs == rhs)`.

    @param[in] lhs  first JSON value to consider
    @param[in] rhs  second JSON value to consider
    @return whether the values @a lhs and @a rhs are not equal

    @complexity Linear.

5555 5556
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__notequal}
N
Niels 已提交
5557

N
Niels 已提交
5558
    @since version 1.0.0
N
Niels 已提交
5559
    */
N
Niels 已提交
5560
    friend bool operator!=(const_reference lhs, const_reference rhs) noexcept
N
cleanup  
Niels 已提交
5561 5562 5563 5564
    {
        return not (lhs == rhs);
    }

N
Niels 已提交
5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579
    /*!
    @brief comparison: not equal

    The functions compares the given JSON value against a null pointer. As the
    null pointer can be used to initialize a JSON value to null, a comparison
    of JSON value @a v with a null pointer should be equivalent to call
    `not v.is_null()`.

    @param[in] v  JSON value to consider
    @return whether @a v is not null

    @complexity Constant.

    @liveexample{The example compares several JSON types to the null pointer.
    ,operator__notequal__nullptr_t}
N
Niels 已提交
5580

N
Niels 已提交
5581
    @since version 1.0.0
N
Niels 已提交
5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596
    */
    friend bool operator!=(const_reference v, std::nullptr_t) noexcept
    {
        return not v.is_null();
    }

    /*!
    @brief comparison: not equal
    @copydoc operator!=(const_reference, std::nullptr_t)
    */
    friend bool operator!=(std::nullptr_t, const_reference v) noexcept
    {
        return not v.is_null();
    }

N
Niels 已提交
5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615
    /*!
    @brief comparison: less than

    Compares whether one JSON value @a lhs is less than another JSON value @a
    rhs according to the following rules:
    - If @a lhs and @a rhs have the same type, the values are compared using
      the default `<` operator.
    - Integer and floating-point numbers are automatically converted before
      comparison
    - In case @a lhs and @a rhs have different types, the values are ignored
      and the order of the types is considered, see
      @ref operator<(const value_t, const value_t).

    @param[in] lhs  first JSON value to consider
    @param[in] rhs  second JSON value to consider
    @return whether @a lhs is less than @a rhs

    @complexity Linear.

5616 5617
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__less}
N
Niels 已提交
5618

N
Niels 已提交
5619
    @since version 1.0.0
N
Niels 已提交
5620
    */
N
Niels 已提交
5621
    friend bool operator<(const_reference lhs, const_reference rhs) noexcept
N
cleanup  
Niels 已提交
5622
    {
F
Florian Weber 已提交
5623 5624
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
5625

F
Florian Weber 已提交
5626
        if (lhs_type == rhs_type)
N
cleanup  
Niels 已提交
5627
        {
F
Florian Weber 已提交
5628
            switch (lhs_type)
N
cleanup  
Niels 已提交
5629
            {
5630
                case value_t::array:
N
Niels 已提交
5631
                {
N
cleanup  
Niels 已提交
5632
                    return *lhs.m_value.array < *rhs.m_value.array;
N
Niels 已提交
5633
                }
5634
                case value_t::object:
N
Niels 已提交
5635
                {
N
cleanup  
Niels 已提交
5636
                    return *lhs.m_value.object < *rhs.m_value.object;
N
Niels 已提交
5637
                }
5638
                case value_t::null:
N
Niels 已提交
5639
                {
N
cleanup  
Niels 已提交
5640
                    return false;
N
Niels 已提交
5641
                }
5642
                case value_t::string:
N
Niels 已提交
5643
                {
N
cleanup  
Niels 已提交
5644
                    return *lhs.m_value.string < *rhs.m_value.string;
N
Niels 已提交
5645
                }
5646
                case value_t::boolean:
N
Niels 已提交
5647
                {
N
cleanup  
Niels 已提交
5648
                    return lhs.m_value.boolean < rhs.m_value.boolean;
N
Niels 已提交
5649
                }
5650
                case value_t::number_integer:
N
Niels 已提交
5651
                {
N
cleanup  
Niels 已提交
5652
                    return lhs.m_value.number_integer < rhs.m_value.number_integer;
N
Niels 已提交
5653
                }
5654 5655 5656 5657
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned < rhs.m_value.number_unsigned;
                }
5658
                case value_t::number_float:
N
Niels 已提交
5659
                {
N
cleanup  
Niels 已提交
5660
                    return lhs.m_value.number_float < rhs.m_value.number_float;
N
Niels 已提交
5661
                }
5662
                default:
N
Niels 已提交
5663
                {
N
Niels 已提交
5664
                    return false;
N
Niels 已提交
5665
                }
N
cleanup  
Niels 已提交
5666 5667
            }
        }
F
Florian Weber 已提交
5668 5669
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
5670
            return static_cast<number_float_t>(lhs.m_value.number_integer) < rhs.m_value.number_float;
F
Florian Weber 已提交
5671 5672 5673
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690
            return lhs.m_value.number_float < static_cast<number_float_t>(rhs.m_value.number_integer);
        }
        else if (lhs_type == value_t::number_unsigned and rhs_type == value_t::number_float)
        {
            return static_cast<number_float_t>(lhs.m_value.number_unsigned) < rhs.m_value.number_float;
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_unsigned)
        {
            return lhs.m_value.number_float < static_cast<number_float_t>(rhs.m_value.number_unsigned);
        }
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_unsigned)
        {
            return lhs.m_value.number_integer < static_cast<number_integer_t>(rhs.m_value.number_unsigned);
        }
        else if (lhs_type == value_t::number_unsigned and rhs_type == value_t::number_integer)
        {
            return static_cast<number_integer_t>(lhs.m_value.number_unsigned) < rhs.m_value.number_integer;
F
Florian Weber 已提交
5691
        }
N
cleanup  
Niels 已提交
5692

N
Niels 已提交
5693
        // We only reach this line if we cannot compare values. In that case,
N
Niels 已提交
5694 5695 5696
        // we compare types. Note we have to call the operator explicitly,
        // because MSVC has problems otherwise.
        return operator<(lhs_type, rhs_type);
N
cleanup  
Niels 已提交
5697 5698
    }

N
Niels 已提交
5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710
    /*!
    @brief comparison: less than or equal

    Compares whether one JSON value @a lhs is less than or equal to another
    JSON value by calculating `not (rhs < lhs)`.

    @param[in] lhs  first JSON value to consider
    @param[in] rhs  second JSON value to consider
    @return whether @a lhs is less than or equal to @a rhs

    @complexity Linear.

5711 5712
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greater}
N
Niels 已提交
5713

N
Niels 已提交
5714
    @since version 1.0.0
N
Niels 已提交
5715
    */
N
Niels 已提交
5716
    friend bool operator<=(const_reference lhs, const_reference rhs) noexcept
N
cleanup  
Niels 已提交
5717 5718 5719 5720
    {
        return not (rhs < lhs);
    }

N
Niels 已提交
5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732
    /*!
    @brief comparison: greater than

    Compares whether one JSON value @a lhs is greater than another
    JSON value by calculating `not (lhs <= rhs)`.

    @param[in] lhs  first JSON value to consider
    @param[in] rhs  second JSON value to consider
    @return whether @a lhs is greater than to @a rhs

    @complexity Linear.

5733 5734
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__lessequal}
N
Niels 已提交
5735

N
Niels 已提交
5736
    @since version 1.0.0
N
Niels 已提交
5737
    */
N
Niels 已提交
5738
    friend bool operator>(const_reference lhs, const_reference rhs) noexcept
N
cleanup  
Niels 已提交
5739 5740 5741 5742
    {
        return not (lhs <= rhs);
    }

N
Niels 已提交
5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754
    /*!
    @brief comparison: greater than or equal

    Compares whether one JSON value @a lhs is greater than or equal to another
    JSON value by calculating `not (lhs < rhs)`.

    @param[in] lhs  first JSON value to consider
    @param[in] rhs  second JSON value to consider
    @return whether @a lhs is greater than or equal to @a rhs

    @complexity Linear.

5755 5756
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greaterequal}
N
Niels 已提交
5757

N
Niels 已提交
5758
    @since version 1.0.0
N
Niels 已提交
5759
    */
N
Niels 已提交
5760
    friend bool operator>=(const_reference lhs, const_reference rhs) noexcept
N
cleanup  
Niels 已提交
5761 5762 5763 5764
    {
        return not (lhs < rhs);
    }

N
Niels 已提交
5765 5766
    /// @}

N
cleanup  
Niels 已提交
5767 5768 5769 5770 5771

    ///////////////////
    // serialization //
    ///////////////////

N
Niels 已提交
5772 5773 5774
    /// @name serialization
    /// @{

N
Niels 已提交
5775 5776 5777 5778 5779 5780 5781 5782 5783 5784
    /*!
    @brief serialize to stream

    Serialize the given JSON value @a j to the output stream @a o. The JSON
    value will be serialized using the @ref dump member function. The
    indentation of the output can be controlled with the member variable
    `width` of the output stream @a o. For instance, using the manipulator
    `std::setw(4)` on @a o sets the indentation level to `4` and the
    serialization result is the same as calling `dump(4)`.

5785 5786 5787 5788
    @note During serializaion, the locale and the precision of the output
    stream @a o are changed. The original values are restored when the
    function returns.

N
Niels 已提交
5789 5790 5791 5792 5793 5794 5795
    @param[in,out] o  stream to serialize to
    @param[in] j  JSON value to serialize

    @return the stream @a o

    @complexity Linear.

N
Niels 已提交
5796 5797
    @liveexample{The example below shows the serialization with different
    parameters to `width` to adjust the indentation level.,operator_serialize}
N
Niels 已提交
5798

N
Niels 已提交
5799
    @since version 1.0.0
N
Niels 已提交
5800
    */
N
cleanup  
Niels 已提交
5801 5802
    friend std::ostream& operator<<(std::ostream& o, const basic_json& j)
    {
N
Niels 已提交
5803
        // read width member and use it as indentation parameter if nonzero
N
Niels 已提交
5804 5805
        const bool pretty_print = (o.width() > 0);
        const auto indentation = (pretty_print ? o.width() : 0);
N
Niels 已提交
5806

N
Niels 已提交
5807 5808
        // reset width to 0 for subsequent calls to this stream
        o.width(0);
5809

N
Niels 已提交
5810
        // fix locale problems
N
Niels 已提交
5811
        const auto old_locale = o.imbue(std::locale::classic());
5812 5813 5814 5815 5816 5817
        // set precision

        // 6, 15 or 16 digits of precision allows round-trip IEEE 754
        // string->float->string, string->double->string or string->long
        // double->string; to be safe, we read this value from
        // std::numeric_limits<number_float_t>::digits10
N
Niels 已提交
5818
        const auto old_precision = o.precision(std::numeric_limits<double>::digits10);
N
Niels 已提交
5819 5820

        // do the actual serialization
N
Niels 已提交
5821
        j.dump(o, pretty_print, static_cast<unsigned int>(indentation));
N
Niels 已提交
5822

5823
        // reset locale and precision
N
Niels 已提交
5824
        o.imbue(old_locale);
N
Niels 已提交
5825
        o.precision(old_precision);
N
cleanup  
Niels 已提交
5826 5827 5828
        return o;
    }

N
Niels 已提交
5829 5830 5831 5832
    /*!
    @brief serialize to stream
    @copydoc operator<<(std::ostream&, const basic_json&)
    */
N
cleanup  
Niels 已提交
5833 5834
    friend std::ostream& operator>>(const basic_json& j, std::ostream& o)
    {
A
Alexandre Hamez 已提交
5835
        return o << j;
N
cleanup  
Niels 已提交
5836 5837
    }

N
Niels 已提交
5838 5839
    /// @}

N
cleanup  
Niels 已提交
5840

N
Niels 已提交
5841 5842 5843 5844
    /////////////////////
    // deserialization //
    /////////////////////

N
Niels 已提交
5845 5846 5847
    /// @name deserialization
    /// @{

N
Niels 已提交
5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882
    /*!
    @brief deserialize from an array

    This function reads from an array of 1-byte values.

    @pre Each element of the container has a size of 1 byte. Violating this
    precondition yields undefined behavior. **This precondition is enforced
    with a static assertion.**

    @param[in] array  array to read from
    @param[in] cb  a parser callback function of type @ref parser_callback_t
    which is used to control the deserialization by filtering unwanted values
    (optional)

    @return result of the deserialization

    @complexity Linear in the length of the input. The parser is a predictive
    LL(1) parser. The complexity can be higher if the parser callback function
    @a cb has a super-linear complexity.

    @note A UTF-8 byte order mark is silently ignored.

    @liveexample{The example below demonstrates the `parse()` function reading
    from an array.,parse__array__parser_callback_t}

    @since version 2.0.3
    */
    template<class T, std::size_t N>
    static basic_json parse(T (&array)[N],
                            const parser_callback_t cb = nullptr)
    {
        // delegate the call to the iterator-range parse overload
        return parse(std::begin(array), std::end(array), cb);
    }

N
Niels 已提交
5883
    /*!
N
Niels 已提交
5884
    @brief deserialize from string literal
N
Niels 已提交
5885

N
Niels 已提交
5886
    @tparam CharT character/literal type with size of 1 byte
N
Niels 已提交
5887
    @param[in] s  string literal to read a serialized JSON value from
N
Niels 已提交
5888 5889 5890
    @param[in] cb a parser callback function of type @ref parser_callback_t
    which is used to control the deserialization by filtering unwanted values
    (optional)
N
Niels 已提交
5891 5892 5893 5894 5895 5896 5897

    @return result of the deserialization

    @complexity Linear in the length of the input. The parser is a predictive
    LL(1) parser. The complexity can be higher if the parser callback function
    @a cb has a super-linear complexity.

N
Niels 已提交
5898
    @note A UTF-8 byte order mark is silently ignored.
N
Niels 已提交
5899 5900
    @note String containers like `std::string` or @ref string_t can be parsed
          with @ref parse(const ContiguousContainer&, const parser_callback_t)
N
Niels 已提交
5901

N
Niels 已提交
5902 5903
    @liveexample{The example below demonstrates the `parse()` function with
    and without callback function.,parse__string__parser_callback_t}
N
Niels 已提交
5904

N
Niels 已提交
5905 5906
    @sa @ref parse(std::istream&, const parser_callback_t) for a version that
    reads from an input stream
N
Niels 已提交
5907

N
Niels 已提交
5908
    @since version 1.0.0 (originally for @ref string_t)
N
Niels 已提交
5909
    */
N
Niels 已提交
5910 5911 5912
    template<typename CharPT, typename std::enable_if<
                 std::is_pointer<CharPT>::value and
                 std::is_integral<typename std::remove_pointer<CharPT>::type>::value and
N
Niels 已提交
5913
                 sizeof(typename std::remove_pointer<CharPT>::type) == 1, int>::type = 0>
N
Niels 已提交
5914
    static basic_json parse(const CharPT s,
N
Niels 已提交
5915
                            const parser_callback_t cb = nullptr)
N
Niels 已提交
5916
    {
N
Niels 已提交
5917
        return parser(reinterpret_cast<const char*>(s), cb).parse();
5918 5919
    }

N
Niels 已提交
5920 5921 5922 5923
    /*!
    @brief deserialize from stream

    @param[in,out] i  stream to read a serialized JSON value from
N
Niels 已提交
5924 5925 5926
    @param[in] cb a parser callback function of type @ref parser_callback_t
    which is used to control the deserialization by filtering unwanted values
    (optional)
N
Niels 已提交
5927 5928 5929 5930 5931 5932 5933

    @return result of the deserialization

    @complexity Linear in the length of the input. The parser is a predictive
    LL(1) parser. The complexity can be higher if the parser callback function
    @a cb has a super-linear complexity.

N
Niels 已提交
5934 5935
    @note A UTF-8 byte order mark is silently ignored.

N
Niels 已提交
5936 5937
    @liveexample{The example below demonstrates the `parse()` function with
    and without callback function.,parse__istream__parser_callback_t}
N
Niels 已提交
5938

N
Niels 已提交
5939
    @sa @ref parse(const char*, const parser_callback_t) for a version
N
Niels 已提交
5940
    that reads from a string
N
Niels 已提交
5941

N
Niels 已提交
5942
    @since version 1.0.0
N
Niels 已提交
5943
    */
N
Niels 已提交
5944 5945
    static basic_json parse(std::istream& i,
                            const parser_callback_t cb = nullptr)
A
Aaron Burghardt 已提交
5946
    {
N
Niels 已提交
5947
        return parser(i, cb).parse();
N
Niels 已提交
5948 5949
    }

N
Niels 已提交
5950
    /*!
N
Niels 已提交
5951
    @copydoc parse(std::istream&, const parser_callback_t)
N
Niels 已提交
5952
    */
N
Niels 已提交
5953 5954
    static basic_json parse(std::istream&& i,
                            const parser_callback_t cb = nullptr)
5955 5956 5957 5958
    {
        return parser(i, cb).parse();
    }

5959
    /*!
N
Niels 已提交
5960
    @brief deserialize from an iterator range with contiguous storage
5961

5962 5963
    This function reads from an iterator range of a container with contiguous
    storage of 1-byte values. Compatible container types include
5964 5965 5966 5967 5968 5969 5970 5971 5972
    `std::vector`, `std::string`, `std::array`, `std::valarray`, and
    `std::initializer_list`. Furthermore, C-style arrays can be used with
    `std::begin()`/`std::end()`. User-defined containers can be used as long
    as they implement random-access iterators and a contiguous storage.

    @pre The iterator range is contiguous. Violating this precondition yields
    undefined behavior. **This precondition is enforced with an assertion.**
    @pre Each element in the range has a size of 1 byte. Violating this
    precondition yields undefined behavior. **This precondition is enforced
5973
    with a static assertion.**
5974

N
Niels 已提交
5975 5976 5977 5978
    @warning There is no way to enforce all preconditions at compile-time. If
             the function is called with noncompliant iterators and with
             assertions switched off, the behavior is undefined and will most
             likely yield segmentation violation.
5979

N
Niels 已提交
5980
    @tparam IteratorType iterator of container with contiguous storage
N
Niels 已提交
5981 5982 5983
    @param[in] first  begin of the range to parse (included)
    @param[in] last  end of the range to parse (excluded)
    @param[in] cb  a parser callback function of type @ref parser_callback_t
5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994
    which is used to control the deserialization by filtering unwanted values
    (optional)

    @return result of the deserialization

    @complexity Linear in the length of the input. The parser is a predictive
    LL(1) parser. The complexity can be higher if the parser callback function
    @a cb has a super-linear complexity.

    @note A UTF-8 byte order mark is silently ignored.

N
Niels 已提交
5995 5996
    @liveexample{The example below demonstrates the `parse()` function reading
    from an iterator range.,parse__iteratortype__parser_callback_t}
5997 5998 5999

    @since version 2.0.3
    */
N
Niels 已提交
6000 6001 6002 6003
    template<class IteratorType, typename std::enable_if<
                 std::is_base_of<
                     std::random_access_iterator_tag,
                     typename std::iterator_traits<IteratorType>::iterator_category>::value, int>::type = 0>
6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016
    static basic_json parse(IteratorType first, IteratorType last,
                            const parser_callback_t cb = nullptr)
    {
        // assertion to check that the iterator range is indeed contiguous,
        // see http://stackoverflow.com/a/35008842/266378 for more discussion
        assert(std::accumulate(first, last, std::make_pair<bool, int>(true, 0),
                               [&first](std::pair<bool, int> res, decltype(*first) val)
        {
            res.first &= (val == *(std::next(std::addressof(*first), res.second++)));
            return res;
        }).first);

        // assertion to check that each element is 1 byte long
6017 6018
        static_assert(sizeof(typename std::iterator_traits<IteratorType>::value_type) == 1,
                      "each element in the iterator range must have the size of 1 byte");
6019

6020 6021 6022 6023 6024 6025
        // if iterator range is empty, create a parser with an empty string
        // to generate "unexpected EOF" error message
        if (std::distance(first, last) <= 0)
        {
            return parser("").parse();
        }
6026 6027 6028 6029

        return parser(first, last, cb).parse();
    }

N
Niels 已提交
6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050
    /*!
    @brief deserialize from a container with contiguous storage

    This function reads from a container with contiguous storage of 1-byte
    values. Compatible container types include `std::vector`, `std::string`,
    `std::array`, and `std::initializer_list`. User-defined containers can be
    used as long as they implement random-access iterators and a contiguous
    storage.

    @pre The container storage is contiguous. Violating this precondition
    yields undefined behavior. **This precondition is enforced with an
    assertion.**
    @pre Each element of the container has a size of 1 byte. Violating this
    precondition yields undefined behavior. **This precondition is enforced
    with a static assertion.**

    @warning There is no way to enforce all preconditions at compile-time. If
             the function is called with a noncompliant container and with
             assertions switched off, the behavior is undefined and will most
             likely yield segmentation violation.

N
Niels 已提交
6051
    @tparam ContiguousContainer container type with contiguous storage
N
Niels 已提交
6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069
    @param[in] c  container to read from
    @param[in] cb  a parser callback function of type @ref parser_callback_t
    which is used to control the deserialization by filtering unwanted values
    (optional)

    @return result of the deserialization

    @complexity Linear in the length of the input. The parser is a predictive
    LL(1) parser. The complexity can be higher if the parser callback function
    @a cb has a super-linear complexity.

    @note A UTF-8 byte order mark is silently ignored.

    @liveexample{The example below demonstrates the `parse()` function reading
    from a contiguous container.,parse__contiguouscontainer__parser_callback_t}

    @since version 2.0.3
    */
N
Niels 已提交
6070
    template<class ContiguousContainer, typename std::enable_if<
N
Niels 已提交
6071
                 not std::is_pointer<ContiguousContainer>::value and
6072 6073
                 std::is_base_of<
                     std::random_access_iterator_tag,
N
Niels 已提交
6074
                     typename std::iterator_traits<decltype(std::begin(std::declval<ContiguousContainer const>()))>::iterator_category>::value
6075 6076 6077 6078 6079 6080 6081 6082
                 , int>::type = 0>
    static basic_json parse(const ContiguousContainer& c,
                            const parser_callback_t cb = nullptr)
    {
        // delegate the call to the iterator-range parse overload
        return parse(std::begin(c), std::end(c), cb);
    }

N
Niels 已提交
6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095
    /*!
    @brief deserialize from stream

    Deserializes an input stream to a JSON value.

    @param[in,out] i  input stream to read a serialized JSON value from
    @param[in,out] j  JSON value to write the deserialized input to

    @throw std::invalid_argument in case of parse errors

    @complexity Linear in the length of the input. The parser is a predictive
    LL(1) parser.

N
Niels 已提交
6096 6097
    @note A UTF-8 byte order mark is silently ignored.

N
Niels 已提交
6098 6099 6100
    @liveexample{The example below shows how a JSON value is constructed by
    reading a serialization from a stream.,operator_deserialize}

N
Niels 已提交
6101 6102
    @sa parse(std::istream&, const parser_callback_t) for a variant with a
    parser callback function to filter values while parsing
N
Niels 已提交
6103

N
Niels 已提交
6104
    @since version 1.0.0
N
Niels 已提交
6105 6106
    */
    friend std::istream& operator<<(basic_json& j, std::istream& i)
N
Niels 已提交
6107 6108 6109 6110 6111
    {
        j = parser(i).parse();
        return i;
    }

N
Niels 已提交
6112 6113 6114 6115 6116
    /*!
    @brief deserialize from stream
    @copydoc operator<<(basic_json&, std::istream&)
    */
    friend std::istream& operator>>(std::istream& i, basic_json& j)
N
Niels 已提交
6117 6118 6119 6120 6121
    {
        j = parser(i).parse();
        return i;
    }

N
Niels 已提交
6122 6123
    /// @}

N
Niels Lohmann 已提交
6124 6125 6126
    //////////////////////////////////////////
    // binary serialization/deserialization //
    //////////////////////////////////////////
N
Niels 已提交
6127

N
Niels Lohmann 已提交
6128
    /// @name binary serialization/deserialization support
N
Niels 已提交
6129 6130 6131
    /// @{

  private:
6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168
    template<typename T>
    static void add_to_vector(std::vector<uint8_t>& vec, size_t bytes, const T number)
    {
        assert(bytes == 1 or bytes == 2 or bytes == 4 or bytes == 8);

        switch (bytes)
        {
            case 8:
            {
                vec.push_back(static_cast<uint8_t>((number >> 070) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 060) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 050) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 040) & 0xff));
                // intentional fall-through
            }

            case 4:
            {
                vec.push_back(static_cast<uint8_t>((number >> 030) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 020) & 0xff));
                // intentional fall-through
            }

            case 2:
            {
                vec.push_back(static_cast<uint8_t>((number >> 010) & 0xff));
                // intentional fall-through
            }

            case 1:
            {
                vec.push_back(static_cast<uint8_t>(number & 0xff));
                break;
            }
        }
    }

6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210
    template<typename T>
    static T get_from_vector(const std::vector<uint8_t>& vec, size_t bytes, size_t current_idx)
    {
        assert(bytes == 1 or bytes == 2 or bytes == 4 or bytes == 8);

        switch (bytes)
        {
            case 1:
            {
                return static_cast<T>(vec[current_idx + 1]);
            }

            case 2:
            {
                return static_cast<T>((static_cast<T>(vec[current_idx + 1]) << 010) +
                                      static_cast<T>(vec[current_idx + 2]));
            }

            case 4:
            {
                return static_cast<T>((static_cast<T>(vec[current_idx + 1]) << 030) +
                                      (static_cast<T>(vec[current_idx + 2]) << 020) +
                                      (static_cast<T>(vec[current_idx + 3]) << 010) +
                                      static_cast<T>(vec[current_idx + 4]));
            }

            case 8:
            {
                return static_cast<T>((static_cast<T>(vec[current_idx + 1]) << 070) +
                                      (static_cast<T>(vec[current_idx + 2]) << 060) +
                                      (static_cast<T>(vec[current_idx + 3]) << 050) +
                                      (static_cast<T>(vec[current_idx + 4]) << 040) +
                                      (static_cast<T>(vec[current_idx + 5]) << 030) +
                                      (static_cast<T>(vec[current_idx + 6]) << 020) +
                                      (static_cast<T>(vec[current_idx + 7]) << 010) +
                                      static_cast<T>(vec[current_idx + 8]));
            }
        }

        assert(false);
    }

N
Niels 已提交
6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233
    static void to_msgpack_internal(const basic_json& j, std::vector<uint8_t>& v)
    {
        switch (j.type())
        {
            case value_t::null:
            {
                // nil
                v.push_back(0xc0);
                break;
            }

            case value_t::boolean:
            {
                // true and false
                v.push_back(j.m_value.boolean ? 0xc3 : 0xc2);
                break;
            }

            case value_t::number_integer:
            {
                if (j.m_value.number_integer >= -32 and j.m_value.number_integer < 128)
                {
                    // negative fixnum and positive fixnum
6234
                    add_to_vector(v, 1, j.m_value.number_integer);
N
Niels 已提交
6235 6236 6237 6238 6239
                }
                else if (j.m_value.number_integer >= INT8_MIN and j.m_value.number_integer <= INT8_MAX)
                {
                    // int 8
                    v.push_back(0xd0);
6240
                    add_to_vector(v, 1, j.m_value.number_integer);
N
Niels 已提交
6241 6242 6243 6244 6245
                }
                else if (j.m_value.number_integer >= INT16_MIN and j.m_value.number_integer <= INT16_MAX)
                {
                    // int 16
                    v.push_back(0xd1);
6246
                    add_to_vector(v, 2, j.m_value.number_integer);
N
Niels 已提交
6247 6248 6249 6250 6251
                }
                else if (j.m_value.number_integer >= INT32_MIN and j.m_value.number_integer <= INT32_MAX)
                {
                    // int 32
                    v.push_back(0xd2);
6252
                    add_to_vector(v, 4, j.m_value.number_integer);
N
Niels 已提交
6253 6254 6255 6256 6257
                }
                else if (j.m_value.number_integer >= INT64_MIN and j.m_value.number_integer <= INT64_MAX)
                {
                    // int 64
                    v.push_back(0xd3);
6258
                    add_to_vector(v, 8, j.m_value.number_integer);
N
Niels 已提交
6259 6260 6261 6262 6263 6264 6265 6266 6267
                }
                break;
            }

            case value_t::number_unsigned:
            {
                if (j.m_value.number_unsigned < 128)
                {
                    // positive fixnum
6268
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels 已提交
6269 6270 6271 6272 6273
                }
                else if (j.m_value.number_unsigned <= UINT8_MAX)
                {
                    // uint 8
                    v.push_back(0xcc);
6274
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels 已提交
6275 6276 6277 6278 6279
                }
                else if (j.m_value.number_unsigned <= UINT16_MAX)
                {
                    // uint 16
                    v.push_back(0xcd);
6280
                    add_to_vector(v, 2, j.m_value.number_unsigned);
N
Niels 已提交
6281 6282 6283 6284 6285
                }
                else if (j.m_value.number_unsigned <= UINT32_MAX)
                {
                    // uint 32
                    v.push_back(0xce);
6286
                    add_to_vector(v, 4, j.m_value.number_unsigned);
N
Niels 已提交
6287 6288 6289 6290 6291
                }
                else if (j.m_value.number_unsigned <= UINT64_MAX)
                {
                    // uint 64
                    v.push_back(0xcf);
6292
                    add_to_vector(v, 8, j.m_value.number_unsigned);
N
Niels 已提交
6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320
                }
                break;
            }

            case value_t::number_float:
            {
                // float 64
                v.push_back(0xcb);
                const uint8_t* helper = reinterpret_cast<const uint8_t*>(&(j.m_value.number_float));
                for (size_t i = 0; i < 8; ++i)
                {
                    v.push_back(helper[7 - i]);
                }
                break;
            }

            case value_t::string:
            {
                const auto N = j.m_value.string->size();
                if (N <= 31)
                {
                    // fixstr
                    v.push_back(static_cast<uint8_t>(0xa0 | N));
                }
                else if (N <= 255)
                {
                    // str 8
                    v.push_back(0xd9);
6321
                    add_to_vector(v, 1, N);
N
Niels 已提交
6322 6323 6324 6325 6326
                }
                else if (N <= 65535)
                {
                    // str 16
                    v.push_back(0xda);
6327
                    add_to_vector(v, 2, N);
N
Niels 已提交
6328 6329 6330 6331 6332
                }
                else if (N <= 4294967295)
                {
                    // str 32
                    v.push_back(0xdb);
6333
                    add_to_vector(v, 4, N);
N
Niels 已提交
6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353
                }

                // append string
                std::copy(j.m_value.string->begin(), j.m_value.string->end(),
                          std::back_inserter(v));
                break;
            }

            case value_t::array:
            {
                const auto N = j.m_value.array->size();
                if (N <= 15)
                {
                    // fixarray
                    v.push_back(static_cast<uint8_t>(0x90 | N));
                }
                else if (N <= 0xffff)
                {
                    // array 16
                    v.push_back(0xdc);
6354
                    add_to_vector(v, 2, N);
N
Niels 已提交
6355 6356 6357 6358 6359
                }
                else if (N <= 0xffffffff)
                {
                    // array 32
                    v.push_back(0xdd);
6360
                    add_to_vector(v, 4, N);
N
Niels 已提交
6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382
                }

                // append each element
                for (const auto& el : *j.m_value.array)
                {
                    to_msgpack_internal(el, v);
                }
                break;
            }

            case value_t::object:
            {
                const auto N = j.m_value.object->size();
                if (N <= 15)
                {
                    // fixmap
                    v.push_back(static_cast<uint8_t>(0x80 | (N & 0xf)));
                }
                else if (N <= 65535)
                {
                    // map 16
                    v.push_back(0xde);
6383
                    add_to_vector(v, 2, N);
N
Niels 已提交
6384 6385 6386 6387 6388
                }
                else if (N <= 4294967295)
                {
                    // map 32
                    v.push_back(0xdf);
6389
                    add_to_vector(v, 4, N);
N
Niels 已提交
6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407
                }

                // append each element
                for (const auto& el : *j.m_value.object)
                {
                    to_msgpack_internal(el.first, v);
                    to_msgpack_internal(el.second, v);
                }
                break;
            }

            default:
            {
                break;
            }
        }
    }

N
Niels Lohmann 已提交
6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432
    static void to_cbor_internal(const basic_json& j, std::vector<uint8_t>& v)
    {
        switch (j.type())
        {
            case value_t::null:
            {
                v.push_back(0xf6);
                break;
            }

            case value_t::boolean:
            {
                v.push_back(j.m_value.boolean ? 0xf5 : 0xf4);
                break;
            }

            case value_t::number_integer:
            {
                if (j.m_value.number_integer >= 0)
                {
                    // CBOR does not differentiate between positive signed
                    // integers and unsigned integers. Therefore, we used the
                    // code from the value_t::number_unsigned case here.
                    if (j.m_value.number_integer < 0x17)
                    {
6433
                        add_to_vector(v, 1, j.m_value.number_integer);
N
Niels Lohmann 已提交
6434 6435 6436 6437 6438
                    }
                    else if (j.m_value.number_integer <= UINT8_MAX)
                    {
                        v.push_back(0x18);
                        // one-byte uint8_t
6439
                        add_to_vector(v, 1, j.m_value.number_integer);
N
Niels Lohmann 已提交
6440 6441 6442 6443 6444
                    }
                    else if (j.m_value.number_integer <= UINT16_MAX)
                    {
                        v.push_back(0x19);
                        // two-byte uint16_t
6445
                        add_to_vector(v, 2, j.m_value.number_integer);
N
Niels Lohmann 已提交
6446 6447 6448 6449 6450
                    }
                    else if (j.m_value.number_integer <= UINT32_MAX)
                    {
                        v.push_back(0x1a);
                        // four-byte uint32_t
6451
                        add_to_vector(v, 4, j.m_value.number_integer);
N
Niels Lohmann 已提交
6452 6453 6454 6455 6456
                    }
                    else if (j.m_value.number_integer <= UINT64_MAX)
                    {
                        v.push_back(0xcf);
                        // eight-byte uint64_t
6457
                        add_to_vector(v, 8, j.m_value.number_integer);
N
Niels Lohmann 已提交
6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472
                    }
                }
                else
                {
                    // The conversions below encode the sign in the first byte,
                    // and the value is converted to a positive number.
                    const auto positive_number = -1 - j.m_value.number_integer;
                    if (j.m_value.number_integer <= -1 and j.m_value.number_integer >= -24)
                    {
                        v.push_back(static_cast<uint8_t>(0x20 + positive_number));
                    }
                    else if (positive_number <= UINT8_MAX)
                    {
                        // int 8
                        v.push_back(0x38);
6473
                        add_to_vector(v, 1, positive_number);
N
Niels Lohmann 已提交
6474 6475 6476 6477 6478
                    }
                    else if (positive_number <= UINT16_MAX)
                    {
                        // int 16
                        v.push_back(0x39);
6479
                        add_to_vector(v, 2, positive_number);
N
Niels Lohmann 已提交
6480 6481 6482 6483 6484
                    }
                    else if (positive_number <= UINT32_MAX)
                    {
                        // int 32
                        v.push_back(0x3a);
6485
                        add_to_vector(v, 4, positive_number);
N
Niels Lohmann 已提交
6486 6487 6488 6489 6490
                    }
                    else if (positive_number <= UINT64_MAX)
                    {
                        // int 64
                        v.push_back(0x3b);
6491
                        add_to_vector(v, 8, positive_number);
N
Niels Lohmann 已提交
6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506
                    }
                    break;
                }
            }

            case value_t::number_unsigned:
            {
                if (j.m_value.number_unsigned < 0x17)
                {
                    v.push_back(static_cast<uint8_t>(j.m_value.number_unsigned));
                }
                else if (j.m_value.number_unsigned <= 0xff)
                {
                    v.push_back(0x18);
                    // one-byte uint8_t
6507
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
6508 6509 6510 6511 6512
                }
                else if (j.m_value.number_unsigned <= 0xffff)
                {
                    v.push_back(0x19);
                    // two-byte uint16_t
6513
                    add_to_vector(v, 2, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
6514 6515 6516 6517 6518
                }
                else if (j.m_value.number_unsigned <= 0xffffffff)
                {
                    v.push_back(0x1a);
                    // four-byte uint32_t
6519
                    add_to_vector(v, 4, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
6520 6521 6522 6523 6524
                }
                else if (j.m_value.number_unsigned <= 0xffffffffffffffff)
                {
                    v.push_back(0xcf);
                    // eight-byte uint64_t
6525
                    add_to_vector(v, 8, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552
                }
                break;
            }

            case value_t::number_float:
            {
                // Double-Precision Float
                v.push_back(0xfb);
                const uint8_t* helper = reinterpret_cast<const uint8_t*>(&(j.m_value.number_float));
                for (size_t i = 0; i < 8; ++i)
                {
                    v.push_back(helper[7 - i]);
                }
                break;
            }

            case value_t::string:
            {
                const auto N = j.m_value.string->size();
                if (N <= 0x17)
                {
                    v.push_back(0x60 + N);
                }
                else if (N <= 0xff)
                {
                    v.push_back(0x78);
                    // one-byte uint8_t for N
6553
                    add_to_vector(v, 1, N);
N
Niels Lohmann 已提交
6554 6555 6556 6557 6558
                }
                else if (N <= 0xffff)
                {
                    v.push_back(0x79);
                    // two-byte uint16_t for N
6559
                    add_to_vector(v, 2, N);
N
Niels Lohmann 已提交
6560 6561 6562 6563 6564
                }
                else if (N <= 0xffffffff)
                {
                    v.push_back(0x7a);
                    // four-byte uint32_t for N
6565
                    add_to_vector(v, 4, N);
N
Niels Lohmann 已提交
6566 6567 6568 6569 6570
                }
                else if (N <= 0xffffffffffffffff)
                {
                    v.push_back(0x7b);
                    // eight-byte uint64_t for N
6571
                    add_to_vector(v, 8, N);
N
Niels Lohmann 已提交
6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591
                }

                // append string
                std::copy(j.m_value.string->begin(), j.m_value.string->end(),
                          std::back_inserter(v));
                break;
            }

            case value_t::array:
            {
                const auto N = j.m_value.array->size();
                if (N <= 0x17)
                {
                    // 1 byte for array + size
                    v.push_back(0x80 + N);
                }
                else if (N <= 0xff)
                {
                    v.push_back(0x98);
                    // one-byte uint8_t for N
6592
                    add_to_vector(v, 1, N);
N
Niels Lohmann 已提交
6593 6594 6595 6596 6597
                }
                else if (N <= 0xffff)
                {
                    v.push_back(0x99);
                    // two-byte uint16_t for N
6598
                    add_to_vector(v, 2, N);
N
Niels Lohmann 已提交
6599 6600 6601 6602 6603
                }
                else if (N <= 0xffffffff)
                {
                    v.push_back(0x9a);
                    // four-byte uint32_t for N
6604
                    add_to_vector(v, 4, N);
N
Niels Lohmann 已提交
6605 6606 6607 6608 6609
                }
                else if (N <= 0xffffffffffffffff)
                {
                    v.push_back(0x9b);
                    // eight-byte uint64_t for N
6610
                    add_to_vector(v, 8, N);
N
Niels Lohmann 已提交
6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625
                }

                // append each element
                for (const auto& el : *j.m_value.array)
                {
                    to_cbor_internal(el, v);
                }
                break;
            }

            case value_t::object:
            {
                const auto N = j.m_value.object->size();
                if (N <= 0x17)
                {
6626
                    // 1 byte for object + size
N
Niels Lohmann 已提交
6627 6628 6629 6630 6631 6632
                    v.push_back(0xa0 + N);
                }
                else if (N <= 0xff)
                {
                    v.push_back(0xb8);
                    // one-byte uint8_t for N
6633
                    add_to_vector(v, 1, N);
N
Niels Lohmann 已提交
6634 6635 6636 6637 6638
                }
                else if (N <= 0xffff)
                {
                    v.push_back(0xb9);
                    // two-byte uint16_t for N
6639
                    add_to_vector(v, 2, N);
N
Niels Lohmann 已提交
6640 6641 6642 6643 6644
                }
                else if (N <= 0xffffffff)
                {
                    v.push_back(0xba);
                    // four-byte uint32_t for N
6645
                    add_to_vector(v, 4, N);
N
Niels Lohmann 已提交
6646 6647 6648 6649 6650
                }
                else if (N <= 0xffffffffffffffff)
                {
                    v.push_back(0xbb);
                    // eight-byte uint64_t for N
6651
                    add_to_vector(v, 8, N);
N
Niels Lohmann 已提交
6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669
                }

                // append each element
                for (const auto& el : *j.m_value.object)
                {
                    to_cbor_internal(el.first, v);
                    to_cbor_internal(el.second, v);
                }
                break;
            }

            default:
            {
                break;
            }
        }
    }

N
Niels 已提交
6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755
    /*!
    @param[in] v  MessagePack serialization
    @param[in] idx  byte index to start reading from @a v
    */
    static basic_json from_msgpack_internal(const std::vector<uint8_t>& v, size_t& idx)
    {
        // store and increment index
        const size_t current_idx = idx++;

        if (v[current_idx] <= 0x7f) // positive fixint
        {
            return v[current_idx];
        }
        else if (v[current_idx] <= 0x8f) // fixmap
        {
            basic_json result = value_t::object;
            const size_t len = v[current_idx] & 0x0f;
            for (size_t i = 0; i < len; ++i)
            {
                std::string key = from_msgpack_internal(v, idx);
                result[key] = from_msgpack_internal(v, idx);
            }
            return result;
        }
        else if (v[current_idx] <= 0x9f) // fixarray
        {
            basic_json result = value_t::array;
            const size_t len = v[current_idx] & 0x0f;
            for (size_t i = 0; i < len; ++i)
            {
                result.push_back(from_msgpack_internal(v, idx));
            }
            return result;
        }
        else if (v[current_idx] <= 0xbf) // fixstr
        {
            const size_t len = v[current_idx] & 0x1f;
            const size_t offset = current_idx + 1;
            idx += len; // skip content bytes
            return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
        }
        else if (v[current_idx] == 0xc0) // nil
        {
            return value_t::null;
        }
        else if (v[current_idx] == 0xc1) // never used
        {
            throw std::invalid_argument("value 0x31 must not be used@ " + std::to_string(current_idx));
        }
        else if (v[current_idx] == 0xc2) // false
        {
            return false;
        }
        else if (v[current_idx] == 0xc3) // true
        {
            return true;
        }
        else if (v[current_idx] >= 0xc4 and v[current_idx] <= 0xc9) // bin/ext
        {
            throw std::invalid_argument("bin/ext are not supported @ " + std::to_string(current_idx));
        }
        else if (v[current_idx] == 0xca) // float 32
        {
            // copy bytes in reverse order into the double variable
            float res;
            for (size_t byte = 0; byte < sizeof(float); ++byte)
            {
                reinterpret_cast<uint8_t*>(&res)[sizeof(float) - byte - 1] = v[current_idx + 1 + byte];
            }
            idx += sizeof(float); // skip content bytes
            return res;
        }
        else if (v[current_idx] == 0xcb) // float 64
        {
            // copy bytes in reverse order into the double variable
            double res;
            for (size_t byte = 0; byte < sizeof(double); ++byte)
            {
                reinterpret_cast<uint8_t*>(&res)[sizeof(double) - byte - 1] = v[current_idx + 1 + byte];
            }
            idx += sizeof(double); // skip content bytes
            return res;
        }
        else if (v[current_idx] == 0xcc) // uint 8
        {
            idx += 1; // skip content byte
6756
            return get_from_vector<uint8_t>(v, 1, current_idx);
N
Niels 已提交
6757 6758 6759 6760
        }
        else if (v[current_idx] == 0xcd) // uint 16
        {
            idx += 2; // skip 2 content bytes
6761
            return get_from_vector<uint16_t>(v, 2, current_idx);
N
Niels 已提交
6762 6763 6764 6765
        }
        else if (v[current_idx] == 0xce) // uint 32
        {
            idx += 4; // skip 4 content bytes
6766
            return get_from_vector<uint32_t>(v, 4, current_idx);
N
Niels 已提交
6767 6768 6769 6770
        }
        else if (v[current_idx] == 0xcf) // uint 64
        {
            idx += 8; // skip 8 content bytes
6771
            return get_from_vector<uint64_t>(v, 8, current_idx);
N
Niels 已提交
6772 6773 6774 6775
        }
        else if (v[current_idx] == 0xd0) // int 8
        {
            idx += 1; // skip content byte
6776
            return get_from_vector<int8_t>(v, 1, current_idx);
N
Niels 已提交
6777 6778 6779 6780
        }
        else if (v[current_idx] == 0xd1) // int 16
        {
            idx += 2; // skip 2 content bytes
6781
            return get_from_vector<int16_t>(v, 2, current_idx);
N
Niels 已提交
6782 6783 6784 6785
        }
        else if (v[current_idx] == 0xd2) // int 32
        {
            idx += 4; // skip 4 content bytes
6786
            return get_from_vector<int32_t>(v, 4, current_idx);
N
Niels 已提交
6787 6788 6789 6790
        }
        else if (v[current_idx] == 0xd3) // int 64
        {
            idx += 8; // skip 8 content bytes
6791
            return get_from_vector<int64_t>(v, 8, current_idx);
N
Niels 已提交
6792 6793 6794 6795 6796 6797 6798
        }
        else if (v[current_idx] >= 0xd4 and v[current_idx] <= 0xd8) // fixext
        {
            throw std::invalid_argument("bin/ext are not supported @ " + std::to_string(current_idx));
        }
        else if (v[current_idx] == 0xd9) // str 8
        {
6799
            const size_t len = get_from_vector<size_t>(v, 1, current_idx);
N
Niels 已提交
6800 6801 6802 6803 6804 6805
            const size_t offset = current_idx + 2;
            idx += len + 1; // skip size byte + content bytes
            return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
        }
        else if (v[current_idx] == 0xda) // str 16
        {
6806
            const size_t len = get_from_vector<size_t>(v, 2, current_idx);
N
Niels 已提交
6807 6808 6809 6810 6811 6812
            const size_t offset = current_idx + 3;
            idx += len + 2; // skip 2 size bytes + content bytes
            return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
        }
        else if (v[current_idx] == 0xdb) // str 32
        {
6813
            const size_t len = get_from_vector<size_t>(v, 4, current_idx);
N
Niels 已提交
6814 6815 6816 6817 6818 6819 6820
            const size_t offset = current_idx + 5;
            idx += len + 4; // skip 4 size bytes + content bytes
            return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
        }
        else if (v[current_idx] == 0xdc) // array 16
        {
            basic_json result = value_t::array;
6821
            const size_t len = get_from_vector<size_t>(v, 2, current_idx);
N
Niels 已提交
6822 6823 6824 6825 6826 6827 6828 6829 6830 6831
            idx += 2; // skip 2 size bytes
            for (size_t i = 0; i < len; ++i)
            {
                result.push_back(from_msgpack_internal(v, idx));
            }
            return result;
        }
        else if (v[current_idx] == 0xdd) // array 32
        {
            basic_json result = value_t::array;
6832
            const size_t len = get_from_vector<size_t>(v, 4, current_idx);
N
Niels 已提交
6833 6834 6835 6836 6837 6838 6839 6840 6841 6842
            idx += 4; // skip 4 size bytes
            for (size_t i = 0; i < len; ++i)
            {
                result.push_back(from_msgpack_internal(v, idx));
            }
            return result;
        }
        else if (v[current_idx] == 0xde) // map 16
        {
            basic_json result = value_t::object;
6843
            const size_t len = get_from_vector<size_t>(v, 2, current_idx);
N
Niels 已提交
6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854
            idx += 2; // skip 2 size bytes
            for (size_t i = 0; i < len; ++i)
            {
                std::string key = from_msgpack_internal(v, idx);
                result[key] = from_msgpack_internal(v, idx);
            }
            return result;
        }
        else if (v[current_idx] == 0xdf) // map 32
        {
            basic_json result = value_t::object;
6855
            const size_t len = get_from_vector<size_t>(v, 4, current_idx);
N
Niels 已提交
6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871
            idx += 4; // skip 4 size bytes
            for (size_t i = 0; i < len; ++i)
            {
                std::string key = from_msgpack_internal(v, idx);
                result[key] = from_msgpack_internal(v, idx);
            }
            return result;
        }
        else if (v[current_idx] >= 0xe0) // negative fixint
        {
            return static_cast<int8_t>(v[current_idx]);
        }

        throw std::invalid_argument("error parsing a msgpack @ " + std::to_string(current_idx));
    }

N
Niels Lohmann 已提交
6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883
    static basic_json from_cbor_internal(const std::vector<uint8_t>& v, size_t& idx)
    {
        // store and increment index
        const size_t current_idx = idx++;

        if (v[current_idx] <= 0x17) // Integer 0x00..0x17
        {
            return v[current_idx];
        }
        else if (v[current_idx] == 0x18) // Unsigned integer uint8_t
        {
            idx += 1; // skip content byte
6884
            return get_from_vector<uint8_t>(v, 1, current_idx);
N
Niels Lohmann 已提交
6885 6886 6887 6888
        }
        else if (v[current_idx] == 0x19) // Unsigned integer uint16_t
        {
            idx += 2; // skip 2 content bytes
6889
            return get_from_vector<uint16_t>(v, 2, current_idx);
N
Niels Lohmann 已提交
6890 6891 6892 6893
        }
        else if (v[current_idx] == 0x1a) // Unsigned integer uint32_t
        {
            idx += 4; // skip 4 content bytes
6894
            return get_from_vector<uint32_t>(v, 4, current_idx);
N
Niels Lohmann 已提交
6895 6896 6897 6898
        }
        else if (v[current_idx] == 0x1b) // Unsigned integer uint64_t
        {
            idx += 8; // skip 8 content bytes
6899
            return get_from_vector<uint64_t>(v, 8, current_idx);
N
Niels Lohmann 已提交
6900 6901 6902 6903 6904 6905 6906 6907
        }
        else if (v[current_idx] >= 0x20 and v[current_idx] <= 0x37) // Negative integer
        {
            return static_cast<int8_t>(0x20 - 1 - v[current_idx]);
        }
        else if (v[current_idx] == 0x38) // Negative integer
        {
            idx += 1; // skip content byte
6908 6909
            // must be int64_t !
            return -1 - get_from_vector<int16_t>(v, 1, current_idx);
N
Niels Lohmann 已提交
6910 6911 6912 6913
        }
        else if (v[current_idx] == 0x39) // Negative integer
        {
            idx += 2; // skip 2 content bytes
6914
            return -1 - get_from_vector<int16_t>(v, 2, current_idx);
N
Niels Lohmann 已提交
6915 6916 6917 6918
        }
        else if (v[current_idx] == 0x3a) // Negative integer
        {
            idx += 4; // skip 4 content bytes
6919
            return -1 - get_from_vector<int32_t>(v, 4, current_idx);
N
Niels Lohmann 已提交
6920 6921 6922 6923
        }
        else if (v[current_idx] == 0x3b) // Negative integer
        {
            idx += 8; // skip 8 content bytes
6924
            return -1 - get_from_vector<int64_t>(v, 8, current_idx);
N
Niels Lohmann 已提交
6925 6926 6927 6928 6929 6930 6931 6932 6933 6934
        }
        else if (v[current_idx] >= 0x60 and v[current_idx] <= 0x77) // UTF-8 string
        {
            const size_t len = v[current_idx] - 0x60;
            const size_t offset = current_idx + 1;
            idx += len; // skip content bytes
            return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
        }
        else if (v[current_idx] == 0x78) // UTF-8 string
        {
6935
            const size_t len = get_from_vector<size_t>(v, 1, current_idx);
N
Niels Lohmann 已提交
6936 6937 6938 6939 6940 6941
            const size_t offset = current_idx + 2;
            idx += len + 1; // skip size byte + content bytes
            return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
        }
        else if (v[current_idx] == 0x79) // UTF-8 string
        {
6942
            const size_t len = get_from_vector<size_t>(v, 2, current_idx);
N
Niels Lohmann 已提交
6943 6944 6945 6946 6947 6948
            const size_t offset = current_idx + 3;
            idx += len + 2; // skip 2 size bytes + content bytes
            return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
        }
        else if (v[current_idx] == 0x7a) // UTF-8 string
        {
6949
            const size_t len = get_from_vector<size_t>(v, 4, current_idx);
N
Niels Lohmann 已提交
6950 6951 6952 6953 6954 6955
            const size_t offset = current_idx + 5;
            idx += len + 4; // skip 4 size bytes + content bytes
            return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
        }
        else if (v[current_idx] == 0x7b) // UTF-8 string
        {
6956 6957 6958
            const size_t len = get_from_vector<size_t>(v, 8, current_idx);
            const size_t offset = current_idx + 9;
            idx += len + 8; // skip 8 size bytes + content bytes
N
Niels Lohmann 已提交
6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973
            return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
        }
        else if (v[current_idx] >= 0x80 and v[current_idx] <= 0x97) // array
        {
            basic_json result = value_t::array;
            const size_t len = v[current_idx] - 0x80;
            for (size_t i = 0; i < len; ++i)
            {
                result.push_back(from_cbor_internal(v, idx));
            }
            return result;
        }
        else if (v[current_idx] == 0x98) // array
        {
            basic_json result = value_t::array;
6974
            const size_t len = get_from_vector<size_t>(v, 1, current_idx);
N
Niels Lohmann 已提交
6975 6976 6977 6978 6979 6980 6981 6982 6983 6984
            idx += 1; // skip 1 size byte
            for (size_t i = 0; i < len; ++i)
            {
                result.push_back(from_cbor_internal(v, idx));
            }
            return result;
        }
        else if (v[current_idx] == 0x99) // array
        {
            basic_json result = value_t::array;
6985
            const size_t len = get_from_vector<size_t>(v, 2, current_idx);
N
Niels Lohmann 已提交
6986 6987 6988 6989 6990 6991 6992 6993 6994 6995
            idx += 2; // skip 4 size bytes
            for (size_t i = 0; i < len; ++i)
            {
                result.push_back(from_cbor_internal(v, idx));
            }
            return result;
        }
        else if (v[current_idx] == 0x9a) // array
        {
            basic_json result = value_t::array;
6996
            const size_t len = get_from_vector<size_t>(v, 4, current_idx);
N
Niels Lohmann 已提交
6997 6998 6999 7000 7001 7002 7003 7004 7005 7006
            idx += 4; // skip 4 size bytes
            for (size_t i = 0; i < len; ++i)
            {
                result.push_back(from_cbor_internal(v, idx));
            }
            return result;
        }
        else if (v[current_idx] == 0x9b) // array
        {
            basic_json result = value_t::array;
7007
            const size_t len = get_from_vector<size_t>(v, 8, current_idx);
N
Niels Lohmann 已提交
7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028
            idx += 8; // skip 8 size bytes
            for (size_t i = 0; i < len; ++i)
            {
                result.push_back(from_cbor_internal(v, idx));
            }
            return result;
        }
        else if (v[current_idx] >= 0xa0 and v[current_idx] <= 0xb7) // map
        {
            basic_json result = value_t::object;
            const size_t len = v[current_idx] - 0xa0;
            for (size_t i = 0; i < len; ++i)
            {
                std::string key = from_cbor_internal(v, idx);
                result[key] = from_cbor_internal(v, idx);
            }
            return result;
        }
        else if (v[current_idx] == 0xb8) // map
        {
            basic_json result = value_t::object;
7029
            const size_t len = get_from_vector<size_t>(v, 1, current_idx);
N
Niels Lohmann 已提交
7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040
            idx += 1; // skip 1 size byte
            for (size_t i = 0; i < len; ++i)
            {
                std::string key = from_cbor_internal(v, idx);
                result[key] = from_cbor_internal(v, idx);
            }
            return result;
        }
        else if (v[current_idx] == 0xb9) // map
        {
            basic_json result = value_t::object;
7041
            const size_t len = get_from_vector<size_t>(v, 2, current_idx);
N
Niels Lohmann 已提交
7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052
            idx += 2; // skip 2 size bytes
            for (size_t i = 0; i < len; ++i)
            {
                std::string key = from_cbor_internal(v, idx);
                result[key] = from_cbor_internal(v, idx);
            }
            return result;
        }
        else if (v[current_idx] == 0xba) // map
        {
            basic_json result = value_t::object;
7053
            const size_t len = get_from_vector<size_t>(v, 4, current_idx);
N
Niels Lohmann 已提交
7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064
            idx += 4; // skip 4 size bytes
            for (size_t i = 0; i < len; ++i)
            {
                std::string key = from_cbor_internal(v, idx);
                result[key] = from_cbor_internal(v, idx);
            }
            return result;
        }
        else if (v[current_idx] == 0xbb) // map
        {
            basic_json result = value_t::object;
7065
            const size_t len = get_from_vector<size_t>(v, 8, current_idx);
N
Niels Lohmann 已提交
7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135
            idx += 8; // skip 8 size bytes
            for (size_t i = 0; i < len; ++i)
            {
                std::string key = from_cbor_internal(v, idx);
                result[key] = from_cbor_internal(v, idx);
            }
            return result;
        }
        else if (v[current_idx] == 0xf4) // false
        {
            return false;
        }
        else if (v[current_idx] == 0xf5) // true
        {
            return true;
        }
        else if (v[current_idx] == 0xf6) // null
        {
            return value_t::null;
        }
        else if (v[current_idx] == 0xfa) // Single-Precision Float
        {
            // copy bytes in reverse order into the float variable
            float res;
            for (size_t byte = 0; byte < sizeof(float); ++byte)
            {
                reinterpret_cast<uint8_t*>(&res)[sizeof(float) - byte - 1] = v[current_idx + 1 + byte];
            }
            idx += sizeof(float); // skip content bytes
            return res;
        }
        else if (v[current_idx] == 0xfb) // Double-Precision Float
        {
            // copy bytes in reverse order into the double variable
            double res;
            for (size_t byte = 0; byte < sizeof(double); ++byte)
            {
                reinterpret_cast<uint8_t*>(&res)[sizeof(double) - byte - 1] = v[current_idx + 1 + byte];
            }
            idx += sizeof(double); // skip content bytes
            return res;
        }

        // 40..57 byte string
        // 58 byte string
        // 59 byte string
        // 5a byte string
        // 5b byte string
        // 5f byte string
        // 7f UTF-8 string with break
        // 9f array with break
        // bf map with break
        // c0 Text-based date/time
        // c1 Epoch-based date/time
        // c2 Positive bignum
        // c3 Positive bignum
        // c4 Decimal Fraction
        // c5 Bigfloat
        // c6..d4 tagged item
        // d5..d7 Expected Conversion
        // d8..db more tagged items
        // e0..f3 simple value
        // f7 undefined
        // f8 simple value
        // f9 half-precision float
        // ff break stop code

        throw std::invalid_argument("error parsing a CBOR @ " + std::to_string(current_idx) + ": " + std::to_string(v[current_idx]));
    }

N
Niels 已提交
7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153
  public:
    /*!
    @param[in] j  JSON value to serialize
    @retuen MessagePack serialization as char vector
    */
    static std::vector<uint8_t> to_msgpack(const basic_json& j)
    {
        std::vector<uint8_t> result;
        to_msgpack_internal(j, result);
        return result;
    }

    static basic_json from_msgpack(const std::vector<uint8_t>& v)
    {
        size_t i = 0;
        return from_msgpack_internal(v, i);
    }

N
Niels Lohmann 已提交
7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170
    /*!
    @param[in] j  JSON value to serialize
    @retuen CBOR serialization as char vector
    */
    static std::vector<uint8_t> to_cbor(const basic_json& j)
    {
        std::vector<uint8_t> result;
        to_cbor_internal(j, result);
        return result;
    }

    static basic_json from_cbor(const std::vector<uint8_t>& v)
    {
        size_t i = 0;
        return from_cbor_internal(v, i);
    }

N
Niels 已提交
7171
    /// @}
N
Niels 已提交
7172

N
cleanup  
Niels 已提交
7173 7174 7175 7176 7177
  private:
    ///////////////////////////
    // convenience functions //
    ///////////////////////////

N
Niels 已提交
7178 7179 7180 7181 7182 7183
    /*!
    @brief return the type as string

    Returns the type name as string to be used in error messages - usually to
    indicate that a function was called on a wrong JSON type.

N
Niels 已提交
7184
    @return basically a string representation of a the @a m_type member
N
Niels 已提交
7185 7186 7187 7188 7189

    @complexity Constant.

    @since version 1.0.0
    */
N
Niels 已提交
7190
    std::string type_name() const
N
cleanup  
Niels 已提交
7191 7192 7193
    {
        switch (m_type)
        {
7194
            case value_t::null:
N
cleanup  
Niels 已提交
7195
                return "null";
7196
            case value_t::object:
N
cleanup  
Niels 已提交
7197
                return "object";
7198
            case value_t::array:
N
cleanup  
Niels 已提交
7199
                return "array";
7200
            case value_t::string:
N
cleanup  
Niels 已提交
7201
                return "string";
7202
            case value_t::boolean:
N
cleanup  
Niels 已提交
7203
                return "boolean";
7204
            case value_t::discarded:
N
Niels 已提交
7205
                return "discarded";
N
Niels 已提交
7206
            default:
N
cleanup  
Niels 已提交
7207 7208 7209 7210
                return "number";
        }
    }

N
Niels 已提交
7211 7212 7213 7214 7215 7216 7217 7218 7219 7220
    /*!
    @brief calculates the extra space to escape a JSON string

    @param[in] s  the string to escape
    @return the number of characters required to escape string @a s

    @complexity Linear in the length of string @a s.
    */
    static std::size_t extra_space(const string_t& s) noexcept
    {
N
Niels 已提交
7221 7222
        return std::accumulate(s.begin(), s.end(), size_t{},
                               [](size_t res, typename string_t::value_type c)
N
Niels 已提交
7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234
        {
            switch (c)
            {
                case '"':
                case '\\':
                case '\b':
                case '\f':
                case '\n':
                case '\r':
                case '\t':
                {
                    // from c (1 byte) to \x (2 bytes)
N
Niels 已提交
7235
                    return res + 1;
N
Niels 已提交
7236 7237 7238 7239 7240 7241 7242
                }

                default:
                {
                    if (c >= 0x00 and c <= 0x1f)
                    {
                        // from c (1 byte) to \uxxxx (6 bytes)
N
Niels 已提交
7243 7244 7245 7246 7247
                        return res + 5;
                    }
                    else
                    {
                        return res;
N
Niels 已提交
7248 7249 7250
                    }
                }
            }
N
Niels 已提交
7251
        });
N
Niels 已提交
7252 7253
    }

N
Niels 已提交
7254
    /*!
N
Niels 已提交
7255
    @brief escape a string
N
Niels 已提交
7256

N
Niels 已提交
7257 7258
    Escape a string by replacing certain special characters by a sequence of
    an escape character (backslash) and another character and other control
N
Niels 已提交
7259 7260 7261
    characters by a sequence of "\u" followed by a four-digit hex
    representation.

N
Niels 已提交
7262
    @param[in] s  the string to escape
N
Niels 已提交
7263 7264 7265
    @return  the escaped string

    @complexity Linear in the length of string @a s.
N
Niels 已提交
7266
    */
N
Niels 已提交
7267
    static string_t escape_string(const string_t& s)
N
Niels 已提交
7268
    {
N
Niels 已提交
7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279
        const auto space = extra_space(s);
        if (space == 0)
        {
            return s;
        }

        // create a result string of necessary size
        string_t result(s.size() + space, '\\');
        std::size_t pos = 0;

        for (const auto& c : s)
N
Niels 已提交
7280 7281 7282
        {
            switch (c)
            {
N
Niels 已提交
7283
                // quotation mark (0x22)
N
Niels 已提交
7284 7285
                case '"':
                {
N
Niels 已提交
7286 7287
                    result[pos + 1] = '"';
                    pos += 2;
N
Niels 已提交
7288 7289
                    break;
                }
N
Niels 已提交
7290

N
Niels 已提交
7291
                // reverse solidus (0x5c)
N
Niels 已提交
7292 7293
                case '\\':
                {
N
Niels 已提交
7294 7295
                    // nothing to change
                    pos += 2;
N
Niels 已提交
7296 7297
                    break;
                }
N
Niels 已提交
7298

N
Niels 已提交
7299
                // backspace (0x08)
N
Niels 已提交
7300 7301
                case '\b':
                {
N
Niels 已提交
7302 7303
                    result[pos + 1] = 'b';
                    pos += 2;
N
Niels 已提交
7304 7305
                    break;
                }
N
Niels 已提交
7306

N
Niels 已提交
7307
                // formfeed (0x0c)
N
Niels 已提交
7308 7309
                case '\f':
                {
N
Niels 已提交
7310 7311
                    result[pos + 1] = 'f';
                    pos += 2;
N
Niels 已提交
7312 7313
                    break;
                }
N
Niels 已提交
7314

N
Niels 已提交
7315
                // newline (0x0a)
N
Niels 已提交
7316 7317
                case '\n':
                {
N
Niels 已提交
7318 7319
                    result[pos + 1] = 'n';
                    pos += 2;
N
Niels 已提交
7320 7321
                    break;
                }
N
Niels 已提交
7322

N
Niels 已提交
7323
                // carriage return (0x0d)
N
Niels 已提交
7324 7325
                case '\r':
                {
N
Niels 已提交
7326 7327
                    result[pos + 1] = 'r';
                    pos += 2;
N
Niels 已提交
7328 7329
                    break;
                }
N
Niels 已提交
7330

N
Niels 已提交
7331
                // horizontal tab (0x09)
N
Niels 已提交
7332 7333
                case '\t':
                {
N
Niels 已提交
7334 7335
                    result[pos + 1] = 't';
                    pos += 2;
N
Niels 已提交
7336 7337
                    break;
                }
N
Niels 已提交
7338

N
Niels 已提交
7339 7340
                default:
                {
7341
                    if (c >= 0x00 and c <= 0x1f)
N
Niels 已提交
7342
                    {
N
Niels 已提交
7343 7344
                        // convert a number 0..15 to its hex representation
                        // (0..f)
N
Niels 已提交
7345
                        static const char hexify[16] =
7346
                        {
N
Niels 已提交
7347 7348
                            '0', '1', '2', '3', '4', '5', '6', '7',
                            '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'
7349 7350
                        };

N
Niels 已提交
7351
                        // print character c as \uxxxx
N
Niels 已提交
7352
                        for (const char m :
N
Niels 已提交
7353
                    { 'u', '0', '0', hexify[c >> 4], hexify[c & 0x0f]
N
Niels 已提交
7354
                        })
7355 7356 7357 7358 7359
                        {
                            result[++pos] = m;
                        }

                        ++pos;
N
Niels 已提交
7360 7361 7362 7363
                    }
                    else
                    {
                        // all other characters are added as-is
N
Niels 已提交
7364
                        result[pos++] = c;
N
Niels 已提交
7365 7366
                    }
                    break;
N
Niels 已提交
7367 7368 7369
                }
            }
        }
N
Niels 已提交
7370 7371

        return result;
N
Niels 已提交
7372 7373
    }

N
cleanup  
Niels 已提交
7374
    /*!
N
Niels 已提交
7375
    @brief internal implementation of the serialization function
N
Niels 已提交
7376

N
Niels 已提交
7377
    This function is called by the public member function dump and organizes
N
Niels 已提交
7378
    the serialization internally. The indentation level is propagated as
N
Niels 已提交
7379 7380
    additional parameter. In case of arrays and objects, the function is
    called recursively. Note that
N
Niels 已提交
7381

N
Niels 已提交
7382 7383 7384
    - strings and object keys are escaped using `escape_string()`
    - integer numbers are converted implicitly via `operator<<`
    - floating-point numbers are converted to a string using `"%g"` format
N
cleanup  
Niels 已提交
7385

N
Niels 已提交
7386 7387 7388 7389
    @param[out] o              stream to write to
    @param[in] pretty_print    whether the output shall be pretty-printed
    @param[in] indent_step     the indent level
    @param[in] current_indent  the current indent level (only used internally)
N
cleanup  
Niels 已提交
7390
    */
N
Niels 已提交
7391 7392 7393
    void dump(std::ostream& o,
              const bool pretty_print,
              const unsigned int indent_step,
N
Niels 已提交
7394
              const unsigned int current_indent = 0) const
N
cleanup  
Niels 已提交
7395
    {
N
Niels 已提交
7396
        // variable to hold indentation for recursive calls
N
Niels 已提交
7397
        unsigned int new_indent = current_indent;
N
Niels 已提交
7398

N
cleanup  
Niels 已提交
7399 7400
        switch (m_type)
        {
7401
            case value_t::object:
N
cleanup  
Niels 已提交
7402 7403 7404
            {
                if (m_value.object->empty())
                {
N
Niels 已提交
7405 7406
                    o << "{}";
                    return;
N
cleanup  
Niels 已提交
7407 7408
                }

N
Niels 已提交
7409
                o << "{";
N
cleanup  
Niels 已提交
7410 7411

                // increase indentation
N
Niels 已提交
7412
                if (pretty_print)
N
cleanup  
Niels 已提交
7413
                {
N
Niels 已提交
7414
                    new_indent += indent_step;
N
Niels 已提交
7415
                    o << "\n";
N
cleanup  
Niels 已提交
7416 7417
                }

N
Niels 已提交
7418
                for (auto i = m_value.object->cbegin(); i != m_value.object->cend(); ++i)
N
cleanup  
Niels 已提交
7419
                {
N
Niels 已提交
7420
                    if (i != m_value.object->cbegin())
N
cleanup  
Niels 已提交
7421
                    {
N
Niels 已提交
7422
                        o << (pretty_print ? ",\n" : ",");
N
cleanup  
Niels 已提交
7423
                    }
N
Niels 已提交
7424 7425 7426
                    o << string_t(new_indent, ' ') << "\""
                      << escape_string(i->first) << "\":"
                      << (pretty_print ? " " : "");
N
Niels 已提交
7427
                    i->second.dump(o, pretty_print, indent_step, new_indent);
N
cleanup  
Niels 已提交
7428 7429 7430
                }

                // decrease indentation
N
Niels 已提交
7431
                if (pretty_print)
N
cleanup  
Niels 已提交
7432
                {
N
Niels 已提交
7433
                    new_indent -= indent_step;
N
Niels 已提交
7434
                    o << "\n";
N
cleanup  
Niels 已提交
7435 7436
                }

N
Niels 已提交
7437 7438
                o << string_t(new_indent, ' ') + "}";
                return;
N
cleanup  
Niels 已提交
7439 7440
            }

7441
            case value_t::array:
N
cleanup  
Niels 已提交
7442 7443 7444
            {
                if (m_value.array->empty())
                {
N
Niels 已提交
7445 7446
                    o << "[]";
                    return;
N
cleanup  
Niels 已提交
7447 7448
                }

N
Niels 已提交
7449
                o << "[";
N
cleanup  
Niels 已提交
7450 7451

                // increase indentation
N
Niels 已提交
7452
                if (pretty_print)
N
cleanup  
Niels 已提交
7453
                {
N
Niels 已提交
7454
                    new_indent += indent_step;
N
Niels 已提交
7455
                    o << "\n";
N
cleanup  
Niels 已提交
7456 7457
                }

N
Niels 已提交
7458
                for (auto i = m_value.array->cbegin(); i != m_value.array->cend(); ++i)
N
cleanup  
Niels 已提交
7459
                {
N
Niels 已提交
7460
                    if (i != m_value.array->cbegin())
N
cleanup  
Niels 已提交
7461
                    {
N
Niels 已提交
7462
                        o << (pretty_print ? ",\n" : ",");
N
cleanup  
Niels 已提交
7463
                    }
N
Niels 已提交
7464
                    o << string_t(new_indent, ' ');
N
Niels 已提交
7465
                    i->dump(o, pretty_print, indent_step, new_indent);
N
cleanup  
Niels 已提交
7466 7467 7468
                }

                // decrease indentation
N
Niels 已提交
7469
                if (pretty_print)
N
cleanup  
Niels 已提交
7470
                {
N
Niels 已提交
7471
                    new_indent -= indent_step;
N
Niels 已提交
7472
                    o << "\n";
N
cleanup  
Niels 已提交
7473 7474
                }

N
Niels 已提交
7475 7476
                o << string_t(new_indent, ' ') << "]";
                return;
N
cleanup  
Niels 已提交
7477 7478
            }

7479
            case value_t::string:
N
cleanup  
Niels 已提交
7480
            {
N
Niels 已提交
7481
                o << string_t("\"") << escape_string(*m_value.string) << "\"";
N
Niels 已提交
7482
                return;
N
cleanup  
Niels 已提交
7483 7484
            }

7485
            case value_t::boolean:
N
cleanup  
Niels 已提交
7486
            {
N
Niels 已提交
7487 7488
                o << (m_value.boolean ? "true" : "false");
                return;
N
cleanup  
Niels 已提交
7489 7490
            }

7491
            case value_t::number_integer:
N
cleanup  
Niels 已提交
7492
            {
N
Niels 已提交
7493 7494
                o << m_value.number_integer;
                return;
N
cleanup  
Niels 已提交
7495 7496
            }

7497 7498 7499 7500 7501 7502
            case value_t::number_unsigned:
            {
                o << m_value.number_unsigned;
                return;
            }

7503
            case value_t::number_float:
N
cleanup  
Niels 已提交
7504
            {
N
Niels 已提交
7505
                if (m_value.number_float == 0)
N
Niels 已提交
7506
                {
N
Niels 已提交
7507 7508
                    // special case for zero to get "0.0"/"-0.0"
                    o << (std::signbit(m_value.number_float) ? "-0.0" : "0.0");
N
Niels 已提交
7509
                }
N
Niels 已提交
7510
                else
N
Niels 已提交
7511
                {
7512
                    o << m_value.number_float;
N
Niels 已提交
7513
                }
N
Niels 已提交
7514
                return;
N
cleanup  
Niels 已提交
7515
            }
N
Niels 已提交
7516

7517
            case value_t::discarded:
N
Niels 已提交
7518
            {
N
Niels 已提交
7519 7520
                o << "<discarded>";
                return;
N
Niels 已提交
7521
            }
N
Niels 已提交
7522

7523
            case value_t::null:
N
Niels 已提交
7524
            {
N
Niels 已提交
7525 7526
                o << "null";
                return;
N
Niels 已提交
7527
            }
N
cleanup  
Niels 已提交
7528 7529 7530 7531 7532 7533 7534 7535 7536
        }
    }

  private:
    //////////////////////
    // member variables //
    //////////////////////

    /// the type of the current element
N
Niels 已提交
7537
    value_t m_type = value_t::null;
N
cleanup  
Niels 已提交
7538 7539 7540 7541

    /// the value of the current element
    json_value m_value = {};

N
Niels 已提交
7542

N
Niels 已提交
7543
  private:
N
cleanup  
Niels 已提交
7544 7545 7546 7547
    ///////////////
    // iterators //
    ///////////////

7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560
    /*!
    @brief an iterator for primitive JSON types

    This class models an iterator for primitive JSON types (boolean, number,
    string). It's only purpose is to allow the iterator/const_iterator classes
    to "iterate" over primitive values. Internally, the iterator is modeled by
    a `difference_type` variable. Value begin_value (`0`) models the begin,
    end_value (`1`) models past the end.
    */
    class primitive_iterator_t
    {
      public:
        /// set iterator to a defined beginning
N
Niels 已提交
7561
        void set_begin() noexcept
7562 7563 7564 7565 7566
        {
            m_it = begin_value;
        }

        /// set iterator to a defined past the end
N
Niels 已提交
7567
        void set_end() noexcept
7568 7569 7570 7571 7572
        {
            m_it = end_value;
        }

        /// return whether the iterator can be dereferenced
N
Niels 已提交
7573
        constexpr bool is_begin() const noexcept
7574 7575 7576 7577 7578
        {
            return (m_it == begin_value);
        }

        /// return whether the iterator is at end
N
Niels 已提交
7579
        constexpr bool is_end() const noexcept
7580 7581 7582 7583 7584
        {
            return (m_it == end_value);
        }

        /// return reference to the value to change and compare
N
Niels 已提交
7585
        operator difference_type& () noexcept
7586 7587 7588 7589 7590
        {
            return m_it;
        }

        /// return value to compare
N
Niels 已提交
7591
        constexpr operator difference_type () const noexcept
7592 7593 7594 7595 7596 7597 7598 7599 7600
        {
            return m_it;
        }

      private:
        static constexpr difference_type begin_value = 0;
        static constexpr difference_type end_value = begin_value + 1;

        /// iterator as signed integer type
N
Niels 已提交
7601
        difference_type m_it = std::numeric_limits<std::ptrdiff_t>::denorm_min();
7602 7603
    };

N
Niels 已提交
7604 7605 7606 7607 7608 7609 7610 7611
    /*!
    @brief an iterator value

    @note This structure could easily be a union, but MSVC currently does not
    allow unions members with complex constructors, see
    https://github.com/nlohmann/json/pull/105.
    */
    struct internal_iterator
N
Niels 已提交
7612 7613
    {
        /// iterator for JSON objects
N
Niels 已提交
7614
        typename object_t::iterator object_iterator;
N
Niels 已提交
7615
        /// iterator for JSON arrays
N
Niels 已提交
7616
        typename array_t::iterator array_iterator;
N
Niels 已提交
7617
        /// generic iterator for all other types
N
Niels 已提交
7618 7619 7620
        primitive_iterator_t primitive_iterator;

        /// create an uninitialized internal_iterator
N
Niels 已提交
7621
        internal_iterator() noexcept
N
Niels 已提交
7622 7623
            : object_iterator(), array_iterator(), primitive_iterator()
        {}
N
Niels 已提交
7624 7625
    };

N
cleanup  
Niels 已提交
7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640
    /// proxy class for the iterator_wrapper functions
    template<typename IteratorType>
    class iteration_proxy
    {
      private:
        /// helper class for iteration
        class iteration_proxy_internal
        {
          private:
            /// the iterator
            IteratorType anchor;
            /// an index for arrays (used to create key names)
            size_t array_index = 0;

          public:
N
Niels 已提交
7641
            explicit iteration_proxy_internal(IteratorType it) noexcept
N
cleanup  
Niels 已提交
7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660
                : anchor(it)
            {}

            /// dereference operator (needed for range-based for)
            iteration_proxy_internal& operator*()
            {
                return *this;
            }

            /// increment operator (needed for range-based for)
            iteration_proxy_internal& operator++()
            {
                ++anchor;
                ++array_index;

                return *this;
            }

            /// inequality operator (needed for range-based for)
N
Niels 已提交
7661
            bool operator!= (const iteration_proxy_internal& o) const
N
cleanup  
Niels 已提交
7662 7663 7664 7665 7666 7667 7668
            {
                return anchor != o.anchor;
            }

            /// return key of the iterator
            typename basic_json::string_t key() const
            {
N
Niels 已提交
7669 7670
                assert(anchor.m_object != nullptr);

N
cleanup  
Niels 已提交
7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704
                switch (anchor.m_object->type())
                {
                    // use integer array index as key
                    case value_t::array:
                    {
                        return std::to_string(array_index);
                    }

                    // use key from the object
                    case value_t::object:
                    {
                        return anchor.key();
                    }

                    // use an empty key for all primitive types
                    default:
                    {
                        return "";
                    }
                }
            }

            /// return value of the iterator
            typename IteratorType::reference value() const
            {
                return anchor.value();
            }
        };

        /// the container to iterate
        typename IteratorType::reference container;

      public:
        /// construct iteration proxy from a container
N
Niels 已提交
7705
        explicit iteration_proxy(typename IteratorType::reference cont)
N
cleanup  
Niels 已提交
7706 7707 7708 7709
            : container(cont)
        {}

        /// return iterator begin (needed for range-based for)
N
Niels 已提交
7710
        iteration_proxy_internal begin() noexcept
N
cleanup  
Niels 已提交
7711 7712 7713 7714 7715
        {
            return iteration_proxy_internal(container.begin());
        }

        /// return iterator end (needed for range-based for)
N
Niels 已提交
7716
        iteration_proxy_internal end() noexcept
N
cleanup  
Niels 已提交
7717 7718 7719 7720 7721
        {
            return iteration_proxy_internal(container.end());
        }
    };

N
Niels 已提交
7722
  public:
N
Niels 已提交
7723 7724 7725 7726 7727 7728
    /*!
    @brief a const random access iterator for the @ref basic_json class

    This class implements a const iterator for the @ref basic_json class. From
    this class, the @ref iterator class is derived.

N
Niels 已提交
7729 7730 7731
    @note An iterator is called *initialized* when a pointer to a JSON value
          has been set (e.g., by a constructor or a copy assignment). If the
          iterator is default-constructed, it is *uninitialized* and most
N
Niels 已提交
7732 7733
          methods are undefined. **The library uses assertions to detect calls
          on uninitialized iterators.**
N
Niels 已提交
7734

N
Niels 已提交
7735 7736 7737 7738
    @requirement The class satisfies the following concept requirements:
    - [RandomAccessIterator](http://en.cppreference.com/w/cpp/concept/RandomAccessIterator):
      The iterator that can be moved to point (forward and backward) to any
      element in constant time.
N
Niels 已提交
7739

N
Niels 已提交
7740
    @since version 1.0.0
N
Niels 已提交
7741
    */
N
Niels 已提交
7742
    class const_iterator : public std::iterator<std::random_access_iterator_tag, const basic_json>
N
cleanup  
Niels 已提交
7743
    {
N
Niels 已提交
7744
        /// allow basic_json to access private members
7745 7746
        friend class basic_json;

N
cleanup  
Niels 已提交
7747 7748
      public:
        /// the type of the values when the iterator is dereferenced
N
Niels 已提交
7749
        using value_type = typename basic_json::value_type;
N
cleanup  
Niels 已提交
7750
        /// a type to represent differences between iterators
N
Niels 已提交
7751
        using difference_type = typename basic_json::difference_type;
N
cleanup  
Niels 已提交
7752
        /// defines a pointer to the type iterated over (value_type)
N
Niels 已提交
7753
        using pointer = typename basic_json::const_pointer;
N
cleanup  
Niels 已提交
7754
        /// defines a reference to the type iterated over (value_type)
N
Niels 已提交
7755
        using reference = typename basic_json::const_reference;
N
cleanup  
Niels 已提交
7756
        /// the category of the iterator
N
Niels 已提交
7757
        using iterator_category = std::bidirectional_iterator_tag;
N
cleanup  
Niels 已提交
7758

7759
        /// default constructor
N
Niels 已提交
7760
        const_iterator() = default;
7761

N
Niels 已提交
7762 7763 7764 7765 7766 7767
        /*!
        @brief constructor for a given JSON instance
        @param[in] object  pointer to a JSON object for this iterator
        @pre object != nullptr
        @post The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7768 7769
        explicit const_iterator(pointer object) noexcept
            : m_object(object)
N
cleanup  
Niels 已提交
7770
        {
N
Niels 已提交
7771 7772
            assert(m_object != nullptr);

N
cleanup  
Niels 已提交
7773 7774
            switch (m_object->m_type)
            {
7775
                case basic_json::value_t::object:
N
cleanup  
Niels 已提交
7776 7777 7778 7779
                {
                    m_it.object_iterator = typename object_t::iterator();
                    break;
                }
7780 7781

                case basic_json::value_t::array:
N
cleanup  
Niels 已提交
7782 7783 7784 7785
                {
                    m_it.array_iterator = typename array_t::iterator();
                    break;
                }
7786

N
cleanup  
Niels 已提交
7787 7788
                default:
                {
7789
                    m_it.primitive_iterator = primitive_iterator_t();
N
cleanup  
Niels 已提交
7790 7791 7792 7793 7794
                    break;
                }
            }
        }

N
Niels 已提交
7795 7796 7797 7798 7799
        /*!
        @brief copy constructor given a non-const iterator
        @param[in] other  iterator to copy from
        @note It is not checked whether @a other is initialized.
        */
N
Niels 已提交
7800 7801
        explicit const_iterator(const iterator& other) noexcept
            : m_object(other.m_object)
N
Niels 已提交
7802
        {
N
Niels 已提交
7803
            if (m_object != nullptr)
N
Niels 已提交
7804
            {
N
Niels 已提交
7805
                switch (m_object->m_type)
N
Niels 已提交
7806
                {
N
Niels 已提交
7807 7808 7809 7810 7811
                    case basic_json::value_t::object:
                    {
                        m_it.object_iterator = other.m_it.object_iterator;
                        break;
                    }
N
Niels 已提交
7812

N
Niels 已提交
7813 7814 7815 7816 7817
                    case basic_json::value_t::array:
                    {
                        m_it.array_iterator = other.m_it.array_iterator;
                        break;
                    }
N
Niels 已提交
7818

N
Niels 已提交
7819 7820 7821 7822 7823
                    default:
                    {
                        m_it.primitive_iterator = other.m_it.primitive_iterator;
                        break;
                    }
N
Niels 已提交
7824 7825 7826 7827
                }
            }
        }

N
Niels 已提交
7828 7829 7830 7831 7832
        /*!
        @brief copy constructor
        @param[in] other  iterator to copy from
        @note It is not checked whether @a other is initialized.
        */
N
Niels 已提交
7833
        const_iterator(const const_iterator& other) noexcept
N
Niels 已提交
7834 7835 7836
            : m_object(other.m_object), m_it(other.m_it)
        {}

N
Niels 已提交
7837 7838 7839 7840 7841
        /*!
        @brief copy assignment
        @param[in,out] other  iterator to copy from
        @note It is not checked whether @a other is initialized.
        */
N
Niels 已提交
7842
        const_iterator& operator=(const_iterator other) noexcept(
N
Niels 已提交
7843 7844
            std::is_nothrow_move_constructible<pointer>::value and
            std::is_nothrow_move_assignable<pointer>::value and
N
Niels 已提交
7845 7846
            std::is_nothrow_move_constructible<internal_iterator>::value and
            std::is_nothrow_move_assignable<internal_iterator>::value
N
Niels 已提交
7847 7848 7849 7850
        )
        {
            std::swap(m_object, other.m_object);
            std::swap(m_it, other.m_it);
N
cleanup  
Niels 已提交
7851 7852 7853
            return *this;
        }

N
Niels 已提交
7854
      private:
N
Niels 已提交
7855 7856 7857 7858
        /*!
        @brief set the iterator to the first value
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7859
        void set_begin() noexcept
N
cleanup  
Niels 已提交
7860
        {
N
Niels 已提交
7861 7862
            assert(m_object != nullptr);

N
cleanup  
Niels 已提交
7863 7864
            switch (m_object->m_type)
            {
7865
                case basic_json::value_t::object:
N
cleanup  
Niels 已提交
7866 7867 7868 7869 7870
                {
                    m_it.object_iterator = m_object->m_value.object->begin();
                    break;
                }

7871
                case basic_json::value_t::array:
N
cleanup  
Niels 已提交
7872 7873 7874 7875 7876
                {
                    m_it.array_iterator = m_object->m_value.array->begin();
                    break;
                }

7877
                case basic_json::value_t::null:
N
cleanup  
Niels 已提交
7878
                {
N
Niels 已提交
7879
                    // set to end so begin()==end() is true: null is empty
7880
                    m_it.primitive_iterator.set_end();
N
cleanup  
Niels 已提交
7881 7882 7883 7884 7885
                    break;
                }

                default:
                {
7886
                    m_it.primitive_iterator.set_begin();
N
cleanup  
Niels 已提交
7887 7888 7889 7890 7891
                    break;
                }
            }
        }

N
Niels 已提交
7892 7893 7894 7895
        /*!
        @brief set the iterator past the last value
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7896
        void set_end() noexcept
N
cleanup  
Niels 已提交
7897
        {
N
Niels 已提交
7898 7899
            assert(m_object != nullptr);

N
cleanup  
Niels 已提交
7900 7901
            switch (m_object->m_type)
            {
7902
                case basic_json::value_t::object:
N
cleanup  
Niels 已提交
7903 7904 7905 7906 7907
                {
                    m_it.object_iterator = m_object->m_value.object->end();
                    break;
                }

7908
                case basic_json::value_t::array:
N
cleanup  
Niels 已提交
7909 7910 7911 7912 7913 7914 7915
                {
                    m_it.array_iterator = m_object->m_value.array->end();
                    break;
                }

                default:
                {
7916
                    m_it.primitive_iterator.set_end();
N
cleanup  
Niels 已提交
7917 7918 7919 7920 7921
                    break;
                }
            }
        }

N
Niels 已提交
7922
      public:
N
Niels 已提交
7923 7924 7925 7926
        /*!
        @brief return a reference to the value pointed to by the iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7927
        reference operator*() const
N
cleanup  
Niels 已提交
7928
        {
N
Niels 已提交
7929 7930
            assert(m_object != nullptr);

N
cleanup  
Niels 已提交
7931 7932
            switch (m_object->m_type)
            {
7933
                case basic_json::value_t::object:
N
cleanup  
Niels 已提交
7934
                {
N
Niels 已提交
7935
                    assert(m_it.object_iterator != m_object->m_value.object->end());
N
cleanup  
Niels 已提交
7936 7937 7938
                    return m_it.object_iterator->second;
                }

7939
                case basic_json::value_t::array:
N
cleanup  
Niels 已提交
7940
                {
N
Niels 已提交
7941
                    assert(m_it.array_iterator != m_object->m_value.array->end());
N
cleanup  
Niels 已提交
7942 7943 7944
                    return *m_it.array_iterator;
                }

7945
                case basic_json::value_t::null:
N
cleanup  
Niels 已提交
7946 7947 7948 7949 7950 7951
                {
                    throw std::out_of_range("cannot get value");
                }

                default:
                {
7952 7953 7954 7955 7956 7957 7958 7959
                    if (m_it.primitive_iterator.is_begin())
                    {
                        return *m_object;
                    }
                    else
                    {
                        throw std::out_of_range("cannot get value");
                    }
N
cleanup  
Niels 已提交
7960 7961 7962 7963
                }
            }
        }

N
Niels 已提交
7964 7965 7966 7967
        /*!
        @brief dereference the iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7968
        pointer operator->() const
N
cleanup  
Niels 已提交
7969
        {
N
Niels 已提交
7970 7971
            assert(m_object != nullptr);

N
cleanup  
Niels 已提交
7972 7973
            switch (m_object->m_type)
            {
7974
                case basic_json::value_t::object:
N
cleanup  
Niels 已提交
7975
                {
N
Niels 已提交
7976
                    assert(m_it.object_iterator != m_object->m_value.object->end());
N
cleanup  
Niels 已提交
7977 7978 7979
                    return &(m_it.object_iterator->second);
                }

7980
                case basic_json::value_t::array:
N
cleanup  
Niels 已提交
7981
                {
N
Niels 已提交
7982
                    assert(m_it.array_iterator != m_object->m_value.array->end());
N
cleanup  
Niels 已提交
7983 7984 7985 7986 7987
                    return &*m_it.array_iterator;
                }

                default:
                {
7988 7989 7990 7991 7992 7993 7994 7995
                    if (m_it.primitive_iterator.is_begin())
                    {
                        return m_object;
                    }
                    else
                    {
                        throw std::out_of_range("cannot get value");
                    }
N
cleanup  
Niels 已提交
7996 7997 7998 7999
                }
            }
        }

N
Niels 已提交
8000 8001 8002 8003
        /*!
        @brief post-increment (it++)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
8004
        const_iterator operator++(int)
N
cleanup  
Niels 已提交
8005
        {
N
Niels 已提交
8006
            auto result = *this;
N
Niels 已提交
8007
            ++(*this);
N
cleanup  
Niels 已提交
8008 8009 8010
            return result;
        }

N
Niels 已提交
8011 8012 8013 8014
        /*!
        @brief pre-increment (++it)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
8015
        const_iterator& operator++()
N
cleanup  
Niels 已提交
8016
        {
N
Niels 已提交
8017 8018
            assert(m_object != nullptr);

N
cleanup  
Niels 已提交
8019 8020
            switch (m_object->m_type)
            {
8021
                case basic_json::value_t::object:
N
cleanup  
Niels 已提交
8022
                {
N
Niels 已提交
8023
                    std::advance(m_it.object_iterator, 1);
N
cleanup  
Niels 已提交
8024 8025 8026
                    break;
                }

8027
                case basic_json::value_t::array:
N
cleanup  
Niels 已提交
8028
                {
N
Niels 已提交
8029
                    std::advance(m_it.array_iterator, 1);
N
cleanup  
Niels 已提交
8030 8031 8032 8033 8034
                    break;
                }

                default:
                {
8035
                    ++m_it.primitive_iterator;
N
cleanup  
Niels 已提交
8036 8037 8038 8039 8040 8041 8042
                    break;
                }
            }

            return *this;
        }

N
Niels 已提交
8043 8044 8045 8046
        /*!
        @brief post-decrement (it--)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
8047
        const_iterator operator--(int)
N
cleanup  
Niels 已提交
8048
        {
N
Niels 已提交
8049
            auto result = *this;
N
Niels 已提交
8050
            --(*this);
N
cleanup  
Niels 已提交
8051 8052 8053
            return result;
        }

N
Niels 已提交
8054 8055 8056 8057
        /*!
        @brief pre-decrement (--it)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
8058
        const_iterator& operator--()
N
cleanup  
Niels 已提交
8059
        {
N
Niels 已提交
8060 8061
            assert(m_object != nullptr);

N
cleanup  
Niels 已提交
8062 8063
            switch (m_object->m_type)
            {
8064
                case basic_json::value_t::object:
N
cleanup  
Niels 已提交
8065
                {
N
Niels 已提交
8066
                    std::advance(m_it.object_iterator, -1);
N
cleanup  
Niels 已提交
8067 8068 8069
                    break;
                }

8070
                case basic_json::value_t::array:
N
cleanup  
Niels 已提交
8071
                {
N
Niels 已提交
8072
                    std::advance(m_it.array_iterator, -1);
N
cleanup  
Niels 已提交
8073 8074 8075 8076 8077
                    break;
                }

                default:
                {
8078
                    --m_it.primitive_iterator;
N
cleanup  
Niels 已提交
8079 8080 8081 8082 8083 8084 8085
                    break;
                }
            }

            return *this;
        }

N
Niels 已提交
8086 8087 8088 8089
        /*!
        @brief  comparison: equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
8090
        bool operator==(const const_iterator& other) const
N
cleanup  
Niels 已提交
8091
        {
N
Niels 已提交
8092 8093
            // if objects are not the same, the comparison is undefined
            if (m_object != other.m_object)
N
cleanup  
Niels 已提交
8094
            {
N
Niels 已提交
8095
                throw std::domain_error("cannot compare iterators of different containers");
N
cleanup  
Niels 已提交
8096 8097
            }

N
Niels 已提交
8098 8099
            assert(m_object != nullptr);

N
cleanup  
Niels 已提交
8100 8101
            switch (m_object->m_type)
            {
8102
                case basic_json::value_t::object:
N
cleanup  
Niels 已提交
8103 8104 8105 8106
                {
                    return (m_it.object_iterator == other.m_it.object_iterator);
                }

8107
                case basic_json::value_t::array:
N
cleanup  
Niels 已提交
8108 8109 8110 8111 8112 8113
                {
                    return (m_it.array_iterator == other.m_it.array_iterator);
                }

                default:
                {
8114
                    return (m_it.primitive_iterator == other.m_it.primitive_iterator);
N
cleanup  
Niels 已提交
8115 8116 8117 8118
                }
            }
        }

N
Niels 已提交
8119 8120 8121 8122
        /*!
        @brief  comparison: not equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
8123
        bool operator!=(const const_iterator& other) const
N
cleanup  
Niels 已提交
8124 8125 8126 8127
        {
            return not operator==(other);
        }

N
Niels 已提交
8128 8129 8130 8131
        /*!
        @brief  comparison: smaller
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
8132
        bool operator<(const const_iterator& other) const
N
Niels 已提交
8133 8134 8135 8136 8137 8138 8139
        {
            // if objects are not the same, the comparison is undefined
            if (m_object != other.m_object)
            {
                throw std::domain_error("cannot compare iterators of different containers");
            }

N
Niels 已提交
8140 8141
            assert(m_object != nullptr);

N
Niels 已提交
8142 8143
            switch (m_object->m_type)
            {
8144
                case basic_json::value_t::object:
N
Niels 已提交
8145
                {
N
Niels 已提交
8146
                    throw std::domain_error("cannot compare order of object iterators");
N
Niels 已提交
8147 8148
                }

8149
                case basic_json::value_t::array:
N
Niels 已提交
8150 8151 8152 8153 8154 8155
                {
                    return (m_it.array_iterator < other.m_it.array_iterator);
                }

                default:
                {
8156
                    return (m_it.primitive_iterator < other.m_it.primitive_iterator);
N
Niels 已提交
8157 8158 8159 8160
                }
            }
        }

N
Niels 已提交
8161 8162 8163 8164
        /*!
        @brief  comparison: less than or equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
8165
        bool operator<=(const const_iterator& other) const
N
Niels 已提交
8166 8167 8168 8169
        {
            return not other.operator < (*this);
        }

N
Niels 已提交
8170 8171 8172 8173
        /*!
        @brief  comparison: greater than
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
8174
        bool operator>(const const_iterator& other) const
N
Niels 已提交
8175 8176 8177 8178
        {
            return not operator<=(other);
        }

N
Niels 已提交
8179 8180 8181 8182
        /*!
        @brief  comparison: greater than or equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
8183
        bool operator>=(const const_iterator& other) const
N
Niels 已提交
8184 8185 8186 8187
        {
            return not operator<(other);
        }

N
Niels 已提交
8188 8189 8190 8191
        /*!
        @brief  add to iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
8192
        const_iterator& operator+=(difference_type i)
N
Niels 已提交
8193
        {
N
Niels 已提交
8194 8195
            assert(m_object != nullptr);

N
Niels 已提交
8196 8197
            switch (m_object->m_type)
            {
8198
                case basic_json::value_t::object:
N
Niels 已提交
8199
                {
N
Niels 已提交
8200
                    throw std::domain_error("cannot use offsets with object iterators");
N
Niels 已提交
8201 8202
                }

8203
                case basic_json::value_t::array:
N
Niels 已提交
8204
                {
N
Niels 已提交
8205
                    std::advance(m_it.array_iterator, i);
N
Niels 已提交
8206 8207 8208 8209 8210
                    break;
                }

                default:
                {
8211
                    m_it.primitive_iterator += i;
N
Niels 已提交
8212 8213 8214 8215 8216 8217 8218
                    break;
                }
            }

            return *this;
        }

N
Niels 已提交
8219 8220 8221 8222
        /*!
        @brief  subtract from iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
8223
        const_iterator& operator-=(difference_type i)
N
Niels 已提交
8224 8225 8226 8227
        {
            return operator+=(-i);
        }

N
Niels 已提交
8228 8229 8230 8231
        /*!
        @brief  add to iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
8232
        const_iterator operator+(difference_type i)
N
Niels 已提交
8233 8234 8235 8236 8237 8238
        {
            auto result = *this;
            result += i;
            return result;
        }

N
Niels 已提交
8239 8240 8241 8242
        /*!
        @brief  subtract from iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
8243
        const_iterator operator-(difference_type i)
N
Niels 已提交
8244 8245 8246 8247 8248 8249
        {
            auto result = *this;
            result -= i;
            return result;
        }

N
Niels 已提交
8250 8251 8252 8253
        /*!
        @brief  return difference
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
8254
        difference_type operator-(const const_iterator& other) const
N
Niels 已提交
8255
        {
N
Niels 已提交
8256 8257
            assert(m_object != nullptr);

N
Niels 已提交
8258 8259
            switch (m_object->m_type)
            {
8260
                case basic_json::value_t::object:
N
Niels 已提交
8261
                {
N
Niels 已提交
8262
                    throw std::domain_error("cannot use offsets with object iterators");
N
Niels 已提交
8263 8264
                }

8265
                case basic_json::value_t::array:
N
Niels 已提交
8266 8267 8268 8269 8270 8271
                {
                    return m_it.array_iterator - other.m_it.array_iterator;
                }

                default:
                {
8272
                    return m_it.primitive_iterator - other.m_it.primitive_iterator;
N
Niels 已提交
8273 8274 8275 8276
                }
            }
        }

N
Niels 已提交
8277 8278 8279 8280
        /*!
        @brief  access to successor
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
8281
        reference operator[](difference_type n) const
N
Niels 已提交
8282
        {
N
Niels 已提交
8283 8284
            assert(m_object != nullptr);

N
Niels 已提交
8285 8286
            switch (m_object->m_type)
            {
8287
                case basic_json::value_t::object:
N
Niels 已提交
8288 8289 8290 8291
                {
                    throw std::domain_error("cannot use operator[] for object iterators");
                }

8292
                case basic_json::value_t::array:
N
Niels 已提交
8293
                {
N
Niels 已提交
8294
                    return *std::next(m_it.array_iterator, n);
N
Niels 已提交
8295 8296
                }

8297
                case basic_json::value_t::null:
N
Niels 已提交
8298 8299 8300 8301 8302 8303
                {
                    throw std::out_of_range("cannot get value");
                }

                default:
                {
8304 8305 8306 8307 8308 8309 8310 8311
                    if (m_it.primitive_iterator == -n)
                    {
                        return *m_object;
                    }
                    else
                    {
                        throw std::out_of_range("cannot get value");
                    }
N
Niels 已提交
8312 8313 8314 8315
                }
            }
        }

N
Niels 已提交
8316 8317 8318 8319
        /*!
        @brief  return the key of an object iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
8320
        typename object_t::key_type key() const
N
Niels 已提交
8321
        {
N
Niels 已提交
8322 8323
            assert(m_object != nullptr);

8324 8325 8326 8327 8328 8329 8330 8331
            if (m_object->is_object())
            {
                return m_it.object_iterator->first;
            }
            else
            {
                throw std::domain_error("cannot use key() for non-object iterators");
            }
N
Niels 已提交
8332 8333
        }

N
Niels 已提交
8334 8335 8336 8337
        /*!
        @brief  return the value of an iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
8338
        reference value() const
N
Niels 已提交
8339 8340 8341 8342
        {
            return operator*();
        }

N
cleanup  
Niels 已提交
8343 8344 8345 8346
      private:
        /// associated JSON instance
        pointer m_object = nullptr;
        /// the actual iterator of the associated instance
N
Niels 已提交
8347
        internal_iterator m_it = internal_iterator();
N
cleanup  
Niels 已提交
8348 8349
    };

N
Niels 已提交
8350 8351 8352 8353 8354 8355 8356 8357 8358
    /*!
    @brief a mutable random access iterator for the @ref basic_json class

    @requirement The class satisfies the following concept requirements:
    - [RandomAccessIterator](http://en.cppreference.com/w/cpp/concept/RandomAccessIterator):
      The iterator that can be moved to point (forward and backward) to any
      element in constant time.
    - [OutputIterator](http://en.cppreference.com/w/cpp/concept/OutputIterator):
      It is possible to write to the pointed-to element.
N
Niels 已提交
8359

N
Niels 已提交
8360
    @since version 1.0.0
N
Niels 已提交
8361
    */
N
Niels 已提交
8362
    class iterator : public const_iterator
N
cleanup  
Niels 已提交
8363 8364
    {
      public:
N
Niels 已提交
8365 8366 8367
        using base_iterator = const_iterator;
        using pointer = typename basic_json::pointer;
        using reference = typename basic_json::reference;
N
cleanup  
Niels 已提交
8368

8369
        /// default constructor
N
Niels 已提交
8370
        iterator() = default;
8371

N
cleanup  
Niels 已提交
8372
        /// constructor for a given JSON instance
N
Niels 已提交
8373
        explicit iterator(pointer object) noexcept
N
cleanup  
Niels 已提交
8374
            : base_iterator(object)
N
Niels 已提交
8375
        {}
N
cleanup  
Niels 已提交
8376

N
Niels 已提交
8377
        /// copy constructor
N
Niels 已提交
8378 8379
        iterator(const iterator& other) noexcept
            : base_iterator(other)
N
Niels 已提交
8380 8381
        {}

N
cleanup  
Niels 已提交
8382
        /// copy assignment
N
Niels 已提交
8383
        iterator& operator=(iterator other) noexcept(
N
Niels 已提交
8384 8385
            std::is_nothrow_move_constructible<pointer>::value and
            std::is_nothrow_move_assignable<pointer>::value and
N
Niels 已提交
8386 8387
            std::is_nothrow_move_constructible<internal_iterator>::value and
            std::is_nothrow_move_assignable<internal_iterator>::value
N
Niels 已提交
8388 8389
        )
        {
N
Niels 已提交
8390
            base_iterator::operator=(other);
N
cleanup  
Niels 已提交
8391 8392 8393
            return *this;
        }

N
Niels 已提交
8394
        /// return a reference to the value pointed to by the iterator
8395
        reference operator*() const
N
cleanup  
Niels 已提交
8396
        {
N
Niels 已提交
8397 8398
            return const_cast<reference>(base_iterator::operator*());
        }
N
cleanup  
Niels 已提交
8399

N
Niels 已提交
8400
        /// dereference the iterator
8401
        pointer operator->() const
N
Niels 已提交
8402 8403 8404
        {
            return const_cast<pointer>(base_iterator::operator->());
        }
N
cleanup  
Niels 已提交
8405

N
Niels 已提交
8406 8407 8408 8409 8410 8411 8412
        /// post-increment (it++)
        iterator operator++(int)
        {
            iterator result = *this;
            base_iterator::operator++();
            return result;
        }
N
cleanup  
Niels 已提交
8413

N
Niels 已提交
8414 8415 8416 8417 8418
        /// pre-increment (++it)
        iterator& operator++()
        {
            base_iterator::operator++();
            return *this;
N
cleanup  
Niels 已提交
8419 8420
        }

N
Niels 已提交
8421 8422
        /// post-decrement (it--)
        iterator operator--(int)
N
cleanup  
Niels 已提交
8423
        {
N
Niels 已提交
8424 8425 8426 8427
            iterator result = *this;
            base_iterator::operator--();
            return result;
        }
N
cleanup  
Niels 已提交
8428

N
Niels 已提交
8429 8430 8431 8432 8433 8434
        /// pre-decrement (--it)
        iterator& operator--()
        {
            base_iterator::operator--();
            return *this;
        }
N
Niels 已提交
8435 8436

        /// add to iterator
N
Niels 已提交
8437
        iterator& operator+=(difference_type i)
N
Niels 已提交
8438
        {
N
Niels 已提交
8439
            base_iterator::operator+=(i);
N
Niels 已提交
8440 8441 8442 8443
            return *this;
        }

        /// subtract from iterator
N
Niels 已提交
8444
        iterator& operator-=(difference_type i)
N
Niels 已提交
8445
        {
N
Niels 已提交
8446 8447
            base_iterator::operator-=(i);
            return *this;
N
Niels 已提交
8448 8449 8450
        }

        /// add to iterator
N
Niels 已提交
8451
        iterator operator+(difference_type i)
N
Niels 已提交
8452 8453 8454 8455 8456 8457 8458
        {
            auto result = *this;
            result += i;
            return result;
        }

        /// subtract from iterator
N
Niels 已提交
8459
        iterator operator-(difference_type i)
N
Niels 已提交
8460 8461 8462 8463 8464 8465
        {
            auto result = *this;
            result -= i;
            return result;
        }

N
Niels 已提交
8466
        /// return difference
N
Niels 已提交
8467
        difference_type operator-(const iterator& other) const
N
Niels 已提交
8468
        {
N
Niels 已提交
8469
            return base_iterator::operator-(other);
N
Niels 已提交
8470 8471 8472
        }

        /// access to successor
8473
        reference operator[](difference_type n) const
N
Niels 已提交
8474
        {
N
Niels 已提交
8475
            return const_cast<reference>(base_iterator::operator[](n));
N
Niels 已提交
8476 8477
        }

8478
        /// return the value of an iterator
8479
        reference value() const
N
Niels 已提交
8480
        {
N
Niels 已提交
8481
            return const_cast<reference>(base_iterator::value());
N
Niels 已提交
8482
        }
N
cleanup  
Niels 已提交
8483
    };
N
Niels 已提交
8484

N
Niels 已提交
8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498
    /*!
    @brief a template for a reverse iterator class

    @tparam Base the base iterator type to reverse. Valid types are @ref
    iterator (to create @ref reverse_iterator) and @ref const_iterator (to
    create @ref const_reverse_iterator).

    @requirement The class satisfies the following concept requirements:
    - [RandomAccessIterator](http://en.cppreference.com/w/cpp/concept/RandomAccessIterator):
      The iterator that can be moved to point (forward and backward) to any
      element in constant time.
    - [OutputIterator](http://en.cppreference.com/w/cpp/concept/OutputIterator):
      It is possible to write to the pointed-to element (only if @a Base is
      @ref iterator).
N
Niels 已提交
8499

N
Niels 已提交
8500
    @since version 1.0.0
N
Niels 已提交
8501
    */
N
Niels 已提交
8502 8503
    template<typename Base>
    class json_reverse_iterator : public std::reverse_iterator<Base>
8504 8505
    {
      public:
8506
        /// shortcut to the reverse iterator adaptor
N
Niels 已提交
8507
        using base_iterator = std::reverse_iterator<Base>;
N
Niels 已提交
8508
        /// the reference type for the pointed-to element
N
Niels 已提交
8509
        using reference = typename Base::reference;
8510

8511
        /// create reverse iterator from iterator
N
Niels 已提交
8512
        json_reverse_iterator(const typename base_iterator::iterator_type& it) noexcept
N
cleanup  
Niels 已提交
8513 8514
            : base_iterator(it)
        {}
8515 8516

        /// create reverse iterator from base class
N
Niels 已提交
8517
        json_reverse_iterator(const base_iterator& it) noexcept
N
cleanup  
Niels 已提交
8518 8519
            : base_iterator(it)
        {}
8520 8521

        /// post-increment (it++)
N
Niels 已提交
8522
        json_reverse_iterator operator++(int)
8523 8524 8525 8526 8527
        {
            return base_iterator::operator++(1);
        }

        /// pre-increment (++it)
N
Niels 已提交
8528
        json_reverse_iterator& operator++()
8529 8530 8531 8532 8533 8534
        {
            base_iterator::operator++();
            return *this;
        }

        /// post-decrement (it--)
N
Niels 已提交
8535
        json_reverse_iterator operator--(int)
8536 8537 8538 8539 8540
        {
            return base_iterator::operator--(1);
        }

        /// pre-decrement (--it)
N
Niels 已提交
8541
        json_reverse_iterator& operator--()
8542 8543 8544 8545 8546 8547
        {
            base_iterator::operator--();
            return *this;
        }

        /// add to iterator
N
Niels 已提交
8548
        json_reverse_iterator& operator+=(difference_type i)
8549 8550 8551 8552 8553 8554
        {
            base_iterator::operator+=(i);
            return *this;
        }

        /// add to iterator
N
Niels 已提交
8555
        json_reverse_iterator operator+(difference_type i) const
8556 8557 8558 8559 8560 8561 8562
        {
            auto result = *this;
            result += i;
            return result;
        }

        /// subtract from iterator
N
Niels 已提交
8563
        json_reverse_iterator operator-(difference_type i) const
8564 8565 8566 8567 8568 8569 8570
        {
            auto result = *this;
            result -= i;
            return result;
        }

        /// return difference
N
Niels 已提交
8571
        difference_type operator-(const json_reverse_iterator& other) const
8572 8573 8574 8575 8576 8577 8578 8579 8580
        {
            return this->base() - other.base();
        }

        /// access to successor
        reference operator[](difference_type n) const
        {
            return *(this->operator+(n));
        }
N
Niels 已提交
8581

8582
        /// return the key of an object iterator
8583
        typename object_t::key_type key() const
8584
        {
N
Niels 已提交
8585 8586
            auto it = --this->base();
            return it.key();
8587 8588 8589
        }

        /// return the value of an iterator
8590
        reference value() const
8591
        {
N
Niels 已提交
8592 8593
            auto it = --this->base();
            return it.operator * ();
8594 8595 8596
        }
    };

N
Niels 已提交
8597

N
Niels 已提交
8598
  private:
N
Niels 已提交
8599 8600 8601
    //////////////////////
    // lexer and parser //
    //////////////////////
N
Niels 已提交
8602

N
Niels 已提交
8603 8604 8605 8606
    /*!
    @brief lexical analysis

    This class organizes the lexical analysis during JSON deserialization. The
N
Niels 已提交
8607 8608
    core of it is a scanner generated by [re2c](http://re2c.org) that
    processes a buffer and recognizes tokens according to RFC 7159.
N
Niels 已提交
8609
    */
N
Niels 已提交
8610
    class lexer
N
Niels 已提交
8611
    {
N
Niels 已提交
8612
      public:
N
Niels 已提交
8613 8614 8615
        /// token types for the parser
        enum class token_type
        {
N
Niels 已提交
8616
            uninitialized,   ///< indicating the scanner is uninitialized
N
Niels 已提交
8617 8618 8619
            literal_true,    ///< the `true` literal
            literal_false,   ///< the `false` literal
            literal_null,    ///< the `null` literal
N
Niels 已提交
8620 8621
            value_string,    ///< a string -- use get_string() for actual value
            value_number,    ///< a number -- use get_number() for actual value
N
Niels 已提交
8622 8623 8624 8625 8626 8627
            begin_array,     ///< the character for array begin `[`
            begin_object,    ///< the character for object begin `{`
            end_array,       ///< the character for array end `]`
            end_object,      ///< the character for object end `}`
            name_separator,  ///< the name separator `:`
            value_separator, ///< the value separator `,`
N
Niels 已提交
8628 8629
            parse_error,     ///< indicating a parse error
            end_of_input     ///< indicating the end of the input buffer
N
Niels 已提交
8630 8631
        };

N
Niels 已提交
8632
        /// the char type to use in the lexer
N
Niels 已提交
8633
        using lexer_char_t = unsigned char;
N
Niels 已提交
8634

8635 8636
        /// a lexer from a buffer with given length
        lexer(const lexer_char_t* buff, const size_t len) noexcept
N
cleanup  
Niels 已提交
8637
            : m_content(buff)
N
Niels 已提交
8638
        {
N
Niels 已提交
8639
            assert(m_content != nullptr);
N
Niels 已提交
8640
            m_start = m_cursor = m_content;
8641
            m_limit = m_content + len;
N
Niels 已提交
8642
        }
N
Niels 已提交
8643

8644 8645
        /// a lexer from an input stream
        explicit lexer(std::istream& s)
N
cleanup  
Niels 已提交
8646
            : m_stream(&s), m_line_buffer()
8647
        {
8648 8649 8650 8651 8652 8653
            // immediately abort if stream is erroneous
            if (s.fail())
            {
                throw std::invalid_argument("stream error: " +  std::string(strerror(errno)));
            }

N
cleanup  
Niels 已提交
8654 8655
            // fill buffer
            fill_line_buffer();
N
Niels 已提交
8656 8657 8658 8659 8660 8661 8662 8663

            // skip UTF-8 byte-order mark
            if (m_line_buffer.size() >= 3 and m_line_buffer.substr(0, 3) == "\xEF\xBB\xBF")
            {
                m_line_buffer[0] = ' ';
                m_line_buffer[1] = ' ';
                m_line_buffer[2] = ' ';
            }
N
Niels 已提交
8664 8665
        }

N
Niels 已提交
8666
        // switch off unwanted functions (due to pointer members)
N
cleanup  
Niels 已提交
8667
        lexer() = delete;
N
Niels 已提交
8668 8669 8670
        lexer(const lexer&) = delete;
        lexer operator=(const lexer&) = delete;

N
Niels 已提交
8671
        /*!
N
Niels 已提交
8672 8673 8674 8675 8676 8677
        @brief create a string from one or two Unicode code points

        There are two cases: (1) @a codepoint1 is in the Basic Multilingual
        Plane (U+0000 through U+FFFF) and @a codepoint2 is 0, or (2)
        @a codepoint1 and @a codepoint2 are a UTF-16 surrogate pair to
        represent a code point above U+FFFF.
N
Niels 已提交
8678

N
Niels 已提交
8679 8680
        @param[in] codepoint1  the code point (can be high surrogate)
        @param[in] codepoint2  the code point (can be low surrogate or 0)
N
Niels 已提交
8681

N
Niels 已提交
8682 8683
        @return string representation of the code point; the length of the
        result string is between 1 and 4 characters.
N
Niels 已提交
8684

N
Niels 已提交
8685
        @throw std::out_of_range if code point is > 0x10ffff; example: `"code
N
Niels 已提交
8686
        points above 0x10FFFF are invalid"`
N
Niels 已提交
8687 8688
        @throw std::invalid_argument if the low surrogate is invalid; example:
        `""missing or wrong low surrogate""`
N
Niels 已提交
8689

N
Niels 已提交
8690 8691
        @complexity Constant.

N
Niels 已提交
8692 8693
        @see <http://en.wikipedia.org/wiki/UTF-8#Sample_code>
        */
8694
        static string_t to_unicode(const std::size_t codepoint1,
N
Niels 已提交
8695
                                   const std::size_t codepoint2 = 0)
N
Niels 已提交
8696
        {
N
Niels 已提交
8697
            // calculate the code point from the given code points
N
Niels 已提交
8698
            std::size_t codepoint = codepoint1;
N
Niels 已提交
8699 8700

            // check if codepoint1 is a high surrogate
N
Niels 已提交
8701 8702
            if (codepoint1 >= 0xD800 and codepoint1 <= 0xDBFF)
            {
N
Niels 已提交
8703
                // check if codepoint2 is a low surrogate
N
Niels 已提交
8704 8705 8706 8707 8708 8709 8710 8711
                if (codepoint2 >= 0xDC00 and codepoint2 <= 0xDFFF)
                {
                    codepoint =
                        // high surrogate occupies the most significant 22 bits
                        (codepoint1 << 10)
                        // low surrogate occupies the least significant 15 bits
                        + codepoint2
                        // there is still the 0xD800, 0xDC00 and 0x10000 noise
N
Niels 已提交
8712
                        // in the result so we have to subtract with:
N
Niels 已提交
8713 8714 8715 8716 8717 8718 8719 8720 8721
                        // (0xD800 << 10) + DC00 - 0x10000 = 0x35FDC00
                        - 0x35FDC00;
                }
                else
                {
                    throw std::invalid_argument("missing or wrong low surrogate");
                }
            }

N
Niels 已提交
8722 8723
            string_t result;

N
Niels 已提交
8724
            if (codepoint < 0x80)
N
Niels 已提交
8725
            {
N
Niels 已提交
8726
                // 1-byte characters: 0xxxxxxx (ASCII)
N
Niels 已提交
8727
                result.append(1, static_cast<typename string_t::value_type>(codepoint));
N
Niels 已提交
8728 8729 8730 8731
            }
            else if (codepoint <= 0x7ff)
            {
                // 2-byte characters: 110xxxxx 10xxxxxx
N
Niels 已提交
8732 8733
                result.append(1, static_cast<typename string_t::value_type>(0xC0 | ((codepoint >> 6) & 0x1F)));
                result.append(1, static_cast<typename string_t::value_type>(0x80 | (codepoint & 0x3F)));
N
Niels 已提交
8734 8735 8736 8737
            }
            else if (codepoint <= 0xffff)
            {
                // 3-byte characters: 1110xxxx 10xxxxxx 10xxxxxx
N
Niels 已提交
8738 8739 8740
                result.append(1, static_cast<typename string_t::value_type>(0xE0 | ((codepoint >> 12) & 0x0F)));
                result.append(1, static_cast<typename string_t::value_type>(0x80 | ((codepoint >> 6) & 0x3F)));
                result.append(1, static_cast<typename string_t::value_type>(0x80 | (codepoint & 0x3F)));
N
Niels 已提交
8741 8742 8743 8744
            }
            else if (codepoint <= 0x10ffff)
            {
                // 4-byte characters: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
N
Niels 已提交
8745 8746 8747 8748
                result.append(1, static_cast<typename string_t::value_type>(0xF0 | ((codepoint >> 18) & 0x07)));
                result.append(1, static_cast<typename string_t::value_type>(0x80 | ((codepoint >> 12) & 0x3F)));
                result.append(1, static_cast<typename string_t::value_type>(0x80 | ((codepoint >> 6) & 0x3F)));
                result.append(1, static_cast<typename string_t::value_type>(0x80 | (codepoint & 0x3F)));
N
Niels 已提交
8749 8750 8751
            }
            else
            {
N
Niels 已提交
8752
                throw std::out_of_range("code points above 0x10FFFF are invalid");
N
Niels 已提交
8753 8754 8755 8756 8757
            }

            return result;
        }

N
Niels 已提交
8758
        /// return name of values of type token_type (only used for errors)
N
Niels 已提交
8759
        static std::string token_type_name(const token_type t)
N
cleanup  
Niels 已提交
8760 8761 8762
        {
            switch (t)
            {
8763
                case token_type::uninitialized:
N
cleanup  
Niels 已提交
8764
                    return "<uninitialized>";
8765
                case token_type::literal_true:
N
cleanup  
Niels 已提交
8766
                    return "true literal";
8767
                case token_type::literal_false:
N
cleanup  
Niels 已提交
8768
                    return "false literal";
8769
                case token_type::literal_null:
N
cleanup  
Niels 已提交
8770
                    return "null literal";
8771
                case token_type::value_string:
N
cleanup  
Niels 已提交
8772
                    return "string literal";
8773
                case token_type::value_number:
N
cleanup  
Niels 已提交
8774
                    return "number literal";
8775
                case token_type::begin_array:
N
Niels 已提交
8776
                    return "'['";
8777
                case token_type::begin_object:
N
Niels 已提交
8778
                    return "'{'";
8779
                case token_type::end_array:
N
Niels 已提交
8780
                    return "']'";
8781
                case token_type::end_object:
N
Niels 已提交
8782
                    return "'}'";
8783
                case token_type::name_separator:
N
Niels 已提交
8784
                    return "':'";
8785
                case token_type::value_separator:
N
Niels 已提交
8786
                    return "','";
8787
                case token_type::parse_error:
N
Niels 已提交
8788
                    return "<parse error>";
8789
                case token_type::end_of_input:
N
Niels 已提交
8790
                    return "end of input";
N
Niels 已提交
8791 8792 8793 8794 8795
                default:
                {
                    // catch non-enum values
                    return "unknown token"; // LCOV_EXCL_LINE
                }
N
cleanup  
Niels 已提交
8796 8797 8798
            }
        }

N
fixes  
Niels 已提交
8799 8800
        /*!
        This function implements a scanner for JSON. It is specified using
8801
        regular expressions that try to follow RFC 7159 as close as possible.
8802 8803 8804 8805
        These regular expressions are then translated into a minimized
        deterministic finite automaton (DFA) by the tool
        [re2c](http://re2c.org). As a result, the translated code for this
        function consists of a large block of code with `goto` jumps.
N
fixes  
Niels 已提交
8806 8807

        @return the class of the next token read from the buffer
N
Niels 已提交
8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818

        @complexity Linear in the length of the input.\n

        Proposition: The loop below will always terminate for finite input.\n

        Proof (by contradiction): Assume a finite input. To loop forever, the
        loop must never hit code with a `break` statement. The only code
        snippets without a `break` statement are the continue statements for
        whitespace and byte-order-marks. To loop forever, the input must be an
        infinite sequence of whitespace or byte-order-marks. This contradicts
        the assumption of finite input, q.e.d.
N
fixes  
Niels 已提交
8819
        */
N
cleanup  
Niels 已提交
8820
        token_type scan()
N
Niels 已提交
8821
        {
N
Niels 已提交
8822 8823 8824 8825 8826 8827 8828 8829 8830 8831
            while (true)
            {
                // pointer for backtracking information
                m_marker = nullptr;

                // remember the begin of the token
                m_start = m_cursor;
                assert(m_start != nullptr);

                /*!re2c
N
cleanup  
Niels 已提交
8832 8833 8834 8835 8836 8837
                    re2c:define:YYCTYPE      = lexer_char_t;
                    re2c:define:YYCURSOR     = m_cursor;
                    re2c:define:YYLIMIT      = m_limit;
                    re2c:define:YYMARKER     = m_marker;
                    re2c:define:YYFILL       = "fill_line_buffer(@@); // LCOV_EXCL_LINE";
                    re2c:define:YYFILL:naked = 1;
N
Niels 已提交
8838
                    re2c:yyfill:enable       = 1;
N
cleanup  
Niels 已提交
8839 8840 8841
                    re2c:indent:string       = "    ";
                    re2c:indent:top          = 1;
                    re2c:labelprefix         = "basic_json_parser_";
N
Niels 已提交
8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860

                    // ignore whitespace
                    ws = [ \t\n\r]+;
                    ws   { continue; }

                    // structural characters
                    "[" { last_token_type = token_type::begin_array; break; }
                    "]" { last_token_type = token_type::end_array; break; }
                    "{" { last_token_type = token_type::begin_object; break; }
                    "}" { last_token_type = token_type::end_object; break; }
                    "," { last_token_type = token_type::value_separator; break; }
                    ":" { last_token_type = token_type::name_separator; break; }

                    // literal names
                    "null"  { last_token_type = token_type::literal_null; break; }
                    "true"  { last_token_type = token_type::literal_true; break; }
                    "false" { last_token_type = token_type::literal_false; break; }

                    // number
N
Niels 已提交
8861
                    decimal_point = ".";
N
Niels 已提交
8862 8863
                    digit         = [0-9];
                    digit_1_9     = [1-9];
N
Niels 已提交
8864 8865 8866 8867 8868
                    e             = "e" | "E";
                    minus         = "-";
                    plus          = "+";
                    zero          = "0";
                    exp           = e (minus | plus)? digit+;
N
Niels 已提交
8869
                    frac          = decimal_point digit+;
N
Niels 已提交
8870
                    int           = (zero | digit_1_9 digit*);
N
Niels 已提交
8871 8872
                    number        = minus? int frac? exp?;
                    number        { last_token_type = token_type::value_number; break; }
N
Niels 已提交
8873

N
Niels 已提交
8874
                    // string
N
Niels 已提交
8875 8876 8877 8878 8879
                    quotation_mark  = "\"";
                    escape          = "\\";
                    unescaped       = [^"\\\x00-\x1f];
                    single_escaped  = "\"" | "\\" | "/" | "b" | "f" | "n" | "r" | "t";
                    unicode_escaped = "u" [0-9a-fA-F]{4};
N
Niels 已提交
8880 8881 8882 8883 8884 8885
                    escaped         = escape (single_escaped | unicode_escaped);
                    char            = unescaped | escaped;
                    string          = quotation_mark char* quotation_mark;
                    string          { last_token_type = token_type::value_string; break; }

                    // end of file
N
cleanup  
Niels 已提交
8886
                    "\x00"         { last_token_type = token_type::end_of_input; break; }
N
Niels 已提交
8887 8888

                    // anything else is an error
N
Niels 已提交
8889
                    *              { last_token_type = token_type::parse_error; break; }
N
Niels 已提交
8890 8891
                */
            }
N
Niels 已提交
8892

N
Niels 已提交
8893
            return last_token_type;
N
Niels 已提交
8894 8895
        }

N
cleanup  
Niels 已提交
8896 8897 8898 8899 8900 8901 8902 8903
        /*!
        @brief append data from the stream to the line buffer

        This function is called by the scan() function when the end of the
        buffer (`m_limit`) is reached and the `m_cursor` pointer cannot be
        incremented without leaving the limits of the line buffer. Note re2c
        decides when to call this function.

8904 8905 8906 8907 8908 8909 8910
        If the lexer reads from contiguous storage, there is no trailing null
        byte. Therefore, this function must make sure to add these padding
        null bytes.

        If the lexer reads from an input stream, this function reads the next
        line of the input.

N
cleanup  
Niels 已提交
8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923
        @pre
            p p p p p p u u u u u x . . . . . .
            ^           ^       ^   ^
            m_content   m_start |   m_limit
                                m_cursor

        @post
            u u u u u x x x x x x x . . . . . .
            ^       ^               ^
            |       m_cursor        m_limit
            m_start
            m_content
        */
N
cleanup  
Niels 已提交
8924
        void fill_line_buffer(size_t n = 0)
8925
        {
N
cleanup  
Niels 已提交
8926
            // number of processed characters (p)
8927
            const auto offset_start = m_start - m_content;
N
cleanup  
Niels 已提交
8928
            // offset for m_marker wrt. to m_start
8929
            const auto offset_marker = (m_marker == nullptr) ? 0 : m_marker - m_start;
N
cleanup  
Niels 已提交
8930
            // number of unprocessed characters (u)
8931
            const auto offset_cursor = m_cursor - m_start;
8932

8933
            // no stream is used or end of file is reached
N
Niels 已提交
8934
            if (m_stream == nullptr or m_stream->eof())
8935
            {
N
Niels 已提交
8936 8937
                // skip this part if we are already using the line buffer
                if (m_start != reinterpret_cast<const lexer_char_t*>(m_line_buffer.data()))
8938
                {
N
Niels 已提交
8939 8940 8941 8942
                    // copy unprocessed characters to line buffer
                    m_line_buffer.clear();
                    for (m_cursor = m_start; m_cursor != m_limit; ++m_cursor)
                    {
8943
                        assert(m_cursor != nullptr);
N
Niels 已提交
8944 8945
                        m_line_buffer.append(1, static_cast<const char>(*m_cursor));
                    }
8946 8947
                }

N
cleanup  
Niels 已提交
8948 8949 8950
                // append n characters to make sure that there is sufficient
                // space between m_cursor and m_limit
                m_line_buffer.append(1, '\x00');
8951 8952 8953 8954
                if (n > 0)
                {
                    m_line_buffer.append(n - 1, '\x01');
                }
8955 8956 8957 8958 8959 8960 8961
            }
            else
            {
                // delete processed characters from line buffer
                m_line_buffer.erase(0, static_cast<size_t>(offset_start));
                // read next line from input stream
                std::string line;
N
cleanup  
Niels 已提交
8962
                std::getline(*m_stream, line, '\n');
8963
                // add line with newline symbol to the line buffer
N
Niels 已提交
8964
                m_line_buffer += line + "\n";
8965
            }
8966

N
cleanup  
Niels 已提交
8967 8968
            // set pointers
            m_content = reinterpret_cast<const lexer_char_t*>(m_line_buffer.c_str());
N
Niels 已提交
8969
            assert(m_content != nullptr);
8970 8971 8972
            m_start  = m_content;
            m_marker = m_start + offset_marker;
            m_cursor = m_start + offset_cursor;
8973
            m_limit  = m_start + m_line_buffer.size();
N
Niels 已提交
8974 8975
        }

N
Niels 已提交
8976
        /// return string representation of last read token
N
Niels 已提交
8977
        string_t get_token_string() const
N
Niels 已提交
8978
        {
N
Niels 已提交
8979
            assert(m_start != nullptr);
N
Niels 已提交
8980 8981
            return string_t(reinterpret_cast<typename string_t::const_pointer>(m_start),
                            static_cast<size_t>(m_cursor - m_start));
N
Niels 已提交
8982 8983 8984
        }

        /*!
N
Niels 已提交
8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995
        @brief return string value for string tokens

        The function iterates the characters between the opening and closing
        quotes of the string value. The complete string is the range
        [m_start,m_cursor). Consequently, we iterate from m_start+1 to
        m_cursor-1.

        We differentiate two cases:

        1. Escaped characters. In this case, a new character is constructed
           according to the nature of the escape. Some escapes create new
N
Niels 已提交
8996 8997
           characters (e.g., `"\\n"` is replaced by `"\n"`), some are copied
           as is (e.g., `"\\\\"`). Furthermore, Unicode escapes of the shape
N
Niels 已提交
8998 8999
           `"\\uxxxx"` need special care. In this case, to_unicode takes care
           of the construction of the values.
N
Niels 已提交
9000
        2. Unescaped characters are copied as is.
N
Niels 已提交
9001

N
Niels 已提交
9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016
        @pre `m_cursor - m_start >= 2`, meaning the length of the last token
        is at least 2 bytes which is trivially true for any string (which
        consists of at least two quotes).

            " c1 c2 c3 ... "
            ^                ^
            m_start          m_cursor

        @complexity Linear in the length of the string.\n

        Lemma: The loop body will always terminate.\n

        Proof (by contradiction): Assume the loop body does not terminate. As
        the loop body does not contain another loop, one of the called
        functions must never return. The called functions are `std::strtoul`
N
Niels 已提交
9017 9018 9019
        and to_unicode. Neither function can loop forever, so the loop body
        will never loop forever which contradicts the assumption that the loop
        body does not terminate, q.e.d.\n
N
Niels 已提交
9020 9021 9022 9023 9024 9025 9026

        Lemma: The loop condition for the for loop is eventually false.\n

        Proof (by contradiction): Assume the loop does not terminate. Due to
        the above lemma, this can only be due to a tautological loop
        condition; that is, the loop condition i < m_cursor - 1 must always be
        true. Let x be the change of i for any loop iteration. Then
N
Niels 已提交
9027 9028
        m_start + 1 + x < m_cursor - 1 must hold to loop indefinitely. This
        can be rephrased to m_cursor - m_start - 2 > x. With the
N
Niels 已提交
9029
        precondition, we x <= 0, meaning that the loop condition holds
N
Niels 已提交
9030 9031 9032 9033 9034 9035
        indefinitly if i is always decreased. However, observe that the value
        of i is strictly increasing with each iteration, as it is incremented
        by 1 in the iteration expression and never decremented inside the loop
        body. Hence, the loop condition will eventually be false which
        contradicts the assumption that the loop condition is a tautology,
        q.e.d.
N
Niels 已提交
9036

N
Niels 已提交
9037 9038
        @return string value of current token without opening and closing
        quotes
N
Niels 已提交
9039
        @throw std::out_of_range if to_unicode fails
N
Niels 已提交
9040
        */
9041
        string_t get_string() const
N
Niels 已提交
9042
        {
N
Niels 已提交
9043 9044
            assert(m_cursor - m_start >= 2);

N
Niels 已提交
9045
            string_t result;
N
Niels 已提交
9046 9047 9048
            result.reserve(static_cast<size_t>(m_cursor - m_start - 2));

            // iterate the result between the quotes
N
Niels 已提交
9049
            for (const lexer_char_t* i = m_start + 1; i < m_cursor - 1; ++i)
N
Niels 已提交
9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086
            {
                // process escaped characters
                if (*i == '\\')
                {
                    // read next character
                    ++i;

                    switch (*i)
                    {
                        // the default escapes
                        case 't':
                        {
                            result += "\t";
                            break;
                        }
                        case 'b':
                        {
                            result += "\b";
                            break;
                        }
                        case 'f':
                        {
                            result += "\f";
                            break;
                        }
                        case 'n':
                        {
                            result += "\n";
                            break;
                        }
                        case 'r':
                        {
                            result += "\r";
                            break;
                        }
                        case '\\':
                        {
N
Niels 已提交
9087
                            result += "\\";
N
Niels 已提交
9088 9089 9090 9091
                            break;
                        }
                        case '/':
                        {
N
Niels 已提交
9092
                            result += "/";
N
Niels 已提交
9093 9094 9095 9096
                            break;
                        }
                        case '"':
                        {
N
Niels 已提交
9097
                            result += "\"";
N
Niels 已提交
9098 9099 9100 9101 9102 9103
                            break;
                        }

                        // unicode
                        case 'u':
                        {
N
Niels 已提交
9104
                            // get code xxxx from uxxxx
N
Niels 已提交
9105 9106
                            auto codepoint = std::strtoul(std::string(reinterpret_cast<typename string_t::const_pointer>(i + 1),
                                                          4).c_str(), nullptr, 16);
N
Niels 已提交
9107

N
Niels 已提交
9108
                            // check if codepoint is a high surrogate
N
Niels 已提交
9109 9110
                            if (codepoint >= 0xD800 and codepoint <= 0xDBFF)
                            {
N
Niels 已提交
9111
                                // make sure there is a subsequent unicode
N
Niels 已提交
9112
                                if ((i + 6 >= m_limit) or * (i + 5) != '\\' or * (i + 6) != 'u')
N
Niels 已提交
9113 9114 9115 9116
                                {
                                    throw std::invalid_argument("missing low surrogate");
                                }

N
Niels 已提交
9117
                                // get code yyyy from uxxxx\uyyyy
N
Niels 已提交
9118 9119
                                auto codepoint2 = std::strtoul(std::string(reinterpret_cast<typename string_t::const_pointer>
                                                               (i + 7), 4).c_str(), nullptr, 16);
N
Niels 已提交
9120
                                result += to_unicode(codepoint, codepoint2);
9121 9122
                                // skip the next 10 characters (xxxx\uyyyy)
                                i += 10;
N
Niels 已提交
9123
                            }
N
Niels 已提交
9124 9125 9126 9127 9128
                            else if (codepoint >= 0xDC00 and codepoint <= 0xDFFF)
                            {
                                // we found a lone low surrogate
                                throw std::invalid_argument("missing high surrogate");
                            }
N
Niels 已提交
9129 9130 9131 9132 9133 9134 9135
                            else
                            {
                                // add unicode character(s)
                                result += to_unicode(codepoint);
                                // skip the next four characters (xxxx)
                                i += 4;
                            }
N
Niels 已提交
9136 9137 9138 9139 9140 9141 9142 9143
                            break;
                        }
                    }
                }
                else
                {
                    // all other characters are just copied to the end of the
                    // string
N
Niels 已提交
9144
                    result.append(1, static_cast<typename string_t::value_type>(*i));
N
Niels 已提交
9145 9146 9147 9148
                }
            }

            return result;
N
Niels 已提交
9149 9150
        }

9151 9152 9153 9154
        /*!
        @brief parse floating point number

        This function (and its overloads) serves to select the most approprate
9155
        standard floating point number parsing function based on the type
N
Niels 已提交
9156 9157
        supplied via the first parameter.  Set this to @a
        static_cast<number_float_t*>(nullptr).
9158

N
Niels 已提交
9159
        @param[in] type  the @ref number_float_t in use
9160

N
Niels 已提交
9161 9162
        @param[in,out] endptr recieves a pointer to the first character after
        the number
9163 9164 9165

        @return the floating point number
        */
9166
        long double str_to_float_t(long double* /* type */, char** endptr) const
9167 9168 9169 9170
        {
            return std::strtold(reinterpret_cast<typename string_t::const_pointer>(m_start), endptr);
        }

9171 9172
        /*!
        @brief parse floating point number
N
Niels 已提交
9173

9174 9175
        This function (and its overloads) serves to select the most approprate
        standard floating point number parsing function based on the type
N
Niels 已提交
9176 9177
        supplied via the first parameter.  Set this to @a
        static_cast<number_float_t*>(nullptr).
N
Niels 已提交
9178

N
Niels 已提交
9179
        @param[in] type  the @ref number_float_t in use
9180

N
Niels 已提交
9181 9182
        @param[in,out] endptr  recieves a pointer to the first character after
        the number
9183 9184

        @return the floating point number
N
Niels 已提交
9185
        */
9186
        double str_to_float_t(double* /* type */, char** endptr) const
9187 9188 9189 9190
        {
            return std::strtod(reinterpret_cast<typename string_t::const_pointer>(m_start), endptr);
        }

9191 9192 9193 9194 9195
        /*!
        @brief parse floating point number

        This function (and its overloads) serves to select the most approprate
        standard floating point number parsing function based on the type
N
Niels 已提交
9196 9197
        supplied via the first parameter.  Set this to @a
        static_cast<number_float_t*>(nullptr).
9198

N
Niels 已提交
9199
        @param[in] type  the @ref number_float_t in use
9200

N
Niels 已提交
9201 9202
        @param[in,out] endptr  recieves a pointer to the first character after
        the number
9203 9204 9205

        @return the floating point number
        */
9206
        float str_to_float_t(float* /* type */, char** endptr) const
9207 9208 9209 9210
        {
            return std::strtof(reinterpret_cast<typename string_t::const_pointer>(m_start), endptr);
        }

9211 9212 9213
        /*!
        @brief return number value for number tokens

N
Niels 已提交
9214
        This function translates the last token into the most appropriate
N
Niels 已提交
9215 9216 9217 9218 9219 9220
        number type (either integer, unsigned integer or floating point),
        which is passed back to the caller via the result parameter.

        This function parses the integer component up to the radix point or
        exponent while collecting information about the 'floating point
        representation', which it stores in the result parameter. If there is
N
Niels 已提交
9221 9222 9223
        no radix point or exponent, and the number can fit into a @ref
        number_integer_t or @ref number_unsigned_t then it sets the result
        parameter accordingly.
N
Niels 已提交
9224 9225 9226 9227 9228

        If the number is a floating point number the number is then parsed
        using @a std:strtod (or @a std:strtof or @a std::strtold).

        @param[out] result  @ref basic_json object to receive the number, or
N
Niels 已提交
9229 9230
        NAN if the conversion read past the current token. The latter case
        needs to be treated by the caller function.
9231 9232
        */
        void get_number(basic_json& result) const
N
Niels 已提交
9233
        {
N
Niels 已提交
9234
            assert(m_start != nullptr);
N
Niels 已提交
9235

N
Niels 已提交
9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248
            const lexer::lexer_char_t* curptr = m_start;

            // accumulate the integer conversion result (unsigned for now)
            number_unsigned_t value = 0;

            // maximum absolute value of the relevant integer type
            number_unsigned_t max;

            // temporarily store the type to avoid unecessary bitfield access
            value_t type;

            // look for sign
            if (*curptr == '-')
9249
            {
N
Niels 已提交
9250
                type = value_t::number_integer;
N
Niels 已提交
9251
                max = static_cast<uint64_t>((std::numeric_limits<number_integer_t>::max)()) + 1;
N
Niels 已提交
9252 9253 9254 9255 9256
                curptr++;
            }
            else
            {
                type = value_t::number_unsigned;
T
Tom Needham 已提交
9257
                max = static_cast<uint64_t>((std::numeric_limits<number_unsigned_t>::max)());
9258
            }
N
Niels 已提交
9259 9260 9261

            // count the significant figures
            for (; curptr < m_cursor; curptr++)
9262
            {
N
Niels 已提交
9263 9264
                // quickly skip tests if a digit
                if (*curptr < '0' || *curptr > '9')
N
Niels 已提交
9265
                {
N
Niels 已提交
9266 9267 9268 9269 9270 9271 9272 9273 9274 9275
                    if (*curptr == '.')
                    {
                        // don't count '.' but change to float
                        type = value_t::number_float;
                        continue;
                    }
                    // assume exponent (if not then will fail parse): change to
                    // float, stop counting and record exponent details
                    type = value_t::number_float;
                    break;
N
Niels 已提交
9276
                }
N
Niels 已提交
9277 9278 9279

                // skip if definitely not an integer
                if (type != value_t::number_float)
N
Niels 已提交
9280
                {
N
Niels 已提交
9281
                    // multiply last value by ten and add the new digit
N
Niels 已提交
9282
                    auto temp = value * 10 + *curptr - '0';
N
Niels 已提交
9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294

                    // test for overflow
                    if (temp < value || temp > max)
                    {
                        // overflow
                        type = value_t::number_float;
                    }
                    else
                    {
                        // no overflow - save it
                        value = temp;
                    }
N
Niels 已提交
9295
                }
9296
            }
N
Niels 已提交
9297

N
Niels 已提交
9298 9299
            // save the value (if not a float)
            if (type == value_t::number_unsigned)
N
Niels 已提交
9300
            {
N
Niels 已提交
9301
                result.m_value.number_unsigned = value;
N
Niels 已提交
9302
            }
N
Niels 已提交
9303 9304 9305 9306 9307
            else if (type == value_t::number_integer)
            {
                result.m_value.number_integer = -static_cast<number_integer_t>(value);
            }
            else
9308
            {
N
Niels 已提交
9309
                // parse with strtod
N
Niels 已提交
9310
                result.m_value.number_float = str_to_float_t(static_cast<number_float_t*>(nullptr), NULL);
N
Niels 已提交
9311 9312 9313 9314 9315 9316 9317

                // replace infinity and NAN by null
                if (not std::isfinite(result.m_value.number_float))
                {
                    type = value_t::null;
                    result.m_value = basic_json::json_value();
                }
9318
            }
N
Niels 已提交
9319 9320 9321

            // save the type
            result.m_type = type;
N
Niels 已提交
9322 9323 9324
        }

      private:
9325
        /// optional input stream
N
Niels 已提交
9326
        std::istream* m_stream = nullptr;
N
cleanup  
Niels 已提交
9327 9328
        /// line buffer buffer for m_stream
        string_t m_line_buffer {};
9329
        /// the buffer pointer
N
Niels 已提交
9330
        const lexer_char_t* m_content = nullptr;
9331
        /// pointer to the beginning of the current symbol
N
Niels 已提交
9332
        const lexer_char_t* m_start = nullptr;
9333 9334
        /// pointer for backtracking information
        const lexer_char_t* m_marker = nullptr;
N
fixes  
Niels 已提交
9335
        /// pointer to the current symbol
N
Niels 已提交
9336
        const lexer_char_t* m_cursor = nullptr;
N
fixes  
Niels 已提交
9337
        /// pointer to the end of the buffer
N
Niels 已提交
9338
        const lexer_char_t* m_limit = nullptr;
N
Niels 已提交
9339 9340
        /// the last token type
        token_type last_token_type = token_type::end_of_input;
N
Niels 已提交
9341 9342
    };

N
Niels 已提交
9343 9344
    /*!
    @brief syntax analysis
N
Niels 已提交
9345 9346

    This class implements a recursive decent parser.
N
Niels 已提交
9347
    */
N
Niels 已提交
9348 9349
    class parser
    {
N
Niels 已提交
9350
      public:
9351
        /// a parser reading from a string literal
N
Niels 已提交
9352
        parser(const char* buff, const parser_callback_t cb = nullptr)
N
cleanup  
Niels 已提交
9353
            : callback(cb),
N
Niels 已提交
9354
              m_lexer(reinterpret_cast<const typename lexer::lexer_char_t*>(buff), std::strlen(buff))
N
cleanup  
Niels 已提交
9355
        {}
9356

N
Niels 已提交
9357
        /// a parser reading from an input stream
N
cleanup  
Niels 已提交
9358
        parser(std::istream& is, const parser_callback_t cb = nullptr)
9359
            : callback(cb), m_lexer(is)
N
cleanup  
Niels 已提交
9360
        {}
9361

N
Niels 已提交
9362
        /// a parser reading from an iterator range with contiguous storage
N
Niels 已提交
9363 9364 9365 9366
        template<class IteratorType, typename std::enable_if<
                     std::is_same<typename std::iterator_traits<IteratorType>::iterator_category, std::random_access_iterator_tag>::value
                     , int>::type
                 = 0>
N
cleanup  
Niels 已提交
9367
        parser(IteratorType first, IteratorType last, const parser_callback_t cb = nullptr)
9368 9369 9370
            : callback(cb),
              m_lexer(reinterpret_cast<const typename lexer::lexer_char_t*>(&(*first)),
                      static_cast<size_t>(std::distance(first, last)))
9371
        {}
N
Niels 已提交
9372

N
Niels 已提交
9373
        /// public parser interface
9374
        basic_json parse()
N
Niels 已提交
9375
        {
N
cleanup  
Niels 已提交
9376 9377 9378
            // read first token
            get_token();

N
Niels 已提交
9379
            basic_json result = parse_internal(true);
9380
            result.assert_invariant();
N
Niels 已提交
9381 9382 9383

            expect(lexer::token_type::end_of_input);

N
Niels 已提交
9384 9385
            // return parser result and replace it with null in case the
            // top-level value was discarded by the callback function
9386
            return result.is_discarded() ? basic_json() : std::move(result);
N
Niels 已提交
9387 9388 9389 9390
        }

      private:
        /// the actual parser
9391
        basic_json parse_internal(bool keep)
N
Niels 已提交
9392
        {
N
Niels 已提交
9393 9394
            auto result = basic_json(value_t::discarded);

N
Niels 已提交
9395 9396
            switch (last_token)
            {
9397
                case lexer::token_type::begin_object:
N
Niels 已提交
9398
                {
N
Niels 已提交
9399 9400
                    if (keep and (not callback
                                  or ((keep = callback(depth++, parse_event_t::object_start, result)) != 0)))
N
Niels 已提交
9401 9402
                    {
                        // explicitly set result to object to cope with {}
N
Niels 已提交
9403
                        result.m_type = value_t::object;
9404
                        result.m_value = value_t::object;
N
Niels 已提交
9405
                    }
N
Niels 已提交
9406 9407 9408 9409 9410

                    // read next token
                    get_token();

                    // closing } -> we are done
N
Niels 已提交
9411
                    if (last_token == lexer::token_type::end_object)
N
Niels 已提交
9412
                    {
N
Niels 已提交
9413
                        get_token();
9414
                        if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
N
Niels 已提交
9415 9416 9417
                        {
                            result = basic_json(value_t::discarded);
                        }
N
Niels 已提交
9418
                        return result;
N
Niels 已提交
9419 9420
                    }

N
Niels 已提交
9421 9422 9423
                    // no comma is expected here
                    unexpect(lexer::token_type::value_separator);

N
Niels 已提交
9424 9425 9426
                    // otherwise: parse key-value pairs
                    do
                    {
N
Niels 已提交
9427 9428 9429 9430 9431 9432
                        // ugly, but could be fixed with loop reorganization
                        if (last_token == lexer::token_type::value_separator)
                        {
                            get_token();
                        }

N
Niels 已提交
9433
                        // store key
N
Niels 已提交
9434 9435
                        expect(lexer::token_type::value_string);
                        const auto key = m_lexer.get_string();
N
Niels 已提交
9436

N
Niels 已提交
9437 9438 9439
                        bool keep_tag = false;
                        if (keep)
                        {
N
Niels 已提交
9440 9441 9442 9443 9444 9445 9446 9447 9448
                            if (callback)
                            {
                                basic_json k(key);
                                keep_tag = callback(depth, parse_event_t::key, k);
                            }
                            else
                            {
                                keep_tag = true;
                            }
N
Niels 已提交
9449 9450
                        }

N
Niels 已提交
9451 9452
                        // parse separator (:)
                        get_token();
N
Niels 已提交
9453
                        expect(lexer::token_type::name_separator);
N
Niels 已提交
9454

9455
                        // parse and add value
N
Niels 已提交
9456
                        get_token();
N
Niels 已提交
9457 9458 9459
                        auto value = parse_internal(keep);
                        if (keep and keep_tag and not value.is_discarded())
                        {
9460
                            result[key] = std::move(value);
N
Niels 已提交
9461
                        }
N
Niels 已提交
9462
                    }
N
Niels 已提交
9463
                    while (last_token == lexer::token_type::value_separator);
N
Niels 已提交
9464 9465

                    // closing }
N
Niels 已提交
9466
                    expect(lexer::token_type::end_object);
N
Niels 已提交
9467
                    get_token();
9468
                    if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
N
Niels 已提交
9469 9470 9471
                    {
                        result = basic_json(value_t::discarded);
                    }
N
Niels 已提交
9472 9473

                    return result;
N
Niels 已提交
9474 9475
                }

9476
                case lexer::token_type::begin_array:
N
Niels 已提交
9477
                {
N
Niels 已提交
9478 9479
                    if (keep and (not callback
                                  or ((keep = callback(depth++, parse_event_t::array_start, result)) != 0)))
N
Niels 已提交
9480 9481
                    {
                        // explicitly set result to object to cope with []
N
Niels 已提交
9482
                        result.m_type = value_t::array;
9483
                        result.m_value = value_t::array;
N
Niels 已提交
9484
                    }
N
Niels 已提交
9485 9486 9487 9488 9489

                    // read next token
                    get_token();

                    // closing ] -> we are done
N
Niels 已提交
9490
                    if (last_token == lexer::token_type::end_array)
N
Niels 已提交
9491
                    {
N
Niels 已提交
9492
                        get_token();
9493
                        if (callback and not callback(--depth, parse_event_t::array_end, result))
N
Niels 已提交
9494 9495 9496
                        {
                            result = basic_json(value_t::discarded);
                        }
N
Niels 已提交
9497
                        return result;
N
Niels 已提交
9498 9499
                    }

N
Niels 已提交
9500 9501 9502
                    // no comma is expected here
                    unexpect(lexer::token_type::value_separator);

N
Niels 已提交
9503 9504 9505
                    // otherwise: parse values
                    do
                    {
N
Niels 已提交
9506 9507 9508 9509 9510
                        // ugly, but could be fixed with loop reorganization
                        if (last_token == lexer::token_type::value_separator)
                        {
                            get_token();
                        }
N
Niels 已提交
9511

N
Niels 已提交
9512 9513 9514 9515
                        // parse value
                        auto value = parse_internal(keep);
                        if (keep and not value.is_discarded())
                        {
9516
                            result.push_back(std::move(value));
N
Niels 已提交
9517
                        }
N
Niels 已提交
9518
                    }
N
Niels 已提交
9519
                    while (last_token == lexer::token_type::value_separator);
N
Niels 已提交
9520 9521

                    // closing ]
N
Niels 已提交
9522
                    expect(lexer::token_type::end_array);
N
Niels 已提交
9523
                    get_token();
9524
                    if (keep and callback and not callback(--depth, parse_event_t::array_end, result))
N
Niels 已提交
9525 9526 9527
                    {
                        result = basic_json(value_t::discarded);
                    }
N
Niels 已提交
9528 9529

                    return result;
N
Niels 已提交
9530 9531
                }

9532
                case lexer::token_type::literal_null:
N
Niels 已提交
9533
                {
N
Niels 已提交
9534
                    get_token();
N
Niels 已提交
9535
                    result.m_type = value_t::null;
N
Niels 已提交
9536
                    break;
N
Niels 已提交
9537 9538
                }

9539
                case lexer::token_type::value_string:
N
Niels 已提交
9540
                {
N
Niels 已提交
9541
                    const auto s = m_lexer.get_string();
N
Niels 已提交
9542
                    get_token();
N
Niels 已提交
9543 9544
                    result = basic_json(s);
                    break;
N
Niels 已提交
9545 9546
                }

9547
                case lexer::token_type::literal_true:
N
Niels 已提交
9548
                {
N
Niels 已提交
9549
                    get_token();
N
Niels 已提交
9550 9551
                    result.m_type = value_t::boolean;
                    result.m_value = true;
N
Niels 已提交
9552
                    break;
N
Niels 已提交
9553 9554
                }

9555
                case lexer::token_type::literal_false:
N
Niels 已提交
9556
                {
N
Niels 已提交
9557
                    get_token();
N
Niels 已提交
9558 9559
                    result.m_type = value_t::boolean;
                    result.m_value = false;
N
Niels 已提交
9560
                    break;
N
Niels 已提交
9561 9562
                }

9563
                case lexer::token_type::value_number:
N
Niels 已提交
9564
                {
9565
                    m_lexer.get_number(result);
N
Niels 已提交
9566
                    get_token();
N
Niels 已提交
9567
                    break;
N
Niels 已提交
9568 9569 9570 9571
                }

                default:
                {
N
Niels 已提交
9572 9573
                    // the last token was unexpected
                    unexpect(last_token);
N
Niels 已提交
9574 9575
                }
            }
N
Niels 已提交
9576

9577
            if (keep and callback and not callback(depth, parse_event_t::value, result))
N
Niels 已提交
9578 9579 9580 9581
            {
                result = basic_json(value_t::discarded);
            }
            return result;
N
Niels 已提交
9582 9583
        }

N
Niels 已提交
9584
        /// get next token from lexer
N
cleanup  
Niels 已提交
9585
        typename lexer::token_type get_token()
N
Niels 已提交
9586
        {
N
Niels 已提交
9587 9588
            last_token = m_lexer.scan();
            return last_token;
N
Niels 已提交
9589 9590
        }

9591
        void expect(typename lexer::token_type t) const
N
Niels 已提交
9592 9593 9594
        {
            if (t != last_token)
            {
N
Niels 已提交
9595
                std::string error_msg = "parse error - unexpected ";
N
Niels 已提交
9596 9597
                error_msg += (last_token == lexer::token_type::parse_error ? ("'" +  m_lexer.get_token_string() +
                              "'") :
N
Niels 已提交
9598 9599
                              lexer::token_type_name(last_token));
                error_msg += "; expected " + lexer::token_type_name(t);
N
Niels 已提交
9600 9601 9602 9603
                throw std::invalid_argument(error_msg);
            }
        }

9604
        void unexpect(typename lexer::token_type t) const
N
Niels 已提交
9605 9606 9607
        {
            if (t == last_token)
            {
N
Niels 已提交
9608
                std::string error_msg = "parse error - unexpected ";
N
Niels 已提交
9609 9610
                error_msg += (last_token == lexer::token_type::parse_error ? ("'" +  m_lexer.get_token_string() +
                              "'") :
N
Niels 已提交
9611
                              lexer::token_type_name(last_token));
N
Niels 已提交
9612 9613 9614 9615
                throw std::invalid_argument(error_msg);
            }
        }

N
Niels 已提交
9616
      private:
N
Niels 已提交
9617
        /// current level of recursion
N
Niels 已提交
9618 9619
        int depth = 0;
        /// callback function
N
Niels 已提交
9620
        const parser_callback_t callback = nullptr;
N
Niels 已提交
9621
        /// the type of the last read token
N
Niels 已提交
9622
        typename lexer::token_type last_token = lexer::token_type::uninitialized;
N
Niels 已提交
9623
        /// the lexer
N
Niels 已提交
9624
        lexer m_lexer;
N
Niels 已提交
9625
    };
N
Niels 已提交
9626 9627

  public:
N
Niels 已提交
9628 9629 9630
    /*!
    @brief JSON Pointer

N
Niels 已提交
9631 9632 9633 9634
    A JSON pointer defines a string syntax for identifying a specific value
    within a JSON document. It can be used with functions `at` and
    `operator[]`. Furthermore, JSON pointers are the base for JSON patches.

N
Niels 已提交
9635
    @sa [RFC 6901](https://tools.ietf.org/html/rfc6901)
N
Niels 已提交
9636 9637

    @since version 2.0.0
N
Niels 已提交
9638
    */
N
Niels 已提交
9639 9640
    class json_pointer
    {
N
Niels 已提交
9641 9642 9643
        /// allow basic_json to access private members
        friend class basic_json;

N
Niels 已提交
9644
      public:
N
Niels 已提交
9645 9646 9647 9648 9649 9650 9651 9652 9653 9654
        /*!
        @brief create JSON pointer

        Create a JSON pointer according to the syntax described in
        [Section 3 of RFC6901](https://tools.ietf.org/html/rfc6901#section-3).

        @param[in] s  string representing the JSON pointer; if omitted, the
                      empty string is assumed which references the whole JSON
                      value

N
Niels 已提交
9655 9656 9657 9658 9659 9660
        @throw std::domain_error if reference token is nonempty and does not
        begin with a slash (`/`); example: `"JSON pointer must be empty or
        begin with /"`
        @throw std::domain_error if a tilde (`~`) is not followed by `0`
        (representing `~`) or `1` (representing `/`); example: `"escape error:
        ~ must be followed with 0 or 1"`
N
Niels 已提交
9661 9662 9663

        @liveexample{The example shows the construction several valid JSON
        pointers as well as the exceptional behavior.,json_pointer}
N
Niels 已提交
9664

N
Niels 已提交
9665 9666 9667
        @since version 2.0.0
        */
        explicit json_pointer(const std::string& s = "")
N
Niels 已提交
9668 9669
            : reference_tokens(split(s))
        {}
N
Niels 已提交
9670

N
Niels 已提交
9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687
        /*!
        @brief return a string representation of the JSON pointer

        @invariant For each JSON pointer `ptr`, it holds:
        @code {.cpp}
        ptr == json_pointer(ptr.to_string());
        @endcode

        @return a string representation of the JSON pointer

        @liveexample{The example shows the result of `to_string`.,
        json_pointer__to_string}

        @since version 2.0.0
        */
        std::string to_string() const noexcept
        {
N
Niels 已提交
9688 9689
            return std::accumulate(reference_tokens.begin(),
                                   reference_tokens.end(), std::string{},
N
Niels 已提交
9690
                                   [](const std::string & a, const std::string & b)
N
Niels 已提交
9691
            {
N
Niels 已提交
9692 9693
                return a + "/" + escape(b);
            });
N
Niels 已提交
9694 9695 9696 9697
        }

        /// @copydoc to_string()
        operator std::string() const
N
Niels 已提交
9698
        {
N
Niels 已提交
9699
            return to_string();
N
Niels 已提交
9700 9701
        }

N
Niels 已提交
9702
      private:
N
Niels 已提交
9703
        /// remove and return last reference pointer
N
Niels 已提交
9704 9705
        std::string pop_back()
        {
N
Niels 已提交
9706
            if (is_root())
N
Niels 已提交
9707 9708 9709 9710 9711 9712 9713 9714 9715
            {
                throw std::domain_error("JSON pointer has no parent");
            }

            auto last = reference_tokens.back();
            reference_tokens.pop_back();
            return last;
        }

N
Niels 已提交
9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733
        /// return whether pointer points to the root document
        bool is_root() const
        {
            return reference_tokens.empty();
        }

        json_pointer top() const
        {
            if (is_root())
            {
                throw std::domain_error("JSON pointer has no parent");
            }

            json_pointer result = *this;
            result.reference_tokens = {reference_tokens[0]};
            return result;
        }

N
Niels 已提交
9734 9735
        /*!
        @brief create and return a reference to the pointed to value
N
Niels 已提交
9736 9737

        @complexity Linear in the number of reference tokens.
N
Niels 已提交
9738 9739
        */
        reference get_and_create(reference j) const
N
Niels 已提交
9740
        {
9741
            pointer result = &j;
N
Niels 已提交
9742

N
Niels 已提交
9743 9744
            // in case no reference tokens exist, return a reference to the
            // JSON value j which will be overwritten by a primitive value
N
Niels 已提交
9745 9746
            for (const auto& reference_token : reference_tokens)
            {
9747
                switch (result->m_type)
N
Niels 已提交
9748
                {
N
Niels 已提交
9749 9750 9751 9752
                    case value_t::null:
                    {
                        if (reference_token == "0")
                        {
N
Niels 已提交
9753
                            // start a new array if reference token is 0
N
Niels 已提交
9754 9755 9756 9757
                            result = &result->operator[](0);
                        }
                        else
                        {
N
Niels 已提交
9758
                            // start a new object otherwise
N
Niels 已提交
9759 9760
                            result = &result->operator[](reference_token);
                        }
N
Niels 已提交
9761
                        break;
N
Niels 已提交
9762 9763
                    }

N
Niels 已提交
9764
                    case value_t::object:
N
Niels 已提交
9765
                    {
N
Niels 已提交
9766
                        // create an entry in the object
N
Niels 已提交
9767
                        result = &result->operator[](reference_token);
N
Niels 已提交
9768
                        break;
N
Niels 已提交
9769
                    }
N
Niels 已提交
9770 9771

                    case value_t::array:
N
Niels 已提交
9772
                    {
N
Niels 已提交
9773
                        // create an entry in the array
N
Niels 已提交
9774
                        result = &result->operator[](static_cast<size_type>(std::stoi(reference_token)));
N
Niels 已提交
9775
                        break;
N
Niels 已提交
9776
                    }
N
Niels 已提交
9777

N
Niels 已提交
9778
                    /*
N
Niels 已提交
9779 9780 9781 9782 9783
                    The following code is only reached if there exists a
                    reference token _and_ the current value is primitive. In
                    this case, we have an error situation, because primitive
                    values may only occur as single value; that is, with an
                    empty list of reference tokens.
N
Niels 已提交
9784
                    */
N
Niels 已提交
9785
                    default:
N
Niels 已提交
9786
                    {
N
Niels 已提交
9787
                        throw std::domain_error("invalid value to unflatten");
N
Niels 已提交
9788
                    }
N
Niels 已提交
9789 9790 9791
                }
            }

9792 9793 9794
            return *result;
        }

N
Niels 已提交
9795 9796 9797
        /*!
        @brief return a reference to the pointed to value

N
Niels 已提交
9798 9799 9800 9801 9802 9803
        @note This version does not throw if a value is not present, but tries
        to create nested values instead. For instance, calling this function
        with pointer `"/this/that"` on a null value is equivalent to calling
        `operator[]("this").operator[]("that")` on that value, effectively
        changing the null value to an object.

N
Niels 已提交
9804 9805 9806 9807 9808 9809
        @param[in] ptr  a JSON value

        @return reference to the JSON value pointed to by the JSON pointer

        @complexity Linear in the length of the JSON pointer.

9810 9811 9812
        @throw std::out_of_range      if the JSON pointer can not be resolved
        @throw std::domain_error      if an array index begins with '0'
        @throw std::invalid_argument  if an array index was not a number
N
Niels 已提交
9813 9814
        */
        reference get_unchecked(pointer ptr) const
N
Niels 已提交
9815
        {
N
Niels 已提交
9816 9817
            for (const auto& reference_token : reference_tokens)
            {
N
Niels 已提交
9818 9819
                // convert null values to arrays or objects before continuing
                if (ptr->m_type == value_t::null)
N
Niels 已提交
9820
                {
N
Niels 已提交
9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838
                    // check if reference token is a number
                    const bool nums = std::all_of(reference_token.begin(),
                                                  reference_token.end(),
                                                  [](const char x)
                    {
                        return std::isdigit(x);
                    });

                    // change value to array for numbers or "-" or to object
                    // otherwise
                    if (nums or reference_token == "-")
                    {
                        *ptr = value_t::array;
                    }
                    else
                    {
                        *ptr = value_t::object;
                    }
N
Niels 已提交
9839 9840
                }

N
Niels 已提交
9841 9842 9843 9844
                switch (ptr->m_type)
                {
                    case value_t::object:
                    {
9845
                        // use unchecked object access
N
Niels 已提交
9846 9847 9848 9849 9850 9851
                        ptr = &ptr->operator[](reference_token);
                        break;
                    }

                    case value_t::array:
                    {
N
Niels 已提交
9852 9853 9854 9855 9856 9857
                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
                            throw std::domain_error("array index must not begin with '0'");
                        }

N
Niels 已提交
9858 9859
                        if (reference_token == "-")
                        {
9860
                            // explicityly treat "-" as index beyond the end
N
Niels 已提交
9861 9862 9863 9864
                            ptr = &ptr->operator[](ptr->m_value.array->size());
                        }
                        else
                        {
9865
                            // convert array index to number; unchecked access
N
Niels 已提交
9866
                            ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
N
Niels 已提交
9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879
                        }
                        break;
                    }

                    default:
                    {
                        throw std::out_of_range("unresolved reference token '" + reference_token + "'");
                    }
                }
            }

            return *ptr;
        }
N
Niels 已提交
9880

N
Niels 已提交
9881 9882
        reference get_checked(pointer ptr) const
        {
N
Niels 已提交
9883 9884
            for (const auto& reference_token : reference_tokens)
            {
N
Niels 已提交
9885
                switch (ptr->m_type)
N
Niels 已提交
9886
                {
N
Niels 已提交
9887
                    case value_t::object:
N
Niels 已提交
9888
                    {
9889
                        // note: at performs range check
N
Niels 已提交
9890 9891 9892 9893 9894 9895 9896
                        ptr = &ptr->at(reference_token);
                        break;
                    }

                    case value_t::array:
                    {
                        if (reference_token == "-")
N
Niels 已提交
9897
                        {
9898 9899 9900 9901
                            // "-" always fails the range check
                            throw std::out_of_range("array index '-' (" +
                                                    std::to_string(ptr->m_value.array->size()) +
                                                    ") is out of range");
N
Niels 已提交
9902
                        }
9903 9904 9905

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
N
Niels 已提交
9906
                        {
9907
                            throw std::domain_error("array index must not begin with '0'");
N
Niels 已提交
9908
                        }
9909 9910

                        // note: at performs range check
N
Niels 已提交
9911
                        ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
N
Niels 已提交
9912 9913 9914 9915 9916 9917
                        break;
                    }

                    default:
                    {
                        throw std::out_of_range("unresolved reference token '" + reference_token + "'");
N
Niels 已提交
9918
                    }
N
Niels 已提交
9919 9920 9921 9922 9923 9924 9925 9926 9927 9928
                }
            }

            return *ptr;
        }

        /*!
        @brief return a const reference to the pointed to value

        @param[in] ptr  a JSON value
N
Niels 已提交
9929

N
Niels 已提交
9930 9931 9932 9933 9934 9935 9936 9937 9938
        @return const reference to the JSON value pointed to by the JSON
                pointer
        */
        const_reference get_unchecked(const_pointer ptr) const
        {
            for (const auto& reference_token : reference_tokens)
            {
                switch (ptr->m_type)
                {
N
Niels 已提交
9939 9940
                    case value_t::object:
                    {
9941
                        // use unchecked object access
N
Niels 已提交
9942
                        ptr = &ptr->operator[](reference_token);
N
Niels 已提交
9943
                        break;
N
Niels 已提交
9944 9945 9946 9947
                    }

                    case value_t::array:
                    {
N
Niels 已提交
9948 9949
                        if (reference_token == "-")
                        {
9950
                            // "-" cannot be used for const access
N
Niels 已提交
9951 9952 9953 9954
                            throw std::out_of_range("array index '-' (" +
                                                    std::to_string(ptr->m_value.array->size()) +
                                                    ") is out of range");
                        }
9955 9956 9957 9958 9959 9960 9961 9962

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
                            throw std::domain_error("array index must not begin with '0'");
                        }

                        // use unchecked array access
N
Niels 已提交
9963
                        ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
N
Niels 已提交
9964
                        break;
N
Niels 已提交
9965 9966 9967 9968
                    }

                    default:
                    {
N
Niels 已提交
9969
                        throw std::out_of_range("unresolved reference token '" + reference_token + "'");
N
Niels 已提交
9970 9971 9972 9973
                    }
                }
            }

N
Niels 已提交
9974
            return *ptr;
N
Niels 已提交
9975 9976
        }

N
Niels 已提交
9977
        const_reference get_checked(const_pointer ptr) const
9978 9979 9980
        {
            for (const auto& reference_token : reference_tokens)
            {
N
Niels 已提交
9981
                switch (ptr->m_type)
9982 9983
                {
                    case value_t::object:
N
Niels 已提交
9984
                    {
9985
                        // note: at performs range check
N
Niels 已提交
9986
                        ptr = &ptr->at(reference_token);
N
Niels 已提交
9987
                        break;
N
Niels 已提交
9988
                    }
9989 9990

                    case value_t::array:
N
Niels 已提交
9991 9992 9993
                    {
                        if (reference_token == "-")
                        {
9994
                            // "-" always fails the range check
N
Niels 已提交
9995 9996 9997 9998
                            throw std::out_of_range("array index '-' (" +
                                                    std::to_string(ptr->m_value.array->size()) +
                                                    ") is out of range");
                        }
9999 10000 10001 10002 10003 10004 10005 10006

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
                            throw std::domain_error("array index must not begin with '0'");
                        }

                        // note: at performs range check
N
Niels 已提交
10007
                        ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
N
Niels 已提交
10008
                        break;
N
Niels 已提交
10009
                    }
10010 10011

                    default:
N
Niels 已提交
10012 10013 10014
                    {
                        throw std::out_of_range("unresolved reference token '" + reference_token + "'");
                    }
10015 10016 10017
                }
            }

N
Niels 已提交
10018
            return *ptr;
N
Niels 已提交
10019 10020 10021
        }

        /// split the string input to reference tokens
10022
        static std::vector<std::string> split(const std::string& reference_string)
N
Niels 已提交
10023
        {
N
Niels 已提交
10024 10025
            std::vector<std::string> result;

N
Niels 已提交
10026 10027 10028
            // special case: empty reference string -> no reference tokens
            if (reference_string.empty())
            {
N
Niels 已提交
10029
                return result;
N
Niels 已提交
10030 10031 10032 10033 10034 10035 10036 10037
            }

            // check if nonempty reference string begins with slash
            if (reference_string[0] != '/')
            {
                throw std::domain_error("JSON pointer must be empty or begin with '/'");
            }

N
Niels 已提交
10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048
            // extract the reference tokens:
            // - slash: position of the last read slash (or end of string)
            // - start: position after the previous slash
            for (
                // search for the first slash after the first character
                size_t slash = reference_string.find_first_of("/", 1),
                // set the beginning of the first reference token
                start = 1;
                // we can stop if start == string::npos+1 = 0
                start != 0;
                // set the beginning of the next reference token
N
Niels 已提交
10049
                // (will eventually be 0 if slash == std::string::npos)
N
Niels 已提交
10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063
                start = slash + 1,
                // find next slash
                slash = reference_string.find_first_of("/", start))
            {
                // use the text between the beginning of the reference token
                // (start) and the last slash (slash).
                auto reference_token = reference_string.substr(start, slash - start);

                // check reference tokens are properly escaped
                for (size_t pos = reference_token.find_first_of("~");
                        pos != std::string::npos;
                        pos = reference_token.find_first_of("~", pos + 1))
                {
                    assert(reference_token[pos] == '~');
N
Niels 已提交
10064

N
Niels 已提交
10065 10066 10067 10068 10069 10070 10071 10072
                    // ~ must be followed by 0 or 1
                    if (pos == reference_token.size() - 1 or
                            (reference_token[pos + 1] != '0' and
                             reference_token[pos + 1] != '1'))
                    {
                        throw std::domain_error("escape error: '~' must be followed with '0' or '1'");
                    }
                }
10073

N
Niels 已提交
10074
                // finally, store the reference token
N
Niels 已提交
10075
                unescape(reference_token);
N
Niels 已提交
10076
                result.push_back(reference_token);
10077
            }
N
Niels 已提交
10078 10079

            return result;
N
Niels 已提交
10080
        }
N
Niels 已提交
10081

N
Niels 已提交
10082
      private:
N
Niels 已提交
10083 10084 10085 10086 10087
        /*!
        @brief replace all occurrences of a substring by another string

        @param[in,out] s  the string to manipulate
        @param[in]     f  the substring to replace with @a t
N
Niels 已提交
10088
        @param[in]     t  the string to replace @a f
N
Niels 已提交
10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110

        @return The string @a s where all occurrences of @a f are replaced
                with @a t.

        @pre The search string @a f must not be empty.

        @since version 2.0.0
        */
        static void replace_substring(std::string& s,
                                      const std::string& f,
                                      const std::string& t)
        {
            assert(not f.empty());

            for (
                size_t pos = s.find(f);         // find first occurrence of f
                pos != std::string::npos;       // make sure f was found
                s.replace(pos, f.size(), t),    // replace with t
                pos = s.find(f, pos + t.size()) // find next occurrence of f
            );
        }

N
Niels 已提交
10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128
        /// escape tilde and slash
        static std::string escape(std::string s)
        {
            // escape "~"" to "~0" and "/" to "~1"
            replace_substring(s, "~", "~0");
            replace_substring(s, "/", "~1");
            return s;
        }

        /// unescape tilde and slash
        static void unescape(std::string& s)
        {
            // first transform any occurrence of the sequence '~1' to '/'
            replace_substring(s, "~1", "/");
            // then transform any occurrence of the sequence '~0' to '~'
            replace_substring(s, "~0", "~");
        }

N
Niels 已提交
10129 10130 10131 10132
        /*!
        @param[in] reference_string  the reference string to the current value
        @param[in] value             the value to consider
        @param[in,out] result        the result object to insert values to
N
Niels 已提交
10133 10134

        @note Empty objects or arrays are flattened to `null`.
N
Niels 已提交
10135
        */
N
Niels 已提交
10136
        static void flatten(const std::string& reference_string,
N
Niels 已提交
10137 10138 10139 10140 10141 10142 10143
                            const basic_json& value,
                            basic_json& result)
        {
            switch (value.m_type)
            {
                case value_t::array:
                {
N
Niels 已提交
10144
                    if (value.m_value.array->empty())
N
Niels 已提交
10145
                    {
N
Niels 已提交
10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156
                        // flatten empty array as null
                        result[reference_string] = nullptr;
                    }
                    else
                    {
                        // iterate array and use index as reference string
                        for (size_t i = 0; i < value.m_value.array->size(); ++i)
                        {
                            flatten(reference_string + "/" + std::to_string(i),
                                    value.m_value.array->operator[](i), result);
                        }
N
Niels 已提交
10157 10158 10159 10160 10161 10162
                    }
                    break;
                }

                case value_t::object:
                {
N
Niels 已提交
10163
                    if (value.m_value.object->empty())
N
Niels 已提交
10164
                    {
N
Niels 已提交
10165 10166 10167 10168 10169 10170 10171 10172
                        // flatten empty object as null
                        result[reference_string] = nullptr;
                    }
                    else
                    {
                        // iterate object and use keys as reference string
                        for (const auto& element : *value.m_value.object)
                        {
N
Niels 已提交
10173
                            flatten(reference_string + "/" + escape(element.first),
N
Niels 已提交
10174 10175
                                    element.second, result);
                        }
N
Niels 已提交
10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187
                    }
                    break;
                }

                default:
                {
                    // add primitive value with its reference string
                    result[reference_string] = value;
                    break;
                }
            }
        }
N
Niels 已提交
10188 10189 10190 10191

        /*!
        @param[in] value  flattened JSON

N
Niels 已提交
10192
        @return unflattened JSON
N
Niels 已提交
10193
        */
N
Niels 已提交
10194
        static basic_json unflatten(const basic_json& value)
N
Niels 已提交
10195 10196 10197
        {
            if (not value.is_object())
            {
N
Niels 已提交
10198
                throw std::domain_error("only objects can be unflattened");
N
Niels 已提交
10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210
            }

            basic_json result;

            // iterate the JSON object values
            for (const auto& element : *value.m_value.object)
            {
                if (not element.second.is_primitive())
                {
                    throw std::domain_error("values in object must be primitive");
                }

N
Niels 已提交
10211 10212 10213 10214 10215
                // assign value to reference pointed to by JSON pointer; Note
                // that if the JSON pointer is "" (i.e., points to the whole
                // value), function get_and_create returns a reference to
                // result itself. An assignment will then create a primitive
                // value.
N
Niels 已提交
10216
                json_pointer(element.first).get_and_create(result) = element.second;
N
Niels 已提交
10217 10218 10219 10220
            }

            return result;
        }
N
Niels 已提交
10221 10222 10223

      private:
        /// the reference tokens
N
Niels 已提交
10224
        std::vector<std::string> reference_tokens {};
N
Niels 已提交
10225
    };
N
Niels 已提交
10226

N
Niels 已提交
10227 10228 10229
    //////////////////////////
    // JSON Pointer support //
    //////////////////////////
N
Niels 已提交
10230 10231 10232 10233

    /// @name JSON Pointer functions
    /// @{

N
Niels 已提交
10234 10235 10236 10237
    /*!
    @brief access specified element via JSON Pointer

    Uses a JSON pointer to retrieve a reference to the respective JSON value.
N
Niels 已提交
10238 10239 10240
    No bound checking is performed. Similar to @ref operator[](const typename
    object_t::key_type&), `null` values are created in arrays and objects if
    necessary.
N
Niels 已提交
10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326

    In particular:
    - If the JSON pointer points to an object key that does not exist, it
      is created an filled with a `null` value before a reference to it
      is returned.
    - If the JSON pointer points to an array index that does not exist, it
      is created an filled with a `null` value before a reference to it
      is returned. All indices between the current maximum and the given
      index are also filled with `null`.
    - The special value `-` is treated as a synonym for the index past the
      end.

    @param[in] ptr  a JSON pointer

    @return reference to the element pointed to by @a ptr

    @complexity Constant.

    @throw std::out_of_range      if the JSON pointer can not be resolved
    @throw std::domain_error      if an array index begins with '0'
    @throw std::invalid_argument  if an array index was not a number

    @liveexample{The behavior is shown in the example.,operatorjson_pointer}

    @since version 2.0.0
    */
    reference operator[](const json_pointer& ptr)
    {
        return ptr.get_unchecked(this);
    }

    /*!
    @brief access specified element via JSON Pointer

    Uses a JSON pointer to retrieve a reference to the respective JSON value.
    No bound checking is performed. The function does not change the JSON
    value; no `null` values are created. In particular, the the special value
    `-` yields an exception.

    @param[in] ptr  JSON pointer to the desired element

    @return const reference to the element pointed to by @a ptr

    @complexity Constant.

    @throw std::out_of_range      if the JSON pointer can not be resolved
    @throw std::domain_error      if an array index begins with '0'
    @throw std::invalid_argument  if an array index was not a number

    @liveexample{The behavior is shown in the example.,operatorjson_pointer_const}

    @since version 2.0.0
    */
    const_reference operator[](const json_pointer& ptr) const
    {
        return ptr.get_unchecked(this);
    }

    /*!
    @brief access specified element via JSON Pointer

    Returns a reference to the element at with specified JSON pointer @a ptr,
    with bounds checking.

    @param[in] ptr  JSON pointer to the desired element

    @return reference to the element pointed to by @a ptr

    @complexity Constant.

    @throw std::out_of_range      if the JSON pointer can not be resolved
    @throw std::domain_error      if an array index begins with '0'
    @throw std::invalid_argument  if an array index was not a number

    @liveexample{The behavior is shown in the example.,at_json_pointer}

    @since version 2.0.0
    */
    reference at(const json_pointer& ptr)
    {
        return ptr.get_checked(this);
    }

    /*!
    @brief access specified element via JSON Pointer

N
Niels 已提交
10327 10328
    Returns a const reference to the element at with specified JSON pointer @a
    ptr, with bounds checking.
N
Niels 已提交
10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348

    @param[in] ptr  JSON pointer to the desired element

    @return reference to the element pointed to by @a ptr

    @complexity Constant.

    @throw std::out_of_range      if the JSON pointer can not be resolved
    @throw std::domain_error      if an array index begins with '0'
    @throw std::invalid_argument  if an array index was not a number

    @liveexample{The behavior is shown in the example.,at_json_pointer_const}

    @since version 2.0.0
    */
    const_reference at(const json_pointer& ptr) const
    {
        return ptr.get_checked(this);
    }

N
Niels 已提交
10349
    /*!
N
Niels 已提交
10350 10351
    @brief return flattened JSON value

N
Niels 已提交
10352 10353 10354 10355
    The function creates a JSON object whose keys are JSON pointers (see [RFC
    6901](https://tools.ietf.org/html/rfc6901)) and whose values are all
    primitive. The original JSON value can be restored using the @ref
    unflatten() function.
N
Niels 已提交
10356

N
Niels 已提交
10357
    @return an object that maps JSON pointers to primitve values
N
Niels 已提交
10358

N
Niels 已提交
10359 10360
    @note Empty objects and arrays are flattened to `null` and will not be
          reconstructed correctly by the @ref unflatten() function.
N
Niels 已提交
10361 10362 10363 10364 10365 10366 10367 10368 10369

    @complexity Linear in the size the JSON value.

    @liveexample{The following code shows how a JSON object is flattened to an
    object whose keys consist of JSON pointers.,flatten}

    @sa @ref unflatten() for the reverse function

    @since version 2.0.0
N
Niels 已提交
10370 10371 10372 10373 10374 10375 10376
    */
    basic_json flatten() const
    {
        basic_json result(value_t::object);
        json_pointer::flatten("", *this, result);
        return result;
    }
N
Niels 已提交
10377 10378

    /*!
N
Niels 已提交
10379 10380 10381 10382 10383 10384 10385 10386 10387 10388
    @brief unflatten a previously flattened JSON value

    The function restores the arbitrary nesting of a JSON value that has been
    flattened before using the @ref flatten() function. The JSON value must
    meet certain constraints:
    1. The value must be an object.
    2. The keys must be JSON pointers (see
       [RFC 6901](https://tools.ietf.org/html/rfc6901))
    3. The mapped values must be primitive JSON types.

N
Niels 已提交
10389
    @return the original JSON from a flattened version
N
Niels 已提交
10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403

    @note Empty objects and arrays are flattened by @ref flatten() to `null`
          values and can not unflattened to their original type. Apart from
          this example, for a JSON value `j`, the following is always true:
          `j == j.flatten().unflatten()`.

    @complexity Linear in the size the JSON value.

    @liveexample{The following code shows how a flattened JSON object is
    unflattened into the original nested JSON object.,unflatten}

    @sa @ref flatten() for the reverse function

    @since version 2.0.0
N
Niels 已提交
10404
    */
N
Niels 已提交
10405
    basic_json unflatten() const
N
Niels 已提交
10406
    {
N
Niels 已提交
10407
        return json_pointer::unflatten(*this);
N
Niels 已提交
10408
    }
N
Niels 已提交
10409 10410

    /// @}
10411

N
Niels 已提交
10412 10413 10414 10415 10416 10417 10418
    //////////////////////////
    // JSON Patch functions //
    //////////////////////////

    /// @name JSON Patch functions
    /// @{

10419 10420 10421
    /*!
    @brief applies a JSON patch

N
Niels 已提交
10422 10423 10424 10425 10426
    [JSON Patch](http://jsonpatch.com) defines a JSON document structure for
    expressing a sequence of operations to apply to a JSON) document. With
    this funcion, a JSON Patch is applied to the current JSON value by
    executing all operations from the patch.

N
Niels 已提交
10427
    @param[in] json_patch  JSON patch document
10428 10429
    @return patched document

N
Niels 已提交
10430 10431 10432 10433 10434 10435 10436 10437 10438 10439
    @note The application of a patch is atomic: Either all operations succeed
          and the patched document is returned or an exception is thrown. In
          any case, the original value is not changed: the patch is applied
          to a copy of the value.

    @throw std::out_of_range if a JSON pointer inside the patch could not
    be resolved successfully in the current JSON value; example: `"key baz
    not found"`
    @throw invalid_argument if the JSON patch is malformed (e.g., mandatory
    attributes are missing); example: `"operation add must have member path"`
10440

N
Niels 已提交
10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453
    @complexity Linear in the size of the JSON value and the length of the
    JSON patch. As usually only a fraction of the JSON value is affected by
    the patch, the complexity can usually be neglected.

    @liveexample{The following code shows how a JSON patch is applied to a
    value.,patch}

    @sa @ref diff -- create a JSON patch by comparing two JSON values

    @sa [RFC 6902 (JSON Patch)](https://tools.ietf.org/html/rfc6902)
    @sa [RFC 6901 (JSON Pointer)](https://tools.ietf.org/html/rfc6901)

    @since version 2.0.0
10454
    */
N
Niels 已提交
10455
    basic_json patch(const basic_json& json_patch) const
10456
    {
N
Niels 已提交
10457
        // make a working copy to apply the patch to
10458 10459
        basic_json result = *this;

N
Niels 已提交
10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492
        // the valid JSON Patch operations
        enum class patch_operations {add, remove, replace, move, copy, test, invalid};

        const auto get_op = [](const std::string op)
        {
            if (op == "add")
            {
                return patch_operations::add;
            }
            if (op == "remove")
            {
                return patch_operations::remove;
            }
            if (op == "replace")
            {
                return patch_operations::replace;
            }
            if (op == "move")
            {
                return patch_operations::move;
            }
            if (op == "copy")
            {
                return patch_operations::copy;
            }
            if (op == "test")
            {
                return patch_operations::test;
            }

            return patch_operations::invalid;
        };

N
Niels 已提交
10493
        // wrapper for "add" operation; add value at ptr
N
Niels 已提交
10494
        const auto operation_add = [&result](json_pointer & ptr, basic_json val)
N
Niels 已提交
10495
        {
N
Niels 已提交
10496 10497
            // adding to the root of the target document means replacing it
            if (ptr.is_root())
N
Niels 已提交
10498
            {
N
Niels 已提交
10499
                result = val;
N
Niels 已提交
10500
            }
N
Niels 已提交
10501
            else
N
Niels 已提交
10502
            {
N
Niels 已提交
10503 10504 10505
                // make sure the top element of the pointer exists
                json_pointer top_pointer = ptr.top();
                if (top_pointer != ptr)
N
Niels 已提交
10506
                {
N
Niels 已提交
10507
                    result.at(top_pointer);
N
Niels 已提交
10508
                }
N
Niels 已提交
10509 10510 10511 10512 10513 10514

                // get reference to parent of JSON pointer ptr
                const auto last_path = ptr.pop_back();
                basic_json& parent = result[ptr];

                switch (parent.m_type)
N
Niels 已提交
10515
                {
N
Niels 已提交
10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549
                    case value_t::null:
                    case value_t::object:
                    {
                        // use operator[] to add value
                        parent[last_path] = val;
                        break;
                    }

                    case value_t::array:
                    {
                        if (last_path == "-")
                        {
                            // special case: append to back
                            parent.push_back(val);
                        }
                        else
                        {
                            const auto idx = std::stoi(last_path);
                            if (static_cast<size_type>(idx) > parent.size())
                            {
                                // avoid undefined behavior
                                throw std::out_of_range("array index " + std::to_string(idx) + " is out of range");
                            }
                            else
                            {
                                // default case: insert add offset
                                parent.insert(parent.begin() + static_cast<difference_type>(idx), val);
                            }
                        }
                        break;
                    }

                    default:
                    {
N
Niels 已提交
10550 10551
                        // if there exists a parent it cannot be primitive
                        assert(false);  // LCOV_EXCL_LINE
N
Niels 已提交
10552
                    }
N
Niels 已提交
10553 10554 10555 10556
                }
            }
        };

N
Niels 已提交
10557
        // wrapper for "remove" operation; remove value at ptr
N
Niels 已提交
10558 10559
        const auto operation_remove = [&result](json_pointer & ptr)
        {
N
Niels 已提交
10560
            // get reference to parent of JSON pointer ptr
N
Niels 已提交
10561 10562
            const auto last_path = ptr.pop_back();
            basic_json& parent = result.at(ptr);
N
Niels 已提交
10563 10564

            // remove child
N
Niels 已提交
10565 10566
            if (parent.is_object())
            {
N
Niels 已提交
10567 10568 10569 10570 10571 10572 10573 10574 10575 10576
                // perform range check
                auto it = parent.find(last_path);
                if (it != parent.end())
                {
                    parent.erase(it);
                }
                else
                {
                    throw std::out_of_range("key '" + last_path + "' not found");
                }
N
Niels 已提交
10577 10578 10579
            }
            else if (parent.is_array())
            {
N
Niels 已提交
10580 10581
                // note erase performs range check
                parent.erase(static_cast<size_type>(std::stoi(last_path)));
N
Niels 已提交
10582 10583 10584
            }
        };

N
Niels 已提交
10585
        // type check
N
Niels 已提交
10586
        if (not json_patch.is_array())
N
Niels 已提交
10587 10588
        {
            // a JSON patch must be an array of objects
N
Niels 已提交
10589
            throw std::invalid_argument("JSON patch must be an array of objects");
N
Niels 已提交
10590 10591 10592
        }

        // iterate and apply th eoperations
N
Niels 已提交
10593
        for (const auto& val : json_patch)
10594
        {
N
Niels 已提交
10595 10596 10597
            // wrapper to get a value for an operation
            const auto get_value = [&val](const std::string & op,
                                          const std::string & member,
N
Niels 已提交
10598
                                          bool string_type) -> basic_json&
10599
            {
N
Niels 已提交
10600 10601
                // find value
                auto it = val.m_value.object->find(member);
10602

N
Niels 已提交
10603 10604
                // context-sensitive error message
                const auto error_msg = (op == "op") ? "operation" : "operation '" + op + "'";
10605

N
Niels 已提交
10606 10607 10608
                // check if desired value is present
                if (it == val.m_value.object->end())
                {
N
Niels 已提交
10609
                    throw std::invalid_argument(error_msg + " must have member '" + member + "'");
N
Niels 已提交
10610
                }
10611

N
Niels 已提交
10612 10613 10614
                // check if result is of type string
                if (string_type and not it->second.is_string())
                {
N
Niels 已提交
10615
                    throw std::invalid_argument(error_msg + " must have string member '" + member + "'");
N
Niels 已提交
10616 10617 10618 10619 10620 10621 10622 10623
                }

                // no error: return value
                return it->second;
            };

            // type check
            if (not val.is_object())
10624
            {
N
Niels 已提交
10625
                throw std::invalid_argument("JSON patch must be an array of objects");
10626 10627
            }

N
Niels 已提交
10628 10629 10630
            // collect mandatory members
            const std::string op = get_value("op", "op", true);
            const std::string path = get_value(op, "path", true);
N
oops  
Niels 已提交
10631
            json_pointer ptr(path);
10632

N
Niels 已提交
10633
            switch (get_op(op))
10634
            {
N
Niels 已提交
10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708 10709
                case patch_operations::add:
                {
                    operation_add(ptr, get_value("add", "value", false));
                    break;
                }

                case patch_operations::remove:
                {
                    operation_remove(ptr);
                    break;
                }

                case patch_operations::replace:
                {
                    // the "path" location must exist - use at()
                    result.at(ptr) = get_value("replace", "value", false);
                    break;
                }

                case patch_operations::move:
                {
                    const std::string from_path = get_value("move", "from", true);
                    json_pointer from_ptr(from_path);

                    // the "from" location must exist - use at()
                    basic_json v = result.at(from_ptr);

                    // The move operation is functionally identical to a
                    // "remove" operation on the "from" location, followed
                    // immediately by an "add" operation at the target
                    // location with the value that was just removed.
                    operation_remove(from_ptr);
                    operation_add(ptr, v);
                    break;
                }

                case patch_operations::copy:
                {
                    const std::string from_path = get_value("copy", "from", true);;
                    const json_pointer from_ptr(from_path);

                    // the "from" location must exist - use at()
                    result[ptr] = result.at(from_ptr);
                    break;
                }

                case patch_operations::test:
                {
                    bool success = false;
                    try
                    {
                        // check if "value" matches the one at "path"
                        // the "path" location must exist - use at()
                        success = (result.at(ptr) == get_value("test", "value", false));
                    }
                    catch (std::out_of_range&)
                    {
                        // ignore out of range errors: success remains false
                    }

                    // throw an exception if test fails
                    if (not success)
                    {
                        throw std::domain_error("unsuccessful: " + val.dump());
                    }

                    break;
                }

                case patch_operations::invalid:
                {
                    // op must be "add", "remove", "replace", "move", "copy", or
                    // "test"
                    throw std::invalid_argument("operation value '" + op + "' is invalid");
                }
10710
            }
N
Niels 已提交
10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749
        }

        return result;
    }

    /*!
    @brief creates a diff as a JSON patch

    Creates a [JSON Patch](http://jsonpatch.com) so that value @a source can
    be changed into the value @a target by calling @ref patch function.

    @invariant For two JSON values @a source and @a target, the following code
    yields always `true`:
    @code {.cpp}
    source.patch(diff(source, target)) == target;
    @endcode

    @note Currently, only `remove`, `add`, and `replace` operations are
          generated.

    @param[in] source  JSON value to copare from
    @param[in] target  JSON value to copare against
    @param[in] path    helper value to create JSON pointers

    @return a JSON patch to convert the @a source to @a target

    @complexity Linear in the lengths of @a source and @a target.

    @liveexample{The following code shows how a JSON patch is created as a
    diff for two JSON values.,diff}

    @sa @ref patch -- apply a JSON patch

    @sa [RFC 6902 (JSON Patch)](https://tools.ietf.org/html/rfc6902)

    @since version 2.0.0
    */
    static basic_json diff(const basic_json& source,
                           const basic_json& target,
10750
                           const std::string& path = "")
N
Niels 已提交
10751 10752 10753 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764
    {
        // the patch
        basic_json result(value_t::array);

        // if the values are the same, return empty patch
        if (source == target)
        {
            return result;
        }

        if (source.type() != target.type())
        {
            // different types: replace value
            result.push_back(
10765
            {
N
Niels 已提交
10766 10767 10768 10769 10770 10771 10772 10773
                {"op", "replace"},
                {"path", path},
                {"value", target}
            });
        }
        else
        {
            switch (source.type())
10774
            {
N
Niels 已提交
10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785
                case value_t::array:
                {
                    // first pass: traverse common elements
                    size_t i = 0;
                    while (i < source.size() and i < target.size())
                    {
                        // recursive call to compare array values at index i
                        auto temp_diff = diff(source[i], target[i], path + "/" + std::to_string(i));
                        result.insert(result.end(), temp_diff.begin(), temp_diff.end());
                        ++i;
                    }
N
Niels 已提交
10786

N
Niels 已提交
10787 10788
                    // i now reached the end of at least one array
                    // in a second pass, traverse the remaining elements
N
Niels 已提交
10789

N
Niels 已提交
10790
                    // remove my remaining elements
N
Niels 已提交
10791
                    const auto end_index = static_cast<difference_type>(result.size());
N
Niels 已提交
10792 10793
                    while (i < source.size())
                    {
N
Niels 已提交
10794 10795
                        // add operations in reverse order to avoid invalid
                        // indices
N
Niels 已提交
10796
                        result.insert(result.begin() + end_index, object(
N
Niels 已提交
10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819
                        {
                            {"op", "remove"},
                            {"path", path + "/" + std::to_string(i)}
                        }));
                        ++i;
                    }

                    // add other remaining elements
                    while (i < target.size())
                    {
                        result.push_back(
                        {
                            {"op", "add"},
                            {"path", path + "/" + std::to_string(i)},
                            {"value", target[i]}
                        });
                        ++i;
                    }

                    break;
                }

                case value_t::object:
10820
                {
N
Niels 已提交
10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872
                    // first pass: traverse this object's elements
                    for (auto it = source.begin(); it != source.end(); ++it)
                    {
                        // escape the key name to be used in a JSON patch
                        const auto key = json_pointer::escape(it.key());

                        if (target.find(it.key()) != target.end())
                        {
                            // recursive call to compare object values at key it
                            auto temp_diff = diff(it.value(), target[it.key()], path + "/" + key);
                            result.insert(result.end(), temp_diff.begin(), temp_diff.end());
                        }
                        else
                        {
                            // found a key that is not in o -> remove it
                            result.push_back(object(
                            {
                                {"op", "remove"},
                                {"path", path + "/" + key}
                            }));
                        }
                    }

                    // second pass: traverse other object's elements
                    for (auto it = target.begin(); it != target.end(); ++it)
                    {
                        if (source.find(it.key()) == source.end())
                        {
                            // found a key that is not in this -> add it
                            const auto key = json_pointer::escape(it.key());
                            result.push_back(
                            {
                                {"op", "add"},
                                {"path", path + "/" + key},
                                {"value", it.value()}
                            });
                        }
                    }

                    break;
                }

                default:
                {
                    // both primitive type: replace value
                    result.push_back(
                    {
                        {"op", "replace"},
                        {"path", path},
                        {"value", target}
                    });
                    break;
10873 10874 10875 10876 10877 10878
                }
            }
        }

        return result;
    }
N
Niels 已提交
10879 10880

    /// @}
N
cleanup  
Niels 已提交
10881 10882 10883 10884 10885 10886 10887
};


/////////////
// presets //
/////////////

N
Niels 已提交
10888 10889 10890
/*!
@brief default JSON class

N
Niels 已提交
10891 10892
This type is the default specialization of the @ref basic_json class which
uses the standard template types.
N
Niels 已提交
10893

N
Niels 已提交
10894
@since version 1.0.0
N
Niels 已提交
10895
*/
N
cleanup  
Niels 已提交
10896 10897 10898 10899
using json = basic_json<>;
}


N
Niels 已提交
10900 10901 10902
///////////////////////
// nonmember support //
///////////////////////
N
cleanup  
Niels 已提交
10903 10904 10905 10906

// specialization of std::swap, and std::hash
namespace std
{
N
Niels 已提交
10907 10908
/*!
@brief exchanges the values of two JSON objects
N
Niels 已提交
10909

N
Niels 已提交
10910
@since version 1.0.0
N
Niels 已提交
10911
*/
N
Niels 已提交
10912
template<>
N
cleanup  
Niels 已提交
10913 10914 10915 10916 10917 10918 10919 10920 10921 10922
inline void swap(nlohmann::json& j1,
                 nlohmann::json& j2) noexcept(
                     is_nothrow_move_constructible<nlohmann::json>::value and
                     is_nothrow_move_assignable<nlohmann::json>::value
                 )
{
    j1.swap(j2);
}

/// hash value for JSON objects
N
Niels 已提交
10923
template<>
N
cleanup  
Niels 已提交
10924 10925
struct hash<nlohmann::json>
{
N
Niels 已提交
10926 10927 10928
    /*!
    @brief return a hash value for a JSON object

N
Niels 已提交
10929
    @since version 1.0.0
N
Niels 已提交
10930
    */
10931
    std::size_t operator()(const nlohmann::json& j) const
N
cleanup  
Niels 已提交
10932 10933
    {
        // a naive hashing via the string representation
N
Niels 已提交
10934 10935
        const auto& h = hash<nlohmann::json::string_t>();
        return h(j.dump());
N
cleanup  
Niels 已提交
10936 10937 10938 10939
    }
};
}

N
Niels 已提交
10940
/*!
N
Niels 已提交
10941 10942
@brief user-defined string literal for JSON values

N
Niels 已提交
10943
This operator implements a user-defined string literal for JSON objects. It
N
Niels 已提交
10944
can be used by adding `"_json"` to a string literal and returns a JSON object
N
Niels 已提交
10945
if no parse error occurred.
N
Niels 已提交
10946

N
Niels 已提交
10947
@param[in] s  a string representation of a JSON object
10948
@param[in] n  the length of string @a s
N
Niels 已提交
10949
@return a JSON object
N
Niels 已提交
10950

N
Niels 已提交
10951
@since version 1.0.0
N
Niels 已提交
10952
*/
10953
inline nlohmann::json operator "" _json(const char* s, std::size_t n)
N
Niels 已提交
10954
{
10955
    return nlohmann::json::parse(s, s + n);
N
Niels 已提交
10956 10957
}

N
Niels 已提交
10958 10959 10960
/*!
@brief user-defined string literal for JSON pointer

N
Niels 已提交
10961
This operator implements a user-defined string literal for JSON Pointers. It
S
Stefan Codrescu 已提交
10962
can be used by adding `"_json_pointer"` to a string literal and returns a JSON pointer
N
Niels 已提交
10963 10964 10965
object if no parse error occurred.

@param[in] s  a string representation of a JSON Pointer
10966
@param[in] n  the length of string @a s
N
Niels 已提交
10967 10968
@return a JSON pointer object

N
Niels 已提交
10969 10970
@since version 2.0.0
*/
10971
inline nlohmann::json::json_pointer operator "" _json_pointer(const char* s, std::size_t n)
N
Niels 已提交
10972
{
10973
    return nlohmann::json::json_pointer(std::string(s, n));
N
Niels 已提交
10974 10975
}

10976 10977 10978 10979 10980
// restore GCC/clang diagnostic settings
#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
    #pragma GCC diagnostic pop
#endif

N
cleanup  
Niels 已提交
10981
#endif