json.hpp 348.5 KB
Newer Older
1 2 3
/*
    __ _____ _____ _____
 __|  |   __|     |   | |  JSON for Modern C++
N
Niels 已提交
4
|  |  |__   |  |  | | | |  version 2.0.6
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
Niels 已提交
31 32

#include <algorithm>
33
#include <array>
N
Niels 已提交
34
#include <cassert>
N
Niels 已提交
35
#include <cctype>
N
Niels 已提交
36
#include <ciso646>
N
Niels 已提交
37
#include <cmath>
N
Niels 已提交
38
#include <cstddef>
39
#include <cstdint>
N
Niels 已提交
40
#include <cstdlib>
N
cleanup  
Niels 已提交
41
#include <cstring>
N
Niels 已提交
42 43
#include <functional>
#include <initializer_list>
N
Niels 已提交
44
#include <iomanip>
N
Niels 已提交
45 46 47
#include <iostream>
#include <iterator>
#include <limits>
N
Niels 已提交
48
#include <locale>
N
Niels 已提交
49 50
#include <map>
#include <memory>
N
Niels 已提交
51
#include <numeric>
N
Niels 已提交
52
#include <sstream>
N
Niels 已提交
53
#include <stdexcept>
N
Niels 已提交
54 55 56 57 58
#include <string>
#include <type_traits>
#include <utility>
#include <vector>

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
Niels 已提交
87
/*!
N
Niels 已提交
88
@brief namespace for Niels Lohmann
N
Niels 已提交
89
@see https://github.com/nlohmann
N
Niels 已提交
90
@since version 1.0.0
N
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 126
/*!
@brief helper class to create locales with decimal point
N
Niels 已提交
127 128 129 130 131 132 133

This struct is used a default locale during the JSON serialization. JSON
requires the decimal point to be `.`, so this function overloads the
`do_decimal_point()` function to return `.`. This function is called by
float-to-string conversions to retrieve the decimal separator between integer
and fractional parts.

N
Niels 已提交
134
@sa https://github.com/nlohmann/json/issues/51#issuecomment-86869315
N
Niels 已提交
135
@since version 2.0.0
N
Niels 已提交
136
*/
N
Niels 已提交
137
struct DecimalSeparator : std::numpunct<char>
N
Niels 已提交
138 139 140 141 142 143 144
{
    char do_decimal_point() const
    {
        return '.';
    }
};

N
Niels 已提交
145
}
N
Niels 已提交
146

N
Niels 已提交
147
/*!
N
Niels 已提交
148
@brief a class to store JSON values
N
Niels 已提交
149

N
Niels 已提交
150
@tparam ObjectType type for JSON objects (`std::map` by default; will be used
N
Niels 已提交
151
in @ref object_t)
N
Niels 已提交
152
@tparam ArrayType type for JSON arrays (`std::vector` by default; will be used
N
Niels 已提交
153
in @ref array_t)
N
Niels 已提交
154
@tparam StringType type for JSON strings and object keys (`std::string` by
N
Niels 已提交
155
default; will be used in @ref string_t)
N
Niels 已提交
156
@tparam BooleanType type for JSON booleans (`bool` by default; will be used
N
Niels 已提交
157
in @ref boolean_t)
N
Niels 已提交
158
@tparam NumberIntegerType type for JSON integer numbers (`int64_t` by
N
Niels 已提交
159
default; will be used in @ref number_integer_t)
N
Niels 已提交
160 161
@tparam NumberUnsignedType type for JSON unsigned integer numbers (@c
`uint64_t` by default; will be used in @ref number_unsigned_t)
N
Niels 已提交
162
@tparam NumberFloatType type for JSON floating-point numbers (`double` by
N
Niels 已提交
163
default; will be used in @ref number_float_t)
N
Niels 已提交
164
@tparam AllocatorType type of the allocator to use (`std::allocator` by
N
Niels 已提交
165
default)
N
Niels 已提交
166

N
Niels 已提交
167 168
@requirement The class satisfies the following concept requirements:
- Basic
N
Niels 已提交
169 170 171 172 173
 - [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 已提交
174
   A JSON value can be copy-constructed from an lvalue expression.
N
Niels 已提交
175 176 177 178 179 180
 - [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 已提交
181
- Layout
N
Niels 已提交
182 183 184 185 186
 - [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 已提交
187
- Library-wide
N
Niels 已提交
188 189 190 191 192 193 194 195 196 197 198 199
 - [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 已提交
200
- Container
N
Niels 已提交
201 202 203 204 205
 - [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 已提交
206

207 208 209 210 211 212 213
@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 已提交
214
@internal
N
Niels 已提交
215
@note ObjectType trick from http://stackoverflow.com/a/9860911
N
Niels 已提交
216
@endinternal
N
Niels 已提交
217

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

N
Niels 已提交
221
@since version 1.0.0
N
Niels 已提交
222 223

@nosubgrouping
N
Niels 已提交
224 225 226 227 228 229
*/
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,
230 231
    class NumberIntegerType = std::int64_t,
    class NumberUnsignedType = std::uint64_t,
N
Niels 已提交
232
    class NumberFloatType = double,
N
Niels 已提交
233
    template<typename U> class AllocatorType = std::allocator
N
Niels 已提交
234 235 236
    >
class basic_json
{
237 238
  private:
    /// workaround type for MSVC
N
Niels 已提交
239 240
    using basic_json_t = basic_json<ObjectType, ArrayType, StringType,
          BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType,
N
Niels 已提交
241
          AllocatorType>;
242 243

  public:
N
Niels 已提交
244 245 246
    // forward declarations
    template<typename Base> class json_reverse_iterator;
    class json_pointer;
247

N
Niels 已提交
248 249 250 251
    /////////////////////
    // container types //
    /////////////////////

N
Niels 已提交
252
    /// @name container types
N
Niels 已提交
253 254
    /// The canonic container types to use @ref basic_json like any other STL
    /// container.
N
Niels 已提交
255 256
    /// @{

N
Niels 已提交
257
    /// the type of elements in a basic_json container
N
Niels 已提交
258
    using value_type = basic_json;
N
Niels 已提交
259

N
Niels 已提交
260
    /// the type of an element reference
N
Niels 已提交
261
    using reference = value_type&;
N
Niels 已提交
262
    /// the type of an element const reference
N
Niels 已提交
263
    using const_reference = const value_type&;
N
Niels 已提交
264

N
Niels 已提交
265
    /// a type to represent differences between iterators
N
Niels 已提交
266
    using difference_type = std::ptrdiff_t;
N
Niels 已提交
267
    /// a type to represent container sizes
N
Niels 已提交
268 269 270
    using size_type = std::size_t;

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

N
Niels 已提交
273
    /// the type of an element pointer
N
Niels 已提交
274
    using pointer = typename std::allocator_traits<allocator_type>::pointer;
N
Niels 已提交
275
    /// the type of an element const pointer
N
Niels 已提交
276
    using const_pointer = typename std::allocator_traits<allocator_type>::const_pointer;
N
Niels 已提交
277

N
Niels 已提交
278 279 280 281 282
    /// 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 已提交
283
    using reverse_iterator = json_reverse_iterator<typename basic_json::iterator>;
N
Niels 已提交
284
    /// a const reverse iterator for a basic_json container
N
Niels 已提交
285
    using const_reverse_iterator = json_reverse_iterator<typename basic_json::const_iterator>;
N
Niels 已提交
286

N
Niels 已提交
287 288 289
    /// @}


N
Niels 已提交
290 291 292
    /*!
    @brief returns the allocator associated with the container
    */
N
Niels 已提交
293
    static allocator_type get_allocator()
N
Niels 已提交
294 295 296 297 298
    {
        return allocator_type();
    }


N
Niels 已提交
299 300 301 302
    ///////////////////////////
    // JSON value data types //
    ///////////////////////////

N
Niels 已提交
303
    /// @name JSON value data types
N
Niels 已提交
304 305
    /// The data types to store a JSON value. These types are derived from
    /// the template arguments passed to class @ref basic_json.
N
Niels 已提交
306 307
    /// @{

N
Niels 已提交
308 309 310 311 312 313 314 315
    /*!
    @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 已提交
316 317 318 319 320
    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 已提交
321 322
    @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 已提交
323 324 325
    inside the container.
    @tparam AllocatorType the allocator to use for objects (e.g.,
    `std::allocator`)
N
Niels 已提交
326 327 328 329

    #### Default type

    With the default values for @a ObjectType (`std::map`), @a StringType
N
Niels 已提交
330 331
    (`std::string`), and @a AllocatorType (`std::allocator`), the default
    value for @a object_t is:
N
Niels 已提交
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347

    @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 已提交
348 349
      that all software implementations receiving that object will agree on
      the name-value mappings.
N
Niels 已提交
350 351 352 353 354
    - 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 已提交
355 356 357
      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 已提交
358 359 360 361 362 363 364 365 366 367 368 369
    - 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 已提交
370 371
    runtime environment. A theoretical limit can be queried by calling the
    @ref max_size function of a JSON object.
N
Niels 已提交
372 373 374

    #### Storage

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

379 380
    @sa @ref array_t -- type for an array value

N
Niels 已提交
381
    @since version 1.0.0
N
Niels 已提交
382

N
Niels 已提交
383 384 385 386 387
    @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 已提交
388 389
    7159](http://rfc7159.net/rfc7159), because any order implements the
    specified "unordered" nature of JSON objects.
N
Niels 已提交
390
    */
N
Niels 已提交
391 392 393 394 395
    using object_t = ObjectType<StringType,
          basic_json,
          std::less<StringType>,
          AllocatorType<std::pair<const StringType,
          basic_json>>>;
N
Niels 已提交
396 397 398 399 400 401 402

    /*!
    @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 已提交
403 404 405 406 407
    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 已提交
408
    @tparam AllocatorType allocator to use for arrays (e.g., `std::allocator`)
N
Niels 已提交
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428

    #### 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 已提交
429 430
    runtime environment. A theoretical limit can be queried by calling the
    @ref max_size function of a JSON array.
N
Niels 已提交
431 432 433

    #### Storage

434
    Arrays are stored as pointers in a @ref basic_json type. That is, for any
N
Niels 已提交
435
    access to array values, a pointer of type `array_t*` must be dereferenced.
436 437 438

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

N
Niels 已提交
439
    @since version 1.0.0
N
Niels 已提交
440
    */
N
Niels 已提交
441
    using array_t = ArrayType<basic_json, AllocatorType<basic_json>>;
N
Niels 已提交
442 443 444 445 446 447 448

    /*!
    @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 已提交
449
    To store objects in C++, a type is defined by the template parameter
N
Niels 已提交
450 451
    described below. Unicode values are split by the JSON class into
    byte-sized characters during deserialization.
N
Niels 已提交
452

N
Niels 已提交
453 454
    @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 已提交
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481

    #### 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

482 483
    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 已提交
484
    dereferenced.
485

N
Niels 已提交
486
    @since version 1.0.0
N
Niels 已提交
487
    */
N
Niels 已提交
488
    using string_t = StringType;
N
Niels 已提交
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509

    /*!
    @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

510 511
    Boolean values are stored directly inside a @ref basic_json type.

N
Niels 已提交
512
    @since version 1.0.0
N
Niels 已提交
513
    */
N
Niels 已提交
514
    using boolean_t = BooleanType;
N
Niels 已提交
515 516 517 518 519

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

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
520 521 522 523 524 525 526 527 528 529 530 531 532
    > 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 已提交
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550

    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 已提交
551 552
      instance, the C++ integer literal `010` will be serialized to `8`.
      During deserialization, leading zeros yield an error.
N
Niels 已提交
553 554 555 556 557 558 559 560 561 562
    - 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 已提交
563 564 565 566
    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 已提交
567 568 569 570 571 572 573 574 575 576 577

    [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

578 579 580 581
    Integer number values are stored directly inside a @ref basic_json type.

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

582 583
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
584
    @since version 1.0.0
N
Niels 已提交
585
    */
N
Niels 已提交
586
    using number_integer_t = NumberIntegerType;
N
Niels 已提交
587

588 589 590 591
    /*!
    @brief a type for a number (unsigned)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
    > 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.
608 609 610

    #### Default type

N
Niels 已提交
611 612
    With the default values for @a NumberUnsignedType (`uint64_t`), the
    default value for @a number_unsigned_t is:
613 614 615 616 617 618 619 620 621 622

    @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 已提交
623 624
      instance, the C++ integer literal `010` will be serialized to `8`.
      During deserialization, leading zeros yield an error.
625 626 627 628 629 630 631 632
    - 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 已提交
633 634 635 636 637
    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.
638 639 640 641 642 643 644

    [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 已提交
645 646
    number_integer_t type) of the exactly supported range [0, UINT64_MAX],
    this class's integer type is interoperable.
647 648 649 650 651 652 653 654 655 656 657

    #### 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 已提交
658

N
Niels 已提交
659 660 661 662
    /*!
    @brief a type for a number (floating-point)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
663 664 665 666 667 668 669 670 671 672 673 674 675
    > 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 已提交
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691

    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 已提交
692 693
      leading zeros in floating-point literals will be ignored. Internally,
      the value will be stored as decimal number. For instance, the C++
N
Niels 已提交
694 695 696 697 698 699 700 701 702 703
      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 已提交
704 705 706
    > 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 已提交
707 708 709 710
    > precision.

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

    #### Storage

716 717 718 719 720
    Floating-point number values are stored directly inside a @ref basic_json
    type.

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

721 722
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
723
    @since version 1.0.0
N
Niels 已提交
724
    */
N
Niels 已提交
725 726
    using number_float_t = NumberFloatType;

N
Niels 已提交
727 728
    /// @}

N
Niels 已提交
729

N
Niels 已提交
730 731 732
    ///////////////////////////
    // JSON type enumeration //
    ///////////////////////////
N
Niels 已提交
733

N
Niels 已提交
734
    /*!
N
Niels 已提交
735
    @brief the JSON type enumeration
N
Niels 已提交
736

N
Niels 已提交
737
    This enumeration collects the different JSON types. It is internally used
738 739
    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 已提交
740 741 742 743 744 745 746 747 748 749 750 751 752
    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
753

N
Niels 已提交
754
    @since version 1.0.0
N
Niels 已提交
755
    */
N
Niels 已提交
756 757
    enum class value_t : uint8_t
    {
N
Niels 已提交
758 759 760 761 762
        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 已提交
763
        number_integer,  ///< number value (signed integer)
N
Niels 已提交
764 765 766
        number_unsigned, ///< number value (unsigned integer)
        number_float,    ///< number value (floating-point)
        discarded        ///< discarded by the the parser callback function
N
Niels 已提交
767 768
    };

N
Niels 已提交
769

N
Niels 已提交
770
  private:
N
Niels 已提交
771

N
Cleanup  
Niels 已提交
772 773
    /// helper for exception-safe object creation
    template<typename T, typename... Args>
N
cleanup  
Niels 已提交
774
    static T* create(Args&& ... args)
N
Cleanup  
Niels 已提交
775 776 777 778 779 780 781 782
    {
        AllocatorType<T> alloc;
        auto deleter = [&](T * object)
        {
            alloc.deallocate(object, 1);
        };
        std::unique_ptr<T, decltype(deleter)> object(alloc.allocate(1), deleter);
        alloc.construct(object.get(), std::forward<Args>(args)...);
N
Niels 已提交
783
        assert(object.get() != nullptr);
N
Cleanup  
Niels 已提交
784 785 786
        return object.release();
    }

N
Niels 已提交
787 788 789 790
    ////////////////////////
    // JSON value storage //
    ////////////////////////

791 792 793
    /*!
    @brief a JSON value

N
Niels 已提交
794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
    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.
812

N
Niels 已提交
813
    @since version 1.0.0
814
    */
N
Niels 已提交
815 816 817 818 819 820 821 822
    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 已提交
823
        /// boolean
N
Niels 已提交
824 825 826
        boolean_t boolean;
        /// number (integer)
        number_integer_t number_integer;
827 828
        /// number (unsigned integer)
        number_unsigned_t number_unsigned;
N
Niels 已提交
829
        /// number (floating-point)
N
Niels 已提交
830 831 832
        number_float_t number_float;

        /// default constructor (for null values)
N
Niels 已提交
833
        json_value() = default;
N
Niels 已提交
834
        /// constructor for booleans
N
Niels 已提交
835
        json_value(boolean_t v) noexcept : boolean(v) {}
N
Niels 已提交
836
        /// constructor for numbers (integer)
N
Niels 已提交
837
        json_value(number_integer_t v) noexcept : number_integer(v) {}
838 839
        /// constructor for numbers (unsigned)
        json_value(number_unsigned_t v) noexcept : number_unsigned(v) {}
N
Niels 已提交
840
        /// constructor for numbers (floating-point)
N
Niels 已提交
841
        json_value(number_float_t v) noexcept : number_float(v) {}
N
Niels 已提交
842
        /// constructor for empty values of a given type
N
Niels 已提交
843
        json_value(value_t t)
N
Niels 已提交
844 845 846
        {
            switch (t)
            {
847
                case value_t::object:
N
Niels 已提交
848
                {
N
Cleanup  
Niels 已提交
849
                    object = create<object_t>();
N
Niels 已提交
850 851
                    break;
                }
N
Niels 已提交
852

853
                case value_t::array:
N
Niels 已提交
854
                {
N
Cleanup  
Niels 已提交
855
                    array = create<array_t>();
N
Niels 已提交
856 857
                    break;
                }
N
Niels 已提交
858

859
                case value_t::string:
N
Niels 已提交
860
                {
N
Cleanup  
Niels 已提交
861
                    string = create<string_t>("");
N
Niels 已提交
862 863
                    break;
                }
N
Niels 已提交
864

865
                case value_t::boolean:
N
Niels 已提交
866 867 868 869 870
                {
                    boolean = boolean_t(false);
                    break;
                }

871
                case value_t::number_integer:
N
Niels 已提交
872 873 874 875
                {
                    number_integer = number_integer_t(0);
                    break;
                }
N
Niels 已提交
876

877 878 879 880 881
                case value_t::number_unsigned:
                {
                    number_unsigned = number_unsigned_t(0);
                    break;
                }
N
Niels 已提交
882

883
                case value_t::number_float:
N
Niels 已提交
884 885 886 887
                {
                    number_float = number_float_t(0.0);
                    break;
                }
888 889 890 891 892

                default:
                {
                    break;
                }
N
Niels 已提交
893 894
            }
        }
N
Niels 已提交
895 896

        /// constructor for strings
N
Niels 已提交
897
        json_value(const string_t& value)
N
Niels 已提交
898
        {
N
Cleanup  
Niels 已提交
899
            string = create<string_t>(value);
N
Niels 已提交
900 901 902
        }

        /// constructor for objects
N
Niels 已提交
903
        json_value(const object_t& value)
N
Niels 已提交
904
        {
N
Cleanup  
Niels 已提交
905
            object = create<object_t>(value);
N
Niels 已提交
906 907 908
        }

        /// constructor for arrays
N
Niels 已提交
909
        json_value(const array_t& value)
N
Niels 已提交
910
        {
N
Cleanup  
Niels 已提交
911
            array = create<array_t>(value);
N
Niels 已提交
912
        }
N
Niels 已提交
913 914
    };

915 916 917 918 919 920 921 922 923 924 925 926 927 928 929
    /*!
    @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 已提交
930 931

  public:
N
Niels 已提交
932 933 934 935
    //////////////////////////
    // JSON parser callback //
    //////////////////////////

N
Niels 已提交
936 937 938 939 940
    /*!
    @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.
941

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

N
Niels 已提交
944
    @since version 1.0.0
N
Niels 已提交
945
    */
N
Niels 已提交
946 947
    enum class parse_event_t : uint8_t
    {
N
Niels 已提交
948 949 950 951 952 953 954 955 956 957 958 959
        /// 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 已提交
960 961
    };

N
Niels 已提交
962 963 964 965
    /*!
    @brief per-element parser callback type

    With a parser callback function, the result of parsing a JSON text can be
N
Niels 已提交
966
    influenced. When passed to @ref parse(std::istream&, const
N
Niels 已提交
967
    parser_callback_t) or @ref parse(const char*, const parser_callback_t),
N
Niels 已提交
968 969 970 971 972
    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 已提交
973 974 975 976 977 978 979 980 981 982 983 984 985 986

    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 已提交
987 988
    @image html callback_events.png "Example when certain parse events are triggered"

N
Niels 已提交
989 990
    Discarding a value (i.e., returning `false`) has different effects
    depending on the context in which function was called:
N
Niels 已提交
991 992 993

    - Discarded values in structured types are skipped. That is, the parser
      will behave as if the discarded value was never read.
N
Niels 已提交
994 995
    - 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 已提交
996

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

N
Niels 已提交
999
    @param[in] event  an event of type parse_event_t indicating the context in
N
Niels 已提交
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
    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 已提交
1010
    @ref parse(const char*, parser_callback_t) for examples
1011

N
Niels 已提交
1012
    @since version 1.0.0
N
Niels 已提交
1013
    */
N
Niels 已提交
1014 1015 1016
    using parser_callback_t = std::function<bool(int depth,
                              parse_event_t event,
                              basic_json& parsed)>;
N
Niels 已提交
1017

N
Niels 已提交
1018 1019 1020 1021 1022

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

N
Niels 已提交
1023
    /// @name constructors and destructors
N
Niels 已提交
1024 1025
    /// Constructors of class @ref basic_json, copy/move constructor, copy
    /// assignment, static functions creating objects, and the destructor.
N
Niels 已提交
1026 1027
    /// @{

N
Niels 已提交
1028 1029 1030
    /*!
    @brief create an empty value with a given type

N
Niels 已提交
1031 1032 1033 1034 1035
    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 已提交
1036 1037 1038 1039 1040 1041
    null        | `null`
    boolean     | `false`
    string      | `""`
    number      | `0`
    object      | `{}`
    array       | `[]`
N
Niels 已提交
1042

1043
    @param[in] value_type  the type of the value to create
N
Niels 已提交
1044 1045 1046

    @complexity Constant.

N
Niels 已提交
1047
    @throw std::bad_alloc if allocation for object, array, or string value
N
Niels 已提交
1048
    fails
N
Niels 已提交
1049 1050 1051

    @liveexample{The following code shows the constructor for different @ref
    value_t values,basic_json__value_t}
1052 1053 1054 1055 1056 1057

    @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 已提交
1058 1059 1060 1061
    @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
1062 1063
    @sa @ref basic_json(const number_unsigned_t) -- create a number (unsigned)
    value
1064

N
Niels 已提交
1065
    @since version 1.0.0
N
Niels 已提交
1066
    */
1067 1068
    basic_json(const value_t value_type)
        : m_type(value_type), m_value(value_type)
1069 1070 1071
    {
        assert_invariant();
    }
N
Niels 已提交
1072

N
Niels 已提交
1073
    /*!
N
Niels 已提交
1074
    @brief create a null object
N
Niels 已提交
1075

N
Niels 已提交
1076 1077
    Create a `null` JSON value. It either takes a null pointer as parameter
    (explicitly creating `null`) or no parameter (implicitly creating `null`).
N
Niels 已提交
1078 1079
    The passed null pointer itself is not read -- it is only used to choose
    the right constructor.
N
Niels 已提交
1080 1081 1082

    @complexity Constant.

N
Niels 已提交
1083 1084 1085
    @exceptionsafety No-throw guarantee: this constructor never throws
    exceptions.

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

N
Niels 已提交
1089
    @since version 1.0.0
N
Niels 已提交
1090
    */
N
Niels 已提交
1091
    basic_json(std::nullptr_t = nullptr) noexcept
N
Niels 已提交
1092
        : basic_json(value_t::null)
1093 1094 1095
    {
        assert_invariant();
    }
N
Niels 已提交
1096

N
Niels 已提交
1097 1098 1099 1100 1101
    /*!
    @brief create an object (explicit)

    Create an object JSON value with a given content.

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

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

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

N
Niels 已提交
1108 1109
    @liveexample{The following code shows the constructor with an @ref
    object_t parameter.,basic_json__object_t}
N
Niels 已提交
1110

1111 1112 1113
    @sa @ref basic_json(const CompatibleObjectType&) -- create an object value
    from a compatible STL container

N
Niels 已提交
1114
    @since version 1.0.0
N
Niels 已提交
1115
    */
1116 1117
    basic_json(const object_t& val)
        : m_type(value_t::object), m_value(val)
1118 1119 1120
    {
        assert_invariant();
    }
N
Niels 已提交
1121

N
Niels 已提交
1122 1123 1124 1125
    /*!
    @brief create an object (implicit)

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

N
Niels 已提交
1129 1130 1131 1132 1133
    @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 已提交
1134

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

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

N
Niels 已提交
1139
    @throw std::bad_alloc if allocation for object value fails
N
Niels 已提交
1140 1141 1142 1143

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

1144 1145
    @sa @ref basic_json(const object_t&) -- create an object value

N
Niels 已提交
1146
    @since version 1.0.0
N
Niels 已提交
1147
    */
N
Niels 已提交
1148 1149 1150
    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>
1151
    basic_json(const CompatibleObjectType& val)
N
Niels 已提交
1152 1153
        : m_type(value_t::object)
    {
1154 1155
        using std::begin;
        using std::end;
1156
        m_value.object = create<object_t>(begin(val), end(val));
1157
        assert_invariant();
N
Niels 已提交
1158
    }
N
Niels 已提交
1159

N
Niels 已提交
1160 1161 1162 1163 1164
    /*!
    @brief create an array (explicit)

    Create an array JSON value with a given content.

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

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

N
Niels 已提交
1169
    @throw std::bad_alloc if allocation for array value fails
N
Niels 已提交
1170 1171 1172 1173

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

1174 1175 1176
    @sa @ref basic_json(const CompatibleArrayType&) -- create an array value
    from a compatible STL containers

N
Niels 已提交
1177
    @since version 1.0.0
N
Niels 已提交
1178
    */
1179 1180
    basic_json(const array_t& val)
        : m_type(value_t::array), m_value(val)
1181 1182 1183
    {
        assert_invariant();
    }
N
Niels 已提交
1184

N
Niels 已提交
1185 1186 1187 1188
    /*!
    @brief create an array (implicit)

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

N
Niels 已提交
1192 1193 1194 1195 1196
    @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 已提交
1197

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

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

N
Niels 已提交
1202
    @throw std::bad_alloc if allocation for array value fails
N
Niels 已提交
1203 1204 1205 1206

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

1207 1208
    @sa @ref basic_json(const array_t&) -- create an array value

N
Niels 已提交
1209
    @since version 1.0.0
N
Niels 已提交
1210
    */
N
Niels 已提交
1211 1212 1213 1214 1215 1216 1217 1218
    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>
1219
    basic_json(const CompatibleArrayType& val)
N
Niels 已提交
1220 1221
        : m_type(value_t::array)
    {
1222 1223
        using std::begin;
        using std::end;
1224
        m_value.array = create<array_t>(begin(val), end(val));
1225
        assert_invariant();
N
Niels 已提交
1226
    }
N
Niels 已提交
1227

N
Niels 已提交
1228 1229 1230 1231 1232
    /*!
    @brief create a string (explicit)

    Create an string JSON value with a given content.

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

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

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

N
Niels 已提交
1239 1240
    @liveexample{The following code shows the constructor with an @ref
    string_t parameter.,basic_json__string_t}
N
Niels 已提交
1241

1242 1243 1244 1245 1246
    @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 已提交
1247
    @since version 1.0.0
N
Niels 已提交
1248
    */
1249 1250
    basic_json(const string_t& val)
        : m_type(value_t::string), m_value(val)
1251 1252 1253
    {
        assert_invariant();
    }
N
Niels 已提交
1254

N
Niels 已提交
1255 1256 1257
    /*!
    @brief create a string (explicit)

N
Niels 已提交
1258
    Create a string JSON value with a given content.
N
Niels 已提交
1259

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

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

N
Niels 已提交
1264
    @throw std::bad_alloc if allocation for string value fails
N
Niels 已提交
1265 1266 1267 1268

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

1269 1270 1271 1272
    @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 已提交
1273
    @since version 1.0.0
N
Niels 已提交
1274
    */
1275 1276
    basic_json(const typename string_t::value_type* val)
        : basic_json(string_t(val))
1277 1278 1279
    {
        assert_invariant();
    }
N
Niels 已提交
1280

N
Niels 已提交
1281 1282 1283 1284 1285
    /*!
    @brief create a string (implicit)

    Create a string JSON value with a given content.

1286
    @param[in] val  a value for the string
N
Niels 已提交
1287 1288

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

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

N
Niels 已提交
1293
    @throw std::bad_alloc if allocation for string value fails
N
Niels 已提交
1294 1295 1296 1297

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

1298 1299 1300 1301
    @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 已提交
1302
    @since version 1.0.0
N
Niels 已提交
1303
    */
N
Niels 已提交
1304 1305
    template<class CompatibleStringType, typename std::enable_if<
                 std::is_constructible<string_t, CompatibleStringType>::value, int>::type = 0>
1306 1307
    basic_json(const CompatibleStringType& val)
        : basic_json(string_t(val))
1308 1309 1310
    {
        assert_invariant();
    }
N
Niels 已提交
1311

N
Niels 已提交
1312 1313 1314 1315 1316
    /*!
    @brief create a boolean (explicit)

    Creates a JSON boolean type from a given value.

1317
    @param[in] val  a boolean value to store
N
Niels 已提交
1318 1319 1320 1321 1322

    @complexity Constant.

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

N
Niels 已提交
1324
    @since version 1.0.0
N
Niels 已提交
1325
    */
N
Niels 已提交
1326
    basic_json(boolean_t val) noexcept
1327
        : m_type(value_t::boolean), m_value(val)
1328 1329 1330
    {
        assert_invariant();
    }
N
Niels 已提交
1331

N
Niels 已提交
1332 1333 1334
    /*!
    @brief create an integer number (explicit)

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

N
Niels 已提交
1337
    @tparam T A helper type to remove this function via SFINAE in case @ref
N
Niels 已提交
1338 1339 1340
    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 已提交
1341

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

N
Niels 已提交
1344 1345
    @complexity Constant.

N
Niels 已提交
1346
    @liveexample{The example below shows the construction of an integer
N
Niels 已提交
1347
    number value.,basic_json__number_integer_t}
N
Niels 已提交
1348

1349 1350 1351 1352
    @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 已提交
1353
    @since version 1.0.0
N
Niels 已提交
1354
    */
N
Niels 已提交
1355 1356 1357
    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 已提交
1358
    basic_json(const number_integer_t val) noexcept
1359
        : m_type(value_t::number_integer), m_value(val)
1360 1361 1362
    {
        assert_invariant();
    }
N
Niels 已提交
1363

N
Niels 已提交
1364
    /*!
N
Niels 已提交
1365 1366
    @brief create an integer number from an enum type (explicit)

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

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

N
Niels 已提交
1371 1372 1373
    @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 已提交
1374 1375
    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 已提交
1376 1377 1378

    @complexity Constant.

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

1382 1383 1384 1385 1386
    @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 已提交
1387
    @since version 1.0.0
N
Niels 已提交
1388
    */
N
Niels 已提交
1389
    basic_json(const int val) noexcept
N
Niels 已提交
1390
        : m_type(value_t::number_integer),
1391
          m_value(static_cast<number_integer_t>(val))
1392 1393 1394
    {
        assert_invariant();
    }
N
Niels 已提交
1395

N
Niels 已提交
1396 1397 1398
    /*!
    @brief create an integer number (implicit)

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

N
Niels 已提交
1403
    @tparam CompatibleNumberIntegerType An integer type which is compatible to
N
Niels 已提交
1404 1405
    @ref number_integer_t. Examples include the types `int`, `int32_t`,
    `long`, and `short`.
N
Niels 已提交
1406

1407
    @param[in] val  an integer to create a JSON number from
N
Niels 已提交
1408 1409 1410

    @complexity Constant.

N
Niels 已提交
1411 1412
    @liveexample{The example below shows the construction of several integer
    number values from compatible
N
Niels 已提交
1413 1414
    types.,basic_json__CompatibleIntegerNumberType}

1415 1416 1417 1418
    @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 已提交
1419
    @since version 1.0.0
N
Niels 已提交
1420
    */
N
Niels 已提交
1421
    template<typename CompatibleNumberIntegerType, typename std::enable_if<
N
Niels 已提交
1422
                 std::is_constructible<number_integer_t, CompatibleNumberIntegerType>::value and
N
Niels 已提交
1423 1424
                 std::numeric_limits<CompatibleNumberIntegerType>::is_integer and
                 std::numeric_limits<CompatibleNumberIntegerType>::is_signed,
N
Niels 已提交
1425
                 CompatibleNumberIntegerType>::type = 0>
1426
    basic_json(const CompatibleNumberIntegerType val) noexcept
N
Niels 已提交
1427
        : m_type(value_t::number_integer),
1428
          m_value(static_cast<number_integer_t>(val))
1429 1430 1431
    {
        assert_invariant();
    }
N
Niels 已提交
1432

1433 1434 1435 1436 1437
    /*!
    @brief create an unsigned integer number (explicit)

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

N
Niels 已提交
1438 1439
    @tparam T  helper type to compare number_unsigned_t and unsigned int (not
    visible in) the interface.
1440 1441 1442 1443 1444 1445 1446 1447 1448 1449

    @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 已提交
1450 1451 1452
    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 已提交
1453
    basic_json(const number_unsigned_t val) noexcept
1454
        : m_type(value_t::number_unsigned), m_value(val)
1455 1456 1457
    {
        assert_invariant();
    }
N
Niels 已提交
1458

1459 1460 1461
    /*!
    @brief create an unsigned number (implicit)

N
Niels 已提交
1462 1463 1464
    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.
1465

N
Niels 已提交
1466 1467
    @tparam CompatibleNumberUnsignedType An integer type which is compatible
    to @ref number_unsigned_t. Examples may include the types `unsigned int`,
N
Niels 已提交
1468
    `uint32_t`, or `unsigned short`.
1469 1470 1471 1472 1473 1474 1475 1476 1477 1478

    @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 已提交
1479 1480 1481 1482 1483
    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>
1484 1485 1486
    basic_json(const CompatibleNumberUnsignedType val) noexcept
        : m_type(value_t::number_unsigned),
          m_value(static_cast<number_unsigned_t>(val))
1487 1488 1489
    {
        assert_invariant();
    }
1490

N
Niels 已提交
1491 1492 1493 1494 1495
    /*!
    @brief create a floating-point number (explicit)

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

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

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

N
Niels 已提交
1505
    @complexity Constant.
N
Niels 已提交
1506 1507 1508

    @liveexample{The following example creates several floating-point
    values.,basic_json__number_float_t}
1509 1510 1511 1512

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

N
Niels 已提交
1513
    @since version 1.0.0
N
Niels 已提交
1514
    */
N
Niels 已提交
1515
    basic_json(const number_float_t val) noexcept
1516
        : m_type(value_t::number_float), m_value(val)
N
Niels 已提交
1517 1518
    {
        // replace infinity and NAN by null
1519
        if (not std::isfinite(val))
N
Niels 已提交
1520 1521 1522 1523
        {
            m_type = value_t::null;
            m_value = json_value();
        }
1524 1525

        assert_invariant();
N
Niels 已提交
1526
    }
N
Niels 已提交
1527

N
Niels 已提交
1528 1529 1530 1531
    /*!
    @brief create an floating-point number (implicit)

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

N
Niels 已提交
1535 1536 1537
    @tparam CompatibleNumberFloatType A floating-point type which is
    compatible to @ref number_float_t. Examples may include the types `float`
    or `double`.
N
Niels 已提交
1538

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

1541
    @note [RFC 7159](http://www.rfc-editor.org/rfc/rfc7159.txt), section 6
N
Niels 已提交
1542
    disallows NaN values:
N
Niels 已提交
1543 1544
    > Numeric values that cannot be represented in the grammar below (such as
    > Infinity and NaN) are not permitted.
N
Niels 已提交
1545 1546
    In case the parameter @a val is not a number, a JSON null value is
    created instead.
N
Niels 已提交
1547 1548 1549

    @complexity Constant.

N
Niels 已提交
1550
    @liveexample{The example below shows the construction of several
N
Niels 已提交
1551 1552 1553
    floating-point number values from compatible
    types.,basic_json__CompatibleNumberFloatType}

1554 1555 1556
    @sa @ref basic_json(const number_float_t) -- create a number value
    (floating-point)

N
Niels 已提交
1557
    @since version 1.0.0
N
Niels 已提交
1558
    */
N
Niels 已提交
1559
    template<typename CompatibleNumberFloatType, typename = typename std::enable_if<
N
Niels 已提交
1560
                 std::is_constructible<number_float_t, CompatibleNumberFloatType>::value and
N
Niels 已提交
1561
                 std::is_floating_point<CompatibleNumberFloatType>::value>::type>
1562 1563
    basic_json(const CompatibleNumberFloatType val) noexcept
        : basic_json(number_float_t(val))
1564 1565 1566
    {
        assert_invariant();
    }
N
Niels 已提交
1567

N
Niels 已提交
1568 1569 1570 1571 1572 1573 1574 1575 1576 1577
    /*!
    @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 已提交
1578 1579
       object value is created where the first elements of the pairs are
       treated as keys and the second elements are as values.
N
Niels 已提交
1580 1581 1582
    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 已提交
1583
    JSON values. The rationale is as follows:
N
Niels 已提交
1584 1585

    1. The empty initializer list is written as `{}` which is exactly an empty
N
Niels 已提交
1586
       JSON object.
N
Niels 已提交
1587
    2. C++ has now way of describing mapped types other than to list a list of
N
Niels 已提交
1588 1589 1590
       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 已提交
1591
    3. In all other cases, the initializer list could not be interpreted as
N
Niels 已提交
1592
       JSON object type, so interpreting it as JSON array type is safe.
N
Niels 已提交
1593

N
Niels 已提交
1594 1595
    With the rules described above, the following JSON values cannot be
    expressed by an initializer list:
N
Niels 已提交
1596

N
Niels 已提交
1597 1598 1599 1600 1601
    - 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 已提交
1602 1603 1604 1605 1606

    @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 已提交
1607
    @param[in] init  initializer list with JSON values
N
Niels 已提交
1608

N
Niels 已提交
1609 1610 1611
    @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 已提交
1612 1613
    used by the functions @ref array(std::initializer_list<basic_json>) and
    @ref object(std::initializer_list<basic_json>).
N
Niels 已提交
1614

N
Niels 已提交
1615 1616
    @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 已提交
1617 1618 1619
    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 已提交
1620 1621
    @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 已提交
1622 1623
    whose first element is a string; example: `"cannot create object from
    initializer list"`
N
Niels 已提交
1624 1625 1626 1627

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

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

N
Niels 已提交
1630
    @sa @ref array(std::initializer_list<basic_json>) -- create a JSON array
1631
    value from an initializer list
N
Niels 已提交
1632
    @sa @ref object(std::initializer_list<basic_json>) -- create a JSON object
1633 1634
    value from an initializer list

N
Niels 已提交
1635
    @since version 1.0.0
N
Niels 已提交
1636
    */
N
Niels 已提交
1637 1638
    basic_json(std::initializer_list<basic_json> init,
               bool type_deduction = true,
N
Niels 已提交
1639
               value_t manual_type = value_t::array)
N
Niels 已提交
1640
    {
N
Niels 已提交
1641 1642
        // check if each element is an array with two elements whose first
        // element is a string
N
Niels 已提交
1643 1644
        bool is_an_object = std::all_of(init.begin(), init.end(),
                                        [](const basic_json & element)
N
Niels 已提交
1645
        {
N
Niels 已提交
1646 1647
            return element.is_array() and element.size() == 2 and element[0].is_string();
        });
N
Niels 已提交
1648 1649 1650 1651 1652 1653 1654

        // 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)
            {
1655
                is_an_object = false;
N
Niels 已提交
1656 1657 1658
            }

            // if object is wanted but impossible, throw an exception
1659
            if (manual_type == value_t::object and not is_an_object)
N
Niels 已提交
1660
            {
N
Niels 已提交
1661
                throw std::domain_error("cannot create object from initializer list");
N
Niels 已提交
1662 1663 1664
            }
        }

1665
        if (is_an_object)
N
Niels 已提交
1666 1667 1668
        {
            // the initializer list is a list of pairs -> create object
            m_type = value_t::object;
N
Niels 已提交
1669
            m_value = value_t::object;
N
Niels 已提交
1670

N
Niels 已提交
1671
            std::for_each(init.begin(), init.end(), [this](const basic_json & element)
N
Niels 已提交
1672
            {
N
Niels 已提交
1673
                m_value.object->emplace(*(element[0].m_value.string), element[1]);
N
Niels 已提交
1674
            });
N
Niels 已提交
1675 1676 1677 1678 1679
        }
        else
        {
            // the initializer list describes an array -> create array
            m_type = value_t::array;
N
Niels 已提交
1680
            m_value.array = create<array_t>(init);
N
Niels 已提交
1681
        }
1682 1683

