json.hpp 347.2 KB
Newer Older
1 2 3
/*
    __ _____ _____ _____
 __|  |   __|     |   | |  JSON for Modern C++
N
Niels 已提交
4
|  |  |__   |  |  | | | |  version 2.0.5
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 <ciso646>
N
Niels 已提交
36
#include <cmath>
N
Niels 已提交
37
#include <cstddef>
38
#include <cstdint>
N
Niels 已提交
39
#include <cstdlib>
N
cleanup  
Niels 已提交
40
#include <cstring>
N
Niels 已提交
41 42
#include <functional>
#include <initializer_list>
N
Niels 已提交
43
#include <iomanip>
N
Niels 已提交
44 45 46
#include <iostream>
#include <iterator>
#include <limits>
N
Niels 已提交
47
#include <locale>
N
Niels 已提交
48 49
#include <map>
#include <memory>
N
Niels 已提交
50
#include <numeric>
N
Niels 已提交
51
#include <sstream>
N
Niels 已提交
52
#include <stdexcept>
N
Niels 已提交
53 54 55 56 57
#include <string>
#include <type_traits>
#include <utility>
#include <vector>

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

71 72 73 74 75 76
// 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 已提交
77 78 79 80 81 82 83 84 85
// 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 已提交
86
/*!
N
Niels 已提交
87
@brief namespace for Niels Lohmann
N
Niels 已提交
88
@see https://github.com/nlohmann
N
Niels 已提交
89
@since version 1.0.0
N
Niels 已提交
90 91 92 93
*/
namespace nlohmann
{

N
Niels 已提交
94

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

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.

108
@sa http://stackoverflow.com/a/7728728/266378
N
Niels 已提交
109
@since version 1.0.0
110
*/
N
Niels 已提交
111
template<typename T>
N
Niels 已提交
112
struct has_mapped_type
N
Niels 已提交
113 114
{
  private:
N
Niels 已提交
115
    template<typename C> static char test(typename C::mapped_type*);
N
Niels 已提交
116
    template<typename C> static char (&test(...))[2];
N
Niels 已提交
117
  public:
N
Niels 已提交
118
    static constexpr bool value = sizeof(test<T>(0)) == 1;
N
Niels 已提交
119
};
120

N
Niels 已提交
121 122
/*!
@brief helper class to create locales with decimal point
N
Niels 已提交
123 124 125 126 127 128 129

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 已提交
130
@sa https://github.com/nlohmann/json/issues/51#issuecomment-86869315
N
Niels 已提交
131
@since version 2.0.0
N
Niels 已提交
132
*/
N
Niels 已提交
133
struct DecimalSeparator : std::numpunct<char>
N
Niels 已提交
134 135 136 137 138 139 140
{
    char do_decimal_point() const
    {
        return '.';
    }
};

N
Niels 已提交
141
}
N
Niels 已提交
142

N
Niels 已提交
143
/*!
N
Niels 已提交
144
@brief a class to store JSON values
N
Niels 已提交
145

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

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

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

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

N
Niels 已提交
217
@since version 1.0.0
N
Niels 已提交
218 219

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

  public:
N
Niels 已提交
240 241 242
    // forward declarations
    template<typename Base> class json_reverse_iterator;
    class json_pointer;
243

N
Niels 已提交
244 245 246 247
    /////////////////////
    // container types //
    /////////////////////

N
Niels 已提交
248
    /// @name container types
N
Niels 已提交
249 250
    /// The canonic container types to use @ref basic_json like any other STL
    /// container.
N
Niels 已提交
251 252
    /// @{

N
Niels 已提交
253
    /// the type of elements in a basic_json container
N
Niels 已提交
254
    using value_type = basic_json;
N
Niels 已提交
255

N
Niels 已提交
256
    /// the type of an element reference
N
Niels 已提交
257
    using reference = value_type&;
N
Niels 已提交
258
    /// the type of an element const reference
N
Niels 已提交
259
    using const_reference = const value_type&;
N
Niels 已提交
260

N
Niels 已提交
261
    /// a type to represent differences between iterators
N
Niels 已提交
262
    using difference_type = std::ptrdiff_t;
N
Niels 已提交
263
    /// a type to represent container sizes
N
Niels 已提交
264 265 266
    using size_type = std::size_t;

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

N
Niels 已提交
269
    /// the type of an element pointer
N
Niels 已提交
270
    using pointer = typename std::allocator_traits<allocator_type>::pointer;
N
Niels 已提交
271
    /// the type of an element const pointer
N
Niels 已提交
272
    using const_pointer = typename std::allocator_traits<allocator_type>::const_pointer;
N
Niels 已提交
273

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

N
Niels 已提交
283 284 285
    /// @}


N
Niels 已提交
286 287 288
    /*!
    @brief returns the allocator associated with the container
    */
N
Niels 已提交
289
    static allocator_type get_allocator()
N
Niels 已提交
290 291 292 293 294
    {
        return allocator_type();
    }


N
Niels 已提交
295 296 297 298
    ///////////////////////////
    // JSON value data types //
    ///////////////////////////

N
Niels 已提交
299
    /// @name JSON value data types
N
Niels 已提交
300 301
    /// The data types to store a JSON value. These types are derived from
    /// the template arguments passed to class @ref basic_json.
N
Niels 已提交
302 303
    /// @{

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

    #### Default type

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

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

    #### Storage

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

375 376
    @sa @ref array_t -- type for an array value

N
Niels 已提交
377
    @since version 1.0.0
N
Niels 已提交
378

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

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

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

    #### Storage

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

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

N
Niels 已提交
435
    @since version 1.0.0
N
Niels 已提交
436
    */
N
Niels 已提交
437
    using array_t = ArrayType<basic_json, AllocatorType<basic_json>>;
N
Niels 已提交
438 439 440 441 442 443 444

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

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

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

478 479
    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 已提交
480
    dereferenced.
481

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

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

506 507
    Boolean values are stored directly inside a @ref basic_json type.

N
Niels 已提交
508
    @since version 1.0.0
N
Niels 已提交
509
    */
N
Niels 已提交
510
    using boolean_t = BooleanType;
N
Niels 已提交
511 512 513 514 515

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

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

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

    [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

574 575 576 577
    Integer number values are stored directly inside a @ref basic_json type.

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

578 579
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
580
    @since version 1.0.0
N
Niels 已提交
581
    */
N
Niels 已提交
582
    using number_integer_t = NumberIntegerType;
N
Niels 已提交
583

584 585 586 587
    /*!
    @brief a type for a number (unsigned)

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

    #### Default type

N
Niels 已提交
607 608
    With the default values for @a NumberUnsignedType (`uint64_t`), the
    default value for @a number_unsigned_t is:
609 610 611 612 613 614 615 616 617 618

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

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

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

N
Niels 已提交
655 656 657 658
    /*!
    @brief a type for a number (floating-point)

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

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

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

    #### Storage

712 713 714 715 716
    Floating-point number values are stored directly inside a @ref basic_json
    type.

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

717 718
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
719
    @since version 1.0.0
N
Niels 已提交
720
    */
N
Niels 已提交
721 722
    using number_float_t = NumberFloatType;

N
Niels 已提交
723 724
    /// @}

N
Niels 已提交
725

N
Niels 已提交
726 727 728
    ///////////////////////////
    // JSON type enumeration //
    ///////////////////////////
N
Niels 已提交
729

N
Niels 已提交
730
    /*!
N
Niels 已提交
731
    @brief the JSON type enumeration
N
Niels 已提交
732

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

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

N
Niels 已提交
765

N
Niels 已提交
766
  private:
N
Niels 已提交
767

N
Cleanup  
Niels 已提交
768 769
    /// helper for exception-safe object creation
    template<typename T, typename... Args>
N
cleanup  
Niels 已提交
770
    static T* create(Args&& ... args)
N
Cleanup  
Niels 已提交
771 772 773 774 775 776 777 778
    {
        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 已提交
779
        assert(object.get() != nullptr);
N
Cleanup  
Niels 已提交
780 781 782
        return object.release();
    }

N
Niels 已提交
783 784 785 786
    ////////////////////////
    // JSON value storage //
    ////////////////////////

787 788 789
    /*!
    @brief a JSON value

N
Niels 已提交
790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
    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.
808

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

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

849
                case value_t::array:
N
Niels 已提交
850
                {
N
Cleanup  
Niels 已提交
851
                    array = create<array_t>();
N
Niels 已提交
852 853
                    break;
                }
N
Niels 已提交
854

855
                case value_t::string:
N
Niels 已提交
856
                {
N
Cleanup  
Niels 已提交
857
                    string = create<string_t>("");
N
Niels 已提交
858 859
                    break;
                }
N
Niels 已提交
860

861
                case value_t::boolean:
N
Niels 已提交
862 863 864 865 866
                {
                    boolean = boolean_t(false);
                    break;
                }

867
                case value_t::number_integer:
N
Niels 已提交
868 869 870 871
                {
                    number_integer = number_integer_t(0);
                    break;
                }
N
Niels 已提交
872

873 874 875 876 877
                case value_t::number_unsigned:
                {
                    number_unsigned = number_unsigned_t(0);
                    break;
                }
N
Niels 已提交
878

879
                case value_t::number_float:
N
Niels 已提交
880 881 882 883
                {
                    number_float = number_float_t(0.0);
                    break;
                }
884 885 886 887 888

                default:
                {
                    break;
                }
N
Niels 已提交
889 890
            }
        }
N
Niels 已提交
891 892

        /// constructor for strings
N
Niels 已提交
893
        json_value(const string_t& value)
N
Niels 已提交
894
        {
N
Cleanup  
Niels 已提交
895
            string = create<string_t>(value);
N
Niels 已提交
896 897 898
        }

        /// constructor for objects
N
Niels 已提交
899
        json_value(const object_t& value)
N
Niels 已提交
900
        {
N
Cleanup  
Niels 已提交
901
            object = create<object_t>(value);
N
Niels 已提交
902 903 904
        }

        /// constructor for arrays
N
Niels 已提交
905
        json_value(const array_t& value)
N
Niels 已提交
906
        {
N
Cleanup  
Niels 已提交
907
            array = create<array_t>(value);
N
Niels 已提交
908
        }
N
Niels 已提交
909 910
    };

911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
    /*!
    @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 已提交
926 927

  public:
N
Niels 已提交
928 929 930 931
    //////////////////////////
    // JSON parser callback //
    //////////////////////////

N
Niels 已提交
932 933 934 935 936
    /*!
    @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.
937

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

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

N
Niels 已提交
958 959 960 961
    /*!
    @brief per-element parser callback type

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

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

N
Niels 已提交
985 986
    Discarding a value (i.e., returning `false`) has different effects
    depending on the context in which function was called:
N
Niels 已提交
987 988 989

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

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

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

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

N
Niels 已提交
1014 1015 1016 1017 1018

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

N
Niels 已提交
1019
    /// @name constructors and destructors
N
Niels 已提交
1020 1021
    /// Constructors of class @ref basic_json, copy/move constructor, copy
    /// assignment, static functions creating objects, and the destructor.
N
Niels 已提交
1022 1023
    /// @{

N
Niels 已提交
1024 1025 1026
    /*!
    @brief create an empty value with a given type

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

1039
    @param[in] value_type  the type of the value to create
N
Niels 已提交
1040 1041 1042

    @complexity Constant.

N
Niels 已提交
1043
    @throw std::bad_alloc if allocation for object, array, or string value
N
Niels 已提交
1044
    fails
N
Niels 已提交
1045 1046 1047

    @liveexample{The following code shows the constructor for different @ref
    value_t values,basic_json__value_t}
1048 1049 1050 1051 1052 1053

    @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 已提交
1054 1055 1056 1057
    @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
1058 1059
    @sa @ref basic_json(const number_unsigned_t) -- create a number (unsigned)
    value
1060

N
Niels 已提交
1061
    @since version 1.0.0
N
Niels 已提交
1062
    */
1063 1064
    basic_json(const value_t value_type)
        : m_type(value_type), m_value(value_type)
1065 1066 1067
    {
        assert_invariant();
    }
N
Niels 已提交
1068

N
Niels 已提交
1069
    /*!
N
Niels 已提交
1070
    @brief create a null object
N
Niels 已提交
1071

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

    @complexity Constant.

N
Niels 已提交
1079 1080 1081
    @exceptionsafety No-throw guarantee: this constructor never throws
    exceptions.

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

N
Niels 已提交
1085
    @since version 1.0.0
N
Niels 已提交
1086
    */
N
Niels 已提交
1087
    basic_json(std::nullptr_t = nullptr) noexcept
N
Niels 已提交
1088
        : basic_json(value_t::null)
1089 1090 1091
    {
        assert_invariant();
    }
N
Niels 已提交
1092

N
Niels 已提交
1093 1094 1095 1096 1097
    /*!
    @brief create an object (explicit)

    Create an object JSON value with a given content.

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

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

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

N
Niels 已提交
1104 1105
    @liveexample{The following code shows the constructor with an @ref
    object_t parameter.,basic_json__object_t}
N
Niels 已提交
1106

1107 1108 1109
    @sa @ref basic_json(const CompatibleObjectType&) -- create an object value
    from a compatible STL container

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

N
Niels 已提交
1118 1119 1120 1121
    /*!
    @brief create an object (implicit)

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

N
Niels 已提交
1125 1126 1127 1128 1129
    @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 已提交
1130

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

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

N
Niels 已提交
1135
    @throw std::bad_alloc if allocation for object value fails
N
Niels 已提交
1136 1137 1138 1139

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

1140 1141
    @sa @ref basic_json(const object_t&) -- create an object value

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

N
Niels 已提交
1156 1157 1158 1159 1160
    /*!
    @brief create an array (explicit)

    Create an array JSON value with a given content.

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

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

N
Niels 已提交
1165
    @throw std::bad_alloc if allocation for array value fails
N
Niels 已提交
1166 1167 1168 1169

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

1170 1171 1172
    @sa @ref basic_json(const CompatibleArrayType&) -- create an array value
    from a compatible STL containers

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

N
Niels 已提交
1181 1182 1183 1184
    /*!
    @brief create an array (implicit)

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

N
Niels 已提交
1188 1189 1190 1191 1192
    @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 已提交
1193

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

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

N
Niels 已提交
1198
    @throw std::bad_alloc if allocation for array value fails
N
Niels 已提交
1199 1200 1201 1202

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

1203 1204
    @sa @ref basic_json(const array_t&) -- create an array value

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

N
Niels 已提交
1224 1225 1226 1227 1228
    /*!
    @brief create a string (explicit)

    Create an string JSON value with a given content.

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

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

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

N
Niels 已提交
1235 1236
    @liveexample{The following code shows the constructor with an @ref
    string_t parameter.,basic_json__string_t}
N
Niels 已提交
1237

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

N
Niels 已提交
1251 1252 1253
    /*!
    @brief create a string (explicit)

N
Niels 已提交
1254
    Create a string JSON value with a given content.
N
Niels 已提交
1255

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

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

N
Niels 已提交
1260
    @throw std::bad_alloc if allocation for string value fails
N
Niels 已提交
1261 1262 1263 1264

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

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

N
Niels 已提交
1277 1278 1279 1280 1281
    /*!
    @brief create a string (implicit)

    Create a string JSON value with a given content.

1282
    @param[in] val  a value for the string
N
Niels 已提交
1283 1284

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

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

N
Niels 已提交
1289
    @throw std::bad_alloc if allocation for string value fails
N
Niels 已提交
1290 1291 1292 1293

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

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

N
Niels 已提交
1308 1309 1310 1311 1312
    /*!
    @brief create a boolean (explicit)

    Creates a JSON boolean type from a given value.

1313
    @param[in] val  a boolean value to store
N
Niels 已提交
1314 1315 1316 1317 1318

    @complexity Constant.

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

N
Niels 已提交
1320
    @since version 1.0.0
N
Niels 已提交
1321
    */
N
Niels 已提交
1322
    basic_json(boolean_t val) noexcept
1323
        : m_type(value_t::boolean), m_value(val)
1324 1325 1326
    {
        assert_invariant();
    }
N
Niels 已提交
1327

N
Niels 已提交
1328 1329 1330
    /*!
    @brief create an integer number (explicit)

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

N
Niels 已提交
1333
    @tparam T A helper type to remove this function via SFINAE in case @ref
N
Niels 已提交
1334 1335 1336
    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 已提交
1337

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

N
Niels 已提交
1340 1341
    @complexity Constant.

N
Niels 已提交
1342
    @liveexample{The example below shows the construction of an integer
N
Niels 已提交
1343
    number value.,basic_json__number_integer_t}
N
Niels 已提交
1344

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

N
Niels 已提交
1360
    /*!
N
Niels 已提交
1361 1362
    @brief create an integer number from an enum type (explicit)

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

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

N
Niels 已提交
1367 1368 1369
    @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 已提交
1370 1371
    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 已提交
1372 1373 1374

    @complexity Constant.

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

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

N
Niels 已提交
1392 1393 1394
    /*!
    @brief create an integer number (implicit)

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

N
Niels 已提交
1399
    @tparam CompatibleNumberIntegerType An integer type which is compatible to
N
Niels 已提交
1400 1401
    @ref number_integer_t. Examples include the types `int`, `int32_t`,
    `long`, and `short`.
N
Niels 已提交
1402

1403
    @param[in] val  an integer to create a JSON number from
N
Niels 已提交
1404 1405 1406

    @complexity Constant.

N
Niels 已提交
1407 1408
    @liveexample{The example below shows the construction of several integer
    number values from compatible
N
Niels 已提交
1409 1410
    types.,basic_json__CompatibleIntegerNumberType}

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

1429 1430 1431 1432 1433
    /*!
    @brief create an unsigned integer number (explicit)

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

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

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

1455 1456 1457
    /*!
    @brief create an unsigned number (implicit)

N
Niels 已提交
1458 1459 1460
    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.
1461

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

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

N
Niels 已提交
1487 1488 1489 1490 1491
    /*!
    @brief create a floating-point number (explicit)

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

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

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

N
Niels 已提交
1501
    @complexity Constant.
N
Niels 已提交
1502 1503 1504

    @liveexample{The following example creates several floating-point
    values.,basic_json__number_float_t}
1505 1506 1507 1508

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

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

        assert_invariant();
N
Niels 已提交
1522
    }
N
Niels 已提交
1523

N
Niels 已提交
1524 1525 1526 1527
    /*!
    @brief create an floating-point number (implicit)

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

N
Niels 已提交
1531 1532 1533
    @tparam CompatibleNumberFloatType A floating-point type which is
    compatible to @ref number_float_t. Examples may include the types `float`
    or `double`.
N
Niels 已提交
1534

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

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

    @complexity Constant.

N
Niels 已提交
1546
    @liveexample{The example below shows the construction of several
N
Niels 已提交
1547 1548 1549
    floating-point number values from compatible
    types.,basic_json__CompatibleNumberFloatType}

1550 1551 1552
    @sa @ref basic_json(const number_float_t) -- create a number value
    (floating-point)

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

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

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

N
Niels 已提交
1590 1591
    With the rules described above, the following JSON values cannot be
    expressed by an initializer list:
N
Niels 已提交
1592

N
Niels 已提交
1593 1594 1595 1596 1597
    - 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 已提交
1598 1599 1600 1601 1602

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

N
Niels 已提交
1605 1606 1607
    @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 已提交
1608 1609
    used by the functions @ref array(std::initializer_list<basic_json>) and
    @ref object(std::initializer_list<basic_json>).
N
Niels 已提交
1610

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

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

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

N
Niels 已提交
1626
    @sa @ref array(std::initializer_list<basic_json>) -- create a JSON array
1627
    value from an initializer list
N
Niels 已提交
1628
    @sa @ref object(std::initializer_list<basic_json>) -- create a JSON object
1629 1630
    value from an initializer list

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

        // 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)
            {
1651
                is_an_object = false;
N
Niels 已提交
1652 1653 1654
            }

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

1661
        if (is_an_object)
N
Niels 已提交
1662 1663 1664
        {
            // the initializer list is a list of pairs -> create object
            m_type = value_t::object;
N
Niels 已提交
1665
            m_value = value_t::object;
N
Niels 已提交
1666

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

        assert_invariant();
N
Niels 已提交
1680 1681
    }

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

N
Niels 已提交
1699
    @param[in] init  initializer list with JSON values to create an array from
N
Niels 已提交
1700 1701 1702 1703 1704 1705
    (optional)

    @return JSON array value

    @complexity Linear in the size of @a init.

N
Niels 已提交
1706
    @liveexample{The following code shows an example for the `array`
N
Niels 已提交
1707 1708
    function.,array}

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

N
Niels 已提交
1722 1723 1724 1725
    /*!
    @brief explicitly create an object from an initializer list

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

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

N
Niels 已提交
1736
    @param[in] init  initializer list to create an object from (optional)
N
Niels 已提交
1737 1738 1739 1740

    @return JSON object value

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

    @complexity Linear in the size of @a init.

N
Niels 已提交
1746
    @liveexample{The following code shows an example for the `object`
N
Niels 已提交
1747 1748
    function.,object}

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

N
Niels 已提交
1762 1763 1764
    /*!
    @brief construct an array with count copies of given value

N
Niels 已提交
1765 1766
    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,
1767
    `std::distance(begin(),end()) == cnt` holds.
N
Niels 已提交
1768

1769 1770
    @param[in] cnt  the number of JSON copies of @a val to create
    @param[in] val  the JSON value to copy
N
Niels 已提交
1771

1772
    @complexity Linear in @a cnt.
N
Niels 已提交
1773 1774 1775 1776

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

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

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

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

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

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

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

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

N
Niels 已提交
1838 1839 1840
        // copy type from first iterator
        m_type = first.m_object->m_type;

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

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

            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 已提交
1891
                m_value = *first.m_object->m_value.string;
N
Niels 已提交
1892 1893 1894 1895 1896
                break;
            }

            case value_t::object:
            {
N
Cleanup  
Niels 已提交
1897
                m_value.object = create<object_t>(first.m_it.object_iterator, last.m_it.object_iterator);
N
Niels 已提交
1898 1899 1900 1901 1902
                break;
            }

            case value_t::array:
            {
N
Cleanup  
Niels 已提交
1903
                m_value.array = create<array_t>(first.m_it.array_iterator, last.m_it.array_iterator);
N
Niels 已提交
1904 1905 1906 1907 1908
                break;
            }

            default:
            {
N
Niels 已提交
1909
                throw std::domain_error("cannot use construct with iterators from " + first.m_object->type_name());
N
Niels 已提交
1910 1911
            }
        }
1912 1913

        assert_invariant();
N
Niels 已提交
1914 1915
    }

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

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

N
Niels 已提交
1951 1952 1953 1954
    ///////////////////////////////////////
    // other constructors and destructor //
    ///////////////////////////////////////

N
Niels 已提交
1955 1956
    /*!
    @brief copy constructor
N
Niels 已提交
1957

N
Niels 已提交
1958 1959
    Creates a copy of a given JSON value.

N
Niels 已提交
1960
    @param[in] other  the JSON value to copy
N
Niels 已提交
1961 1962 1963

    @complexity Linear in the size of @a other.

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

N
Niels 已提交
1970
    @throw std::bad_alloc if allocation for object, array, or string fails.
N
Niels 已提交
1971 1972

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

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

N
Niels 已提交
1983 1984
        switch (m_type)
        {
1985
            case value_t::object:
N
Niels 已提交
1986
            {
N
Niels 已提交
1987
                m_value = *other.m_value.object;
N
Niels 已提交
1988 1989
                break;
            }
N
Niels 已提交
1990

1991
            case value_t::array:
N
Niels 已提交
1992
            {
N
Niels 已提交
1993
                m_value = *other.m_value.array;
N
Niels 已提交
1994 1995
                break;
            }
N
Niels 已提交
1996

1997
            case value_t::string:
N
Niels 已提交
1998
            {
N
Niels 已提交
1999
                m_value = *other.m_value.string;
N
Niels 已提交
2000 2001
                break;
            }
N
Niels 已提交
2002

2003
            case value_t::boolean:
N
Niels 已提交
2004
            {
N
Niels 已提交
2005
                m_value = other.m_value.boolean;
N
Niels 已提交
2006 2007
                break;
            }
N
Niels 已提交
2008

2009
            case value_t::number_integer:
N
Niels 已提交
2010
            {
N
Niels 已提交
2011
                m_value = other.m_value.number_integer;
N
Niels 已提交
2012 2013
                break;
            }
N
Niels 已提交
2014

2015 2016 2017 2018 2019
            case value_t::number_unsigned:
            {
                m_value = other.m_value.number_unsigned;
                break;
            }
N
Niels 已提交
2020

2021
            case value_t::number_float:
N
Niels 已提交
2022
            {
N
Niels 已提交
2023
                m_value = other.m_value.number_float;
N
Niels 已提交
2024 2025
                break;
            }
2026 2027 2028 2029 2030

            default:
            {
                break;
            }
N
Niels 已提交
2031
        }
2032 2033

        assert_invariant();
N
Niels 已提交
2034 2035
    }

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

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

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

N
Niels 已提交
2061
        // invalidate payload
N
Niels 已提交
2062 2063
        other.m_type = value_t::null;
        other.m_value = {};
2064 2065

        assert_invariant();
N
Niels 已提交
2066 2067
    }

N
Niels 已提交
2068 2069
    /*!
    @brief copy assignment
N
Niels 已提交
2070

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

N
Niels 已提交
2075
    @param[in] other  value to copy from
N
Niels 已提交
2076 2077 2078

    @complexity Linear.

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

N
Niels 已提交
2084 2085 2086 2087
    @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 已提交
2088

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

N
Niels 已提交
2101
        using std::swap;
N
Cleanup  
Niels 已提交
2102 2103
        swap(m_type, other.m_type);
        swap(m_value, other.m_value);
2104 2105

        assert_invariant();
N
Niels 已提交
2106 2107 2108
        return *this;
    }

N
Niels 已提交
2109 2110
    /*!
    @brief destructor
N
Niels 已提交
2111

N
Niels 已提交
2112
    Destroys the JSON value and frees all allocated memory.
N
Niels 已提交
2113 2114 2115

    @complexity Linear.

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

N
Niels 已提交
2122
    @since version 1.0.0
N
Niels 已提交
2123
    */
N
Niels 已提交
2124
    ~basic_json()
N
Niels 已提交
2125
    {
2126 2127
        assert_invariant();

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

2138
            case value_t::array:
N
Niels 已提交
2139
            {
N
Niels 已提交
2140
                AllocatorType<array_t> alloc;
N
Niels 已提交
2141 2142
                alloc.destroy(m_value.array);
                alloc.deallocate(m_value.array, 1);
N
Niels 已提交
2143 2144
                break;
            }
N
Niels 已提交
2145

2146
            case value_t::string:
N
Niels 已提交
2147
            {
N
Niels 已提交
2148
                AllocatorType<string_t> alloc;
N
Niels 已提交
2149
                alloc.destroy(m_value.string);
N
Niels 已提交
2150
                alloc.deallocate(m_value.string, 1);
N
Niels 已提交
2151 2152
                break;
            }
N
Niels 已提交
2153 2154

            default:
N
Niels 已提交
2155
            {
N
Niels 已提交
2156
                // all other types need no specific destructor
N
Niels 已提交
2157 2158 2159 2160 2161
                break;
            }
        }
    }