        assert_invariant();
N
Niels 已提交
1684 1685
    }

N
Niels 已提交
1686 1687 1688 1689 1690 1691 1692
    /*!
    @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 已提交
1693 1694
    @note This function is only needed to express two edge cases that cannot
    be realized with the initializer list constructor (@ref
N
Niels 已提交
1695 1696
    basic_json(std::initializer_list<basic_json>, bool, value_t)). These cases
    are:
N
Niels 已提交
1697
    1. creating an array whose elements are all pairs whose first element is a
N
Niels 已提交
1698
    string -- in this case, the initializer list constructor would create an
N
Niels 已提交
1699
    object, taking the first elements as keys
N
Niels 已提交
1700
    2. creating an empty array -- passing the empty initializer list to the
N
Niels 已提交
1701 1702
    initializer list constructor yields an empty object

N
Niels 已提交
1703
    @param[in] init  initializer list with JSON values to create an array from
N
Niels 已提交
1704 1705 1706 1707 1708 1709
    (optional)

    @return JSON array value

    @complexity Linear in the size of @a init.

N
Niels 已提交
1710
    @liveexample{The following code shows an example for the `array`
N
Niels 已提交
1711 1712
    function.,array}

1713 1714 1715 1716 1717
    @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 已提交
1718
    @since version 1.0.0
N
Niels 已提交
1719
    */
N
Niels 已提交
1720 1721
    static basic_json array(std::initializer_list<basic_json> init =
                                std::initializer_list<basic_json>())
N
Niels 已提交
1722
    {
N
Niels 已提交
1723
        return basic_json(init, false, value_t::array);
N
Niels 已提交
1724 1725
    }

N
Niels 已提交
1726 1727 1728 1729
    /*!
    @brief explicitly create an object from an initializer list

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

    @note This function is only added for symmetry reasons. In contrast to the
1734 1735 1736
    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 已提交
1737 1738
    constructor @ref basic_json(std::initializer_list<basic_json>, bool,
    value_t).
N
Niels 已提交
1739

N
Niels 已提交
1740
    @param[in] init  initializer list to create an object from (optional)
N
Niels 已提交
1741 1742 1743 1744

    @return JSON object value

    @throw std::domain_error if @a init is not a pair whose first elements are
1745 1746
    strings; thrown by
    @ref basic_json(std::initializer_list<basic_json>, bool, value_t)
N
Niels 已提交
1747 1748 1749

    @complexity Linear in the size of @a init.

N
Niels 已提交
1750
    @liveexample{The following code shows an example for the `object`
N
Niels 已提交
1751 1752
    function.,object}

1753 1754 1755 1756 1757
    @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 已提交
1758
    @since version 1.0.0
N
Niels 已提交
1759
    */
N
Niels 已提交
1760 1761
    static basic_json object(std::initializer_list<basic_json> init =
                                 std::initializer_list<basic_json>())
N
Niels 已提交
1762
    {
N
Niels 已提交
1763
        return basic_json(init, false, value_t::object);
N
Niels 已提交
1764 1765
    }

N
Niels 已提交
1766 1767 1768
    /*!
    @brief construct an array with count copies of given value

N
Niels 已提交
1769 1770
    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,
1771
    `std::distance(begin(),end()) == cnt` holds.
N
Niels 已提交
1772

1773 1774
    @param[in] cnt  the number of JSON copies of @a val to create
    @param[in] val  the JSON value to copy
N
Niels 已提交
1775

1776
    @complexity Linear in @a cnt.
N
Niels 已提交
1777 1778 1779 1780

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

N
Niels 已提交
1782
    @since version 1.0.0
N
Niels 已提交
1783
    */
1784
    basic_json(size_type cnt, const basic_json& val)
N
Niels 已提交
1785 1786
        : m_type(value_t::array)
    {
1787
        m_value.array = create<array_t>(cnt, val);
1788
        assert_invariant();
N
Niels 已提交
1789
    }
N
Niels 已提交
1790

N
Niels 已提交
1791 1792 1793 1794 1795
    /*!
    @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 已提交
1796
    - In case of primitive types (number, boolean, or string), @a first must
N
Niels 已提交
1797 1798
      be `begin()` and @a last must be `end()`. In this case, the value is
      copied. Otherwise, std::out_of_range is thrown.
N
Niels 已提交
1799 1800
    - In case of structured types (array, object), the constructor behaves as
      similar versions for `std::vector`.
N
Niels 已提交
1801
    - In case of a null type, std::domain_error is thrown.
N
Niels 已提交
1802 1803 1804 1805 1806 1807 1808

    @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 已提交
1809 1810
    @pre Iterators @a first and @a last must be initialized. **This
         precondition is enforced with an assertion.**
N
Niels 已提交
1811

N
Niels 已提交
1812
    @throw std::domain_error if iterators are not compatible; that is, do not
N
Niels 已提交
1813
    belong to the same JSON value; example: `"iterators are not compatible"`
N
Niels 已提交
1814
    @throw std::out_of_range if iterators are for a primitive type (number,
N
Niels 已提交
1815 1816
    boolean, or string) where an out of range error can be detected easily;
    example: `"iterators out of range"`
N
Niels 已提交
1817
    @throw std::bad_alloc if allocation for object, array, or string fails
N
Niels 已提交
1818 1819
    @throw std::domain_error if called with a null value; example: `"cannot
    use construct with iterators from null"`
N
Niels 已提交
1820 1821 1822 1823 1824

    @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}
1825

N
Niels 已提交
1826
    @since version 1.0.0
N
Niels 已提交
1827
    */
N
Niels 已提交
1828 1829 1830
    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 已提交
1831
    basic_json(InputIT first, InputIT last)
N
Niels 已提交
1832
    {
N
Niels 已提交
1833 1834 1835
        assert(first.m_object != nullptr);
        assert(last.m_object != nullptr);

N
Niels 已提交
1836
        // make sure iterator fits the current value
N
Niels 已提交
1837
        if (first.m_object != last.m_object)
N
Niels 已提交
1838
        {
N
Niels 已提交
1839
            throw std::domain_error("iterators are not compatible");
N
Niels 已提交
1840 1841
        }

N
Niels 已提交
1842 1843 1844
        // copy type from first iterator
        m_type = first.m_object->m_type;

N
Niels 已提交
1845
        // check if iterator range is complete for primitive values
N
Niels 已提交
1846 1847 1848
        switch (m_type)
        {
            case value_t::boolean:
1849 1850
            case value_t::number_float:
            case value_t::number_integer:
1851
            case value_t::number_unsigned:
N
Niels 已提交
1852 1853
            case value_t::string:
            {
1854
                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
N
Niels 已提交
1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873
                {
                    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 已提交
1874

1875 1876 1877 1878 1879
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = first.m_object->m_value.number_unsigned;
                break;
            }
N
Niels 已提交
1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894

            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 已提交
1895
                m_value = *first.m_object->m_value.string;
N
Niels 已提交
1896 1897 1898 1899 1900
                break;
            }

            case value_t::object:
            {
N
Cleanup  
Niels 已提交
1901
                m_value.object = create<object_t>(first.m_it.object_iterator, last.m_it.object_iterator);
N
Niels 已提交
1902 1903 1904 1905 1906
                break;
            }

            case value_t::array:
            {
N
Cleanup  
Niels 已提交
1907
                m_value.array = create<array_t>(first.m_it.array_iterator, last.m_it.array_iterator);
N
Niels 已提交
1908 1909 1910 1911 1912
                break;
            }

            default:
            {
N
Niels 已提交
1913
                throw std::domain_error("cannot use construct with iterators from " + first.m_object->type_name());
N
Niels 已提交
1914 1915
            }
        }
1916 1917

        assert_invariant();
N
Niels 已提交
1918 1919
    }

N
Niels 已提交
1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933
    /*!
    @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 已提交
1934 1935 1936 1937 1938 1939 1940
    @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 已提交
1941 1942 1943 1944
    @liveexample{The example below demonstrates constructing a JSON value from
    a `std::stringstream` with and without callback
    function.,basic_json__istream}

N
Niels 已提交
1945 1946
    @since version 2.0.0, deprecated in version 2.0.3, to be removed in
           version 3.0.0
N
Niels 已提交
1947
    */
N
Niels 已提交
1948
    JSON_DEPRECATED
N
Niels 已提交
1949
    explicit basic_json(std::istream& i, const parser_callback_t cb = nullptr)
N
Niels 已提交
1950 1951
    {
        *this = parser(i, cb).parse();
1952
        assert_invariant();
N
Niels 已提交
1953 1954
    }

N
Niels 已提交
1955 1956 1957 1958
    ///////////////////////////////////////
    // other constructors and destructor //
    ///////////////////////////////////////

N
Niels 已提交
1959 1960
    /*!
    @brief copy constructor
N
Niels 已提交
1961

N
Niels 已提交
1962 1963
    Creates a copy of a given JSON value.

N
Niels 已提交
1964
    @param[in] other  the JSON value to copy
N
Niels 已提交
1965 1966 1967

    @complexity Linear in the size of @a other.

N
Niels 已提交
1968 1969 1970
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
1971 1972 1973
    - The complexity is linear.
    - As postcondition, it holds: `other == basic_json(other)`.

N
Niels 已提交
1974
    @throw std::bad_alloc if allocation for object, array, or string fails.
N
Niels 已提交
1975 1976

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

N
Niels 已提交
1979
    @since version 1.0.0
N
Niels 已提交
1980
    */
N
Niels 已提交
1981
    basic_json(const basic_json& other)
N
Niels 已提交
1982 1983
        : m_type(other.m_type)
    {
1984 1985 1986
        // check of passed value is valid
        other.assert_invariant();

N
Niels 已提交
1987 1988
        switch (m_type)
        {
1989
            case value_t::object:
N
Niels 已提交
1990
            {
N
Niels 已提交
1991
                m_value = *other.m_value.object;
N
Niels 已提交
1992 1993
                break;
            }
N
Niels 已提交
1994

1995
            case value_t::array:
N
Niels 已提交
1996
            {
N
Niels 已提交
1997
                m_value = *other.m_value.array;
N
Niels 已提交
1998 1999
                break;
            }
N
Niels 已提交
2000

2001
            case value_t::string:
N
Niels 已提交
2002
            {
N
Niels 已提交
2003
                m_value = *other.m_value.string;
N
Niels 已提交
2004 2005
                break;
            }
N
Niels 已提交
2006

2007
            case value_t::boolean:
N
Niels 已提交
2008
            {
N
Niels 已提交
2009
                m_value = other.m_value.boolean;
N
Niels 已提交
2010 2011
                break;
            }
N
Niels 已提交
2012

2013
            case value_t::number_integer:
N
Niels 已提交
2014
            {
N
Niels 已提交
2015
                m_value = other.m_value.number_integer;
N
Niels 已提交
2016 2017
                break;
            }
N
Niels 已提交
2018

2019 2020 2021 2022 2023
            case value_t::number_unsigned:
            {
                m_value = other.m_value.number_unsigned;
                break;
            }
N
Niels 已提交
2024

2025
            case value_t::number_float:
N
Niels 已提交
2026
            {
N
Niels 已提交
2027
                m_value = other.m_value.number_float;
N
Niels 已提交
2028 2029
                break;
            }
2030 2031 2032 2033 2034

            default:
            {
                break;
            }
N
Niels 已提交
2035
        }
2036 2037

        assert_invariant();
N
Niels 已提交
2038 2039
    }

N
Niels 已提交
2040 2041 2042 2043 2044 2045 2046
    /*!
    @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 已提交
2047
    @param[in,out] other  value to move to this object
N
Niels 已提交
2048 2049 2050 2051 2052 2053 2054

    @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}
2055

N
Niels 已提交
2056
    @since version 1.0.0
N
Niels 已提交
2057
    */
N
Niels 已提交
2058
    basic_json(basic_json&& other) noexcept
N
Niels 已提交
2059 2060
        : m_type(std::move(other.m_type)),
          m_value(std::move(other.m_value))
N
Niels 已提交
2061
    {
2062 2063 2064
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2065
        // invalidate payload
N
Niels 已提交
2066 2067
        other.m_type = value_t::null;
        other.m_value = {};
2068 2069

        assert_invariant();
N
Niels 已提交
2070 2071
    }

N
Niels 已提交
2072 2073
    /*!
    @brief copy assignment
N
Niels 已提交
2074

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

N
Niels 已提交
2079
    @param[in] other  value to copy from
N
Niels 已提交
2080 2081 2082

    @complexity Linear.

N
Niels 已提交
2083 2084 2085
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2086 2087
    - The complexity is linear.

N
Niels 已提交
2088 2089 2090 2091
    @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 已提交
2092

N
Niels 已提交
2093
    @since version 1.0.0
N
Niels 已提交
2094
    */
N
Niels 已提交
2095
    reference& operator=(basic_json other) noexcept (
N
Niels 已提交
2096 2097 2098 2099 2100
        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
Niels 已提交
2101
    {
2102 2103 2104
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2105
        using std::swap;
N
Cleanup  
Niels 已提交
2106 2107
        swap(m_type, other.m_type);
        swap(m_value, other.m_value);
2108 2109

        assert_invariant();
N
Niels 已提交
2110 2111 2112
        return *this;
    }

N
Niels 已提交
2113 2114
    /*!
    @brief destructor
N
Niels 已提交
2115

N
Niels 已提交
2116
    Destroys the JSON value and frees all allocated memory.
N
Niels 已提交
2117 2118 2119

    @complexity Linear.

N
Niels 已提交
2120 2121 2122
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2123 2124
    - The complexity is linear.
    - All stored elements are destroyed and all memory is freed.
2125

N
Niels 已提交
2126
    @since version 1.0.0
N
Niels 已提交
2127
    */
N
Niels 已提交
2128
    ~basic_json()
N
Niels 已提交
2129
    {
2130 2131
        assert_invariant();

N
Niels 已提交
2132 2133
        switch (m_type)
        {
2134
            case value_t::object:
N
Niels 已提交
2135
            {
N
Niels 已提交
2136
                AllocatorType<object_t> alloc;
N
Niels 已提交
2137 2138
                alloc.destroy(m_value.object);
                alloc.deallocate(m_value.object, 1);
N
Niels 已提交
2139 2140
                break;
            }
N
Niels 已提交
2141

2142
            case value_t::array:
N
Niels 已提交
2143
            {
N
Niels 已提交
2144
                AllocatorType<array_t> alloc;
N
Niels 已提交
2145 2146
                alloc.destroy(m_value.array);
                alloc.deallocate(m_value.array, 1);
N
Niels 已提交
2147 2148
                break;
            }
N
Niels 已提交
2149

2150
            case value_t::string:
N
Niels 已提交
2151
            {
N
Niels 已提交
2152
                AllocatorType<string_t> alloc;
N
Niels 已提交
2153
                alloc.destroy(m_value.string);
N
Niels 已提交
2154
                alloc.deallocate(m_value.string, 1);
N
Niels 已提交
2155 2156
                break;
            }
N
Niels 已提交
2157 2158

            default:
N
Niels 已提交
2159
            {
N
Niels 已提交
2160
                // all other types need no specific destructor
N
Niels 已提交
2161 2162 2163 2164 2165
                break;
            }
        }
    }

N
Niels 已提交
2166
    /// @}
N
Niels 已提交
2167 2168 2169 2170 2171 2172

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

N
Niels 已提交
2173
    /// @name object inspection
N
Niels 已提交
2174
    /// Functions to inspect the type of a JSON value.
N
Niels 已提交
2175 2176
    /// @{

N
Niels 已提交
2177
    /*!
N
Niels 已提交
2178 2179
    @brief serialization

N
Niels 已提交
2180
    Serialization function for JSON values. The function tries to mimic
N
Niels 已提交
2181
    Python's `json.dumps()` function, and currently supports its @a indent
N
Niels 已提交
2182
    parameter.
N
Niels 已提交
2183

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

N
Niels 已提交
2189 2190 2191 2192 2193
    @return string containing the serialization of the JSON value

    @complexity Linear.

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

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

N
Niels 已提交
2198
    @since version 1.0.0
N
Niels 已提交
2199
    */
N
Niels 已提交
2200
    string_t dump(const int indent = -1) const
N
Niels 已提交
2201
    {
N
Niels 已提交
2202
        std::stringstream ss;
N
Niels 已提交
2203
        // fix locale problems
N
Niels 已提交
2204 2205
        const static std::locale loc(std::locale(), new DecimalSeparator);
        ss.imbue(loc);
N
Niels 已提交
2206

2207 2208 2209 2210 2211 2212
        // 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
Niels 已提交
2213 2214
        if (indent >= 0)
        {
N
Niels 已提交
2215
            dump(ss, true, static_cast<unsigned int>(indent));
N
Niels 已提交
2216 2217 2218
        }
        else
        {
N
Niels 已提交
2219
            dump(ss, false, 0);
N
Niels 已提交
2220
        }
N
Niels 已提交
2221 2222

        return ss.str();
N
Niels 已提交
2223 2224
    }

N
Niels 已提交
2225 2226 2227 2228 2229 2230 2231
    /*!
    @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 已提交
2232 2233 2234

    @complexity Constant.

N
Niels 已提交
2235 2236 2237
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2238
    @liveexample{The following code exemplifies `type()` for all JSON
N
Niels 已提交
2239
    types.,type}
N
Niels 已提交
2240

N
Niels 已提交
2241
    @since version 1.0.0
N
Niels 已提交
2242
    */
N
Niels 已提交
2243
    constexpr value_t type() const noexcept
N
Niels 已提交
2244 2245 2246 2247
    {
        return m_type;
    }

N
Niels 已提交
2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258
    /*!
    @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 已提交
2259 2260 2261
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2262
    @liveexample{The following code exemplifies `is_primitive()` for all JSON
N
Niels 已提交
2263
    types.,is_primitive}
N
Niels 已提交
2264

N
Niels 已提交
2265 2266 2267 2268 2269 2270
    @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 已提交
2271
    @since version 1.0.0
N
Niels 已提交
2272
    */
N
Niels 已提交
2273
    constexpr bool is_primitive() const noexcept
N
Niels 已提交
2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287
    {
        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 已提交
2288 2289 2290
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2291
    @liveexample{The following code exemplifies `is_structured()` for all JSON
N
Niels 已提交
2292
    types.,is_structured}
N
Niels 已提交
2293

N
Niels 已提交
2294 2295 2296 2297
    @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 已提交
2298
    @since version 1.0.0
N
Niels 已提交
2299
    */
N
Niels 已提交
2300
    constexpr bool is_structured() const noexcept
N
Niels 已提交
2301 2302 2303 2304
    {
        return is_array() or is_object();
    }

N
Niels 已提交
2305 2306 2307 2308 2309
    /*!
    @brief return whether value is null

    This function returns true iff the JSON value is null.

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

    @complexity Constant.

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

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

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

N
Niels 已提交
2327 2328 2329 2330 2331
    /*!
    @brief return whether value is a boolean

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

N
Niels 已提交
2332
    @return `true` if type is boolean, `false` otherwise.
N
Niels 已提交
2333 2334 2335

    @complexity Constant.

N
Niels 已提交
2336 2337 2338
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2339
    @liveexample{The following code exemplifies `is_boolean()` for all JSON
N
Niels 已提交
2340
    types.,is_boolean}
N
Niels 已提交
2341

N
Niels 已提交
2342
    @since version 1.0.0
N
Niels 已提交
2343
    */
N
Niels 已提交
2344
    constexpr bool is_boolean() const noexcept
N
Niels 已提交
2345 2346 2347 2348
    {
        return m_type == value_t::boolean;
    }

N
Niels 已提交
2349 2350 2351 2352 2353 2354
    /*!
    @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.

2355 2356
    @return `true` if type is number (regardless whether integer, unsigned
    integer or floating-type), `false` otherwise.
N
Niels 已提交
2357 2358 2359

    @complexity Constant.

N
Niels 已提交
2360 2361 2362
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2363
    @liveexample{The following code exemplifies `is_number()` for all JSON
N
Niels 已提交
2364
    types.,is_number}
N
Niels 已提交
2365

N
Niels 已提交
2366
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
2367
    integer number
N
Niels 已提交
2368 2369
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2370 2371
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
2372
    @since version 1.0.0
N
Niels 已提交
2373
    */
N
Niels 已提交
2374
    constexpr bool is_number() const noexcept
N
Niels 已提交
2375
    {
N
Niels 已提交
2376
        return is_number_integer() or is_number_float();
N
Niels 已提交
2377 2378
    }

N
Niels 已提交
2379 2380 2381
    /*!
    @brief return whether value is an integer number

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

N
Niels 已提交
2385
    @return `true` if type is an integer or unsigned integer number, `false`
2386
    otherwise.
N
Niels 已提交
2387 2388 2389

    @complexity Constant.

N
Niels 已提交
2390 2391 2392
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2393
    @liveexample{The following code exemplifies `is_number_integer()` for all
N
Niels 已提交
2394
    JSON types.,is_number_integer}
N
Niels 已提交
2395 2396

    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
2397 2398
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2399 2400
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
2401
    @since version 1.0.0
N
Niels 已提交
2402
    */
N
Niels 已提交
2403
    constexpr bool is_number_integer() const noexcept
N
Niels 已提交
2404
    {
2405 2406
        return m_type == value_t::number_integer or m_type == value_t::number_unsigned;
    }
N
Niels 已提交
2407

2408 2409 2410
    /*!
    @brief return whether value is an unsigned integer number

N
Niels 已提交
2411 2412
    This function returns true iff the JSON value is an unsigned integer
    number. This excludes floating-point and (signed) integer values.
2413 2414 2415 2416 2417

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

    @complexity Constant.

N
Niels 已提交
2418 2419 2420
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2421
    @liveexample{The following code exemplifies `is_number_unsigned()` for all
N
Niels 已提交
2422 2423
    JSON types.,is_number_unsigned}

2424
    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
2425
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
2426 2427 2428 2429 2430
    integer number
    @sa @ref is_number_float() -- check if value is a floating-point number

    @since version 2.0.0
    */
N
Niels 已提交
2431
    constexpr bool is_number_unsigned() const noexcept
2432 2433
    {
        return m_type == value_t::number_unsigned;
N
Niels 已提交
2434 2435
    }

N
Niels 已提交
2436 2437 2438 2439
    /*!
    @brief return whether value is a floating-point number

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

N
Niels 已提交
2442
    @return `true` if type is a floating-point number, `false` otherwise.
N
Niels 已提交
2443 2444 2445

    @complexity Constant.

N
Niels 已提交
2446 2447 2448
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2449
    @liveexample{The following code exemplifies `is_number_float()` for all
N
Niels 已提交
2450
    JSON types.,is_number_float}
N
Niels 已提交
2451 2452 2453

    @sa @ref is_number() -- check if value is number
    @sa @ref is_number_integer() -- check if value is an integer number
N
Niels 已提交
2454 2455
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2456

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

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

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

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

    @complexity Constant.

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

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

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

N
Niels 已提交
2486 2487 2488 2489 2490
    /*!
    @brief return whether value is an array

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

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

    @complexity Constant.

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

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

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

N
Niels 已提交
2508 2509 2510 2511 2512
    /*!
    @brief return whether value is a string

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

N
Niels 已提交
2513
    @return `true` if type is string, `false` otherwise.
N
Niels 已提交
2514 2515 2516

    @complexity Constant.

N
Niels 已提交
2517 2518 2519
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2520
    @liveexample{The following code exemplifies `is_string()` for all JSON
N
Niels 已提交
2521
    types.,is_string}
N
Niels 已提交
2522

N
Niels 已提交
2523
    @since version 1.0.0
N
Niels 已提交
2524
    */
N
Niels 已提交
2525
    constexpr bool is_string() const noexcept
N
Niels 已提交
2526 2527 2528 2529
    {
        return m_type == value_t::string;
    }

N
Niels 已提交
2530 2531 2532 2533 2534 2535
    /*!
    @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 已提交
2536 2537 2538 2539
    @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 已提交
2540 2541 2542 2543
    @return `true` if type is discarded, `false` otherwise.

    @complexity Constant.

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

N
Niels 已提交
2547
    @liveexample{The following code exemplifies `is_discarded()` for all JSON
N
Niels 已提交
2548
    types.,is_discarded}
N
Niels 已提交
2549

N
Niels 已提交
2550
    @since version 1.0.0
N
Niels 已提交
2551
    */
N
Niels 已提交
2552
    constexpr bool is_discarded() const noexcept
N
Niels 已提交
2553 2554 2555 2556
    {
        return m_type == value_t::discarded;
    }

N
Niels 已提交
2557 2558 2559 2560 2561 2562 2563 2564 2565 2566
    /*!
    @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 已提交
2567 2568 2569
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

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

N
Niels 已提交
2573
    @since version 1.0.0
N
Niels 已提交
2574
    */
N
Niels 已提交
2575
    constexpr operator value_t() const noexcept
N
Niels 已提交
2576 2577 2578 2579
    {
        return m_type;
    }

N
Niels 已提交
2580 2581
    /// @}

N
Niels 已提交
2582
  private:
N
Niels 已提交
2583 2584 2585
    //////////////////
    // value access //
    //////////////////
N
Niels 已提交
2586

N
Niels 已提交
2587
    /// get an object (explicit)
N
Niels 已提交
2588 2589 2590
    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>
N
Niels 已提交
2591
    T get_impl(T*) const
N
Niels 已提交
2592
    {
N
Niels 已提交
2593 2594 2595 2596 2597 2598 2599 2600
        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 已提交
2601 2602 2603
    }

    /// get an object (explicit)
N
Niels 已提交
2604
    object_t get_impl(object_t*) const
N
Niels 已提交
2605
    {
N
Niels 已提交
2606 2607 2608 2609 2610 2611 2612 2613
        if (is_object())
        {
            return *(m_value.object);
        }
        else
        {
            throw std::domain_error("type must be object, but is " + type_name());
        }
N
Niels 已提交
2614 2615
    }

N
Niels 已提交
2616
    /// get an array (explicit)
N
Niels 已提交
2617 2618 2619 2620 2621 2622
    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>
N
Niels 已提交
2623
    T get_impl(T*) const
N
Niels 已提交
2624
    {
N
cleanup  
Niels 已提交
2625
        if (is_array())
N
Niels 已提交
2626
        {
2627 2628 2629
            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 已提交
2630
            {
2631 2632 2633 2634 2635 2636 2637
                return i.get<typename T::value_type>();
            });
            return to_vector;
        }
        else
        {
            throw std::domain_error("type must be array, but is " + type_name());
N
Niels 已提交
2638 2639 2640
        }
    }

N
Niels 已提交
2641
    /// get an array (explicit)
N
Niels 已提交
2642 2643 2644
    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>
N
Niels 已提交
2645
    std::vector<T> get_impl(std::vector<T>*) const
N
Niels 已提交
2646
    {
N
cleanup  
Niels 已提交
2647
        if (is_array())
N
Niels 已提交
2648
        {
2649 2650 2651 2652
            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 已提交
2653
            {
2654 2655 2656 2657 2658 2659 2660
                return i.get<T>();
            });
            return to_vector;
        }
        else
        {
            throw std::domain_error("type must be array, but is " + type_name());
N
Niels 已提交
2661 2662 2663
        }
    }

N
Niels 已提交
2664
    /// get an array (explicit)
N
Niels 已提交
2665 2666 2667
    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>
N
Niels 已提交
2668
    T get_impl(T*) const
N
Niels 已提交
2669
    {
N
Niels 已提交
2670 2671 2672 2673 2674 2675 2676 2677
        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 已提交
2678 2679
    }

N
Niels 已提交
2680
    /// get an array (explicit)
N
Niels 已提交
2681
    array_t get_impl(array_t*) const
N
Niels 已提交
2682
    {
N
Niels 已提交
2683 2684 2685 2686 2687 2688 2689 2690
        if (is_array())
        {
            return *(m_value.array);
        }
        else
        {
            throw std::domain_error("type must be array, but is " + type_name());
        }
N
Niels 已提交
2691 2692 2693
    }

    /// get a string (explicit)
N
Niels 已提交
2694 2695
    template<typename T, typename std::enable_if<
                 std::is_convertible<string_t, T>::value, int>::type = 0>
N
Niels 已提交
2696
    T get_impl(T*) const
N
Niels 已提交
2697
    {
N
Niels 已提交
2698 2699 2700 2701 2702 2703 2704 2705
        if (is_string())
        {
            return *m_value.string;
        }
        else
        {
            throw std::domain_error("type must be string, but is " + type_name());
        }
N
Niels 已提交
2706 2707
    }

N
Niels 已提交
2708
    /// get a number (explicit)
N
Niels 已提交
2709 2710
    template<typename T, typename std::enable_if<
                 std::is_arithmetic<T>::value, int>::type = 0>
N
Niels 已提交
2711
    T get_impl(T*) const
N
Niels 已提交
2712 2713 2714
    {
        switch (m_type)
        {
2715
            case value_t::number_integer:
N
Niels 已提交
2716
            {
N
Niels 已提交
2717
                return static_cast<T>(m_value.number_integer);
N
Niels 已提交
2718
            }
N
Niels 已提交
2719

2720 2721 2722 2723
            case value_t::number_unsigned:
            {
                return static_cast<T>(m_value.number_unsigned);
            }
2724 2725

            case value_t::number_float:
N
Niels 已提交
2726
            {
N
Niels 已提交
2727
                return static_cast<T>(m_value.number_float);
N
Niels 已提交
2728
            }
2729

N
Niels 已提交
2730
            default:
N
Niels 已提交
2731
            {
N
Niels 已提交
2732
                throw std::domain_error("type must be number, but is " + type_name());
N
Niels 已提交
2733 2734 2735 2736 2737
            }
        }
    }

    /// get a boolean (explicit)
N
Niels 已提交
2738
    constexpr boolean_t get_impl(boolean_t*) const
N
Niels 已提交
2739
    {
N
Niels 已提交
2740 2741 2742
        return is_boolean()
               ? m_value.boolean
               : throw std::domain_error("type must be boolean, but is " + type_name());
N
Niels 已提交
2743 2744
    }

N
Niels 已提交
2745
    /// get a pointer to the value (object)
N
Niels 已提交
2746
    object_t* get_impl_ptr(object_t*) noexcept
N
Niels 已提交
2747 2748 2749 2750
    {
        return is_object() ? m_value.object : nullptr;
    }

N
Niels 已提交
2751
    /// get a pointer to the value (object)
N
Niels 已提交
2752
    constexpr const object_t* get_impl_ptr(const object_t*) const noexcept