N
Niels 已提交
2162
    /// @}
N
Niels 已提交
2163 2164 2165 2166 2167 2168

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

N
Niels 已提交
2169
    /// @name object inspection
N
Niels 已提交
2170
    /// Functions to inspect the type of a JSON value.
N
Niels 已提交
2171 2172
    /// @{

N
Niels 已提交
2173
    /*!
N
Niels 已提交
2174 2175
    @brief serialization

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

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

N
Niels 已提交
2185 2186 2187 2188 2189
    @return string containing the serialization of the JSON value

    @complexity Linear.

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

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

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

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

        return ss.str();
N
Niels 已提交
2219 2220
    }

N
Niels 已提交
2221 2222 2223 2224 2225 2226 2227
    /*!
    @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 已提交
2228 2229 2230

    @complexity Constant.

N
Niels 已提交
2231 2232 2233
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2234
    @liveexample{The following code exemplifies `type()` for all JSON
N
Niels 已提交
2235
    types.,type}
N
Niels 已提交
2236

N
Niels 已提交
2237
    @since version 1.0.0
N
Niels 已提交
2238
    */
N
Niels 已提交
2239
    constexpr value_t type() const noexcept
N
Niels 已提交
2240 2241 2242 2243
    {
        return m_type;
    }

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

N
Niels 已提交
2258
    @liveexample{The following code exemplifies `is_primitive()` for all JSON
N
Niels 已提交
2259
    types.,is_primitive}
N
Niels 已提交
2260

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

N
Niels 已提交
2287
    @liveexample{The following code exemplifies `is_structured()` for all JSON
N
Niels 已提交
2288
    types.,is_structured}
N
Niels 已提交
2289

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

N
Niels 已提交
2301 2302 2303 2304 2305
    /*!
    @brief return whether value is null

    This function returns true iff the JSON value is null.

N
Niels 已提交
2306
    @return `true` if type is null, `false` otherwise.
N
Niels 已提交
2307 2308 2309

    @complexity Constant.

N
Niels 已提交
2310 2311 2312
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2313
    @liveexample{The following code exemplifies `is_null()` for all JSON
N
Niels 已提交
2314
    types.,is_null}
N
Niels 已提交
2315

N
Niels 已提交
2316
    @since version 1.0.0
N
Niels 已提交
2317
    */
N
Niels 已提交
2318
    constexpr bool is_null() const noexcept
N
Niels 已提交
2319 2320 2321 2322
    {
        return m_type == value_t::null;
    }

N
Niels 已提交
2323 2324 2325 2326 2327
    /*!
    @brief return whether value is a boolean

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

N
Niels 已提交
2328
    @return `true` if type is boolean, `false` otherwise.
N
Niels 已提交
2329 2330 2331

    @complexity Constant.

N
Niels 已提交
2332 2333 2334
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2335
    @liveexample{The following code exemplifies `is_boolean()` for all JSON
N
Niels 已提交
2336
    types.,is_boolean}
N
Niels 已提交
2337

N
Niels 已提交
2338
    @since version 1.0.0
N
Niels 已提交
2339
    */
N
Niels 已提交
2340
    constexpr bool is_boolean() const noexcept
N
Niels 已提交
2341 2342 2343 2344
    {
        return m_type == value_t::boolean;
    }

N
Niels 已提交
2345 2346 2347 2348 2349 2350
    /*!
    @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.

2351 2352
    @return `true` if type is number (regardless whether integer, unsigned
    integer or floating-type), `false` otherwise.
N
Niels 已提交
2353 2354 2355

    @complexity Constant.

N
Niels 已提交
2356 2357 2358
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2359
    @liveexample{The following code exemplifies `is_number()` for all JSON
N
Niels 已提交
2360
    types.,is_number}
N
Niels 已提交
2361

N
Niels 已提交
2362
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
2363
    integer number
N
Niels 已提交
2364 2365
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2366 2367
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
2368
    @since version 1.0.0
N
Niels 已提交
2369
    */
N
Niels 已提交
2370
    constexpr bool is_number() const noexcept
N
Niels 已提交
2371
    {
N
Niels 已提交
2372
        return is_number_integer() or is_number_float();
N
Niels 已提交
2373 2374
    }

N
Niels 已提交
2375 2376 2377
    /*!
    @brief return whether value is an integer number

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

N
Niels 已提交
2381
    @return `true` if type is an integer or unsigned integer number, `false`
2382
    otherwise.
N
Niels 已提交
2383 2384 2385

    @complexity Constant.

N
Niels 已提交
2386 2387 2388
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2389
    @liveexample{The following code exemplifies `is_number_integer()` for all
N
Niels 已提交
2390
    JSON types.,is_number_integer}
N
Niels 已提交
2391 2392

    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
2393 2394
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2395 2396
    @sa @ref is_number_float() -- check if value is a floating-point number

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

2404 2405 2406
    /*!
    @brief return whether value is an unsigned integer number

N
Niels 已提交
2407 2408
    This function returns true iff the JSON value is an unsigned integer
    number. This excludes floating-point and (signed) integer values.
2409 2410 2411 2412 2413

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

    @complexity Constant.

N
Niels 已提交
2414 2415 2416
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2417
    @liveexample{The following code exemplifies `is_number_unsigned()` for all
N
Niels 已提交
2418 2419
    JSON types.,is_number_unsigned}

2420
    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
2421
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
2422 2423 2424 2425 2426
    integer number
    @sa @ref is_number_float() -- check if value is a floating-point number

    @since version 2.0.0
    */
N
Niels 已提交
2427
    constexpr bool is_number_unsigned() const noexcept
2428 2429
    {
        return m_type == value_t::number_unsigned;
N
Niels 已提交
2430 2431
    }

N
Niels 已提交
2432 2433 2434 2435
    /*!
    @brief return whether value is a floating-point number

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

N
Niels 已提交
2438
    @return `true` if type is a floating-point number, `false` otherwise.
N
Niels 已提交
2439 2440 2441

    @complexity Constant.

N
Niels 已提交
2442 2443 2444
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2445
    @liveexample{The following code exemplifies `is_number_float()` for all
N
Niels 已提交
2446
    JSON types.,is_number_float}
N
Niels 已提交
2447 2448 2449

    @sa @ref is_number() -- check if value is number
    @sa @ref is_number_integer() -- check if value is an integer number
N
Niels 已提交
2450 2451
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2452

N
Niels 已提交
2453
    @since version 1.0.0
N
Niels 已提交
2454
    */
N
Niels 已提交
2455
    constexpr bool is_number_float() const noexcept
N
Niels 已提交
2456 2457 2458 2459
    {
        return m_type == value_t::number_float;
    }

N
Niels 已提交
2460 2461 2462 2463 2464
    /*!
    @brief return whether value is an object

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

N
Niels 已提交
2465
    @return `true` if type is object, `false` otherwise.
N
Niels 已提交
2466 2467 2468

    @complexity Constant.

N
Niels 已提交
2469 2470 2471
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2472
    @liveexample{The following code exemplifies `is_object()` for all JSON
N
Niels 已提交
2473
    types.,is_object}
N
Niels 已提交
2474

N
Niels 已提交
2475
    @since version 1.0.0
N
Niels 已提交
2476
    */
N
Niels 已提交
2477
    constexpr bool is_object() const noexcept
N
Niels 已提交
2478 2479 2480 2481
    {
        return m_type == value_t::object;
    }

N
Niels 已提交
2482 2483 2484 2485 2486
    /*!
    @brief return whether value is an array

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

N
Niels 已提交
2487
    @return `true` if type is array, `false` otherwise.
N
Niels 已提交
2488 2489 2490

    @complexity Constant.

N
Niels 已提交
2491 2492 2493
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2494
    @liveexample{The following code exemplifies `is_array()` for all JSON
N
Niels 已提交
2495
    types.,is_array}
N
Niels 已提交
2496

N
Niels 已提交
2497
    @since version 1.0.0
N
Niels 已提交
2498
    */
N
Niels 已提交
2499
    constexpr bool is_array() const noexcept
N
Niels 已提交
2500 2501 2502 2503
    {
        return m_type == value_t::array;
    }

N
Niels 已提交
2504 2505 2506 2507 2508
    /*!
    @brief return whether value is a string

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

N
Niels 已提交
2509
    @return `true` if type is string, `false` otherwise.
N
Niels 已提交
2510 2511 2512

    @complexity Constant.

N
Niels 已提交
2513 2514 2515
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2516
    @liveexample{The following code exemplifies `is_string()` for all JSON
N
Niels 已提交
2517
    types.,is_string}
N
Niels 已提交
2518

N
Niels 已提交
2519
    @since version 1.0.0
N
Niels 已提交
2520
    */
N
Niels 已提交
2521
    constexpr bool is_string() const noexcept
N
Niels 已提交
2522 2523 2524 2525
    {
        return m_type == value_t::string;
    }

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

    @complexity Constant.

N
Niels 已提交
2540 2541 2542
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2543
    @liveexample{The following code exemplifies `is_discarded()` for all JSON
N
Niels 已提交
2544
    types.,is_discarded}
N
Niels 已提交
2545

N
Niels 已提交
2546
    @since version 1.0.0
N
Niels 已提交
2547
    */
N
Niels 已提交
2548
    constexpr bool is_discarded() const noexcept
N
Niels 已提交
2549 2550 2551 2552
    {
        return m_type == value_t::discarded;
    }

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

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

N
Niels 已提交
2569
    @since version 1.0.0
N
Niels 已提交
2570
    */
N
Niels 已提交
2571
    constexpr operator value_t() const noexcept
N
Niels 已提交
2572 2573 2574 2575
    {
        return m_type;
    }

N
Niels 已提交
2576 2577
    /// @}

N
Niels 已提交
2578
  private:
N
Niels 已提交
2579 2580 2581
    //////////////////
    // value access //
    //////////////////
N
Niels 已提交
2582

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

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

N
Niels 已提交
2612
    /// get an array (explicit)
N
Niels 已提交
2613 2614 2615 2616 2617 2618
    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 已提交
2619
    T get_impl(T*) const
N
Niels 已提交
2620
    {
N
cleanup  
Niels 已提交
2621
        if (is_array())
N
Niels 已提交
2622
        {
2623 2624 2625
            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 已提交
2626
            {
2627 2628 2629 2630 2631 2632 2633
                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 已提交
2634 2635 2636
        }
    }

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

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

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

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

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

2716 2717 2718 2719
            case value_t::number_unsigned:
            {
                return static_cast<T>(m_value.number_unsigned);
            }
2720 2721

            case value_t::number_float:
N
Niels 已提交
2722
            {
N
Niels 已提交
2723
                return static_cast<T>(m_value.number_float);
N
Niels 已提交
2724
            }
2725

N
Niels 已提交
2726
            default:
N
Niels 已提交
2727
            {
N
Niels 已提交
2728
                throw std::domain_error("type must be number, but is " + type_name());
N
Niels 已提交
2729 2730 2731 2732 2733
            }
        }
    }

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

N
Niels 已提交
2741
    /// get a pointer to the value (object)
N
Niels 已提交
2742
    object_t* get_impl_ptr(object_t*) noexcept
N
Niels 已提交
2743 2744 2745 2746
    {
        return is_object() ? m_value.object : nullptr;
    }

N
Niels 已提交
2747
    /// get a pointer to the value (object)
N
Niels 已提交
2748
    constexpr const object_t* get_impl_ptr(const object_t*) const noexcept
N
Niels 已提交
2749 2750 2751 2752 2753 2754 2755 2756 2757 2758
    {
        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 已提交
2759
    /// get a pointer to the value (array)
N
Niels 已提交
2760
    constexpr const array_t* get_impl_ptr(const array_t*) const noexcept
N
Niels 已提交
2761 2762 2763 2764 2765
    {
        return is_array() ? m_value.array : nullptr;
    }

    /// get a pointer to the value (string)
N
Niels 已提交
2766 2767 2768 2769 2770 2771
    string_t* get_impl_ptr(string_t*) noexcept
    {
        return is_string() ? m_value.string : nullptr;
    }

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

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

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

    /// get a pointer to the value (integer number)
N
Niels 已提交
2790 2791 2792 2793 2794 2795
    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 已提交
2796
    constexpr const number_integer_t* get_impl_ptr(const number_integer_t*) const noexcept
N
Niels 已提交
2797 2798 2799
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }
N
Niels 已提交
2800

2801 2802 2803 2804 2805
    /// 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 已提交
2806

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

N
Niels 已提交
2813
    /// get a pointer to the value (floating-point number)
N
Niels 已提交
2814 2815 2816 2817 2818 2819
    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 已提交
2820
    constexpr const number_float_t* get_impl_ptr(const number_float_t*) const noexcept
N
Niels 已提交
2821 2822 2823 2824
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

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

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

N
Niels 已提交
2856
  public:
N
Niels 已提交
2857 2858

    /// @name value access
N
Niels 已提交
2859
    /// Direct access to the stored value of a JSON value.
N
Niels 已提交
2860 2861
    /// @{

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

    @complexity Linear in the size of the JSON value.

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

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

N
Niels 已提交
2902 2903 2904 2905 2906 2907
    /*!
    @brief get a pointer value (explicit)

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

N
Niels 已提交
2908 2909
    @warning The pointer becomes invalid if the underlying JSON object
    changes.
N
Niels 已提交
2910 2911

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

N
Niels 已提交
2915 2916
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
2917 2918 2919 2920 2921 2922 2923 2924 2925

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

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

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

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

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

N
Niels 已提交
2963 2964
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
2965 2966 2967 2968 2969 2970 2971

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

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

N
Niels 已提交
3026
    /*!
D
dariomt 已提交
3027 3028
    @brief get a reference value (implicit)

N
Niels 已提交
3029 3030
    Implict reference access to the internally stored JSON value. No copies
    are made.
D
dariomt 已提交
3031 3032 3033 3034

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

N
Niels 已提交
3035 3036
    @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 已提交
3037
    @ref number_float_t. Enforced by static assertion.
D
dariomt 已提交
3038

N
Niels 已提交
3039 3040 3041
    @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 已提交
3042

N
Niels 已提交
3043 3044
    @throw std::domain_error in case passed type @a ReferenceType is
    incompatible with the stored JSON value
D
dariomt 已提交
3045 3046

    @complexity Constant.
N
Niels 已提交
3047 3048 3049

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

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

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

    /*!
    @brief get a value (implicit)

N
Niels 已提交
3076 3077
    Implicit type conversion between the JSON value and a compatible value.
    The call is realized by calling @ref get() const.
N
Niels 已提交
3078 3079 3080

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

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

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

N
Niels 已提交
3114 3115
    /// @}

N
Niels 已提交
3116 3117 3118 3119 3120

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

N
Niels 已提交
3121
    /// @name element access
N
Niels 已提交
3122
    /// Access to the JSON value.
N
Niels 已提交
3123 3124
    /// @{

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

    @complexity Constant.

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

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

N
Niels 已提交
3168 3169 3170
    /*!
    @brief access specified array element with bounds checking

N
Niels 已提交
3171 3172
    Returns a const reference to the element at specified location @a idx,
    with bounds checking.
N
Niels 已提交
3173 3174 3175 3176 3177

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

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

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

    @complexity Constant.

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

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

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

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3229
    written using `at()`.,at__object_t_key_type}
N
Niels 已提交
3230 3231 3232 3233

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

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

N
Niels 已提交
3258 3259 3260
    /*!
    @brief access specified object element with bounds checking

N
Niels 已提交
3261 3262
    Returns a const reference to the element at with specified key @a key,
    with bounds checking.
N
Niels 已提交
3263 3264 3265 3266 3267

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

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

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

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3276
    `at()`.,at__object_t_key_type_const}
N
Niels 已提交
3277 3278 3279 3280

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

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

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

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

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

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

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

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

    @complexity Constant.

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

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

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

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3410
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
3411 3412 3413 3414

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

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

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

N
Niels 已提交
3439
    /*!
3440
    @brief read-only access specified object element
N
Niels 已提交
3441

3442 3443 3444 3445 3446
    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 已提交
3447 3448 3449

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

3450
    @return const reference to the element at key @a key
N
Niels 已提交
3451

N
Niels 已提交
3452 3453 3454
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

N
Niels 已提交
3455 3456
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    operator[] with null"`
N
Niels 已提交
3457 3458 3459 3460

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3461
    the `[]` operator.,operatorarray__key_type_const}
3462 3463 3464 3465 3466

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

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

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3502
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
3503 3504 3505 3506

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

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

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

    @complexity Logarithmic in the size of the container.

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

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

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

N
Niels 已提交
3600
    /*!
3601
    @brief read-only access specified object element
N
Niels 已提交
3602

3603 3604 3605 3606 3607
    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 已提交
3608 3609 3610

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

3611
    @return const reference to the element at key @a key
N
Niels 已提交
3612

N
Niels 已提交
3613 3614 3615
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

N
Niels 已提交
3616 3617
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    operator[] with null"`
N
Niels 已提交
3618 3619 3620 3621

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3622
    the `[]` operator.,operatorarray__key_type_const}
3623 3624 3625 3626 3627

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

N
Niels 已提交
3645 3646 3647
    /*!
    @brief access specified object element with default value

N
Niels 已提交
3648 3649
    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.
3650

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

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

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

N
Niels 已提交
3726 3727 3728
    /*!
    @brief access specified object element via JSON Pointer with default value

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

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

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

    @complexity Constant.

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

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

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

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

N
Niels 已提交
3822
    @since version 1.0.0
N
Niels 已提交
3823
    */
N
Niels 已提交
3824
    reference front()
N
Niels 已提交
3825 3826 3827 3828
    {
        return *begin();
    }

N
Niels 已提交
3829 3830 3831
    /*!
    @copydoc basic_json::front()
    */
N
Niels 已提交
3832
    const_reference front() const
N
Niels 已提交
3833 3834 3835 3836
    {
        return *cbegin();
    }

N
Niels 已提交
3837 3838 3839 3840
    /*!
    @brief access the last element

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

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

    @complexity Constant.

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

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

N
Niels 已提交
3861 3862 3863
    @liveexample{The following code shows an example for `back()`.,back}

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

N
Niels 已提交
3865
    @since version 1.0.0
N
Niels 已提交
3866
    */
N
Niels 已提交
3867
    reference back()
N
Niels 已提交
3868 3869 3870 3871 3872 3873
    {
        auto tmp = end();
        --tmp;
        return *tmp;
    }

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

N
Niels 已提交
3884 3885 3886
    /*!
    @brief remove element given an iterator

N
Niels 已提交
3887 3888 3889
    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 已提交
3890

N
Niels 已提交
3891
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
3892 3893 3894
    will be `null`.

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

3898
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
3899

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

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

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

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

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

3941
        IteratorType result = end();
3942 3943 3944 3945

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

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

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

        return result;
    }

N
Niels 已提交
3990 3991 3992
    /*!
    @brief remove elements given an iterator range

N
Niels 已提交
3993 3994 3995
    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 已提交
3996

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

4005
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
4006

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

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

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

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

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

4048
        IteratorType result = end();
4049 4050 4051 4052

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

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

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

        return result;
    }

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

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

N
Niels 已提交
4113 4114
    @throw std::domain_error when called on a type other than JSON object;
    example: `"cannot use erase() with null"`
N
Niels 已提交
4115 4116 4117

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

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

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

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

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

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

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

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

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

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

N
Niels 已提交
4183 4184 4185 4186 4187 4188 4189 4190 4191 4192
    /// @}


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

    /// @name lookup
    /// @{

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

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

N
Niels 已提交
4209
    @since version 1.0.0
N
Niels 已提交
4210
    */
N
Niels 已提交
4211
    iterator find(typename object_t::key_type key)
N
Niels 已提交
4212 4213 4214
    {
        auto result = end();

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

        return result;
    }

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

N
cleanup  
Niels 已提交
4231
        if (is_object())
N
Niels 已提交
4232 4233 4234 4235 4236 4237 4238
        {
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

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

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

N
Niels 已提交
4263 4264
    /// @}

N
Niels 已提交
4265

N
Niels 已提交
4266 4267 4268 4269
    ///////////////
    // iterators //
    ///////////////

N
Niels 已提交
4270 4271 4272
    /// @name iterators
    /// @{

N
Niels 已提交
4273 4274
    /*!
    @brief returns an iterator to the first element
N
Niels 已提交
4275 4276 4277 4278 4279 4280 4281 4282 4283

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

N
Niels 已提交
4289 4290 4291 4292 4293
    @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 已提交
4294

N
Niels 已提交
4295
    @since version 1.0.0
N
Niels 已提交
4296
    */
N
Niels 已提交
4297
    iterator begin() noexcept
N
Niels 已提交
4298 4299 4300 4301 4302 4303
    {
        iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4304
    /*!
N
Niels 已提交
4305
    @copydoc basic_json::cbegin()
N
Niels 已提交
4306
    */
N
Niels 已提交
4307
    const_iterator begin() const noexcept
N
Niels 已提交
4308
    {
N
Niels 已提交
4309
        return cbegin();
N
Niels 已提交
4310 4311
    }

N
Niels 已提交
4312 4313
    /*!
    @brief returns a const iterator to the first element
N
Niels 已提交
4314 4315 4316 4317 4318 4319 4320 4321 4322

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

N
Niels 已提交
4329 4330 4331 4332 4333
    @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 已提交
4334

N
Niels 已提交
4335
    @since version 1.0.0
N
Niels 已提交
4336
    */
N
Niels 已提交
4337
    const_iterator cbegin() const noexcept
N
Niels 已提交
4338 4339 4340 4341 4342 4343
    {
        const_iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4344 4345
    /*!
    @brief returns an iterator to one past the last element
N
Niels 已提交
4346 4347 4348 4349 4350 4351 4352 4353 4354

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

N
Niels 已提交
4360 4361 4362 4363 4364
    @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 已提交
4365

N
Niels 已提交
4366
    @since version 1.0.0
N
Niels 已提交
4367
    */
N
Niels 已提交
4368
    iterator end() noexcept
N
Niels 已提交
4369 4370 4371 4372 4373 4374
    {
        iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
4375
    /*!
N
Niels 已提交
4376
    @copydoc basic_json::cend()
N
Niels 已提交
4377
    */
N
Niels 已提交
4378
    const_iterator end() const noexcept
N
Niels 已提交
4379
    {
N
Niels 已提交
4380
        return cend();
N
Niels 已提交
4381 4382
    }

N
Niels 已提交
4383 4384
    /*!
    @brief returns a const iterator to one past the last element
N
Niels 已提交
4385 4386 4387 4388 4389 4390 4391 4392 4393

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

N
Niels 已提交
4400 4401 4402 4403 4404
    @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 已提交
4405

N
Niels 已提交
4406
    @since version 1.0.0
N
Niels 已提交
4407
    */
N
Niels 已提交
4408
    const_iterator cend() const noexcept
N
Niels 已提交
4409 4410 4411 4412 4413 4414
    {
        const_iterator result(this);
        result.set_end();
        return result;
    }

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

N
Niels 已提交
4430 4431 4432 4433 4434
    @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 已提交
4435

N
Niels 已提交
4436
    @since version 1.0.0
N
Niels 已提交
4437
    */
N
Niels 已提交
4438
    reverse_iterator rbegin() noexcept
N
Niels 已提交
4439 4440 4441 4442
    {
        return reverse_iterator(end());
    }

N
Niels 已提交
4443
    /*!
N
Niels 已提交
4444
    @copydoc basic_json::crbegin()
N
Niels 已提交
4445
    */
N
Niels 已提交
4446
    const_reverse_iterator rbegin() const noexcept
N
Niels 已提交
4447
    {
N
Niels 已提交
4448
        return crbegin();
N
Niels 已提交
4449 4450
    }

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

N
Niels 已提交
4467 4468 4469 4470 4471
    @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 已提交
4472

N
Niels 已提交
4473
    @since version 1.0.0
N
Niels 已提交
4474
    */
N
Niels 已提交
4475
    reverse_iterator rend() noexcept
N
Niels 已提交
4476 4477 4478 4479
    {
        return reverse_iterator(begin());
    }

N
Niels 已提交
4480
    /*!
N
Niels 已提交
4481
    @copydoc basic_json::crend()
N
Niels 已提交
4482
    */
N
Niels 已提交
4483
    const_reverse_iterator rend() const noexcept
N
Niels 已提交
4484
    {
N
Niels 已提交
4485
        return crend();
N
Niels 已提交
4486 4487
    }

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

N
Niels 已提交
4504 4505 4506 4507 4508
    @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 已提交
4509

N
Niels 已提交
4510
    @since version 1.0.0
N
Niels 已提交
4511
    */
N
Niels 已提交
4512
    const_reverse_iterator crbegin() const noexcept
N
Niels 已提交
4513 4514 4515 4516
    {
        return const_reverse_iterator(cend());
    }

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

N
Niels 已提交
4533 4534 4535 4536 4537
    @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 已提交
4538

N
Niels 已提交
4539
    @since version 1.0.0
N
Niels 已提交
4540
    */
N
Niels 已提交
4541
    const_reverse_iterator crend() const noexcept
N
Niels 已提交
4542 4543 4544 4545
    {
        return const_reverse_iterator(cbegin());
    }

N
cleanup  
Niels 已提交
4546 4547 4548 4549 4550 4551 4552 4553
  private:
    // forward declaration
    template<typename IteratorType> class iteration_proxy;

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

N
Niels 已提交
4554
    This function allows to access @ref iterator::key() and @ref
N
Niels 已提交
4555 4556 4557
    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 已提交
4558 4559 4560

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

N
Niels 已提交
4577 4578 4579 4580 4581

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

N
Niels 已提交
4582 4583 4584
    /// @name capacity
    /// @{

N
Niels 已提交
4585 4586
    /*!
    @brief checks whether the container is empty
N
Niels 已提交
4587 4588 4589

    Checks if a JSON value has no elements.

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

N
Niels 已提交
4601 4602 4603 4604
    @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 已提交
4605 4606
    @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 已提交
4607
    complexity.
N
Niels 已提交
4608

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

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

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

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

4632
            case value_t::array:
N
Niels 已提交
4633
            {
N
Niels 已提交
4634
                // delegate call to array_t::empty()
N
Niels 已提交
4635 4636
                return m_value.array->empty();
            }
N
Niels 已提交
4637

4638
            case value_t::object:
N
Niels 已提交
4639
            {
N
Niels 已提交
4640
                // delegate call to object_t::empty()
N
Niels 已提交
4641 4642
                return m_value.object->empty();
            }
N
Niels 已提交
4643

N
Niels 已提交
4644 4645 4646 4647 4648 4649
            default:
            {
                // all other types are nonempty
                return false;
            }
        }
N
Niels 已提交
4650 4651
    }

N
Niels 已提交
4652 4653
    /*!
    @brief returns the number of elements
N
Niels 已提交
4654 4655 4656

    Returns the number of elements in a JSON value.

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

N
Niels 已提交
4668 4669 4670 4671
    @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 已提交
4672 4673 4674
    @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 已提交
4675

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

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

N
Niels 已提交
4685 4686 4687
    @sa @ref empty() -- checks whether the container is empty
    @sa @ref max_size() -- returns the maximal number of elements

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

4700
            case value_t::array:
N
Niels 已提交
4701
            {
N
Niels 已提交
4702
                // delegate call to array_t::size()
N
Niels 已提交
4703 4704
                return m_value.array->size();
            }
N
Niels 已提交
4705

4706
            case value_t::object:
N
Niels 已提交
4707
            {
N
Niels 已提交
4708
                // delegate call to object_t::size()
N
Niels 已提交
4709 4710
                return m_value.object->size();
            }
N
Niels 已提交
4711

N
Niels 已提交
4712 4713 4714 4715 4716 4717
            default:
            {
                // all other types have size 1
                return 1;
            }
        }
N
Niels 已提交
4718 4719
    }

N
Niels 已提交
4720 4721
    /*!
    @brief returns the maximum possible number of elements
N
Niels 已提交
4722 4723 4724 4725 4726

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

N
Niels 已提交
4738 4739
    @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 已提交
4740
    complexity.
N
Niels 已提交
4741

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

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

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

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

4766
            case value_t::object:
N
Niels 已提交
4767
            {
N
Niels 已提交
4768
                // delegate call to object_t::max_size()
N
Niels 已提交
4769 4770
                return m_value.object->max_size();
            }
N
Niels 已提交
4771

N
Niels 已提交
4772 4773
            default:
            {
4774 4775
                // all other types have max_size() == size()
                return size();
N
Niels 已提交
4776 4777
            }
        }
N
Niels 已提交
4778 4779
    }

N
Niels 已提交
4780 4781
    /// @}

N
Niels 已提交
4782 4783 4784 4785 4786

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

N
Niels 已提交
4787 4788 4789
    /// @name modifiers
    /// @{

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

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

4825 4826 4827 4828 4829 4830
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = 0;
                break;
            }

4831
            case value_t::number_float:
N
Niels 已提交
4832
            {
N
Niels 已提交
4833
                m_value.number_float = 0.0;
N
Niels 已提交
4834 4835
                break;
            }
N
Niels 已提交
4836

4837
            case value_t::boolean:
N
Niels 已提交
4838
            {
N
Niels 已提交
4839
                m_value.boolean = false;
N
Niels 已提交
4840 4841
                break;
            }
N
Niels 已提交
4842

4843
            case value_t::string:
N
Niels 已提交
4844 4845 4846 4847
            {
                m_value.string->clear();
                break;
            }
N
Niels 已提交
4848

4849
            case value_t::array:
N
Niels 已提交
4850 4851 4852 4853
            {
                m_value.array->clear();
                break;
            }
N
Niels 已提交
4854

4855
            case value_t::object:
N
Niels 已提交
4856 4857 4858 4859
            {
                m_value.object->clear();
                break;
            }
4860 4861 4862 4863 4864

            default:
            {
                break;
            }
N
Niels 已提交
4865 4866 4867
        }
    }

4868 4869 4870
    /*!
    @brief add an object to an array

4871
    Appends the given element @a val to the end of the JSON value. If the
4872
    function is called on a JSON null value, an empty array is created before
4873
    appending @a val.
4874

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

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

    @complexity Amortized constant.

N
Niels 已提交
4882 4883 4884
    @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 已提交
4885

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

        // transform null object into an array
N
cleanup  
Niels 已提交
4897
        if (is_null())
N
Niels 已提交
4898 4899
        {
            m_type = value_t::array;
N
Niels 已提交
4900
            m_value = value_t::array;
4901
            assert_invariant();
N
Niels 已提交
4902 4903 4904
        }

        // add element to array (move semantics)
4905
        m_value.array->push_back(std::move(val));
N
Niels 已提交
4906
        // invalidate object
4907
        val.m_type = value_t::null;
N
Niels 已提交
4908 4909
    }

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

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

        // transform null object into an array
N
cleanup  
Niels 已提交
4933
        if (is_null())
N
Niels 已提交
4934 4935
        {
            m_type = value_t::array;
N
Niels 已提交
4936
            m_value = value_t::array;
4937
            assert_invariant();
N
Niels 已提交
4938 4939 4940
        }

        // add element to array
4941
        m_value.array->push_back(val);
N
Niels 已提交
4942 4943
    }

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

4954 4955 4956
    /*!
    @brief add an object to an object

4957
    Inserts the given element @a val to the JSON object. If the function is
N
Niels 已提交
4958 4959
    called on a JSON null value, an empty object is created before inserting
    @a val.
4960

4961
    @param[in] val the value to add to the JSON object
4962 4963

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

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

N
Niels 已提交
4968 4969 4970
    @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 已提交
4971

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

        // transform null object into an object
N
cleanup  
Niels 已提交
4983
        if (is_null())
N
Niels 已提交
4984 4985
        {
            m_type = value_t::object;
N
Niels 已提交
4986
            m_value = value_t::object;
4987
            assert_invariant();
N
Niels 已提交
4988 4989 4990
        }

        // add element to array
4991
        m_value.object->insert(val);
N
Niels 已提交
4992 4993
    }

4994 4995 4996 4997
    /*!
    @brief add an object to an object
    @copydoc push_back(const typename object_t::value_type&)
    */
4998
    reference operator+=(const typename object_t::value_type& val)
N
Niels 已提交
4999
    {
5000
        push_back(val);
N
Niels 已提交
5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049
        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 已提交
5050 5051
    }

N
Niels 已提交
5052 5053 5054
    /*!
    @brief inserts element

5055
    Inserts element @a val before iterator @a pos.
N
Niels 已提交
5056 5057 5058

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

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

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

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

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

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

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

    /*!
    @brief inserts elements

5108
    Inserts @a cnt copies of @a val before iterator @a pos.
N
Niels 已提交
5109 5110 5111

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

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

5122
    @complexity Linear in @a cnt plus linear in the distance between @a pos
N
Niels 已提交
5123 5124
    and end of the container.

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

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

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

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

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

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

        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 已提交
5208 5209 5210 5211
        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 已提交
5212 5213 5214
        return result;
    }

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

N
Niels 已提交
5229 5230 5231
    @return iterator pointing to the first element inserted, or @a pos if
    `ilist` is empty

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

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

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

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

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

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

    @complexity Constant.

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

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

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

    @complexity Constant.

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

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

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

    @complexity Constant.

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

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

N
Niels 已提交
5387 5388
    /// @}

N
Niels 已提交
5389 5390 5391 5392 5393

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

N
Niels 已提交
5394 5395 5396
    /// @name lexicographical comparison operators
    /// @{

N
Niels 已提交
5397 5398 5399 5400 5401 5402 5403
  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 已提交
5404

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

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

    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.

5449 5450
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__equal}
N
Niels 已提交
5451

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

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

N
Niels 已提交
5526 5527 5528
        return false;
    }

N
Niels 已提交
5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543
    /*!
    @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 已提交
5544

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

    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.

5572 5573
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__notequal}
N
Niels 已提交
5574

N
Niels 已提交
5575
    @since version 1.0.0
N
Niels 已提交
5576
    */
N
Niels 已提交
5577
    friend bool operator!=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
5578 5579 5580 5581
    {
        return not (lhs == rhs);
    }

N
Niels 已提交
5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596
    /*!
    @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 已提交
5597

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

5633 5634
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__less}
N
Niels 已提交
5635

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

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

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

N
Niels 已提交
5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727
    /*!
    @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.

5728 5729
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greater}
N
Niels 已提交
5730

N
Niels 已提交
5731
    @since version 1.0.0
N
Niels 已提交
5732
    */
N
Niels 已提交
5733
    friend bool operator<=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
5734 5735 5736 5737
    {
        return not (rhs < lhs);
    }

N
Niels 已提交
5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749
    /*!
    @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.

5750 5751
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__lessequal}
N
Niels 已提交
5752

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

N
Niels 已提交
5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771
    /*!
    @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.

5772 5773
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greaterequal}
N
Niels 已提交
5774

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

N
Niels 已提交
5782 5783
    /// @}

N
Niels 已提交
5784 5785 5786 5787 5788

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

N
Niels 已提交
5789 5790 5791
    /// @name serialization
    /// @{

N
Niels 已提交
5792 5793 5794 5795 5796 5797 5798 5799 5800 5801
    /*!
    @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)`.

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

    @return the stream @a o

    @complexity Linear.

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

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

N
Niels 已提交
5824 5825
        // reset width to 0 for subsequent calls to this stream
        o.width(0);
5826

N
Niels 已提交
5827
        // fix locale problems
5828 5829 5830 5831 5832 5833 5834
        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 已提交
5835
        const auto old_precision = o.precision(std::numeric_limits<double>::digits10);
N
Niels 已提交
5836 5837

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

5840
        // reset locale and precision
N
Niels 已提交
5841
        o.imbue(old_locale);
N
Niels 已提交
5842
        o.precision(old_precision);
N
Niels 已提交
5843 5844 5845
        return o;
    }

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

N
Niels 已提交
5855 5856
    /// @}

N
Niels 已提交
5857 5858 5859 5860 5861

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

N
Niels 已提交
5862 5863 5864
    /// @name deserialization
    /// @{

N
Niels 已提交
5865 5866 5867 5868 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
    /*!
    @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 已提交
5930
                 sizeof(typename std::remove_pointer<CharPT>::type) == 1, int>::type = 0>
N
Niels 已提交
5931 5932 5933 5934 5935 5936
    static basic_json parse(const CharPT s,
                            const parser_callback_t cb = nullptr)
    {
        return parser(reinterpret_cast<const char*>(s), cb).parse();
    }

N
Niels 已提交
5937 5938 5939 5940
    /*!
    @brief deserialize from stream

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

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

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

N
Niels 已提交
5956
    @sa @ref parse(const char*, const parser_callback_t) for a version
N
Niels 已提交
5957
    that reads from a string
N
Niels 已提交
5958

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

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

5976
    /*!
N
Niels 已提交
5977
    @brief deserialize from an iterator range with contiguous storage
5978

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

N
Niels 已提交
5992 5993 5994 5995
    @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.
5996

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

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

6037 6038 6039 6040 6041 6042
        // 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();
        }
6043 6044 6045 6046

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

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

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

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

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

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

N
Niels 已提交
6139 6140
    /// @}

N
Niels 已提交
6141 6142 6143 6144 6145 6146

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

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

    @complexity Constant.

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

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

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

N
Niels 已提交
6223 6224
    /*!
    @brief escape a string
N
Niels 已提交
6225

N
Niels 已提交
6226 6227
    Escape a string by replacing certain special characters by a sequence of
    an escape character (backslash) and another character and other control
N
Niels 已提交
6228 6229 6230
    characters by a sequence of "\u" followed by a four-digit hex
    representation.

N
Niels 已提交
6231
    @param[in] s  the string to escape
N
Niels 已提交
6232 6233 6234
    @return  the escaped string

    @complexity Linear in the length of string @a s.
N
Niels 已提交
6235
    */
N
Niels 已提交
6236
    static string_t escape_string(const string_t& s)
N
Niels 已提交
6237
    {
N
Niels 已提交
6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248
        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 已提交
6249 6250 6251 6252 6253 6254
        {
            switch (c)
            {
                // quotation mark (0x22)
                case '"':
                {
N
Niels 已提交
6255 6256
                    result[pos + 1] = '"';
                    pos += 2;
N
Niels 已提交
6257 6258
                    break;
                }
N
Niels 已提交
6259

N
Niels 已提交
6260 6261 6262
                // reverse solidus (0x5c)
                case '\\':
                {
N
Niels 已提交
6263 6264
                    // nothing to change
                    pos += 2;
N
Niels 已提交
6265 6266
                    break;
                }
N
Niels 已提交
6267

N
Niels 已提交
6268 6269 6270
                // backspace (0x08)
                case '\b':
                {
N
Niels 已提交
6271 6272
                    result[pos + 1] = 'b';
                    pos += 2;
N
Niels 已提交
6273 6274
                    break;
                }
N
Niels 已提交
6275

N
Niels 已提交
6276 6277 6278
                // formfeed (0x0c)
                case '\f':
                {
N
Niels 已提交
6279 6280
                    result[pos + 1] = 'f';
                    pos += 2;
N
Niels 已提交
6281 6282
                    break;
                }
N
Niels 已提交
6283

N
Niels 已提交
6284 6285 6286
                // newline (0x0a)
                case '\n':
                {
N
Niels 已提交
6287 6288
                    result[pos + 1] = 'n';
                    pos += 2;
N
Niels 已提交
6289 6290
                    break;
                }
N
Niels 已提交
6291

N
Niels 已提交
6292 6293 6294
                // carriage return (0x0d)
                case '\r':
                {
N
Niels 已提交
6295 6296
                    result[pos + 1] = 'r';
                    pos += 2;
N
Niels 已提交
6297 6298
                    break;
                }
N
Niels 已提交
6299

N
Niels 已提交
6300 6301 6302
                // horizontal tab (0x09)
                case '\t':
                {
N
Niels 已提交
6303 6304
                    result[pos + 1] = 't';
                    pos += 2;
N
Niels 已提交
6305 6306 6307 6308 6309
                    break;
                }

                default:
                {
6310
                    if (c >= 0x00 and c <= 0x1f)
N
Niels 已提交
6311
                    {
N
Niels 已提交
6312 6313
                        // convert a number 0..15 to its hex representation
                        // (0..f)
N
Niels 已提交
6314
                        static const char hexify[16] =
6315
                        {
N
Niels 已提交
6316 6317
                            '0', '1', '2', '3', '4', '5', '6', '7',
                            '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'
6318 6319
                        };

N
Niels 已提交
6320
                        // print character c as \uxxxx
N
Niels 已提交
6321
                        for (const char m :
N
Niels 已提交
6322
                    { 'u', '0', '0', hexify[c >> 4], hexify[c & 0x0f]
N
Niels 已提交
6323
                        })
6324 6325 6326 6327 6328
                        {
                            result[++pos] = m;
                        }

                        ++pos;
N
Niels 已提交
6329 6330 6331 6332
                    }
                    else
                    {
                        // all other characters are added as-is
N
Niels 已提交
6333
                        result[pos++] = c;
N
Niels 已提交
6334 6335 6336 6337 6338
                    }
                    break;
                }
            }
        }
N
Niels 已提交
6339 6340

        return result;
N
Niels 已提交
6341 6342 6343 6344
    }

    /*!
    @brief internal implementation of the serialization function
N
Niels 已提交
6345

N
Niels 已提交
6346
    This function is called by the public member function dump and organizes
N
Niels 已提交
6347
    the serialization internally. The indentation level is propagated as
N
Niels 已提交
6348 6349
    additional parameter. In case of arrays and objects, the function is
    called recursively. Note that
N
Niels 已提交
6350

N
Niels 已提交
6351 6352 6353
    - 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 已提交
6354

N
Niels 已提交
6355 6356 6357 6358
    @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 已提交
6359
    */
N
Niels 已提交
6360 6361 6362
    void dump(std::ostream& o,
              const bool pretty_print,
              const unsigned int indent_step,
N
Niels 已提交
6363
              const unsigned int current_indent = 0) const
N
Niels 已提交
6364
    {
N
Niels 已提交
6365
        // variable to hold indentation for recursive calls
N
Niels 已提交
6366
        unsigned int new_indent = current_indent;
N
Niels 已提交
6367

N
Niels 已提交
6368 6369
        switch (m_type)
        {
6370
            case value_t::object:
N
Niels 已提交
6371 6372 6373
            {
                if (m_value.object->empty())
                {
N
Niels 已提交
6374 6375
                    o << "{}";
                    return;
N
Niels 已提交
6376 6377
                }

N
Niels 已提交
6378
                o << "{";
N
Niels 已提交
6379 6380

                // increase indentation
N
Niels 已提交
6381
                if (pretty_print)
N
Niels 已提交
6382
                {
N
Niels 已提交
6383
                    new_indent += indent_step;
N
Niels 已提交
6384
                    o << "\n";
N
Niels 已提交
6385 6386 6387 6388 6389 6390
                }

                for (auto i = m_value.object->cbegin(); i != m_value.object->cend(); ++i)
                {
                    if (i != m_value.object->cbegin())
                    {
N
Niels 已提交
6391
                        o << (pretty_print ? ",\n" : ",");
N
Niels 已提交
6392
                    }
N
Niels 已提交
6393 6394 6395
                    o << string_t(new_indent, ' ') << "\""
                      << escape_string(i->first) << "\":"
                      << (pretty_print ? " " : "");
N
Niels 已提交
6396
                    i->second.dump(o, pretty_print, indent_step, new_indent);
N
Niels 已提交
6397 6398 6399
                }

                // decrease indentation
N
Niels 已提交
6400
                if (pretty_print)
N
Niels 已提交
6401
                {
N
Niels 已提交
6402
                    new_indent -= indent_step;
N
Niels 已提交
6403
                    o << "\n";
N
Niels 已提交
6404 6405
                }

N
Niels 已提交
6406 6407
                o << string_t(new_indent, ' ') + "}";
                return;
N
Niels 已提交
6408 6409
            }

6410
            case value_t::array:
N
Niels 已提交
6411 6412 6413
            {
                if (m_value.array->empty())
                {
N
Niels 已提交
6414 6415
                    o << "[]";
                    return;
N
Niels 已提交
6416 6417
                }

N
Niels 已提交
6418
                o << "[";
N
Niels 已提交
6419 6420

                // increase indentation
N
Niels 已提交
6421
                if (pretty_print)
N
Niels 已提交
6422
                {
N
Niels 已提交
6423
                    new_indent += indent_step;
N
Niels 已提交
6424
                    o << "\n";
N
Niels 已提交
6425 6426 6427 6428 6429 6430
                }

                for (auto i = m_value.array->cbegin(); i != m_value.array->cend(); ++i)
                {
                    if (i != m_value.array->cbegin())
                    {
N
Niels 已提交
6431
                        o << (pretty_print ? ",\n" : ",");
N
Niels 已提交
6432
                    }
N
Niels 已提交
6433
                    o << string_t(new_indent, ' ');
N
Niels 已提交
6434
                    i->dump(o, pretty_print, indent_step, new_indent);
N
Niels 已提交
6435 6436 6437
                }

                // decrease indentation
N
Niels 已提交
6438
                if (pretty_print)
N
Niels 已提交
6439
                {
N
Niels 已提交
6440
                    new_indent -= indent_step;
N
Niels 已提交
6441
                    o << "\n";
N
Niels 已提交
6442 6443
                }

N
Niels 已提交
6444 6445
                o << string_t(new_indent, ' ') << "]";
                return;
N
Niels 已提交
6446 6447
            }

6448
            case value_t::string:
N
Niels 已提交
6449
            {
N
Niels 已提交
6450
                o << string_t("\"") << escape_string(*m_value.string) << "\"";
N
Niels 已提交
6451
                return;
N
Niels 已提交
6452 6453
            }

6454
            case value_t::boolean:
N
Niels 已提交
6455
            {
N
Niels 已提交
6456 6457
                o << (m_value.boolean ? "true" : "false");
                return;
N
Niels 已提交
6458 6459
            }

6460
            case value_t::number_integer:
N
Niels 已提交
6461
            {
N
Niels 已提交
6462 6463
                o << m_value.number_integer;
                return;
N
Niels 已提交
6464 6465
            }

6466 6467 6468 6469 6470 6471
            case value_t::number_unsigned:
            {
                o << m_value.number_unsigned;
                return;
            }

6472
            case value_t::number_float:
N
Niels 已提交
6473
            {
N
Niels 已提交
6474
                if (m_value.number_float == 0)
N
Niels 已提交
6475
                {
N
Niels 已提交
6476 6477
                    // special case for zero to get "0.0"/"-0.0"
                    o << (std::signbit(m_value.number_float) ? "-0.0" : "0.0");
N
Niels 已提交
6478
                }
N
Niels 已提交
6479
                else
N
Niels 已提交
6480
                {
6481
                    o << m_value.number_float;
N
Niels 已提交
6482
                }
N
Niels 已提交
6483
                return;
N
Niels 已提交
6484
            }
N
Niels 已提交
6485

6486
            case value_t::discarded:
N
Niels 已提交
6487
            {
N
Niels 已提交
6488 6489
                o << "<discarded>";
                return;
N
Niels 已提交
6490
            }
N
Niels 已提交
6491

6492
            case value_t::null:
N
Niels 已提交
6493
            {
N
Niels 已提交
6494 6495
                o << "null";
                return;
N
Niels 已提交
6496
            }
N
Niels 已提交
6497 6498 6499 6500 6501 6502 6503 6504 6505
        }
    }

  private:
    //////////////////////
    // member variables //
    //////////////////////

    /// the type of the current element
N
Niels 已提交
6506
    value_t m_type = value_t::null;
N
Niels 已提交
6507 6508 6509 6510

    /// the value of the current element
    json_value m_value = {};

N
Niels 已提交
6511

N
Niels 已提交
6512
  private:
N
Niels 已提交
6513 6514 6515 6516
    ///////////////
    // iterators //
    ///////////////

6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529
    /*!
    @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 已提交
6530
        void set_begin() noexcept
6531 6532 6533 6534 6535
        {
            m_it = begin_value;
        }

        /// set iterator to a defined past the end
N
Niels 已提交
6536
        void set_end() noexcept
6537 6538 6539 6540 6541
        {
            m_it = end_value;
        }

        /// return whether the iterator can be dereferenced
N
Niels 已提交
6542
        constexpr bool is_begin() const noexcept
6543 6544 6545 6546 6547
        {
            return (m_it == begin_value);
        }

        /// return whether the iterator is at end
N
Niels 已提交
6548
        constexpr bool is_end() const noexcept
6549 6550 6551 6552 6553
        {
            return (m_it == end_value);
        }

        /// return reference to the value to change and compare
N
Niels 已提交
6554
        operator difference_type& () noexcept
6555 6556 6557 6558 6559
        {
            return m_it;
        }

        /// return value to compare
N
Niels 已提交
6560
        constexpr operator difference_type () const noexcept
6561 6562 6563 6564 6565 6566 6567 6568 6569
        {
            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 已提交
6570
        difference_type m_it = std::numeric_limits<std::ptrdiff_t>::denorm_min();
6571 6572
    };

N
Niels 已提交
6573 6574 6575 6576 6577 6578 6579 6580
    /*!
    @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 已提交
6581 6582
    {
        /// iterator for JSON objects
N
Niels 已提交
6583
        typename object_t::iterator object_iterator;
N
Niels 已提交
6584
        /// iterator for JSON arrays
N
Niels 已提交
6585
        typename array_t::iterator array_iterator;
N
Niels 已提交
6586
        /// generic iterator for all other types
N
Niels 已提交
6587 6588 6589
        primitive_iterator_t primitive_iterator;

        /// create an uninitialized internal_iterator
N
Niels 已提交
6590
        internal_iterator() noexcept
N
Niels 已提交
6591 6592
            : object_iterator(), array_iterator(), primitive_iterator()
        {}
N
Niels 已提交
6593 6594
    };

N
cleanup  
Niels 已提交
6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609
    /// 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 已提交
6610
            explicit iteration_proxy_internal(IteratorType it) noexcept
N
cleanup  
Niels 已提交
6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629
                : 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 已提交
6630
            bool operator!= (const iteration_proxy_internal& o) const
N
cleanup  
Niels 已提交
6631 6632 6633 6634 6635 6636 6637
            {
                return anchor != o.anchor;
            }

            /// return key of the iterator
            typename basic_json::string_t key() const
            {
N
Niels 已提交
6638 6639
                assert(anchor.m_object != nullptr);

N
cleanup  
Niels 已提交
6640 6641 6642 6643 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
                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 已提交
6674
        explicit iteration_proxy(typename IteratorType::reference cont)
N
cleanup  
Niels 已提交
6675 6676 6677 6678
            : container(cont)
        {}

        /// return iterator begin (needed for range-based for)
N
Niels 已提交
6679
        iteration_proxy_internal begin() noexcept
N
cleanup  
Niels 已提交
6680 6681 6682 6683 6684
        {
            return iteration_proxy_internal(container.begin());
        }

        /// return iterator end (needed for range-based for)
N
Niels 已提交
6685
        iteration_proxy_internal end() noexcept
N
cleanup  
Niels 已提交
6686 6687 6688 6689 6690
        {
            return iteration_proxy_internal(container.end());
        }
    };

N
Niels 已提交
6691
  public:
N
Niels 已提交
6692 6693 6694 6695 6696 6697
    /*!
    @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 已提交
6698 6699 6700
    @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 已提交
6701 6702
          methods are undefined. **The library uses assertions to detect calls
          on uninitialized iterators.**
N
Niels 已提交
6703

N
Niels 已提交
6704 6705 6706 6707
    @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 已提交
6708

N
Niels 已提交
6709
    @since version 1.0.0
N
Niels 已提交
6710
    */
N
Niels 已提交
6711
    class const_iterator : public std::iterator<std::random_access_iterator_tag, const basic_json>
N
Niels 已提交
6712
    {
N
Niels 已提交
6713
        /// allow basic_json to access private members
6714 6715
        friend class basic_json;

N
Niels 已提交
6716 6717
      public:
        /// the type of the values when the iterator is dereferenced
N
Niels 已提交
6718
        using value_type = typename basic_json::value_type;
N
Niels 已提交
6719
        /// a type to represent differences between iterators
N
Niels 已提交
6720
        using difference_type = typename basic_json::difference_type;
N
Niels 已提交
6721
        /// defines a pointer to the type iterated over (value_type)
N
Niels 已提交
6722
        using pointer = typename basic_json::const_pointer;
N
Niels 已提交
6723
        /// defines a reference to the type iterated over (value_type)
N
Niels 已提交
6724
        using reference = typename basic_json::const_reference;
N
Niels 已提交
6725
        /// the category of the iterator
N
Niels 已提交
6726
        using iterator_category = std::bidirectional_iterator_tag;
N
Niels 已提交
6727

6728
        /// default constructor
N
Niels 已提交
6729
        const_iterator() = default;
6730

N
Niels 已提交
6731 6732 6733 6734 6735 6736
        /*!
        @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 已提交
6737 6738
        explicit const_iterator(pointer object) noexcept
            : m_object(object)
N
Niels 已提交
6739
        {
N
Niels 已提交
6740 6741
            assert(m_object != nullptr);

N
Niels 已提交
6742 6743
            switch (m_object->m_type)
            {
6744
                case basic_json::value_t::object:
N
Niels 已提交
6745 6746 6747 6748
                {
                    m_it.object_iterator = typename object_t::iterator();
                    break;
                }
6749 6750

                case basic_json::value_t::array:
N
Niels 已提交
6751 6752 6753 6754
                {
                    m_it.array_iterator = typename array_t::iterator();
                    break;
                }
6755

N
Niels 已提交
6756 6757
                default:
                {
6758
                    m_it.primitive_iterator = primitive_iterator_t();
N
Niels 已提交
6759 6760 6761 6762 6763
                    break;
                }
            }
        }

N
Niels 已提交
6764 6765 6766 6767 6768
        /*!
        @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 已提交
6769 6770
        explicit const_iterator(const iterator& other) noexcept
            : m_object(other.m_object)
N
Niels 已提交
6771
        {
N
Niels 已提交
6772
            if (m_object != nullptr)
N
Niels 已提交
6773
            {
N
Niels 已提交
6774
                switch (m_object->m_type)
N
Niels 已提交
6775
                {
N
Niels 已提交
6776 6777 6778 6779 6780
                    case basic_json::value_t::object:
                    {
                        m_it.object_iterator = other.m_it.object_iterator;
                        break;
                    }
N
Niels 已提交
6781

N
Niels 已提交
6782 6783 6784 6785 6786
                    case basic_json::value_t::array:
                    {
                        m_it.array_iterator = other.m_it.array_iterator;
                        break;
                    }
N
Niels 已提交
6787

N
Niels 已提交
6788 6789 6790 6791 6792
                    default:
                    {
                        m_it.primitive_iterator = other.m_it.primitive_iterator;
                        break;
                    }
N
Niels 已提交
6793 6794 6795 6796
                }
            }
        }

N
Niels 已提交
6797 6798 6799 6800 6801
        /*!
        @brief copy constructor
        @param[in] other  iterator to copy from
        @note It is not checked whether @a other is initialized.
        */
N
Niels 已提交
6802
        const_iterator(const const_iterator& other) noexcept
N
Niels 已提交
6803 6804 6805
            : m_object(other.m_object), m_it(other.m_it)
        {}

N
Niels 已提交
6806 6807 6808 6809 6810
        /*!
        @brief copy assignment
        @param[in,out] other  iterator to copy from
        @note It is not checked whether @a other is initialized.
        */
N
Niels 已提交
6811
        const_iterator& operator=(const_iterator other) noexcept(
N
Niels 已提交
6812 6813
            std::is_nothrow_move_constructible<pointer>::value and
            std::is_nothrow_move_assignable<pointer>::value and
N
Niels 已提交
6814 6815
            std::is_nothrow_move_constructible<internal_iterator>::value and
            std::is_nothrow_move_assignable<internal_iterator>::value
N
Niels 已提交
6816 6817 6818 6819
        )
        {
            std::swap(m_object, other.m_object);
            std::swap(m_it, other.m_it);
N
Niels 已提交
6820 6821 6822
            return *this;
        }

N
Niels 已提交
6823
      private:
N
Niels 已提交
6824 6825 6826 6827
        /*!
        @brief set the iterator to the first value
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
6828
        void set_begin() noexcept
N
Niels 已提交
6829
        {
N
Niels 已提交
6830 6831
            assert(m_object != nullptr);

N
Niels 已提交
6832 6833
            switch (m_object->m_type)
            {
6834
                case basic_json::value_t::object:
N
Niels 已提交
6835 6836 6837 6838 6839
                {
                    m_it.object_iterator = m_object->m_value.object->begin();
                    break;
                }

6840
                case basic_json::value_t::array:
N
Niels 已提交
6841 6842 6843 6844 6845
                {
                    m_it.array_iterator = m_object->m_value.array->begin();
                    break;
                }

6846
                case basic_json::value_t::null:
N
Niels 已提交
6847
                {
N
Niels 已提交
6848
                    // set to end so begin()==end() is true: null is empty
6849
                    m_it.primitive_iterator.set_end();
N
Niels 已提交
6850 6851 6852 6853 6854
                    break;
                }

                default:
                {
6855
                    m_it.primitive_iterator.set_begin();
N
Niels 已提交
6856 6857 6858 6859 6860
                    break;
                }
            }
        }

N
Niels 已提交
6861 6862 6863 6864
        /*!
        @brief set the iterator past the last value
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
6865
        void set_end() noexcept
N
Niels 已提交
6866
        {
N
Niels 已提交
6867 6868
            assert(m_object != nullptr);

N
Niels 已提交
6869 6870
            switch (m_object->m_type)
            {
6871
                case basic_json::value_t::object:
N
Niels 已提交
6872 6873 6874 6875 6876
                {
                    m_it.object_iterator = m_object->m_value.object->end();
                    break;
                }

6877
                case basic_json::value_t::array:
N
Niels 已提交
6878 6879 6880 6881 6882 6883 6884
                {
                    m_it.array_iterator = m_object->m_value.array->end();
                    break;
                }

                default:
                {
6885
                    m_it.primitive_iterator.set_end();
N
Niels 已提交
6886 6887 6888 6889 6890
                    break;
                }
            }
        }

N
Niels 已提交
6891
      public:
N
Niels 已提交
6892 6893 6894 6895
        /*!
        @brief return a reference to the value pointed to by the iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
6896
        reference operator*() const
N
Niels 已提交
6897
        {
N
Niels 已提交
6898 6899
            assert(m_object != nullptr);

N
Niels 已提交
6900 6901
            switch (m_object->m_type)
            {
6902
                case basic_json::value_t::object:
N
Niels 已提交
6903
                {
N
Niels 已提交
6904
                    assert(m_it.object_iterator != m_object->m_value.object->end());
N
Niels 已提交
6905 6906 6907
                    return m_it.object_iterator->second;
                }

6908
                case basic_json::value_t::array:
N
Niels 已提交
6909
                {
N
Niels 已提交
6910
                    assert(m_it.array_iterator != m_object->m_value.array->end());
N
Niels 已提交
6911 6912 6913
                    return *m_it.array_iterator;
                }

6914
                case basic_json::value_t::null:
N
Niels 已提交
6915 6916 6917 6918 6919 6920
                {
                    throw std::out_of_range("cannot get value");
                }

                default:
                {
6921
                    if (m_it.primitive_iterator.is_begin())
N
Niels 已提交
6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932
                    {
                        return *m_object;
                    }
                    else
                    {
                        throw std::out_of_range("cannot get value");
                    }
                }
            }
        }

N
Niels 已提交
6933 6934 6935 6936
        /*!
        @brief dereference the iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
6937
        pointer operator->() const
N
Niels 已提交
6938
        {
N
Niels 已提交
6939 6940
            assert(m_object != nullptr);

N
Niels 已提交
6941 6942
            switch (m_object->m_type)
            {
6943
                case basic_json::value_t::object:
N
Niels 已提交
6944
                {
N
Niels 已提交
6945
                    assert(m_it.object_iterator != m_object->m_value.object->end());
N
Niels 已提交
6946 6947 6948
                    return &(m_it.object_iterator->second);
                }

6949
                case basic_json::value_t::array:
N
Niels 已提交
6950
                {
N
Niels 已提交
6951
                    assert(m_it.array_iterator != m_object->m_value.array->end());
N
Niels 已提交
6952 6953 6954 6955 6956
                    return &*m_it.array_iterator;
                }

                default:
                {
6957
                    if (m_it.primitive_iterator.is_begin())
N
Niels 已提交
6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968
                    {
                        return m_object;
                    }
                    else
                    {
                        throw std::out_of_range("cannot get value");
                    }
                }
            }
        }

N
Niels 已提交
6969 6970 6971 6972
        /*!
        @brief post-increment (it++)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
6973
        const_iterator operator++(int)
N
Niels 已提交
6974
        {
N
Niels 已提交
6975
            auto result = *this;
N
Niels 已提交
6976
            ++(*this);
N
Niels 已提交
6977 6978 6979
            return result;
        }

N
Niels 已提交
6980 6981 6982 6983
        /*!
        @brief pre-increment (++it)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
6984
        const_iterator& operator++()
N
Niels 已提交
6985
        {
N
Niels 已提交
6986 6987
            assert(m_object != nullptr);

N
Niels 已提交
6988 6989
            switch (m_object->m_type)
            {
6990
                case basic_json::value_t::object:
N
Niels 已提交
6991
                {
N
Niels 已提交
6992
                    std::advance(m_it.object_iterator, 1);
N
Niels 已提交
6993 6994 6995
                    break;
                }

6996
                case basic_json::value_t::array:
N
Niels 已提交
6997
                {
N
Niels 已提交
6998
                    std::advance(m_it.array_iterator, 1);
N
Niels 已提交
6999 7000 7001 7002 7003
                    break;
                }

                default:
                {
7004
                    ++m_it.primitive_iterator;
N
Niels 已提交
7005 7006 7007 7008 7009 7010 7011
                    break;
                }
            }

            return *this;
        }

N
Niels 已提交
7012 7013 7014 7015
        /*!
        @brief post-decrement (it--)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7016
        const_iterator operator--(int)
N
Niels 已提交
7017
        {
N
Niels 已提交
7018
            auto result = *this;
N
Niels 已提交
7019
            --(*this);
N
Niels 已提交
7020 7021 7022
            return result;
        }

N
Niels 已提交
7023 7024 7025 7026
        /*!
        @brief pre-decrement (--it)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7027
        const_iterator& operator--()
N
Niels 已提交
7028
        {
N
Niels 已提交
7029 7030
            assert(m_object != nullptr);

N
Niels 已提交
7031 7032
            switch (m_object->m_type)
            {
7033
                case basic_json::value_t::object:
N
Niels 已提交
7034
                {
N
Niels 已提交
7035
                    std::advance(m_it.object_iterator, -1);
N
Niels 已提交
7036 7037 7038
                    break;
                }

7039
                case basic_json::value_t::array:
N
Niels 已提交
7040
                {
N
Niels 已提交
7041
                    std::advance(m_it.array_iterator, -1);
N
Niels 已提交
7042 7043 7044 7045 7046
                    break;
                }

                default:
                {
7047
                    --m_it.primitive_iterator;
N
Niels 已提交
7048 7049 7050 7051 7052 7053 7054
                    break;
                }
            }

            return *this;
        }

N
Niels 已提交
7055 7056 7057 7058
        /*!
        @brief  comparison: equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7059
        bool operator==(const const_iterator& other) const
N
Niels 已提交
7060
        {
N
Niels 已提交
7061 7062
            // if objects are not the same, the comparison is undefined
            if (m_object != other.m_object)
N
Niels 已提交
7063
            {
N
Niels 已提交
7064
                throw std::domain_error("cannot compare iterators of different containers");
N
Niels 已提交
7065 7066
            }

N
Niels 已提交
7067 7068
            assert(m_object != nullptr);

N
Niels 已提交
7069 7070
            switch (m_object->m_type)
            {
7071
                case basic_json::value_t::object:
N
Niels 已提交
7072 7073 7074 7075
                {
                    return (m_it.object_iterator == other.m_it.object_iterator);
                }

7076
                case basic_json::value_t::array:
N
Niels 已提交
7077 7078 7079 7080 7081 7082
                {
                    return (m_it.array_iterator == other.m_it.array_iterator);
                }

                default:
                {
7083
                    return (m_it.primitive_iterator == other.m_it.primitive_iterator);
N
Niels 已提交
7084 7085 7086 7087
                }
            }
        }

N
Niels 已提交
7088 7089 7090 7091
        /*!
        @brief  comparison: not equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7092
        bool operator!=(const const_iterator& other) const
N
Niels 已提交
7093 7094 7095 7096
        {
            return not operator==(other);
        }

N
Niels 已提交
7097 7098 7099 7100
        /*!
        @brief  comparison: smaller
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7101
        bool operator<(const const_iterator& other) const
N
Niels 已提交
7102 7103 7104 7105 7106 7107 7108
        {
            // 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 已提交
7109 7110
            assert(m_object != nullptr);

N
Niels 已提交
7111 7112
            switch (m_object->m_type)
            {
7113
                case basic_json::value_t::object:
N
Niels 已提交
7114
                {
N
Niels 已提交
7115
                    throw std::domain_error("cannot compare order of object iterators");
N
Niels 已提交
7116 7117
                }

7118
                case basic_json::value_t::array:
N
Niels 已提交
7119 7120 7121 7122 7123 7124
                {
                    return (m_it.array_iterator < other.m_it.array_iterator);
                }

                default:
                {
7125
                    return (m_it.primitive_iterator < other.m_it.primitive_iterator);
N
Niels 已提交
7126 7127 7128 7129
                }
            }
        }

N
Niels 已提交
7130 7131 7132 7133
        /*!
        @brief  comparison: less than or equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7134
        bool operator<=(const const_iterator& other) const
N
Niels 已提交
7135 7136 7137 7138
        {
            return not other.operator < (*this);
        }

N
Niels 已提交
7139 7140 7141 7142
        /*!
        @brief  comparison: greater than
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7143
        bool operator>(const const_iterator& other) const
N
Niels 已提交
7144 7145 7146 7147
        {
            return not operator<=(other);
        }

N
Niels 已提交
7148 7149 7150 7151
        /*!
        @brief  comparison: greater than or equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7152
        bool operator>=(const const_iterator& other) const
N
Niels 已提交
7153 7154 7155 7156
        {
            return not operator<(other);
        }

N
Niels 已提交
7157 7158 7159 7160
        /*!
        @brief  add to iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7161
        const_iterator& operator+=(difference_type i)
N
Niels 已提交
7162
        {
N
Niels 已提交
7163 7164
            assert(m_object != nullptr);

N
Niels 已提交
7165 7166
            switch (m_object->m_type)
            {
7167
                case basic_json::value_t::object:
N
Niels 已提交
7168
                {
N
Niels 已提交
7169
                    throw std::domain_error("cannot use offsets with object iterators");
N
Niels 已提交
7170 7171
                }

7172
                case basic_json::value_t::array:
N
Niels 已提交
7173
                {
N
Niels 已提交
7174
                    std::advance(m_it.array_iterator, i);
N
Niels 已提交
7175 7176 7177 7178 7179
                    break;
                }

                default:
                {
7180
                    m_it.primitive_iterator += i;
N
Niels 已提交
7181 7182 7183 7184 7185 7186 7187
                    break;
                }
            }

            return *this;
        }

N
Niels 已提交
7188 7189 7190 7191
        /*!
        @brief  subtract from iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7192
        const_iterator& operator-=(difference_type i)
N
Niels 已提交
7193 7194 7195 7196
        {
            return operator+=(-i);
        }

N
Niels 已提交
7197 7198 7199 7200
        /*!
        @brief  add to iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7201
        const_iterator operator+(difference_type i)
N
Niels 已提交
7202 7203 7204 7205 7206 7207
        {
            auto result = *this;
            result += i;
            return result;
        }

N
Niels 已提交
7208 7209 7210 7211
        /*!
        @brief  subtract from iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7212
        const_iterator operator-(difference_type i)
N
Niels 已提交
7213 7214 7215 7216 7217 7218
        {
            auto result = *this;
            result -= i;
            return result;
        }

N
Niels 已提交
7219 7220 7221 7222
        /*!
        @brief  return difference
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7223
        difference_type operator-(const const_iterator& other) const
N
Niels 已提交
7224
        {
N
Niels 已提交
7225 7226
            assert(m_object != nullptr);

N
Niels 已提交
7227 7228
            switch (m_object->m_type)
            {
7229
                case basic_json::value_t::object:
N
Niels 已提交
7230
                {
N
Niels 已提交
7231
                    throw std::domain_error("cannot use offsets with object iterators");
N
Niels 已提交
7232 7233
                }

7234
                case basic_json::value_t::array:
N
Niels 已提交
7235 7236 7237 7238 7239 7240
                {
                    return m_it.array_iterator - other.m_it.array_iterator;
                }

                default:
                {
7241
                    return m_it.primitive_iterator - other.m_it.primitive_iterator;
N
Niels 已提交
7242 7243 7244 7245
                }
            }
        }

N
Niels 已提交
7246 7247 7248 7249
        /*!
        @brief  access to successor
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7250
        reference operator[](difference_type n) const
N
Niels 已提交
7251
        {
N
Niels 已提交
7252 7253
            assert(m_object != nullptr);

N
Niels 已提交
7254 7255
            switch (m_object->m_type)
            {
7256
                case basic_json::value_t::object:
N
Niels 已提交
7257 7258 7259 7260
                {
                    throw std::domain_error("cannot use operator[] for object iterators");
                }

7261
                case basic_json::value_t::array:
N
Niels 已提交
7262
                {
N
Niels 已提交
7263
                    return *std::next(m_it.array_iterator, n);
N
Niels 已提交
7264 7265
                }

7266
                case basic_json::value_t::null:
N
Niels 已提交
7267 7268 7269 7270 7271 7272
                {
                    throw std::out_of_range("cannot get value");
                }

                default:
                {
7273
                    if (m_it.primitive_iterator == -n)
N
Niels 已提交
7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284
                    {
                        return *m_object;
                    }
                    else
                    {
                        throw std::out_of_range("cannot get value");
                    }
                }
            }
        }

N
Niels 已提交
7285 7286 7287 7288
        /*!
        @brief  return the key of an object iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7289
        typename object_t::key_type key() const
N
Niels 已提交
7290
        {
N
Niels 已提交
7291
            assert(m_object != nullptr);
N
Niels 已提交
7292

7293 7294 7295 7296 7297 7298 7299
            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 已提交
7300 7301 7302
            }
        }

N
Niels 已提交
7303 7304 7305 7306
        /*!
        @brief  return the value of an iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
N
Niels 已提交
7307
        reference value() const
N
Niels 已提交
7308 7309 7310 7311
        {
            return operator*();
        }

N
Niels 已提交
7312 7313 7314 7315
      private:
        /// associated JSON instance
        pointer m_object = nullptr;
        /// the actual iterator of the associated instance
N
Niels 已提交
7316
        internal_iterator m_it = internal_iterator();
N
Niels 已提交
7317 7318
    };

N
Niels 已提交
7319 7320 7321 7322 7323 7324 7325 7326 7327
    /*!
    @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 已提交
7328

N
Niels 已提交
7329
    @since version 1.0.0
N
Niels 已提交
7330
    */
N
Niels 已提交
7331
    class iterator : public const_iterator
N
Niels 已提交
7332 7333
    {
      public:
N
Niels 已提交
7334 7335 7336
        using base_iterator = const_iterator;
        using pointer = typename basic_json::pointer;
        using reference = typename basic_json::reference;
N
Niels 已提交
7337

7338
        /// default constructor
N
Niels 已提交
7339
        iterator() = default;
7340

N
Niels 已提交
7341
        /// constructor for a given JSON instance
N
Niels 已提交
7342
        explicit iterator(pointer object) noexcept
N
cleanup  
Niels 已提交
7343
            : base_iterator(object)
N
Niels 已提交
7344
        {}
N
Niels 已提交
7345

N
Niels 已提交
7346
        /// copy constructor
N
Niels 已提交
7347 7348
        iterator(const iterator& other) noexcept
            : base_iterator(other)
N
Niels 已提交
7349 7350
        {}

N
Niels 已提交
7351
        /// copy assignment
N
Niels 已提交
7352
        iterator& operator=(iterator other) noexcept(
N
Niels 已提交
7353 7354
            std::is_nothrow_move_constructible<pointer>::value and
            std::is_nothrow_move_assignable<pointer>::value and
N
Niels 已提交
7355 7356
            std::is_nothrow_move_constructible<internal_iterator>::value and
            std::is_nothrow_move_assignable<internal_iterator>::value
N
Niels 已提交
7357 7358
        )
        {
N
Niels 已提交
7359
            base_iterator::operator=(other);
N
Niels 已提交
7360 7361 7362
            return *this;
        }

N
Niels 已提交
7363
        /// return a reference to the value pointed to by the iterator
7364
        reference operator*() const
N
Niels 已提交
7365
        {
N
Niels 已提交
7366 7367
            return const_cast<reference>(base_iterator::operator*());
        }
N
Niels 已提交
7368

N
Niels 已提交
7369
        /// dereference the iterator
7370
        pointer operator->() const
N
Niels 已提交
7371 7372 7373
        {
            return const_cast<pointer>(base_iterator::operator->());
        }
N
Niels 已提交
7374

N
Niels 已提交
7375 7376 7377 7378 7379 7380 7381
        /// post-increment (it++)
        iterator operator++(int)
        {
            iterator result = *this;
            base_iterator::operator++();
            return result;
        }
N
Niels 已提交
7382

N
Niels 已提交
7383 7384 7385 7386 7387
        /// pre-increment (++it)
        iterator& operator++()
        {
            base_iterator::operator++();
            return *this;
N
Niels 已提交
7388 7389
        }

N
Niels 已提交
7390 7391
        /// post-decrement (it--)
        iterator operator--(int)
N
Niels 已提交
7392
        {
N
Niels 已提交
7393 7394 7395 7396
            iterator result = *this;
            base_iterator::operator--();
            return result;
        }
N
Niels 已提交
7397

N
Niels 已提交
7398 7399 7400 7401 7402 7403
        /// pre-decrement (--it)
        iterator& operator--()
        {
            base_iterator::operator--();
            return *this;
        }
N
Niels 已提交
7404 7405

        /// add to iterator
N
Niels 已提交
7406
        iterator& operator+=(difference_type i)
N
Niels 已提交
7407
        {
N
Niels 已提交
7408
            base_iterator::operator+=(i);
N
Niels 已提交
7409 7410 7411 7412
            return *this;
        }

        /// subtract from iterator
N
Niels 已提交
7413
        iterator& operator-=(difference_type i)
N
Niels 已提交
7414
        {
N
Niels 已提交
7415 7416
            base_iterator::operator-=(i);
            return *this;
N
Niels 已提交
7417 7418 7419
        }

        /// add to iterator
N
Niels 已提交
7420
        iterator operator+(difference_type i)
N
Niels 已提交
7421 7422 7423 7424 7425 7426 7427
        {
            auto result = *this;
            result += i;
            return result;
        }

        /// subtract from iterator
N
Niels 已提交
7428
        iterator operator-(difference_type i)
N
Niels 已提交
7429 7430 7431 7432 7433 7434
        {
            auto result = *this;
            result -= i;
            return result;
        }

N
Niels 已提交
7435
        /// return difference
N
Niels 已提交
7436
        difference_type operator-(const iterator& other) const
N
Niels 已提交
7437
        {
N
Niels 已提交
7438
            return base_iterator::operator-(other);
N
Niels 已提交
7439 7440 7441
        }

        /// access to successor
N
Niels 已提交
7442
        reference operator[](difference_type n) const
N
Niels 已提交
7443
        {
N
Niels 已提交
7444
            return const_cast<reference>(base_iterator::operator[](n));
N
Niels 已提交
7445 7446
        }

7447
        /// return the value of an iterator
N
Niels 已提交
7448
        reference value() const
N
Niels 已提交
7449
        {
N
Niels 已提交
7450
            return const_cast<reference>(base_iterator::value());
N
Niels 已提交
7451
        }
N
Niels 已提交
7452 7453
    };

N
Niels 已提交
7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467
    /*!
    @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 已提交
7468

N
Niels 已提交
7469
    @since version 1.0.0
N
Niels 已提交
7470
    */
N
Niels 已提交
7471 7472
    template<typename Base>
    class json_reverse_iterator : public std::reverse_iterator<Base>
7473 7474
    {
      public:
7475
        /// shortcut to the reverse iterator adaptor
N
Niels 已提交
7476
        using base_iterator = std::reverse_iterator<Base>;
N
Niels 已提交
7477
        /// the reference type for the pointed-to element
N
Niels 已提交
7478
        using reference = typename Base::reference;
7479

7480
        /// create reverse iterator from iterator
N
Niels 已提交
7481
        json_reverse_iterator(const typename base_iterator::iterator_type& it) noexcept
N
cleanup  
Niels 已提交
7482 7483
            : base_iterator(it)
        {}
7484 7485

        /// create reverse iterator from base class
N
Niels 已提交
7486
        json_reverse_iterator(const base_iterator& it) noexcept
N
cleanup  
Niels 已提交
7487 7488
            : base_iterator(it)
        {}
7489 7490

        /// post-increment (it++)
N
Niels 已提交
7491
        json_reverse_iterator operator++(int)
7492 7493 7494 7495 7496
        {
            return base_iterator::operator++(1);
        }

        /// pre-increment (++it)
N
Niels 已提交
7497
        json_reverse_iterator& operator++()
7498 7499 7500 7501 7502 7503
        {
            base_iterator::operator++();
            return *this;
        }

        /// post-decrement (it--)
N
Niels 已提交
7504
        json_reverse_iterator operator--(int)
7505 7506 7507 7508 7509
        {
            return base_iterator::operator--(1);
        }

        /// pre-decrement (--it)
N
Niels 已提交
7510
        json_reverse_iterator& operator--()
7511 7512 7513 7514 7515 7516
        {
            base_iterator::operator--();
            return *this;
        }

        /// add to iterator
N
Niels 已提交
7517
        json_reverse_iterator& operator+=(difference_type i)
7518 7519 7520 7521 7522 7523
        {
            base_iterator::operator+=(i);
            return *this;
        }

        /// add to iterator
N
Niels 已提交
7524
        json_reverse_iterator operator+(difference_type i) const
7525 7526 7527 7528 7529 7530 7531
        {
            auto result = *this;
            result += i;
            return result;
        }

        /// subtract from iterator
N
Niels 已提交
7532
        json_reverse_iterator operator-(difference_type i) const
7533 7534 7535 7536 7537 7538 7539
        {
            auto result = *this;
            result -= i;
            return result;
        }

        /// return difference
N
Niels 已提交
7540
        difference_type operator-(const json_reverse_iterator& other) const
7541 7542 7543 7544 7545 7546 7547 7548 7549
        {
            return this->base() - other.base();
        }

        /// access to successor
        reference operator[](difference_type n) const
        {
            return *(this->operator+(n));
        }
N
Niels 已提交
7550

7551
        /// return the key of an object iterator
N
Niels 已提交
7552
        typename object_t::key_type key() const
7553
        {
N
Niels 已提交
7554 7555
            auto it = --this->base();
            return it.key();
7556 7557 7558
        }

        /// return the value of an iterator
N
Niels 已提交
7559
        reference value() const
7560
        {
N
Niels 已提交
7561 7562
            auto it = --this->base();
            return it.operator * ();
7563 7564 7565
        }
    };

N
Niels 已提交
7566

N
Niels 已提交
7567
  private:
N
Niels 已提交
7568 7569 7570
    //////////////////////
    // lexer and parser //
    //////////////////////
N
Niels 已提交
7571

N
Niels 已提交
7572 7573 7574 7575
    /*!
    @brief lexical analysis

    This class organizes the lexical analysis during JSON deserialization. The
N
Niels 已提交
7576 7577
    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 已提交
7578
    */
N
Niels 已提交
7579
    class lexer
N
Niels 已提交
7580
    {
N
Niels 已提交
7581
      public:
N
Niels 已提交
7582 7583 7584
        /// token types for the parser
        enum class token_type
        {
N
Niels 已提交
7585
            uninitialized,   ///< indicating the scanner is uninitialized
N
Niels 已提交
7586 7587 7588
            literal_true,    ///< the `true` literal
            literal_false,   ///< the `false` literal
            literal_null,    ///< the `null` literal
N
Niels 已提交
7589 7590
            value_string,    ///< a string -- use get_string() for actual value
            value_number,    ///< a number -- use get_number() for actual value
N
Niels 已提交
7591 7592 7593 7594 7595 7596
            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 已提交
7597 7598
            parse_error,     ///< indicating a parse error
            end_of_input     ///< indicating the end of the input buffer
N
Niels 已提交
7599 7600
        };

N
Niels 已提交
7601
        /// the char type to use in the lexer
N
Niels 已提交
7602
        using lexer_char_t = unsigned char;
N
Niels 已提交
7603

7604 7605
        /// a lexer from a buffer with given length
        lexer(const lexer_char_t* buff, const size_t len) noexcept
N
cleanup  
Niels 已提交
7606
            : m_content(buff)
N
Niels 已提交
7607
        {
N
Niels 已提交
7608
            assert(m_content != nullptr);
N
Niels 已提交
7609
            m_start = m_cursor = m_content;
7610
            m_limit = m_content + len;
N
Niels 已提交
7611
        }
N
Niels 已提交
7612

7613 7614
        /// a lexer from an input stream
        explicit lexer(std::istream& s)
N
cleanup  
Niels 已提交
7615
            : m_stream(&s), m_line_buffer()
N
Niels 已提交
7616
        {
N
cleanup  
Niels 已提交
7617 7618
            // fill buffer
            fill_line_buffer();
N
Niels 已提交
7619
        }
N
Niels 已提交
7620

N
Niels 已提交
7621
        // switch off unwanted functions (due to pointer members)
N
cleanup  
Niels 已提交
7622
        lexer() = delete;
N
Niels 已提交
7623 7624 7625
        lexer(const lexer&) = delete;
        lexer operator=(const lexer&) = delete;

N
Niels 已提交
7626
        /*!
N
Niels 已提交
7627 7628 7629 7630 7631 7632
        @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 已提交
7633

N
Niels 已提交
7634 7635
        @param[in] codepoint1  the code point (can be high surrogate)
        @param[in] codepoint2  the code point (can be low surrogate or 0)
N
Niels 已提交
7636

N
Niels 已提交
7637 7638
        @return string representation of the code point; the length of the
        result string is between 1 and 4 characters.
N
Niels 已提交
7639

N
Niels 已提交
7640
        @throw std::out_of_range if code point is > 0x10ffff; example: `"code
N
Niels 已提交
7641
        points above 0x10FFFF are invalid"`
N
Niels 已提交
7642 7643
        @throw std::invalid_argument if the low surrogate is invalid; example:
        `""missing or wrong low surrogate""`
N
Niels 已提交
7644

N
Niels 已提交
7645 7646
        @complexity Constant.

N
Niels 已提交
7647 7648
        @see <http://en.wikipedia.org/wiki/UTF-8#Sample_code>
        */
N
Niels 已提交
7649 7650
        static string_t to_unicode(const std::size_t codepoint1,
                                   const std::size_t codepoint2 = 0)
N
Niels 已提交
7651
        {
N
Niels 已提交
7652
            // calculate the code point from the given code points
N
Niels 已提交
7653
            std::size_t codepoint = codepoint1;
N
Niels 已提交
7654 7655

            // check if codepoint1 is a high surrogate
N
Niels 已提交
7656 7657
            if (codepoint1 >= 0xD800 and codepoint1 <= 0xDBFF)
            {
N
Niels 已提交
7658
                // check if codepoint2 is a low surrogate
N
Niels 已提交
7659 7660 7661 7662 7663 7664 7665 7666
                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 已提交
7667
                        // in the result so we have to subtract with:
N
Niels 已提交
7668 7669 7670 7671 7672 7673 7674 7675 7676
                        // (0xD800 << 10) + DC00 - 0x10000 = 0x35FDC00
                        - 0x35FDC00;
                }
                else
                {
                    throw std::invalid_argument("missing or wrong low surrogate");
                }
            }

N
Niels 已提交
7677 7678
            string_t result;

N
Niels 已提交
7679
            if (codepoint < 0x80)
N
Niels 已提交
7680
            {
N
Niels 已提交
7681
                // 1-byte characters: 0xxxxxxx (ASCII)
N
Niels 已提交
7682
                result.append(1, static_cast<typename string_t::value_type>(codepoint));
N
Niels 已提交
7683 7684 7685 7686
            }
            else if (codepoint <= 0x7ff)
            {
                // 2-byte characters: 110xxxxx 10xxxxxx
N
Niels 已提交
7687 7688
                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 已提交
7689 7690 7691 7692
            }
            else if (codepoint <= 0xffff)
            {
                // 3-byte characters: 1110xxxx 10xxxxxx 10xxxxxx
N
Niels 已提交
7693 7694 7695
                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 已提交
7696 7697 7698 7699
            }
            else if (codepoint <= 0x10ffff)
            {
                // 4-byte characters: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
N
Niels 已提交
7700 7701 7702 7703
                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 已提交
7704 7705 7706
            }
            else
            {
N
Niels 已提交
7707
                throw std::out_of_range("code points above 0x10FFFF are invalid");
N
Niels 已提交
7708 7709 7710 7711 7712
            }

            return result;
        }

7713
        /// return name of values of type token_type (only used for errors)
N
Niels 已提交
7714
        static std::string token_type_name(const token_type t)
N
cleanup  
Niels 已提交
7715 7716 7717
        {
            switch (t)
            {
7718
                case token_type::uninitialized:
N
cleanup  
Niels 已提交
7719
                    return "<uninitialized>";
7720
                case token_type::literal_true:
N
cleanup  
Niels 已提交
7721
                    return "true literal";
7722
                case token_type::literal_false:
N
cleanup  
Niels 已提交
7723
                    return "false literal";
7724
                case token_type::literal_null:
N
cleanup  
Niels 已提交
7725
                    return "null literal";
7726
                case token_type::value_string:
N
cleanup  
Niels 已提交
7727
                    return "string literal";
7728
                case token_type::value_number:
N
cleanup  
Niels 已提交
7729
                    return "number literal";
7730
                case token_type::begin_array:
N
Niels 已提交
7731
                    return "'['";
7732
                case token_type::begin_object:
N
Niels 已提交
7733
                    return "'{'";
7734
                case token_type::end_array:
N
Niels 已提交
7735
                    return "']'";
7736
                case token_type::end_object:
N
Niels 已提交
7737
                    return "'}'";
7738
                case token_type::name_separator:
N
Niels 已提交
7739
                    return "':'";
7740
                case token_type::value_separator:
N
Niels 已提交
7741
                    return "','";
7742
                case token_type::parse_error:
N
Niels 已提交
7743
                    return "<parse error>";
7744
                case token_type::end_of_input:
N
Niels 已提交
7745
                    return "end of input";
N
Niels 已提交
7746 7747 7748 7749 7750
                default:
                {
                    // catch non-enum values
                    return "unknown token"; // LCOV_EXCL_LINE
                }
N
cleanup  
Niels 已提交
7751 7752 7753
            }
        }

N
fixes  
Niels 已提交
7754 7755
        /*!
        This function implements a scanner for JSON. It is specified using
7756
        regular expressions that try to follow RFC 7159 as close as possible.
7757 7758 7759 7760
        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 已提交
7761 7762

        @return the class of the next token read from the buffer
N
Niels 已提交
7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773

        @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 已提交
7774
        */
N
cleanup  
Niels 已提交
7775
        token_type scan()
N
Niels 已提交
7776
        {
N
Niels 已提交
7777 7778 7779 7780
            while (true)
            {
                // pointer for backtracking information
                m_marker = nullptr;
N
Niels 已提交
7781

N
Niels 已提交
7782 7783 7784
                // remember the begin of the token
                m_start = m_cursor;
                assert(m_start != nullptr);
N
Niels 已提交
7785

N
Niels 已提交
7786

N
Niels 已提交
7787
                {
N
Niels 已提交
7788 7789 7790 7791 7792 7793
                    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 已提交
7794 7795
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
N
Niels 已提交
7796 7797 7798 7799 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
                        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)
                    {
7827
                        fill_line_buffer();
N
Niels 已提交
7828 7829 7830
                    }
                    yych = *m_cursor;
                    if (yybm[0 + yych] & 32)
N
Niels 已提交
7831
                    {
N
Niels 已提交
7832 7833 7834 7835 7836
                        goto basic_json_parser_6;
                    }
                    if (yych <= '\\')
                    {
                        if (yych <= '-')
N
Niels 已提交
7837
                        {
N
Niels 已提交
7838
                            if (yych <= '"')
N
Niels 已提交
7839
                            {
N
Niels 已提交
7840 7841 7842 7843 7844 7845 7846 7847 7848
                                if (yych <= 0x00)
                                {
                                    goto basic_json_parser_2;
                                }
                                if (yych <= '!')
                                {
                                    goto basic_json_parser_4;
                                }
                                goto basic_json_parser_9;
N
Niels 已提交
7849
                            }
N
Niels 已提交
7850
                            else
N
Niels 已提交
7851
                            {
N
Niels 已提交
7852 7853 7854 7855 7856 7857 7858 7859 7860
                                if (yych <= '+')
                                {
                                    goto basic_json_parser_4;
                                }
                                if (yych <= ',')
                                {
                                    goto basic_json_parser_10;
                                }
                                goto basic_json_parser_12;
N
Niels 已提交
7861 7862 7863 7864
                            }
                        }
                        else
                        {
N
Niels 已提交
7865
                            if (yych <= '9')
N
Niels 已提交
7866
                            {
N
Niels 已提交
7867 7868 7869 7870 7871 7872 7873 7874 7875
                                if (yych <= '/')
                                {
                                    goto basic_json_parser_4;
                                }
                                if (yych <= '0')
                                {
                                    goto basic_json_parser_13;
                                }
                                goto basic_json_parser_15;
N
Niels 已提交
7876
                            }
N
Niels 已提交
7877
                            else
N
Niels 已提交
7878
                            {
N
Niels 已提交
7879 7880 7881 7882 7883 7884 7885 7886 7887
                                if (yych <= ':')
                                {
                                    goto basic_json_parser_17;
                                }
                                if (yych == '[')
                                {
                                    goto basic_json_parser_19;
                                }
                                goto basic_json_parser_4;
N
Niels 已提交
7888 7889 7890 7891 7892
                            }
                        }
                    }
                    else
                    {
N
Niels 已提交
7893
                        if (yych <= 't')
N
Niels 已提交
7894
                        {
N
Niels 已提交
7895
                            if (yych <= 'f')
N
Niels 已提交
7896
                            {
N
Niels 已提交
7897 7898 7899 7900 7901 7902 7903 7904 7905
                                if (yych <= ']')
                                {
                                    goto basic_json_parser_21;
                                }
                                if (yych <= 'e')
                                {
                                    goto basic_json_parser_4;
                                }
                                goto basic_json_parser_23;
N
Niels 已提交
7906
                            }
N
Niels 已提交
7907
                            else
N
Niels 已提交
7908
                            {
N
Niels 已提交
7909 7910 7911 7912 7913 7914 7915 7916 7917
                                if (yych == 'n')
                                {
                                    goto basic_json_parser_24;
                                }
                                if (yych <= 's')
                                {
                                    goto basic_json_parser_4;
                                }
                                goto basic_json_parser_25;
N
Niels 已提交
7918 7919 7920 7921
                            }
                        }
                        else
                        {
N
Niels 已提交
7922
                            if (yych <= '|')
N
Niels 已提交
7923
                            {
N
Niels 已提交
7924 7925 7926 7927 7928
                                if (yych == '{')
                                {
                                    goto basic_json_parser_26;
                                }
                                goto basic_json_parser_4;
N
Niels 已提交
7929
                            }
N
Niels 已提交
7930
                            else
N
Niels 已提交
7931
                            {
N
Niels 已提交
7932 7933 7934 7935 7936 7937 7938 7939 7940
                                if (yych <= '}')
                                {
                                    goto basic_json_parser_28;
                                }
                                if (yych == 0xEF)
                                {
                                    goto basic_json_parser_30;
                                }
                                goto basic_json_parser_4;
N
Niels 已提交
7941 7942
                            }
                        }
N
Niels 已提交
7943
                    }
N
Niels 已提交
7944 7945
basic_json_parser_2:
                    ++m_cursor;
N
Niels 已提交
7946
                    {
N
Niels 已提交
7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960
                        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)
                    {
7961
                        fill_line_buffer();
N
Niels 已提交
7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973
                    }
                    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 已提交
7974
                    if (yych <= 0x1F)
N
Niels 已提交
7975 7976 7977 7978 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
                    {
                        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)
                    {
8031
                        fill_line_buffer();
N
Niels 已提交
8032 8033 8034 8035 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
                    }
                    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)
                    {
8124
                        fill_line_buffer();
N
Niels 已提交
8125 8126 8127 8128 8129 8130 8131
                    }
                    yych = *m_cursor;
basic_json_parser_32:
                    if (yybm[0 + yych] & 128)
                    {
                        goto basic_json_parser_31;
                    }
N
Niels 已提交
8132
                    if (yych <= 0x1F)
N
Niels 已提交
8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160
                    {
                        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)
                    {
8161
                        fill_line_buffer();
N
Niels 已提交
8162 8163 8164 8165 8166
                    }
                    yych = *m_cursor;
                    if (yych <= 'e')
                    {
                        if (yych <= '/')
N
Niels 已提交
8167
                        {
N
Niels 已提交
8168
                            if (yych == '"')
N
Niels 已提交
8169
                            {
N
Niels 已提交
8170
                                goto basic_json_parser_31;
N
Niels 已提交
8171
                            }
N
Niels 已提交
8172
                            if (yych <= '.')
N
Niels 已提交
8173
                            {
N
Niels 已提交
8174
                                goto basic_json_parser_33;
N
Niels 已提交
8175
                            }
N
Niels 已提交
8176
                            goto basic_json_parser_31;
N
Niels 已提交
8177 8178 8179
                        }
                        else
                        {
N
Niels 已提交
8180
                            if (yych <= '\\')
N
Niels 已提交
8181
                            {
N
Niels 已提交
8182 8183 8184 8185 8186
                                if (yych <= '[')
                                {
                                    goto basic_json_parser_33;
                                }
                                goto basic_json_parser_31;
N
Niels 已提交
8187
                            }
N
Niels 已提交
8188
                            else
N
Niels 已提交
8189
                            {
N
Niels 已提交
8190 8191 8192 8193 8194
                                if (yych == 'b')
                                {
                                    goto basic_json_parser_31;
                                }
                                goto basic_json_parser_33;
N
Niels 已提交
8195 8196 8197 8198 8199
                            }
                        }
                    }
                    else
                    {
N
Niels 已提交
8200
                        if (yych <= 'q')
N
Niels 已提交
8201
                        {
N
Niels 已提交
8202
                            if (yych <= 'f')
N
Niels 已提交
8203
                            {
N
Niels 已提交
8204
                                goto basic_json_parser_31;
N
Niels 已提交
8205
                            }
N
Niels 已提交
8206 8207 8208 8209 8210
                            if (yych == 'n')
                            {
                                goto basic_json_parser_31;
                            }
                            goto basic_json_parser_33;
N
Niels 已提交
8211 8212 8213
                        }
                        else
                        {
N
Niels 已提交
8214
                            if (yych <= 's')
N
Niels 已提交
8215
                            {
N
Niels 已提交
8216 8217 8218 8219 8220
                                if (yych <= 'r')
                                {
                                    goto basic_json_parser_31;
                                }
                                goto basic_json_parser_33;
N
Niels 已提交
8221
                            }
N
Niels 已提交
8222
                            else
N
Niels 已提交
8223
                            {
N
Niels 已提交
8224 8225 8226 8227 8228 8229 8230 8231 8232
                                if (yych <= 't')
                                {
                                    goto basic_json_parser_31;
                                }
                                if (yych <= 'u')
                                {
                                    goto basic_json_parser_43;
                                }
                                goto basic_json_parser_33;
N
Niels 已提交
8233 8234
                            }
                        }
N
Niels 已提交
8235
                    }
N
Niels 已提交
8236 8237 8238
basic_json_parser_37:
                    yych = *++m_cursor;
                    if (yych <= '/')
N
Niels 已提交
8239
                    {
N
Niels 已提交
8240
                        goto basic_json_parser_33;
N
Niels 已提交
8241
                    }
N
Niels 已提交
8242
                    if (yych <= '9')
N
Niels 已提交
8243
                    {
N
Niels 已提交
8244
                        goto basic_json_parser_44;
N
Niels 已提交
8245
                    }
N
Niels 已提交
8246 8247 8248 8249
                    goto basic_json_parser_33;
basic_json_parser_38:
                    yych = *++m_cursor;
                    if (yych <= ',')
N
Niels 已提交
8250
                    {
N
Niels 已提交
8251 8252 8253 8254 8255
                        if (yych == '+')
                        {
                            goto basic_json_parser_46;
                        }
                        goto basic_json_parser_33;
N
Niels 已提交
8256
                    }
N
Niels 已提交
8257
                    else
N
Niels 已提交
8258
                    {
N
Niels 已提交
8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271
                        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 已提交
8272
                    }
N
Niels 已提交
8273 8274 8275
basic_json_parser_39:
                    yych = *++m_cursor;
                    if (yych == 'l')
N
Niels 已提交
8276
                    {
N
Niels 已提交
8277
                        goto basic_json_parser_49;
N
Niels 已提交
8278
                    }
N
Niels 已提交
8279 8280 8281 8282
                    goto basic_json_parser_33;
basic_json_parser_40:
                    yych = *++m_cursor;
                    if (yych == 'l')
N
Niels 已提交
8283
                    {
N
Niels 已提交
8284
                        goto basic_json_parser_50;
N
Niels 已提交
8285
                    }
T
Trevor Welsby 已提交
8286
                    goto basic_json_parser_33;
N
Niels 已提交
8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304
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)
                    {
8305
                        fill_line_buffer();
N
Niels 已提交
8306 8307 8308
                    }
                    yych = *m_cursor;
                    if (yych <= '@')
N
Niels 已提交
8309
                    {
N
Niels 已提交
8310
                        if (yych <= '/')
N
Niels 已提交
8311
                        {
N
Niels 已提交
8312
                            goto basic_json_parser_33;
N
Niels 已提交
8313
                        }
N
Niels 已提交
8314
                        if (yych <= '9')
N
Niels 已提交
8315
                        {
N
Niels 已提交
8316
                            goto basic_json_parser_54;
N
Niels 已提交
8317
                        }
N
Niels 已提交
8318
                        goto basic_json_parser_33;
N
Niels 已提交
8319 8320 8321
                    }
                    else
                    {
N
Niels 已提交
8322
                        if (yych <= 'F')
N
Niels 已提交
8323
                        {
N
Niels 已提交
8324
                            goto basic_json_parser_54;
N
Niels 已提交
8325
                        }
N
Niels 已提交
8326
                        if (yych <= '`')
N
Niels 已提交
8327 8328 8329
                        {
                            goto basic_json_parser_33;
                        }
N
Niels 已提交
8330 8331 8332 8333 8334
                        if (yych <= 'f')
                        {
                            goto basic_json_parser_54;
                        }
                        goto basic_json_parser_33;
N
Niels 已提交
8335
                    }
N
Niels 已提交
8336 8337 8338 8339
basic_json_parser_44:
                    yyaccept = 1;
                    m_marker = ++m_cursor;
                    if ((m_limit - m_cursor) < 3)
N
Niels 已提交
8340
                    {
8341
                        fill_line_buffer();
N
Niels 已提交
8342 8343 8344 8345 8346
                    }
                    yych = *m_cursor;
                    if (yych <= 'D')
                    {
                        if (yych <= '/')
N
Niels 已提交
8347
                        {
N
Niels 已提交
8348
                            goto basic_json_parser_14;
N
Niels 已提交
8349
                        }
N
Niels 已提交
8350
                        if (yych <= '9')
N
Niels 已提交
8351
                        {
N
Niels 已提交
8352
                            goto basic_json_parser_44;
N
Niels 已提交
8353
                        }
N
Niels 已提交
8354
                        goto basic_json_parser_14;
N
Niels 已提交
8355 8356 8357
                    }
                    else
                    {
N
Niels 已提交
8358
                        if (yych <= 'E')
N
Niels 已提交
8359
                        {
N
Niels 已提交
8360
                            goto basic_json_parser_38;
N
Niels 已提交
8361
                        }
N
Niels 已提交
8362
                        if (yych == 'e')
N
Niels 已提交
8363
                        {
N
Niels 已提交
8364
                            goto basic_json_parser_38;
N
Niels 已提交
8365
                        }
N
Niels 已提交
8366
                        goto basic_json_parser_14;
N
Niels 已提交
8367
                    }
N
Niels 已提交
8368 8369
basic_json_parser_46:
                    yych = *++m_cursor;
N
Niels 已提交
8370 8371 8372 8373
                    if (yych <= '/')
                    {
                        goto basic_json_parser_33;
                    }
N
Niels 已提交
8374
                    if (yych >= ':')
N
Niels 已提交
8375 8376 8377
                    {
                        goto basic_json_parser_33;
                    }
N
Niels 已提交
8378 8379 8380
basic_json_parser_47:
                    ++m_cursor;
                    if (m_limit <= m_cursor)
N
Niels 已提交
8381
                    {
8382
                        fill_line_buffer();
N
Niels 已提交
8383
                    }
N
Niels 已提交
8384
                    yych = *m_cursor;
N
Niels 已提交
8385
                    if (yych <= '/')
N
Niels 已提交
8386
                    {
N
Niels 已提交
8387
                        goto basic_json_parser_14;
N
Niels 已提交
8388
                    }
N
Niels 已提交
8389
                    if (yych <= '9')
N
Niels 已提交
8390
                    {
N
Niels 已提交
8391
                        goto basic_json_parser_47;
N
Niels 已提交
8392
                    }
N
Niels 已提交
8393
                    goto basic_json_parser_14;
N
Niels 已提交
8394 8395 8396
basic_json_parser_49:
                    yych = *++m_cursor;
                    if (yych == 's')
N
Niels 已提交
8397
                    {
N
Niels 已提交
8398
                        goto basic_json_parser_55;
N
Niels 已提交
8399
                    }
N
Niels 已提交
8400 8401 8402 8403
                    goto basic_json_parser_33;
basic_json_parser_50:
                    yych = *++m_cursor;
                    if (yych == 'l')
N
Niels 已提交
8404
                    {
N
Niels 已提交
8405
                        goto basic_json_parser_56;
N
Niels 已提交
8406
                    }
N
Niels 已提交
8407
                    goto basic_json_parser_33;
N
Niels 已提交
8408
basic_json_parser_51:
N
Niels 已提交
8409 8410 8411 8412 8413 8414
                    yych = *++m_cursor;
                    if (yych == 'e')
                    {
                        goto basic_json_parser_58;
                    }
                    goto basic_json_parser_33;
N
Niels 已提交
8415
basic_json_parser_52:
N
Niels 已提交
8416
                    ++m_cursor;
N
Niels 已提交
8417
                    {
N
Niels 已提交
8418
                        continue;
N
Niels 已提交
8419
                    }
N
Niels 已提交
8420 8421 8422
basic_json_parser_54:
                    ++m_cursor;
                    if (m_limit <= m_cursor)
N
Niels 已提交
8423
                    {
8424
                        fill_line_buffer();
N
Niels 已提交
8425
                    }
N
Niels 已提交
8426 8427
                    yych = *m_cursor;
                    if (yych <= '@')
N
Niels 已提交
8428
                    {
N
Niels 已提交
8429 8430 8431 8432 8433 8434 8435 8436 8437
                        if (yych <= '/')
                        {
                            goto basic_json_parser_33;
                        }
                        if (yych <= '9')
                        {
                            goto basic_json_parser_60;
                        }
                        goto basic_json_parser_33;
N
Niels 已提交
8438
                    }
N
Niels 已提交
8439
                    else
N
Niels 已提交
8440
                    {
N
Niels 已提交
8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452
                        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 已提交
8453
                        goto basic_json_parser_33;
N
Niels 已提交
8454
                    }
N
Niels 已提交
8455 8456 8457
basic_json_parser_55:
                    yych = *++m_cursor;
                    if (yych == 'e')
N
Niels 已提交
8458
                    {
N
Niels 已提交
8459
                        goto basic_json_parser_61;
N
Niels 已提交
8460 8461
                    }
                    goto basic_json_parser_33;
N
Niels 已提交
8462
basic_json_parser_56:
N
Niels 已提交
8463
                    ++m_cursor;
N
Niels 已提交
8464
                    {
N
Niels 已提交
8465 8466
                        last_token_type = token_type::literal_null;
                        break;
N
Niels 已提交
8467
                    }
N
Niels 已提交
8468 8469
basic_json_parser_58:
                    ++m_cursor;
N
Niels 已提交
8470
                    {
N
Niels 已提交
8471 8472
                        last_token_type = token_type::literal_true;
                        break;
N
Niels 已提交
8473
                    }
N
Niels 已提交
8474 8475 8476
basic_json_parser_60:
                    ++m_cursor;
                    if (m_limit <= m_cursor)
N
Niels 已提交
8477
                    {
8478
                        fill_line_buffer();
N
Niels 已提交
8479
                    }
N
Niels 已提交
8480 8481
                    yych = *m_cursor;
                    if (yych <= '@')
N
Niels 已提交
8482
                    {
N
Niels 已提交
8483 8484 8485 8486 8487 8488 8489 8490
                        if (yych <= '/')
                        {
                            goto basic_json_parser_33;
                        }
                        if (yych <= '9')
                        {
                            goto basic_json_parser_63;
                        }
N
Niels 已提交
8491 8492
                        goto basic_json_parser_33;
                    }
N
Niels 已提交
8493
                    else
N
Niels 已提交
8494
                    {
N
Niels 已提交
8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506
                        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 已提交
8507 8508
                        goto basic_json_parser_33;
                    }
N
Niels 已提交
8509 8510
basic_json_parser_61:
                    ++m_cursor;
N
Niels 已提交
8511
                    {
N
Niels 已提交
8512 8513
                        last_token_type = token_type::literal_false;
                        break;
N
Niels 已提交
8514
                    }
N
Niels 已提交
8515 8516 8517
basic_json_parser_63:
                    ++m_cursor;
                    if (m_limit <= m_cursor)
N
Niels 已提交
8518
                    {
8519
                        fill_line_buffer();
N
Niels 已提交
8520
                    }
N
Niels 已提交
8521 8522
                    yych = *m_cursor;
                    if (yych <= '@')
N
Niels 已提交
8523
                    {
N
Niels 已提交
8524 8525 8526 8527 8528 8529 8530 8531
                        if (yych <= '/')
                        {
                            goto basic_json_parser_33;
                        }
                        if (yych <= '9')
                        {
                            goto basic_json_parser_31;
                        }
N
Niels 已提交
8532 8533
                        goto basic_json_parser_33;
                    }
N
Niels 已提交
8534
                    else
N
Niels 已提交
8535
                    {
N
Niels 已提交
8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548
                        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 已提交
8549
                    }
N
Niels 已提交
8550
                }
N
Niels 已提交
8551

N
Niels 已提交
8552
            }
N
Niels 已提交
8553

N
Niels 已提交
8554
            return last_token_type;
N
Niels 已提交
8555 8556
        }

N
cleanup  
Niels 已提交
8557 8558 8559 8560 8561 8562 8563 8564
        /*!
        @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.

8565 8566 8567 8568 8569 8570 8571
        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 已提交
8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585
        @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 已提交
8586
        {
N
cleanup  
Niels 已提交
8587
            // number of processed characters (p)
8588
            const auto offset_start = m_start - m_content;
N
cleanup  
Niels 已提交
8589
            // offset for m_marker wrt. to m_start
8590
            const auto offset_marker = (m_marker == nullptr) ? 0 : m_marker - m_start;
N
cleanup  
Niels 已提交
8591
            // number of unprocessed characters (u)
8592
            const auto offset_cursor = m_cursor - m_start;
N
Niels 已提交
8593

8594
            // no stream is used or end of file is reached
N
Niels 已提交
8595
            if (m_stream == nullptr or m_stream->eof())
8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616
            {
                // 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 已提交
8617
                m_line_buffer += line + "\n";
8618
            }
N
Niels 已提交
8619

N
cleanup  
Niels 已提交
8620 8621
            // set pointers
            m_content = reinterpret_cast<const lexer_char_t*>(m_line_buffer.c_str());
N
Niels 已提交
8622
            assert(m_content != nullptr);
N
Niels 已提交
8623 8624 8625
            m_start  = m_content;
            m_marker = m_start + offset_marker;
            m_cursor = m_start + offset_cursor;
8626
            m_limit  = m_start + m_line_buffer.size();
N
Niels 已提交
8627 8628
        }

N
Niels 已提交
8629
        /// return string representation of last read token
N
Niels 已提交
8630
        string_t get_token_string() const
N
Niels 已提交
8631
        {
N
Niels 已提交
8632
            assert(m_start != nullptr);
N
Niels 已提交
8633 8634
            return string_t(reinterpret_cast<typename string_t::const_pointer>(m_start),
                            static_cast<size_t>(m_cursor - m_start));
N
Niels 已提交
8635 8636 8637
        }

        /*!
N
Niels 已提交
8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648
        @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 已提交
8649 8650
           characters (e.g., `"\\n"` is replaced by `"\n"`), some are copied
           as is (e.g., `"\\\\"`). Furthermore, Unicode escapes of the shape
N
Niels 已提交
8651 8652
           `"\\uxxxx"` need special care. In this case, to_unicode takes care
           of the construction of the values.
N
Niels 已提交
8653
        2. Unescaped characters are copied as is.
N
Niels 已提交
8654

N
Niels 已提交
8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669
        @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 已提交
8670 8671 8672
        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 已提交
8673 8674 8675 8676 8677 8678 8679

        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 已提交
8680 8681
        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 已提交
8682
        precondition, we x <= 0, meaning that the loop condition holds
N
Niels 已提交
8683 8684 8685 8686 8687 8688
        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 已提交
8689

N
Niels 已提交
8690 8691
        @return string value of current token without opening and closing
        quotes
N
Niels 已提交
8692
        @throw std::out_of_range if to_unicode fails
N
Niels 已提交
8693
        */
N
Niels 已提交
8694
        string_t get_string() const
N
Niels 已提交
8695
        {
N
Niels 已提交
8696 8697
            assert(m_cursor - m_start >= 2);

N
Niels 已提交
8698
            string_t result;
N
Niels 已提交
8699 8700 8701
            result.reserve(static_cast<size_t>(m_cursor - m_start - 2));

            // iterate the result between the quotes
N
Niels 已提交
8702
            for (const lexer_char_t* i = m_start + 1; i < m_cursor - 1; ++i)
N
Niels 已提交
8703 8704 8705 8706 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
            {
                // 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 已提交
8740
                            result += "\\";
N
Niels 已提交
8741 8742 8743 8744
                            break;
                        }
                        case '/':
                        {
N
Niels 已提交
8745
                            result += "/";
N
Niels 已提交
8746 8747 8748 8749
                            break;
                        }
                        case '"':
                        {
N
Niels 已提交
8750
                            result += "\"";
N
Niels 已提交
8751 8752 8753 8754 8755 8756
                            break;
                        }

                        // unicode
                        case 'u':
                        {
N
Niels 已提交
8757
                            // get code xxxx from uxxxx
N
Niels 已提交
8758 8759
                            auto codepoint = std::strtoul(std::string(reinterpret_cast<typename string_t::const_pointer>(i + 1),
                                                          4).c_str(), nullptr, 16);
N
Niels 已提交
8760

N
Niels 已提交
8761
                            // check if codepoint is a high surrogate
N
Niels 已提交
8762 8763
                            if (codepoint >= 0xD800 and codepoint <= 0xDBFF)
                            {
N
Niels 已提交
8764
                                // make sure there is a subsequent unicode
N
Niels 已提交
8765
                                if ((i + 6 >= m_limit) or * (i + 5) != '\\' or * (i + 6) != 'u')
N
Niels 已提交
8766 8767 8768 8769
                                {
                                    throw std::invalid_argument("missing low surrogate");
                                }

N
Niels 已提交
8770
                                // get code yyyy from uxxxx\uyyyy
N
Niels 已提交
8771 8772
                                auto codepoint2 = std::strtoul(std::string(reinterpret_cast<typename string_t::const_pointer>
                                                               (i + 7), 4).c_str(), nullptr, 16);
N
Niels 已提交
8773
                                result += to_unicode(codepoint, codepoint2);
8774 8775
                                // skip the next 10 characters (xxxx\uyyyy)
                                i += 10;
N
Niels 已提交
8776 8777 8778 8779 8780 8781 8782 8783
                            }
                            else
                            {
                                // add unicode character(s)
                                result += to_unicode(codepoint);
                                // skip the next four characters (xxxx)
                                i += 4;
                            }
N
Niels 已提交
8784 8785 8786 8787 8788 8789 8790 8791
                            break;
                        }
                    }
                }
                else
                {
                    // all other characters are just copied to the end of the
                    // string
N
Niels 已提交
8792
                    result.append(1, static_cast<typename string_t::value_type>(*i));
N
Niels 已提交
8793 8794 8795 8796
                }
            }

            return result;