N
Niels 已提交
2753 2754 2755 2756 2757 2758 2759 2760 2761 2762
    {
        return is_object() ? m_value.object : nullptr;
    }

    /// get a pointer to the value (array)
    array_t* get_impl_ptr(array_t*) noexcept
    {
        return is_array() ? m_value.array : nullptr;
    }

N
Niels 已提交
2763
    /// get a pointer to the value (array)
N
Niels 已提交
2764
    constexpr const array_t* get_impl_ptr(const array_t*) const noexcept
N
Niels 已提交
2765 2766 2767 2768 2769
    {
        return is_array() ? m_value.array : nullptr;
    }

    /// get a pointer to the value (string)
N
Niels 已提交
2770 2771 2772 2773 2774 2775
    string_t* get_impl_ptr(string_t*) noexcept
    {
        return is_string() ? m_value.string : nullptr;
    }

    /// get a pointer to the value (string)
N
Niels 已提交
2776
    constexpr const string_t* get_impl_ptr(const string_t*) const noexcept
N
Niels 已提交
2777 2778 2779 2780 2781
    {
        return is_string() ? m_value.string : nullptr;
    }

    /// get a pointer to the value (boolean)
N
Niels 已提交
2782 2783 2784 2785 2786 2787
    boolean_t* get_impl_ptr(boolean_t*) noexcept
    {
        return is_boolean() ? &m_value.boolean : nullptr;
    }

    /// get a pointer to the value (boolean)
N
Niels 已提交
2788
    constexpr const boolean_t* get_impl_ptr(const boolean_t*) const noexcept
N
Niels 已提交
2789 2790 2791 2792 2793
    {
        return is_boolean() ? &m_value.boolean : nullptr;
    }

    /// get a pointer to the value (integer number)
N
Niels 已提交
2794 2795 2796 2797 2798 2799
    number_integer_t* get_impl_ptr(number_integer_t*) noexcept
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }

    /// get a pointer to the value (integer number)
N
Niels 已提交
2800
    constexpr const number_integer_t* get_impl_ptr(const number_integer_t*) const noexcept
N
Niels 已提交
2801 2802 2803
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }
N
Niels 已提交
2804

2805 2806 2807 2808 2809
    /// 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 已提交
2810

2811
    /// get a pointer to the value (unsigned number)
N
Niels 已提交
2812
    constexpr const number_unsigned_t* get_impl_ptr(const number_unsigned_t*) const noexcept
2813 2814 2815
    {
        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
    }
N
Niels 已提交
2816

N
Niels 已提交
2817
    /// get a pointer to the value (floating-point number)
N
Niels 已提交
2818 2819 2820 2821 2822 2823
    number_float_t* get_impl_ptr(number_float_t*) noexcept
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

    /// get a pointer to the value (floating-point number)
N
Niels 已提交
2824
    constexpr const number_float_t* get_impl_ptr(const number_float_t*) const noexcept
N
Niels 已提交
2825 2826 2827 2828
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

N
Niels 已提交
2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840
    /*!
    @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>
2841
    static ReferenceType get_ref_impl(ThisType& obj)
D
dariomt 已提交
2842
    {
N
Niels 已提交
2843
        // helper type
N
Niels 已提交
2844 2845
        using PointerType = typename std::add_pointer<ReferenceType>::type;

N
Niels 已提交
2846
        // delegate the call to get_ptr<>()
2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857
        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 已提交
2858 2859
    }

N
Niels 已提交
2860
  public:
N
Niels 已提交
2861 2862

    /// @name value access
N
Niels 已提交
2863
    /// Direct access to the stored value of a JSON value.
N
Niels 已提交
2864 2865
    /// @{

N
Niels 已提交
2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877
    /*!
    @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 已提交
2878
    to JSON; example: `"type must be object, but is null"`
N
Niels 已提交
2879 2880 2881

    @complexity Linear in the size of the JSON value.

N
Niels 已提交
2882
    @liveexample{The example below shows several conversions from JSON values
N
Niels 已提交
2883 2884 2885
    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 已提交
2886
    associative containers such as `std::unordered_map<std::string\,
N
Niels 已提交
2887 2888 2889 2890 2891 2892 2893 2894 2895
    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 已提交
2896

N
Niels 已提交
2897
    @since version 1.0.0
N
Niels 已提交
2898
    */
N
Niels 已提交
2899 2900
    template<typename ValueType, typename std::enable_if<
                 not std::is_pointer<ValueType>::value, int>::type = 0>
N
Niels 已提交
2901
    ValueType get() const
N
Niels 已提交
2902
    {
N
Niels 已提交
2903
        return get_impl(static_cast<ValueType*>(nullptr));
N
Niels 已提交
2904 2905
    }

N
Niels 已提交
2906 2907 2908 2909 2910 2911
    /*!
    @brief get a pointer value (explicit)

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

N
Niels 已提交
2912 2913
    @warning The pointer becomes invalid if the underlying JSON object
    changes.
N
Niels 已提交
2914 2915

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

N
Niels 已提交
2919 2920
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
2921 2922 2923 2924 2925 2926 2927 2928 2929

    @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 已提交
2930

N
Niels 已提交
2931
    @since version 1.0.0
N
Niels 已提交
2932
    */
N
Niels 已提交
2933 2934
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
2935 2936 2937 2938 2939 2940 2941 2942 2943 2944
    PointerType get() noexcept
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

    /*!
    @brief get a pointer value (explicit)
    @copydoc get()
    */
N
Niels 已提交
2945 2946
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
2947
    constexpr const PointerType get() const noexcept
N
Niels 已提交
2948 2949 2950 2951 2952 2953 2954 2955
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

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

N
Niels 已提交
2956
    Implicit pointer access to the internally stored JSON value. No copies are
N
Niels 已提交
2957 2958 2959 2960 2961 2962
    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 已提交
2963
    object_t, @ref string_t, @ref boolean_t, @ref number_integer_t,
N
Niels 已提交
2964 2965
    @ref number_unsigned_t, or @ref number_float_t. Enforced by a static
    assertion.
N
Niels 已提交
2966

N
Niels 已提交
2967 2968
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
2969 2970 2971 2972 2973 2974 2975

    @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 已提交
2976

N
Niels 已提交
2977
    @since version 1.0.0
N
Niels 已提交
2978
    */
N
Niels 已提交
2979 2980
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
2981 2982
    PointerType get_ptr() noexcept
    {
N
Niels 已提交
2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997
        // 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 已提交
2998 2999 3000 3001 3002 3003 3004 3005
        // 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 已提交
3006 3007 3008
    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 已提交
3009
    constexpr const PointerType get_ptr() const noexcept
N
Niels 已提交
3010
    {
N
Niels 已提交
3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025
        // 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 已提交
3026
        // delegate the call to get_impl_ptr<>() const
D
dariomt 已提交
3027
        return get_impl_ptr(static_cast<const PointerType>(nullptr));
D
dariomt 已提交
3028 3029
    }

N
Niels 已提交
3030
    /*!
D
dariomt 已提交
3031 3032
    @brief get a reference value (implicit)

N
Niels 已提交
3033 3034
    Implict reference access to the internally stored JSON value. No copies
    are made.
D
dariomt 已提交
3035 3036 3037 3038

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

N
Niels 已提交
3039 3040
    @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 已提交
3041
    @ref number_float_t. Enforced by static assertion.
D
dariomt 已提交
3042

N
Niels 已提交
3043 3044 3045
    @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 已提交
3046

N
Niels 已提交
3047 3048
    @throw std::domain_error in case passed type @a ReferenceType is
    incompatible with the stored JSON value
D
dariomt 已提交
3049 3050

    @complexity Constant.
N
Niels 已提交
3051 3052 3053

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

N
Niels 已提交
3054
    @since version 1.1.0
D
dariomt 已提交
3055
    */
N
Niels 已提交
3056 3057
    template<typename ReferenceType, typename std::enable_if<
                 std::is_reference<ReferenceType>::value, int>::type = 0>
D
dariomt 已提交
3058 3059
    ReferenceType get_ref()
    {
N
Niels 已提交
3060 3061
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
D
dariomt 已提交
3062 3063 3064 3065 3066 3067
    }

    /*!
    @brief get a reference value (implicit)
    @copydoc get_ref()
    */
N
Niels 已提交
3068 3069 3070
    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>
3071
    ReferenceType get_ref() const
D
dariomt 已提交
3072
    {
N
Niels 已提交
3073 3074
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
N
Niels 已提交
3075 3076 3077 3078 3079
    }

    /*!
    @brief get a value (implicit)

N
Niels 已提交
3080 3081
    Implicit type conversion between the JSON value and a compatible value.
    The call is realized by calling @ref get() const.
N
Niels 已提交
3082 3083 3084

    @tparam ValueType non-pointer type compatible to the JSON value, for
    instance `int` for JSON integer numbers, `bool` for JSON booleans, or
N
Niels 已提交
3085 3086 3087
    `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 已提交
3088 3089 3090 3091 3092 3093 3094 3095

    @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 已提交
3096
    @liveexample{The example below shows several conversions from JSON values
N
Niels 已提交
3097 3098 3099
    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 已提交
3100
    associative containers such as `std::unordered_map<std::string\,
N
Niels 已提交
3101
    json>`.,operator__ValueType}
N
Niels 已提交
3102

N
Niels 已提交
3103
    @since version 1.0.0
N
Niels 已提交
3104
    */
N
Niels 已提交
3105 3106 3107
    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
3108
#ifndef _MSC_VER  // Fix for issue #167 operator<< abiguity under VS2015
N
Niels 已提交
3109
                   and not std::is_same<ValueType, std::initializer_list<typename string_t::value_type>>::value
3110
#endif
N
Niels 已提交
3111
                   , int >::type = 0 >
N
Niels 已提交
3112
    operator ValueType() const
N
Niels 已提交
3113
    {
N
Niels 已提交
3114 3115
        // delegate the call to get<>() const
        return get<ValueType>();
N
Niels 已提交
3116 3117
    }

N
Niels 已提交
3118 3119
    /// @}

N
Niels 已提交
3120 3121 3122 3123 3124

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

N
Niels 已提交
3125
    /// @name element access
N
Niels 已提交
3126
    /// Access to the JSON value.
N
Niels 已提交
3127 3128
    /// @{

N
Niels 已提交
3129 3130 3131 3132 3133 3134 3135 3136 3137 3138
    /*!
    @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 已提交
3139 3140
    @throw std::domain_error if the JSON value is not an array; example:
    `"cannot use at() with string"`
N
Niels 已提交
3141
    @throw std::out_of_range if the index @a idx is out of range of the array;
N
Niels 已提交
3142
    that is, `idx >= size()`; example: `"array index 7 is out of range"`
N
Niels 已提交
3143 3144 3145 3146

    @complexity Constant.

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

N
Niels 已提交
3149
    @since version 1.0.0
N
Niels 已提交
3150
    */
N
Niels 已提交
3151
    reference at(size_type idx)
N
Niels 已提交
3152 3153
    {
        // at only works for arrays
3154 3155
        if (is_array())
        {
N
Niels 已提交
3156 3157 3158 3159
            try
            {
                return m_value.array->at(idx);
            }
3160
            catch (std::out_of_range&)
N
Niels 已提交
3161 3162 3163 3164
            {
                // create better exception explanation
                throw std::out_of_range("array index " + std::to_string(idx) + " is out of range");
            }
3165 3166
        }
        else
N
Niels 已提交
3167
        {
N
Niels 已提交
3168
            throw std::domain_error("cannot use at() with " + type_name());
N
Niels 已提交
3169 3170 3171
        }
    }

N
Niels 已提交
3172 3173 3174
    /*!
    @brief access specified array element with bounds checking

N
Niels 已提交
3175 3176
    Returns a const reference to the element at specified location @a idx,
    with bounds checking.
N
Niels 已提交
3177 3178 3179 3180 3181

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

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

N
Niels 已提交
3182 3183
    @throw std::domain_error if the JSON value is not an array; example:
    `"cannot use at() with string"`
N
Niels 已提交
3184
    @throw std::out_of_range if the index @a idx is out of range of the array;
N
Niels 已提交
3185
    that is, `idx >= size()`; example: `"array index 7 is out of range"`
N
Niels 已提交
3186 3187 3188 3189

    @complexity Constant.

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

N
Niels 已提交
3192
    @since version 1.0.0
N
Niels 已提交
3193
    */
N
Niels 已提交
3194
    const_reference at(size_type idx) const
N
Niels 已提交
3195 3196
    {
        // at only works for arrays
3197 3198
        if (is_array())
        {
N
Niels 已提交
3199 3200 3201 3202
            try
            {
                return m_value.array->at(idx);
            }
3203
            catch (std::out_of_range&)
N
Niels 已提交
3204 3205 3206 3207
            {
                // create better exception explanation
                throw std::out_of_range("array index " + std::to_string(idx) + " is out of range");
            }
3208 3209
        }
        else
N
Niels 已提交
3210
        {
N
Niels 已提交
3211
            throw std::domain_error("cannot use at() with " + type_name());
N
Niels 已提交
3212
        }
3213 3214
    }

N
Niels 已提交
3215 3216 3217 3218 3219 3220 3221 3222 3223 3224
    /*!
    @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 已提交
3225 3226
    @throw std::domain_error if the JSON value is not an object; example:
    `"cannot use at() with boolean"`
N
Niels 已提交
3227
    @throw std::out_of_range if the key @a key is is not stored in the object;
N
Niels 已提交
3228
    that is, `find(key) == end()`; example: `"key "the fast" not found"`
N
Niels 已提交
3229 3230 3231 3232

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3233
    written using `at()`.,at__object_t_key_type}
N
Niels 已提交
3234 3235 3236 3237

    @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 已提交
3238

N
Niels 已提交
3239
    @since version 1.0.0
N
Niels 已提交
3240
    */
N
Niels 已提交
3241
    reference at(const typename object_t::key_type& key)
3242 3243
    {
        // at only works for objects
3244 3245
        if (is_object())
        {
N
Niels 已提交
3246 3247 3248 3249
            try
            {
                return m_value.object->at(key);
            }
3250
            catch (std::out_of_range&)
N
Niels 已提交
3251 3252 3253 3254
            {
                // create better exception explanation
                throw std::out_of_range("key '" + key + "' not found");
            }
3255 3256
        }
        else
3257
        {
N
Niels 已提交
3258
            throw std::domain_error("cannot use at() with " + type_name());
3259 3260 3261
        }
    }

N
Niels 已提交
3262 3263 3264
    /*!
    @brief access specified object element with bounds checking

N
Niels 已提交
3265 3266
    Returns a const reference to the element at with specified key @a key,
    with bounds checking.
N
Niels 已提交
3267 3268 3269 3270 3271

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

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

N
Niels 已提交
3272 3273
    @throw std::domain_error if the JSON value is not an object; example:
    `"cannot use at() with boolean"`
N
Niels 已提交
3274
    @throw std::out_of_range if the key @a key is is not stored in the object;
N
Niels 已提交
3275
    that is, `find(key) == end()`; example: `"key "the fast" not found"`
N
Niels 已提交
3276 3277 3278 3279

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3280
    `at()`.,at__object_t_key_type_const}
N
Niels 已提交
3281 3282 3283 3284

    @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 已提交
3285

N
Niels 已提交
3286
    @since version 1.0.0
N
Niels 已提交
3287
    */
N
Niels 已提交
3288
    const_reference at(const typename object_t::key_type& key) const
3289 3290
    {
        // at only works for objects
3291 3292
        if (is_object())
        {
N
Niels 已提交
3293 3294 3295 3296
            try
            {
                return m_value.object->at(key);
            }
3297
            catch (std::out_of_range&)
N
Niels 已提交
3298 3299 3300 3301
            {
                // create better exception explanation
                throw std::out_of_range("key '" + key + "' not found");
            }
3302 3303
        }
        else
3304
        {
N
Niels 已提交
3305
            throw std::domain_error("cannot use at() with " + type_name());
3306
        }
N
Niels 已提交
3307 3308
    }

N
Niels 已提交
3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321
    /*!
    @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 已提交
3322 3323
    @throw std::domain_error if JSON is not an array or null; example:
    `"cannot use operator[] with string"`
N
Niels 已提交
3324 3325 3326 3327 3328

    @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 已提交
3329
    written using `[]` operator. Note the addition of `null`
N
Niels 已提交
3330
    values.,operatorarray__size_type}
N
Niels 已提交
3331

N
Niels 已提交
3332
    @since version 1.0.0
N
Niels 已提交
3333
    */
N
Niels 已提交
3334
    reference operator[](size_type idx)
N
Niels 已提交
3335
    {
N
Niels 已提交
3336
        // implicitly convert null value to an empty array
N
cleanup  
Niels 已提交
3337
        if (is_null())
N
Niels 已提交
3338 3339
        {
            m_type = value_t::array;
N
Cleanup  
Niels 已提交
3340
            m_value.array = create<array_t>();
3341
            assert_invariant();
N
Niels 已提交
3342 3343
        }

N
Niels 已提交
3344
        // operator[] only works for arrays
N
cleanup  
Niels 已提交
3345
        if (is_array())
N
Niels 已提交
3346
        {
N
Niels 已提交
3347 3348
            // fill up array with null values if given idx is outside range
            if (idx >= m_value.array->size())
N
cleanup  
Niels 已提交
3349
            {
N
Niels 已提交
3350 3351 3352
                m_value.array->insert(m_value.array->end(),
                                      idx - m_value.array->size() + 1,
                                      basic_json());
N
cleanup  
Niels 已提交
3353
            }
N
Niels 已提交
3354

N
cleanup  
Niels 已提交
3355 3356 3357
            return m_value.array->operator[](idx);
        }
        else
N
Niels 已提交
3358
        {
N
cleanup  
Niels 已提交
3359
            throw std::domain_error("cannot use operator[] with " + type_name());
N
Niels 已提交
3360
        }
N
Niels 已提交
3361 3362
    }

N
Niels 已提交
3363 3364 3365 3366 3367 3368 3369 3370 3371
    /*!
    @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 已提交
3372 3373
    @throw std::domain_error if JSON is not an array; example: `"cannot use
    operator[] with null"`
N
Niels 已提交
3374 3375 3376 3377

    @complexity Constant.

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

N
Niels 已提交
3380
    @since version 1.0.0
N
Niels 已提交
3381
    */
N
Niels 已提交
3382
    const_reference operator[](size_type idx) const
N
Niels 已提交
3383
    {
N
Niels 已提交
3384
        // const operator[] only works for arrays
N
Niels 已提交
3385 3386 3387 3388 3389 3390 3391 3392
        if (is_array())
        {
            return m_value.array->operator[](idx);
        }
        else
        {
            throw std::domain_error("cannot use operator[] with " + type_name());
        }
N
Niels 已提交
3393 3394
    }

N
Niels 已提交
3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407
    /*!
    @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 已提交
3408
    @throw std::domain_error if JSON is not an object or null; example:
N
Niels 已提交
3409
    `"cannot use operator[] with string"`
N
Niels 已提交
3410 3411 3412 3413

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3414
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
3415 3416 3417 3418

    @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 已提交
3419

N
Niels 已提交
3420
    @since version 1.0.0
N
Niels 已提交
3421
    */
N
Niels 已提交
3422
    reference operator[](const typename object_t::key_type& key)
N
Niels 已提交
3423
    {
N
Niels 已提交
3424
        // implicitly convert null value to an empty object
N
cleanup  
Niels 已提交
3425
        if (is_null())
N
Niels 已提交
3426 3427
        {
            m_type = value_t::object;
N
Cleanup  
Niels 已提交
3428
            m_value.object = create<object_t>();
3429
            assert_invariant();
N
Niels 已提交
3430 3431
        }

N
Niels 已提交
3432
        // operator[] only works for objects
N
Niels 已提交
3433 3434 3435 3436 3437 3438 3439 3440
        if (is_object())
        {
            return m_value.object->operator[](key);
        }
        else
        {
            throw std::domain_error("cannot use operator[] with " + type_name());
        }
N
Niels 已提交
3441 3442
    }

N
Niels 已提交
3443
    /*!
3444
    @brief read-only access specified object element
N
Niels 已提交
3445

3446 3447 3448 3449 3450
    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.
N
Niels 已提交
3451 3452 3453

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

3454
    @return const reference to the element at key @a key
N
Niels 已提交
3455

N
Niels 已提交
3456 3457 3458
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

N
Niels 已提交
3459 3460
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    operator[] with null"`
N
Niels 已提交
3461 3462 3463 3464

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3465
    the `[]` operator.,operatorarray__key_type_const}
3466 3467 3468 3469 3470

    @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 已提交
3471
    @since version 1.0.0
N
Niels 已提交
3472
    */
N
Niels 已提交
3473
    const_reference operator[](const typename object_t::key_type& key) const
3474
    {
N
Niels 已提交
3475
        // const operator[] only works for objects
N
Niels 已提交
3476 3477 3478 3479 3480 3481 3482 3483 3484
        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());
        }
3485 3486
    }

N
Niels 已提交
3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499
    /*!
    @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 已提交
3500
    @throw std::domain_error if JSON is not an object or null; example:
N
Niels 已提交
3501
    `"cannot use operator[] with string"`
N
Niels 已提交
3502 3503 3504 3505

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3506
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
3507 3508 3509 3510

    @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 已提交
3511

N
Niels 已提交
3512
    @since version 1.0.0
N
Niels 已提交
3513
    */
N
Niels 已提交
3514
    template<typename T, std::size_t n>
N
Niels 已提交
3515
    reference operator[](T * (&key)[n])
3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540
    {
        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 已提交
3541
    the `[]` operator.,operatorarray__key_type_const}
3542 3543 3544 3545 3546 3547 3548 3549

    @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 已提交
3550
    const_reference operator[](T * (&key)[n]) const
3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568
    {
        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 已提交
3569
    `"cannot use operator[] with string"`
3570 3571 3572 3573

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3574
    written using the `[]` operator.,operatorarray__key_type}
3575 3576 3577 3578 3579

    @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 已提交
3580
    @since version 1.1.0
3581 3582 3583
    */
    template<typename T>
    reference operator[](T* key)
N
Niels 已提交
3584
    {
N
Niels 已提交
3585
        // implicitly convert null to object
N
cleanup  
Niels 已提交
3586
        if (is_null())
N
Niels 已提交
3587 3588
        {
            m_type = value_t::object;
N
Niels 已提交
3589
            m_value = value_t::object;
3590
            assert_invariant();
N
Niels 已提交
3591 3592
        }

N
Niels 已提交
3593
        // at only works for objects
N
Niels 已提交
3594 3595 3596 3597 3598 3599 3600 3601
        if (is_object())
        {
            return m_value.object->operator[](key);
        }
        else
        {
            throw std::domain_error("cannot use operator[] with " + type_name());
        }
N
Niels 已提交
3602 3603
    }

N
Niels 已提交
3604
    /*!
3605
    @brief read-only access specified object element
N
Niels 已提交
3606

3607 3608 3609 3610 3611
    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.
N
Niels 已提交
3612 3613 3614

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

3615
    @return const reference to the element at key @a key
N
Niels 已提交
3616

N
Niels 已提交
3617 3618 3619
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

N
Niels 已提交
3620 3621
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    operator[] with null"`
N
Niels 已提交
3622 3623 3624 3625

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3626
    the `[]` operator.,operatorarray__key_type_const}
3627 3628 3629 3630 3631

    @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 已提交
3632
    @since version 1.1.0
N
Niels 已提交
3633
    */
3634 3635
    template<typename T>
    const_reference operator[](T* key) const
3636 3637
    {
        // at only works for objects
N
Niels 已提交
3638 3639 3640 3641 3642 3643 3644 3645 3646
        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());
        }
3647 3648
    }

N
Niels 已提交
3649 3650 3651
    /*!
    @brief access specified object element with default value

N
Niels 已提交
3652 3653
    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.
3654

N
Niels 已提交
3655
    The function is basically equivalent to executing
3656
    @code {.cpp}
N
Niels 已提交
3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681
    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 已提交
3682 3683
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    value() with null"`
N
Niels 已提交
3684 3685 3686 3687 3688 3689 3690 3691 3692 3693

    @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 已提交
3694

N
Niels 已提交
3695
    @since version 1.0.0
N
Niels 已提交
3696
    */
N
Niels 已提交
3697 3698
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721
    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 已提交
3722
    @brief overload for a default value of type const char*
N
Niels 已提交
3723
    @copydoc basic_json::value(const typename object_t::key_type&, ValueType) const
N
Niels 已提交
3724 3725 3726 3727
    */
    string_t value(const typename object_t::key_type& key, const char* default_value) const
    {
        return value(key, string_t(default_value));
3728 3729
    }

N
Niels 已提交
3730 3731 3732
    /*!
    @brief access specified object element via JSON Pointer with default value

N
Niels 已提交
3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747
    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 已提交
3748 3749 3750 3751 3752 3753 3754 3755
    @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 已提交
3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766
    @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 已提交
3767
    @sa @ref operator[](const json_pointer&) for unchecked access by reference
N
Niels 已提交
3768

N
Niels 已提交
3769 3770
    @since version 2.0.2
    */
N
Niels 已提交
3771 3772
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795
    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 已提交
3796
    @copydoc basic_json::value(const json_pointer&, ValueType) const
N
Niels 已提交
3797 3798 3799 3800 3801 3802
    */
    string_t value(const json_pointer& ptr, const char* default_value) const
    {
        return value(ptr, string_t(default_value));
    }

N
Niels 已提交
3803 3804 3805 3806 3807 3808
    /*!
    @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 已提交
3809
    @return In case of a structured type (array or object), a reference to the
N
Niels 已提交
3810 3811 3812 3813 3814
    first element is returned. In cast of number, string, or boolean values, a
    reference to the value is returned.

    @complexity Constant.

N
Niels 已提交
3815
    @pre The JSON value must not be `null` (would throw `std::out_of_range`)
N
Niels 已提交
3816 3817
    or an empty array or object (undefined behavior, **guarded by
    assertions**).
N
Niels 已提交
3818 3819 3820
    @post The JSON value remains unchanged.

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

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

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

N
Niels 已提交
3826
    @since version 1.0.0
N
Niels 已提交
3827
    */
N
Niels 已提交
3828
    reference front()
N
Niels 已提交
3829 3830 3831 3832
    {
        return *begin();
    }

N
Niels 已提交
3833 3834 3835
    /*!
    @copydoc basic_json::front()
    */
N
Niels 已提交
3836
    const_reference front() const
N
Niels 已提交
3837 3838 3839 3840
    {
        return *cbegin();
    }

N
Niels 已提交
3841 3842 3843 3844
    /*!
    @brief access the last element

    Returns a reference to the last element in the container. For a JSON
N
Niels 已提交
3845 3846 3847 3848 3849 3850
    container `c`, the expression `c.back()` is equivalent to
    @code {.cpp}
    auto tmp = c.end();
    --tmp;
    return *tmp;
    @endcode
N
Niels 已提交
3851

N
Niels 已提交
3852
    @return In case of a structured type (array or object), a reference to the
N
Niels 已提交
3853 3854 3855 3856 3857
    last element is returned. In cast of number, string, or boolean values, a
    reference to the value is returned.

    @complexity Constant.

N
Niels 已提交
3858
    @pre The JSON value must not be `null` (would throw `std::out_of_range`)
N
Niels 已提交
3859 3860
    or an empty array or object (undefined behavior, **guarded by
    assertions**).
N
Niels 已提交
3861
    @post The JSON value remains unchanged.
N
Niels 已提交
3862

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

N
Niels 已提交
3865 3866 3867
    @liveexample{The following code shows an example for `back()`.,back}

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

N
Niels 已提交
3869
    @since version 1.0.0
N
Niels 已提交
3870
    */
N
Niels 已提交
3871
    reference back()