N
Niels 已提交
8797 8798
        }

8799 8800 8801 8802
        /*!
        @brief parse floating point number

        This function (and its overloads) serves to select the most approprate
8803
        standard floating point number parsing function based on the type
N
Niels 已提交
8804 8805
        supplied via the first parameter.  Set this to @a
        static_cast<number_float_t*>(nullptr).
8806

N
Niels 已提交
8807
        @param[in] type  the @ref number_float_t in use
8808

N
Niels 已提交
8809 8810
        @param[in,out] endptr recieves a pointer to the first character after
        the number
8811 8812 8813

        @return the floating point number
        */
8814
        long double str_to_float_t(long double* /* type */, char** endptr) const
8815 8816 8817 8818
        {
            return std::strtold(reinterpret_cast<typename string_t::const_pointer>(m_start), endptr);
        }

8819 8820 8821 8822 8823
        /*!
        @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 已提交
8824 8825
        supplied via the first parameter.  Set this to @a
        static_cast<number_float_t*>(nullptr).
8826

N
Niels 已提交
8827
        @param[in] type  the @ref number_float_t in use
8828

N
Niels 已提交
8829 8830
        @param[in,out] endptr  recieves a pointer to the first character after
        the number
8831 8832 8833

        @return the floating point number
        */
8834
        double str_to_float_t(double* /* type */, char** endptr) const
8835 8836 8837 8838
        {
            return std::strtod(reinterpret_cast<typename string_t::const_pointer>(m_start), endptr);
        }

8839 8840 8841 8842 8843
        /*!
        @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 已提交
8844 8845
        supplied via the first parameter.  Set this to @a
        static_cast<number_float_t*>(nullptr).
8846

N
Niels 已提交
8847
        @param[in] type  the @ref number_float_t in use
8848

N
Niels 已提交
8849 8850
        @param[in,out] endptr  recieves a pointer to the first character after
        the number
8851 8852 8853

        @return the floating point number
        */
8854
        float str_to_float_t(float* /* type */, char** endptr) const
8855 8856 8857 8858
        {
            return std::strtof(reinterpret_cast<typename string_t::const_pointer>(m_start), endptr);
        }

8859 8860
        /*!
        @brief return number value for number tokens
N
Niels 已提交
8861

N
Niels 已提交
8862
        This function translates the last token into the most appropriate
N
Niels 已提交
8863 8864 8865 8866 8867 8868
        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 已提交
8869 8870 8871
        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 已提交
8872 8873 8874 8875 8876

        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 已提交
8877 8878
        NAN if the conversion read past the current token. The latter case
        needs to be treated by the caller function.
N
Niels 已提交
8879
        */