N
Niels 已提交
3872 3873 3874 3875 3876 3877
    {
        auto tmp = end();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
3878 3879 3880
    /*!
    @copydoc basic_json::back()
    */
N
Niels 已提交
3881
    const_reference back() const
N
Niels 已提交
3882 3883 3884 3885 3886 3887
    {
        auto tmp = cend();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
3888 3889 3890
    /*!
    @brief remove element given an iterator

N
Niels 已提交
3891 3892 3893
    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 已提交
3894

N
Niels 已提交
3895
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
3896 3897 3898
    will be `null`.

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

3902
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
3903

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

N
Niels 已提交
3907 3908
    @throw std::domain_error if called on a `null` value; example: `"cannot
    use erase() with null"`
N
Niels 已提交
3909
    @throw std::domain_error if called on an iterator which does not belong to
N
Niels 已提交
3910
    the current JSON value; example: `"iterator does not fit current value"`
N
Niels 已提交
3911
    @throw std::out_of_range if called on a primitive type with invalid
N
Niels 已提交
3912 3913
    iterator (i.e., any iterator which is not `begin()`); example: `"iterator
    out of range"`
N
Niels 已提交
3914 3915 3916 3917 3918 3919 3920

    @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 已提交
3921
    @liveexample{The example shows the result of `erase()` for different JSON
N
Niels 已提交
3922
    types.,erase__IteratorType}
N
Niels 已提交
3923

3924
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
3925
    the given range
N
Niels 已提交
3926
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
3927
    from an object at the given key
N
Niels 已提交
3928 3929
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
3930

N
Niels 已提交
3931
    @since version 1.0.0
N
Niels 已提交
3932
    */
N
Niels 已提交
3933 3934 3935 3936
    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>
3937
    IteratorType erase(IteratorType pos)
3938 3939
    {
        // make sure iterator fits the current value
N
Niels 已提交
3940
        if (this != pos.m_object)
3941
        {
N
Niels 已提交
3942
            throw std::domain_error("iterator does not fit current value");
3943 3944
        }

3945
        IteratorType result = end();
3946 3947 3948 3949

        switch (m_type)
        {
            case value_t::boolean:
3950 3951
            case value_t::number_float:
            case value_t::number_integer:
3952
            case value_t::number_unsigned:
3953 3954
            case value_t::string:
            {
3955
                if (not pos.m_it.primitive_iterator.is_begin())
3956 3957 3958 3959
                {
                    throw std::out_of_range("iterator out of range");
                }

N
cleanup  
Niels 已提交
3960
                if (is_string())
3961
                {
3962 3963 3964
                    AllocatorType<string_t> alloc;
                    alloc.destroy(m_value.string);
                    alloc.deallocate(m_value.string, 1);
3965 3966 3967 3968
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
3969
                assert_invariant();
3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986
                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 已提交
3987
                throw std::domain_error("cannot use erase() with " + type_name());
3988 3989 3990 3991 3992 3993
            }
        }

        return result;
    }

N
Niels 已提交
3994 3995 3996
    /*!
    @brief remove elements given an iterator range

N
Niels 已提交
3997 3998 3999
    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 已提交
4000

N
Niels 已提交
4001
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
4002 4003 4004 4005 4006
    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 已提交
4007
    second refers to the last element, the `end()` iterator is returned.
N
Niels 已提交
4008

4009
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
4010

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

N
Niels 已提交
4014 4015
    @throw std::domain_error if called on a `null` value; example: `"cannot
    use erase() with null"`
N
Niels 已提交
4016
    @throw std::domain_error if called on iterators which does not belong to
N
Niels 已提交
4017
    the current JSON value; example: `"iterators do not fit current value"`
N
Niels 已提交
4018
    @throw std::out_of_range if called on a primitive type with invalid
N
Niels 已提交
4019 4020
    iterators (i.e., if `first != begin()` and `last != end()`); example:
    `"iterators out of range"`
N
Niels 已提交
4021 4022 4023 4024 4025 4026 4027 4028

    @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 已提交
4029
    @liveexample{The example shows the result of `erase()` for different JSON
N
Niels 已提交
4030
    types.,erase__IteratorType_IteratorType}
N
Niels 已提交
4031

4032
    @sa @ref erase(IteratorType) -- removes the element at a given position
N
Niels 已提交
4033
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4034
    from an object at the given key
N
Niels 已提交
4035 4036
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4037

N
Niels 已提交
4038
    @since version 1.0.0
N
Niels 已提交
4039
    */
N
Niels 已提交
4040 4041 4042 4043
    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>
4044
    IteratorType erase(IteratorType first, IteratorType last)
4045 4046
    {
        // make sure iterator fits the current value
N
Niels 已提交
4047
        if (this != first.m_object or this != last.m_object)
4048
        {
N
Niels 已提交
4049
            throw std::domain_error("iterators do not fit current value");
4050 4051
        }

4052
        IteratorType result = end();
4053 4054 4055 4056

        switch (m_type)
        {
            case value_t::boolean:
4057 4058
            case value_t::number_float:
            case value_t::number_integer:
4059
            case value_t::number_unsigned:
4060 4061
            case value_t::string:
            {
4062
                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
4063 4064 4065 4066
                {
                    throw std::out_of_range("iterators out of range");
                }

N
cleanup  
Niels 已提交
4067
                if (is_string())
4068
                {
4069 4070 4071
                    AllocatorType<string_t> alloc;
                    alloc.destroy(m_value.string);
                    alloc.deallocate(m_value.string, 1);
4072 4073 4074 4075
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
4076
                assert_invariant();
4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095
                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 已提交
4096
                throw std::domain_error("cannot use erase() with " + type_name());
4097 4098 4099 4100 4101 4102
            }
        }

        return result;
    }

N
Niels 已提交
4103 4104 4105 4106 4107 4108 4109
    /*!
    @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 已提交
4110
    @return Number of elements removed. If @a ObjectType is the default
N
Niels 已提交
4111 4112
    `std::map` type, the return value will always be `0` (@a key was not
    found) or `1` (@a key was found).
N
Niels 已提交
4113 4114 4115

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

N
Niels 已提交
4117 4118
    @throw std::domain_error when called on a type other than JSON object;
    example: `"cannot use erase() with null"`
N
Niels 已提交
4119 4120 4121

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

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

4124 4125
    @sa @ref erase(IteratorType) -- removes the element at a given position
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4126 4127 4128
    the given range
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4129

N
Niels 已提交
4130
    @since version 1.0.0
N
Niels 已提交
4131
    */
N
Niels 已提交
4132
    size_type erase(const typename object_t::key_type& key)
4133
    {
N
Niels 已提交
4134
        // this erase only works for objects
N
Niels 已提交
4135 4136 4137 4138 4139 4140 4141 4142
        if (is_object())
        {
            return m_value.object->erase(key);
        }
        else
        {
            throw std::domain_error("cannot use erase() with " + type_name());
        }
4143 4144
    }

N
Niels 已提交
4145 4146 4147 4148 4149 4150 4151
    /*!
    @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 已提交
4152 4153
    @throw std::domain_error when called on a type other than JSON array;
    example: `"cannot use erase() with null"`
N
Niels 已提交
4154 4155
    @throw std::out_of_range when `idx >= size()`; example: `"array index 17
    is out of range"`
N
Niels 已提交
4156 4157 4158

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

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

4161 4162
    @sa @ref erase(IteratorType) -- removes the element at a given position
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4163
    the given range
N
Niels 已提交
4164
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4165 4166
    from an object at the given key

N
Niels 已提交
4167
    @since version 1.0.0
N
Niels 已提交
4168
    */
N
Niels 已提交
4169
    void erase(const size_type idx)
N
Niels 已提交
4170 4171
    {
        // this erase only works for arrays
N
cleanup  
Niels 已提交
4172
        if (is_array())
N
Niels 已提交
4173
        {
N
cleanup  
Niels 已提交
4174 4175
            if (idx >= size())
            {
N
Niels 已提交
4176
                throw std::out_of_range("array index " + std::to_string(idx) + " is out of range");
N
cleanup  
Niels 已提交
4177
            }
N
Niels 已提交
4178

N
cleanup  
Niels 已提交
4179 4180 4181
            m_value.array->erase(m_value.array->begin() + static_cast<difference_type>(idx));
        }
        else
N
Niels 已提交
4182
        {
N
cleanup  
Niels 已提交
4183
            throw std::domain_error("cannot use erase() with " + type_name());
N
Niels 已提交
4184 4185 4186
        }
    }

N
Niels 已提交
4187 4188 4189 4190 4191 4192 4193 4194 4195 4196
    /// @}


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

    /// @name lookup
    /// @{

N
Niels 已提交
4197 4198 4199 4200
    /*!
    @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 已提交
4201 4202
    element is not found or the JSON value is not an object, end() is
    returned.
N
Niels 已提交
4203 4204 4205 4206 4207 4208 4209 4210

    @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 已提交
4211
    @liveexample{The example shows how `find()` is used.,find__key_type}
N
Niels 已提交
4212

N
Niels 已提交
4213
    @since version 1.0.0
N
Niels 已提交
4214
    */
N
Niels 已提交
4215
    iterator find(typename object_t::key_type key)
N
Niels 已提交
4216 4217 4218
    {
        auto result = end();

N
cleanup  
Niels 已提交
4219
        if (is_object())
N
Niels 已提交
4220 4221 4222 4223 4224 4225 4226
        {
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4227 4228 4229 4230
    /*!
    @brief find an element in a JSON object
    @copydoc find(typename object_t::key_type)
    */
N
Niels 已提交
4231
    const_iterator find(typename object_t::key_type key) const
N
Niels 已提交
4232 4233 4234
    {
        auto result = cend();

N
cleanup  
Niels 已提交
4235
        if (is_object())
N
Niels 已提交
4236 4237 4238 4239 4240 4241 4242
        {
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256
    /*!
    @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 已提交
4257
    @liveexample{The example shows how `count()` is used.,count}
N
Niels 已提交
4258

N
Niels 已提交
4259
    @since version 1.0.0
N
Niels 已提交
4260
    */
N
Niels 已提交
4261
    size_type count(typename object_t::key_type key) const
4262 4263
    {
        // return 0 for all nonobject types
N
Niels 已提交
4264
        return is_object() ? m_value.object->count(key) : 0;
4265 4266
    }

N
Niels 已提交
4267 4268
    /// @}

N
Niels 已提交
4269

N
Niels 已提交
4270 4271 4272 4273
    ///////////////
    // iterators //
    ///////////////

N
Niels 已提交
4274 4275 4276
    /// @name iterators
    /// @{

N
Niels 已提交
4277 4278
    /*!
    @brief returns an iterator to the first element
N
Niels 已提交
4279 4280 4281 4282 4283 4284 4285 4286 4287

    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 已提交
4288 4289 4290
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
4291 4292
    - The complexity is constant.

N
Niels 已提交
4293 4294 4295 4296 4297
    @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 已提交
4298

N
Niels 已提交
4299
    @since version 1.0.0
N
Niels 已提交
4300
    */
N
Niels 已提交
4301
    iterator begin() noexcept
N
Niels 已提交
4302 4303 4304 4305 4306 4307
    {
        iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4308
    /*!
N
Niels 已提交
4309
    @copydoc basic_json::cbegin()
N
Niels 已提交
4310
    */
N
Niels 已提交
4311
    const_iterator begin() const noexcept
N
Niels 已提交
4312
    {
N
Niels 已提交
4313
        return cbegin();
N
Niels 已提交
4314 4315
    }

N
Niels 已提交
4316 4317
    /*!
    @brief returns a const iterator to the first element
N
Niels 已提交
4318 4319 4320 4321 4322 4323 4324 4325 4326

    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 已提交
4327 4328 4329
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
4330 4331 4332
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).begin()`.

N
Niels 已提交
4333 4334 4335 4336 4337
    @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 已提交
4338

N
Niels 已提交
4339
    @since version 1.0.0
N
Niels 已提交
4340
    */
N
Niels 已提交
4341
    const_iterator cbegin() const noexcept
N
Niels 已提交
4342 4343 4344 4345 4346 4347
    {
        const_iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4348 4349
    /*!
    @brief returns an iterator to one past the last element
N
Niels 已提交
4350 4351 4352 4353 4354 4355 4356 4357 4358

    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 已提交
4359 4360 4361
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
4362 4363
    - The complexity is constant.

N
Niels 已提交
4364 4365 4366 4367 4368
    @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 已提交
4369

N
Niels 已提交
4370
    @since version 1.0.0
N
Niels 已提交
4371
    */
N
Niels 已提交
4372
    iterator end() noexcept
N
Niels 已提交
4373 4374 4375 4376 4377 4378
    {
        iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
4379
    /*!
N
Niels 已提交
4380
    @copydoc basic_json::cend()
N
Niels 已提交
4381
    */
N
Niels 已提交
4382
    const_iterator end() const noexcept
N
Niels 已提交
4383
    {
N
Niels 已提交
4384
        return cend();
N
Niels 已提交
4385 4386
    }

N
Niels 已提交
4387 4388
    /*!
    @brief returns a const iterator to one past the last element
N
Niels 已提交
4389 4390 4391 4392 4393 4394 4395 4396 4397

    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 已提交
4398 4399 4400
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
4401 4402 4403
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).end()`.

N
Niels 已提交
4404 4405 4406 4407 4408
    @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 已提交
4409

N
Niels 已提交
4410
    @since version 1.0.0
N
Niels 已提交
4411
    */
N
Niels 已提交
4412
    const_iterator cend() const noexcept
N
Niels 已提交
4413 4414 4415 4416 4417 4418
    {
        const_iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
4419
    /*!
N
Niels 已提交
4420 4421 4422 4423 4424 4425 4426 4427
    @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 已提交
4428 4429 4430
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4431 4432 4433
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(end())`.

N
Niels 已提交
4434 4435 4436 4437 4438
    @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 已提交
4439

N
Niels 已提交
4440
    @since version 1.0.0
N
Niels 已提交
4441
    */
N
Niels 已提交
4442
    reverse_iterator rbegin() noexcept
N
Niels 已提交
4443 4444 4445 4446
    {
        return reverse_iterator(end());
    }

N
Niels 已提交
4447
    /*!
N
Niels 已提交
4448
    @copydoc basic_json::crbegin()
N
Niels 已提交
4449
    */
N
Niels 已提交
4450
    const_reverse_iterator rbegin() const noexcept
N
Niels 已提交
4451
    {
N
Niels 已提交
4452
        return crbegin();
N
Niels 已提交
4453 4454
    }

N
Niels 已提交
4455
    /*!
N
Niels 已提交
4456 4457 4458 4459 4460 4461 4462 4463 4464
    @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 已提交
4465 4466 4467
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4468 4469 4470
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(begin())`.

N
Niels 已提交
4471 4472 4473 4474 4475
    @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 已提交
4476

N
Niels 已提交
4477
    @since version 1.0.0
N
Niels 已提交
4478
    */
N
Niels 已提交
4479
    reverse_iterator rend() noexcept
N
Niels 已提交
4480 4481 4482 4483
    {
        return reverse_iterator(begin());
    }

N
Niels 已提交
4484
    /*!
N
Niels 已提交
4485
    @copydoc basic_json::crend()
N
Niels 已提交
4486
    */
N
Niels 已提交
4487
    const_reverse_iterator rend() const noexcept
N
Niels 已提交
4488
    {
N
Niels 已提交
4489
        return crend();
N
Niels 已提交
4490 4491
    }

N
Niels 已提交
4492
    /*!
N
Niels 已提交
4493 4494 4495 4496 4497 4498 4499 4500 4501
    @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 已提交
4502 4503 4504
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4505 4506 4507
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).rbegin()`.

N
Niels 已提交
4508 4509 4510 4511 4512
    @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 已提交
4513

N
Niels 已提交
4514
    @since version 1.0.0
N
Niels 已提交
4515
    */
N
Niels 已提交
4516
    const_reverse_iterator crbegin() const noexcept
N
Niels 已提交
4517 4518 4519 4520
    {
        return const_reverse_iterator(cend());
    }

N
Niels 已提交
4521
    /*!
N
Niels 已提交
4522 4523 4524 4525 4526 4527 4528 4529 4530
    @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 已提交
4531 4532 4533
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4534 4535 4536
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).rend()`.

N
Niels 已提交
4537 4538 4539 4540 4541
    @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 已提交
4542

N
Niels 已提交
4543
    @since version 1.0.0
N
Niels 已提交
4544
    */
N
Niels 已提交
4545
    const_reverse_iterator crend() const noexcept
N
Niels 已提交
4546 4547 4548 4549
    {
        return const_reverse_iterator(cbegin());
    }

N
cleanup  
Niels 已提交
4550 4551 4552 4553 4554 4555 4556 4557
  private:
    // forward declaration
    template<typename IteratorType> class iteration_proxy;

  public:
    /*!
    @brief wrapper to access iterator member functions in range-based for

N
Niels 已提交
4558
    This function allows to access @ref iterator::key() and @ref
N
Niels 已提交
4559 4560 4561
    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 已提交
4562 4563 4564

    @note The name of this function is not yet final and may change in the
    future.
N
cleanup  
Niels 已提交
4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578
    */
    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 已提交
4579 4580
    /// @}

N
Niels 已提交
4581 4582 4583 4584 4585

    //////////////
    // capacity //
    //////////////

N
Niels 已提交
4586 4587 4588
    /// @name capacity
    /// @{

N
Niels 已提交
4589 4590
    /*!
    @brief checks whether the container is empty
N
Niels 已提交
4591 4592 4593

    Checks if a JSON value has no elements.

N
Niels 已提交
4594
    @return The return value depends on the different types and is
N
Niels 已提交
4595 4596 4597
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
4598 4599 4600 4601 4602 4603
            null        | `true`
            boolean     | `false`
            string      | `false`
            number      | `false`
            object      | result of function `object_t::empty()`
            array       | result of function `array_t::empty()`
N
Niels 已提交
4604

N
Niels 已提交
4605 4606 4607 4608
    @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 已提交
4609 4610
    @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 已提交
4611
    complexity.
N
Niels 已提交
4612

N
Niels 已提交
4613 4614 4615
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
4616 4617 4618
    - The complexity is constant.
    - Has the semantics of `begin() == end()`.

N
Niels 已提交
4619
    @liveexample{The following code uses `empty()` to check if a JSON
N
Niels 已提交
4620
    object contains any elements.,empty}
N
Niels 已提交
4621

N
Niels 已提交
4622 4623
    @sa @ref size() -- returns the number of elements

N
Niels 已提交
4624
    @since version 1.0.0
N
Niels 已提交
4625
    */
N
Niels 已提交
4626
    bool empty() const noexcept
N
Niels 已提交
4627 4628 4629
    {
        switch (m_type)
        {
4630
            case value_t::null:
N
Niels 已提交
4631
            {
N
Niels 已提交
4632
                // null values are empty
N
Niels 已提交
4633 4634
                return true;
            }
N
Niels 已提交
4635

4636
            case value_t::array:
N
Niels 已提交
4637
            {
N
Niels 已提交
4638
                // delegate call to array_t::empty()
N
Niels 已提交
4639 4640
                return m_value.array->empty();
            }
N
Niels 已提交
4641

4642
            case value_t::object:
N
Niels 已提交
4643
            {
N
Niels 已提交
4644
                // delegate call to object_t::empty()
N
Niels 已提交
4645 4646
                return m_value.object->empty();
            }
N
Niels 已提交
4647

N
Niels 已提交
4648 4649 4650 4651 4652 4653
            default:
            {
                // all other types are nonempty
                return false;
            }
        }
N
Niels 已提交
4654 4655
    }

N
Niels 已提交
4656 4657
    /*!
    @brief returns the number of elements
N
Niels 已提交
4658 4659 4660

    Returns the number of elements in a JSON value.

N
Niels 已提交
4661
    @return The return value depends on the different types and is
N
Niels 已提交
4662 4663 4664
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
4665 4666 4667 4668
            null        | `0`
            boolean     | `1`
            string      | `1`
            number      | `1`
N
Niels 已提交
4669 4670 4671
            object      | result of function object_t::size()
            array       | result of function array_t::size()

N
Niels 已提交
4672 4673 4674 4675
    @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 已提交
4676 4677 4678
    @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 已提交
4679

N
Niels 已提交
4680 4681 4682
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
4683 4684 4685
    - The complexity is constant.
    - Has the semantics of `std::distance(begin(), end())`.

N
Niels 已提交
4686
    @liveexample{The following code calls `size()` on the different value
N
Niels 已提交
4687
    types.,size}
N
Niels 已提交
4688

N
Niels 已提交
4689 4690 4691
    @sa @ref empty() -- checks whether the container is empty
    @sa @ref max_size() -- returns the maximal number of elements

N
Niels 已提交
4692
    @since version 1.0.0
N
Niels 已提交
4693
    */
N
Niels 已提交
4694
    size_type size() const noexcept
N
Niels 已提交
4695 4696 4697
    {
        switch (m_type)
        {
4698
            case value_t::null:
N
Niels 已提交
4699
            {
N
Niels 已提交
4700
                // null values are empty
N
Niels 已提交
4701 4702
                return 0;
            }
N
Niels 已提交
4703

4704
            case value_t::array:
N
Niels 已提交
4705
            {
N
Niels 已提交
4706
                // delegate call to array_t::size()
N
Niels 已提交
4707 4708
                return m_value.array->size();
            }
N
Niels 已提交
4709

4710
            case value_t::object:
N
Niels 已提交
4711
            {
N
Niels 已提交
4712
                // delegate call to object_t::size()
N
Niels 已提交
4713 4714
                return m_value.object->size();
            }
N
Niels 已提交
4715

N
Niels 已提交
4716 4717 4718 4719 4720 4721
            default:
            {
                // all other types have size 1
                return 1;
            }
        }
N
Niels 已提交
4722 4723
    }

N
Niels 已提交
4724 4725
    /*!
    @brief returns the maximum possible number of elements
N
Niels 已提交
4726 4727 4728 4729 4730

    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 已提交
4731
    @return The return value depends on the different types and is
N
Niels 已提交
4732 4733 4734
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
4735 4736 4737 4738 4739 4740
            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 已提交
4741

N
Niels 已提交
4742 4743
    @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 已提交
4744
    complexity.
N
Niels 已提交
4745

N
Niels 已提交
4746 4747 4748
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
4749 4750 4751 4752
    - The complexity is constant.
    - Has the semantics of returning `b.size()` where `b` is the largest
      possible JSON value.

N
Niels 已提交
4753
    @liveexample{The following code calls `max_size()` on the different value
N
Niels 已提交
4754
    types. Note the output is implementation specific.,max_size}
N
Niels 已提交
4755

N
Niels 已提交
4756 4757
    @sa @ref size() -- returns the number of elements

N
Niels 已提交
4758
    @since version 1.0.0
N
Niels 已提交
4759
    */
N
Niels 已提交
4760
    size_type max_size() const noexcept
N
Niels 已提交
4761 4762 4763
    {
        switch (m_type)
        {
4764
            case value_t::array:
N
Niels 已提交
4765
            {
N
Niels 已提交
4766
                // delegate call to array_t::max_size()
N
Niels 已提交
4767 4768
                return m_value.array->max_size();
            }
N
Niels 已提交
4769

4770
            case value_t::object:
N
Niels 已提交
4771
            {
N
Niels 已提交
4772
                // delegate call to object_t::max_size()
N
Niels 已提交
4773 4774
                return m_value.object->max_size();
            }
N
Niels 已提交
4775

N
Niels 已提交
4776 4777
            default:
            {
4778 4779
                // all other types have max_size() == size()
                return size();
N
Niels 已提交
4780 4781
            }
        }
N
Niels 已提交
4782 4783
    }

N
Niels 已提交
4784 4785
    /// @}

N
Niels 已提交
4786 4787 4788 4789 4790

    ///////////////
    // modifiers //
    ///////////////

N
Niels 已提交
4791 4792 4793
    /// @name modifiers
    /// @{

N
Niels 已提交
4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813
    /*!
    @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 已提交
4814
    @liveexample{The example below shows the effect of `clear()` to different
N
Niels 已提交
4815
    JSON types.,clear}
N
Niels 已提交
4816

N
Niels 已提交
4817
    @since version 1.0.0
N
Niels 已提交
4818
    */
N
Niels 已提交
4819
    void clear() noexcept
N
Niels 已提交
4820 4821 4822
    {
        switch (m_type)
        {
4823
            case value_t::number_integer:
N
Niels 已提交
4824
            {
N
Niels 已提交
4825
                m_value.number_integer = 0;
N
Niels 已提交
4826 4827
                break;
            }
N
Niels 已提交
4828

4829 4830 4831 4832 4833 4834
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = 0;
                break;
            }

4835
            case value_t::number_float:
N
Niels 已提交
4836
            {
N
Niels 已提交
4837
                m_value.number_float = 0.0;
N
Niels 已提交
4838 4839
                break;
            }
N
Niels 已提交
4840

4841
            case value_t::boolean:
N
Niels 已提交
4842
            {
N
Niels 已提交
4843
                m_value.boolean = false;
N
Niels 已提交
4844 4845
                break;
            }
N
Niels 已提交
4846

4847
            case value_t::string:
N
Niels 已提交
4848 4849 4850 4851
            {
                m_value.string->clear();
                break;
            }
N
Niels 已提交
4852

4853
            case value_t::array:
N
Niels 已提交
4854 4855 4856 4857
            {
                m_value.array->clear();
                break;
            }
N
Niels 已提交
4858

4859
            case value_t::object:
N
Niels 已提交
4860 4861 4862 4863
            {
                m_value.object->clear();
                break;
            }
4864 4865 4866 4867 4868

            default:
            {
                break;
            }
N
Niels 已提交
4869 4870 4871
        }
    }

4872 4873 4874
    /*!
    @brief add an object to an array

4875
    Appends the given element @a val to the end of the JSON value. If the
4876
    function is called on a JSON null value, an empty array is created before
4877
    appending @a val.
4878

N
Niels 已提交
4879
    @param[in] val the value to add to the JSON array
4880

N
Niels 已提交
4881 4882
    @throw std::domain_error when called on a type other than JSON array or
    null; example: `"cannot use push_back() with number"`
4883 4884 4885

    @complexity Amortized constant.

N
Niels 已提交
4886 4887 4888
    @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 已提交
4889

N
Niels 已提交
4890
    @since version 1.0.0
4891
    */
4892
    void push_back(basic_json&& val)
N
Niels 已提交
4893 4894
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
4895
        if (not(is_null() or is_array()))
N
Niels 已提交
4896
        {
N
Niels 已提交
4897
            throw std::domain_error("cannot use push_back() with " + type_name());
N
Niels 已提交
4898 4899 4900
        }

        // transform null object into an array
N
cleanup  
Niels 已提交
4901
        if (is_null())
N
Niels 已提交
4902 4903
        {
            m_type = value_t::array;
N
Niels 已提交
4904
            m_value = value_t::array;
4905
            assert_invariant();
N
Niels 已提交
4906 4907 4908
        }

        // add element to array (move semantics)
4909
        m_value.array->push_back(std::move(val));
N
Niels 已提交
4910
        // invalidate object
4911
        val.m_type = value_t::null;
N
Niels 已提交
4912 4913
    }

4914 4915 4916 4917
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
4918
    reference operator+=(basic_json&& val)
N
Niels 已提交
4919
    {
4920
        push_back(std::move(val));
N
Niels 已提交
4921 4922 4923
        return *this;
    }

4924 4925 4926 4927
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
4928
    void push_back(const basic_json& val)
N
Niels 已提交
4929 4930
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
4931
        if (not(is_null() or is_array()))
N
Niels 已提交
4932
        {
N
Niels 已提交
4933
            throw std::domain_error("cannot use push_back() with " + type_name());
N
Niels 已提交
4934 4935 4936
        }

        // transform null object into an array
N
cleanup  
Niels 已提交
4937
        if (is_null())
N
Niels 已提交
4938 4939
        {
            m_type = value_t::array;
N
Niels 已提交
4940
            m_value = value_t::array;
4941
            assert_invariant();
N
Niels 已提交
4942 4943 4944
        }

        // add element to array
4945
        m_value.array->push_back(val);
N
Niels 已提交
4946 4947
    }

4948 4949 4950 4951
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
4952
    reference operator+=(const basic_json& val)
N
Niels 已提交
4953
    {
4954
        push_back(val);
N
Niels 已提交
4955 4956 4957
        return *this;
    }

4958 4959 4960
    /*!
    @brief add an object to an object

4961
    Inserts the given element @a val to the JSON object. If the function is
N
Niels 已提交
4962 4963
    called on a JSON null value, an empty object is created before inserting
    @a val.
4964

4965
    @param[in] val the value to add to the JSON object
4966 4967

    @throw std::domain_error when called on a type other than JSON object or
N
Niels 已提交
4968
    null; example: `"cannot use push_back() with number"`
4969 4970 4971

    @complexity Logarithmic in the size of the container, O(log(`size()`)).

N
Niels 已提交
4972 4973 4974
    @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 已提交
4975

N
Niels 已提交
4976
    @since version 1.0.0
4977
    */
4978
    void push_back(const typename object_t::value_type& val)
N
Niels 已提交
4979 4980
    {
        // push_back only works for null objects or objects
N
cleanup  
Niels 已提交
4981
        if (not(is_null() or is_object()))
N
Niels 已提交
4982
        {
N
Niels 已提交
4983
            throw std::domain_error("cannot use push_back() with " + type_name());
N
Niels 已提交
4984 4985 4986
        }

        // transform null object into an object
N
cleanup  
Niels 已提交
4987
        if (is_null())
N
Niels 已提交
4988 4989
        {
            m_type = value_t::object;
N
Niels 已提交
4990
            m_value = value_t::object;
4991
            assert_invariant();
N
Niels 已提交
4992 4993 4994
        }

        // add element to array
4995
        m_value.object->insert(val);
N
Niels 已提交
4996 4997
    }

4998 4999 5000 5001
    /*!
    @brief add an object to an object
    @copydoc push_back(const typename object_t::value_type&)
    */
5002
    reference operator+=(const typename object_t::value_type& val)
N
Niels 已提交
5003
    {
5004
        push_back(val);
N
Niels 已提交
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 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053
        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
Niels 已提交
5054 5055
    }

N
Niels 已提交
5056 5057 5058
    /*!
    @brief inserts element

5059
    Inserts element @a val before iterator @a pos.
N
Niels 已提交
5060 5061 5062

    @param[in] pos iterator before which the content will be inserted; may be
    the end() iterator
5063 5064
    @param[in] val element to insert
    @return iterator pointing to the inserted @a val.
N
Niels 已提交
5065

N
Niels 已提交
5066 5067
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
N
Niels 已提交
5068 5069
    @throw std::domain_error if @a pos is not an iterator of *this; example:
    `"iterator does not fit current value"`
N
Niels 已提交
5070 5071 5072 5073

    @complexity Constant plus linear in the distance between pos and end of the
    container.

N
Niels 已提交
5074
    @liveexample{The example shows how `insert()` is used.,insert}
N
Niels 已提交
5075

N
Niels 已提交
5076
    @since version 1.0.0
N
Niels 已提交
5077
    */
5078
    iterator insert(const_iterator pos, const basic_json& val)
N
Niels 已提交
5079 5080
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5081
        if (is_array())
N
Niels 已提交
5082
        {
N
cleanup  
Niels 已提交
5083 5084 5085 5086 5087
            // 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 已提交
5088

N
cleanup  
Niels 已提交
5089 5090
            // insert to array and return iterator
            iterator result(this);
5091
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, val);
N
cleanup  
Niels 已提交
5092 5093 5094
            return result;
        }
        else
N
Niels 已提交
5095
        {
N
cleanup  
Niels 已提交
5096
            throw std::domain_error("cannot use insert() with " + type_name());
N
Niels 已提交
5097 5098 5099 5100 5101 5102 5103
        }
    }

    /*!
    @brief inserts element
    @copydoc insert(const_iterator, const basic_json&)
    */
5104
    iterator insert(const_iterator pos, basic_json&& val)
N
Niels 已提交
5105
    {
5106
        return insert(pos, val);
N
Niels 已提交
5107 5108 5109 5110 5111
    }

    /*!
    @brief inserts elements

5112
    Inserts @a cnt copies of @a val before iterator @a pos.
N
Niels 已提交
5113 5114 5115

    @param[in] pos iterator before which the content will be inserted; may be
    the end() iterator
5116 5117
    @param[in] cnt number of copies of @a val to insert
    @param[in] val element to insert
N
Niels 已提交
5118
    @return iterator pointing to the first element inserted, or @a pos if
5119
    `cnt==0`
N
Niels 已提交
5120

N
Niels 已提交
5121 5122
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
N
Niels 已提交
5123 5124
    @throw std::domain_error if @a pos is not an iterator of *this; example:
    `"iterator does not fit current value"`
N
Niels 已提交
5125

5126
    @complexity Linear in @a cnt plus linear in the distance between @a pos
N
Niels 已提交
5127 5128
    and end of the container.

N
Niels 已提交
5129
    @liveexample{The example shows how `insert()` is used.,insert__count}
N
Niels 已提交
5130

N
Niels 已提交
5131
    @since version 1.0.0
N
Niels 已提交
5132
    */
5133
    iterator insert(const_iterator pos, size_type cnt, const basic_json& val)
N
Niels 已提交
5134 5135
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5136
        if (is_array())
N
Niels 已提交
5137
        {
N
cleanup  
Niels 已提交
5138 5139 5140 5141 5142
            // 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 已提交
5143

N
cleanup  
Niels 已提交
5144 5145
            // insert to array and return iterator
            iterator result(this);
5146
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, cnt, val);
N
cleanup  
Niels 已提交
5147 5148 5149
            return result;
        }
        else
N
Niels 已提交
5150
        {
N
cleanup  
Niels 已提交
5151
            throw std::domain_error("cannot use insert() with " + type_name());
N
Niels 已提交
5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164
        }
    }

    /*!
    @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 已提交
5165 5166
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
N
Niels 已提交
5167 5168
    @throw std::domain_error if @a pos is not an iterator of *this; example:
    `"iterator does not fit current value"`
N
Niels 已提交
5169
    @throw std::domain_error if @a first and @a last do not belong to the same
N
Niels 已提交
5170
    JSON value; example: `"iterators do not fit"`
N
Niels 已提交
5171
    @throw std::domain_error if @a first or @a last are iterators into
N
Niels 已提交
5172 5173 5174
    container for which insert is called; example: `"passed iterators may not
    belong to container"`

N
Niels 已提交
5175 5176 5177 5178 5179 5180
    @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 已提交
5181
    @liveexample{The example shows how `insert()` is used.,insert__range}
N
Niels 已提交
5182

N
Niels 已提交
5183
    @since version 1.0.0
N
Niels 已提交
5184 5185 5186 5187
    */
    iterator insert(const_iterator pos, const_iterator first, const_iterator last)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5188
        if (not is_array())
N
Niels 已提交
5189 5190 5191 5192 5193 5194 5195 5196 5197 5198
        {
            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 已提交
5199
        // check if range iterators belong to the same JSON object
N
Niels 已提交
5200 5201
        if (first.m_object != last.m_object)
        {
N
Niels 已提交
5202
            throw std::domain_error("iterators do not fit");
N
Niels 已提交
5203 5204 5205 5206 5207 5208 5209 5210 5211
        }

        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 已提交
5212 5213 5214 5215
        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 已提交
5216 5217 5218
        return result;
    }

N
Niels 已提交
5219 5220 5221 5222 5223 5224 5225 5226 5227
    /*!
    @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 已提交
5228 5229
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
N
Niels 已提交
5230 5231
    @throw std::domain_error if @a pos is not an iterator of *this; example:
    `"iterator does not fit current value"`
N
Niels 已提交
5232

N
Niels 已提交
5233 5234 5235
    @return iterator pointing to the first element inserted, or @a pos if
    `ilist` is empty

N
Niels 已提交
5236 5237
    @complexity Linear in `ilist.size()` plus linear in the distance between
    @a pos and end of the container.
N
Niels 已提交
5238

N
Niels 已提交
5239
    @liveexample{The example shows how `insert()` is used.,insert__ilist}
N
Niels 已提交
5240

N
Niels 已提交
5241
    @since version 1.0.0
N
Niels 已提交
5242 5243 5244 5245
    */
    iterator insert(const_iterator pos, std::initializer_list<basic_json> ilist)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5246
        if (not is_array())
N
Niels 已提交
5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262
        {
            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 已提交
5263 5264
    /*!
    @brief exchanges the values
N
Niels 已提交
5265 5266 5267 5268 5269 5270 5271 5272 5273 5274

    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 已提交
5275 5276
    @liveexample{The example below shows how JSON values can be swapped with
    `swap()`.,swap__reference}
N
Niels 已提交
5277

N
Niels 已提交
5278
    @since version 1.0.0
N
Niels 已提交
5279
    */
N
Niels 已提交
5280
    void swap(reference other) noexcept (
N
Niels 已提交
5281 5282 5283 5284 5285
        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
Niels 已提交
5286 5287 5288
    {
        std::swap(m_type, other.m_type);
        std::swap(m_value, other.m_value);
5289
        assert_invariant();
N
Niels 已提交
5290 5291
    }

N
Niels 已提交
5292 5293 5294 5295 5296 5297 5298 5299 5300 5301
    /*!
    @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 已提交
5302 5303
    @throw std::domain_error when JSON value is not an array; example: `"cannot
    use swap() with string"`
N
Niels 已提交
5304 5305 5306

    @complexity Constant.

N
Niels 已提交
5307 5308
    @liveexample{The example below shows how arrays can be swapped with
    `swap()`.,swap__array_t}
N
Niels 已提交
5309

N
Niels 已提交
5310
    @since version 1.0.0
N
Niels 已提交
5311
    */
N
Niels 已提交
5312
    void swap(array_t& other)
N
Niels 已提交
5313 5314
    {
        // swap only works for arrays
N
cleanup  
Niels 已提交
5315 5316 5317 5318 5319
        if (is_array())
        {
            std::swap(*(m_value.array), other);
        }
        else
N
Niels 已提交
5320
        {
N
Niels 已提交
5321
            throw std::domain_error("cannot use swap() with " + type_name());
N
Niels 已提交
5322 5323 5324
        }
    }

5325 5326 5327 5328 5329 5330 5331 5332 5333 5334
    /*!
    @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 已提交
5335 5336
    @throw std::domain_error when JSON value is not an object; example:
    `"cannot use swap() with string"`
5337 5338 5339

    @complexity Constant.

N
Niels 已提交
5340 5341
    @liveexample{The example below shows how objects can be swapped with
    `swap()`.,swap__object_t}
N
Niels 已提交
5342

N
Niels 已提交
5343
    @since version 1.0.0
5344
    */
N
Niels 已提交
5345
    void swap(object_t& other)
N
Niels 已提交
5346 5347
    {
        // swap only works for objects
N
cleanup  
Niels 已提交
5348 5349 5350 5351 5352
        if (is_object())
        {
            std::swap(*(m_value.object), other);
        }
        else
N
Niels 已提交
5353
        {
N
Niels 已提交
5354
            throw std::domain_error("cannot use swap() with " + type_name());
N
Niels 已提交
5355 5356 5357
        }
    }

5358 5359 5360 5361 5362 5363 5364 5365 5366 5367
    /*!
    @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 已提交
5368 5369
    @throw std::domain_error when JSON value is not a string; example: `"cannot
    use swap() with boolean"`
5370 5371 5372

    @complexity Constant.

N
Niels 已提交
5373 5374
    @liveexample{The example below shows how strings can be swapped with
    `swap()`.,swap__string_t}
N
Niels 已提交
5375

N
Niels 已提交
5376
    @since version 1.0.0
5377
    */
N
Niels 已提交
5378
    void swap(string_t& other)
N
Niels 已提交
5379 5380
    {
        // swap only works for strings
N
cleanup  
Niels 已提交
5381 5382 5383 5384 5385
        if (is_string())
        {
            std::swap(*(m_value.string), other);
        }
        else
N
Niels 已提交
5386
        {
N
Niels 已提交
5387
            throw std::domain_error("cannot use swap() with " + type_name());
N
Niels 已提交
5388 5389 5390
        }
    }

N
Niels 已提交
5391 5392
    /// @}

N
Niels 已提交
5393 5394 5395 5396 5397

    //////////////////////////////////////////
    // lexicographical comparison operators //
    //////////////////////////////////////////

N
Niels 已提交
5398 5399 5400
    /// @name lexicographical comparison operators
    /// @{

N
Niels 已提交
5401 5402 5403 5404 5405 5406 5407
  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 已提交
5408

N
Niels 已提交
5409
    @since version 1.0.0
N
Niels 已提交
5410
    */
N
Niels 已提交
5411
    friend bool operator<(const value_t lhs, const value_t rhs) noexcept
N
Niels 已提交
5412
    {
5413
        static constexpr std::array<uint8_t, 8> order = {{
N
Niels 已提交
5414 5415 5416 5417 5418 5419
                0, // null
                3, // object
                4, // array
                5, // string
                1, // boolean
                2, // integer
5420 5421
                2, // unsigned
                2, // float
N
Niels 已提交
5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434
            }
        };

        // 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 已提交
5435 5436
    /*!
    @brief comparison: equal
N
Niels 已提交
5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452

    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.

5453 5454
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__equal}
N
Niels 已提交
5455

N
Niels 已提交
5456
    @since version 1.0.0
N
Niels 已提交
5457
    */
N
Niels 已提交
5458
    friend bool operator==(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
5459
    {
F
Florian Weber 已提交
5460 5461
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
5462

F
Florian Weber 已提交
5463
        if (lhs_type == rhs_type)
N
Niels 已提交
5464
        {
F
Florian Weber 已提交
5465
            switch (lhs_type)
N
Niels 已提交
5466
            {
5467
                case value_t::array:
N
Niels 已提交
5468
                {
N
Niels 已提交
5469
                    return *lhs.m_value.array == *rhs.m_value.array;
N
Niels 已提交
5470
                }
5471
                case value_t::object:
N
Niels 已提交
5472
                {
N
Niels 已提交
5473
                    return *lhs.m_value.object == *rhs.m_value.object;
N
Niels 已提交
5474
                }
5475
                case value_t::null:
N
Niels 已提交
5476
                {
N
Niels 已提交
5477
                    return true;
N
Niels 已提交
5478
                }
5479
                case value_t::string:
N
Niels 已提交
5480
                {
N
Niels 已提交
5481
                    return *lhs.m_value.string == *rhs.m_value.string;
N
Niels 已提交
5482
                }
5483
                case value_t::boolean:
N
Niels 已提交
5484
                {
N
Niels 已提交
5485
                    return lhs.m_value.boolean == rhs.m_value.boolean;
N
Niels 已提交
5486
                }
5487
                case value_t::number_integer:
N
Niels 已提交
5488
                {
N
Niels 已提交
5489
                    return lhs.m_value.number_integer == rhs.m_value.number_integer;
N
Niels 已提交
5490
                }
5491 5492 5493 5494
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned == rhs.m_value.number_unsigned;
                }
5495
                case value_t::number_float:
N
Niels 已提交
5496
                {
5497
                    return lhs.m_value.number_float == rhs.m_value.number_float;
N
Niels 已提交
5498
                }
5499
                default:
N
Niels 已提交
5500
                {
N
Niels 已提交
5501
                    return false;
N
Niels 已提交
5502
                }
N
Niels 已提交
5503 5504
            }
        }
F
Florian Weber 已提交
5505 5506
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
N
Niels 已提交
5507
            return static_cast<number_float_t>(lhs.m_value.number_integer) == rhs.m_value.number_float;
F
Florian Weber 已提交
5508 5509 5510
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
5511
            return lhs.m_value.number_float == static_cast<number_float_t>(rhs.m_value.number_integer);
F
Florian Weber 已提交
5512
        }
5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527
        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_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);
F
Florian Weber 已提交
5528
        }
5529

N
Niels 已提交
5530 5531 5532
        return false;
    }

N
Niels 已提交
5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547
    /*!
    @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 已提交
5548

N
Niels 已提交
5549
    @since version 1.0.0
N
Niels 已提交
5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564
    */
    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 已提交
5565 5566
    /*!
    @brief comparison: not equal
N
Niels 已提交
5567 5568 5569 5570 5571 5572 5573 5574 5575

    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.

5576 5577
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__notequal}
N
Niels 已提交
5578

N
Niels 已提交
5579
    @since version 1.0.0
N
Niels 已提交
5580
    */
N
Niels 已提交
5581
    friend bool operator!=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
5582 5583 5584 5585
    {
        return not (lhs == rhs);
    }

N
Niels 已提交
5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600
    /*!
    @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 已提交
5601

N
Niels 已提交
5602
    @since version 1.0.0
N
Niels 已提交
5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617
    */
    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 已提交
5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636
    /*!
    @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.

5637 5638
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__less}
N
Niels 已提交
5639

N
Niels 已提交
5640
    @since version 1.0.0
N
Niels 已提交
5641
    */
N
Niels 已提交
5642
    friend bool operator<(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
5643
    {
F
Florian Weber 已提交
5644 5645
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
5646

F
Florian Weber 已提交
5647
        if (lhs_type == rhs_type)
N
Niels 已提交
5648
        {
F
Florian Weber 已提交
5649
            switch (lhs_type)
N
Niels 已提交
5650
            {
5651
                case value_t::array:
N
Niels 已提交
5652
                {
N
Niels 已提交
5653
                    return *lhs.m_value.array < *rhs.m_value.array;
N
Niels 已提交
5654
                }
5655
                case value_t::object:
N
Niels 已提交
5656
                {
N
Niels 已提交
5657
                    return *lhs.m_value.object < *rhs.m_value.object;
N
Niels 已提交
5658
                }
5659
                case value_t::null:
N
Niels 已提交
5660
                {
N
Niels 已提交
5661
                    return false;
N
Niels 已提交
5662
                }
5663
                case value_t::string:
N
Niels 已提交
5664
                {
N
Niels 已提交
5665
                    return *lhs.m_value.string < *rhs.m_value.string;
N
Niels 已提交
5666
                }
5667
                case value_t::boolean:
N
Niels 已提交
5668
                {
N
Niels 已提交
5669
                    return lhs.m_value.boolean < rhs.m_value.boolean;
N
Niels 已提交
5670
                }
5671
                case value_t::number_integer:
N
Niels 已提交
5672
                {
N
Niels 已提交
5673
                    return lhs.m_value.number_integer < rhs.m_value.number_integer;
N
Niels 已提交
5674
                }
5675 5676 5677 5678
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned < rhs.m_value.number_unsigned;
                }
5679
                case value_t::number_float:
N
Niels 已提交
5680
                {
N
Niels 已提交
5681
                    return lhs.m_value.number_float < rhs.m_value.number_float;
N
Niels 已提交
5682
                }
5683
                default:
N
Niels 已提交
5684
                {
N
Niels 已提交
5685
                    return false;
N
Niels 已提交
5686
                }
N
Niels 已提交
5687 5688
            }
        }
F
Florian Weber 已提交
5689 5690
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
5691
            return static_cast<number_float_t>(lhs.m_value.number_integer) < rhs.m_value.number_float;
F
Florian Weber 已提交
5692 5693 5694
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711
            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 已提交
5712
        }
N
Niels 已提交
5713

N
Niels 已提交
5714
        // We only reach this line if we cannot compare values. In that case,
N
Niels 已提交
5715 5716 5717
        // we compare types. Note we have to call the operator explicitly,
        // because MSVC has problems otherwise.
        return operator<(lhs_type, rhs_type);
N
Niels 已提交
5718 5719
    }

N
Niels 已提交
5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731
    /*!
    @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.

5732 5733
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greater}
N
Niels 已提交
5734

N
Niels 已提交
5735
    @since version 1.0.0
N
Niels 已提交
5736
    */
N
Niels 已提交
5737
    friend bool operator<=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
5738 5739 5740 5741
    {
        return not (rhs < lhs);
    }

N
Niels 已提交
5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753
    /*!
    @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.

5754 5755
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__lessequal}
N
Niels 已提交
5756

N
Niels 已提交
5757
    @since version 1.0.0
N
Niels 已提交
5758
    */
N
Niels 已提交
5759
    friend bool operator>(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
5760 5761 5762 5763
    {
        return not (lhs <= rhs);
    }

N
Niels 已提交
5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775
    /*!
    @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.

5776 5777
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greaterequal}
N
Niels 已提交
5778

N
Niels 已提交
5779
    @since version 1.0.0
N
Niels 已提交
5780
    */
N
Niels 已提交
5781
    friend bool operator>=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
5782 5783 5784 5785
    {
        return not (lhs < rhs);
    }

N
Niels 已提交
5786 5787
    /// @}

N
Niels 已提交
5788 5789 5790 5791 5792

    ///////////////////
    // serialization //
    ///////////////////

N
Niels 已提交
5793 5794 5795
    /// @name serialization
    /// @{

N
Niels 已提交
5796 5797 5798 5799 5800 5801 5802 5803 5804 5805
    /*!
    @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)`.

5806 5807 5808 5809
    @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 已提交
5810 5811 5812 5813 5814 5815 5816
    @param[in,out] o  stream to serialize to
    @param[in] j  JSON value to serialize

    @return the stream @a o

    @complexity Linear.

N
Niels 已提交
5817 5818
    @liveexample{The example below shows the serialization with different
    parameters to `width` to adjust the indentation level.,operator_serialize}
N
Niels 已提交
5819

N
Niels 已提交
5820
    @since version 1.0.0
N
Niels 已提交
5821
    */
N
Niels 已提交
5822 5823
    friend std::ostream& operator<<(std::ostream& o, const basic_json& j)
    {
N
Niels 已提交
5824
        // read width member and use it as indentation parameter if nonzero
N
Niels 已提交
5825 5826
        const bool pretty_print = (o.width() > 0);
        const auto indentation = (pretty_print ? o.width() : 0);
N
Niels 已提交
5827

N
Niels 已提交
5828 5829
        // reset width to 0 for subsequent calls to this stream
        o.width(0);
5830

N
Niels 已提交
5831
        // fix locale problems
5832 5833 5834 5835 5836 5837 5838
        const auto old_locale = o.imbue(std::locale(std::locale(), new DecimalSeparator));
        // 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 已提交
5839
        const auto old_precision = o.precision(std::numeric_limits<double>::digits10);
N
Niels 已提交
5840 5841

        // do the actual serialization
N
Niels 已提交
5842
        j.dump(o, pretty_print, static_cast<unsigned int>(indentation));
N
Niels 已提交
5843

5844
        // reset locale and precision
N
Niels 已提交
5845
        o.imbue(old_locale);
N
Niels 已提交
5846
        o.precision(old_precision);
N
Niels 已提交
5847 5848 5849
        return o;
    }

N
Niels 已提交
5850 5851 5852 5853
    /*!
    @brief serialize to stream
    @copydoc operator<<(std::ostream&, const basic_json&)
    */
N
Niels 已提交
5854 5855
    friend std::ostream& operator>>(const basic_json& j, std::ostream& o)
    {
N
Niels 已提交
5856
        return o << j;
N
Niels 已提交
5857 5858
    }

N
Niels 已提交
5859 5860
    /// @}

N
Niels 已提交
5861 5862 5863 5864 5865

    /////////////////////
    // deserialization //
    /////////////////////

N
Niels 已提交
5866 5867 5868
    /// @name deserialization
    /// @{

N
Niels 已提交
5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933
    /*!
    @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);
    }

    /*!
    @brief deserialize from string literal

    @tparam CharT character/literal type with size of 1 byte
    @param[in] s  string literal 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)

    @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.
    @note String containers like `std::string` or @ref string_t can be parsed
          with @ref parse(const ContiguousContainer&, const parser_callback_t)

    @liveexample{The example below demonstrates the `parse()` function with
    and without callback function.,parse__string__parser_callback_t}

    @sa @ref parse(std::istream&, const parser_callback_t) for a version that
    reads from an input stream

    @since version 1.0.0 (originally for @ref string_t)
    */
    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 已提交
5934
                 sizeof(typename std::remove_pointer<CharPT>::type) == 1, int>::type = 0>
N
Niels 已提交
5935 5936 5937 5938 5939 5940
    static basic_json parse(const CharPT s,
                            const parser_callback_t cb = nullptr)
    {
        return parser(reinterpret_cast<const char*>(s), cb).parse();
    }

N
Niels 已提交
5941 5942 5943 5944
    /*!
    @brief deserialize from stream

    @param[in,out] i  stream to read a serialized JSON value from
N
Niels 已提交
5945 5946 5947
    @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 已提交
5948 5949 5950 5951 5952 5953 5954

    @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 已提交
5955 5956
    @note A UTF-8 byte order mark is silently ignored.

N
Niels 已提交
5957 5958
    @liveexample{The example below demonstrates the `parse()` function with
    and without callback function.,parse__istream__parser_callback_t}
N
Niels 已提交
5959

N
Niels 已提交
5960
    @sa @ref parse(const char*, const parser_callback_t) for a version
N
Niels 已提交
5961
    that reads from a string
N
Niels 已提交
5962

N
Niels 已提交
5963
    @since version 1.0.0
N
Niels 已提交
5964
    */
N
Niels 已提交
5965 5966
    static basic_json parse(std::istream& i,
                            const parser_callback_t cb = nullptr)
N
Niels 已提交
5967
    {
N
Niels 已提交
5968
        return parser(i, cb).parse();
N
Niels 已提交
5969 5970
    }

N
Niels 已提交
5971
    /*!
N
Niels 已提交
5972
    @copydoc parse(std::istream&, const parser_callback_t)
N
Niels 已提交
5973
    */
N
Niels 已提交
5974 5975
    static basic_json parse(std::istream&& i,
                            const parser_callback_t cb = nullptr)
N
Cleanup  
Niels 已提交
5976 5977 5978 5979
    {
        return parser(i, cb).parse();
    }

5980
    /*!
N
Niels 已提交
5981
    @brief deserialize from an iterator range with contiguous storage
5982

5983 5984
    This function reads from an iterator range of a container with contiguous
    storage of 1-byte values. Compatible container types include
5985 5986 5987 5988 5989 5990 5991 5992 5993
    `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
5994
    with a static assertion.**
5995

N
Niels 已提交
5996 5997 5998 5999
    @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.
6000

N
Niels 已提交
6001
    @tparam IteratorType iterator of container with contiguous storage
N
Niels 已提交
6002 6003 6004
    @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
6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015
    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 已提交
6016 6017
    @liveexample{The example below demonstrates the `parse()` function reading
    from an iterator range.,parse__iteratortype__parser_callback_t}
6018 6019 6020

    @since version 2.0.3
    */
N
Niels 已提交
6021 6022 6023 6024
    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>
6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037
    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
6038 6039
        static_assert(sizeof(typename std::iterator_traits<IteratorType>::value_type) == 1,
                      "each element in the iterator range must have the size of 1 byte");
6040

6041 6042 6043 6044 6045 6046
        // 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();
        }
6047 6048 6049 6050

        return parser(first, last, cb).parse();
    }

N
Niels 已提交
6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071
    /*!
    @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 已提交
6072
    @tparam ContiguousContainer container type with contiguous storage
N
Niels 已提交
6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090
    @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 已提交
6091
    template<class ContiguousContainer, typename std::enable_if<
N
Niels 已提交
6092
                 not std::is_pointer<ContiguousContainer>::value and
6093 6094
                 std::is_base_of<
                     std::random_access_iterator_tag,
N
Niels 已提交
6095
                     typename std::iterator_traits<decltype(std::begin(std::declval<ContiguousContainer const>()))>::iterator_category>::value
6096 6097 6098 6099 6100 6101 6102 6103
                 , 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 已提交
6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116
    /*!
    @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 已提交
6117 6118
    @note A UTF-8 byte order mark is silently ignored.

N
Niels 已提交
6119 6120 6121
    @liveexample{The example below shows how a JSON value is constructed by
    reading a serialization from a stream.,operator_deserialize}

N
Niels 已提交
6122 6123
    @sa parse(std::istream&, const parser_callback_t) for a variant with a
    parser callback function to filter values while parsing
N
Niels 已提交
6124

N
Niels 已提交
6125
    @since version 1.0.0
N
Niels 已提交
6126 6127
    */
    friend std::istream& operator<<(basic_json& j, std::istream& i)
N
Niels 已提交
6128 6129 6130 6131 6132
    {
        j = parser(i).parse();
        return i;
    }

N
Niels 已提交
6133 6134 6135 6136 6137
    /*!
    @brief deserialize from stream
    @copydoc operator<<(basic_json&, std::istream&)
    */
    friend std::istream& operator>>(std::istream& i, basic_json& j)
N
Niels 已提交
6138 6139 6140 6141 6142
    {
        j = parser(i).parse();
        return i;
    }

N
Niels 已提交
6143 6144
    /// @}

N
Niels 已提交
6145 6146 6147 6148 6149 6150

  private:
    ///////////////////////////
    // convenience functions //
    ///////////////////////////

N
Niels 已提交
6151 6152 6153 6154 6155 6156
    /*!
    @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 已提交
6157
    @return basically a string representation of a the @a m_type member
N
Niels 已提交
6158 6159 6160 6161 6162

    @complexity Constant.

    @since version 1.0.0
    */
N
Niels 已提交
6163
    std::string type_name() const
N
Niels 已提交
6164 6165 6166
    {
        switch (m_type)
        {
6167
            case value_t::null:
N
Niels 已提交
6168
                return "null";
6169
            case value_t::object:
N
Niels 已提交
6170
                return "object";
6171
            case value_t::array:
N
Niels 已提交
6172
                return "array";
6173
            case value_t::string:
N
Niels 已提交
6174
                return "string";
6175
            case value_t::boolean:
N
Niels 已提交
6176
                return "boolean";
6177
            case value_t::discarded:
N
Niels 已提交
6178
                return "discarded";
N
Niels 已提交
6179
            default:
N
Niels 已提交
6180 6181 6182 6183
                return "number";
        }
    }

N
Niels 已提交
6184 6185 6186 6187 6188 6189 6190 6191 6192 6193
    /*!
    @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 已提交
6194 6195
        return std::accumulate(s.begin(), s.end(), size_t{},
                               [](size_t res, typename string_t::value_type c)
N
Niels 已提交
6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207
        {
            switch (c)
            {
                case '"':
                case '\\':
                case '\b':
                case '\f':
                case '\n':
                case '\r':
                case '\t':
                {
                    // from c (1 byte) to \x (2 bytes)
N
Niels 已提交
6208
                    return res + 1;
N
Niels 已提交
6209 6210 6211 6212 6213 6214 6215
                }

                default:
                {
                    if (c >= 0x00 and c <= 0x1f)
                    {
                        // from c (1 byte) to \uxxxx (6 bytes)
N
Niels 已提交
6216 6217 6218 6219 6220
                        return res + 5;
                    }
                    else
                    {
                        return res;
N
Niels 已提交
6221 6222 6223
                    }
                }
            }
N
Niels 已提交
6224
        });
N
Niels 已提交
6225 6226
    }

N
Niels 已提交
6227 6228
    /*!
    @brief escape a string
N
Niels 已提交
6229

N
Niels 已提交
6230 6231
    Escape a string by replacing certain special characters by a sequence of
    an escape character (backslash) and another character and other control
N
Niels 已提交
6232 6233 6234
    characters by a sequence of "\u" followed by a four-digit hex
    representation.

N
Niels 已提交
6235
    @param[in] s  the string to escape
N
Niels 已提交
6236 6237 6238
    @return  the escaped string

    @complexity Linear in the length of string @a s.
N
Niels 已提交
6239
    */
N
Niels 已提交
6240
    static string_t escape_string(const string_t& s)
N
Niels 已提交
6241
    {
N
Niels 已提交
6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252
        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 已提交
6253 6254 6255 6256 6257 6258
        {
            switch (c)
            {
                // quotation mark (0x22)
                case '"':
                {
N
Niels 已提交
6259 6260
                    result[pos + 1] = '"';
                    pos += 2;
N
Niels 已提交
6261 6262
                    break;
                }
N
Niels 已提交
6263

N
Niels 已提交
6264 6265 6266
                // reverse solidus (0x5c)
                case '\\':
                {
N
Niels 已提交
6267 6268
                    // nothing to change
                    pos += 2;
N
Niels 已提交
6269 6270
                    break;
                }
N
Niels 已提交
6271

N
Niels 已提交
6272 6273 6274
                // backspace (0x08)
                case '\b':
                {
N
Niels 已提交
6275 6276
                    result[pos + 1] = 'b';
                    pos += 2;
N
Niels 已提交
6277 6278
                    break;
                }
N
Niels 已提交
6279

N
Niels 已提交
6280 6281 6282
                // formfeed (0x0c)
                case '\f':
                {
N
Niels 已提交
6283 6284
                    result[pos + 1] = 'f';
                    pos += 2;
N
Niels 已提交
6285 6286
                    break;
                }
N
Niels 已提交
6287

N
Niels 已提交
6288 6289 6290
                // newline (0x0a)
                case '\n':
                {
N
Niels 已提交
6291 6292
                    result[pos + 1] = 'n';
                    pos += 2;
N
Niels 已提交
6293 6294
                    break;
                }
N
Niels 已提交
6295

N
Niels 已提交
6296 6297 6298
                // carriage return (0x0d)
                case '\r':
                {
N
Niels 已提交
6299 6300
                    result[pos + 1] = 'r';
                    pos += 2;
N
Niels 已提交
6301 6302
                    break;
                }
N
Niels 已提交
6303

N
Niels 已提交
6304 6305 6306
                // horizontal tab (0x09)
                case '\t':
                {
N
Niels 已提交
6307 6308
                    result[pos + 1] = 't';
                    pos += 2;
N
Niels 已提交
6309 6310 6311 6312 6313
                    break;
                }

                default:
                {
6314
                    if (c >= 0x00 and c <= 0x1f)
N
Niels 已提交
6315
                    {
N
Niels 已提交
6316 6317
                        // convert a number 0..15 to its hex representation
                        // (0..f)
N
Niels 已提交
6318
                        static const char hexify[16] =
6319
                        {
N
Niels 已提交
6320 6321
                            '0', '1', '2', '3', '4', '5', '6', '7',
                            '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'
6322 6323
                        };

N
Niels 已提交
6324
                        // print character c as \uxxxx
N
Niels 已提交
6325
                        for (const char m :
N
Niels 已提交
6326
                    { 'u', '0', '0', hexify[c >> 4], hexify[c & 0x0f]
N
Niels 已提交
6327
                        })
6328 6329 6330 6331 6332
                        {
                            result[++pos] = m;
                        }

                        ++pos;
N
Niels 已提交
6333 6334 6335 6336
                    }
                    else
                    {
                        // all other characters are added as-is
N
Niels 已提交
6337
                        result[pos++] = c;
N
Niels 已提交
6338 6339 6340 6341 6342
                    }
                    break;
                }
            }
        }
N
Niels 已提交
6343 6344

        return result;
N
Niels 已提交
6345 6346 6347 6348
    }

    /*!
    @brief internal implementation of the serialization function
N
Niels 已提交
6349

N
Niels 已提交
6350
    This function is called by the public member function dump and organizes
N
Niels 已提交
6351
    the serialization internally. The indentation level is propagated as
N
Niels 已提交
6352 6353
    additional parameter. In case of arrays and objects, the function is
    called recursively. Note that
N
Niels 已提交
6354

N
Niels 已提交
6355 6356 6357
    - 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
Niels 已提交
6358

N
Niels 已提交
6359 6360 6361 6362
    @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
Niels 已提交
6363
    */
N
Niels 已提交
6364 6365 6366
    void dump(std::ostream& o,
              const bool pretty_print,
              const unsigned int indent_step,
N
Niels 已提交
6367
              const unsigned int current_indent = 0) const
N
Niels 已提交
6368
    {
N
Niels 已提交
6369
        // variable to hold indentation for recursive calls
N
Niels 已提交
6370
        unsigned int new_indent = current_indent;
N
Niels 已提交
6371

N
Niels 已提交
6372 6373
        switch (m_type)
        {
6374
            case value_t::object:
N
Niels 已提交
6375 6376 6377
            {
                if (m_value.object->empty())
                {
N
Niels 已提交
6378 6379
                    o << "{}";
                    return;
N
Niels 已提交
6380 6381
                }

N
Niels 已提交
6382
                o << "{";
N
Niels 已提交
6383 6384

                // increase indentation
N
Niels 已提交
6385
                if (pretty_print)
N
Niels 已提交
6386
                {
N
Niels 已提交
6387
                    new_indent += indent_step;
N
Niels 已提交
6388
                    o << "\n";
N
Niels 已提交
6389 6390 6391 6392 6393 6394
                }

                for (auto i = m_value.object->cbegin(); i != m_value.object->cend(); ++i)
                {
                    if (i != m_value.object->cbegin())
                    {
N
Niels 已提交
6395
                        o << (pretty_print ? ",\n" : ",");
N
Niels 已提交
6396
                    }
N
Niels 已提交
6397 6398 6399
                    o << string_t(new_indent, ' ') << "\""
                      << escape_string(i->first) << "\":"
                      << (pretty_print ? " " : "");
N
Niels 已提交
6400
                    i->second.dump(o, pretty_print, indent_step, new_indent);
N
Niels 已提交
6401 6402 6403
                }

                // decrease indentation
N
Niels 已提交
6404
                if (pretty_print)
N
Niels 已提交
6405
                {
N
Niels 已提交
6406
                    new_indent -= indent_step;
N
Niels 已提交
6407
                    o << "\n";
N
Niels 已提交
6408 6409
                }

N
Niels 已提交
6410 6411
                o << string_t(new_indent, ' ') + "}";
                return;
N
Niels 已提交
6412 6413
            }

6414
            case value_t::array:
N
Niels 已提交
6415 6416 6417
            {
                if (m_value.array->empty())
                {
N
Niels 已提交
6418 6419
                    o << "[]";
                    return;
N
Niels 已提交
6420 6421
                }

N
Niels 已提交
6422
                o << "[";
N
Niels 已提交
6423 6424

                // increase indentation
N
Niels 已提交
6425
                if (pretty_print)
N
Niels 已提交
6426
                {
N
Niels 已提交
6427
                    new_indent += indent_step;
N
Niels 已提交
6428
                    o << "\n";
N
Niels 已提交
6429 6430 6431 6432 6433 6434
                }

                for (auto i = m_value.array->cbegin(); i != m_value.array->cend(); ++i)
                {
                    if (i != m_value.array->cbegin())
                    {
N
Niels 已提交
6435
                        o << (pretty_print ? ",\n" : ",");
N
Niels 已提交
6436
                    }
N
Niels 已提交
6437
                    o << string_t(new_indent, ' ');
N
Niels 已提交
6438
                    i->dump(o, pretty_print, indent_step, new_indent);
N
Niels 已提交
6439 6440 6441
                }

                // decrease indentation
N
Niels 已提交
6442
                if (pretty_print)
N
Niels 已提交
6443
                {
N
Niels 已提交
6444
                    new_indent -= indent_step;
N
Niels 已提交
6445
                    o << "\n";
N
Niels 已提交
6446 6447
                }

N
Niels 已提交
6448 6449
                o << string_t(new_indent, ' ') << "]";
                return;
N
Niels 已提交
6450 6451
            }

6452
            case value_t::string:
N
Niels 已提交
6453
            {
N
Niels 已提交
6454
                o << string_t("\"") << escape_string(*m_value.string) << "\"";
N
Niels 已提交
6455
                return;
N
Niels 已提交
6456 6457
            }

6458
            case value_t::boolean:
N
Niels 已提交
6459
            {
N
Niels 已提交
6460 6461
                o << (m_value.boolean ? "true" : "false");
                return;
N
Niels 已提交
6462 6463
            }

6464
            case value_t::number_integer:
N
Niels 已提交
6465
            {
N
Niels 已提交
6466 6467
                o << m_value.number_integer;
                return;
N
Niels 已提交
6468 6469
            }

6470 6471 6472 6473 6474 6475
            case value_t::number_unsigned:
            {
                o << m_value.number_unsigned;
                return;
            }

6476
            case value_t::number_float:
N
Niels 已提交
6477
            {
N
Niels 已提交
6478
                if (m_value.number_float == 0)
N
Niels 已提交
6479
                {
N
Niels 已提交
6480 6481
                    // special case for zero to get "0.0"/"-0.0"
                    o << (std::signbit(m_value.number_float) ? "-0.0" : "0.0");
N
Niels 已提交
6482
                }
N
Niels 已提交
6483
                else
N
Niels 已提交
6484
                {
6485
                    o << m_value.number_float;
N
Niels 已提交
6486
                }
N
Niels 已提交
6487
                return;
N
Niels 已提交
6488
            }
N
Niels 已提交
6489

6490
            case value_t::discarded:
N
Niels 已提交
6491
            {
N
Niels 已提交
6492 6493
                o << "<discarded>";
                return;
N
Niels 已提交
6494
            }
N
Niels 已提交
6495

6496
            case value_t::null:
N
Niels 已提交
6497
            {
N
Niels 已提交
6498 6499
                o << "null";
                return;
N
Niels 已提交
6500
            }
N
Niels 已提交
6501 6502 6503 6504 6505 6506 6507 6508 6509
        }
    }

  private:
    //////////////////////
    // member variables //
    //////////////////////

    /// the type of the current element
N
Niels 已提交
6510
    value_t m_type = value_t::null;
N
Niels 已提交
6511 6512 6513 6514

    /// the value of the current element
    json_value m_value = {};

N
Niels 已提交
6515

N
Niels 已提交
6516
  private:
N
Niels 已提交
6517 6518 6519 6520
    ///////////////
    // iterators //
    ///////////////

6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533
    /*!
    @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 已提交
6534
        void set_begin() noexcept
6535 6536 6537 6538 6539
        {
            m_it = begin_value;
        }

        /// set iterator to a defined past the end
N
Niels 已提交
6540
        void set_end() noexcept
6541 6542 6543 6544 6545
        {
            m_it = end_value;
        }

        /// return whether the iterator can be dereferenced
N
Niels 已提交
6546
        constexpr bool is_begin() const noexcept
6547 6548 6549 6550 6551
        {
            return (m_it == begin_value);
        }

        /// return whether the iterator is at end
N
Niels 已提交
6552
        constexpr bool is_end() const noexcept
6553 6554 6555 6556 6557
        {
            return (m_it == end_value);
        }

        /// return reference to the value to change and compare
N
Niels 已提交
6558
        operator difference_type& () noexcept
6559 6560 6561 6562 6563
        {
            return m_it;
        }

        /// return value to compare
N
Niels 已提交
6564
        constexpr operator difference_type () const noexcept
6565 6566 6567 6568 6569 6570 6571 6572 6573
        {
            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 已提交
6574
        difference_type m_it = std::numeric_limits<std::ptrdiff_t>::denorm_min();
6575 6576
    };

N
Niels 已提交
6577 6578 6579 6580 6581 6582 6583 6584
    /*!
    @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 已提交
6585 6586
    {
        /// iterator for JSON objects
N
Niels 已提交
6587
        typename object_t::iterator object_iterator;
N
Niels 已提交
6588
        /// iterator for JSON arrays
N
Niels 已提交
6589
        typename array_t::iterator array_iterator;
N
Niels 已提交
6590
        /// generic iterator for all other types
N
Niels 已提交
6591 6592 6593
        primitive_iterator_t primitive_iterator;

        /// create an uninitialized internal_iterator
N
Niels 已提交
6594
        internal_iterator() noexcept
N
Niels 已提交
6595 6596
            : object_iterator(), array_iterator(), primitive_iterator()
        {}
N
Niels 已提交
6597 6598
    };

N
cleanup  
Niels 已提交
6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613
    /// 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 已提交
6614
            explicit iteration_proxy_internal(IteratorType it) noexcept
N
cleanup  
Niels 已提交
6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633
                : 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 已提交
6634
            bool operator!= (const iteration_proxy_internal& o) const
N
cleanup  
Niels 已提交
6635 6636 6637 6638 6639 6640 6641
            {
                return anchor != o.anchor;
            }

            /// return key of the iterator
            typename basic_json::string_t key() const
            {
N
Niels 已提交
6642 6643
                assert(anchor.m_object != nullptr);

N
cleanup  
Niels 已提交
6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677
                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 已提交
6678
        explicit iteration_proxy(typename IteratorType::reference cont)
N
cleanup  
Niels 已提交
6679 6680 6681 6682
            : container(cont)
        {}

        /// return iterator begin (needed for range-based for)
N
Niels 已提交
6683
        iteration_proxy_internal begin() noexcept
N
cleanup  
Niels 已提交
6684 6685 6686 6687 6688
        {
            return iteration_proxy_internal(container.begin());
        }

        /// return iterator end (needed for range-based for)
N
Niels 已提交
6689
        iteration_proxy_internal end() noexcept
N
cleanup  
Niels 已提交
6690 6691 6692 6693 6694
        {
            return iteration_proxy_internal(container.end());
        }
    };

N
Niels 已提交
6695
  public:
N
Niels 已提交
6696 6697 6698 6699 6700 6701
    /*!
    @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 已提交
6702 6703 6704
    @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 已提交
6705 6706
          methods are undefined. **The library uses assertions to detect calls
          on uninitialized iterators.**
N
Niels 已提交
6707

N
Niels 已提交
6708 6709 6710 6711
    @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 已提交
6712

N
Niels 已提交
6713
    @since version 1.0.0
N
Niels 已提交
6714
    */
N
Niels 已提交
6715
    class const_iterator : public std::iterator<std::random_access_iterator_tag, const basic_json>
N
Niels 已提交
6716
    {
N
Niels 已提交
6717
        /// allow basic_json to access private members
6718 6719
        friend class basic_json;

N
Niels 已提交
6720 6721
      public:
        /// the type of the values when the iterator is dereferenced
N
Niels 已提交
6722
        using value_type = typename basic_json::value_type;
N
Niels 已提交
6723
        /// a type to represent differences between iterators
N
Niels 已提交
6724
        using difference_type = typename basic_json::difference_type;
N
Niels 已提交
6725
        /// defines a pointer to the type iterated over (value_type)
N
Niels 已提交
6726
        using pointer = typename basic_json::const_pointer;
N
Niels 已提交
6727
        /// defines a reference to the type iterated over (value_type)
N
Niels 已提交
6728
        using reference = typename basic_json::const_reference;
N
Niels 已提交
6729
        /// the category of the iterator
N
Niels 已提交
6730
        using iterator_category = std::bidirectional_iterator_tag;
N
Niels 已提交
6731

6732
        /// default constructor
N
Niels 已提交
6733
        const_iterator() = default;
6734

N
Niels 已提交
6735 6736 6737 6738 6739 6740
        /*!
        @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 已提交
6741 6742
        explicit const_iterator(pointer object) noexcept
            : m_object(object)
N
Niels 已提交
6743
        {
N
Niels 已提交
6744 6745
            assert(m_object != nullptr);

N
Niels 已提交
6746 6747
            switch (m_object->m_type)
            {
6748
                case basic_json::value_t::object:
N
Niels 已提交
6749 6750 6751 6752
                {
                    m_it.object_iterator = typename object_t::iterator();
                    break;
                }
6753 6754

                case basic_json::value_t::array:
N
Niels 已提交
6755 6756 6757 6758
                {
                    m_it.array_iterator = typename array_t::iterator();
                    break;
                }
6759

N
Niels 已提交
6760 6761
                default:
                {
6762
                    m_it.primitive_iterator = primitive_iterator_t();
N
Niels 已提交
6763 6764 6765 6766 6767
                    break;
                }
            }
        }

N
Niels 已提交
6768 6769 6770 6771 6772
        /*!
        @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 已提交
6773 6774
        explicit const_iterator(const iterator& other) noexcept
            : m_object(other.m_object)
N
Niels 已提交
6775
        {
N
Niels 已提交
6776
            if (m_object != nullptr)
N
Niels 已提交
6777
            {
N
Niels 已提交
6778
                switch (m_object->m_type)
N
Niels 已提交
6779
                {
N
Niels 已提交
6780 6781 6782 6783 6784
                    case basic_json::value_t::object:
                    {
                        m_it.object_iterator = other.m_it.object_iterator;
                        break;
                    }
N
Niels 已提交
6785

N
Niels 已提交
6786 6787 6788 6789 6790
                    case basic_json::value_t::array:
                    {
                        m_it.array_iterator = other.m_it.array_iterator;
                        break;
                    }
N
Niels 已提交
6791

N
Niels 已提交
6792 6793 6794 6795 6796
                    default:
                    {
                        m_it.primitive_iterator = other.m_it.primitive_iterator;
                        break;
                    }
N
Niels 已提交
6797 6798 6799 6800
                }
            }
        }

N
Niels 已提交
6801 6802 6803 6804 6805
        /*!
        @brief copy constructor
        @param[in] other  iterator to copy from
        @note It is not checked whether @a other is initialized.
        */
N
Niels 已提交
6806
        const_iterator(const const_iterator& other) noexcept
N
Niels 已提交
6807 6808 6809
            : m_object(other.m_object), m_it(other.m_it)
        {}

N
Niels 已提交
6810 6811 6812 6813 6814
        /*!
        @brief copy assignment
        @param[in,out] other  iterator to copy from
        @note It is not checked whether @a other is initialized.
        */
N
Niels 已提交
6815
        const_iterator& operator=(const_iterator other) noexcept(
N
Niels 已提交
6816 6817
            std::is_nothrow_move_constructible<pointer>::value and
            std::is_nothrow_move_assignable<pointer>::value and
N
Niels 已提交
6818 6819
            std::is_nothrow_move_constructible<internal_iterator>::value and
            std::is_nothrow_move_assignable<internal_iterator>::value
N
Niels 已提交
6820 6821 6822 6823
        )
        {
            std::swap(m_object, other.m_object);
            std::swap(m_it, other.m_it);
N
Niels 已提交
6824 6825 6826
            return *this;
        }

N
Niels 已提交
6827
      private:
N
Niels 已提交
6828 6829 6830 6831
        /*!
        @brief set the iterator to the first value
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
6832
        void set_begin() noexcept
N
Niels 已提交
6833
        {
N
Niels 已提交
6834 6835
            assert(m_object != nullptr);

N
Niels 已提交
6836 6837
            switch (m_object->m_type)
            {
6838
                case basic_json::value_t::object:
N
Niels 已提交
6839 6840 6841 6842 6843
                {
                    m_it.object_iterator = m_object->m_value.object->begin();
                    break;
                }

6844
                case basic_json::value_t::array:
N
Niels 已提交
6845 6846 6847 6848 6849
                {
                    m_it.array_iterator = m_object->m_value.array->begin();
                    break;
                }

6850
                case basic_json::value_t::null:
N
Niels 已提交
6851
                {
N
Niels 已提交
6852
                    // set to end so begin()==end() is true: null is empty
6853
                    m_it.primitive_iterator.set_end();
N
Niels 已提交
6854 6855 6856 6857 6858
                    break;
                }

                default:
                {
6859
                    m_it.primitive_iterator.set_begin();
N
Niels 已提交
6860 6861 6862 6863 6864
                    break;
                }
            }
        }

N
Niels 已提交
6865 6866 6867 6868
        /*!
        @brief set the iterator past the last value
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
6869
        void set_end() noexcept
N
Niels 已提交
6870
        {
N
Niels 已提交
6871 6872
            assert(m_object != nullptr);

N
Niels 已提交
6873 6874
            switch (m_object->m_type)
            {
6875
                case basic_json::value_t::object:
N
Niels 已提交
6876 6877 6878 6879 6880
                {
                    m_it.object_iterator = m_object->m_value.object->end();
                    break;
                }

6881
                case basic_json::value_t::array:
N
Niels 已提交
6882 6883 6884 6885 6886 6887 6888
                {
                    m_it.array_iterator = m_object->m_value.array->end();
                    break;
                }

                default:
                {
6889
                    m_it.primitive_iterator.set_end();
N
Niels 已提交
6890 6891 6892 6893 6894
                    break;
                }
            }
        }

N
Niels 已提交
6895
      public:
N
Niels 已提交
6896 6897 6898 6899
        /*!
        @brief return a reference to the value pointed to by the iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
6900
        reference operator*() const
N
Niels 已提交
6901
        {
N
Niels 已提交
6902 6903
            assert(m_object != nullptr);

N
Niels 已提交
6904 6905
            switch (m_object->m_type)
            {
6906
                case basic_json::value_t::object:
N
Niels 已提交
6907
                {
N
Niels 已提交
6908
                    assert(m_it.object_iterator != m_object->m_value.object->end());
N
Niels 已提交
6909 6910 6911
                    return m_it.object_iterator->second;
                }

6912
                case basic_json::value_t::array:
N
Niels 已提交
6913
                {
N
Niels 已提交
6914
                    assert(m_it.array_iterator != m_object->m_value.array->end());
N
Niels 已提交
6915 6916 6917
                    return *m_it.array_iterator;
                }

6918
                case basic_json::value_t::null:
N
Niels 已提交
6919 6920 6921 6922 6923 6924
                {
                    throw std::out_of_range("cannot get value");
                }

                default:
                {
6925
                    if (m_it.primitive_iterator.is_begin())
N
Niels 已提交
6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936
                    {
                        return *m_object;
                    }
                    else
                    {
                        throw std::out_of_range("cannot get value");
                    }
                }
            }
        }

N
Niels 已提交
6937 6938 6939 6940
        /*!
        @brief dereference the iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
6941
        pointer operator->() const
N
Niels 已提交
6942
        {
N
Niels 已提交
6943 6944
            assert(m_object != nullptr);

N
Niels 已提交
6945 6946
            switch (m_object->m_type)
            {
6947
                case basic_json::value_t::object:
N
Niels 已提交
6948
                {
N
Niels 已提交
6949
                    assert(m_it.object_iterator != m_object->m_value.object->end());
N
Niels 已提交
6950 6951 6952
                    return &(m_it.object_iterator->second);
                }

6953
                case basic_json::value_t::array:
N
Niels 已提交
6954
                {
N
Niels 已提交
6955
                    assert(m_it.array_iterator != m_object->m_value.array->end());
N
Niels 已提交
6956 6957 6958 6959 6960
                    return &*m_it.array_iterator;
                }

                default:
                {
6961
                    if (m_it.primitive_iterator.is_begin())
N
Niels 已提交
6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972
                    {
                        return m_object;
                    }
                    else
                    {
                        throw std::out_of_range("cannot get value");
                    }
                }
            }
        }

N
Niels 已提交
6973 6974 6975 6976
        /*!
        @brief post-increment (it++)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
6977
        const_iterator operator++(int)
N
Niels 已提交
6978
        {
N
Niels 已提交
6979
            auto result = *this;
N
Niels 已提交
6980
            ++(*this);
N
Niels 已提交
6981 6982 6983
            return result;
        }

N
Niels 已提交
6984 6985 6986 6987
        /*!
        @brief pre-increment (++it)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
6988
        const_iterator& operator++()
N
Niels 已提交
6989
        {
N
Niels 已提交
6990 6991
            assert(m_object != nullptr);

N
Niels 已提交
6992 6993
            switch (m_object->m_type)
            {
6994
                case basic_json::value_t::object:
N
Niels 已提交
6995
                {
N
Niels 已提交
6996
                    std::advance(m_it.object_iterator, 1);
N
Niels 已提交
6997 6998 6999
                    break;
                }

7000
                case basic_json::value_t::array:
N
Niels 已提交
7001
                {
N
Niels 已提交
7002
                    std::advance(m_it.array_iterator, 1);
N
Niels 已提交
7003 7004 7005 7006 7007
                    break;
                }

                default:
                {
7008
                    ++m_it.primitive_iterator;
N
Niels 已提交
7009 7010 7011 7012 7013 7014 7015
                    break;
                }
            }

            return *this;
        }

N
Niels 已提交
7016 7017 7018 7019
        /*!
        @brief post-decrement (it--)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7020
        const_iterator operator--(int)
N
Niels 已提交
7021
        {
N
Niels 已提交
7022
            auto result = *this;
N
Niels 已提交
7023
            --(*this);
N
Niels 已提交
7024 7025 7026
            return result;
        }

N
Niels 已提交
7027 7028 7029 7030
        /*!
        @brief pre-decrement (--it)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7031
        const_iterator& operator--()
N
Niels 已提交
7032
        {
N
Niels 已提交
7033 7034
            assert(m_object != nullptr);

N
Niels 已提交
7035 7036
            switch (m_object->m_type)
            {
7037
                case basic_json::value_t::object:
N
Niels 已提交
7038
                {
N
Niels 已提交
7039
                    std::advance(m_it.object_iterator, -1);
N
Niels 已提交
7040 7041 7042
                    break;
                }

7043
                case basic_json::value_t::array:
N
Niels 已提交
7044
                {
N
Niels 已提交
7045
                    std::advance(m_it.array_iterator, -1);
N
Niels 已提交
7046 7047 7048 7049 7050
                    break;
                }

                default:
                {
7051
                    --m_it.primitive_iterator;
N
Niels 已提交
7052 7053 7054 7055 7056 7057 7058
                    break;
                }
            }

            return *this;
        }

N
Niels 已提交
7059 7060 7061 7062
        /*!
        @brief  comparison: equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7063
        bool operator==(const const_iterator& other) const
N
Niels 已提交
7064
        {
N
Niels 已提交
7065 7066
            // if objects are not the same, the comparison is undefined
            if (m_object != other.m_object)
N
Niels 已提交
7067
            {
N
Niels 已提交
7068
                throw std::domain_error("cannot compare iterators of different containers");
N
Niels 已提交
7069 7070
            }

N
Niels 已提交
7071 7072
            assert(m_object != nullptr);

N
Niels 已提交
7073 7074
            switch (m_object->m_type)
            {
7075
                case basic_json::value_t::object:
N
Niels 已提交
7076 7077 7078 7079
                {
                    return (m_it.object_iterator == other.m_it.object_iterator);
                }

7080
                case basic_json::value_t::array:
N
Niels 已提交
7081 7082 7083 7084 7085 7086
                {
                    return (m_it.array_iterator == other.m_it.array_iterator);
                }

                default:
                {
7087
                    return (m_it.primitive_iterator == other.m_it.primitive_iterator);
N
Niels 已提交
7088 7089 7090 7091
                }
            }
        }

N
Niels 已提交
7092 7093 7094 7095
        /*!
        @brief  comparison: not equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7096
        bool operator!=(const const_iterator& other) const
N
Niels 已提交
7097 7098 7099 7100
        {
            return not operator==(other);
        }

N
Niels 已提交
7101 7102 7103 7104
        /*!
        @brief  comparison: smaller
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7105
        bool operator<(const const_iterator& other) const
N
Niels 已提交
7106 7107 7108 7109 7110 7111 7112
        {
            // 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 已提交
7113 7114
            assert(m_object != nullptr);

N
Niels 已提交
7115 7116
            switch (m_object->m_type)
            {
7117
                case basic_json::value_t::object:
N
Niels 已提交
7118
                {
N
Niels 已提交
7119
                    throw std::domain_error("cannot compare order of object iterators");
N
Niels 已提交
7120 7121
                }

7122
                case basic_json::value_t::array:
N
Niels 已提交
7123 7124 7125 7126 7127 7128
                {
                    return (m_it.array_iterator < other.m_it.array_iterator);
                }

                default:
                {
7129
                    return (m_it.primitive_iterator < other.m_it.primitive_iterator);
N
Niels 已提交
7130 7131 7132 7133
                }
            }
        }

N
Niels 已提交
7134 7135 7136 7137
        /*!
        @brief  comparison: less than or equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7138
        bool operator<=(const const_iterator& other) const
N
Niels 已提交
7139 7140 7141 7142
        {
            return not other.operator < (*this);
        }

N
Niels 已提交
7143 7144 7145 7146
        /*!
        @brief  comparison: greater than
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7147
        bool operator>(const const_iterator& other) const
N
Niels 已提交
7148 7149 7150 7151
        {
            return not operator<=(other);
        }

N
Niels 已提交
7152 7153 7154 7155
        /*!
        @brief  comparison: greater than or equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7156
        bool operator>=(const const_iterator& other) const
N
Niels 已提交
7157 7158 7159 7160
        {
            return not operator<(other);
        }

N
Niels 已提交
7161 7162 7163 7164
        /*!
        @brief  add to iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7165
        const_iterator& operator+=(difference_type i)
N
Niels 已提交
7166
        {
N
Niels 已提交
7167 7168
            assert(m_object != nullptr);

N
Niels 已提交
7169 7170
            switch (m_object->m_type)
            {
7171
                case basic_json::value_t::object:
N
Niels 已提交
7172
                {
N
Niels 已提交
7173
                    throw std::domain_error("cannot use offsets with object iterators");
N
Niels 已提交
7174 7175
                }

7176
                case basic_json::value_t::array:
N
Niels 已提交
7177
                {
N
Niels 已提交
7178
                    std::advance(m_it.array_iterator, i);
N
Niels 已提交
7179 7180 7181 7182 7183
                    break;
                }

                default:
                {
7184
                    m_it.primitive_iterator += i;
N
Niels 已提交
7185 7186 7187 7188 7189 7190 7191
                    break;
                }
            }

            return *this;
        }

N
Niels 已提交
7192 7193 7194 7195
        /*!
        @brief  subtract from iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7196
        const_iterator& operator-=(difference_type i)
N
Niels 已提交
7197 7198 7199 7200
        {
            return operator+=(-i);
        }

N
Niels 已提交
7201 7202 7203 7204
        /*!
        @brief  add to iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7205
        const_iterator operator+(difference_type i)
N
Niels 已提交
7206 7207 7208 7209 7210 7211
        {
            auto result = *this;
            result += i;
            return result;
        }

N
Niels 已提交
7212 7213 7214 7215
        /*!
        @brief  subtract from iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7216
        const_iterator operator-(difference_type i)
N
Niels 已提交
7217 7218 7219 7220 7221 7222
        {
            auto result = *this;
            result -= i;
            return result;
        }

N
Niels 已提交
7223 7224 7225 7226
        /*!
        @brief  return difference
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7227
        difference_type operator-(const const_iterator& other) const
N
Niels 已提交
7228
        {
N
Niels 已提交
7229 7230
            assert(m_object != nullptr);

N
Niels 已提交
7231 7232
            switch (m_object->m_type)
            {
7233
                case basic_json::value_t::object:
N
Niels 已提交
7234
                {
N
Niels 已提交
7235
                    throw std::domain_error("cannot use offsets with object iterators");
N
Niels 已提交
7236 7237
                }

7238
                case basic_json::value_t::array:
N
Niels 已提交
7239 7240 7241 7242 7243 7244
                {
                    return m_it.array_iterator - other.m_it.array_iterator;
                }

                default:
                {
7245
                    return m_it.primitive_iterator - other.m_it.primitive_iterator;
N
Niels 已提交
7246 7247 7248 7249
                }
            }
        }

N
Niels 已提交
7250 7251 7252 7253
        /*!
        @brief  access to successor
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7254
        reference operator[](difference_type n) const
N
Niels 已提交
7255
        {
N
Niels 已提交
7256 7257
            assert(m_object != nullptr);

N
Niels 已提交
7258 7259
            switch (m_object->m_type)
            {
7260
                case basic_json::value_t::object:
N
Niels 已提交
7261 7262 7263 7264
                {
                    throw std::domain_error("cannot use operator[] for object iterators");
                }

7265
                case basic_json::value_t::array:
N
Niels 已提交
7266
                {
N
Niels 已提交
7267
                    return *std::next(m_it.array_iterator, n);
N
Niels 已提交
7268 7269
                }

7270
                case basic_json::value_t::null:
N
Niels 已提交
7271 7272 7273 7274 7275 7276
                {
                    throw std::out_of_range("cannot get value");
                }

                default:
                {
7277
                    if (m_it.primitive_iterator == -n)
N
Niels 已提交
7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288
                    {
                        return *m_object;
                    }
                    else
                    {
                        throw std::out_of_range("cannot get value");
                    }
                }
            }
        }

N
Niels 已提交
7289 7290 7291 7292
        /*!
        @brief  return the key of an object iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7293
        typename object_t::key_type key() const
N
Niels 已提交
7294
        {
N
Niels 已提交
7295
            assert(m_object != nullptr);
N
Niels 已提交
7296

7297 7298 7299 7300 7301 7302 7303
            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 已提交
7304 7305 7306
            }
        }

N
Niels 已提交
7307 7308 7309 7310
        /*!
        @brief  return the value of an iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7311
        reference value() const
N
Niels 已提交
7312 7313 7314 7315
        {
            return operator*();
        }

N
Niels 已提交
7316 7317 7318 7319
      private:
        /// associated JSON instance
        pointer m_object = nullptr;
        /// the actual iterator of the associated instance
N
Niels 已提交
7320
        internal_iterator m_it = internal_iterator();
N
Niels 已提交
7321 7322
    };

N
Niels 已提交
7323 7324 7325 7326 7327 7328 7329 7330 7331
    /*!
    @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 已提交
7332

N
Niels 已提交
7333
    @since version 1.0.0
N
Niels 已提交
7334
    */
N
Niels 已提交
7335
    class iterator : public const_iterator
N
Niels 已提交
7336 7337
    {
      public:
N
Niels 已提交
7338 7339 7340
        using base_iterator = const_iterator;
        using pointer = typename basic_json::pointer;
        using reference = typename basic_json::reference;
N
Niels 已提交
7341

7342
        /// default constructor
N
Niels 已提交
7343
        iterator() = default;
7344

N
Niels 已提交
7345
        /// constructor for a given JSON instance
N
Niels 已提交
7346
        explicit iterator(pointer object) noexcept
N
cleanup  
Niels 已提交
7347
            : base_iterator(object)
N
Niels 已提交
7348
        {}
N
Niels 已提交
7349

N
Niels 已提交
7350
        /// copy constructor
N
Niels 已提交
7351 7352
        iterator(const iterator& other) noexcept
            : base_iterator(other)
N
Niels 已提交
7353 7354
        {}

N
Niels 已提交
7355
        /// copy assignment
N
Niels 已提交
7356
        iterator& operator=(iterator other) noexcept(
N
Niels 已提交
7357 7358
            std::is_nothrow_move_constructible<pointer>::value and
            std::is_nothrow_move_assignable<pointer>::value and
N
Niels 已提交
7359 7360
            std::is_nothrow_move_constructible<internal_iterator>::value and
            std::is_nothrow_move_assignable<internal_iterator>::value
N
Niels 已提交
7361 7362
        )
        {
N
Niels 已提交
7363
            base_iterator::operator=(other);
N
Niels 已提交
7364 7365 7366
            return *this;
        }

N
Niels 已提交
7367
        /// return a reference to the value pointed to by the iterator
7368
        reference operator*() const
N
Niels 已提交
7369
        {
N
Niels 已提交
7370 7371
            return const_cast<reference>(base_iterator::operator*());
        }
N
Niels 已提交
7372

N
Niels 已提交
7373
        /// dereference the iterator
7374
        pointer operator->() const
N
Niels 已提交
7375 7376 7377
        {
            return const_cast<pointer>(base_iterator::operator->());
        }
N
Niels 已提交
7378

N
Niels 已提交
7379 7380 7381 7382 7383 7384 7385
        /// post-increment (it++)
        iterator operator++(int)
        {
            iterator result = *this;
            base_iterator::operator++();
            return result;
        }
N
Niels 已提交
7386

N
Niels 已提交
7387 7388 7389 7390 7391
        /// pre-increment (++it)
        iterator& operator++()
        {
            base_iterator::operator++();
            return *this;
N
Niels 已提交
7392 7393
        }

N
Niels 已提交
7394 7395
        /// post-decrement (it--)
        iterator operator--(int)
N
Niels 已提交
7396
        {
N
Niels 已提交
7397 7398 7399 7400
            iterator result = *this;
            base_iterator::operator--();
            return result;
        }
N
Niels 已提交
7401

N
Niels 已提交
7402 7403 7404 7405 7406 7407
        /// pre-decrement (--it)
        iterator& operator--()
        {
            base_iterator::operator--();
            return *this;
        }
N
Niels 已提交
7408 7409

        /// add to iterator
N
Niels 已提交
7410
        iterator& operator+=(difference_type i)
N
Niels 已提交
7411
        {
N
Niels 已提交
7412
            base_iterator::operator+=(i);
N
Niels 已提交
7413 7414 7415 7416
            return *this;
        }

        /// subtract from iterator
N
Niels 已提交
7417
        iterator& operator-=(difference_type i)
N
Niels 已提交
7418
        {
N
Niels 已提交
7419 7420
            base_iterator::operator-=(i);
            return *this;
N
Niels 已提交
7421 7422 7423
        }

        /// add to iterator
N
Niels 已提交
7424
        iterator operator+(difference_type i)
N
Niels 已提交
7425 7426 7427 7428 7429 7430 7431
        {
            auto result = *this;
            result += i;
            return result;
        }

        /// subtract from iterator
N
Niels 已提交
7432
        iterator operator-(difference_type i)
N
Niels 已提交
7433 7434 7435 7436 7437 7438
        {
            auto result = *this;
            result -= i;
            return result;
        }

N
Niels 已提交
7439
        /// return difference
N
Niels 已提交
7440
        difference_type operator-(const iterator& other) const
N
Niels 已提交
7441
        {
N
Niels 已提交
7442
            return base_iterator::operator-(other);
N
Niels 已提交
7443 7444 7445
        }

        /// access to successor
N
Niels 已提交
7446
        reference operator[](difference_type n) const
N
Niels 已提交
7447
        {
N
Niels 已提交
7448
            return const_cast<reference>(base_iterator::operator[](n));
N
Niels 已提交
7449 7450
        }

7451
        /// return the value of an iterator
N
Niels 已提交
7452
        reference value() const
N
Niels 已提交
7453
        {
N
Niels 已提交
7454
            return const_cast<reference>(base_iterator::value());
N
Niels 已提交
7455
        }
N
Niels 已提交
7456 7457
    };

N
Niels 已提交
7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471
    /*!
    @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 已提交
7472

N
Niels 已提交
7473
    @since version 1.0.0
N
Niels 已提交
7474
    */
N
Niels 已提交
7475 7476
    template<typename Base>
    class json_reverse_iterator : public std::reverse_iterator<Base>
7477 7478
    {
      public:
7479
        /// shortcut to the reverse iterator adaptor
N
Niels 已提交
7480
        using base_iterator = std::reverse_iterator<Base>;
N
Niels 已提交
7481
        /// the reference type for the pointed-to element
N
Niels 已提交
7482
        using reference = typename Base::reference;
7483

7484
        /// create reverse iterator from iterator
N
Niels 已提交
7485
        json_reverse_iterator(const typename base_iterator::iterator_type& it) noexcept
N
cleanup  
Niels 已提交
7486 7487
            : base_iterator(it)
        {}
7488 7489

        /// create reverse iterator from base class
N
Niels 已提交
7490
        json_reverse_iterator(const base_iterator& it) noexcept
N
cleanup  
Niels 已提交
7491 7492
            : base_iterator(it)
        {}
7493 7494

        /// post-increment (it++)
N
Niels 已提交
7495
        json_reverse_iterator operator++(int)
7496 7497 7498 7499 7500
        {
            return base_iterator::operator++(1);
        }

        /// pre-increment (++it)
N
Niels 已提交
7501
        json_reverse_iterator& operator++()
7502 7503 7504 7505 7506 7507
        {
            base_iterator::operator++();
            return *this;
        }

        /// post-decrement (it--)
N
Niels 已提交
7508
        json_reverse_iterator operator--(int)
7509 7510 7511 7512 7513
        {
            return base_iterator::operator--(1);
        }

        /// pre-decrement (--it)
N
Niels 已提交
7514
        json_reverse_iterator& operator--()
7515 7516 7517 7518 7519 7520
        {
            base_iterator::operator--();
            return *this;
        }

        /// add to iterator
N
Niels 已提交
7521
        json_reverse_iterator& operator+=(difference_type i)
7522 7523 7524 7525 7526 7527
        {
            base_iterator::operator+=(i);
            return *this;
        }

        /// add to iterator
N
Niels 已提交
7528
        json_reverse_iterator operator+(difference_type i) const
7529 7530 7531 7532 7533 7534 7535
        {
            auto result = *this;
            result += i;
            return result;
        }

        /// subtract from iterator
N
Niels 已提交
7536
        json_reverse_iterator operator-(difference_type i) const
7537 7538 7539 7540 7541 7542 7543
        {
            auto result = *this;
            result -= i;
            return result;
        }

        /// return difference
N
Niels 已提交
7544
        difference_type operator-(const json_reverse_iterator& other) const
7545 7546 7547 7548 7549 7550 7551 7552 7553
        {
            return this->base() - other.base();
        }

        /// access to successor
        reference operator[](difference_type n) const
        {
            return *(this->operator+(n));
        }
N
Niels 已提交
7554

7555
        /// return the key of an object iterator
N
Niels 已提交
7556
        typename object_t::key_type key() const
7557
        {
N
Niels 已提交
7558 7559
            auto it = --this->base();
            return it.key();
7560 7561 7562
        }

        /// return the value of an iterator
N
Niels 已提交
7563
        reference value() const
7564
        {
N
Niels 已提交
7565 7566
            auto it = --this->base();
            return it.operator * ();
7567 7568 7569
        }
    };

N
Niels 已提交
7570

N
Niels 已提交
7571
  private:
N
Niels 已提交
7572 7573 7574
    //////////////////////
    // lexer and parser //
    //////////////////////
N
Niels 已提交
7575

N
Niels 已提交
7576 7577 7578 7579
    /*!
    @brief lexical analysis

    This class organizes the lexical analysis during JSON deserialization. The
N
Niels 已提交
7580 7581
    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 已提交
7582
    */
N
Niels 已提交
7583
    class lexer
N
Niels 已提交
7584
    {
N
Niels 已提交
7585
      public:
N
Niels 已提交
7586 7587 7588
        /// token types for the parser
        enum class token_type
        {
N
Niels 已提交
7589
            uninitialized,   ///< indicating the scanner is uninitialized
N
Niels 已提交
7590 7591 7592
            literal_true,    ///< the `true` literal
            literal_false,   ///< the `false` literal
            literal_null,    ///< the `null` literal
N
Niels 已提交
7593 7594
            value_string,    ///< a string -- use get_string() for actual value
            value_number,    ///< a number -- use get_number() for actual value
N
Niels 已提交
7595 7596 7597 7598 7599 7600
            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 已提交
7601 7602
            parse_error,     ///< indicating a parse error
            end_of_input     ///< indicating the end of the input buffer
N
Niels 已提交
7603 7604
        };

N
Niels 已提交
7605
        /// the char type to use in the lexer
N
Niels 已提交
7606
        using lexer_char_t = unsigned char;
N
Niels 已提交
7607

7608 7609
        /// a lexer from a buffer with given length
        lexer(const lexer_char_t* buff, const size_t len) noexcept
N
cleanup  
Niels 已提交
7610
            : m_content(buff)
N
Niels 已提交
7611
        {
N
Niels 已提交
7612
            assert(m_content != nullptr);
N
Niels 已提交
7613
            m_start = m_cursor = m_content;
7614
            m_limit = m_content + len;
N
Niels 已提交
7615
        }
N
Niels 已提交
7616

7617 7618
        /// a lexer from an input stream
        explicit lexer(std::istream& s)
N
cleanup  
Niels 已提交
7619
            : m_stream(&s), m_line_buffer()
N
Niels 已提交
7620
        {
N
cleanup  
Niels 已提交
7621 7622
            // fill buffer
            fill_line_buffer();
N
Niels 已提交
7623
        }
N
Niels 已提交
7624

N
Niels 已提交
7625
        // switch off unwanted functions (due to pointer members)
N
cleanup  
Niels 已提交
7626
        lexer() = delete;
N
Niels 已提交
7627 7628 7629
        lexer(const lexer&) = delete;
        lexer operator=(const lexer&) = delete;

N
Niels 已提交
7630
        /*!
N
Niels 已提交
7631 7632 7633 7634 7635 7636
        @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 已提交
7637

N
Niels 已提交
7638 7639
        @param[in] codepoint1  the code point (can be high surrogate)
        @param[in] codepoint2  the code point (can be low surrogate or 0)
N
Niels 已提交
7640

N
Niels 已提交
7641 7642
        @return string representation of the code point; the length of the
        result string is between 1 and 4 characters.
N
Niels 已提交
7643

N
Niels 已提交
7644
        @throw std::out_of_range if code point is > 0x10ffff; example: `"code
N
Niels 已提交
7645
        points above 0x10FFFF are invalid"`
N
Niels 已提交
7646 7647
        @throw std::invalid_argument if the low surrogate is invalid; example:
        `""missing or wrong low surrogate""`
N
Niels 已提交
7648

N
Niels 已提交
7649 7650
        @complexity Constant.

N
Niels 已提交
7651 7652
        @see <http://en.wikipedia.org/wiki/UTF-8#Sample_code>
        */
N
Niels 已提交
7653 7654
        static string_t to_unicode(const std::size_t codepoint1,
                                   const std::size_t codepoint2 = 0)
N
Niels 已提交
7655
        {
N
Niels 已提交
7656
            // calculate the code point from the given code points
N
Niels 已提交
7657
            std::size_t codepoint = codepoint1;
N
Niels 已提交
7658 7659

            // check if codepoint1 is a high surrogate
N
Niels 已提交
7660 7661
            if (codepoint1 >= 0xD800 and codepoint1 <= 0xDBFF)
            {
N
Niels 已提交
7662
                // check if codepoint2 is a low surrogate
N
Niels 已提交
7663 7664 7665 7666 7667 7668 7669 7670
                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 已提交
7671
                        // in the result so we have to subtract with:
N
Niels 已提交
7672 7673 7674 7675 7676 7677 7678 7679 7680
                        // (0xD800 << 10) + DC00 - 0x10000 = 0x35FDC00
                        - 0x35FDC00;
                }
                else
                {
                    throw std::invalid_argument("missing or wrong low surrogate");
                }
            }

N
Niels 已提交
7681 7682
            string_t result;

N
Niels 已提交
7683
            if (codepoint < 0x80)
N
Niels 已提交
7684
            {
N
Niels 已提交
7685
                // 1-byte characters: 0xxxxxxx (ASCII)
N
Niels 已提交
7686
                result.append(1, static_cast<typename string_t::value_type>(codepoint));
N
Niels 已提交
7687 7688 7689 7690
            }
            else if (codepoint <= 0x7ff)
            {
                // 2-byte characters: 110xxxxx 10xxxxxx
N
Niels 已提交
7691 7692
                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 已提交
7693 7694 7695 7696
            }
            else if (codepoint <= 0xffff)
            {
                // 3-byte characters: 1110xxxx 10xxxxxx 10xxxxxx
N
Niels 已提交
7697 7698 7699
                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 已提交
7700 7701 7702 7703
            }
            else if (codepoint <= 0x10ffff)
            {
                // 4-byte characters: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
N
Niels 已提交
7704 7705 7706 7707
                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 已提交
7708 7709 7710
            }
            else
            {
N
Niels 已提交
7711
                throw std::out_of_range("code points above 0x10FFFF are invalid");
N
Niels 已提交
7712 7713 7714 7715 7716
            }

            return result;
        }

7717
        /// return name of values of type token_type (only used for errors)
N
Niels 已提交
7718
        static std::string token_type_name(const token_type t)
N
cleanup  
Niels 已提交
7719 7720 7721
        {
            switch (t)
            {
7722
                case token_type::uninitialized:
N
cleanup  
Niels 已提交
7723
                    return "<uninitialized>";
7724
                case token_type::literal_true:
N
cleanup  
Niels 已提交
7725
                    return "true literal";
7726
                case token_type::literal_false:
N
cleanup  
Niels 已提交
7727
                    return "false literal";
7728
                case token_type::literal_null:
N
cleanup  
Niels 已提交
7729
                    return "null literal";
7730
                case token_type::value_string:
N
cleanup  
Niels 已提交
7731
                    return "string literal";
7732
                case token_type::value_number:
N
cleanup  
Niels 已提交
7733
                    return "number literal";
7734
                case token_type::begin_array:
N
Niels 已提交
7735
                    return "'['";
7736
                case token_type::begin_object:
N
Niels 已提交
7737
                    return "'{'";
7738
                case token_type::end_array:
N
Niels 已提交
7739
                    return "']'";
7740
                case token_type::end_object:
N
Niels 已提交
7741
                    return "'}'";
7742
                case token_type::name_separator:
N
Niels 已提交
7743
                    return "':'";
7744
                case token_type::value_separator:
N
Niels 已提交
7745
                    return "','";
7746
                case token_type::parse_error:
N
Niels 已提交
7747
                    return "<parse error>";
7748
                case token_type::end_of_input:
N
Niels 已提交
7749
                    return "end of input";
N
Niels 已提交
7750 7751 7752 7753 7754
                default:
                {
                    // catch non-enum values
                    return "unknown token"; // LCOV_EXCL_LINE
                }
N
cleanup  
Niels 已提交
7755 7756 7757
            }
        }

N
fixes  
Niels 已提交
7758 7759
        /*!
        This function implements a scanner for JSON. It is specified using
7760
        regular expressions that try to follow RFC 7159 as close as possible.
7761 7762 7763 7764
        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 已提交
7765 7766

        @return the class of the next token read from the buffer
N
Niels 已提交
7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777

        @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 已提交
7778
        */
N
cleanup  
Niels 已提交
7779
        token_type scan()
N
Niels 已提交
7780
        {
N
Niels 已提交
7781 7782 7783 7784
            while (true)
            {
                // pointer for backtracking information
                m_marker = nullptr;
N
Niels 已提交
7785

N
Niels 已提交
7786 7787 7788
                // remember the begin of the token
                m_start = m_cursor;
                assert(m_start != nullptr);
N
Niels 已提交
7789

N
Niels 已提交
7790

N
Niels 已提交
7791
                {
N
Niels 已提交
7792 7793 7794 7795 7796 7797
                    lexer_char_t yych;
                    unsigned int yyaccept = 0;
                    static const unsigned char yybm[] =
                    {
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,  32,  32,   0,   0,  32,   0,   0,
N
Niels 已提交
7798 7799
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
N
Niels 已提交
7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830
                        160, 128,   0, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        192, 192, 192, 192, 192, 192, 192, 192,
                        192, 192, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128,   0, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                    };
                    if ((m_limit - m_cursor) < 5)
                    {
7831
                        fill_line_buffer();
N
Niels 已提交
7832 7833 7834
                    }
                    yych = *m_cursor;
                    if (yybm[0 + yych] & 32)
N
Niels 已提交
7835
                    {
N
Niels 已提交
7836 7837 7838 7839 7840
                        goto basic_json_parser_6;
                    }
                    if (yych <= '\\')
                    {
                        if (yych <= '-')
N
Niels 已提交
7841
                        {
N
Niels 已提交
7842
                            if (yych <= '"')
N
Niels 已提交
7843
                            {
N
Niels 已提交
7844 7845 7846 7847 7848 7849 7850 7851 7852
                                if (yych <= 0x00)
                                {
                                    goto basic_json_parser_2;
                                }
                                if (yych <= '!')
                                {
                                    goto basic_json_parser_4;
                                }
                                goto basic_json_parser_9;
N
Niels 已提交
7853
                            }
N
Niels 已提交
7854
                            else
N
Niels 已提交
7855
                            {
N
Niels 已提交
7856 7857 7858 7859 7860 7861 7862 7863 7864
                                if (yych <= '+')
                                {
                                    goto basic_json_parser_4;
                                }
                                if (yych <= ',')
                                {
                                    goto basic_json_parser_10;
                                }
                                goto basic_json_parser_12;
N
Niels 已提交
7865 7866 7867 7868
                            }
                        }
                        else
                        {
N
Niels 已提交
7869
                            if (yych <= '9')
N
Niels 已提交
7870
                            {
N
Niels 已提交
7871 7872 7873 7874 7875 7876 7877 7878 7879
                                if (yych <= '/')
                                {
                                    goto basic_json_parser_4;
                                }
                                if (yych <= '0')
                                {
                                    goto basic_json_parser_13;
                                }
                                goto basic_json_parser_15;
N
Niels 已提交
7880
                            }
N
Niels 已提交
7881
                            else
N
Niels 已提交
7882
                            {
N
Niels 已提交
7883 7884 7885 7886 7887 7888 7889 7890 7891
                                if (yych <= ':')
                                {
                                    goto basic_json_parser_17;
                                }
                                if (yych == '[')
                                {
                                    goto basic_json_parser_19;
                                }
                                goto basic_json_parser_4;
N
Niels 已提交
7892 7893 7894 7895 7896
                            }
                        }
                    }
                    else
                    {
N
Niels 已提交
7897
                        if (yych <= 't')
N
Niels 已提交
7898
                        {
N
Niels 已提交
7899
                            if (yych <= 'f')
N
Niels 已提交
7900
                            {
N
Niels 已提交
7901 7902 7903 7904 7905 7906 7907 7908 7909
                                if (yych <= ']')
                                {
                                    goto basic_json_parser_21;
                                }
                                if (yych <= 'e')
                                {
                                    goto basic_json_parser_4;
                                }
                                goto basic_json_parser_23;
N
Niels 已提交
7910
                            }
N
Niels 已提交
7911
                            else
N
Niels 已提交
7912
                            {
N
Niels 已提交
7913 7914 7915 7916 7917 7918 7919 7920 7921
                                if (yych == 'n')
                                {
                                    goto basic_json_parser_24;
                                }
                                if (yych <= 's')
                                {
                                    goto basic_json_parser_4;
                                }
                                goto basic_json_parser_25;
N
Niels 已提交
7922 7923 7924 7925
                            }
                        }
                        else
                        {
N
Niels 已提交
7926
                            if (yych <= '|')
N
Niels 已提交
7927
                            {
N
Niels 已提交
7928 7929 7930 7931 7932
                                if (yych == '{')
                                {
                                    goto basic_json_parser_26;
                                }
                                goto basic_json_parser_4;
N
Niels 已提交
7933
                            }
N
Niels 已提交
7934
                            else
N
Niels 已提交
7935
                            {
N
Niels 已提交
7936 7937 7938 7939 7940 7941 7942 7943 7944
                                if (yych <= '}')
                                {
                                    goto basic_json_parser_28;
                                }
                                if (yych == 0xEF)
                                {
                                    goto basic_json_parser_30;
                                }
                                goto basic_json_parser_4;
N
Niels 已提交
7945 7946
                            }
                        }
N
Niels 已提交
7947
                    }
N
Niels 已提交
7948 7949
basic_json_parser_2:
                    ++m_cursor;
N
Niels 已提交
7950
                    {
N
Niels 已提交
7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964
                        last_token_type = token_type::end_of_input;
                        break;
                    }
basic_json_parser_4:
                    ++m_cursor;
basic_json_parser_5:
                    {
                        last_token_type = token_type::parse_error;
                        break;
                    }
basic_json_parser_6:
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
7965
                        fill_line_buffer();
N
Niels 已提交
7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977
                    }
                    yych = *m_cursor;
                    if (yybm[0 + yych] & 32)
                    {
                        goto basic_json_parser_6;
                    }
                    {
                        continue;
                    }
basic_json_parser_9:
                    yyaccept = 0;
                    yych = *(m_marker = ++m_cursor);
N
Niels 已提交
7978
                    if (yych <= 0x1F)
N
Niels 已提交
7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034
                    {
                        goto basic_json_parser_5;
                    }
                    goto basic_json_parser_32;
basic_json_parser_10:
                    ++m_cursor;
                    {
                        last_token_type = token_type::value_separator;
                        break;
                    }
basic_json_parser_12:
                    yych = *++m_cursor;
                    if (yych <= '/')
                    {
                        goto basic_json_parser_5;
                    }
                    if (yych <= '0')
                    {
                        goto basic_json_parser_13;
                    }
                    if (yych <= '9')
                    {
                        goto basic_json_parser_15;
                    }
                    goto basic_json_parser_5;
basic_json_parser_13:
                    yyaccept = 1;
                    yych = *(m_marker = ++m_cursor);
                    if (yych <= 'D')
                    {
                        if (yych == '.')
                        {
                            goto basic_json_parser_37;
                        }
                    }
                    else
                    {
                        if (yych <= 'E')
                        {
                            goto basic_json_parser_38;
                        }
                        if (yych == 'e')
                        {
                            goto basic_json_parser_38;
                        }
                    }
basic_json_parser_14:
                    {
                        last_token_type = token_type::value_number;
                        break;
                    }
basic_json_parser_15:
                    yyaccept = 1;
                    m_marker = ++m_cursor;
                    if ((m_limit - m_cursor) < 3)
                    {
8035
                        fill_line_buffer();
N
Niels 已提交
8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127
                    }
                    yych = *m_cursor;
                    if (yybm[0 + yych] & 64)
                    {
                        goto basic_json_parser_15;
                    }
                    if (yych <= 'D')
                    {
                        if (yych == '.')
                        {
                            goto basic_json_parser_37;
                        }
                        goto basic_json_parser_14;
                    }
                    else
                    {
                        if (yych <= 'E')
                        {
                            goto basic_json_parser_38;
                        }
                        if (yych == 'e')
                        {
                            goto basic_json_parser_38;
                        }
                        goto basic_json_parser_14;
                    }
basic_json_parser_17:
                    ++m_cursor;
                    {
                        last_token_type = token_type::name_separator;
                        break;
                    }
basic_json_parser_19:
                    ++m_cursor;
                    {
                        last_token_type = token_type::begin_array;
                        break;
                    }
basic_json_parser_21:
                    ++m_cursor;
                    {
                        last_token_type = token_type::end_array;
                        break;
                    }
basic_json_parser_23:
                    yyaccept = 0;
                    yych = *(m_marker = ++m_cursor);
                    if (yych == 'a')
                    {
                        goto basic_json_parser_39;
                    }
                    goto basic_json_parser_5;
basic_json_parser_24:
                    yyaccept = 0;
                    yych = *(m_marker = ++m_cursor);
                    if (yych == 'u')
                    {
                        goto basic_json_parser_40;
                    }
                    goto basic_json_parser_5;
basic_json_parser_25:
                    yyaccept = 0;
                    yych = *(m_marker = ++m_cursor);
                    if (yych == 'r')
                    {
                        goto basic_json_parser_41;
                    }
                    goto basic_json_parser_5;
basic_json_parser_26:
                    ++m_cursor;
                    {
                        last_token_type = token_type::begin_object;
                        break;
                    }
basic_json_parser_28:
                    ++m_cursor;
                    {
                        last_token_type = token_type::end_object;
                        break;
                    }
basic_json_parser_30:
                    yyaccept = 0;
                    yych = *(m_marker = ++m_cursor);
                    if (yych == 0xBB)
                    {
                        goto basic_json_parser_42;
                    }
                    goto basic_json_parser_5;
basic_json_parser_31:
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
8128
                        fill_line_buffer();
N
Niels 已提交
8129 8130 8131 8132 8133 8134 8135
                    }
                    yych = *m_cursor;
basic_json_parser_32:
                    if (yybm[0 + yych] & 128)
                    {
                        goto basic_json_parser_31;
                    }
N
Niels 已提交
8136
                    if (yych <= 0x1F)
N
Niels 已提交
8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164
                    {
                        goto basic_json_parser_33;
                    }
                    if (yych <= '"')
                    {
                        goto basic_json_parser_34;
                    }
                    goto basic_json_parser_36;
basic_json_parser_33:
                    m_cursor = m_marker;
                    if (yyaccept == 0)
                    {
                        goto basic_json_parser_5;
                    }
                    else
                    {
                        goto basic_json_parser_14;
                    }
basic_json_parser_34:
                    ++m_cursor;
                    {
                        last_token_type = token_type::value_string;
                        break;
                    }
basic_json_parser_36:
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
8165
                        fill_line_buffer();
N
Niels 已提交
8166 8167 8168 8169 8170
                    }
                    yych = *m_cursor;
                    if (yych <= 'e')
                    {
                        if (yych <= '/')
N
Niels 已提交
8171
                        {
N
Niels 已提交
8172
                            if (yych == '"')
N
Niels 已提交
8173
                            {
N
Niels 已提交
8174
                                goto basic_json_parser_31;
N
Niels 已提交
8175
                            }
N
Niels 已提交
8176
                            if (yych <= '.')
N
Niels 已提交
8177
                            {
N
Niels 已提交
8178
                                goto basic_json_parser_33;
N
Niels 已提交
8179
                            }
N
Niels 已提交
8180
                            goto basic_json_parser_31;
N
Niels 已提交
8181 8182 8183
                        }
                        else
                        {
N
Niels 已提交
8184
                            if (yych <= '\\')
N
Niels 已提交
8185
                            {
N
Niels 已提交
8186 8187 8188 8189 8190
                                if (yych <= '[')
                                {
                                    goto basic_json_parser_33;
                                }
                                goto basic_json_parser_31;
N
Niels 已提交
8191
                            }
N
Niels 已提交
8192
                            else
N
Niels 已提交
8193
                            {
N
Niels 已提交
8194 8195 8196 8197 8198
                                if (yych == 'b')
                                {
                                    goto basic_json_parser_31;
                                }
                                goto basic_json_parser_33;
N
Niels 已提交
8199 8200 8201 8202 8203
                            }
                        }
                    }
                    else
                    {
N
Niels 已提交
8204
                        if (yych <= 'q')
N
Niels 已提交
8205
                        {
N
Niels 已提交
8206
                            if (yych <= 'f')
N
Niels 已提交
8207
                            {
N
Niels 已提交
8208
                                goto basic_json_parser_31;
N
Niels 已提交
8209
                            }
N
Niels 已提交
8210 8211 8212 8213 8214
                            if (yych == 'n')
                            {
                                goto basic_json_parser_31;
                            }
                            goto basic_json_parser_33;
N
Niels 已提交
8215 8216 8217
                        }
                        else
                        {
N
Niels 已提交
8218
                            if (yych <= 's')
N
Niels 已提交
8219
                            {
N
Niels 已提交
8220 8221 8222 8223 8224
                                if (yych <= 'r')
                                {
                                    goto basic_json_parser_31;
                                }
                                goto basic_json_parser_33;
N
Niels 已提交
8225
                            }
N
Niels 已提交
8226
                            else
N
Niels 已提交
8227
                            {
N
Niels 已提交
8228 8229 8230 8231 8232 8233 8234 8235 8236
                                if (yych <= 't')
                                {
                                    goto basic_json_parser_31;
                                }
                                if (yych <= 'u')
                                {
                                    goto basic_json_parser_43;
                                }
                                goto basic_json_parser_33;
N
Niels 已提交
8237 8238
                            }
                        }
N
Niels 已提交
8239
                    }
N
Niels 已提交
8240 8241 8242
basic_json_parser_37:
                    yych = *++m_cursor;
                    if (yych <= '/')
N
Niels 已提交
8243
                    {
N
Niels 已提交
8244
                        goto basic_json_parser_33;
N
Niels 已提交
8245
                    }
N
Niels 已提交
8246
                    if (yych <= '9')
N
Niels 已提交
8247
                    {
N
Niels 已提交
8248
                        goto basic_json_parser_44;
N
Niels 已提交
8249
                    }
N
Niels 已提交
8250 8251 8252 8253
                    goto basic_json_parser_33;
basic_json_parser_38:
                    yych = *++m_cursor;
                    if (yych <= ',')
N
Niels 已提交
8254
                    {
N
Niels 已提交
8255 8256 8257 8258 8259
                        if (yych == '+')
                        {
                            goto basic_json_parser_46;
                        }
                        goto basic_json_parser_33;
N
Niels 已提交
8260
                    }
N
Niels 已提交
8261
                    else
N
Niels 已提交
8262
                    {
N
Niels 已提交
8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275
                        if (yych <= '-')
                        {
                            goto basic_json_parser_46;
                        }
                        if (yych <= '/')
                        {
                            goto basic_json_parser_33;
                        }
                        if (yych <= '9')
                        {
                            goto basic_json_parser_47;
                        }
                        goto basic_json_parser_33;
N
Niels 已提交
8276
                    }
N
Niels 已提交
8277 8278 8279
basic_json_parser_39:
                    yych = *++m_cursor;
                    if (yych == 'l')
N
Niels 已提交
8280
                    {
N
Niels 已提交
8281
                        goto basic_json_parser_49;
N
Niels 已提交
8282
                    }
N
Niels 已提交
8283 8284 8285 8286
                    goto basic_json_parser_33;
basic_json_parser_40:
                    yych = *++m_cursor;
                    if (yych == 'l')
N
Niels 已提交
8287
                    {
N
Niels 已提交
8288
                        goto basic_json_parser_50;
N
Niels 已提交
8289
                    }
T
Trevor Welsby 已提交
8290
                    goto basic_json_parser_33;
N
Niels 已提交
8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308
basic_json_parser_41:
                    yych = *++m_cursor;
                    if (yych == 'u')
                    {
                        goto basic_json_parser_51;
                    }
                    goto basic_json_parser_33;
basic_json_parser_42:
                    yych = *++m_cursor;
                    if (yych == 0xBF)
                    {
                        goto basic_json_parser_52;
                    }
                    goto basic_json_parser_33;
basic_json_parser_43:
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
8309
                        fill_line_buffer();
N
Niels 已提交
8310 8311 8312
                    }
                    yych = *m_cursor;
                    if (yych <= '@')
N
Niels 已提交
8313
                    {
N
Niels 已提交
8314
                        if (yych <= '/')
N
Niels 已提交
8315
                        {
N
Niels 已提交
8316
                            goto basic_json_parser_33;
N
Niels 已提交
8317
                        }
N
Niels 已提交
8318
                        if (yych <= '9')
N
Niels 已提交
8319
                        {
N
Niels 已提交
8320
                            goto basic_json_parser_54;
N
Niels 已提交
8321
                        }
N
Niels 已提交
8322
                        goto basic_json_parser_33;
N
Niels 已提交
8323 8324 8325
                    }
                    else
                    {
N
Niels 已提交
8326
                        if (yych <= 'F')
N
Niels 已提交
8327
                        {
N
Niels 已提交
8328
                            goto basic_json_parser_54;
N
Niels 已提交
8329
                        }
N
Niels 已提交
8330
                        if (yych <= '`')
N
Niels 已提交
8331 8332 8333
                        {
                            goto basic_json_parser_33;
                        }
N
Niels 已提交
8334 8335 8336 8337 8338
                        if (yych <= 'f')
                        {
                            goto basic_json_parser_54;
                        }
                        goto basic_json_parser_33;
N
Niels 已提交
8339
                    }
N
Niels 已提交
8340 8341 8342 8343
basic_json_parser_44:
                    yyaccept = 1;
                    m_marker = ++m_cursor;
                    if ((m_limit - m_cursor) < 3)
N
Niels 已提交
8344
                    {
8345
                        fill_line_buffer();
N
Niels 已提交
8346 8347 8348 8349 8350
                    }
                    yych = *m_cursor;
                    if (yych <= 'D')
                    {
                        if (yych <= '/')
N
Niels 已提交
8351
                        {
N
Niels 已提交
8352
                            goto basic_json_parser_14;
N
Niels 已提交
8353
                        }
N
Niels 已提交
8354
                        if (yych <= '9')
N
Niels 已提交
8355
                        {
N
Niels 已提交
8356
                            goto basic_json_parser_44;
N
Niels 已提交
8357
                        }
N
Niels 已提交
8358
                        goto basic_json_parser_14;
N
Niels 已提交
8359 8360 8361
                    }
                    else
                    {
N
Niels 已提交
8362
                        if (yych <= 'E')
N
Niels 已提交
8363
                        {
N
Niels 已提交
8364
                            goto basic_json_parser_38;
N
Niels 已提交
8365
                        }
N
Niels 已提交
8366
                        if (yych == 'e')
N
Niels 已提交
8367
                        {
N
Niels 已提交
8368
                            goto basic_json_parser_38;
N
Niels 已提交
8369
                        }
N
Niels 已提交
8370
                        goto basic_json_parser_14;
N
Niels 已提交
8371
                    }
N
Niels 已提交
8372 8373
basic_json_parser_46:
                    yych = *++m_cursor;
N
Niels 已提交
8374 8375 8376 8377
                    if (yych <= '/')
                    {
                        goto basic_json_parser_33;
                    }
N
Niels 已提交
8378
                    if (yych >= ':')
N
Niels 已提交
8379 8380 8381
                    {
                        goto basic_json_parser_33;
                    }
N
Niels 已提交
8382 8383 8384
basic_json_parser_47:
                    ++m_cursor;
                    if (m_limit <= m_cursor)
N
Niels 已提交
8385
                    {
8386
                        fill_line_buffer();
N
Niels 已提交
8387
                    }
N
Niels 已提交
8388
                    yych = *m_cursor;
N
Niels 已提交
8389
                    if (yych <= '/')
N
Niels 已提交
8390
                    {
N
Niels 已提交
8391
                        goto basic_json_parser_14;
N
Niels 已提交
8392
                    }
N
Niels 已提交
8393
                    if (yych <= '9')
N
Niels 已提交
8394
                    {
N
Niels 已提交
8395
                        goto basic_json_parser_47;
N
Niels 已提交
8396
                    }
N
Niels 已提交
8397
                    goto basic_json_parser_14;
N
Niels 已提交
8398 8399 8400
basic_json_parser_49:
                    yych = *++m_cursor;
                    if (yych == 's')
N
Niels 已提交
8401
                    {
N
Niels 已提交
8402
                        goto basic_json_parser_55;
N
Niels 已提交
8403
                    }
N
Niels 已提交
8404 8405 8406 8407
                    goto basic_json_parser_33;
basic_json_parser_50:
                    yych = *++m_cursor;
                    if (yych == 'l')
N
Niels 已提交
8408
                    {
N
Niels 已提交
8409
                        goto basic_json_parser_56;
N
Niels 已提交
8410
                    }
N
Niels 已提交
8411
                    goto basic_json_parser_33;
N
Niels 已提交
8412
basic_json_parser_51:
N
Niels 已提交
8413 8414 8415 8416 8417 8418
                    yych = *++m_cursor;
                    if (yych == 'e')
                    {
                        goto basic_json_parser_58;
                    }
                    goto basic_json_parser_33;
N
Niels 已提交
8419
basic_json_parser_52:
N
Niels 已提交
8420
                    ++m_cursor;
N
Niels 已提交
8421
                    {
N
Niels 已提交
8422
                        continue;
N
Niels 已提交
8423
                    }
N
Niels 已提交
8424 8425 8426
basic_json_parser_54:
                    ++m_cursor;
                    if (m_limit <= m_cursor)
N
Niels 已提交
8427
                    {
8428
                        fill_line_buffer();
N
Niels 已提交
8429
                    }
N
Niels 已提交
8430 8431
                    yych = *m_cursor;
                    if (yych <= '@')
N
Niels 已提交
8432
                    {
N
Niels 已提交
8433 8434 8435 8436 8437 8438 8439 8440 8441
                        if (yych <= '/')
                        {
                            goto basic_json_parser_33;
                        }
                        if (yych <= '9')
                        {
                            goto basic_json_parser_60;
                        }
                        goto basic_json_parser_33;
N
Niels 已提交
8442
                    }
N
Niels 已提交
8443
                    else
N
Niels 已提交
8444
                    {
N
Niels 已提交
8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456
                        if (yych <= 'F')
                        {
                            goto basic_json_parser_60;
                        }
                        if (yych <= '`')
                        {
                            goto basic_json_parser_33;
                        }
                        if (yych <= 'f')
                        {
                            goto basic_json_parser_60;
                        }
N
Niels 已提交
8457
                        goto basic_json_parser_33;
N
Niels 已提交
8458
                    }
N
Niels 已提交
8459 8460 8461
basic_json_parser_55:
                    yych = *++m_cursor;
                    if (yych == 'e')
N
Niels 已提交
8462
                    {
N
Niels 已提交
8463
                        goto basic_json_parser_61;
N
Niels 已提交
8464 8465
                    }
                    goto basic_json_parser_33;
N
Niels 已提交
8466
basic_json_parser_56:
N
Niels 已提交
8467
                    ++m_cursor;
N
Niels 已提交
8468
                    {
N
Niels 已提交
8469 8470
                        last_token_type = token_type::literal_null;
                        break;
N
Niels 已提交
8471
                    }
N
Niels 已提交
8472 8473
basic_json_parser_58:
                    ++m_cursor;
N
Niels 已提交
8474
                    {
N
Niels 已提交
8475 8476
                        last_token_type = token_type::literal_true;
                        break;
N
Niels 已提交
8477
                    }
N
Niels 已提交
8478 8479 8480
basic_json_parser_60:
                    ++m_cursor;
                    if (m_limit <= m_cursor)
N
Niels 已提交
8481
                    {
8482
                        fill_line_buffer();
N
Niels 已提交
8483
                    }
N
Niels 已提交
8484 8485
                    yych = *m_cursor;
                    if (yych <= '@')
N
Niels 已提交
8486
                    {
N
Niels 已提交
8487 8488 8489 8490 8491 8492 8493 8494
                        if (yych <= '/')
                        {
                            goto basic_json_parser_33;
                        }
                        if (yych <= '9')
                        {
                            goto basic_json_parser_63;
                        }
N
Niels 已提交
8495 8496
                        goto basic_json_parser_33;
                    }
N
Niels 已提交
8497
                    else
N
Niels 已提交
8498
                    {
N
Niels 已提交
8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510
                        if (yych <= 'F')
                        {
                            goto basic_json_parser_63;
                        }
                        if (yych <= '`')
                        {
                            goto basic_json_parser_33;
                        }
                        if (yych <= 'f')
                        {
                            goto basic_json_parser_63;
                        }
N
Niels 已提交
8511 8512
                        goto basic_json_parser_33;
                    }
N
Niels 已提交
8513 8514
basic_json_parser_61:
                    ++m_cursor;
N
Niels 已提交
8515
                    {
N
Niels 已提交
8516 8517
                        last_token_type = token_type::literal_false;
                        break;
N
Niels 已提交
8518
                    }
N
Niels 已提交
8519 8520 8521
basic_json_parser_63:
                    ++m_cursor;
                    if (m_limit <= m_cursor)
N
Niels 已提交
8522
                    {
8523
                        fill_line_buffer();
N
Niels 已提交
8524
                    }
N
Niels 已提交
8525 8526
                    yych = *m_cursor;
                    if (yych <= '@')
N
Niels 已提交
8527
                    {
N
Niels 已提交
8528 8529 8530 8531 8532 8533 8534 8535
                        if (yych <= '/')
                        {
                            goto basic_json_parser_33;
                        }
                        if (yych <= '9')
                        {
                            goto basic_json_parser_31;
                        }
N
Niels 已提交
8536 8537
                        goto basic_json_parser_33;
                    }
N
Niels 已提交
8538
                    else
N
Niels 已提交
8539
                    {
N
Niels 已提交
8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552
                        if (yych <= 'F')
                        {
                            goto basic_json_parser_31;
                        }
                        if (yych <= '`')
                        {
                            goto basic_json_parser_33;
                        }
                        if (yych <= 'f')
                        {
                            goto basic_json_parser_31;
                        }
                        goto basic_json_parser_33;
N
Niels 已提交
8553
                    }
N
Niels 已提交
8554
                }
N
Niels 已提交
8555

N
Niels 已提交
8556
            }
N
Niels 已提交
8557

N
Niels 已提交
8558
            return last_token_type;
N
Niels 已提交
8559 8560
        }