8880
        void get_number(basic_json& result) const
N
Niels 已提交
8881
        {
N
Niels 已提交
8882
            assert(m_start != nullptr);
N
Niels 已提交
8883

N
Niels 已提交
8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896
            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 == '-')
8897
            {
N
Niels 已提交
8898
                type = value_t::number_integer;
N
Niels 已提交
8899
                max = static_cast<uint64_t>((std::numeric_limits<number_integer_t>::max)()) + 1;
N
Niels 已提交
8900 8901 8902 8903 8904
                curptr++;
            }
            else
            {
                type = value_t::number_unsigned;
T
Tom Needham 已提交
8905
                max = static_cast<uint64_t>((std::numeric_limits<number_unsigned_t>::max)());
8906
            }
N
Niels 已提交
8907 8908 8909

            // count the significant figures
            for (; curptr < m_cursor; curptr++)
8910
            {
N
Niels 已提交
8911 8912
                // quickly skip tests if a digit
                if (*curptr < '0' || *curptr > '9')
N
Niels 已提交
8913
                {
N
Niels 已提交
8914 8915 8916 8917 8918 8919 8920 8921 8922 8923
                    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 已提交
8924
                }
N
Niels 已提交
8925 8926 8927

                // skip if definitely not an integer
                if (type != value_t::number_float)
N
Niels 已提交
8928
                {
N
Niels 已提交
8929
                    // multiply last value by ten and add the new digit
N
Niels 已提交
8930
                    auto temp = value * 10 + *curptr - '0';
N
Niels 已提交
8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942

                    // test for overflow
                    if (temp < value || temp > max)
                    {
                        // overflow
                        type = value_t::number_float;
                    }
                    else
                    {
                        // no overflow - save it
                        value = temp;
                    }
N
Niels 已提交
8943
                }
8944
            }