N
cleanup  
Niels 已提交
8561 8562 8563 8564 8565 8566 8567 8568
        /*!
        @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.

8569 8570 8571 8572 8573 8574 8575
        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 已提交
8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589
        @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
        */
        void fill_line_buffer()
N
Niels 已提交
8590
        {
N
cleanup  
Niels 已提交
8591
            // number of processed characters (p)
8592
            const auto offset_start = m_start - m_content;
N
cleanup  
Niels 已提交
8593
            // offset for m_marker wrt. to m_start
8594
            const auto offset_marker = (m_marker == nullptr) ? 0 : m_marker - m_start;
N
cleanup  
Niels 已提交
8595
            // number of unprocessed characters (u)
8596
            const auto offset_cursor = m_cursor - m_start;
N
Niels 已提交
8597

8598
            // no stream is used or end of file is reached
N
Niels 已提交
8599
            if (m_stream == nullptr or m_stream->eof())
8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620
            {
                // copy unprocessed characters to line buffer
                m_line_buffer.clear();
                for (m_cursor = m_start; m_cursor != m_limit; ++m_cursor)
                {
                    m_line_buffer.append(1, static_cast<const char>(*m_cursor));
                }

                // append 5 characters (size of longest keyword "false") to
                // make sure that there is sufficient space between m_cursor
                // and m_limit
                m_line_buffer.append(5, '\0');
            }
            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;
                std::getline(*m_stream, line);
                // add line with newline symbol to the line buffer
N
Niels 已提交
8621
                m_line_buffer += line + "\n";
8622
            }
N
Niels 已提交
8623

N
cleanup  
Niels 已提交
8624 8625
            // set pointers
            m_content = reinterpret_cast<const lexer_char_t*>(m_line_buffer.c_str());
N
Niels 已提交
8626
            assert(m_content != nullptr);
N
Niels 已提交
8627 8628 8629
            m_start  = m_content;
            m_marker = m_start + offset_marker;
            m_cursor = m_start + offset_cursor;
8630
            m_limit  = m_start + m_line_buffer.size();
N
Niels 已提交
8631 8632
        }

N
Niels 已提交
8633
        /// return string representation of last read token
N
Niels 已提交
8634
        string_t get_token_string() const
N
Niels 已提交
8635
        {
N
Niels 已提交
8636
            assert(m_start != nullptr);
N
Niels 已提交
8637 8638
            return string_t(reinterpret_cast<typename string_t::const_pointer>(m_start),
                            static_cast<size_t>(m_cursor - m_start));
N
Niels 已提交
8639 8640 8641
        }

        /*!
N
Niels 已提交
8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652
        @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 已提交
8653 8654
           characters (e.g., `"\\n"` is replaced by `"\n"`), some are copied
           as is (e.g., `"\\\\"`). Furthermore, Unicode escapes of the shape
N
Niels 已提交
8655 8656
           `"\\uxxxx"` need special care. In this case, to_unicode takes care
           of the construction of the values.
N
Niels 已提交
8657
        2. Unescaped characters are copied as is.
N
Niels 已提交
8658

N
Niels 已提交
8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673
        @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 已提交
8674 8675 8676
        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 已提交
8677 8678 8679 8680 8681 8682 8683

        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 已提交
8684 8685
        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 已提交
8686
        precondition, we x <= 0, meaning that the loop condition holds
N
Niels 已提交
8687 8688 8689 8690 8691 8692
        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 已提交
8693

N
Niels 已提交
8694 8695
        @return string value of current token without opening and closing
        quotes
N
Niels 已提交
8696
        @throw std::out_of_range if to_unicode fails
N
Niels 已提交
8697
        */