N
Niels 已提交
8945

N
Niels 已提交
8946 8947
            // save the value (if not a float)
            if (type == value_t::number_unsigned)
N
Niels 已提交
8948
            {
N
Niels 已提交
8949
                result.m_value.number_unsigned = value;
N
Niels 已提交
8950
            }
N
Niels 已提交
8951 8952 8953 8954 8955
            else if (type == value_t::number_integer)
            {
                result.m_value.number_integer = -static_cast<number_integer_t>(value);
            }
            else
8956
            {
N
Niels 已提交
8957
                // parse with strtod
N
Niels 已提交
8958
                result.m_value.number_float = str_to_float_t(static_cast<number_float_t*>(nullptr), NULL);
8959
            }
N
Niels 已提交
8960 8961 8962

            // save the type
            result.m_type = type;
N
Niels 已提交
8963 8964 8965
        }

      private:
N
Niels 已提交
8966
        /// optional input stream
N
Niels 已提交
8967
        std::istream* m_stream = nullptr;
N
cleanup  
Niels 已提交
8968 8969
        /// line buffer buffer for m_stream
        string_t m_line_buffer {};
N
Niels 已提交
8970
        /// the buffer pointer
N
Niels 已提交
8971
        const lexer_char_t* m_content = nullptr;
N
Niels 已提交
8972
        /// pointer to the beginning of the current symbol
N
Niels 已提交
8973
        const lexer_char_t* m_start = nullptr;
N
Niels 已提交
8974 8975
        /// pointer for backtracking information
        const lexer_char_t* m_marker = nullptr;
N
fixes  
Niels 已提交
8976
        /// pointer to the current symbol
N
Niels 已提交
8977
        const lexer_char_t* m_cursor = nullptr;
N
fixes  
Niels 已提交
8978
        /// pointer to the end of the buffer
N
Niels 已提交
8979
        const lexer_char_t* m_limit = nullptr;
N
Niels 已提交
8980 8981
        /// the last token type
        token_type last_token_type = token_type::end_of_input;
N
Niels 已提交
8982 8983
    };

N
Niels 已提交
8984 8985
    /*!
    @brief syntax analysis
N
Niels 已提交
8986 8987

    This class implements a recursive decent parser.
N
Niels 已提交
8988
    */
N
Niels 已提交
8989 8990 8991
    class parser
    {
      public:
8992
        /// a parser reading from a string literal
N
Niels 已提交
8993
        parser(const char* buff, const parser_callback_t cb = nullptr)
N
cleanup  
Niels 已提交
8994
            : callback(cb),
8995
              m_lexer(reinterpret_cast<const typename lexer::lexer_char_t*>(buff), strlen(buff))
N
cleanup  
Niels 已提交
8996
        {}
8997

N
Niels 已提交
8998
        /// a parser reading from an input stream
N
cleanup  
Niels 已提交
8999
        parser(std::istream& is, const parser_callback_t cb = nullptr)
9000
            : callback(cb), m_lexer(is)
N
cleanup  
Niels 已提交
9001
        {}
9002

N
Niels 已提交
9003
        /// a parser reading from an iterator range with contiguous storage
N
Niels 已提交
9004 9005 9006 9007
        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 已提交
9008
        parser(IteratorType first, IteratorType last, const parser_callback_t cb = nullptr)
9009 9010 9011
            : callback(cb),
              m_lexer(reinterpret_cast<const typename lexer::lexer_char_t*>(&(*first)),
                      static_cast<size_t>(std::distance(first, last)))
9012
        {}
N
Niels 已提交
9013

N
Niels 已提交
9014
        /// public parser interface
N
Niels 已提交
9015
        basic_json parse()
N
Niels 已提交
9016
        {
N
cleanup  
Niels 已提交
9017 9018 9019
            // read first token
            get_token();

N
Niels 已提交
9020
            basic_json result = parse_internal(true);
9021
            result.assert_invariant();
N
Niels 已提交
9022 9023 9024

            expect(lexer::token_type::end_of_input);

N
Niels 已提交
9025 9026
            // return parser result and replace it with null in case the
            // top-level value was discarded by the callback function
9027
            return result.is_discarded() ? basic_json() : std::move(result);
N
Niels 已提交
9028 9029 9030 9031
        }

      private:
        /// the actual parser
N
Niels 已提交
9032
        basic_json parse_internal(bool keep)
N
Niels 已提交
9033
        {
N
Niels 已提交
9034 9035
            auto result = basic_json(value_t::discarded);

N
Niels 已提交
9036 9037
            switch (last_token)
            {
9038
                case lexer::token_type::begin_object:
N
Niels 已提交
9039
                {
N
Niels 已提交
9040 9041
                    if (keep and (not callback
                                  or ((keep = callback(depth++, parse_event_t::object_start, result)) != 0)))
N
Niels 已提交
9042 9043
                    {
                        // explicitly set result to object to cope with {}
N
Niels 已提交
9044
                        result.m_type = value_t::object;
9045
                        result.m_value = value_t::object;
N
Niels 已提交
9046
                    }
N
Niels 已提交
9047 9048 9049 9050 9051 9052 9053

                    // read next token
                    get_token();

                    // closing } -> we are done
                    if (last_token == lexer::token_type::end_object)
                    {
N
Niels 已提交
9054
                        get_token();
N
Niels 已提交
9055
                        if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
N
Niels 已提交
9056 9057 9058
                        {
                            result = basic_json(value_t::discarded);
                        }
N
Niels 已提交
9059
                        return result;
N
Niels 已提交
9060 9061
                    }

N
Niels 已提交
9062 9063 9064
                    // no comma is expected here
                    unexpect(lexer::token_type::value_separator);

N
Niels 已提交
9065 9066 9067
                    // otherwise: parse key-value pairs
                    do
                    {
N
Niels 已提交
9068 9069 9070 9071 9072 9073
                        // ugly, but could be fixed with loop reorganization
                        if (last_token == lexer::token_type::value_separator)
                        {
                            get_token();
                        }

N
Niels 已提交
9074 9075 9076 9077
                        // store key
                        expect(lexer::token_type::value_string);
                        const auto key = m_lexer.get_string();

N
Niels 已提交
9078 9079 9080
                        bool keep_tag = false;
                        if (keep)
                        {
N
Niels 已提交
9081 9082 9083 9084 9085 9086 9087 9088 9089
                            if (callback)
                            {
                                basic_json k(key);
                                keep_tag = callback(depth, parse_event_t::key, k);
                            }
                            else
                            {
                                keep_tag = true;
                            }
N
Niels 已提交
9090 9091
                        }

N
Niels 已提交
9092 9093 9094 9095
                        // parse separator (:)
                        get_token();
                        expect(lexer::token_type::name_separator);

9096
                        // parse and add value
N
Niels 已提交
9097
                        get_token();
N
Niels 已提交
9098 9099 9100
                        auto value = parse_internal(keep);
                        if (keep and keep_tag and not value.is_discarded())
                        {
N
Niels 已提交
9101
                            result[key] = std::move(value);
N
Niels 已提交
9102
                        }
N
Niels 已提交
9103
                    }
N
Niels 已提交
9104
                    while (last_token == lexer::token_type::value_separator);
N
Niels 已提交
9105 9106 9107

                    // closing }
                    expect(lexer::token_type::end_object);
N
Niels 已提交
9108
                    get_token();
N
Niels 已提交
9109
                    if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
N
Niels 已提交
9110 9111 9112
                    {
                        result = basic_json(value_t::discarded);
                    }
N
Niels 已提交
9113 9114

                    return result;
N
Niels 已提交
9115 9116
                }

9117
                case lexer::token_type::begin_array:
N
Niels 已提交
9118
                {
N
Niels 已提交
9119 9120
                    if (keep and (not callback
                                  or ((keep = callback(depth++, parse_event_t::array_start, result)) != 0)))
N
Niels 已提交
9121 9122
                    {
                        // explicitly set result to object to cope with []
N
Niels 已提交
9123
                        result.m_type = value_t::array;
9124
                        result.m_value = value_t::array;
N
Niels 已提交
9125
                    }
N
Niels 已提交
9126 9127 9128 9129 9130 9131 9132

                    // read next token
                    get_token();

                    // closing ] -> we are done
                    if (last_token == lexer::token_type::end_array)
                    {
N
Niels 已提交
9133
                        get_token();
N
Niels 已提交
9134
                        if (callback and not callback(--depth, parse_event_t::array_end, result))
N
Niels 已提交
9135 9136 9137
                        {
                            result = basic_json(value_t::discarded);
                        }
N
Niels 已提交
9138
                        return result;
N
Niels 已提交
9139 9140
                    }

N
Niels 已提交
9141 9142 9143
                    // no comma is expected here
                    unexpect(lexer::token_type::value_separator);

N
Niels 已提交
9144 9145 9146
                    // otherwise: parse values
                    do
                    {
N
Niels 已提交
9147 9148 9149 9150 9151
                        // ugly, but could be fixed with loop reorganization
                        if (last_token == lexer::token_type::value_separator)
                        {
                            get_token();
                        }
N
Niels 已提交
9152

N
Niels 已提交
9153 9154 9155 9156
                        // parse value
                        auto value = parse_internal(keep);
                        if (keep and not value.is_discarded())
                        {
N
Niels 已提交
9157
                            result.push_back(std::move(value));
N
Niels 已提交
9158
                        }
N
Niels 已提交
9159
                    }
N
Niels 已提交
9160
                    while (last_token == lexer::token_type::value_separator);
N
Niels 已提交
9161 9162 9163

                    // closing ]
                    expect(lexer::token_type::end_array);
N
Niels 已提交
9164
                    get_token();
N
Niels 已提交
9165
                    if (keep and callback and not callback(--depth, parse_event_t::array_end, result))
N
Niels 已提交
9166 9167 9168
                    {
                        result = basic_json(value_t::discarded);
                    }
N
Niels 已提交
9169 9170

                    return result;
N
Niels 已提交
9171 9172
                }

9173
                case lexer::token_type::literal_null:
N
Niels 已提交
9174
                {
N
Niels 已提交
9175
                    get_token();
N
Niels 已提交
9176
                    result.m_type = value_t::null;
N
Niels 已提交
9177
                    break;
N
Niels 已提交
9178 9179
                }

9180
                case lexer::token_type::value_string:
N
Niels 已提交
9181
                {
N
Niels 已提交
9182
                    const auto s = m_lexer.get_string();
N
Niels 已提交
9183
                    get_token();
N
Niels 已提交
9184 9185
                    result = basic_json(s);
                    break;
N
Niels 已提交
9186 9187
                }

9188
                case lexer::token_type::literal_true:
N
Niels 已提交
9189
                {
N
Niels 已提交
9190
                    get_token();
N
Niels 已提交
9191 9192
                    result.m_type = value_t::boolean;
                    result.m_value = true;
N
Niels 已提交
9193
                    break;
N
Niels 已提交
9194 9195
                }

9196
                case lexer::token_type::literal_false:
N
Niels 已提交
9197
                {
N
Niels 已提交
9198
                    get_token();
N
Niels 已提交
9199 9200
                    result.m_type = value_t::boolean;
                    result.m_value = false;
N
Niels 已提交
9201
                    break;
N
Niels 已提交
9202 9203
                }

9204
                case lexer::token_type::value_number:
N
Niels 已提交
9205
                {
9206
                    m_lexer.get_number(result);
N
Niels 已提交
9207
                    get_token();
N
Niels 已提交
9208
                    break;
N
Niels 已提交
9209 9210 9211 9212
                }

                default:
                {
N
Niels 已提交
9213 9214
                    // the last token was unexpected
                    unexpect(last_token);
N
Niels 已提交
9215 9216
                }
            }
N
Niels 已提交
9217

N
Niels 已提交
9218
            if (keep and callback and not callback(depth, parse_event_t::value, result))
N
Niels 已提交
9219 9220 9221 9222
            {
                result = basic_json(value_t::discarded);
            }
            return result;
N
Niels 已提交
9223 9224 9225
        }

        /// get next token from lexer
N
cleanup  
Niels 已提交
9226
        typename lexer::token_type get_token()
N
Niels 已提交
9227 9228 9229 9230 9231
        {
            last_token = m_lexer.scan();
            return last_token;
        }

N
Niels 已提交
9232
        void expect(typename lexer::token_type t) const
N
Niels 已提交
9233 9234 9235
        {
            if (t != last_token)
            {
N
Niels 已提交
9236
                std::string error_msg = "parse error - unexpected ";
N
Niels 已提交
9237 9238
                error_msg += (last_token == lexer::token_type::parse_error ? ("'" +  m_lexer.get_token_string() +
                              "'") :
N
Niels 已提交
9239 9240
                              lexer::token_type_name(last_token));
                error_msg += "; expected " + lexer::token_type_name(t);
N
Niels 已提交
9241 9242 9243 9244
                throw std::invalid_argument(error_msg);
            }
        }

N
Niels 已提交
9245
        void unexpect(typename lexer::token_type t) const
N
Niels 已提交
9246 9247 9248
        {
            if (t == last_token)
            {
N
Niels 已提交
9249
                std::string error_msg = "parse error - unexpected ";
N
Niels 已提交
9250 9251
                error_msg += (last_token == lexer::token_type::parse_error ? ("'" +  m_lexer.get_token_string() +
                              "'") :
N
Niels 已提交
9252
                              lexer::token_type_name(last_token));
N
Niels 已提交
9253 9254 9255 9256
                throw std::invalid_argument(error_msg);
            }
        }

N
Niels 已提交
9257
      private:
N
Niels 已提交
9258
        /// current level of recursion
N
Niels 已提交
9259 9260
        int depth = 0;
        /// callback function
N
Niels 已提交
9261
        const parser_callback_t callback = nullptr;
N
Niels 已提交
9262
        /// the type of the last read token
N
Niels 已提交
9263
        typename lexer::token_type last_token = lexer::token_type::uninitialized;
N
Niels 已提交
9264
        /// the lexer
N
Niels 已提交
9265
        lexer m_lexer;
N
Niels 已提交
9266
    };
N
Niels 已提交
9267 9268

  public:
N
Niels 已提交
9269 9270 9271
    /*!
    @brief JSON Pointer

N
Niels 已提交
9272 9273 9274 9275
    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 已提交
9276
    @sa [RFC 6901](https://tools.ietf.org/html/rfc6901)
N
Niels 已提交
9277 9278

    @since version 2.0.0
N
Niels 已提交
9279
    */