N
Niels 已提交
8698
        string_t get_string() const
N
Niels 已提交
8699
        {
N
Niels 已提交
8700 8701
            assert(m_cursor - m_start >= 2);

N
Niels 已提交
8702
            string_t result;
N
Niels 已提交
8703 8704 8705
            result.reserve(static_cast<size_t>(m_cursor - m_start - 2));

            // iterate the result between the quotes
N
Niels 已提交
8706
            for (const lexer_char_t* i = m_start + 1; i < m_cursor - 1; ++i)
N
Niels 已提交
8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743
            {
                // 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 已提交
8744
                            result += "\\";
N
Niels 已提交
8745 8746 8747 8748
                            break;
                        }
                        case '/':
                        {
N
Niels 已提交
8749
                            result += "/";
N
Niels 已提交
8750 8751 8752 8753
                            break;
                        }
                        case '"':
                        {
N
Niels 已提交
8754
                            result += "\"";
N
Niels 已提交
8755 8756 8757 8758 8759 8760
                            break;
                        }

                        // unicode
                        case 'u':
                        {
N
Niels 已提交
8761
                            // get code xxxx from uxxxx
N
Niels 已提交
8762 8763
                            auto codepoint = std::strtoul(std::string(reinterpret_cast<typename string_t::const_pointer>(i + 1),
                                                          4).c_str(), nullptr, 16);
N
Niels 已提交
8764

N
Niels 已提交
8765
                            // check if codepoint is a high surrogate
N
Niels 已提交
8766 8767
                            if (codepoint >= 0xD800 and codepoint <= 0xDBFF)
                            {
N
Niels 已提交
8768
                                // make sure there is a subsequent unicode
N
Niels 已提交
8769
                                if ((i + 6 >= m_limit) or * (i + 5) != '\\' or * (i + 6) != 'u')
N
Niels 已提交
8770 8771 8772 8773
                                {
                                    throw std::invalid_argument("missing low surrogate");
                                }

N
Niels 已提交
8774
                                // get code yyyy from uxxxx\uyyyy
N
Niels 已提交
8775 8776
                                auto codepoint2 = std::strtoul(std::string(reinterpret_cast<typename string_t::const_pointer>
                                                               (i + 7), 4).c_str(), nullptr, 16);
N
Niels 已提交
8777
                                result += to_unicode(codepoint, codepoint2);
8778 8779
                                // skip the next 10 characters (xxxx\uyyyy)
                                i += 10;
N
Niels 已提交
8780 8781 8782 8783 8784 8785 8786 8787
                            }
                            else
                            {
                                // add unicode character(s)
                                result += to_unicode(codepoint);
                                // skip the next four characters (xxxx)
                                i += 4;
                            }
N
Niels 已提交
8788 8789 8790 8791 8792 8793 8794 8795
                            break;
                        }
                    }
                }
                else
                {
                    // all other characters are just copied to the end of the
                    // string
N
Niels 已提交
8796
                    result.append(1, static_cast<typename string_t::value_type>(*i));
N
Niels 已提交
8797 8798 8799 8800
                }
            }

            return result;
N
Niels 已提交
8801 8802
        }

8803 8804 8805 8806
        /*!
        @brief parse floating point number

        This function (and its overloads) serves to select the most approprate
8807
        standard floating point number parsing function based on the type
N
Niels 已提交
8808 8809
        supplied via the first parameter.  Set this to @a
        static_cast<number_float_t*>(nullptr).
8810

N
Niels 已提交
8811
        @param[in] type  the @ref number_float_t in use
8812

N
Niels 已提交
8813 8814
        @param[in,out] endptr recieves a pointer to the first character after
        the number
8815 8816 8817

        @return the floating point number
        */
8818
        long double str_to_float_t(long double* /* type */, char** endptr) const
8819 8820 8821 8822
        {
            return std::strtold(reinterpret_cast<typename string_t::const_pointer>(m_start), endptr);
        }

8823 8824 8825 8826 8827
        /*!
        @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 已提交
8828 8829
        supplied via the first parameter.  Set this to @a
        static_cast<number_float_t*>(nullptr).
8830

N
Niels 已提交
8831
        @param[in] type  the @ref number_float_t in use
8832

N
Niels 已提交
8833 8834
        @param[in,out] endptr  recieves a pointer to the first character after
        the number
8835 8836 8837

        @return the floating point number
        */
8838
        double str_to_float_t(double* /* type */, char** endptr) const
8839 8840 8841 8842
        {
            return std::strtod(reinterpret_cast<typename string_t::const_pointer>(m_start), endptr);
        }

8843 8844 8845 8846 8847
        /*!
        @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 已提交
8848 8849
        supplied via the first parameter.  Set this to @a
        static_cast<number_float_t*>(nullptr).
8850

N
Niels 已提交
8851
        @param[in] type  the @ref number_float_t in use
8852

N
Niels 已提交
8853 8854
        @param[in,out] endptr  recieves a pointer to the first character after
        the number
8855 8856 8857

        @return the floating point number
        */
8858
        float str_to_float_t(float* /* type */, char** endptr) const
8859 8860 8861 8862
        {
            return std::strtof(reinterpret_cast<typename string_t::const_pointer>(m_start), endptr);
        }

8863 8864
        /*!
        @brief return number value for number tokens
N
Niels 已提交
8865

N
Niels 已提交
8866
        This function translates the last token into the most appropriate
N
Niels 已提交
8867 8868 8869 8870 8871 8872
        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 已提交
8873 8874 8875
        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 已提交
8876 8877 8878 8879 8880

        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 已提交
8881 8882
        NAN if the conversion read past the current token. The latter case
        needs to be treated by the caller function.
N
Niels 已提交
8883
        */
8884
        void get_number(basic_json& result) const
N
Niels 已提交
8885
        {
N
Niels 已提交
8886
            assert(m_start != nullptr);
N
Niels 已提交
8887

N
Niels 已提交
8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900
            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 == '-')
8901
            {
N
Niels 已提交
8902
                type = value_t::number_integer;
N
Niels 已提交
8903
                max = static_cast<uint64_t>((std::numeric_limits<number_integer_t>::max)()) + 1;
N
Niels 已提交
8904 8905 8906 8907 8908
                curptr++;
            }
            else
            {
                type = value_t::number_unsigned;
T
Tom Needham 已提交
8909
                max = static_cast<uint64_t>((std::numeric_limits<number_unsigned_t>::max)());
8910
            }
N
Niels 已提交
8911 8912 8913

            // count the significant figures
            for (; curptr < m_cursor; curptr++)
8914
            {
N
Niels 已提交
8915 8916
                // quickly skip tests if a digit
                if (*curptr < '0' || *curptr > '9')
N
Niels 已提交
8917
                {
N
Niels 已提交
8918 8919 8920 8921 8922 8923 8924 8925 8926 8927
                    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 已提交
8928
                }
N
Niels 已提交
8929 8930 8931

                // skip if definitely not an integer
                if (type != value_t::number_float)
N
Niels 已提交
8932
                {
N
Niels 已提交
8933
                    // multiply last value by ten and add the new digit
N
Niels 已提交
8934
                    auto temp = value * 10 + *curptr - '0';
N
Niels 已提交
8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946

                    // test for overflow
                    if (temp < value || temp > max)
                    {
                        // overflow
                        type = value_t::number_float;
                    }
                    else
                    {
                        // no overflow - save it
                        value = temp;
                    }
N
Niels 已提交
8947
                }
8948
            }
N
Niels 已提交
8949

N
Niels 已提交
8950 8951
            // save the value (if not a float)
            if (type == value_t::number_unsigned)
N
Niels 已提交
8952
            {
N
Niels 已提交
8953
                result.m_value.number_unsigned = value;
N
Niels 已提交
8954
            }
N
Niels 已提交
8955 8956 8957 8958 8959
            else if (type == value_t::number_integer)
            {
                result.m_value.number_integer = -static_cast<number_integer_t>(value);
            }
            else
8960
            {
N
Niels 已提交
8961
                // parse with strtod
N
Niels 已提交
8962
                result.m_value.number_float = str_to_float_t(static_cast<number_float_t*>(nullptr), NULL);
8963
            }
N
Niels 已提交
8964 8965 8966

            // save the type
            result.m_type = type;
N
Niels 已提交
8967 8968 8969
        }

      private:
N
Niels 已提交
8970
        /// optional input stream
N
Niels 已提交
8971
        std::istream* m_stream = nullptr;
N
cleanup  
Niels 已提交
8972 8973
        /// line buffer buffer for m_stream
        string_t m_line_buffer {};
N
Niels 已提交
8974
        /// the buffer pointer
N
Niels 已提交
8975
        const lexer_char_t* m_content = nullptr;
N
Niels 已提交
8976
        /// pointer to the beginning of the current symbol
N
Niels 已提交
8977
        const lexer_char_t* m_start = nullptr;
N
Niels 已提交
8978 8979
        /// pointer for backtracking information
        const lexer_char_t* m_marker = nullptr;
N
fixes  
Niels 已提交
8980
        /// pointer to the current symbol
N
Niels 已提交
8981
        const lexer_char_t* m_cursor = nullptr;
N
fixes  
Niels 已提交
8982
        /// pointer to the end of the buffer
N
Niels 已提交
8983
        const lexer_char_t* m_limit = nullptr;
N
Niels 已提交
8984 8985
        /// the last token type
        token_type last_token_type = token_type::end_of_input;
N
Niels 已提交
8986 8987
    };

N
Niels 已提交
8988 8989
    /*!
    @brief syntax analysis
N
Niels 已提交
8990 8991

    This class implements a recursive decent parser.
N
Niels 已提交
8992
    */