N
Niels 已提交
9280 9281
    class json_pointer
    {
N
Niels 已提交
9282 9283 9284
        /// allow basic_json to access private members
        friend class basic_json;

N
Niels 已提交
9285
      public:
N
Niels 已提交
9286 9287 9288 9289 9290 9291 9292 9293 9294 9295
        /*!
        @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 已提交
9296 9297 9298 9299 9300 9301
        @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 已提交
9302 9303 9304

        @liveexample{The example shows the construction several valid JSON
        pointers as well as the exceptional behavior.,json_pointer}
N
Niels 已提交
9305

N
Niels 已提交
9306 9307 9308
        @since version 2.0.0
        */
        explicit json_pointer(const std::string& s = "")
N
Niels 已提交
9309 9310
            : reference_tokens(split(s))
        {}
N
Niels 已提交
9311

N
Niels 已提交
9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328
        /*!
        @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 已提交
9329 9330
            return std::accumulate(reference_tokens.begin(),
                                   reference_tokens.end(), std::string{},
N
Niels 已提交
9331
                                   [](const std::string & a, const std::string & b)
N
Niels 已提交
9332
            {
N
Niels 已提交
9333 9334
                return a + "/" + escape(b);
            });
N
Niels 已提交
9335 9336 9337 9338
        }

        /// @copydoc to_string()
        operator std::string() const
N
Niels 已提交
9339
        {
N
Niels 已提交
9340
            return to_string();
N
Niels 已提交
9341 9342
        }

N
Niels 已提交
9343
      private:
N
Niels 已提交
9344
        /// remove and return last reference pointer
N
Niels 已提交
9345 9346
        std::string pop_back()
        {
N
Niels 已提交
9347
            if (is_root())
N
Niels 已提交
9348 9349 9350 9351 9352 9353 9354 9355 9356
            {
                throw std::domain_error("JSON pointer has no parent");
            }

            auto last = reference_tokens.back();
            reference_tokens.pop_back();
            return last;
        }

N
Niels 已提交
9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374
        /// 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 已提交
9375 9376
        /*!
        @brief create and return a reference to the pointed to value
N
Niels 已提交
9377 9378

        @complexity Linear in the number of reference tokens.
N
Niels 已提交
9379 9380
        */
        reference get_and_create(reference j) const
N
Niels 已提交
9381
        {
9382
            pointer result = &j;
N
Niels 已提交
9383

N
Niels 已提交
9384 9385
            // in case no reference tokens exist, return a reference to the
            // JSON value j which will be overwritten by a primitive value
N
Niels 已提交
9386 9387
            for (const auto& reference_token : reference_tokens)
            {
9388
                switch (result->m_type)
N
Niels 已提交
9389
                {
N
Niels 已提交
9390 9391 9392 9393
                    case value_t::null:
                    {
                        if (reference_token == "0")
                        {
N
Niels 已提交
9394
                            // start a new array if reference token is 0
N
Niels 已提交
9395 9396 9397 9398
                            result = &result->operator[](0);
                        }
                        else
                        {
N
Niels 已提交
9399
                            // start a new object otherwise
N
Niels 已提交
9400 9401
                            result = &result->operator[](reference_token);
                        }
N
Niels 已提交
9402
                        break;
N
Niels 已提交
9403 9404
                    }

N
Niels 已提交
9405
                    case value_t::object:
N
Niels 已提交
9406
                    {
N
Niels 已提交
9407
                        // create an entry in the object
N
Niels 已提交
9408
                        result = &result->operator[](reference_token);
N
Niels 已提交
9409
                        break;
N
Niels 已提交
9410
                    }
N
Niels 已提交
9411 9412

                    case value_t::array:
N
Niels 已提交
9413
                    {
N
Niels 已提交
9414
                        // create an entry in the array
N
Niels 已提交
9415
                        result = &result->operator[](static_cast<size_type>(std::stoi(reference_token)));
N
Niels 已提交
9416
                        break;
N
Niels 已提交
9417
                    }
N
Niels 已提交
9418

N
Niels 已提交
9419
                    /*
N
Niels 已提交
9420 9421 9422 9423 9424
                    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 已提交
9425
                    */
N
Niels 已提交
9426
                    default:
N
Niels 已提交
9427
                    {
N
Niels 已提交
9428
                        throw std::domain_error("invalid value to unflatten");
N
Niels 已提交
9429
                    }
N
Niels 已提交
9430 9431 9432
                }
            }

9433 9434 9435
            return *result;
        }

N
Niels 已提交
9436 9437 9438 9439 9440 9441 9442 9443 9444
        /*!
        @brief return a reference to the pointed to value

        @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.

9445 9446 9447
        @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 已提交
9448 9449
        */
        reference get_unchecked(pointer ptr) const
N
Niels 已提交
9450
        {
N
Niels 已提交
9451 9452 9453 9454 9455 9456
            for (const auto& reference_token : reference_tokens)
            {
                switch (ptr->m_type)
                {
                    case value_t::object:
                    {
9457
                        // use unchecked object access
N
Niels 已提交
9458 9459 9460 9461 9462 9463
                        ptr = &ptr->operator[](reference_token);
                        break;
                    }

                    case value_t::array:
                    {
9464 9465 9466 9467 9468 9469
                        // 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 已提交
9470 9471
                        if (reference_token == "-")
                        {
9472
                            // explicityly treat "-" as index beyond the end
N
Niels 已提交
9473 9474 9475 9476
                            ptr = &ptr->operator[](ptr->m_value.array->size());
                        }
                        else
                        {
9477
                            // convert array index to number; unchecked access
N
Niels 已提交
9478
                            ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
N
Niels 已提交
9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491
                        }
                        break;
                    }

                    default:
                    {
                        throw std::out_of_range("unresolved reference token '" + reference_token + "'");
                    }
                }
            }

            return *ptr;
        }
N
Niels 已提交
9492

N
Niels 已提交
9493 9494
        reference get_checked(pointer ptr) const
        {
N
Niels 已提交
9495 9496
            for (const auto& reference_token : reference_tokens)
            {
N
Niels 已提交
9497
                switch (ptr->m_type)
N
Niels 已提交
9498
                {
N
Niels 已提交
9499
                    case value_t::object:
N
Niels 已提交
9500
                    {
9501
                        // note: at performs range check
N
Niels 已提交
9502 9503 9504 9505 9506 9507 9508
                        ptr = &ptr->at(reference_token);
                        break;
                    }

                    case value_t::array:
                    {
                        if (reference_token == "-")
N
Niels 已提交
9509
                        {
9510 9511 9512 9513
                            // "-" 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 已提交
9514
                        }
9515 9516 9517

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
N
Niels 已提交
9518
                        {
9519
                            throw std::domain_error("array index must not begin with '0'");
N
Niels 已提交
9520
                        }
9521 9522

                        // note: at performs range check
N
Niels 已提交
9523
                        ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
N
Niels 已提交
9524 9525 9526 9527 9528 9529
                        break;
                    }

                    default:
                    {
                        throw std::out_of_range("unresolved reference token '" + reference_token + "'");
N
Niels 已提交
9530
                    }
N
Niels 已提交
9531 9532 9533 9534 9535 9536 9537 9538 9539 9540
                }
            }

            return *ptr;
        }

        /*!
        @brief return a const reference to the pointed to value

        @param[in] ptr  a JSON value
N
Niels 已提交
9541

N
Niels 已提交
9542 9543 9544 9545 9546 9547 9548 9549 9550
        @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 已提交
9551 9552
                    case value_t::object:
                    {
9553
                        // use unchecked object access
N
Niels 已提交
9554
                        ptr = &ptr->operator[](reference_token);
N
Niels 已提交
9555
                        break;
N
Niels 已提交
9556 9557 9558 9559
                    }

                    case value_t::array:
                    {
N
Niels 已提交
9560 9561
                        if (reference_token == "-")
                        {
9562
                            // "-" cannot be used for const access
N
Niels 已提交
9563 9564 9565 9566
                            throw std::out_of_range("array index '-' (" +
                                                    std::to_string(ptr->m_value.array->size()) +
                                                    ") is out of range");
                        }
9567 9568 9569 9570 9571 9572 9573 9574

                        // 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 已提交
9575
                        ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
N
Niels 已提交
9576
                        break;
N
Niels 已提交
9577 9578 9579 9580
                    }

                    default:
                    {
N
Niels 已提交
9581
                        throw std::out_of_range("unresolved reference token '" + reference_token + "'");
N
Niels 已提交
9582 9583 9584 9585
                    }
                }
            }

N
Niels 已提交
9586
            return *ptr;
N
Niels 已提交
9587 9588
        }

N
Niels 已提交
9589
        const_reference get_checked(const_pointer ptr) const
9590 9591 9592
        {
            for (const auto& reference_token : reference_tokens)
            {
N
Niels 已提交
9593
                switch (ptr->m_type)
9594 9595
                {
                    case value_t::object:
N
Niels 已提交
9596
                    {
9597
                        // note: at performs range check
N
Niels 已提交
9598
                        ptr = &ptr->at(reference_token);
N
Niels 已提交
9599
                        break;
N
Niels 已提交
9600
                    }
9601 9602

                    case value_t::array:
N
Niels 已提交
9603 9604 9605
                    {
                        if (reference_token == "-")
                        {
9606
                            // "-" always fails the range check
N
Niels 已提交
9607 9608 9609 9610
                            throw std::out_of_range("array index '-' (" +
                                                    std::to_string(ptr->m_value.array->size()) +
                                                    ") is out of range");
                        }
9611 9612 9613 9614 9615 9616 9617 9618

                        // 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 已提交
9619
                        ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
N
Niels 已提交
9620
                        break;
N
Niels 已提交
9621
                    }
9622 9623

                    default:
N
Niels 已提交
9624 9625 9626
                    {
                        throw std::out_of_range("unresolved reference token '" + reference_token + "'");
                    }
9627 9628 9629
                }
            }

N
Niels 已提交
9630
            return *ptr;
N
Niels 已提交
9631 9632 9633
        }

        /// split the string input to reference tokens
9634
        static std::vector<std::string> split(const std::string& reference_string)
N
Niels 已提交
9635
        {
N
Niels 已提交
9636 9637
            std::vector<std::string> result;

N
Niels 已提交
9638 9639 9640
            // special case: empty reference string -> no reference tokens
            if (reference_string.empty())
            {
N
Niels 已提交
9641
                return result;
N
Niels 已提交
9642 9643 9644 9645 9646 9647 9648 9649
            }

            // 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 已提交
9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660
            // 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 已提交
9661
                // (will eventually be 0 if slash == std::string::npos)
N
Niels 已提交
9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684
                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'");
                    }
                }
9685

N
Niels 已提交
9686
                // finally, store the reference token
N
Niels 已提交
9687
                unescape(reference_token);
N
Niels 已提交
9688
                result.push_back(reference_token);
9689
            }
N
Niels 已提交
9690 9691

            return result;
N
Niels 已提交
9692
        }
N
Niels 已提交
9693

N
Niels 已提交
9694
      private:
N
Niels 已提交
9695 9696 9697 9698 9699
        /*!
        @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 已提交
9700
        @param[in]     t  the string to replace @a f
N
Niels 已提交
9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722

        @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 已提交
9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740
        /// 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 已提交
9741 9742 9743 9744
        /*!
        @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 已提交
9745 9746

        @note Empty objects or arrays are flattened to `null`.
N
Niels 已提交
9747
        */
N
Niels 已提交
9748
        static void flatten(const std::string& reference_string,
N
Niels 已提交
9749 9750 9751 9752 9753 9754 9755
                            const basic_json& value,
                            basic_json& result)
        {
            switch (value.m_type)
            {
                case value_t::array:
                {
N
Niels 已提交
9756
                    if (value.m_value.array->empty())
N
Niels 已提交
9757
                    {
N
Niels 已提交
9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768
                        // 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 已提交
9769 9770 9771 9772 9773 9774
                    }
                    break;
                }

                case value_t::object:
                {
N
Niels 已提交
9775
                    if (value.m_value.object->empty())
N
Niels 已提交
9776
                    {
N
Niels 已提交
9777 9778 9779 9780 9781 9782 9783 9784
                        // 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 已提交
9785
                            flatten(reference_string + "/" + escape(element.first),
N
Niels 已提交
9786 9787
                                    element.second, result);
                        }
N
Niels 已提交
9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799
                    }
                    break;
                }

                default:
                {
                    // add primitive value with its reference string
                    result[reference_string] = value;
                    break;
                }
            }
        }
N
Niels 已提交
9800 9801 9802 9803

        /*!
        @param[in] value  flattened JSON

N
Niels 已提交
9804
        @return unflattened JSON
N
Niels 已提交
9805
        */
N
Niels 已提交
9806
        static basic_json unflatten(const basic_json& value)
N
Niels 已提交
9807 9808 9809
        {
            if (not value.is_object())
            {
N
Niels 已提交
9810
                throw std::domain_error("only objects can be unflattened");
N
Niels 已提交
9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822
            }

            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 已提交
9823 9824 9825 9826 9827
                // 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 已提交
9828
                json_pointer(element.first).get_and_create(result) = element.second;
N
Niels 已提交
9829 9830 9831 9832
            }

            return result;
        }
N
Niels 已提交
9833 9834 9835

      private:
        /// the reference tokens
N
Niels 已提交
9836
        std::vector<std::string> reference_tokens {};
N
Niels 已提交
9837
    };
N
Niels 已提交
9838

N
Niels 已提交
9839 9840 9841
    //////////////////////////
    // JSON Pointer support //
    //////////////////////////
N
Niels 已提交
9842 9843 9844 9845

    /// @name JSON Pointer functions
    /// @{

N
Niels 已提交
9846 9847 9848 9849
    /*!
    @brief access specified element via JSON Pointer

    Uses a JSON pointer to retrieve a reference to the respective JSON value.
N
Niels 已提交
9850 9851 9852
    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 已提交
9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 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

    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 已提交
9939 9940
    Returns a const reference to the element at with specified JSON pointer @a
    ptr, with bounds checking.
N
Niels 已提交
9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960

    @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 已提交
9961
    /*!
N
Niels 已提交
9962 9963
    @brief return flattened JSON value

N
Niels 已提交
9964 9965 9966 9967
    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 已提交
9968

N
Niels 已提交
9969
    @return an object that maps JSON pointers to primitve values
N
Niels 已提交
9970

N
Niels 已提交
9971 9972
    @note Empty objects and arrays are flattened to `null` and will not be
          reconstructed correctly by the @ref unflatten() function.
N
Niels 已提交
9973 9974 9975 9976 9977 9978 9979 9980 9981

    @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 已提交
9982 9983 9984 9985 9986 9987 9988
    */
    basic_json flatten() const
    {
        basic_json result(value_t::object);
        json_pointer::flatten("", *this, result);
        return result;
    }
N
Niels 已提交
9989 9990

    /*!
N
Niels 已提交
9991 9992 9993 9994 9995 9996 9997 9998 9999 10000
    @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 已提交
10001
    @return the original JSON from a flattened version
N
Niels 已提交
10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015

    @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 已提交
10016
    */
N
Niels 已提交
10017
    basic_json unflatten() const
N
Niels 已提交
10018
    {
N
Niels 已提交
10019
        return json_pointer::unflatten(*this);
N
Niels 已提交
10020
    }
N
Niels 已提交
10021 10022

    /// @}
10023

N
Niels 已提交
10024 10025 10026 10027 10028 10029 10030
    //////////////////////////
    // JSON Patch functions //
    //////////////////////////

    /// @name JSON Patch functions
    /// @{

10031 10032 10033
    /*!
    @brief applies a JSON patch

N
Niels 已提交
10034 10035 10036 10037 10038
    [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 已提交
10039
    @param[in] json_patch  JSON patch document
10040 10041
    @return patched document

N
Niels 已提交
10042 10043 10044 10045 10046 10047 10048 10049 10050 10051 10052 10053 10054 10055
    @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.
10056

N
Niels 已提交
10057 10058 10059 10060 10061 10062 10063 10064 10065
    @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
10066
    */
N
Niels 已提交
10067
    basic_json patch(const basic_json& json_patch) const
10068
    {
N
Niels 已提交
10069
        // make a working copy to apply the patch to
10070 10071
        basic_json result = *this;

N
Niels 已提交
10072 10073 10074 10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104
        // 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 已提交
10105
        // wrapper for "add" operation; add value at ptr
N
Niels 已提交
10106
        const auto operation_add = [&result](json_pointer & ptr, basic_json val)
N
Niels 已提交
10107
        {
N
Niels 已提交
10108 10109
            // adding to the root of the target document means replacing it
            if (ptr.is_root())
N
Niels 已提交
10110
            {
N
Niels 已提交
10111
                result = val;
N
Niels 已提交
10112
            }
N
Niels 已提交
10113
            else
N
Niels 已提交
10114
            {
N
Niels 已提交
10115 10116 10117
                // make sure the top element of the pointer exists
                json_pointer top_pointer = ptr.top();
                if (top_pointer != ptr)
N
Niels 已提交
10118
                {
N
Niels 已提交
10119
                    result.at(top_pointer);
N
Niels 已提交
10120
                }
N
Niels 已提交
10121 10122 10123 10124 10125 10126

                // 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 已提交
10127
                {
N
Niels 已提交
10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161
                    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 已提交
10162 10163
                        // if there exists a parent it cannot be primitive
                        assert(false);  // LCOV_EXCL_LINE
N
Niels 已提交
10164
                    }
N
Niels 已提交
10165 10166 10167 10168
                }
            }
        };

N
Niels 已提交
10169
        // wrapper for "remove" operation; remove value at ptr
N
Niels 已提交
10170 10171
        const auto operation_remove = [&result](json_pointer & ptr)
        {
N
Niels 已提交
10172
            // get reference to parent of JSON pointer ptr
N
Niels 已提交
10173 10174
            const auto last_path = ptr.pop_back();
            basic_json& parent = result.at(ptr);
N
Niels 已提交
10175 10176

            // remove child
N
Niels 已提交
10177 10178
            if (parent.is_object())
            {
N
Niels 已提交
10179 10180 10181 10182 10183 10184 10185 10186 10187 10188
                // 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 已提交
10189 10190 10191
            }
            else if (parent.is_array())
            {
N
Niels 已提交
10192 10193
                // note erase performs range check
                parent.erase(static_cast<size_type>(std::stoi(last_path)));
N
Niels 已提交
10194 10195 10196
            }
        };

N
Niels 已提交
10197
        // type check
N
Niels 已提交
10198
        if (not json_patch.is_array())
N
Niels 已提交
10199 10200
        {
            // a JSON patch must be an array of objects
N
Niels 已提交
10201
            throw std::invalid_argument("JSON patch must be an array of objects");
N
Niels 已提交
10202 10203 10204
        }

        // iterate and apply th eoperations
N
Niels 已提交
10205
        for (const auto& val : json_patch)
10206
        {
N
Niels 已提交
10207 10208 10209
            // wrapper to get a value for an operation
            const auto get_value = [&val](const std::string & op,
                                          const std::string & member,
N
Niels 已提交
10210
                                          bool string_type) -> basic_json&
10211
            {
N
Niels 已提交
10212 10213
                // find value
                auto it = val.m_value.object->find(member);
10214

N
Niels 已提交
10215 10216
                // context-sensitive error message
                const auto error_msg = (op == "op") ? "operation" : "operation '" + op + "'";
10217

N
Niels 已提交
10218 10219 10220
                // check if desired value is present
                if (it == val.m_value.object->end())
                {
N
Niels 已提交
10221
                    throw std::invalid_argument(error_msg + " must have member '" + member + "'");
N
Niels 已提交
10222
                }
10223

N
Niels 已提交
10224 10225 10226
                // check if result is of type string
                if (string_type and not it->second.is_string())
                {
N
Niels 已提交
10227
                    throw std::invalid_argument(error_msg + " must have string member '" + member + "'");
N
Niels 已提交
10228 10229 10230 10231 10232 10233 10234 10235
                }

                // no error: return value
                return it->second;
            };

            // type check
            if (not val.is_object())
10236
            {
N
Niels 已提交
10237
                throw std::invalid_argument("JSON patch must be an array of objects");
10238 10239
            }

N
Niels 已提交
10240 10241 10242
            // collect mandatory members
            const std::string op = get_value("op", "op", true);
            const std::string path = get_value(op, "path", true);
N
oops  
Niels 已提交
10243
            json_pointer ptr(path);
10244

N
Niels 已提交
10245
            switch (get_op(op))
10246
            {
N
Niels 已提交
10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321
                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");
                }
10322
            }
N
Niels 已提交
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 10355 10356 10357 10358 10359 10360 10361
        }

        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,
10362
                           const std::string& path = "")
N
Niels 已提交
10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376
    {
        // 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(
10377
            {
N
Niels 已提交
10378 10379 10380 10381 10382 10383 10384 10385
                {"op", "replace"},
                {"path", path},
                {"value", target}
            });
        }
        else
        {
            switch (source.type())
10386
            {
N
Niels 已提交
10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397
                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 已提交
10398

N
Niels 已提交
10399 10400
                    // i now reached the end of at least one array
                    // in a second pass, traverse the remaining elements
N
Niels 已提交
10401

N
Niels 已提交
10402
                    // remove my remaining elements
N
Niels 已提交
10403
                    const auto end_index = static_cast<difference_type>(result.size());
N
Niels 已提交
10404 10405
                    while (i < source.size())
                    {
N
Niels 已提交
10406 10407
                        // add operations in reverse order to avoid invalid
                        // indices
N
Niels 已提交
10408
                        result.insert(result.begin() + end_index, object(
N
Niels 已提交
10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431
                        {
                            {"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:
10432
                {
N
Niels 已提交
10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484
                    // 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;
10485 10486 10487 10488 10489 10490
                }
            }
        }

        return result;
    }
N
Niels 已提交
10491 10492

    /// @}
N
Niels 已提交
10493 10494 10495 10496 10497 10498 10499
};


/////////////
// presets //
/////////////

N
Niels 已提交
10500 10501 10502
/*!
@brief default JSON class

N
Niels 已提交
10503 10504
This type is the default specialization of the @ref basic_json class which
uses the standard template types.
N
Niels 已提交
10505

N
Niels 已提交
10506
@since version 1.0.0
N
Niels 已提交
10507
*/
N
Niels 已提交
10508 10509 10510 10511
using json = basic_json<>;
}


N
Niels 已提交
10512 10513 10514
///////////////////////
// nonmember support //
///////////////////////
N
Niels 已提交
10515 10516 10517 10518

// specialization of std::swap, and std::hash
namespace std
{
N
Niels 已提交
10519 10520
/*!
@brief exchanges the values of two JSON objects
N
Niels 已提交
10521

N
Niels 已提交
10522
@since version 1.0.0
N
Niels 已提交
10523
*/
N
Niels 已提交
10524
template<>
N
Niels 已提交
10525 10526 10527 10528 10529 10530 10531 10532 10533 10534
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 已提交
10535
template<>
N
Niels 已提交
10536 10537
struct hash<nlohmann::json>
{
N
Niels 已提交
10538 10539 10540
    /*!
    @brief return a hash value for a JSON object

N
Niels 已提交
10541
    @since version 1.0.0
N
Niels 已提交
10542
    */
N
Niels 已提交
10543
    std::size_t operator()(const nlohmann::json& j) const
N
Niels 已提交
10544 10545
    {
        // a naive hashing via the string representation
N
Niels 已提交
10546 10547
        const auto& h = hash<nlohmann::json::string_t>();
        return h(j.dump());
N
Niels 已提交
10548 10549 10550 10551 10552
    }
};
}

/*!
N
Niels 已提交
10553 10554
@brief user-defined string literal for JSON values

N
Niels 已提交
10555
This operator implements a user-defined string literal for JSON objects. It
N
Niels 已提交
10556
can be used by adding `"_json"` to a string literal and returns a JSON object
N
Niels 已提交
10557
if no parse error occurred.
N
Niels 已提交
10558

N
Niels 已提交
10559
@param[in] s  a string representation of a JSON object
N
Niels 已提交
10560
@return a JSON object
N
Niels 已提交
10561

N
Niels 已提交
10562
@since version 1.0.0
N
Niels 已提交
10563
*/
N
Niels 已提交
10564
inline nlohmann::json operator "" _json(const char* s, std::size_t)
N
Niels 已提交
10565
{
N
Niels 已提交
10566
    return nlohmann::json::parse(s);
N
Niels 已提交
10567 10568
}

N
Niels 已提交
10569 10570 10571
/*!
@brief user-defined string literal for JSON pointer

N
Niels 已提交
10572 10573 10574 10575 10576 10577 10578
This operator implements a user-defined string literal for JSON Pointers. It
can be used by adding `"_json"` to a string literal and returns a JSON pointer
object if no parse error occurred.

@param[in] s  a string representation of a JSON Pointer
@return a JSON pointer object

N
Niels 已提交
10579 10580 10581 10582 10583 10584 10585
@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);
}

10586 10587 10588 10589 10590
// restore GCC/clang diagnostic settings
#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
    #pragma GCC diagnostic pop
#endif

N
Niels 已提交
10591
#endif