N
Niels 已提交
8993 8994 8995
    class parser
    {
      public:
8996
        /// a parser reading from a string literal
N
Niels 已提交
8997
        parser(const char* buff, const parser_callback_t cb = nullptr)
N
cleanup  
Niels 已提交
8998
            : callback(cb),
8999
              m_lexer(reinterpret_cast<const typename lexer::lexer_char_t*>(buff), strlen(buff))
N
cleanup  
Niels 已提交
9000
        {}
9001

N
Niels 已提交
9002
        /// a parser reading from an input stream
N
cleanup  
Niels 已提交
9003
        parser(std::istream& is, const parser_callback_t cb = nullptr)
9004
            : callback(cb), m_lexer(is)
N
cleanup  
Niels 已提交
9005
        {}
9006

N
Niels 已提交
9007
        /// a parser reading from an iterator range with contiguous storage
N
Niels 已提交
9008 9009 9010 9011
        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 已提交
9012
        parser(IteratorType first, IteratorType last, const parser_callback_t cb = nullptr)
9013 9014 9015
            : callback(cb),
              m_lexer(reinterpret_cast<const typename lexer::lexer_char_t*>(&(*first)),
                      static_cast<size_t>(std::distance(first, last)))
9016
        {}
N
Niels 已提交
9017

N
Niels 已提交
9018
        /// public parser interface
N
Niels 已提交
9019
        basic_json parse()
N
Niels 已提交
9020
        {
N
cleanup  
Niels 已提交
9021 9022 9023
            // read first token
            get_token();

N
Niels 已提交
9024
            basic_json result = parse_internal(true);
9025
            result.assert_invariant();
N
Niels 已提交
9026 9027 9028

            expect(lexer::token_type::end_of_input);

N
Niels 已提交
9029 9030
            // return parser result and replace it with null in case the
            // top-level value was discarded by the callback function
9031
            return result.is_discarded() ? basic_json() : std::move(result);
N
Niels 已提交
9032 9033 9034 9035
        }

      private:
        /// the actual parser
N
Niels 已提交
9036
        basic_json parse_internal(bool keep)
N
Niels 已提交
9037
        {
N
Niels 已提交
9038 9039
            auto result = basic_json(value_t::discarded);

N
Niels 已提交
9040 9041
            switch (last_token)
            {
9042
                case lexer::token_type::begin_object:
N
Niels 已提交
9043
                {
N
Niels 已提交
9044 9045
                    if (keep and (not callback
                                  or ((keep = callback(depth++, parse_event_t::object_start, result)) != 0)))
N
Niels 已提交
9046 9047
                    {
                        // explicitly set result to object to cope with {}
N
Niels 已提交
9048
                        result.m_type = value_t::object;
9049
                        result.m_value = value_t::object;
N
Niels 已提交
9050
                    }
N
Niels 已提交
9051 9052 9053 9054 9055 9056 9057

                    // read next token
                    get_token();

                    // closing } -> we are done
                    if (last_token == lexer::token_type::end_object)
                    {
N
Niels 已提交
9058
                        get_token();
N
Niels 已提交
9059
                        if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
N
Niels 已提交
9060 9061 9062
                        {
                            result = basic_json(value_t::discarded);
                        }
N
Niels 已提交
9063
                        return result;
N
Niels 已提交
9064 9065
                    }

N
Niels 已提交
9066 9067 9068
                    // no comma is expected here
                    unexpect(lexer::token_type::value_separator);

N
Niels 已提交
9069 9070 9071
                    // otherwise: parse key-value pairs
                    do
                    {
N
Niels 已提交
9072 9073 9074 9075 9076 9077
                        // ugly, but could be fixed with loop reorganization
                        if (last_token == lexer::token_type::value_separator)
                        {
                            get_token();
                        }

N
Niels 已提交
9078 9079 9080 9081
                        // store key
                        expect(lexer::token_type::value_string);
                        const auto key = m_lexer.get_string();

N
Niels 已提交
9082 9083 9084
                        bool keep_tag = false;
                        if (keep)
                        {
N
Niels 已提交
9085 9086 9087 9088 9089 9090 9091 9092 9093
                            if (callback)
                            {
                                basic_json k(key);
                                keep_tag = callback(depth, parse_event_t::key, k);
                            }
                            else
                            {
                                keep_tag = true;
                            }
N
Niels 已提交
9094 9095
                        }

N
Niels 已提交
9096 9097 9098 9099
                        // parse separator (:)
                        get_token();
                        expect(lexer::token_type::name_separator);

9100
                        // parse and add value
N
Niels 已提交
9101
                        get_token();
N
Niels 已提交
9102 9103 9104
                        auto value = parse_internal(keep);
                        if (keep and keep_tag and not value.is_discarded())
                        {
N
Niels 已提交
9105
                            result[key] = std::move(value);
N
Niels 已提交
9106
                        }
N
Niels 已提交
9107
                    }
N
Niels 已提交
9108
                    while (last_token == lexer::token_type::value_separator);
N
Niels 已提交
9109 9110 9111

                    // closing }
                    expect(lexer::token_type::end_object);
N
Niels 已提交
9112
                    get_token();
N
Niels 已提交
9113
                    if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
N
Niels 已提交
9114 9115 9116
                    {
                        result = basic_json(value_t::discarded);
                    }
N
Niels 已提交
9117 9118

                    return result;
N
Niels 已提交
9119 9120
                }

9121
                case lexer::token_type::begin_array:
N
Niels 已提交
9122
                {
N
Niels 已提交
9123 9124
                    if (keep and (not callback
                                  or ((keep = callback(depth++, parse_event_t::array_start, result)) != 0)))
N
Niels 已提交
9125 9126
                    {
                        // explicitly set result to object to cope with []
N
Niels 已提交
9127
                        result.m_type = value_t::array;
9128
                        result.m_value = value_t::array;
N
Niels 已提交
9129
                    }
N
Niels 已提交
9130 9131 9132 9133 9134 9135 9136

                    // read next token
                    get_token();

                    // closing ] -> we are done
                    if (last_token == lexer::token_type::end_array)
                    {
N
Niels 已提交
9137
                        get_token();
N
Niels 已提交
9138
                        if (callback and not callback(--depth, parse_event_t::array_end, result))
N
Niels 已提交
9139 9140 9141
                        {
                            result = basic_json(value_t::discarded);
                        }
N
Niels 已提交
9142
                        return result;
N
Niels 已提交
9143 9144
                    }

N
Niels 已提交
9145 9146 9147
                    // no comma is expected here
                    unexpect(lexer::token_type::value_separator);

N
Niels 已提交
9148 9149 9150
                    // otherwise: parse values
                    do
                    {
N
Niels 已提交
9151 9152 9153 9154 9155
                        // ugly, but could be fixed with loop reorganization
                        if (last_token == lexer::token_type::value_separator)
                        {
                            get_token();
                        }
N
Niels 已提交
9156

N
Niels 已提交
9157 9158 9159 9160
                        // parse value
                        auto value = parse_internal(keep);
                        if (keep and not value.is_discarded())
                        {
N
Niels 已提交
9161
                            result.push_back(std::move(value));
N
Niels 已提交
9162
                        }
N
Niels 已提交
9163
                    }
N
Niels 已提交
9164
                    while (last_token == lexer::token_type::value_separator);
N
Niels 已提交
9165 9166 9167

                    // closing ]
                    expect(lexer::token_type::end_array);
N
Niels 已提交
9168
                    get_token();
N
Niels 已提交
9169
                    if (keep and callback and not callback(--depth, parse_event_t::array_end, result))
N
Niels 已提交
9170 9171 9172
                    {
                        result = basic_json(value_t::discarded);
                    }
N
Niels 已提交
9173 9174

                    return result;
N
Niels 已提交
9175 9176
                }

9177
                case lexer::token_type::literal_null:
N
Niels 已提交
9178
                {
N
Niels 已提交
9179
                    get_token();
N
Niels 已提交
9180
                    result.m_type = value_t::null;
N
Niels 已提交
9181
                    break;
N
Niels 已提交
9182 9183
                }

9184
                case lexer::token_type::value_string:
N
Niels 已提交
9185
                {
N
Niels 已提交
9186
                    const auto s = m_lexer.get_string();
N
Niels 已提交
9187
                    get_token();
N
Niels 已提交
9188 9189
                    result = basic_json(s);
                    break;
N
Niels 已提交
9190 9191
                }

9192
                case lexer::token_type::literal_true:
N
Niels 已提交
9193
                {
N
Niels 已提交
9194
                    get_token();
N
Niels 已提交
9195 9196
                    result.m_type = value_t::boolean;
                    result.m_value = true;
N
Niels 已提交
9197
                    break;
N
Niels 已提交
9198 9199
                }

9200
                case lexer::token_type::literal_false:
N
Niels 已提交
9201
                {
N
Niels 已提交
9202
                    get_token();
N
Niels 已提交
9203 9204
                    result.m_type = value_t::boolean;
                    result.m_value = false;
N
Niels 已提交
9205
                    break;
N
Niels 已提交
9206 9207
                }

9208
                case lexer::token_type::value_number:
N
Niels 已提交
9209
                {
9210
                    m_lexer.get_number(result);
N
Niels 已提交
9211
                    get_token();
N
Niels 已提交
9212
                    break;
N
Niels 已提交
9213 9214 9215 9216
                }

                default:
                {
N
Niels 已提交
9217 9218
                    // the last token was unexpected
                    unexpect(last_token);
N
Niels 已提交
9219 9220
                }
            }
N
Niels 已提交
9221

N
Niels 已提交
9222
            if (keep and callback and not callback(depth, parse_event_t::value, result))
N
Niels 已提交
9223 9224 9225 9226
            {
                result = basic_json(value_t::discarded);
            }
            return result;
N
Niels 已提交
9227 9228 9229
        }

        /// get next token from lexer
N
cleanup  
Niels 已提交
9230
        typename lexer::token_type get_token()
N
Niels 已提交
9231 9232 9233 9234 9235
        {
            last_token = m_lexer.scan();
            return last_token;
        }

N
Niels 已提交
9236
        void expect(typename lexer::token_type t) const
N
Niels 已提交
9237 9238 9239
        {
            if (t != last_token)
            {
N
Niels 已提交
9240
                std::string error_msg = "parse error - unexpected ";
N
Niels 已提交
9241 9242
                error_msg += (last_token == lexer::token_type::parse_error ? ("'" +  m_lexer.get_token_string() +
                              "'") :
N
Niels 已提交
9243 9244
                              lexer::token_type_name(last_token));
                error_msg += "; expected " + lexer::token_type_name(t);
N
Niels 已提交
9245 9246 9247 9248
                throw std::invalid_argument(error_msg);
            }
        }

N
Niels 已提交
9249
        void unexpect(typename lexer::token_type t) const
N
Niels 已提交
9250 9251 9252
        {
            if (t == last_token)
            {
N
Niels 已提交
9253
                std::string error_msg = "parse error - unexpected ";
N
Niels 已提交
9254 9255
                error_msg += (last_token == lexer::token_type::parse_error ? ("'" +  m_lexer.get_token_string() +
                              "'") :
N
Niels 已提交
9256
                              lexer::token_type_name(last_token));
N
Niels 已提交
9257 9258 9259 9260
                throw std::invalid_argument(error_msg);
            }
        }

N
Niels 已提交
9261
      private:
N
Niels 已提交
9262
        /// current level of recursion
N
Niels 已提交
9263 9264
        int depth = 0;
        /// callback function
N
Niels 已提交
9265
        const parser_callback_t callback = nullptr;
N
Niels 已提交
9266
        /// the type of the last read token
N
Niels 已提交
9267
        typename lexer::token_type last_token = lexer::token_type::uninitialized;
N
Niels 已提交
9268
        /// the lexer
N
Niels 已提交
9269
        lexer m_lexer;
N
Niels 已提交
9270
    };
N
Niels 已提交
9271 9272

  public:
N
Niels 已提交
9273 9274 9275
    /*!
    @brief JSON Pointer

N
Niels 已提交
9276 9277 9278 9279
    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 已提交
9280
    @sa [RFC 6901](https://tools.ietf.org/html/rfc6901)
N
Niels 已提交
9281 9282

    @since version 2.0.0
N
Niels 已提交
9283
    */
N
Niels 已提交
9284 9285
    class json_pointer
    {
N
Niels 已提交
9286 9287 9288
        /// allow basic_json to access private members
        friend class basic_json;

N
Niels 已提交
9289
      public:
N
Niels 已提交
9290 9291 9292 9293 9294 9295 9296 9297 9298 9299
        /*!
        @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 已提交
9300 9301 9302 9303 9304 9305
        @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 已提交
9306 9307 9308

        @liveexample{The example shows the construction several valid JSON
        pointers as well as the exceptional behavior.,json_pointer}
N
Niels 已提交
9309

N
Niels 已提交
9310 9311 9312
        @since version 2.0.0
        */
        explicit json_pointer(const std::string& s = "")
N
Niels 已提交
9313 9314
            : reference_tokens(split(s))
        {}
N
Niels 已提交
9315

N
Niels 已提交
9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332
        /*!
        @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 已提交
9333 9334
            return std::accumulate(reference_tokens.begin(),
                                   reference_tokens.end(), std::string{},
N
Niels 已提交
9335
                                   [](const std::string & a, const std::string & b)
N
Niels 已提交
9336
            {
N
Niels 已提交
9337 9338
                return a + "/" + escape(b);
            });
N
Niels 已提交
9339 9340 9341 9342
        }

        /// @copydoc to_string()
        operator std::string() const
N
Niels 已提交
9343
        {
N
Niels 已提交
9344
            return to_string();
N
Niels 已提交
9345 9346
        }

N
Niels 已提交
9347
      private:
N
Niels 已提交
9348
        /// remove and return last reference pointer
N
Niels 已提交
9349 9350
        std::string pop_back()
        {
N
Niels 已提交
9351
            if (is_root())
N
Niels 已提交
9352 9353 9354 9355 9356 9357 9358 9359 9360
            {
                throw std::domain_error("JSON pointer has no parent");
            }

            auto last = reference_tokens.back();
            reference_tokens.pop_back();
            return last;
        }

N
Niels 已提交
9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378
        /// 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 已提交
9379 9380
        /*!
        @brief create and return a reference to the pointed to value
N
Niels 已提交
9381 9382

        @complexity Linear in the number of reference tokens.
N
Niels 已提交
9383 9384
        */
        reference get_and_create(reference j) const
N
Niels 已提交
9385
        {
9386
            pointer result = &j;
N
Niels 已提交
9387

N
Niels 已提交
9388 9389
            // in case no reference tokens exist, return a reference to the
            // JSON value j which will be overwritten by a primitive value
N
Niels 已提交
9390 9391
            for (const auto& reference_token : reference_tokens)
            {
9392
                switch (result->m_type)
N
Niels 已提交
9393
                {
N
Niels 已提交
9394 9395 9396 9397
                    case value_t::null:
                    {
                        if (reference_token == "0")
                        {
N
Niels 已提交
9398
                            // start a new array if reference token is 0
N
Niels 已提交
9399 9400 9401 9402
                            result = &result->operator[](0);
                        }
                        else
                        {
N
Niels 已提交
9403
                            // start a new object otherwise
N
Niels 已提交
9404 9405
                            result = &result->operator[](reference_token);
                        }
N
Niels 已提交
9406
                        break;
N
Niels 已提交
9407 9408
                    }

N
Niels 已提交
9409
                    case value_t::object:
N
Niels 已提交
9410
                    {
N
Niels 已提交
9411
                        // create an entry in the object
N
Niels 已提交
9412
                        result = &result->operator[](reference_token);
N
Niels 已提交
9413
                        break;
N
Niels 已提交
9414
                    }
N
Niels 已提交
9415 9416

                    case value_t::array:
N
Niels 已提交
9417
                    {
N
Niels 已提交
9418
                        // create an entry in the array
N
Niels 已提交
9419
                        result = &result->operator[](static_cast<size_type>(std::stoi(reference_token)));
N
Niels 已提交
9420
                        break;
N
Niels 已提交
9421
                    }
N
Niels 已提交
9422

N
Niels 已提交
9423
                    /*
N
Niels 已提交
9424 9425 9426 9427 9428
                    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 已提交
9429
                    */
N
Niels 已提交
9430
                    default:
N
Niels 已提交
9431
                    {
N
Niels 已提交
9432
                        throw std::domain_error("invalid value to unflatten");
N
Niels 已提交
9433
                    }
N
Niels 已提交
9434 9435 9436
                }
            }

9437 9438 9439
            return *result;
        }

N
Niels 已提交
9440 9441 9442
        /*!
        @brief return a reference to the pointed to value

N
Niels 已提交
9443 9444 9445 9446 9447 9448
        @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 已提交
9449 9450 9451 9452 9453 9454
        @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.

9455 9456 9457
        @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 已提交
9458 9459
        */
        reference get_unchecked(pointer ptr) const
N
Niels 已提交
9460
        {
N
Niels 已提交
9461 9462
            for (const auto& reference_token : reference_tokens)
            {
N
Niels 已提交
9463 9464
                // convert null values to arrays or objects before continuing
                if (ptr->m_type == value_t::null)
N
Niels 已提交
9465
                {
N
Niels 已提交
9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483
                    // 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 已提交
9484 9485
                }

N
Niels 已提交
9486 9487 9488 9489
                switch (ptr->m_type)
                {
                    case value_t::object:
                    {
9490
                        // use unchecked object access
N
Niels 已提交
9491 9492 9493 9494 9495 9496
                        ptr = &ptr->operator[](reference_token);
                        break;
                    }

                    case value_t::array:
                    {
N
Niels 已提交
9497 9498 9499 9500 9501 9502
                        // 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 已提交
9503 9504
                        if (reference_token == "-")
                        {
9505
                            // explicityly treat "-" as index beyond the end
N
Niels 已提交
9506 9507 9508 9509
                            ptr = &ptr->operator[](ptr->m_value.array->size());
                        }
                        else
                        {
9510
                            // convert array index to number; unchecked access
N
Niels 已提交
9511
                            ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
N
Niels 已提交
9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524
                        }
                        break;
                    }

                    default:
                    {
                        throw std::out_of_range("unresolved reference token '" + reference_token + "'");
                    }
                }
            }

            return *ptr;
        }
N
Niels 已提交
9525

N
Niels 已提交
9526 9527
        reference get_checked(pointer ptr) const
        {
N
Niels 已提交
9528 9529
            for (const auto& reference_token : reference_tokens)
            {
N
Niels 已提交
9530
                switch (ptr->m_type)
N
Niels 已提交
9531
                {
N
Niels 已提交
9532
                    case value_t::object:
N
Niels 已提交
9533
                    {
9534
                        // note: at performs range check
N
Niels 已提交
9535 9536 9537 9538 9539 9540 9541
                        ptr = &ptr->at(reference_token);
                        break;
                    }

                    case value_t::array:
                    {
                        if (reference_token == "-")
N
Niels 已提交
9542
                        {
9543 9544 9545 9546
                            // "-" 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 已提交
9547
                        }
9548 9549 9550

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
N
Niels 已提交
9551
                        {
9552
                            throw std::domain_error("array index must not begin with '0'");
N
Niels 已提交
9553
                        }
9554 9555

                        // note: at performs range check
N
Niels 已提交
9556
                        ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
N
Niels 已提交
9557 9558 9559 9560 9561 9562
                        break;
                    }

                    default:
                    {
                        throw std::out_of_range("unresolved reference token '" + reference_token + "'");
N
Niels 已提交
9563
                    }
N
Niels 已提交
9564 9565 9566 9567 9568 9569 9570 9571 9572 9573
                }
            }

            return *ptr;
        }

        /*!
        @brief return a const reference to the pointed to value

        @param[in] ptr  a JSON value
N
Niels 已提交
9574

N
Niels 已提交
9575 9576 9577 9578 9579 9580 9581 9582 9583
        @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 已提交
9584 9585
                    case value_t::object:
                    {
9586
                        // use unchecked object access
N
Niels 已提交
9587
                        ptr = &ptr->operator[](reference_token);
N
Niels 已提交
9588
                        break;
N
Niels 已提交
9589 9590 9591 9592
                    }

                    case value_t::array:
                    {
N
Niels 已提交
9593 9594
                        if (reference_token == "-")
                        {
9595
                            // "-" cannot be used for const access
N
Niels 已提交
9596 9597 9598 9599
                            throw std::out_of_range("array index '-' (" +
                                                    std::to_string(ptr->m_value.array->size()) +
                                                    ") is out of range");
                        }
9600 9601 9602 9603 9604 9605 9606 9607

                        // 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 已提交
9608
                        ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
N
Niels 已提交
9609
                        break;
N
Niels 已提交
9610 9611 9612 9613
                    }

                    default:
                    {
N
Niels 已提交
9614
                        throw std::out_of_range("unresolved reference token '" + reference_token + "'");
N
Niels 已提交
9615 9616 9617 9618
                    }
                }
            }

N
Niels 已提交
9619
            return *ptr;
N
Niels 已提交
9620 9621
        }

N
Niels 已提交
9622
        const_reference get_checked(const_pointer ptr) const
9623 9624 9625
        {
            for (const auto& reference_token : reference_tokens)
            {
N
Niels 已提交
9626
                switch (ptr->m_type)
9627 9628
                {
                    case value_t::object:
N
Niels 已提交
9629
                    {
9630
                        // note: at performs range check
N
Niels 已提交
9631
                        ptr = &ptr->at(reference_token);
N
Niels 已提交
9632
                        break;
N
Niels 已提交
9633
                    }
9634 9635

                    case value_t::array:
N
Niels 已提交
9636 9637 9638
                    {
                        if (reference_token == "-")
                        {
9639
                            // "-" always fails the range check
N
Niels 已提交
9640 9641 9642 9643
                            throw std::out_of_range("array index '-' (" +
                                                    std::to_string(ptr->m_value.array->size()) +
                                                    ") is out of range");
                        }
9644 9645 9646 9647 9648 9649 9650 9651

                        // 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 已提交
9652
                        ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
N
Niels 已提交
9653
                        break;
N
Niels 已提交
9654
                    }
9655 9656

                    default:
N
Niels 已提交
9657 9658 9659
                    {
                        throw std::out_of_range("unresolved reference token '" + reference_token + "'");
                    }
9660 9661 9662
                }
            }

N
Niels 已提交
9663
            return *ptr;
N
Niels 已提交
9664 9665 9666
        }

        /// split the string input to reference tokens
9667
        static std::vector<std::string> split(const std::string& reference_string)
N
Niels 已提交
9668
        {
N
Niels 已提交
9669 9670
            std::vector<std::string> result;

N
Niels 已提交
9671 9672 9673
            // special case: empty reference string -> no reference tokens
            if (reference_string.empty())
            {
N
Niels 已提交
9674
                return result;
N
Niels 已提交
9675 9676 9677 9678 9679 9680 9681 9682
            }

            // 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 已提交
9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693
            // 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 已提交
9694
                // (will eventually be 0 if slash == std::string::npos)
N
Niels 已提交
9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717
                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] == '~');

                    // ~ 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'");
                    }
                }
9718

N
Niels 已提交
9719
                // finally, store the reference token
N
Niels 已提交
9720
                unescape(reference_token);
N
Niels 已提交
9721
                result.push_back(reference_token);
9722
            }
N
Niels 已提交
9723 9724

            return result;
N
Niels 已提交
9725
        }
N
Niels 已提交
9726

N
Niels 已提交
9727
      private:
N
Niels 已提交
9728 9729 9730 9731 9732
        /*!
        @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 已提交
9733
        @param[in]     t  the string to replace @a f
N
Niels 已提交
9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755

        @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 已提交
9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773
        /// 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 已提交
9774 9775 9776 9777
        /*!
        @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 已提交
9778 9779

        @note Empty objects or arrays are flattened to `null`.
N
Niels 已提交
9780
        */
N
Niels 已提交
9781
        static void flatten(const std::string& reference_string,
N
Niels 已提交
9782 9783 9784 9785 9786 9787 9788
                            const basic_json& value,
                            basic_json& result)
        {
            switch (value.m_type)
            {
                case value_t::array:
                {
N
Niels 已提交
9789
                    if (value.m_value.array->empty())
N
Niels 已提交
9790
                    {
N
Niels 已提交
9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801
                        // 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 已提交
9802 9803 9804 9805 9806 9807
                    }
                    break;
                }

                case value_t::object:
                {
N
Niels 已提交
9808
                    if (value.m_value.object->empty())
N
Niels 已提交
9809
                    {
N
Niels 已提交
9810 9811 9812 9813 9814 9815 9816 9817
                        // 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 已提交
9818
                            flatten(reference_string + "/" + escape(element.first),
N
Niels 已提交
9819 9820
                                    element.second, result);
                        }
N
Niels 已提交
9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832
                    }
                    break;
                }

                default:
                {
                    // add primitive value with its reference string
                    result[reference_string] = value;
                    break;
                }
            }
        }
N
Niels 已提交
9833 9834 9835 9836

        /*!
        @param[in] value  flattened JSON

N
Niels 已提交
9837
        @return unflattened JSON
N
Niels 已提交
9838
        */
N
Niels 已提交
9839
        static basic_json unflatten(const basic_json& value)
N
Niels 已提交
9840 9841 9842
        {
            if (not value.is_object())
            {
N
Niels 已提交
9843
                throw std::domain_error("only objects can be unflattened");
N
Niels 已提交
9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855
            }

            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 已提交
9856 9857 9858 9859 9860
                // 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 已提交
9861
                json_pointer(element.first).get_and_create(result) = element.second;
N
Niels 已提交
9862 9863 9864 9865
            }

            return result;
        }
N
Niels 已提交
9866 9867 9868

      private:
        /// the reference tokens
N
Niels 已提交
9869
        std::vector<std::string> reference_tokens {};
N
Niels 已提交
9870
    };
N
Niels 已提交
9871

N
Niels 已提交
9872 9873 9874
    //////////////////////////
    // JSON Pointer support //
    //////////////////////////
N
Niels 已提交
9875 9876 9877 9878

    /// @name JSON Pointer functions
    /// @{

N
Niels 已提交
9879 9880 9881 9882
    /*!
    @brief access specified element via JSON Pointer

    Uses a JSON pointer to retrieve a reference to the respective JSON value.
N
Niels 已提交
9883 9884 9885
    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 已提交
9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971

    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 已提交
9972 9973
    Returns a const reference to the element at with specified JSON pointer @a
    ptr, with bounds checking.
N
Niels 已提交
9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993

    @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 已提交
9994
    /*!
N
Niels 已提交
9995 9996
    @brief return flattened JSON value

N
Niels 已提交
9997 9998 9999 10000
    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 已提交
10001

N
Niels 已提交
10002
    @return an object that maps JSON pointers to primitve values
N
Niels 已提交
10003

N
Niels 已提交
10004 10005
    @note Empty objects and arrays are flattened to `null` and will not be
          reconstructed correctly by the @ref unflatten() function.
N
Niels 已提交
10006 10007 10008 10009 10010 10011 10012 10013 10014

    @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 已提交
10015 10016 10017 10018 10019 10020 10021
    */
    basic_json flatten() const
    {
        basic_json result(value_t::object);
        json_pointer::flatten("", *this, result);
        return result;
    }
N
Niels 已提交
10022 10023

    /*!
N
Niels 已提交
10024 10025 10026 10027 10028 10029 10030 10031 10032 10033
    @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 已提交
10034
    @return the original JSON from a flattened version
N
Niels 已提交
10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048

    @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 已提交
10049
    */
N
Niels 已提交
10050
    basic_json unflatten() const
N
Niels 已提交
10051
    {
N
Niels 已提交
10052
        return json_pointer::unflatten(*this);
N
Niels 已提交
10053
    }
N
Niels 已提交
10054 10055

    /// @}
10056

N
Niels 已提交
10057 10058 10059 10060 10061 10062 10063
    //////////////////////////
    // JSON Patch functions //
    //////////////////////////

    /// @name JSON Patch functions
    /// @{

10064 10065 10066
    /*!
    @brief applies a JSON patch

N
Niels 已提交
10067 10068 10069 10070 10071
    [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 已提交
10072
    @param[in] json_patch  JSON patch document
10073 10074
    @return patched document

N
Niels 已提交
10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088
    @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"`

    @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.
10089

N
Niels 已提交
10090 10091 10092 10093 10094 10095 10096 10097 10098
    @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
10099
    */
N
Niels 已提交
10100
    basic_json patch(const basic_json& json_patch) const
10101
    {
N
Niels 已提交
10102
        // make a working copy to apply the patch to
10103 10104
        basic_json result = *this;

N
Niels 已提交
10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137
        // 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 已提交
10138
        // wrapper for "add" operation; add value at ptr
N
Niels 已提交
10139
        const auto operation_add = [&result](json_pointer & ptr, basic_json val)
N
Niels 已提交
10140
        {
N
Niels 已提交
10141 10142
            // adding to the root of the target document means replacing it
            if (ptr.is_root())
N
Niels 已提交
10143
            {
N
Niels 已提交
10144
                result = val;
N
Niels 已提交
10145
            }
N
Niels 已提交
10146
            else
N
Niels 已提交
10147
            {
N
Niels 已提交
10148 10149 10150
                // make sure the top element of the pointer exists
                json_pointer top_pointer = ptr.top();
                if (top_pointer != ptr)
N
Niels 已提交
10151
                {
N
Niels 已提交
10152
                    result.at(top_pointer);
N
Niels 已提交
10153
                }
N
Niels 已提交
10154 10155 10156 10157 10158 10159

                // 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 已提交
10160
                {
N
Niels 已提交
10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192 10193 10194
                    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 已提交
10195 10196
                        // if there exists a parent it cannot be primitive
                        assert(false);  // LCOV_EXCL_LINE
N
Niels 已提交
10197
                    }
N
Niels 已提交
10198 10199 10200 10201
                }
            }
        };

N
Niels 已提交
10202
        // wrapper for "remove" operation; remove value at ptr
N
Niels 已提交
10203 10204
        const auto operation_remove = [&result](json_pointer & ptr)
        {
N
Niels 已提交
10205
            // get reference to parent of JSON pointer ptr
N
Niels 已提交
10206 10207
            const auto last_path = ptr.pop_back();
            basic_json& parent = result.at(ptr);
N
Niels 已提交
10208 10209

            // remove child
N
Niels 已提交
10210 10211
            if (parent.is_object())
            {
N
Niels 已提交
10212 10213 10214 10215 10216 10217 10218 10219 10220 10221
                // 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 已提交
10222 10223 10224
            }
            else if (parent.is_array())
            {
N
Niels 已提交
10225 10226
                // note erase performs range check
                parent.erase(static_cast<size_type>(std::stoi(last_path)));
N
Niels 已提交
10227 10228 10229
            }
        };

N
Niels 已提交
10230
        // type check
N
Niels 已提交
10231
        if (not json_patch.is_array())
N
Niels 已提交
10232 10233
        {
            // a JSON patch must be an array of objects
N
Niels 已提交
10234
            throw std::invalid_argument("JSON patch must be an array of objects");
N
Niels 已提交
10235 10236 10237
        }

        // iterate and apply th eoperations
N
Niels 已提交
10238
        for (const auto& val : json_patch)
10239
        {
N
Niels 已提交
10240 10241 10242
            // wrapper to get a value for an operation
            const auto get_value = [&val](const std::string & op,
                                          const std::string & member,
N
Niels 已提交
10243
                                          bool string_type) -> basic_json&
10244
            {
N
Niels 已提交
10245 10246
                // find value
                auto it = val.m_value.object->find(member);
10247

N
Niels 已提交
10248 10249
                // context-sensitive error message
                const auto error_msg = (op == "op") ? "operation" : "operation '" + op + "'";
10250

N
Niels 已提交
10251 10252 10253
                // check if desired value is present
                if (it == val.m_value.object->end())
                {
N
Niels 已提交
10254
                    throw std::invalid_argument(error_msg + " must have member '" + member + "'");
N
Niels 已提交
10255
                }
10256

N
Niels 已提交
10257 10258 10259
                // check if result is of type string
                if (string_type and not it->second.is_string())
                {
N
Niels 已提交
10260
                    throw std::invalid_argument(error_msg + " must have string member '" + member + "'");
N
Niels 已提交
10261 10262 10263 10264 10265 10266 10267 10268
                }

                // no error: return value
                return it->second;
            };

            // type check
            if (not val.is_object())
10269
            {
N
Niels 已提交
10270
                throw std::invalid_argument("JSON patch must be an array of objects");
10271 10272
            }

N
Niels 已提交
10273 10274 10275
            // collect mandatory members
            const std::string op = get_value("op", "op", true);
            const std::string path = get_value(op, "path", true);
N
oops  
Niels 已提交
10276
            json_pointer ptr(path);
10277

N
Niels 已提交
10278
            switch (get_op(op))
10279
            {
N
Niels 已提交
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 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348 10349 10350 10351 10352 10353 10354
                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");
                }
10355
            }
N
Niels 已提交
10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393 10394
        }

        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,
10395
                           const std::string& path = "")
N
Niels 已提交
10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409
    {
        // 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(
10410
            {
N
Niels 已提交
10411 10412 10413 10414 10415 10416 10417 10418
                {"op", "replace"},
                {"path", path},
                {"value", target}
            });
        }
        else
        {
            switch (source.type())
10419
            {
N
Niels 已提交
10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430
                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 已提交
10431

N
Niels 已提交
10432 10433
                    // i now reached the end of at least one array
                    // in a second pass, traverse the remaining elements
N
Niels 已提交
10434

N
Niels 已提交
10435
                    // remove my remaining elements
N
Niels 已提交
10436
                    const auto end_index = static_cast<difference_type>(result.size());
N
Niels 已提交
10437 10438
                    while (i < source.size())
                    {
N
Niels 已提交
10439 10440
                        // add operations in reverse order to avoid invalid
                        // indices
N
Niels 已提交
10441
                        result.insert(result.begin() + end_index, object(
N
Niels 已提交
10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464
                        {
                            {"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:
10465
                {
N
Niels 已提交
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 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517
                    // 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;
10518 10519 10520 10521 10522 10523
                }
            }
        }

        return result;
    }
N
Niels 已提交
10524 10525

    /// @}
N
Niels 已提交
10526 10527 10528 10529 10530 10531 10532
};


/////////////
// presets //
/////////////

N
Niels 已提交
10533 10534 10535
/*!
@brief default JSON class

N
Niels 已提交
10536 10537
This type is the default specialization of the @ref basic_json class which
uses the standard template types.
N
Niels 已提交
10538

N
Niels 已提交
10539
@since version 1.0.0
N
Niels 已提交
10540
*/
N
Niels 已提交
10541 10542 10543 10544
using json = basic_json<>;
}


N
Niels 已提交
10545 10546 10547
///////////////////////
// nonmember support //
///////////////////////
N
Niels 已提交
10548 10549 10550 10551

// specialization of std::swap, and std::hash
namespace std
{
N
Niels 已提交
10552 10553
/*!
@brief exchanges the values of two JSON objects
N
Niels 已提交
10554

N
Niels 已提交
10555
@since version 1.0.0
N
Niels 已提交
10556
*/
N
Niels 已提交
10557
template<>
N
Niels 已提交
10558 10559 10560 10561 10562 10563 10564 10565 10566 10567
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 已提交
10568
template<>
N
Niels 已提交
10569 10570
struct hash<nlohmann::json>
{
N
Niels 已提交
10571 10572 10573
    /*!
    @brief return a hash value for a JSON object

N
Niels 已提交
10574
    @since version 1.0.0
N
Niels 已提交
10575
    */
N
Niels 已提交
10576
    std::size_t operator()(const nlohmann::json& j) const
N
Niels 已提交
10577 10578
    {
        // a naive hashing via the string representation
N
Niels 已提交
10579 10580
        const auto& h = hash<nlohmann::json::string_t>();
        return h(j.dump());
N
Niels 已提交
10581 10582 10583 10584 10585
    }
};
}

/*!
N
Niels 已提交
10586 10587
@brief user-defined string literal for JSON values

N
Niels 已提交
10588
This operator implements a user-defined string literal for JSON objects. It
N
Niels 已提交
10589
can be used by adding `"_json"` to a string literal and returns a JSON object
N
Niels 已提交
10590
if no parse error occurred.
N
Niels 已提交
10591

N
Niels 已提交
10592
@param[in] s  a string representation of a JSON object
N
Niels 已提交
10593
@return a JSON object
N
Niels 已提交
10594

N
Niels 已提交
10595
@since version 1.0.0
N
Niels 已提交
10596
*/
N
Niels 已提交
10597
inline nlohmann::json operator "" _json(const char* s, std::size_t)
N
Niels 已提交
10598
{
N
Niels 已提交
10599
    return nlohmann::json::parse(s);
N
Niels 已提交
10600 10601
}

N
Niels 已提交
10602 10603 10604
/*!
@brief user-defined string literal for JSON pointer

N
Niels 已提交
10605
This operator implements a user-defined string literal for JSON Pointers. It
N
Niels 已提交
10606
can be used by adding `"_json_pointer"` to a string literal and returns a JSON pointer
N
Niels 已提交
10607 10608 10609 10610 10611
object if no parse error occurred.

@param[in] s  a string representation of a JSON Pointer
@return a JSON pointer object

N
Niels 已提交
10612 10613 10614 10615 10616 10617 10618
@since version 2.0.0
*/
inline nlohmann::json::json_pointer operator "" _json_pointer(const char* s, std::size_t)
{
    return nlohmann::json::json_pointer(s);
}

10619 10620 10621 10622 10623
// restore GCC/clang diagnostic settings
#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
    #pragma GCC diagnostic pop
#endif

N
Niels 已提交
10624
#endif