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

56 57 58 59 60 61
// 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 已提交
62
/*!
N
Niels 已提交
63
@brief namespace for Niels Lohmann
N
Niels 已提交
64
@see https://github.com/nlohmann
N
Niels 已提交
65
@since version 1.0.0
N
Niels 已提交
66 67 68 69
*/
namespace nlohmann
{

N
Niels 已提交
70

71 72
/*!
@brief unnamed namespace with internal helper functions
N
Niels 已提交
73
@since version 1.0.0
74 75
*/
namespace
N
Niels 已提交
76
{
77 78 79 80
/*!
@brief Helper to determine whether there's a key_type for T.
@sa http://stackoverflow.com/a/7728728/266378
*/
N
Niels 已提交
81
template<typename T>
N
Niels 已提交
82
struct has_mapped_type
N
Niels 已提交
83 84
{
  private:
N
Niels 已提交
85
    template<typename C> static char test(typename C::mapped_type*);
N
Niels 已提交
86
    template<typename C> static char (&test(...))[2];
N
Niels 已提交
87
  public:
N
Niels 已提交
88
    static constexpr bool value = sizeof(test<T>(0)) == 1;
N
Niels 已提交
89
};
90

N
Niels 已提交
91 92 93 94 95 96 97 98 99 100 101 102 103
/*!
@brief helper class to create locales with decimal point
@sa https://github.com/nlohmann/json/issues/51#issuecomment-86869315
*/
class DecimalSeparator : public std::numpunct<char>
{
  protected:
    char do_decimal_point() const
    {
        return '.';
    }
};

N
Niels 已提交
104
}
N
Niels 已提交
105

N
Niels 已提交
106
/*!
N
Niels 已提交
107
@brief a class to store JSON values
N
Niels 已提交
108

N
Niels 已提交
109
@tparam ObjectType type for JSON objects (`std::map` by default; will be used
N
Niels 已提交
110
in @ref object_t)
N
Niels 已提交
111
@tparam ArrayType type for JSON arrays (`std::vector` by default; will be used
N
Niels 已提交
112
in @ref array_t)
N
Niels 已提交
113
@tparam StringType type for JSON strings and object keys (`std::string` by
N
Niels 已提交
114
default; will be used in @ref string_t)
N
Niels 已提交
115
@tparam BooleanType type for JSON booleans (`bool` by default; will be used
N
Niels 已提交
116
in @ref boolean_t)
N
Niels 已提交
117
@tparam NumberIntegerType type for JSON integer numbers (`int64_t` by
N
Niels 已提交
118
default; will be used in @ref number_integer_t)
N
Niels 已提交
119 120
@tparam NumberUnsignedType type for JSON unsigned integer numbers (@c
`uint64_t` by default; will be used in @ref number_unsigned_t)
N
Niels 已提交
121
@tparam NumberFloatType type for JSON floating-point numbers (`double` by
N
Niels 已提交
122
default; will be used in @ref number_float_t)
N
Niels 已提交
123
@tparam AllocatorType type of the allocator to use (`std::allocator` by
N
Niels 已提交
124
default)
N
Niels 已提交
125

N
Niels 已提交
126 127
@requirement The class satisfies the following concept requirements:
- Basic
N
Niels 已提交
128 129 130 131 132
 - [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 已提交
133
   A JSON value can be copy-constructed from an lvalue expression.
N
Niels 已提交
134 135 136 137 138 139
 - [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 已提交
140
- Layout
N
Niels 已提交
141 142 143 144 145
 - [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 已提交
146
- Library-wide
N
Niels 已提交
147 148 149 150 151 152 153 154 155 156 157 158
 - [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 已提交
159
- Container
N
Niels 已提交
160 161 162 163 164
 - [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 已提交
165

N
Niels 已提交
166
@internal
N
Niels 已提交
167
@note ObjectType trick from http://stackoverflow.com/a/9860911
N
Niels 已提交
168
@endinternal
N
Niels 已提交
169

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

N
Niels 已提交
173
@since version 1.0.0
N
Niels 已提交
174 175

@nosubgrouping
N
Niels 已提交
176 177 178 179 180 181
*/
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,
182 183
    class NumberIntegerType = std::int64_t,
    class NumberUnsignedType = std::uint64_t,
N
Niels 已提交
184
    class NumberFloatType = double,
N
Niels 已提交
185
    template<typename U> class AllocatorType = std::allocator
N
Niels 已提交
186 187 188
    >
class basic_json
{
189 190
  private:
    /// workaround type for MSVC
N
Niels 已提交
191 192 193 194 195
    using basic_json_t = basic_json<ObjectType,
          ArrayType,
          StringType,
          BooleanType,
          NumberIntegerType,
196
          NumberUnsignedType,
N
Niels 已提交
197 198
          NumberFloatType,
          AllocatorType>;
199 200

  public:
N
Niels 已提交
201 202 203
    // forward declarations
    template<typename Base> class json_reverse_iterator;
    class json_pointer;
204

N
Niels 已提交
205 206 207 208
    /////////////////////
    // container types //
    /////////////////////

N
Niels 已提交
209 210 211
    /// @name container types
    /// @{

N
Niels 已提交
212
    /// the type of elements in a basic_json container
N
Niels 已提交
213
    using value_type = basic_json;
N
Niels 已提交
214

N
Niels 已提交
215
    /// the type of an element reference
N
Niels 已提交
216
    using reference = value_type&;
N
Niels 已提交
217
    /// the type of an element const reference
N
Niels 已提交
218
    using const_reference = const value_type&;
N
Niels 已提交
219

N
Niels 已提交
220
    /// a type to represent differences between iterators
N
Niels 已提交
221
    using difference_type = std::ptrdiff_t;
N
Niels 已提交
222
    /// a type to represent container sizes
N
Niels 已提交
223 224 225
    using size_type = std::size_t;

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

N
Niels 已提交
228
    /// the type of an element pointer
N
Niels 已提交
229
    using pointer = typename std::allocator_traits<allocator_type>::pointer;
N
Niels 已提交
230
    /// the type of an element const pointer
N
Niels 已提交
231
    using const_pointer = typename std::allocator_traits<allocator_type>::const_pointer;
N
Niels 已提交
232

N
Niels 已提交
233 234 235 236 237
    /// 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 已提交
238
    using reverse_iterator = json_reverse_iterator<typename basic_json::iterator>;
N
Niels 已提交
239
    /// a const reverse iterator for a basic_json container
N
Niels 已提交
240
    using const_reverse_iterator = json_reverse_iterator<typename basic_json::const_iterator>;
N
Niels 已提交
241

N
Niels 已提交
242 243 244
    /// @}


N
Niels 已提交
245 246 247
    /*!
    @brief returns the allocator associated with the container
    */
N
Niels 已提交
248
    static allocator_type get_allocator()
N
Niels 已提交
249 250 251 252 253
    {
        return allocator_type();
    }


N
Niels 已提交
254 255 256 257
    ///////////////////////////
    // JSON value data types //
    ///////////////////////////

N
Niels 已提交
258 259 260
    /// @name JSON value data types
    /// @{

N
Niels 已提交
261 262 263 264 265 266 267 268
    /*!
    @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 已提交
269 270 271 272 273 274 275 276 277 278
    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`)
    @tparam StringType the type of the keys or names (e.g., `std::string`). The
    comparison function `std::less<StringType>` is used to order elements
    inside the container.
    @tparam AllocatorType the allocator to use for objects (e.g.,
    `std::allocator`)
N
Niels 已提交
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327

    #### Default type

    With the default values for @a ObjectType (`std::map`), @a StringType
    (`std::string`), and @a AllocatorType (`std::allocator`), the default value
    for @a object_t is:

    @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
      that all software implementations receiving that object will agree on the
      name-value mappings.
    - 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
      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}`.
    - 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
    runtime environment. A theoretical limit can be queried by calling the @ref
    max_size function of a JSON object.

    #### Storage

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

331 332
    @sa @ref array_t -- type for an array value

N
Niels 已提交
333
    @since version 1.0.0
N
Niels 已提交
334 335 336 337 338 339 340 341

    @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
    7159](http://rfc7159.net/rfc7159), because any order implements the
    specified "unordered" nature of JSON objects.
N
Niels 已提交
342
    */
N
Niels 已提交
343 344 345 346 347
    using object_t = ObjectType<StringType,
          basic_json,
          std::less<StringType>,
          AllocatorType<std::pair<const StringType,
          basic_json>>>;
N
Niels 已提交
348 349 350 351 352 353 354

    /*!
    @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 已提交
355 356 357 358 359 360
    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`)
    @tparam AllocatorType  allocator to use for arrays (e.g., `std::allocator`)
N
Niels 已提交
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385

    #### 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
    runtime environment. A theoretical limit can be queried by calling the @ref
    max_size function of a JSON array.

    #### Storage

386
    Arrays are stored as pointers in a @ref basic_json type. That is, for any
N
Niels 已提交
387
    access to array values, a pointer of type `array_t*` must be dereferenced.
388 389 390

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

N
Niels 已提交
391
    @since version 1.0.0
N
Niels 已提交
392
    */
N
Niels 已提交
393
    using array_t = ArrayType<basic_json, AllocatorType<basic_json>>;
N
Niels 已提交
394 395 396 397 398 399 400

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

N
Niels 已提交
405 406
    @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 已提交
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433

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

434 435
    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 已提交
436
    dereferenced.
437

N
Niels 已提交
438
    @since version 1.0.0
N
Niels 已提交
439
    */
N
Niels 已提交
440
    using string_t = StringType;
N
Niels 已提交
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461

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

462 463
    Boolean values are stored directly inside a @ref basic_json type.

N
Niels 已提交
464
    @since version 1.0.0
N
Niels 已提交
465
    */
N
Niels 已提交
466
    using boolean_t = BooleanType;
N
Niels 已提交
467 468 469 470 471 472 473 474 475 476 477 478 479 480

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

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
    > 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,
N
Niels 已提交
481
    C++ allows more precise storage if it is known whether the number is a
482
    signed integer, an unsigned integer or a floating-point number. Therefore,
N
Niels 已提交
483
    three different types, @ref number_integer_t, @ref number_unsigned_t and
484
    @ref number_float_t are used.
N
Niels 已提交
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516

    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
      instance, the C++ integer literal `010` will be serialized to `8`. During
      deserialization, leading zeros yield an error.
    - 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
    that are out of range will yield over/underflow when used in a constructor.
    During deserialization, too large or small integer numbers will be
517
    automatically be stored as @ref number_unsigned_t or @ref number_float_t.
N
Niels 已提交
518 519 520 521 522 523 524 525 526 527 528

    [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

529 530 531 532
    Integer number values are stored directly inside a @ref basic_json type.

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

533 534
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
535
    @since version 1.0.0
N
Niels 已提交
536
    */
N
Niels 已提交
537
    using number_integer_t = NumberIntegerType;
N
Niels 已提交
538

539 540 541 542 543 544 545 546 547 548 549 550 551
    /*!
    @brief a type for a number (unsigned)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
    > 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,
N
Niels 已提交
552
    C++ allows more precise storage if it is known whether the number is a
553
    signed integer, an unsigned integer or a floating-point number. Therefore,
N
Niels 已提交
554
    three different types, @ref number_integer_t, @ref number_unsigned_t and
555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
    @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.

    #### Default type

    With the default values for @a NumberUnsignedType (`uint64_t`), the default
    value for @a number_unsigned_t is:

    @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
      instance, the C++ integer literal `010` will be serialized to `8`. During
      deserialization, leading zeros yield an error.
    - 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 已提交
584 585 586 587 588
    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.
589 590 591 592 593 594 595

    [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 已提交
596
    number_integer_t type) of the exactly supported range [0, UINT64_MAX], this
597 598 599 600 601 602 603 604 605 606 607 608 609
    class's integer type is interoperable.

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

N
Niels 已提交
611 612 613 614 615 616 617 618 619 620 621 622 623
    /*!
    @brief a type for a number (floating-point)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
    > 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,
N
Niels 已提交
624
    C++ allows more precise storage if it is known whether the number is a
625
    signed integer, an unsigned integer or a floating-point number. Therefore,
N
Niels 已提交
626
    three different types, @ref number_integer_t, @ref number_unsigned_t and
627
    @ref number_float_t are used.
N
Niels 已提交
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662

    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,
      leading zeros in floating-point literals will be ignored. Internally, the
      value will be stored as decimal number. For instance, the C++
      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
    > 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
    > precision.

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

    #### Storage

668 669 670 671 672
    Floating-point number values are stored directly inside a @ref basic_json
    type.

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

673 674
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
675
    @since version 1.0.0
N
Niels 已提交
676
    */
N
Niels 已提交
677 678
    using number_float_t = NumberFloatType;

N
Niels 已提交
679 680
    /// @}

N
Niels 已提交
681

N
Niels 已提交
682 683 684
    ///////////////////////////
    // JSON type enumeration //
    ///////////////////////////
N
Niels 已提交
685

N
Niels 已提交
686
    /*!
N
Niels 已提交
687
    @brief the JSON type enumeration
N
Niels 已提交
688

N
Niels 已提交
689
    This enumeration collects the different JSON types. It is internally used
690 691 692 693
    to distinguish the stored values, and the functions @ref is_null(), @ref
    is_object(), @ref is_array(), @ref is_string(), @ref is_boolean(), @ref
    is_number(), and @ref is_discarded() rely on it.

N
Niels 已提交
694
    @since version 1.0.0
N
Niels 已提交
695
    */
N
Niels 已提交
696 697
    enum class value_t : uint8_t
    {
N
Niels 已提交
698 699 700 701 702 703 704 705 706
        null,            ///< null value
        object,          ///< object (unordered set of name/value pairs)
        array,           ///< array (ordered collection of values)
        string,          ///< string value
        boolean,         ///< boolean value
        number_integer,  ///< number value (integer)
        number_unsigned, ///< number value (unsigned integer)
        number_float,    ///< number value (floating-point)
        discarded        ///< discarded by the the parser callback function
N
Niels 已提交
707 708
    };

N
Niels 已提交
709

N
Niels 已提交
710
  private:
N
Niels 已提交
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778

    /*!
    @brief a type to hold JSON type information

    This bitfield type holds information about JSON types. It is internally
    used to hold the basic JSON type enumeration, as well as additional
    information in the case of values that have been parsed from a string
    including whether of not it was created directly or parsed, and in the
    case of floating point numbers the number of significant figures in the
    original representaiton and if it was in exponential form, if a '+' was
    included in the exponent and the capitilization of the exponent marker.
    The sole purpose of this information is to permit accurate round trips.

    @since version 2.0.0
    */
    union type_data_t
    {
        struct
        {
            /// the type of the value (@ref value_t)
            uint16_t type : 4;
            /// whether the number was parsed from a string
            uint16_t parsed : 1;
            /// whether parsed number contained an exponent ('e'/'E')
            uint16_t has_exp : 1;
            /// whether parsed number contained a plus in the exponent
            uint16_t exp_plus : 1;
            /// whether parsed number's exponent was capitalized ('E')
            uint16_t exp_cap : 1;
            /// the number of figures for a parsed number
            uint16_t precision : 8;
        } bits;
        uint16_t data;

        /// return the type as value_t
        operator value_t() const
        {
            return static_cast<value_t>(bits.type);
        }

        /// test type for equality (ignore other fields)
        bool operator==(const value_t& rhs) const
        {
            return static_cast<value_t>(bits.type) == rhs;
        }

        /// assignment
        type_data_t& operator=(value_t rhs)
        {
            bits.type = static_cast<uint16_t>(rhs);
            return *this;
        }

        /// construct from value_t
        type_data_t(value_t t) noexcept
        {
            *reinterpret_cast<uint16_t*>(this) = 0;
            bits.type = static_cast<uint16_t>(t);
        }

        /// default constructor
        type_data_t() noexcept
        {
            data = 0;
            bits.type = reinterpret_cast<uint16_t>(value_t::null);
        }
    };

N
Cleanup  
Niels 已提交
779 780
    /// helper for exception-safe object creation
    template<typename T, typename... Args>
N
cleanup  
Niels 已提交
781
    static T* create(Args&& ... args)
N
Cleanup  
Niels 已提交
782 783 784 785 786 787 788 789 790 791 792
    {
        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)...);
        return object.release();
    }

N
Niels 已提交
793 794 795 796
    ////////////////////////
    // JSON value storage //
    ////////////////////////

797 798 799 800 801
    /*!
    @brief a JSON value

    The actual storage for a JSON value of the @ref basic_json class.

N
Niels 已提交
802
    @since version 1.0.0
803
    */
N
Niels 已提交
804 805 806 807 808 809 810 811
    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 已提交
812
        /// boolean
N
Niels 已提交
813 814 815
        boolean_t boolean;
        /// number (integer)
        number_integer_t number_integer;
816 817
        /// number (unsigned integer)
        number_unsigned_t number_unsigned;
N
Niels 已提交
818
        /// number (floating-point)
N
Niels 已提交
819 820 821
        number_float_t number_float;

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

842
                case value_t::array:
N
Niels 已提交
843
                {
N
Cleanup  
Niels 已提交
844
                    array = create<array_t>();
N
Niels 已提交
845 846
                    break;
                }
N
Niels 已提交
847

848
                case value_t::string:
N
Niels 已提交
849
                {
N
Cleanup  
Niels 已提交
850
                    string = create<string_t>("");
N
Niels 已提交
851 852
                    break;
                }
N
Niels 已提交
853

854
                case value_t::boolean:
N
Niels 已提交
855 856 857 858 859
                {
                    boolean = boolean_t(false);
                    break;
                }

860
                case value_t::number_integer:
N
Niels 已提交
861 862 863 864
                {
                    number_integer = number_integer_t(0);
                    break;
                }
N
Niels 已提交
865

866 867 868 869 870
                case value_t::number_unsigned:
                {
                    number_unsigned = number_unsigned_t(0);
                    break;
                }
N
Niels 已提交
871

872
                case value_t::number_float:
N
Niels 已提交
873 874 875 876
                {
                    number_float = number_float_t(0.0);
                    break;
                }
877 878 879 880 881

                default:
                {
                    break;
                }
N
Niels 已提交
882 883
            }
        }
N
Niels 已提交
884 885

        /// constructor for strings
N
Niels 已提交
886
        json_value(const string_t& value)
N
Niels 已提交
887
        {
N
Cleanup  
Niels 已提交
888
            string = create<string_t>(value);
N
Niels 已提交
889 890 891
        }

        /// constructor for objects
N
Niels 已提交
892
        json_value(const object_t& value)
N
Niels 已提交
893
        {
N
Cleanup  
Niels 已提交
894
            object = create<object_t>(value);
N
Niels 已提交
895 896 897
        }

        /// constructor for arrays
N
Niels 已提交
898
        json_value(const array_t& value)
N
Niels 已提交
899
        {
N
Cleanup  
Niels 已提交
900
            array = create<array_t>(value);
N
Niels 已提交
901
        }
N
Niels 已提交
902 903
    };

N
Niels 已提交
904 905

  public:
N
Niels 已提交
906 907 908 909
    //////////////////////////
    // JSON parser callback //
    //////////////////////////

N
Niels 已提交
910 911 912 913 914
    /*!
    @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.
915

N
Niels 已提交
916
    @since version 1.0.0
N
Niels 已提交
917
    */
N
Niels 已提交
918 919
    enum class parse_event_t : uint8_t
    {
N
Niels 已提交
920 921 922 923 924 925 926 927 928 929 930 931
        /// 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 已提交
932 933
    };

N
Niels 已提交
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
    /*!
    @brief per-element parser callback type

    With a parser callback function, the result of parsing a JSON text can be
    influenced. When passed to @ref parse(std::istream&, parser_callback_t) or
    @ref parse(const string_t&, parser_callback_t), 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.

    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 已提交
958 959
    Discarding a value (i.e., returning `false`) has different effects
    depending on the context in which function was called:
N
Niels 已提交
960 961 962 963 964 965

    - Discarded values in structured types are skipped. That is, the parser
      will behave as if the discarded value was never read.
    - 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 已提交
966
    @param[in] depth  the depth of the recursion during parsing
N
Niels 已提交
967

N
Niels 已提交
968
    @param[in] event  an event of type parse_event_t indicating the context in
N
Niels 已提交
969 970 971 972 973 974 975 976 977 978 979
    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
    @ref parse(const string_t&, parser_callback_t) for examples
980

N
Niels 已提交
981
    @since version 1.0.0
N
Niels 已提交
982
    */
983
    using parser_callback_t = std::function<bool(int depth, parse_event_t event, basic_json& parsed)>;
N
Niels 已提交
984

N
Niels 已提交
985 986 987 988 989

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

N
Niels 已提交
990 991 992
    /// @name constructors and destructors
    /// @{

N
Niels 已提交
993 994 995
    /*!
    @brief create an empty value with a given type

N
Niels 已提交
996 997 998 999 1000
    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 已提交
1001 1002 1003 1004 1005 1006
    null        | `null`
    boolean     | `false`
    string      | `""`
    number      | `0`
    object      | `{}`
    array       | `[]`
N
Niels 已提交
1007

1008
    @param[in] value_type  the type of the value to create
N
Niels 已提交
1009 1010 1011

    @complexity Constant.

N
Niels 已提交
1012
    @throw std::bad_alloc if allocation for object, array, or string value
N
Niels 已提交
1013
    fails
N
Niels 已提交
1014 1015 1016

    @liveexample{The following code shows the constructor for different @ref
    value_t values,basic_json__value_t}
1017 1018 1019 1020 1021 1022

    @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 已提交
1023 1024 1025 1026
    @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
1027 1028
    @sa @ref basic_json(const number_unsigned_t) -- create a number (unsigned)
    value
1029

N
Niels 已提交
1030
    @since version 1.0.0
N
Niels 已提交
1031
    */
1032 1033
    basic_json(const value_t value_type)
        : m_type(value_type), m_value(value_type)
N
Niels 已提交
1034
    {}
N
Niels 已提交
1035

N
Niels 已提交
1036 1037
    /*!
    @brief create a null object (implicitly)
N
Niels 已提交
1038 1039 1040 1041 1042 1043

    Create a `null` JSON value. This is the implicit version of the `null`
    value constructor as it takes no parameters.

    @complexity Constant.

N
Niels 已提交
1044 1045 1046
    @exceptionsafety No-throw guarantee: this constructor never throws
    exceptions.

N
Niels 已提交
1047 1048 1049
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
1050 1051 1052 1053 1054 1055
    - The complexity is constant.
    - As postcondition, it holds: `basic_json().empty() == true`.

    @liveexample{The following code shows the constructor for a `null` JSON
    value.,basic_json}

1056 1057
    @sa @ref basic_json(std::nullptr_t) -- create a `null` value

N
Niels 已提交
1058
    @since version 1.0.0
N
Niels 已提交
1059
    */
N
Niels 已提交
1060
    basic_json() = default;
N
Niels 已提交
1061

N
Niels 已提交
1062 1063 1064 1065 1066
    /*!
    @brief create a null object (explicitly)

    Create a `null` JSON value. This is the explicitly version of the `null`
    value constructor as it takes a null pointer as parameter. It allows to
N
Niels 已提交
1067
    create `null` values by explicitly assigning a `nullptr` to a JSON value.
N
Niels 已提交
1068
    The passed null pointer itself is not read -- it is only used to choose the
N
Niels 已提交
1069 1070 1071 1072
    right constructor.

    @complexity Constant.

N
Niels 已提交
1073 1074 1075
    @exceptionsafety No-throw guarantee: this constructor never throws
    exceptions.

N
Niels 已提交
1076 1077 1078
    @liveexample{The following code shows the constructor with null pointer
    parameter.,basic_json__nullptr_t}

1079 1080 1081
    @sa @ref basic_json() -- default constructor (implicitly creating a `null`
    value)

N
Niels 已提交
1082
    @since version 1.0.0
N
Niels 已提交
1083
    */
N
Niels 已提交
1084
    basic_json(std::nullptr_t) noexcept
N
Niels 已提交
1085
        : basic_json(value_t::null)
N
Niels 已提交
1086 1087
    {}

N
Niels 已提交
1088 1089 1090 1091 1092
    /*!
    @brief create an object (explicit)

    Create an object JSON value with a given content.

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

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

N
Niels 已提交
1097
    @throw std::bad_alloc if allocation for object value fails
N
Niels 已提交
1098 1099 1100 1101

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

1102 1103 1104
    @sa @ref basic_json(const CompatibleObjectType&) -- create an object value
    from a compatible STL container

N
Niels 已提交
1105
    @since version 1.0.0
N
Niels 已提交
1106
    */
1107 1108
    basic_json(const object_t& val)
        : m_type(value_t::object), m_value(val)
N
Niels 已提交
1109
    {}
N
Niels 已提交
1110

N
Niels 已提交
1111 1112 1113 1114
    /*!
    @brief create an object (implicit)

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

N
Niels 已提交
1118 1119 1120 1121 1122
    @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 已提交
1123

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

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

N
Niels 已提交
1128
    @throw std::bad_alloc if allocation for object value fails
N
Niels 已提交
1129 1130 1131 1132

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

1133 1134
    @sa @ref basic_json(const object_t&) -- create an object value

N
Niels 已提交
1135
    @since version 1.0.0
N
Niels 已提交
1136 1137
    */
    template <class CompatibleObjectType, typename
N
Niels 已提交
1138
              std::enable_if<
N
Niels 已提交
1139 1140
                  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
N
Niels 已提交
1141
              = 0>
1142
    basic_json(const CompatibleObjectType& val)
N
Niels 已提交
1143 1144
        : m_type(value_t::object)
    {
1145 1146
        using std::begin;
        using std::end;
1147
        m_value.object = create<object_t>(begin(val), end(val));
N
Niels 已提交
1148
    }
N
Niels 已提交
1149

N
Niels 已提交
1150 1151 1152 1153 1154
    /*!
    @brief create an array (explicit)

    Create an array JSON value with a given content.

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

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

N
Niels 已提交
1159
    @throw std::bad_alloc if allocation for array value fails
N
Niels 已提交
1160 1161 1162 1163

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

1164 1165 1166
    @sa @ref basic_json(const CompatibleArrayType&) -- create an array value
    from a compatible STL containers

N
Niels 已提交
1167
    @since version 1.0.0
N
Niels 已提交
1168
    */
1169 1170
    basic_json(const array_t& val)
        : m_type(value_t::array), m_value(val)
N
Niels 已提交
1171
    {}
N
Niels 已提交
1172

N
Niels 已提交
1173 1174 1175 1176
    /*!
    @brief create an array (implicit)

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

N
Niels 已提交
1180 1181 1182 1183 1184
    @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 已提交
1185

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

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

N
Niels 已提交
1190
    @throw std::bad_alloc if allocation for array value fails
N
Niels 已提交
1191 1192 1193 1194

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

1195 1196
    @sa @ref basic_json(const array_t&) -- create an array value

N
Niels 已提交
1197
    @since version 1.0.0
N
Niels 已提交
1198 1199
    */
    template <class CompatibleArrayType, typename
N
Niels 已提交
1200
              std::enable_if<
N
Niels 已提交
1201 1202 1203 1204
                  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
N
Niels 已提交
1205 1206 1207
                  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
N
Niels 已提交
1208
              = 0>
1209
    basic_json(const CompatibleArrayType& val)
N
Niels 已提交
1210 1211
        : m_type(value_t::array)
    {
1212 1213
        using std::begin;
        using std::end;
1214
        m_value.array = create<array_t>(begin(val), end(val));
N
Niels 已提交
1215
    }
N
Niels 已提交
1216

N
Niels 已提交
1217 1218 1219 1220 1221
    /*!
    @brief create a string (explicit)

    Create an string JSON value with a given content.

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

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

N
Niels 已提交
1226
    @throw std::bad_alloc if allocation for string value fails
N
Niels 已提交
1227 1228 1229 1230

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

1231 1232 1233 1234 1235
    @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 已提交
1236
    @since version 1.0.0
N
Niels 已提交
1237
    */
1238 1239
    basic_json(const string_t& val)
        : m_type(value_t::string), m_value(val)
N
Niels 已提交
1240
    {}
N
Niels 已提交
1241

N
Niels 已提交
1242 1243 1244
    /*!
    @brief create a string (explicit)

N
Niels 已提交
1245
    Create a string JSON value with a given content.
N
Niels 已提交
1246

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

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

N
Niels 已提交
1251
    @throw std::bad_alloc if allocation for string value fails
N
Niels 已提交
1252 1253 1254 1255

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

1256 1257 1258 1259
    @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 已提交
1260
    @since version 1.0.0
N
Niels 已提交
1261
    */
1262 1263
    basic_json(const typename string_t::value_type* val)
        : basic_json(string_t(val))
N
Niels 已提交
1264
    {}
N
Niels 已提交
1265

N
Niels 已提交
1266 1267 1268 1269 1270
    /*!
    @brief create a string (implicit)

    Create a string JSON value with a given content.

1271
    @param[in] val  a value for the string
N
Niels 已提交
1272 1273

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

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

N
Niels 已提交
1278
    @throw std::bad_alloc if allocation for string value fails
N
Niels 已提交
1279 1280 1281 1282

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

1283 1284 1285 1286
    @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 已提交
1287
    @since version 1.0.0
N
Niels 已提交
1288
    */
N
Niels 已提交
1289
    template <class CompatibleStringType, typename
N
Niels 已提交
1290
              std::enable_if<
N
Niels 已提交
1291
                  std::is_constructible<string_t, CompatibleStringType>::value, int>::type
N
Niels 已提交
1292
              = 0>
1293 1294
    basic_json(const CompatibleStringType& val)
        : basic_json(string_t(val))
N
Niels 已提交
1295 1296
    {}

N
Niels 已提交
1297 1298 1299 1300 1301
    /*!
    @brief create a boolean (explicit)

    Creates a JSON boolean type from a given value.

1302
    @param[in] val  a boolean value to store
N
Niels 已提交
1303 1304 1305 1306 1307

    @complexity Constant.

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

N
Niels 已提交
1309
    @since version 1.0.0
N
Niels 已提交
1310
    */
N
Niels 已提交
1311
    basic_json(boolean_t val) noexcept
1312
        : m_type(value_t::boolean), m_value(val)
N
Niels 已提交
1313 1314
    {}

N
Niels 已提交
1315 1316 1317
    /*!
    @brief create an integer number (explicit)

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

N
Niels 已提交
1320 1321 1322 1323
    @tparam T A helper type to remove this function via SFINAE in case @ref
    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 已提交
1324

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

N
Niels 已提交
1327 1328
    @complexity Constant.

N
Niels 已提交
1329
    @liveexample{The example below shows the construction of an integer
N
Niels 已提交
1330
    number value.,basic_json__number_integer_t}
N
Niels 已提交
1331

1332 1333 1334 1335
    @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 已提交
1336
    @since version 1.0.0
N
Niels 已提交
1337 1338 1339 1340 1341
    */
    template<typename T,
             typename std::enable_if<
                 not (std::is_same<T, int>::value)
                 and std::is_same<T, number_integer_t>::value
1342 1343
                 , int>::type
             = 0>
N
Niels 已提交
1344
    basic_json(const number_integer_t val) noexcept
1345
        : m_type(value_t::number_integer), m_value(val)
N
Niels 已提交
1346
    {}
N
Niels 已提交
1347

N
Niels 已提交
1348
    /*!
N
Niels 已提交
1349 1350
    @brief create an integer number from an enum type (explicit)

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

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

N
Niels 已提交
1355 1356 1357 1358 1359 1360 1361 1362
    @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
    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).

    @complexity Constant.

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

1366 1367 1368 1369 1370
    @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 已提交
1371
    @since version 1.0.0
N
Niels 已提交
1372
    */
N
Niels 已提交
1373
    basic_json(const int val) noexcept
N
Niels 已提交
1374
        : m_type(value_t::number_integer),
1375
          m_value(static_cast<number_integer_t>(val))
易思龙 已提交
1376
    {}
N
Niels 已提交
1377

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

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

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

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

    @complexity Constant.

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

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

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

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

N
Niels 已提交
1420
    @tparam T  helper type to compare number_unsigned_t and unsigned int
1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437
    (not visible in) the interface.

    @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
    */
    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 已提交
1438
    basic_json(const number_unsigned_t val) noexcept
1439 1440
        : m_type(value_t::number_unsigned), m_value(val)
    {}
N
Niels 已提交
1441

1442 1443 1444 1445
    /*!
    @brief create an unsigned number (implicit)

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

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

    @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 已提交
1462 1463 1464 1465 1466 1467 1468
    template < typename CompatibleNumberUnsignedType, typename
               std::enable_if <
                   std::is_constructible<number_unsigned_t, CompatibleNumberUnsignedType>::value and
                   std::numeric_limits<CompatibleNumberUnsignedType>::is_integer and
                   !std::numeric_limits<CompatibleNumberUnsignedType>::is_signed,
                   CompatibleNumberUnsignedType >::type
               = 0 >
1469 1470 1471 1472 1473
    basic_json(const CompatibleNumberUnsignedType val) noexcept
        : m_type(value_t::number_unsigned),
          m_value(static_cast<number_unsigned_t>(val))
    {}

N
Niels 已提交
1474 1475 1476 1477 1478
    /*!
    @brief create a floating-point number (explicit)

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

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

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

N
Niels 已提交
1488
    @complexity Constant.
N
Niels 已提交
1489 1490 1491

    @liveexample{The following example creates several floating-point
    values.,basic_json__number_float_t}
1492 1493 1494 1495

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

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

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

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

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

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

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

    @complexity Constant.

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

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

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

N
Niels 已提交
1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562
    /*!
    @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
    object value is created where the first elements of the pairs are treated
    as keys and the second elements are as values.
    3. In all other cases, an array is created.

    The rules aim to create the best fit between a C++ initializer list and
N
Niels 已提交
1563
    JSON values. The rationale is as follows:
N
Niels 已提交
1564 1565 1566 1567 1568 1569 1570 1571 1572 1573

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

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

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

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

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

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

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

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

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

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

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

N
Niels 已提交
1615
    @since version 1.0.0
N
Niels 已提交
1616
    */
N
Niels 已提交
1617 1618
    basic_json(std::initializer_list<basic_json> init,
               bool type_deduction = true,
N
Niels 已提交
1619
               value_t manual_type = value_t::array)
N
Niels 已提交
1620 1621
    {
        // the initializer list could describe an object
1622
        bool is_an_object = true;
N
Niels 已提交
1623

N
Niels 已提交
1624 1625
        // check if each element is an array with two elements whose first
        // element is a string
N
Niels 已提交
1626
        for (const auto& element : init)
N
Niels 已提交
1627
        {
N
cleanup  
Niels 已提交
1628 1629
            if (not element.is_array() or element.size() != 2
                    or not element[0].is_string())
N
Niels 已提交
1630 1631 1632
            {
                // we found an element that makes it impossible to use the
                // initializer list as object
1633
                is_an_object = false;
N
Niels 已提交
1634 1635 1636 1637 1638 1639 1640 1641 1642 1643
                break;
            }
        }

        // 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)
            {
1644
                is_an_object = false;
N
Niels 已提交
1645 1646 1647
            }

            // if object is wanted but impossible, throw an exception
1648
            if (manual_type == value_t::object and not is_an_object)
N
Niels 已提交
1649
            {
N
Niels 已提交
1650
                throw std::domain_error("cannot create object from initializer list");
N
Niels 已提交
1651 1652 1653
            }
        }

1654
        if (is_an_object)
N
Niels 已提交
1655 1656 1657
        {
            // the initializer list is a list of pairs -> create object
            m_type = value_t::object;
N
Niels 已提交
1658
            m_value = value_t::object;
N
Niels 已提交
1659

N
Niels 已提交
1660 1661
            assert(m_value.object != nullptr);

N
Niels 已提交
1662
            for (auto& element : init)
N
Niels 已提交
1663
            {
N
Niels 已提交
1664
                m_value.object->emplace(*(element[0].m_value.string), element[1]);
N
Niels 已提交
1665 1666 1667 1668 1669 1670
            }
        }
        else
        {
            // the initializer list describes an array -> create array
            m_type = value_t::array;
N
Niels 已提交
1671
            m_value.array = create<array_t>(init);
N
Niels 已提交
1672 1673 1674
        }
    }

N
Niels 已提交
1675 1676 1677 1678 1679 1680 1681 1682 1683
    /*!
    @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.

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

N
Niels 已提交
1692
    @param[in] init  initializer list with JSON values to create an array from
N
Niels 已提交
1693 1694 1695 1696 1697 1698
    (optional)

    @return JSON array value

    @complexity Linear in the size of @a init.

N
Niels 已提交
1699
    @liveexample{The following code shows an example for the `array`
N
Niels 已提交
1700 1701
    function.,array}

1702 1703 1704 1705 1706
    @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 已提交
1707
    @since version 1.0.0
N
Niels 已提交
1708
    */
N
Niels 已提交
1709 1710
    static basic_json array(std::initializer_list<basic_json> init =
                                std::initializer_list<basic_json>())
N
Niels 已提交
1711
    {
N
Niels 已提交
1712
        return basic_json(init, false, value_t::array);
N
Niels 已提交
1713 1714
    }

N
Niels 已提交
1715 1716 1717 1718
    /*!
    @brief explicitly create an object from an initializer list

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

    @note This function is only added for symmetry reasons. In contrast to the
1723 1724 1725 1726 1727
    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
    constructor
    @ref basic_json(std::initializer_list<basic_json>, bool, value_t).
N
Niels 已提交
1728

N
Niels 已提交
1729
    @param[in] init  initializer list to create an object from (optional)
N
Niels 已提交
1730 1731 1732 1733

    @return JSON object value

    @throw std::domain_error if @a init is not a pair whose first elements are
1734 1735
    strings; thrown by
    @ref basic_json(std::initializer_list<basic_json>, bool, value_t)
N
Niels 已提交
1736 1737 1738

    @complexity Linear in the size of @a init.

N
Niels 已提交
1739
    @liveexample{The following code shows an example for the `object`
N
Niels 已提交
1740 1741
    function.,object}

1742 1743 1744 1745 1746
    @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 已提交
1747
    @since version 1.0.0
N
Niels 已提交
1748
    */
N
Niels 已提交
1749 1750
    static basic_json object(std::initializer_list<basic_json> init =
                                 std::initializer_list<basic_json>())
N
Niels 已提交
1751
    {
N
Niels 已提交
1752
        return basic_json(init, false, value_t::object);
N
Niels 已提交
1753 1754
    }

N
Niels 已提交
1755 1756 1757
    /*!
    @brief construct an array with count copies of given value

1758 1759 1760
    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,
    `std::distance(begin(),end()) == cnt` holds.
N
Niels 已提交
1761

1762 1763
    @param[in] cnt  the number of JSON copies of @a val to create
    @param[in] val  the JSON value to copy
N
Niels 已提交
1764

1765
    @complexity Linear in @a cnt.
N
Niels 已提交
1766 1767 1768 1769

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

N
Niels 已提交
1771
    @since version 1.0.0
N
Niels 已提交
1772
    */
1773
    basic_json(size_type cnt, const basic_json& val)
N
Niels 已提交
1774 1775
        : m_type(value_t::array)
    {
1776
        m_value.array = create<array_t>(cnt, val);
N
Niels 已提交
1777
    }
N
Niels 已提交
1778

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

    @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)

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

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

N
Niels 已提交
1811
    @since version 1.0.0
N
Niels 已提交
1812 1813
    */
    template <class InputIT, typename
N
Niels 已提交
1814
              std::enable_if<
N
Niels 已提交
1815 1816
                  std::is_same<InputIT, typename basic_json_t::iterator>::value or
                  std::is_same<InputIT, typename basic_json_t::const_iterator>::value
N
Niels 已提交
1817 1818
                  , int>::type
              = 0>
N
Niels 已提交
1819
    basic_json(InputIT first, InputIT last) : m_type(first.m_object->m_type)
N
Niels 已提交
1820 1821
    {
        // make sure iterator fits the current value
N
Niels 已提交
1822
        if (first.m_object != last.m_object)
N
Niels 已提交
1823
        {
N
Niels 已提交
1824
            throw std::domain_error("iterators are not compatible");
N
Niels 已提交
1825 1826
        }

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

            default:
            {
                break;
            }
        }

        switch (m_type)
        {
            case value_t::number_integer:
            {
N
Niels 已提交
1853
                assert(first.m_object != nullptr);
N
Niels 已提交
1854 1855 1856
                m_value.number_integer = first.m_object->m_value.number_integer;
                break;
            }
N
Niels 已提交
1857

1858 1859 1860 1861 1862 1863
            case value_t::number_unsigned:
            {
                assert(first.m_object != nullptr);
                m_value.number_unsigned = first.m_object->m_value.number_unsigned;
                break;
            }
N
Niels 已提交
1864 1865 1866

            case value_t::number_float:
            {
N
Niels 已提交
1867
                assert(first.m_object != nullptr);
N
Niels 已提交
1868 1869 1870 1871 1872 1873
                m_value.number_float = first.m_object->m_value.number_float;
                break;
            }

            case value_t::boolean:
            {
N
Niels 已提交
1874
                assert(first.m_object != nullptr);
N
Niels 已提交
1875 1876 1877 1878 1879 1880
                m_value.boolean = first.m_object->m_value.boolean;
                break;
            }

            case value_t::string:
            {
N
Niels 已提交
1881
                assert(first.m_object != nullptr);
N
Niels 已提交
1882
                m_value = *first.m_object->m_value.string;
N
Niels 已提交
1883 1884 1885 1886 1887
                break;
            }

            case value_t::object:
            {
N
Cleanup  
Niels 已提交
1888
                m_value.object = create<object_t>(first.m_it.object_iterator, last.m_it.object_iterator);
N
Niels 已提交
1889 1890 1891 1892 1893
                break;
            }

            case value_t::array:
            {
N
Cleanup  
Niels 已提交
1894
                m_value.array = create<array_t>(first.m_it.array_iterator, last.m_it.array_iterator);
N
Niels 已提交
1895 1896 1897 1898 1899
                break;
            }

            default:
            {
N
Niels 已提交
1900
                assert(first.m_object != nullptr);
N
Niels 已提交
1901
                throw std::domain_error("cannot use construct with iterators from " + first.m_object->type_name());
N
Niels 已提交
1902 1903 1904 1905
            }
        }
    }

N
Niels 已提交
1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925
    /*!
    @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.

    @liveexample{The example below demonstrates constructing a JSON value from
    a `std::stringstream` with and without callback
    function.,basic_json__istream}

    @since version 2.0.0
    */
N
Niels 已提交
1926
    explicit basic_json(std::istream& i, parser_callback_t cb = nullptr)
N
Niels 已提交
1927 1928 1929 1930
    {
        *this = parser(i, cb).parse();
    }

N
Niels 已提交
1931 1932 1933 1934
    ///////////////////////////////////////
    // other constructors and destructor //
    ///////////////////////////////////////

N
Niels 已提交
1935 1936
    /*!
    @brief copy constructor
N
Niels 已提交
1937

N
Niels 已提交
1938 1939
    Creates a copy of a given JSON value.

N
Niels 已提交
1940
    @param[in] other  the JSON value to copy
N
Niels 已提交
1941 1942 1943

    @complexity Linear in the size of @a other.

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

N
Niels 已提交
1950
    @throw std::bad_alloc if allocation for object, array, or string fails.
N
Niels 已提交
1951 1952

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

N
Niels 已提交
1955
    @since version 1.0.0
N
Niels 已提交
1956
    */
N
Niels 已提交
1957
    basic_json(const basic_json& other)
N
Niels 已提交
1958 1959 1960 1961
        : m_type(other.m_type)
    {
        switch (m_type)
        {
1962
            case value_t::object:
N
Niels 已提交
1963
            {
N
Niels 已提交
1964
                assert(other.m_value.object != nullptr);
N
Niels 已提交
1965
                m_value = *other.m_value.object;
N
Niels 已提交
1966 1967
                break;
            }
N
Niels 已提交
1968

1969
            case value_t::array:
N
Niels 已提交
1970
            {
N
Niels 已提交
1971
                assert(other.m_value.array != nullptr);
N
Niels 已提交
1972
                m_value = *other.m_value.array;
N
Niels 已提交
1973 1974
                break;
            }
N
Niels 已提交
1975

1976
            case value_t::string:
N
Niels 已提交
1977
            {
N
Niels 已提交
1978
                assert(other.m_value.string != nullptr);
N
Niels 已提交
1979
                m_value = *other.m_value.string;
N
Niels 已提交
1980 1981
                break;
            }
N
Niels 已提交
1982

1983
            case value_t::boolean:
N
Niels 已提交
1984
            {
N
Niels 已提交
1985
                m_value = other.m_value.boolean;
N
Niels 已提交
1986 1987
                break;
            }
N
Niels 已提交
1988

1989
            case value_t::number_integer:
N
Niels 已提交
1990
            {
N
Niels 已提交
1991
                m_value = other.m_value.number_integer;
N
Niels 已提交
1992 1993
                break;
            }
N
Niels 已提交
1994

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

2001
            case value_t::number_float:
N
Niels 已提交
2002
            {
N
Niels 已提交
2003
                m_value = other.m_value.number_float;
N
Niels 已提交
2004 2005
                break;
            }
2006 2007 2008 2009 2010

            default:
            {
                break;
            }
N
Niels 已提交
2011 2012 2013
        }
    }

N
Niels 已提交
2014 2015 2016 2017 2018 2019 2020
    /*!
    @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 已提交
2021
    @param[in,out] other  value to move to this object
N
Niels 已提交
2022 2023 2024 2025 2026 2027 2028

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

N
Niels 已提交
2030
    @since version 1.0.0
N
Niels 已提交
2031
    */
N
Niels 已提交
2032
    basic_json(basic_json&& other) noexcept
N
Niels 已提交
2033 2034 2035
        : m_type(std::move(other.m_type)),
          m_value(std::move(other.m_value))
    {
N
Niels 已提交
2036
        // invalidate payload
N
Niels 已提交
2037 2038 2039 2040
        other.m_type = value_t::null;
        other.m_value = {};
    }

N
Niels 已提交
2041 2042
    /*!
    @brief copy assignment
N
Niels 已提交
2043

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

N
Niels 已提交
2048
    @param[in] other  value to copy from
N
Niels 已提交
2049 2050 2051

    @complexity Linear.

N
Niels 已提交
2052 2053 2054
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2055 2056
    - The complexity is linear.

N
Niels 已提交
2057 2058 2059 2060
    @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 已提交
2061

N
Niels 已提交
2062
    @since version 1.0.0
N
Niels 已提交
2063
    */
N
Niels 已提交
2064
    reference& operator=(basic_json other) noexcept (
N
Niels 已提交
2065 2066 2067 2068 2069
        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 已提交
2070
    {
N
Niels 已提交
2071
        using std::swap;
N
Cleanup  
Niels 已提交
2072 2073
        swap(m_type, other.m_type);
        swap(m_value, other.m_value);
N
Niels 已提交
2074 2075 2076
        return *this;
    }

N
Niels 已提交
2077 2078
    /*!
    @brief destructor
N
Niels 已提交
2079

N
Niels 已提交
2080
    Destroys the JSON value and frees all allocated memory.
N
Niels 已提交
2081 2082 2083

    @complexity Linear.

N
Niels 已提交
2084 2085 2086
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2087 2088
    - The complexity is linear.
    - All stored elements are destroyed and all memory is freed.
2089

N
Niels 已提交
2090
    @since version 1.0.0
N
Niels 已提交
2091
    */
N
Niels 已提交
2092
    ~basic_json()
N
Niels 已提交
2093 2094 2095
    {
        switch (m_type)
        {
2096
            case value_t::object:
N
Niels 已提交
2097
            {
N
Niels 已提交
2098
                AllocatorType<object_t> alloc;
N
Niels 已提交
2099 2100
                alloc.destroy(m_value.object);
                alloc.deallocate(m_value.object, 1);
N
Niels 已提交
2101 2102
                break;
            }
N
Niels 已提交
2103

2104
            case value_t::array:
N
Niels 已提交
2105
            {
N
Niels 已提交
2106
                AllocatorType<array_t> alloc;
N
Niels 已提交
2107 2108
                alloc.destroy(m_value.array);
                alloc.deallocate(m_value.array, 1);
N
Niels 已提交
2109 2110
                break;
            }
N
Niels 已提交
2111

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

            default:
N
Niels 已提交
2121
            {
N
Niels 已提交
2122
                // all other types need no specific destructor
N
Niels 已提交
2123 2124 2125 2126 2127
                break;
            }
        }
    }

N
Niels 已提交
2128
    /// @}
N
Niels 已提交
2129 2130 2131 2132 2133 2134

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

N
Niels 已提交
2135 2136 2137
    /// @name object inspection
    /// @{

N
Niels 已提交
2138
    /*!
N
Niels 已提交
2139 2140
    @brief serialization

N
Niels 已提交
2141
    Serialization function for JSON values. The function tries to mimic
N
Niels 已提交
2142 2143
    Python's @p json.dumps() function, and currently supports its @p indent
    parameter.
N
Niels 已提交
2144

N
Niels 已提交
2145
    @param[in] indent if indent is nonnegative, then array elements and object
N
Niels 已提交
2146 2147 2148
    members will be pretty-printed with that indent level. An indent level of 0
    will only insert newlines. -1 (the default) selects the most compact
    representation
N
Niels 已提交
2149

N
Niels 已提交
2150 2151 2152 2153 2154
    @return string containing the serialization of the JSON value

    @complexity Linear.

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

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

N
Niels 已提交
2159
    @since version 1.0.0
N
Niels 已提交
2160
    */
N
Niels 已提交
2161
    string_t dump(const int indent = -1) const
N
Niels 已提交
2162
    {
N
Niels 已提交
2163 2164
        std::stringstream ss;

N
Niels 已提交
2165 2166
        if (indent >= 0)
        {
N
Niels 已提交
2167
            dump(ss, true, static_cast<unsigned int>(indent));
N
Niels 已提交
2168 2169 2170
        }
        else
        {
N
Niels 已提交
2171
            dump(ss, false, 0);
N
Niels 已提交
2172
        }
N
Niels 已提交
2173 2174

        return ss.str();
N
Niels 已提交
2175 2176
    }

N
Niels 已提交
2177 2178 2179 2180 2181 2182 2183
    /*!
    @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 已提交
2184 2185 2186

    @complexity Constant.

N
Niels 已提交
2187 2188 2189
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2190
    @liveexample{The following code exemplifies `type()` for all JSON
N
Niels 已提交
2191
    types.,type}
N
Niels 已提交
2192

N
Niels 已提交
2193
    @since version 1.0.0
N
Niels 已提交
2194
    */
N
Niels 已提交
2195
    constexpr value_t type() const noexcept
N
Niels 已提交
2196 2197 2198 2199
    {
        return m_type;
    }

N
Niels 已提交
2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210
    /*!
    @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 已提交
2211 2212 2213
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2214
    @liveexample{The following code exemplifies `is_primitive()` for all JSON
N
Niels 已提交
2215
    types.,is_primitive}
N
Niels 已提交
2216

N
Niels 已提交
2217 2218 2219 2220 2221 2222
    @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 已提交
2223
    @since version 1.0.0
N
Niels 已提交
2224
    */
N
Niels 已提交
2225
    constexpr bool is_primitive() const noexcept
N
Niels 已提交
2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239
    {
        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 已提交
2240 2241 2242
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2243
    @liveexample{The following code exemplifies `is_structured()` for all JSON
N
Niels 已提交
2244
    types.,is_structured}
N
Niels 已提交
2245

N
Niels 已提交
2246 2247 2248 2249
    @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 已提交
2250
    @since version 1.0.0
N
Niels 已提交
2251
    */
N
Niels 已提交
2252
    constexpr bool is_structured() const noexcept
N
Niels 已提交
2253 2254 2255 2256
    {
        return is_array() or is_object();
    }

N
Niels 已提交
2257 2258 2259 2260 2261
    /*!
    @brief return whether value is null

    This function returns true iff the JSON value is null.

N
Niels 已提交
2262
    @return `true` if type is null, `false` otherwise.
N
Niels 已提交
2263 2264 2265

    @complexity Constant.

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

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

N
Niels 已提交
2272
    @since version 1.0.0
N
Niels 已提交
2273
    */
N
Niels 已提交
2274
    constexpr bool is_null() const noexcept
N
Niels 已提交
2275 2276 2277 2278
    {
        return m_type == value_t::null;
    }

N
Niels 已提交
2279 2280 2281 2282 2283
    /*!
    @brief return whether value is a boolean

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

N
Niels 已提交
2284
    @return `true` if type is boolean, `false` otherwise.
N
Niels 已提交
2285 2286 2287

    @complexity Constant.

N
Niels 已提交
2288 2289 2290
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

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

N
Niels 已提交
2294
    @since version 1.0.0
N
Niels 已提交
2295
    */
N
Niels 已提交
2296
    constexpr bool is_boolean() const noexcept
N
Niels 已提交
2297 2298 2299 2300
    {
        return m_type == value_t::boolean;
    }

N
Niels 已提交
2301 2302 2303 2304 2305 2306
    /*!
    @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.

2307 2308
    @return `true` if type is number (regardless whether integer, unsigned
    integer or floating-type), `false` otherwise.
N
Niels 已提交
2309 2310 2311

    @complexity Constant.

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

N
Niels 已提交
2315
    @liveexample{The following code exemplifies `is_number()` for all JSON
N
Niels 已提交
2316
    types.,is_number}
N
Niels 已提交
2317

N
Niels 已提交
2318
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
2319
    integer number
N
Niels 已提交
2320 2321
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2322 2323
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
2324
    @since version 1.0.0
N
Niels 已提交
2325
    */
N
Niels 已提交
2326
    constexpr bool is_number() const noexcept
N
Niels 已提交
2327
    {
N
Niels 已提交
2328
        return is_number_integer() or is_number_float();
N
Niels 已提交
2329 2330
    }

N
Niels 已提交
2331 2332 2333
    /*!
    @brief return whether value is an integer number

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

N
Niels 已提交
2337
    @return `true` if type is an integer or unsigned integer number, `false`
2338
    otherwise.
N
Niels 已提交
2339 2340 2341

    @complexity Constant.

N
Niels 已提交
2342 2343 2344
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2345
    @liveexample{The following code exemplifies `is_number_integer()` for all
N
Niels 已提交
2346
    JSON types.,is_number_integer}
N
Niels 已提交
2347 2348

    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
2349 2350
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2351 2352
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
2353
    @since version 1.0.0
N
Niels 已提交
2354
    */
N
Niels 已提交
2355
    constexpr bool is_number_integer() const noexcept
N
Niels 已提交
2356
    {
2357 2358
        return m_type == value_t::number_integer or m_type == value_t::number_unsigned;
    }
N
Niels 已提交
2359

2360 2361 2362
    /*!
    @brief return whether value is an unsigned integer number

N
Niels 已提交
2363 2364
    This function returns true iff the JSON value is an unsigned integer
    number. This excludes floating-point and (signed) integer values.
2365 2366 2367 2368 2369

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

    @complexity Constant.

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

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

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

    @since version 2.0.0
    */
N
Niels 已提交
2383
    constexpr bool is_number_unsigned() const noexcept
2384 2385
    {
        return m_type == value_t::number_unsigned;
N
Niels 已提交
2386 2387
    }

N
Niels 已提交
2388 2389 2390 2391
    /*!
    @brief return whether value is a floating-point number

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

N
Niels 已提交
2394
    @return `true` if type is a floating-point number, `false` otherwise.
N
Niels 已提交
2395 2396 2397

    @complexity Constant.

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

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

    @sa @ref is_number() -- check if value is number
    @sa @ref is_number_integer() -- check if value is an integer number
N
Niels 已提交
2406 2407
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2408

N
Niels 已提交
2409
    @since version 1.0.0
N
Niels 已提交
2410
    */
N
Niels 已提交
2411
    constexpr bool is_number_float() const noexcept
N
Niels 已提交
2412 2413 2414 2415
    {
        return m_type == value_t::number_float;
    }

N
Niels 已提交
2416 2417 2418 2419 2420
    /*!
    @brief return whether value is an object

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

N
Niels 已提交
2421
    @return `true` if type is object, `false` otherwise.
N
Niels 已提交
2422 2423 2424

    @complexity Constant.

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

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

N
Niels 已提交
2431
    @since version 1.0.0
N
Niels 已提交
2432
    */
N
Niels 已提交
2433
    constexpr bool is_object() const noexcept
N
Niels 已提交
2434 2435 2436 2437
    {
        return m_type == value_t::object;
    }

N
Niels 已提交
2438 2439 2440 2441 2442
    /*!
    @brief return whether value is an array

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

N
Niels 已提交
2443
    @return `true` if type is array, `false` otherwise.
N
Niels 已提交
2444 2445 2446

    @complexity Constant.

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

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

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

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

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

N
Niels 已提交
2465
    @return `true` if type is string, `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_string()` for all JSON
N
Niels 已提交
2473
    types.,is_string}
N
Niels 已提交
2474

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

N
Niels 已提交
2482 2483 2484 2485 2486 2487
    /*!
    @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 已提交
2488 2489 2490 2491
    @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 已提交
2492 2493 2494 2495
    @return `true` if type is discarded, `false` otherwise.

    @complexity Constant.

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

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

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

N
Niels 已提交
2509 2510 2511 2512 2513 2514 2515 2516 2517 2518
    /*!
    @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 已提交
2519 2520 2521
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

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

N
Niels 已提交
2525
    @since version 1.0.0
N
Niels 已提交
2526
    */
N
Niels 已提交
2527
    constexpr operator value_t() const noexcept
N
Niels 已提交
2528 2529 2530 2531
    {
        return m_type;
    }

N
Niels 已提交
2532 2533
    /// @}

N
Niels 已提交
2534
  private:
N
Niels 已提交
2535 2536 2537
    //////////////////
    // value access //
    //////////////////
N
Niels 已提交
2538

N
Niels 已提交
2539
    /// get an object (explicit)
N
Niels 已提交
2540 2541
    template <class T, typename
              std::enable_if<
N
Niels 已提交
2542
                  std::is_convertible<typename object_t::key_type, typename T::key_type>::value and
N
Niels 已提交
2543
                  std::is_convertible<basic_json_t, typename T::mapped_type>::value
N
Niels 已提交
2544
                  , int>::type = 0>
N
Niels 已提交
2545
    T get_impl(T*) const
N
Niels 已提交
2546
    {
2547
        if (is_object())
N
Niels 已提交
2548
        {
N
Niels 已提交
2549
            assert(m_value.object != nullptr);
2550 2551 2552 2553 2554
            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 已提交
2555 2556 2557 2558
        }
    }

    /// get an object (explicit)
N
Niels 已提交
2559
    object_t get_impl(object_t*) const
N
Niels 已提交
2560
    {
2561
        if (is_object())
N
Niels 已提交
2562
        {
N
Niels 已提交
2563
            assert(m_value.object != nullptr);
2564 2565 2566 2567 2568
            return *(m_value.object);
        }
        else
        {
            throw std::domain_error("type must be object, but is " + type_name());
N
Niels 已提交
2569 2570 2571
        }
    }

N
Niels 已提交
2572
    /// get an array (explicit)
N
Niels 已提交
2573 2574
    template <class T, typename
              std::enable_if<
N
Niels 已提交
2575 2576
                  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
N
Niels 已提交
2577 2578
                  not std::is_arithmetic<T>::value and
                  not std::is_convertible<std::string, T>::value and
2579
                  not has_mapped_type<T>::value
N
Niels 已提交
2580
                  , int>::type = 0>
N
Niels 已提交
2581
    T get_impl(T*) const
N
Niels 已提交
2582
    {
N
cleanup  
Niels 已提交
2583
        if (is_array())
N
Niels 已提交
2584
        {
2585
            T to_vector;
N
Niels 已提交
2586
            assert(m_value.array != nullptr);
2587 2588
            std::transform(m_value.array->begin(), m_value.array->end(),
                           std::inserter(to_vector, to_vector.end()), [](basic_json i)
N
Niels 已提交
2589
            {
2590 2591 2592 2593 2594 2595 2596
                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 已提交
2597 2598 2599
        }
    }

N
Niels 已提交
2600 2601
    /// get an array (explicit)
    template <class T, typename
N
Niels 已提交
2602
              std::enable_if<
N
Niels 已提交
2603 2604
                  std::is_convertible<basic_json_t, T>::value and
                  not std::is_same<basic_json_t, T>::value
N
Niels 已提交
2605
                  , int>::type = 0>
N
Niels 已提交
2606
    std::vector<T> get_impl(std::vector<T>*) const
N
Niels 已提交
2607
    {
N
cleanup  
Niels 已提交
2608
        if (is_array())
N
Niels 已提交
2609
        {
2610
            std::vector<T> to_vector;
N
Niels 已提交
2611
            assert(m_value.array != nullptr);
2612 2613 2614
            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 已提交
2615
            {
2616 2617 2618 2619 2620 2621 2622
                return i.get<T>();
            });
            return to_vector;
        }
        else
        {
            throw std::domain_error("type must be array, but is " + type_name());
N
Niels 已提交
2623 2624 2625
        }
    }

N
Niels 已提交
2626 2627 2628 2629
    /// get an array (explicit)
    template <class T, typename
              std::enable_if<
                  std::is_same<basic_json, typename T::value_type>::value and
2630
                  not has_mapped_type<T>::value
N
Niels 已提交
2631
                  , int>::type = 0>
N
Niels 已提交
2632
    T get_impl(T*) const
N
Niels 已提交
2633
    {
2634
        if (is_array())
N
Niels 已提交
2635
        {
N
Niels 已提交
2636
            assert(m_value.array != nullptr);
2637 2638 2639 2640 2641
            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 已提交
2642 2643 2644
        }
    }

N
Niels 已提交
2645
    /// get an array (explicit)
N
Niels 已提交
2646
    array_t get_impl(array_t*) const
N
Niels 已提交
2647
    {
2648
        if (is_array())
N
Niels 已提交
2649
        {
N
Niels 已提交
2650
            assert(m_value.array != nullptr);
2651 2652 2653 2654 2655
            return *(m_value.array);
        }
        else
        {
            throw std::domain_error("type must be array, but is " + type_name());
N
Niels 已提交
2656 2657 2658 2659
        }
    }

    /// get a string (explicit)
N
Niels 已提交
2660 2661
    template <typename T, typename
              std::enable_if<
N
Niels 已提交
2662 2663
                  std::is_convertible<string_t, T>::value
                  , int>::type = 0>
N
Niels 已提交
2664
    T get_impl(T*) const
N
Niels 已提交
2665
    {
2666
        if (is_string())
N
Niels 已提交
2667
        {
N
Niels 已提交
2668
            assert(m_value.string != nullptr);
2669 2670 2671 2672 2673
            return *m_value.string;
        }
        else
        {
            throw std::domain_error("type must be string, but is " + type_name());
N
Niels 已提交
2674 2675 2676
        }
    }

N
Niels 已提交
2677
    /// get a number (explicit)
N
Niels 已提交
2678 2679
    template<typename T, typename
             std::enable_if<
N
Niels 已提交
2680 2681
                 std::is_arithmetic<T>::value
                 , int>::type = 0>
N
Niels 已提交
2682
    T get_impl(T*) const
N
Niels 已提交
2683 2684 2685
    {
        switch (m_type)
        {
2686
            case value_t::number_integer:
N
Niels 已提交
2687
            {
N
Niels 已提交
2688
                return static_cast<T>(m_value.number_integer);
N
Niels 已提交
2689
            }
N
Niels 已提交
2690

2691 2692 2693 2694
            case value_t::number_unsigned:
            {
                return static_cast<T>(m_value.number_unsigned);
            }
2695 2696

            case value_t::number_float:
N
Niels 已提交
2697
            {
N
Niels 已提交
2698
                return static_cast<T>(m_value.number_float);
N
Niels 已提交
2699
            }
2700

N
Niels 已提交
2701
            default:
N
Niels 已提交
2702
            {
N
Niels 已提交
2703
                throw std::domain_error("type must be number, but is " + type_name());
N
Niels 已提交
2704 2705 2706 2707 2708
            }
        }
    }

    /// get a boolean (explicit)
N
Niels 已提交
2709
    constexpr boolean_t get_impl(boolean_t*) const
N
Niels 已提交
2710
    {
N
Niels 已提交
2711 2712 2713
        return is_boolean()
               ? m_value.boolean
               : throw std::domain_error("type must be boolean, but is " + type_name());
N
Niels 已提交
2714 2715
    }

N
Niels 已提交
2716
    /// get a pointer to the value (object)
N
Niels 已提交
2717
    object_t* get_impl_ptr(object_t*) noexcept
N
Niels 已提交
2718 2719 2720 2721
    {
        return is_object() ? m_value.object : nullptr;
    }

N
Niels 已提交
2722
    /// get a pointer to the value (object)
N
Niels 已提交
2723
    constexpr const object_t* get_impl_ptr(const object_t*) const noexcept
N
Niels 已提交
2724 2725 2726 2727 2728 2729 2730 2731 2732 2733
    {
        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 已提交
2734
    /// get a pointer to the value (array)
N
Niels 已提交
2735
    constexpr const array_t* get_impl_ptr(const array_t*) const noexcept
N
Niels 已提交
2736 2737 2738 2739 2740
    {
        return is_array() ? m_value.array : nullptr;
    }

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

    /// get a pointer to the value (string)
N
Niels 已提交
2747
    constexpr const string_t* get_impl_ptr(const string_t*) const noexcept
N
Niels 已提交
2748 2749 2750 2751 2752
    {
        return is_string() ? m_value.string : nullptr;
    }

    /// get a pointer to the value (boolean)
N
Niels 已提交
2753 2754 2755 2756 2757 2758
    boolean_t* get_impl_ptr(boolean_t*) noexcept
    {
        return is_boolean() ? &m_value.boolean : nullptr;
    }

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

    /// get a pointer to the value (integer number)
N
Niels 已提交
2765 2766 2767 2768 2769 2770
    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 已提交
2771
    constexpr const number_integer_t* get_impl_ptr(const number_integer_t*) const noexcept
N
Niels 已提交
2772 2773 2774
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }
N
Niels 已提交
2775

2776 2777 2778 2779 2780
    /// 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 已提交
2781

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

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

N
Niels 已提交
2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811
    /*!
    @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>
D
dariomt 已提交
2812 2813 2814
    static ReferenceType get_ref_impl(ThisType& obj)
    {
        // delegate the call to get_ptr<>()
N
Niels 已提交
2815
        using PointerType = typename std::add_pointer<ReferenceType>::type;
2816
        auto ptr = obj.template get_ptr<PointerType>();
N
Niels 已提交
2817 2818 2819 2820 2821 2822 2823 2824 2825 2826

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

N
Niels 已提交
2829
  public:
N
Niels 已提交
2830 2831 2832 2833

    /// @name value access
    /// @{

N
Niels 已提交
2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845
    /*!
    @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 已提交
2846
    to JSON; example: `"type must be object, but is null"`
N
Niels 已提交
2847 2848 2849

    @complexity Linear in the size of the JSON value.

N
Niels 已提交
2850
    @liveexample{The example below shows several conversions from JSON values
N
Niels 已提交
2851 2852 2853
    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 已提交
2854
    associative containers such as `std::unordered_map<std::string\,
N
Niels 已提交
2855 2856 2857 2858 2859 2860 2861 2862 2863
    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 已提交
2864

N
Niels 已提交
2865
    @since version 1.0.0
N
Niels 已提交
2866 2867 2868 2869 2870 2871
    */
    template<typename ValueType, typename
             std::enable_if<
                 not std::is_pointer<ValueType>::value
                 , int>::type = 0>
    ValueType get() const
N
Niels 已提交
2872
    {
N
Niels 已提交
2873
        return get_impl(static_cast<ValueType*>(nullptr));
N
Niels 已提交
2874 2875
    }

N
Niels 已提交
2876 2877 2878 2879 2880 2881
    /*!
    @brief get a pointer value (explicit)

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

N
Niels 已提交
2882
    @warning The pointer becomes invalid if the underlying JSON object changes.
N
Niels 已提交
2883 2884

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

N
Niels 已提交
2888 2889
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
2890 2891 2892 2893 2894 2895 2896 2897 2898

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

N
Niels 已提交
2900
    @since version 1.0.0
N
Niels 已提交
2901 2902 2903 2904 2905
    */
    template<typename PointerType, typename
             std::enable_if<
                 std::is_pointer<PointerType>::value
                 , int>::type = 0>
N
Niels 已提交
2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919
    PointerType get() noexcept
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

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

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

N
Niels 已提交
2929
    Implicit pointer access to the internally stored JSON value. No copies are
N
Niels 已提交
2930 2931 2932 2933 2934 2935
    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 已提交
2936
    object_t, @ref string_t, @ref boolean_t, @ref number_integer_t,
2937
    @ref number_unsigned_t, or @ref number_float_t.
N
Niels 已提交
2938

N
Niels 已提交
2939 2940
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
2941 2942 2943 2944 2945 2946 2947

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

N
Niels 已提交
2949
    @since version 1.0.0
N
Niels 已提交
2950 2951 2952 2953 2954
    */
    template<typename PointerType, typename
             std::enable_if<
                 std::is_pointer<PointerType>::value
                 , int>::type = 0>
N
Niels 已提交
2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967
    PointerType get_ptr() noexcept
    {
        // delegate the call to get_impl_ptr<>()
        return get_impl_ptr(static_cast<PointerType>(nullptr));
    }

    /*!
    @brief get a pointer value (implicit)
    @copydoc get_ptr()
    */
    template<typename PointerType, typename
             std::enable_if<
                 std::is_pointer<PointerType>::value
N
Niels 已提交
2968
                 and std::is_const<typename std::remove_pointer<PointerType>::type>::value
N
Niels 已提交
2969
                 , int>::type = 0>
N
Niels 已提交
2970
    constexpr const PointerType get_ptr() const noexcept
N
Niels 已提交
2971 2972
    {
        // delegate the call to get_impl_ptr<>() const
D
dariomt 已提交
2973
        return get_impl_ptr(static_cast<const PointerType>(nullptr));
D
dariomt 已提交
2974 2975
    }

N
Niels 已提交
2976
    /*!
D
dariomt 已提交
2977 2978 2979 2980 2981 2982 2983 2984
    @brief get a reference value (implicit)

    Implict reference access to the internally stored JSON value. No copies are
    made.

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

N
Niels 已提交
2985 2986 2987
    @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
    @ref number_float_t.
D
dariomt 已提交
2988

N
Niels 已提交
2989 2990 2991
    @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 已提交
2992

N
Niels 已提交
2993 2994
    @throw std::domain_error in case passed type @a ReferenceType is
    incompatible with the stored JSON value
D
dariomt 已提交
2995 2996

    @complexity Constant.
N
Niels 已提交
2997 2998 2999

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

N
Niels 已提交
3000
    @since version 1.1.0
D
dariomt 已提交
3001 3002 3003 3004 3005 3006 3007
    */
    template<typename ReferenceType, typename
             std::enable_if<
                 std::is_reference<ReferenceType>::value
                 , int>::type = 0>
    ReferenceType get_ref()
    {
N
Niels 已提交
3008 3009
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
D
dariomt 已提交
3010 3011 3012 3013 3014 3015 3016 3017 3018
    }

    /*!
    @brief get a reference value (implicit)
    @copydoc get_ref()
    */
    template<typename ReferenceType, typename
             std::enable_if<
                 std::is_reference<ReferenceType>::value
N
Niels 已提交
3019
                 and std::is_const<typename std::remove_reference<ReferenceType>::type>::value
D
dariomt 已提交
3020 3021 3022
                 , int>::type = 0>
    ReferenceType get_ref() const
    {
N
Niels 已提交
3023 3024
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
N
Niels 已提交
3025 3026 3027 3028 3029
    }

    /*!
    @brief get a value (implicit)

N
Niels 已提交
3030
    Implicit type conversion between the JSON value and a compatible value. The
N
Niels 已提交
3031 3032 3033 3034
    call is realized by calling @ref get() const.

    @tparam ValueType non-pointer type compatible to the JSON value, for
    instance `int` for JSON integer numbers, `bool` for JSON booleans, or
N
Niels 已提交
3035 3036 3037
    `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 已提交
3038 3039 3040 3041 3042 3043 3044 3045

    @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 已提交
3046
    @liveexample{The example below shows several conversions from JSON values
N
Niels 已提交
3047 3048 3049
    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 已提交
3050
    associative containers such as `std::unordered_map<std::string\,
N
Niels 已提交
3051
    json>`.,operator__ValueType}
N
Niels 已提交
3052

N
Niels 已提交
3053
    @since version 1.0.0
N
Niels 已提交
3054
    */
N
Niels 已提交
3055 3056 3057 3058
    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
3059
#ifndef _MSC_VER  // Fix for issue #167 operator<< abiguity under VS2015
N
Niels 已提交
3060
                   and not std::is_same<ValueType, std::initializer_list<typename string_t::value_type>>::value
3061
#endif
N
Niels 已提交
3062
                   , int >::type = 0 >
N
Niels 已提交
3063
    operator ValueType() const
N
Niels 已提交
3064
    {
N
Niels 已提交
3065 3066
        // delegate the call to get<>() const
        return get<ValueType>();
N
Niels 已提交
3067 3068
    }

N
Niels 已提交
3069 3070
    /// @}

N
Niels 已提交
3071 3072 3073 3074 3075

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

N
Niels 已提交
3076 3077 3078
    /// @name element access
    /// @{

N
Niels 已提交
3079 3080 3081 3082 3083 3084 3085 3086 3087 3088
    /*!
    @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 已提交
3089 3090
    @throw std::domain_error if the JSON value is not an array; example:
    `"cannot use at() with string"`
N
Niels 已提交
3091
    @throw std::out_of_range if the index @a idx is out of range of the array;
N
Niels 已提交
3092
    that is, `idx >= size()`; example: `"array index 7 is out of range"`
N
Niels 已提交
3093 3094 3095 3096

    @complexity Constant.

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

N
Niels 已提交
3099
    @since version 1.0.0
N
Niels 已提交
3100
    */
N
Niels 已提交
3101
    reference at(size_type idx)
N
Niels 已提交
3102 3103
    {
        // at only works for arrays
3104 3105
        if (is_array())
        {
N
Niels 已提交
3106 3107
            try
            {
N
Niels 已提交
3108
                assert(m_value.array != nullptr);
N
Niels 已提交
3109 3110
                return m_value.array->at(idx);
            }
3111
            catch (std::out_of_range&)
N
Niels 已提交
3112 3113 3114 3115
            {
                // create better exception explanation
                throw std::out_of_range("array index " + std::to_string(idx) + " is out of range");
            }
3116 3117
        }
        else
N
Niels 已提交
3118
        {
N
Niels 已提交
3119
            throw std::domain_error("cannot use at() with " + type_name());
N
Niels 已提交
3120 3121 3122
        }
    }

N
Niels 已提交
3123 3124 3125 3126 3127 3128 3129 3130 3131 3132
    /*!
    @brief access specified array element with bounds checking

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

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

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

N
Niels 已提交
3133 3134
    @throw std::domain_error if the JSON value is not an array; example:
    `"cannot use at() with string"`
N
Niels 已提交
3135
    @throw std::out_of_range if the index @a idx is out of range of the array;
N
Niels 已提交
3136
    that is, `idx >= size()`; example: `"array index 7 is out of range"`
N
Niels 已提交
3137 3138 3139 3140

    @complexity Constant.

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

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

N
Niels 已提交
3167 3168 3169 3170 3171 3172 3173 3174 3175 3176
    /*!
    @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 已提交
3177 3178
    @throw std::domain_error if the JSON value is not an object; example:
    `"cannot use at() with boolean"`
N
Niels 已提交
3179
    @throw std::out_of_range if the key @a key is is not stored in the object;
N
Niels 已提交
3180
    that is, `find(key) == end()`; example: `"key "the fast" not found"`
N
Niels 已提交
3181 3182 3183 3184

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3185
    written using `at()`.,at__object_t_key_type}
N
Niels 已提交
3186 3187 3188 3189

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

N
Niels 已提交
3191
    @since version 1.0.0
N
Niels 已提交
3192
    */
N
Niels 已提交
3193
    reference at(const typename object_t::key_type& key)
3194 3195
    {
        // at only works for objects
3196 3197
        if (is_object())
        {
N
Niels 已提交
3198 3199
            try
            {
N
Niels 已提交
3200
                assert(m_value.object != nullptr);
N
Niels 已提交
3201 3202
                return m_value.object->at(key);
            }
3203
            catch (std::out_of_range&)
N
Niels 已提交
3204 3205 3206 3207
            {
                // create better exception explanation
                throw std::out_of_range("key '" + key + "' not found");
            }
3208 3209
        }
        else
3210
        {
N
Niels 已提交
3211
            throw std::domain_error("cannot use at() with " + type_name());
3212 3213 3214
        }
    }

N
Niels 已提交
3215 3216 3217 3218 3219 3220 3221 3222 3223 3224
    /*!
    @brief access specified object element with bounds checking

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

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

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

N
Niels 已提交
3225 3226
    @throw std::domain_error if the JSON value is not an object; example:
    `"cannot use at() with boolean"`
N
Niels 已提交
3227
    @throw std::out_of_range if the key @a key is is not stored in the object;
N
Niels 已提交
3228
    that is, `find(key) == end()`; example: `"key "the fast" not found"`
N
Niels 已提交
3229 3230 3231 3232

    @complexity Logarithmic in the size of the container.

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

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

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

N
Niels 已提交
3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275
    /*!
    @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 已提交
3276 3277
    @throw std::domain_error if JSON is not an array or null; example:
    `"cannot use operator[] with string"`
N
Niels 已提交
3278 3279 3280 3281 3282

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

N
Niels 已提交
3286
    @since version 1.0.0
N
Niels 已提交
3287
    */
N
Niels 已提交
3288
    reference operator[](size_type idx)
N
Niels 已提交
3289
    {
N
Niels 已提交
3290
        // implicitly convert null value to an empty array
N
cleanup  
Niels 已提交
3291
        if (is_null())
N
Niels 已提交
3292 3293
        {
            m_type = value_t::array;
N
Cleanup  
Niels 已提交
3294
            m_value.array = create<array_t>();
N
Niels 已提交
3295 3296
        }

N
Niels 已提交
3297
        // operator[] only works for arrays
N
cleanup  
Niels 已提交
3298
        if (is_array())
N
Niels 已提交
3299
        {
N
Niels 已提交
3300
            // fill up array with null values until given idx is reached
N
Niels 已提交
3301
            assert(m_value.array != nullptr);
N
cleanup  
Niels 已提交
3302 3303 3304 3305
            for (size_t i = m_value.array->size(); i <= idx; ++i)
            {
                m_value.array->push_back(basic_json());
            }
N
Niels 已提交
3306

N
cleanup  
Niels 已提交
3307 3308 3309
            return m_value.array->operator[](idx);
        }
        else
N
Niels 已提交
3310
        {
N
cleanup  
Niels 已提交
3311
            throw std::domain_error("cannot use operator[] with " + type_name());
N
Niels 已提交
3312
        }
N
Niels 已提交
3313 3314
    }

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

    @complexity Constant.

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

N
Niels 已提交
3332
    @since version 1.0.0
N
Niels 已提交
3333
    */
N
Niels 已提交
3334
    const_reference operator[](size_type idx) const
N
Niels 已提交
3335
    {
N
Niels 已提交
3336
        // const operator[] only works for arrays
3337 3338
        if (is_array())
        {
N
Niels 已提交
3339
            assert(m_value.array != nullptr);
3340 3341 3342
            return m_value.array->operator[](idx);
        }
        else
N
Niels 已提交
3343
        {
N
Niels 已提交
3344
            throw std::domain_error("cannot use operator[] with " + type_name());
N
Niels 已提交
3345 3346 3347
        }
    }

N
Niels 已提交
3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360
    /*!
    @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 已提交
3361
    @throw std::domain_error if JSON is not an object or null; example:
N
Niels 已提交
3362
    `"cannot use operator[] with string"`
N
Niels 已提交
3363 3364 3365 3366

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3367
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
3368 3369 3370 3371

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

N
Niels 已提交
3373
    @since version 1.0.0
N
Niels 已提交
3374
    */
N
Niels 已提交
3375
    reference operator[](const typename object_t::key_type& key)
N
Niels 已提交
3376
    {
N
Niels 已提交
3377
        // implicitly convert null value to an empty object
N
cleanup  
Niels 已提交
3378
        if (is_null())
N
Niels 已提交
3379 3380
        {
            m_type = value_t::object;
N
Cleanup  
Niels 已提交
3381
            m_value.object = create<object_t>();
N
Niels 已提交
3382 3383
        }

N
Niels 已提交
3384
        // operator[] only works for objects
3385 3386
        if (is_object())
        {
N
Niels 已提交
3387
            assert(m_value.object != nullptr);
3388 3389 3390
            return m_value.object->operator[](key);
        }
        else
N
Niels 已提交
3391
        {
N
Niels 已提交
3392
            throw std::domain_error("cannot use operator[] with " + type_name());
N
Niels 已提交
3393 3394 3395
        }
    }

N
Niels 已提交
3396
    /*!
3397
    @brief read-only access specified object element
N
Niels 已提交
3398

3399 3400 3401 3402 3403
    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 已提交
3404 3405 3406

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

3407
    @return const reference to the element at key @a key
N
Niels 已提交
3408

N
Niels 已提交
3409 3410
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    operator[] with null"`
N
Niels 已提交
3411 3412 3413 3414

    @complexity Logarithmic in the size of the container.

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

    @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 已提交
3421
    @since version 1.0.0
N
Niels 已提交
3422
    */
N
Niels 已提交
3423
    const_reference operator[](const typename object_t::key_type& key) const
3424
    {
N
Niels 已提交
3425
        // const operator[] only works for objects
3426 3427
        if (is_object())
        {
N
Niels 已提交
3428 3429
            assert(m_value.object != nullptr);
            assert(m_value.object->find(key) != m_value.object->end());
3430 3431 3432
            return m_value.object->find(key)->second;
        }
        else
3433
        {
N
Niels 已提交
3434
            throw std::domain_error("cannot use operator[] with " + type_name());
3435 3436 3437
        }
    }

N
Niels 已提交
3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450
    /*!
    @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 已提交
3451
    @throw std::domain_error if JSON is not an object or null; example:
N
Niels 已提交
3452
    `"cannot use operator[] with string"`
N
Niels 已提交
3453 3454 3455 3456

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3457
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
3458 3459 3460 3461

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

N
Niels 已提交
3463
    @since version 1.0.0
N
Niels 已提交
3464
    */
N
Niels 已提交
3465
    template<typename T, std::size_t n>
N
Niels 已提交
3466
    reference operator[](T * (&key)[n])
3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491
    {
        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 已提交
3492
    the `[]` operator.,operatorarray__key_type_const}
3493 3494 3495 3496 3497 3498 3499 3500

    @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 已提交
3501
    const_reference operator[](T * (&key)[n]) const
3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519
    {
        return operator[](static_cast<const T>(key));
    }

    /*!
    @brief 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 已提交
3520
    `"cannot use operator[] with string"`
3521 3522 3523 3524

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3525
    written using the `[]` operator.,operatorarray__key_type}
3526 3527 3528 3529 3530

    @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 已提交
3531
    @since version 1.1.0
3532 3533 3534
    */
    template<typename T>
    reference operator[](T* key)
N
Niels 已提交
3535
    {
N
Niels 已提交
3536
        // implicitly convert null to object
N
cleanup  
Niels 已提交
3537
        if (is_null())
N
Niels 已提交
3538 3539
        {
            m_type = value_t::object;
N
Niels 已提交
3540
            m_value = value_t::object;
N
Niels 已提交
3541 3542
        }

N
Niels 已提交
3543
        // at only works for objects
3544 3545
        if (is_object())
        {
N
Niels 已提交
3546
            assert(m_value.object != nullptr);
3547 3548 3549
            return m_value.object->operator[](key);
        }
        else
N
Niels 已提交
3550
        {
N
Niels 已提交
3551
            throw std::domain_error("cannot use operator[] with " + type_name());
N
Niels 已提交
3552 3553 3554
        }
    }

N
Niels 已提交
3555
    /*!
3556
    @brief read-only access specified object element
N
Niels 已提交
3557

3558 3559 3560 3561 3562
    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 已提交
3563 3564 3565

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

3566
    @return const reference to the element at key @a key
N
Niels 已提交
3567

N
Niels 已提交
3568 3569
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    operator[] with null"`
N
Niels 已提交
3570 3571 3572 3573

    @complexity Logarithmic in the size of the container.

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

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

N
Niels 已提交
3580
    @since version 1.1.0
N
Niels 已提交
3581
    */
3582 3583
    template<typename T>
    const_reference operator[](T* key) const
3584 3585
    {
        // at only works for objects
3586 3587
        if (is_object())
        {
N
Niels 已提交
3588 3589
            assert(m_value.object != nullptr);
            assert(m_value.object->find(key) != m_value.object->end());
3590 3591 3592
            return m_value.object->find(key)->second;
        }
        else
3593
        {
N
Niels 已提交
3594
            throw std::domain_error("cannot use operator[] with " + type_name());
3595
        }
3596 3597
    }

N
Niels 已提交
3598 3599 3600
    /*!
    @brief access specified element via JSON Pointer

N
Niels 已提交
3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622
    Uses a JSON pointer to retrieve a reference to the respective JSON value.
    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.

    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 JSON value pointed to by @a ptr

    @complexity Linear in the length of the JSON pointer.

N
Niels 已提交
3623 3624 3625
    @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 已提交
3626

N
Niels 已提交
3627
    @liveexample{The behavior is shown in the example.,operatorjson_pointer}
N
Niels 已提交
3628 3629 3630 3631 3632

    @since version 2.0.0
    */
    reference operator[](const json_pointer& ptr)
    {
N
Niels 已提交
3633
        return ptr.get_unchecked(this);
N
Niels 已提交
3634 3635 3636
    }

    /*!
N
Niels 已提交
3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649
    @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  a JSON pointer

    @return reference to the JSON value pointed to by @a ptr

    @complexity Linear in the length of the JSON pointer.

N
Niels 已提交
3650 3651 3652
    @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 已提交
3653 3654 3655 3656 3657

    @liveexample{The behavior is shown in the example.,
    operatorjson_pointer_const}

    @since version 2.0.0
N
Niels 已提交
3658 3659 3660
    */
    const_reference operator[](const json_pointer& ptr) const
    {
N
Niels 已提交
3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683
        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.

    @param ptr  JSON pointer to the desired element

    @since version 2.0.0
    */
    reference at(const json_pointer& ptr)
    {
        return ptr.get_checked(this);
    }

    /*!
    @copydoc basic_json::at(const json_pointer&)
    */
    const_reference at(const json_pointer& ptr) const
    {
        return ptr.get_checked(this);
N
Niels 已提交
3684 3685
    }

N
Niels 已提交
3686 3687 3688 3689 3690
    /*!
    @brief access specified object element with default value

    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.
3691

N
Niels 已提交
3692
    The function is basically equivalent to executing
3693
    @code {.cpp}
N
Niels 已提交
3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718
    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 已提交
3719 3720
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    value() with null"`
N
Niels 已提交
3721 3722 3723 3724 3725 3726 3727 3728 3729 3730

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

N
Niels 已提交
3732
    @since version 1.0.0
N
Niels 已提交
3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760
    */
    template <class ValueType, typename
              std::enable_if<
                  std::is_convertible<basic_json_t, ValueType>::value
                  , int>::type = 0>
    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 已提交
3761
    @brief overload for a default value of type const char*
N
Niels 已提交
3762 3763 3764 3765 3766
    @copydoc basic_json::value()
    */
    string_t value(const typename object_t::key_type& key, const char* default_value) const
    {
        return value(key, string_t(default_value));
3767 3768
    }

N
Niels 已提交
3769 3770 3771 3772 3773 3774
    /*!
    @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 已提交
3775
    @return In case of a structured type (array or object), a reference to the
N
Niels 已提交
3776 3777 3778 3779 3780
    first element is returned. In cast of number, string, or boolean values, a
    reference to the value is returned.

    @complexity Constant.

N
Niels 已提交
3781 3782 3783 3784 3785
    @pre The JSON value must not be `null` (would throw `std::out_of_range`) or
    an empty array or object (undefined behavior, guarded by assertions).
    @post The JSON value remains unchanged.

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

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

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

N
Niels 已提交
3791
    @since version 1.0.0
N
Niels 已提交
3792
    */
N
Niels 已提交
3793
    reference front()
N
Niels 已提交
3794 3795 3796 3797
    {
        return *begin();
    }

N
Niels 已提交
3798 3799 3800
    /*!
    @copydoc basic_json::front()
    */
N
Niels 已提交
3801
    const_reference front() const
N
Niels 已提交
3802 3803 3804 3805
    {
        return *cbegin();
    }

N
Niels 已提交
3806 3807 3808 3809
    /*!
    @brief access the last element

    Returns a reference to the last element in the container. For a JSON
N
Niels 已提交
3810 3811 3812 3813 3814 3815
    container `c`, the expression `c.back()` is equivalent to
    @code {.cpp}
    auto tmp = c.end();
    --tmp;
    return *tmp;
    @endcode
N
Niels 已提交
3816

N
Niels 已提交
3817
    @return In case of a structured type (array or object), a reference to the
N
Niels 已提交
3818 3819 3820 3821 3822
    last element is returned. In cast of number, string, or boolean values, a
    reference to the value is returned.

    @complexity Constant.

N
Niels 已提交
3823 3824 3825
    @pre The JSON value must not be `null` (would throw `std::out_of_range`) or
    an empty array or object (undefined behavior, guarded by assertions).
    @post The JSON value remains unchanged.
N
Niels 已提交
3826

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

N
Niels 已提交
3829 3830 3831
    @liveexample{The following code shows an example for `back()`.,back}

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

N
Niels 已提交
3833
    @since version 1.0.0
N
Niels 已提交
3834
    */
N
Niels 已提交
3835
    reference back()
N
Niels 已提交
3836 3837 3838 3839 3840 3841
    {
        auto tmp = end();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
3842 3843 3844
    /*!
    @copydoc basic_json::back()
    */
N
Niels 已提交
3845
    const_reference back() const
N
Niels 已提交
3846 3847 3848 3849 3850 3851
    {
        auto tmp = cend();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
3852 3853 3854
    /*!
    @brief remove element given an iterator

N
Niels 已提交
3855 3856 3857
    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 已提交
3858

N
Niels 已提交
3859
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
3860 3861 3862 3863
    will be `null`.

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

    @tparam InteratorType an @ref iterator or @ref const_iterator

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

N
Niels 已提交
3871 3872
    @throw std::domain_error if called on a `null` value; example: `"cannot use
    erase() with null"`
N
Niels 已提交
3873
    @throw std::domain_error if called on an iterator which does not belong to
N
Niels 已提交
3874
    the current JSON value; example: `"iterator does not fit current value"`
N
Niels 已提交
3875
    @throw std::out_of_range if called on a primitive type with invalid
N
Niels 已提交
3876 3877
    iterator (i.e., any iterator which is not `begin()`); example: `"iterator
    out of range"`
N
Niels 已提交
3878 3879 3880 3881 3882 3883 3884

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

    @sa @ref erase(InteratorType, InteratorType) -- removes the elements in the
    given range
N
Niels 已提交
3890
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
3891 3892 3893 3894
    from an object at the given key
    @sa @ref erase(const size_type) -- removes the element from an array at the
    given index

N
Niels 已提交
3895
    @since version 1.0.0
N
Niels 已提交
3896 3897
    */
    template <class InteratorType, typename
3898
              std::enable_if<
N
Niels 已提交
3899 3900
                  std::is_same<InteratorType, typename basic_json_t::iterator>::value or
                  std::is_same<InteratorType, typename basic_json_t::const_iterator>::value
3901 3902
                  , int>::type
              = 0>
N
Niels 已提交
3903
    InteratorType erase(InteratorType pos)
3904 3905
    {
        // make sure iterator fits the current value
N
Niels 已提交
3906
        if (this != pos.m_object)
3907
        {
N
Niels 已提交
3908
            throw std::domain_error("iterator does not fit current value");
3909 3910
        }

N
Niels 已提交
3911
        InteratorType result = end();
3912 3913 3914 3915

        switch (m_type)
        {
            case value_t::boolean:
3916 3917
            case value_t::number_float:
            case value_t::number_integer:
3918
            case value_t::number_unsigned:
3919 3920
            case value_t::string:
            {
3921
                if (not pos.m_it.primitive_iterator.is_begin())
3922 3923 3924 3925
                {
                    throw std::out_of_range("iterator out of range");
                }

N
cleanup  
Niels 已提交
3926
                if (is_string())
3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937
                {
                    delete m_value.string;
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
                break;
            }

            case value_t::object:
            {
N
Niels 已提交
3938
                assert(m_value.object != nullptr);
3939 3940 3941 3942 3943 3944
                result.m_it.object_iterator = m_value.object->erase(pos.m_it.object_iterator);
                break;
            }

            case value_t::array:
            {
N
Niels 已提交
3945
                assert(m_value.array != nullptr);
3946 3947 3948 3949 3950 3951
                result.m_it.array_iterator = m_value.array->erase(pos.m_it.array_iterator);
                break;
            }

            default:
            {
N
Niels 已提交
3952
                throw std::domain_error("cannot use erase() with " + type_name());
3953 3954 3955 3956 3957 3958
            }
        }

        return result;
    }

N
Niels 已提交
3959 3960 3961
    /*!
    @brief remove elements given an iterator range

N
Niels 已提交
3962 3963 3964
    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 已提交
3965

N
Niels 已提交
3966
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
3967 3968 3969 3970 3971
    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 已提交
3972
    second refers to the last element, the `end()` iterator is returned.
N
Niels 已提交
3973 3974 3975

    @tparam InteratorType an @ref iterator or @ref const_iterator

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

N
Niels 已提交
3979 3980
    @throw std::domain_error if called on a `null` value; example: `"cannot use
    erase() with null"`
N
Niels 已提交
3981
    @throw std::domain_error if called on iterators which does not belong to
N
Niels 已提交
3982
    the current JSON value; example: `"iterators do not fit current value"`
N
Niels 已提交
3983
    @throw std::out_of_range if called on a primitive type with invalid
N
Niels 已提交
3984 3985
    iterators (i.e., if `first != begin()` and `last != end()`); example:
    `"iterators out of range"`
N
Niels 已提交
3986 3987 3988 3989 3990 3991 3992 3993

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

    @sa @ref erase(InteratorType) -- removes the element at a given position
N
Niels 已提交
3998
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
3999 4000 4001 4002
    from an object at the given key
    @sa @ref erase(const size_type) -- removes the element from an array at the
    given index

N
Niels 已提交
4003
    @since version 1.0.0
N
Niels 已提交
4004 4005
    */
    template <class InteratorType, typename
4006
              std::enable_if<
N
Niels 已提交
4007 4008
                  std::is_same<InteratorType, typename basic_json_t::iterator>::value or
                  std::is_same<InteratorType, typename basic_json_t::const_iterator>::value
4009 4010
                  , int>::type
              = 0>
N
Niels 已提交
4011
    InteratorType erase(InteratorType first, InteratorType last)
4012 4013
    {
        // make sure iterator fits the current value
N
Niels 已提交
4014
        if (this != first.m_object or this != last.m_object)
4015
        {
N
Niels 已提交
4016
            throw std::domain_error("iterators do not fit current value");
4017 4018
        }

N
Niels 已提交
4019
        InteratorType result = end();
4020 4021 4022 4023

        switch (m_type)
        {
            case value_t::boolean:
4024 4025
            case value_t::number_float:
            case value_t::number_integer:
4026
            case value_t::number_unsigned:
4027 4028
            case value_t::string:
            {
4029
                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
4030 4031 4032 4033
                {
                    throw std::out_of_range("iterators out of range");
                }

N
cleanup  
Niels 已提交
4034
                if (is_string())
4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045
                {
                    delete m_value.string;
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
                break;
            }

            case value_t::object:
            {
N
Niels 已提交
4046
                assert(m_value.object != nullptr);
4047 4048 4049 4050 4051 4052 4053
                result.m_it.object_iterator = m_value.object->erase(first.m_it.object_iterator,
                                              last.m_it.object_iterator);
                break;
            }

            case value_t::array:
            {
N
Niels 已提交
4054
                assert(m_value.array != nullptr);
4055 4056 4057 4058 4059 4060 4061
                result.m_it.array_iterator = m_value.array->erase(first.m_it.array_iterator,
                                             last.m_it.array_iterator);
                break;
            }

            default:
            {
N
Niels 已提交
4062
                throw std::domain_error("cannot use erase() with " + type_name());
4063 4064 4065 4066 4067 4068
            }
        }

        return result;
    }

N
Niels 已提交
4069 4070 4071 4072 4073 4074 4075
    /*!
    @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 已提交
4076 4077 4078 4079 4080 4081
    @return Number of elements removed. If @a 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).

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

N
Niels 已提交
4083 4084
    @throw std::domain_error when called on a type other than JSON object;
    example: `"cannot use erase() with null"`
N
Niels 已提交
4085 4086 4087

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

N
Niels 已提交
4088
    @liveexample{The example shows the effect of `erase()`.,erase__key_type}
N
Niels 已提交
4089 4090 4091 4092 4093 4094 4095

    @sa @ref erase(InteratorType) -- removes the element at a given position
    @sa @ref erase(InteratorType, InteratorType) -- removes the elements in the
    given range
    @sa @ref erase(const size_type) -- removes the element from an array at the
    given index

N
Niels 已提交
4096
    @since version 1.0.0
N
Niels 已提交
4097
    */
N
Niels 已提交
4098
    size_type erase(const typename object_t::key_type& key)
4099
    {
N
Niels 已提交
4100
        // this erase only works for objects
4101 4102
        if (is_object())
        {
N
Niels 已提交
4103
            assert(m_value.object != nullptr);
4104 4105 4106
            return m_value.object->erase(key);
        }
        else
4107
        {
N
Niels 已提交
4108
            throw std::domain_error("cannot use erase() with " + type_name());
4109 4110 4111
        }
    }

N
Niels 已提交
4112 4113 4114 4115 4116 4117 4118
    /*!
    @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 已提交
4119 4120 4121 4122
    @throw std::domain_error when called on a type other than JSON array;
    example: `"cannot use erase() with null"`
    @throw std::out_of_range when `idx >= size()`; example: `"index out of
    range"`
N
Niels 已提交
4123 4124 4125

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

N
Niels 已提交
4126
    @liveexample{The example shows the effect of `erase()`.,erase__size_type}
N
Niels 已提交
4127 4128 4129 4130

    @sa @ref erase(InteratorType) -- removes the element at a given position
    @sa @ref erase(InteratorType, InteratorType) -- removes the elements in the
    given range
N
Niels 已提交
4131
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4132 4133
    from an object at the given key

N
Niels 已提交
4134
    @since version 1.0.0
N
Niels 已提交
4135
    */
N
Niels 已提交
4136
    void erase(const size_type idx)
N
Niels 已提交
4137 4138
    {
        // this erase only works for arrays
N
cleanup  
Niels 已提交
4139
        if (is_array())
N
Niels 已提交
4140
        {
N
cleanup  
Niels 已提交
4141 4142 4143 4144
            if (idx >= size())
            {
                throw std::out_of_range("index out of range");
            }
N
Niels 已提交
4145

N
Niels 已提交
4146
            assert(m_value.array != nullptr);
N
cleanup  
Niels 已提交
4147 4148 4149
            m_value.array->erase(m_value.array->begin() + static_cast<difference_type>(idx));
        }
        else
N
Niels 已提交
4150
        {
N
cleanup  
Niels 已提交
4151
            throw std::domain_error("cannot use erase() with " + type_name());
N
Niels 已提交
4152 4153 4154
        }
    }

N
Niels 已提交
4155 4156 4157 4158 4159 4160 4161 4162 4163 4164
    /// @}


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

    /// @name lookup
    /// @{

N
Niels 已提交
4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177
    /*!
    @brief find an element in a JSON object

    Finds an element in a JSON object with key equivalent to @a key. If the
    element is not found or the JSON value is not an object, end() is returned.

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

N
Niels 已提交
4180
    @since version 1.0.0
N
Niels 已提交
4181
    */
N
Niels 已提交
4182
    iterator find(typename object_t::key_type key)
N
Niels 已提交
4183 4184 4185
    {
        auto result = end();

N
cleanup  
Niels 已提交
4186
        if (is_object())
N
Niels 已提交
4187
        {
N
Niels 已提交
4188
            assert(m_value.object != nullptr);
N
Niels 已提交
4189 4190 4191 4192 4193 4194
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4195 4196 4197 4198
    /*!
    @brief find an element in a JSON object
    @copydoc find(typename object_t::key_type)
    */
N
Niels 已提交
4199
    const_iterator find(typename object_t::key_type key) const
N
Niels 已提交
4200 4201 4202
    {
        auto result = cend();

N
cleanup  
Niels 已提交
4203
        if (is_object())
N
Niels 已提交
4204
        {
N
Niels 已提交
4205
            assert(m_value.object != nullptr);
N
Niels 已提交
4206 4207 4208 4209 4210 4211
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225
    /*!
    @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 已提交
4226
    @liveexample{The example shows how `count()` is used.,count}
N
Niels 已提交
4227

N
Niels 已提交
4228
    @since version 1.0.0
N
Niels 已提交
4229
    */
N
Niels 已提交
4230
    size_type count(typename object_t::key_type key) const
4231 4232
    {
        // return 0 for all nonobject types
N
Niels 已提交
4233
        assert(not is_object() or m_value.object != nullptr);
N
Niels 已提交
4234
        return is_object() ? m_value.object->count(key) : 0;
4235 4236
    }

N
Niels 已提交
4237 4238
    /// @}

N
Niels 已提交
4239

N
Niels 已提交
4240 4241 4242 4243
    ///////////////
    // iterators //
    ///////////////

N
Niels 已提交
4244 4245 4246
    /// @name iterators
    /// @{

N
Niels 已提交
4247 4248
    /*!
    @brief returns an iterator to the first element
N
Niels 已提交
4249 4250 4251 4252 4253 4254 4255 4256 4257

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

N
Niels 已提交
4263 4264 4265 4266 4267
    @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 已提交
4268

N
Niels 已提交
4269
    @since version 1.0.0
N
Niels 已提交
4270
    */
N
Niels 已提交
4271
    iterator begin() noexcept
N
Niels 已提交
4272 4273 4274 4275 4276 4277
    {
        iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4278
    /*!
N
Niels 已提交
4279
    @copydoc basic_json::cbegin()
N
Niels 已提交
4280
    */
N
Niels 已提交
4281
    const_iterator begin() const noexcept
N
Niels 已提交
4282
    {
N
Niels 已提交
4283
        return cbegin();
N
Niels 已提交
4284 4285
    }

N
Niels 已提交
4286 4287
    /*!
    @brief returns a const iterator to the first element
N
Niels 已提交
4288 4289 4290 4291 4292 4293 4294 4295 4296

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

N
Niels 已提交
4303 4304 4305 4306 4307
    @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 已提交
4308

N
Niels 已提交
4309
    @since version 1.0.0
N
Niels 已提交
4310
    */
N
Niels 已提交
4311
    const_iterator cbegin() const noexcept
N
Niels 已提交
4312 4313 4314 4315 4316 4317
    {
        const_iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4318 4319
    /*!
    @brief returns an iterator to one past the last element
N
Niels 已提交
4320 4321 4322 4323 4324 4325 4326 4327 4328

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

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

N
Niels 已提交
4340
    @since version 1.0.0
N
Niels 已提交
4341
    */
N
Niels 已提交
4342
    iterator end() noexcept
N
Niels 已提交
4343 4344 4345 4346 4347 4348
    {
        iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
4349
    /*!
N
Niels 已提交
4350
    @copydoc basic_json::cend()
N
Niels 已提交
4351
    */
N
Niels 已提交
4352
    const_iterator end() const noexcept
N
Niels 已提交
4353
    {
N
Niels 已提交
4354
        return cend();
N
Niels 已提交
4355 4356
    }

N
Niels 已提交
4357 4358
    /*!
    @brief returns a const iterator to one past the last element
N
Niels 已提交
4359 4360 4361 4362 4363 4364 4365 4366 4367

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

N
Niels 已提交
4374 4375 4376 4377 4378
    @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 已提交
4379

N
Niels 已提交
4380
    @since version 1.0.0
N
Niels 已提交
4381
    */
N
Niels 已提交
4382
    const_iterator cend() const noexcept
N
Niels 已提交
4383 4384 4385 4386 4387 4388
    {
        const_iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
4389
    /*!
N
Niels 已提交
4390 4391 4392 4393 4394 4395 4396 4397
    @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 已提交
4398 4399 4400
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4401 4402 4403
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(end())`.

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

N
Niels 已提交
4410
    @since version 1.0.0
N
Niels 已提交
4411
    */
N
Niels 已提交
4412
    reverse_iterator rbegin() noexcept
N
Niels 已提交
4413 4414 4415 4416
    {
        return reverse_iterator(end());
    }

N
Niels 已提交
4417
    /*!
N
Niels 已提交
4418
    @copydoc basic_json::crbegin()
N
Niels 已提交
4419
    */
N
Niels 已提交
4420
    const_reverse_iterator rbegin() const noexcept
N
Niels 已提交
4421
    {
N
Niels 已提交
4422
        return crbegin();
N
Niels 已提交
4423 4424
    }

N
Niels 已提交
4425
    /*!
N
Niels 已提交
4426 4427 4428 4429 4430 4431 4432 4433 4434
    @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 已提交
4435 4436 4437
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4438 4439 4440
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(begin())`.

N
Niels 已提交
4441 4442 4443 4444 4445
    @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 已提交
4446

N
Niels 已提交
4447
    @since version 1.0.0
N
Niels 已提交
4448
    */
N
Niels 已提交
4449
    reverse_iterator rend() noexcept
N
Niels 已提交
4450 4451 4452 4453
    {
        return reverse_iterator(begin());
    }

N
Niels 已提交
4454
    /*!
N
Niels 已提交
4455
    @copydoc basic_json::crend()
N
Niels 已提交
4456
    */
N
Niels 已提交
4457
    const_reverse_iterator rend() const noexcept
N
Niels 已提交
4458
    {
N
Niels 已提交
4459
        return crend();
N
Niels 已提交
4460 4461
    }

N
Niels 已提交
4462
    /*!
N
Niels 已提交
4463 4464 4465 4466 4467 4468 4469 4470 4471
    @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 已提交
4472 4473 4474
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4475 4476 4477
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).rbegin()`.

N
Niels 已提交
4478 4479 4480 4481 4482
    @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 已提交
4483

N
Niels 已提交
4484
    @since version 1.0.0
N
Niels 已提交
4485
    */
N
Niels 已提交
4486
    const_reverse_iterator crbegin() const noexcept
N
Niels 已提交
4487 4488 4489 4490
    {
        return const_reverse_iterator(cend());
    }

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

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

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

N
cleanup  
Niels 已提交
4520 4521 4522 4523 4524 4525 4526 4527
  private:
    // forward declaration
    template<typename IteratorType> class iteration_proxy;

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

N
Niels 已提交
4528
    This function allows to access @ref iterator::key() and @ref
N
cleanup  
Niels 已提交
4529 4530 4531
    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 已提交
4532 4533 4534

    @note The name of this function is not yet final and may change in the
    future.
N
cleanup  
Niels 已提交
4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548
    */
    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 已提交
4549 4550
    /// @}

N
Niels 已提交
4551 4552 4553 4554 4555

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

N
Niels 已提交
4556 4557 4558
    /// @name capacity
    /// @{

N
Niels 已提交
4559 4560
    /*!
    @brief checks whether the container is empty
N
Niels 已提交
4561 4562 4563

    Checks if a JSON value has no elements.

N
Niels 已提交
4564
    @return The return value depends on the different types and is
N
Niels 已提交
4565 4566 4567
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
4568 4569 4570 4571 4572 4573
            null        | `true`
            boolean     | `false`
            string      | `false`
            number      | `false`
            object      | result of function `object_t::empty()`
            array       | result of function `array_t::empty()`
N
Niels 已提交
4574 4575

    @complexity Constant, as long as @ref array_t and @ref object_t satisfy the
N
Niels 已提交
4576
    Container concept; that is, their `empty()` functions have constant
N
Niels 已提交
4577
    complexity.
N
Niels 已提交
4578

N
Niels 已提交
4579 4580 4581
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
4582 4583 4584
    - The complexity is constant.
    - Has the semantics of `begin() == end()`.

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

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

N
Niels 已提交
4590
    @since version 1.0.0
N
Niels 已提交
4591
    */
N
Niels 已提交
4592
    bool empty() const noexcept
N
Niels 已提交
4593 4594 4595
    {
        switch (m_type)
        {
4596
            case value_t::null:
N
Niels 已提交
4597
            {
N
Niels 已提交
4598
                // null values are empty
N
Niels 已提交
4599 4600
                return true;
            }
N
Niels 已提交
4601

4602
            case value_t::array:
N
Niels 已提交
4603
            {
N
Niels 已提交
4604
                assert(m_value.array != nullptr);
N
Niels 已提交
4605 4606
                return m_value.array->empty();
            }
N
Niels 已提交
4607

4608
            case value_t::object:
N
Niels 已提交
4609
            {
N
Niels 已提交
4610
                assert(m_value.object != nullptr);
N
Niels 已提交
4611 4612
                return m_value.object->empty();
            }
N
Niels 已提交
4613

N
Niels 已提交
4614 4615 4616 4617 4618 4619
            default:
            {
                // all other types are nonempty
                return false;
            }
        }
N
Niels 已提交
4620 4621
    }

N
Niels 已提交
4622 4623
    /*!
    @brief returns the number of elements
N
Niels 已提交
4624 4625 4626

    Returns the number of elements in a JSON value.

N
Niels 已提交
4627
    @return The return value depends on the different types and is
N
Niels 已提交
4628 4629 4630
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
4631 4632 4633 4634
            null        | `0`
            boolean     | `1`
            string      | `1`
            number      | `1`
N
Niels 已提交
4635 4636 4637 4638
            object      | result of function object_t::size()
            array       | result of function array_t::size()

    @complexity Constant, as long as @ref array_t and @ref object_t satisfy the
N
Niels 已提交
4639
    Container concept; that is, their size() functions have constant complexity.
N
Niels 已提交
4640

N
Niels 已提交
4641 4642 4643
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
4644 4645 4646
    - The complexity is constant.
    - Has the semantics of `std::distance(begin(), end())`.

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

N
Niels 已提交
4650 4651 4652
    @sa @ref empty() -- checks whether the container is empty
    @sa @ref max_size() -- returns the maximal number of elements

N
Niels 已提交
4653
    @since version 1.0.0
N
Niels 已提交
4654
    */
N
Niels 已提交
4655
    size_type size() const noexcept
N
Niels 已提交
4656 4657 4658
    {
        switch (m_type)
        {
4659
            case value_t::null:
N
Niels 已提交
4660
            {
N
Niels 已提交
4661
                // null values are empty
N
Niels 已提交
4662 4663
                return 0;
            }
N
Niels 已提交
4664

4665
            case value_t::array:
N
Niels 已提交
4666
            {
N
Niels 已提交
4667
                assert(m_value.array != nullptr);
N
Niels 已提交
4668 4669
                return m_value.array->size();
            }
N
Niels 已提交
4670

4671
            case value_t::object:
N
Niels 已提交
4672
            {
N
Niels 已提交
4673
                assert(m_value.object != nullptr);
N
Niels 已提交
4674 4675
                return m_value.object->size();
            }
N
Niels 已提交
4676

N
Niels 已提交
4677 4678 4679 4680 4681 4682
            default:
            {
                // all other types have size 1
                return 1;
            }
        }
N
Niels 已提交
4683 4684
    }

N
Niels 已提交
4685 4686
    /*!
    @brief returns the maximum possible number of elements
N
Niels 已提交
4687 4688 4689 4690 4691

    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 已提交
4692
    @return The return value depends on the different types and is
N
Niels 已提交
4693 4694 4695
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
4696 4697 4698 4699 4700 4701
            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 已提交
4702 4703

    @complexity Constant, as long as @ref array_t and @ref object_t satisfy the
N
Niels 已提交
4704
    Container concept; that is, their `max_size()` functions have constant
N
Niels 已提交
4705
    complexity.
N
Niels 已提交
4706

N
Niels 已提交
4707 4708 4709
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
4710 4711 4712 4713
    - The complexity is constant.
    - Has the semantics of returning `b.size()` where `b` is the largest
      possible JSON value.

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

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

N
Niels 已提交
4719
    @since version 1.0.0
N
Niels 已提交
4720
    */
N
Niels 已提交
4721
    size_type max_size() const noexcept
N
Niels 已提交
4722 4723 4724
    {
        switch (m_type)
        {
4725
            case value_t::array:
N
Niels 已提交
4726
            {
N
Niels 已提交
4727
                assert(m_value.array != nullptr);
N
Niels 已提交
4728 4729
                return m_value.array->max_size();
            }
N
Niels 已提交
4730

4731
            case value_t::object:
N
Niels 已提交
4732
            {
N
Niels 已提交
4733
                assert(m_value.object != nullptr);
N
Niels 已提交
4734 4735
                return m_value.object->max_size();
            }
N
Niels 已提交
4736

N
Niels 已提交
4737 4738
            default:
            {
4739 4740
                // all other types have max_size() == size()
                return size();
N
Niels 已提交
4741 4742
            }
        }
N
Niels 已提交
4743 4744
    }

N
Niels 已提交
4745 4746
    /// @}

N
Niels 已提交
4747 4748 4749 4750 4751

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

N
Niels 已提交
4752 4753 4754
    /// @name modifiers
    /// @{

N
Niels 已提交
4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774
    /*!
    @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 已提交
4775
    @liveexample{The example below shows the effect of `clear()` to different
N
Niels 已提交
4776
    JSON types.,clear}
N
Niels 已提交
4777

N
Niels 已提交
4778
    @since version 1.0.0
N
Niels 已提交
4779
    */
N
Niels 已提交
4780
    void clear() noexcept
N
Niels 已提交
4781 4782 4783
    {
        switch (m_type)
        {
4784
            case value_t::number_integer:
N
Niels 已提交
4785
            {
N
Niels 已提交
4786
                m_value.number_integer = 0;
N
Niels 已提交
4787 4788
                break;
            }
N
Niels 已提交
4789

4790 4791 4792 4793 4794 4795
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = 0;
                break;
            }

4796
            case value_t::number_float:
N
Niels 已提交
4797
            {
N
Niels 已提交
4798
                m_value.number_float = 0.0;
N
Niels 已提交
4799 4800
                break;
            }
N
Niels 已提交
4801

4802
            case value_t::boolean:
N
Niels 已提交
4803
            {
N
Niels 已提交
4804
                m_value.boolean = false;
N
Niels 已提交
4805 4806
                break;
            }
N
Niels 已提交
4807

4808
            case value_t::string:
N
Niels 已提交
4809
            {
N
Niels 已提交
4810
                assert(m_value.string != nullptr);
N
Niels 已提交
4811 4812 4813
                m_value.string->clear();
                break;
            }
N
Niels 已提交
4814

4815
            case value_t::array:
N
Niels 已提交
4816
            {
N
Niels 已提交
4817
                assert(m_value.array != nullptr);
N
Niels 已提交
4818 4819 4820
                m_value.array->clear();
                break;
            }
N
Niels 已提交
4821

4822
            case value_t::object:
N
Niels 已提交
4823
            {
N
Niels 已提交
4824
                assert(m_value.object != nullptr);
N
Niels 已提交
4825 4826 4827
                m_value.object->clear();
                break;
            }
4828 4829 4830 4831 4832

            default:
            {
                break;
            }
N
Niels 已提交
4833 4834 4835
        }
    }

4836 4837 4838
    /*!
    @brief add an object to an array

4839
    Appends the given element @a val to the end of the JSON value. If the
4840
    function is called on a JSON null value, an empty array is created before
4841
    appending @a val.
4842

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

N
Niels 已提交
4845 4846
    @throw std::domain_error when called on a type other than JSON array or
    null; example: `"cannot use push_back() with number"`
4847 4848 4849

    @complexity Amortized constant.

N
Niels 已提交
4850 4851 4852
    @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 已提交
4853

N
Niels 已提交
4854
    @since version 1.0.0
4855
    */
4856
    void push_back(basic_json&& val)
N
Niels 已提交
4857 4858
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
4859
        if (not(is_null() or is_array()))
N
Niels 已提交
4860
        {
N
Niels 已提交
4861
            throw std::domain_error("cannot use push_back() with " + type_name());
N
Niels 已提交
4862 4863 4864
        }

        // transform null object into an array
N
cleanup  
Niels 已提交
4865
        if (is_null())
N
Niels 已提交
4866 4867
        {
            m_type = value_t::array;
N
Niels 已提交
4868
            m_value = value_t::array;
N
Niels 已提交
4869 4870 4871
        }

        // add element to array (move semantics)
N
Niels 已提交
4872
        assert(m_value.array != nullptr);
4873
        m_value.array->push_back(std::move(val));
N
Niels 已提交
4874
        // invalidate object
4875
        val.m_type = value_t::null;
N
Niels 已提交
4876 4877
    }

4878 4879 4880 4881
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
4882
    reference operator+=(basic_json&& val)
N
Niels 已提交
4883
    {
4884
        push_back(std::move(val));
N
Niels 已提交
4885 4886 4887
        return *this;
    }

4888 4889 4890 4891
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
4892
    void push_back(const basic_json& val)
N
Niels 已提交
4893 4894
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
4895
        if (not(is_null() or is_array()))
N
Niels 已提交
4896
        {
N
Niels 已提交
4897
            throw std::domain_error("cannot use push_back() with " + type_name());
N
Niels 已提交
4898 4899 4900
        }

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

        // add element to array
N
Niels 已提交
4908
        assert(m_value.array != nullptr);
4909
        m_value.array->push_back(val);
N
Niels 已提交
4910 4911
    }

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

4922 4923 4924
    /*!
    @brief add an object to an object

4925
    Inserts the given element @a val to the JSON object. If the function is
4926
    called on a JSON null value, an empty object is created before inserting @a
4927
    val.
4928

4929
    @param[in] val the value to add to the JSON object
4930 4931

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

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

N
Niels 已提交
4936 4937 4938
    @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 已提交
4939

N
Niels 已提交
4940
    @since version 1.0.0
4941
    */
4942
    void push_back(const typename object_t::value_type& val)
N
Niels 已提交
4943 4944
    {
        // push_back only works for null objects or objects
N
cleanup  
Niels 已提交
4945
        if (not(is_null() or is_object()))
N
Niels 已提交
4946
        {
N
Niels 已提交
4947
            throw std::domain_error("cannot use push_back() with " + type_name());
N
Niels 已提交
4948 4949 4950
        }

        // transform null object into an object
N
cleanup  
Niels 已提交
4951
        if (is_null())
N
Niels 已提交
4952 4953
        {
            m_type = value_t::object;
N
Niels 已提交
4954
            m_value = value_t::object;
N
Niels 已提交
4955 4956 4957
        }

        // add element to array
N
Niels 已提交
4958
        assert(m_value.object != nullptr);
4959
        m_value.object->insert(val);
N
Niels 已提交
4960 4961
    }

4962 4963 4964 4965
    /*!
    @brief add an object to an object
    @copydoc push_back(const typename object_t::value_type&)
    */
4966
    reference operator+=(const typename object_t::value_type& val)
N
Niels 已提交
4967
    {
4968 4969
        push_back(val);
        return operator[](val.first);
N
Niels 已提交
4970 4971
    }

N
Niels 已提交
4972 4973 4974
    /*!
    @brief inserts element

4975
    Inserts element @a val before iterator @a pos.
N
Niels 已提交
4976 4977 4978

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

N
Niels 已提交
4982 4983
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
N
Niels 已提交
4984 4985
    @throw std::domain_error if @a pos is not an iterator of *this; example:
    `"iterator does not fit current value"`
N
Niels 已提交
4986 4987 4988 4989

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

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

N
Niels 已提交
4992
    @since version 1.0.0
N
Niels 已提交
4993
    */
4994
    iterator insert(const_iterator pos, const basic_json& val)
N
Niels 已提交
4995 4996
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
4997
        if (is_array())
N
Niels 已提交
4998
        {
N
cleanup  
Niels 已提交
4999 5000 5001 5002 5003
            // 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 已提交
5004

N
cleanup  
Niels 已提交
5005 5006
            // insert to array and return iterator
            iterator result(this);
N
Niels 已提交
5007
            assert(m_value.array != nullptr);
5008
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, val);
N
cleanup  
Niels 已提交
5009 5010 5011
            return result;
        }
        else
N
Niels 已提交
5012
        {
N
cleanup  
Niels 已提交
5013
            throw std::domain_error("cannot use insert() with " + type_name());
N
Niels 已提交
5014 5015 5016 5017 5018 5019 5020
        }
    }

    /*!
    @brief inserts element
    @copydoc insert(const_iterator, const basic_json&)
    */
5021
    iterator insert(const_iterator pos, basic_json&& val)
N
Niels 已提交
5022
    {
5023
        return insert(pos, val);
N
Niels 已提交
5024 5025 5026 5027 5028
    }

    /*!
    @brief inserts elements

5029
    Inserts @a cnt copies of @a val before iterator @a pos.
N
Niels 已提交
5030 5031 5032

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

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

5043
    @complexity Linear in @a cnt plus linear in the distance between @a pos
N
Niels 已提交
5044 5045
    and end of the container.

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

N
Niels 已提交
5048
    @since version 1.0.0
N
Niels 已提交
5049
    */
5050
    iterator insert(const_iterator pos, size_type cnt, const basic_json& val)
N
Niels 已提交
5051 5052
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5053
        if (is_array())
N
Niels 已提交
5054
        {
N
cleanup  
Niels 已提交
5055 5056 5057 5058 5059
            // 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 已提交
5060

N
cleanup  
Niels 已提交
5061 5062
            // insert to array and return iterator
            iterator result(this);
N
Niels 已提交
5063
            assert(m_value.array != nullptr);
5064
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, cnt, val);
N
cleanup  
Niels 已提交
5065 5066 5067
            return result;
        }
        else
N
Niels 已提交
5068
        {
N
cleanup  
Niels 已提交
5069
            throw std::domain_error("cannot use insert() with " + type_name());
N
Niels 已提交
5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082
        }
    }

    /*!
    @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 已提交
5083 5084
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
N
Niels 已提交
5085 5086
    @throw std::domain_error if @a pos is not an iterator of *this; example:
    `"iterator does not fit current value"`
N
Niels 已提交
5087
    @throw std::domain_error if @a first and @a last do not belong to the same
N
Niels 已提交
5088
    JSON value; example: `"iterators do not fit"`
N
Niels 已提交
5089
    @throw std::domain_error if @a first or @a last are iterators into
N
Niels 已提交
5090 5091 5092
    container for which insert is called; example: `"passed iterators may not
    belong to container"`

N
Niels 已提交
5093 5094 5095 5096 5097 5098
    @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 已提交
5099
    @liveexample{The example shows how `insert()` is used.,insert__range}
N
Niels 已提交
5100

N
Niels 已提交
5101
    @since version 1.0.0
N
Niels 已提交
5102 5103 5104 5105
    */
    iterator insert(const_iterator pos, const_iterator first, const_iterator last)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5106
        if (not is_array())
N
Niels 已提交
5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118
        {
            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");
        }

        if (first.m_object != last.m_object)
        {
N
Niels 已提交
5119
            throw std::domain_error("iterators do not fit");
N
Niels 已提交
5120 5121 5122 5123 5124 5125 5126 5127 5128
        }

        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 已提交
5129
        assert(m_value.array != nullptr);
N
Niels 已提交
5130 5131 5132 5133
        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 已提交
5134 5135 5136
        return result;
    }

N
Niels 已提交
5137 5138 5139 5140 5141 5142 5143 5144 5145
    /*!
    @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 已提交
5146 5147
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
N
Niels 已提交
5148 5149
    @throw std::domain_error if @a pos is not an iterator of *this; example:
    `"iterator does not fit current value"`
N
Niels 已提交
5150

N
Niels 已提交
5151 5152 5153 5154 5155 5156
    @return iterator pointing to the first element inserted, or @a pos if
    `ilist` is empty

    @complexity Linear in `ilist.size()` plus linear in the distance between @a
    pos and end of the container.

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

N
Niels 已提交
5159
    @since version 1.0.0
N
Niels 已提交
5160 5161 5162 5163
    */
    iterator insert(const_iterator pos, std::initializer_list<basic_json> ilist)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5164
        if (not is_array())
N
Niels 已提交
5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176
        {
            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);
N
Niels 已提交
5177
        assert(m_value.array != nullptr);
N
Niels 已提交
5178 5179 5180 5181
        result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, ilist);
        return result;
    }

N
Niels 已提交
5182 5183
    /*!
    @brief exchanges the values
N
Niels 已提交
5184 5185 5186 5187 5188 5189 5190 5191 5192 5193

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

N
Niels 已提交
5197
    @since version 1.0.0
N
Niels 已提交
5198
    */
N
Niels 已提交
5199
    void swap(reference other) noexcept (
N
Niels 已提交
5200 5201 5202 5203 5204
        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 已提交
5205 5206 5207 5208 5209
    {
        std::swap(m_type, other.m_type);
        std::swap(m_value, other.m_value);
    }

N
Niels 已提交
5210 5211 5212 5213 5214 5215 5216 5217 5218 5219
    /*!
    @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 已提交
5220 5221
    @throw std::domain_error when JSON value is not an array; example: `"cannot
    use swap() with string"`
N
Niels 已提交
5222 5223 5224

    @complexity Constant.

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

N
Niels 已提交
5228
    @since version 1.0.0
N
Niels 已提交
5229
    */
N
Niels 已提交
5230
    void swap(array_t& other)
N
Niels 已提交
5231 5232
    {
        // swap only works for arrays
N
cleanup  
Niels 已提交
5233 5234
        if (is_array())
        {
N
Niels 已提交
5235
            assert(m_value.array != nullptr);
N
cleanup  
Niels 已提交
5236 5237 5238
            std::swap(*(m_value.array), other);
        }
        else
N
Niels 已提交
5239
        {
N
Niels 已提交
5240
            throw std::domain_error("cannot use swap() with " + type_name());
N
Niels 已提交
5241 5242 5243
        }
    }

5244 5245 5246 5247 5248 5249 5250 5251 5252 5253
    /*!
    @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 已提交
5254 5255
    @throw std::domain_error when JSON value is not an object; example:
    `"cannot use swap() with string"`
5256 5257 5258

    @complexity Constant.

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

N
Niels 已提交
5262
    @since version 1.0.0
5263
    */
N
Niels 已提交
5264
    void swap(object_t& other)
N
Niels 已提交
5265 5266
    {
        // swap only works for objects
N
cleanup  
Niels 已提交
5267 5268
        if (is_object())
        {
N
Niels 已提交
5269
            assert(m_value.object != nullptr);
N
cleanup  
Niels 已提交
5270 5271 5272
            std::swap(*(m_value.object), other);
        }
        else
N
Niels 已提交
5273
        {
N
Niels 已提交
5274
            throw std::domain_error("cannot use swap() with " + type_name());
N
Niels 已提交
5275 5276 5277
        }
    }

5278 5279 5280 5281 5282 5283 5284 5285 5286 5287
    /*!
    @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 已提交
5288 5289
    @throw std::domain_error when JSON value is not a string; example: `"cannot
    use swap() with boolean"`
5290 5291 5292

    @complexity Constant.

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

N
Niels 已提交
5296
    @since version 1.0.0
5297
    */
N
Niels 已提交
5298
    void swap(string_t& other)
N
Niels 已提交
5299 5300
    {
        // swap only works for strings
N
cleanup  
Niels 已提交
5301 5302
        if (is_string())
        {
N
Niels 已提交
5303
            assert(m_value.string != nullptr);
N
cleanup  
Niels 已提交
5304 5305 5306
            std::swap(*(m_value.string), other);
        }
        else
N
Niels 已提交
5307
        {
N
Niels 已提交
5308
            throw std::domain_error("cannot use swap() with " + type_name());
N
Niels 已提交
5309 5310 5311
        }
    }

N
Niels 已提交
5312 5313
    /// @}

N
Niels 已提交
5314 5315 5316 5317 5318

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

N
Niels 已提交
5319 5320 5321
    /// @name lexicographical comparison operators
    /// @{

N
Niels 已提交
5322 5323 5324 5325 5326 5327 5328
  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 已提交
5329

N
Niels 已提交
5330
    @since version 1.0.0
N
Niels 已提交
5331
    */
N
Niels 已提交
5332
    friend bool operator<(const value_t lhs, const value_t rhs) noexcept
N
Niels 已提交
5333
    {
5334
        static constexpr std::array<uint8_t, 8> order = {{
N
Niels 已提交
5335 5336 5337 5338 5339 5340
                0, // null
                3, // object
                4, // array
                5, // string
                1, // boolean
                2, // integer
5341 5342
                2, // unsigned
                2, // float
N
Niels 已提交
5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355
            }
        };

        // 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 已提交
5356 5357
    /*!
    @brief comparison: equal
N
Niels 已提交
5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373

    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.

5374 5375
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__equal}
N
Niels 已提交
5376

N
Niels 已提交
5377
    @since version 1.0.0
N
Niels 已提交
5378
    */
N
Niels 已提交
5379
    friend bool operator==(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
5380
    {
F
Florian Weber 已提交
5381 5382
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
5383

F
Florian Weber 已提交
5384
        if (lhs_type == rhs_type)
N
Niels 已提交
5385
        {
F
Florian Weber 已提交
5386
            switch (lhs_type)
N
Niels 已提交
5387
            {
5388
                case value_t::array:
N
Niels 已提交
5389 5390 5391
                {
                    assert(lhs.m_value.array != nullptr);
                    assert(rhs.m_value.array != nullptr);
N
Niels 已提交
5392
                    return *lhs.m_value.array == *rhs.m_value.array;
N
Niels 已提交
5393
                }
5394
                case value_t::object:
N
Niels 已提交
5395 5396 5397
                {
                    assert(lhs.m_value.object != nullptr);
                    assert(rhs.m_value.object != nullptr);
N
Niels 已提交
5398
                    return *lhs.m_value.object == *rhs.m_value.object;
N
Niels 已提交
5399
                }
5400
                case value_t::null:
N
Niels 已提交
5401
                {
N
Niels 已提交
5402
                    return true;
N
Niels 已提交
5403
                }
5404
                case value_t::string:
N
Niels 已提交
5405 5406 5407
                {
                    assert(lhs.m_value.string != nullptr);
                    assert(rhs.m_value.string != nullptr);
N
Niels 已提交
5408
                    return *lhs.m_value.string == *rhs.m_value.string;
N
Niels 已提交
5409
                }
5410
                case value_t::boolean:
N
Niels 已提交
5411
                {
N
Niels 已提交
5412
                    return lhs.m_value.boolean == rhs.m_value.boolean;
N
Niels 已提交
5413
                }
5414
                case value_t::number_integer:
N
Niels 已提交
5415
                {
N
Niels 已提交
5416
                    return lhs.m_value.number_integer == rhs.m_value.number_integer;
N
Niels 已提交
5417
                }
5418 5419 5420 5421
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned == rhs.m_value.number_unsigned;
                }
5422
                case value_t::number_float:
N
Niels 已提交
5423
                {
5424
                    return lhs.m_value.number_float == rhs.m_value.number_float;
N
Niels 已提交
5425
                }
5426
                default:
N
Niels 已提交
5427
                {
N
Niels 已提交
5428
                    return false;
N
Niels 已提交
5429
                }
N
Niels 已提交
5430 5431
            }
        }
F
Florian Weber 已提交
5432 5433
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
N
Niels 已提交
5434
            return static_cast<number_float_t>(lhs.m_value.number_integer) == rhs.m_value.number_float;
F
Florian Weber 已提交
5435 5436 5437
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
5438
            return lhs.m_value.number_float == static_cast<number_float_t>(rhs.m_value.number_integer);
F
Florian Weber 已提交
5439
        }
5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454
        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 已提交
5455
        }
5456

N
Niels 已提交
5457 5458 5459
        return false;
    }

N
Niels 已提交
5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474
    /*!
    @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 已提交
5475

N
Niels 已提交
5476
    @since version 1.0.0
N
Niels 已提交
5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491
    */
    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 已提交
5492 5493
    /*!
    @brief comparison: not equal
N
Niels 已提交
5494 5495 5496 5497 5498 5499 5500 5501 5502

    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.

5503 5504
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__notequal}
N
Niels 已提交
5505

N
Niels 已提交
5506
    @since version 1.0.0
N
Niels 已提交
5507
    */
N
Niels 已提交
5508
    friend bool operator!=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
5509 5510 5511 5512
    {
        return not (lhs == rhs);
    }

N
Niels 已提交
5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527
    /*!
    @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 已提交
5528

N
Niels 已提交
5529
    @since version 1.0.0
N
Niels 已提交
5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544
    */
    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 已提交
5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563
    /*!
    @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.

5564 5565
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__less}
N
Niels 已提交
5566

N
Niels 已提交
5567
    @since version 1.0.0
N
Niels 已提交
5568
    */
N
Niels 已提交
5569
    friend bool operator<(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
5570
    {
F
Florian Weber 已提交
5571 5572
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
5573

F
Florian Weber 已提交
5574
        if (lhs_type == rhs_type)
N
Niels 已提交
5575
        {
F
Florian Weber 已提交
5576
            switch (lhs_type)
N
Niels 已提交
5577
            {
5578
                case value_t::array:
N
Niels 已提交
5579 5580 5581
                {
                    assert(lhs.m_value.array != nullptr);
                    assert(rhs.m_value.array != nullptr);
N
Niels 已提交
5582
                    return *lhs.m_value.array < *rhs.m_value.array;
N
Niels 已提交
5583
                }
5584
                case value_t::object:
N
Niels 已提交
5585 5586 5587
                {
                    assert(lhs.m_value.object != nullptr);
                    assert(rhs.m_value.object != nullptr);
N
Niels 已提交
5588
                    return *lhs.m_value.object < *rhs.m_value.object;
N
Niels 已提交
5589
                }
5590
                case value_t::null:
N
Niels 已提交
5591
                {
N
Niels 已提交
5592
                    return false;
N
Niels 已提交
5593
                }
5594
                case value_t::string:
N
Niels 已提交
5595 5596 5597
                {
                    assert(lhs.m_value.string != nullptr);
                    assert(rhs.m_value.string != nullptr);
N
Niels 已提交
5598
                    return *lhs.m_value.string < *rhs.m_value.string;
N
Niels 已提交
5599
                }
5600
                case value_t::boolean:
N
Niels 已提交
5601
                {
N
Niels 已提交
5602
                    return lhs.m_value.boolean < rhs.m_value.boolean;
N
Niels 已提交
5603
                }
5604
                case value_t::number_integer:
N
Niels 已提交
5605
                {
N
Niels 已提交
5606
                    return lhs.m_value.number_integer < rhs.m_value.number_integer;
N
Niels 已提交
5607
                }
5608 5609 5610 5611
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned < rhs.m_value.number_unsigned;
                }
5612
                case value_t::number_float:
N
Niels 已提交
5613
                {
N
Niels 已提交
5614
                    return lhs.m_value.number_float < rhs.m_value.number_float;
N
Niels 已提交
5615
                }
5616
                default:
N
Niels 已提交
5617
                {
N
Niels 已提交
5618
                    return false;
N
Niels 已提交
5619
                }
N
Niels 已提交
5620 5621
            }
        }
F
Florian Weber 已提交
5622 5623
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
5624
            return static_cast<number_float_t>(lhs.m_value.number_integer) < rhs.m_value.number_float;
F
Florian Weber 已提交
5625 5626 5627
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644
            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 已提交
5645
        }
N
Niels 已提交
5646

N
Niels 已提交
5647
        // We only reach this line if we cannot compare values. In that case,
N
Niels 已提交
5648 5649 5650
        // we compare types. Note we have to call the operator explicitly,
        // because MSVC has problems otherwise.
        return operator<(lhs_type, rhs_type);
N
Niels 已提交
5651 5652
    }

N
Niels 已提交
5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664
    /*!
    @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.

5665 5666
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greater}
N
Niels 已提交
5667

N
Niels 已提交
5668
    @since version 1.0.0
N
Niels 已提交
5669
    */
N
Niels 已提交
5670
    friend bool operator<=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
5671 5672 5673 5674
    {
        return not (rhs < lhs);
    }

N
Niels 已提交
5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686
    /*!
    @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.

5687 5688
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__lessequal}
N
Niels 已提交
5689

N
Niels 已提交
5690
    @since version 1.0.0
N
Niels 已提交
5691
    */
N
Niels 已提交
5692
    friend bool operator>(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
5693 5694 5695 5696
    {
        return not (lhs <= rhs);
    }

N
Niels 已提交
5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708
    /*!
    @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.

5709 5710
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greaterequal}
N
Niels 已提交
5711

N
Niels 已提交
5712
    @since version 1.0.0
N
Niels 已提交
5713
    */
N
Niels 已提交
5714
    friend bool operator>=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
5715 5716 5717 5718
    {
        return not (lhs < rhs);
    }

N
Niels 已提交
5719 5720
    /// @}

N
Niels 已提交
5721 5722 5723 5724 5725

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

N
Niels 已提交
5726 5727 5728
    /// @name serialization
    /// @{

N
Niels 已提交
5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745
    /*!
    @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)`.

    @param[in,out] o  stream to serialize to
    @param[in] j  JSON value to serialize

    @return the stream @a o

    @complexity Linear.

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

N
Niels 已提交
5749
    @since version 1.0.0
N
Niels 已提交
5750
    */
N
Niels 已提交
5751 5752
    friend std::ostream& operator<<(std::ostream& o, const basic_json& j)
    {
N
Niels 已提交
5753
        // read width member and use it as indentation parameter if nonzero
N
Niels 已提交
5754 5755
        const bool pretty_print = (o.width() > 0);
        const auto indentation = (pretty_print ? o.width() : 0);
N
Niels 已提交
5756

N
Niels 已提交
5757 5758 5759 5760
        // reset width to 0 for subsequent calls to this stream
        o.width(0);

        // do the actual serialization
N
Niels 已提交
5761
        j.dump(o, pretty_print, static_cast<unsigned int>(indentation));
N
Niels 已提交
5762 5763 5764
        return o;
    }

N
Niels 已提交
5765 5766 5767 5768
    /*!
    @brief serialize to stream
    @copydoc operator<<(std::ostream&, const basic_json&)
    */
N
Niels 已提交
5769 5770
    friend std::ostream& operator>>(const basic_json& j, std::ostream& o)
    {
N
Niels 已提交
5771
        return o << j;
N
Niels 已提交
5772 5773
    }

N
Niels 已提交
5774 5775
    /// @}

N
Niels 已提交
5776 5777 5778 5779 5780

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

N
Niels 已提交
5781 5782 5783
    /// @name deserialization
    /// @{

N
Niels 已提交
5784 5785 5786 5787
    /*!
    @brief deserialize from string

    @param[in] s  string to read a serialized JSON value from
N
Niels 已提交
5788 5789 5790
    @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 已提交
5791 5792 5793 5794 5795 5796 5797

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

N
Niels 已提交
5800
    @liveexample{The example below demonstrates the `parse()` function with and
N
Niels 已提交
5801
    without callback function.,parse__string__parser_callback_t}
N
Niels 已提交
5802

N
Niels 已提交
5803 5804 5805
    @sa @ref parse(std::istream&, parser_callback_t) for a version that reads
    from an input stream

N
Niels 已提交
5806
    @since version 1.0.0
N
Niels 已提交
5807
    */
N
Niels 已提交
5808
    static basic_json parse(const string_t& s, parser_callback_t cb = nullptr)
N
Niels 已提交
5809
    {
N
Niels 已提交
5810
        return parser(s, cb).parse();
N
Niels 已提交
5811 5812
    }

N
Niels 已提交
5813 5814 5815 5816
    /*!
    @brief deserialize from stream

    @param[in,out] i  stream to read a serialized JSON value from
N
Niels 已提交
5817 5818 5819
    @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 已提交
5820 5821 5822 5823 5824 5825 5826

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

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

N
Niels 已提交
5832
    @sa @ref parse(const string_t&, parser_callback_t) for a version that reads
N
Niels 已提交
5833
    from a string
N
Niels 已提交
5834

N
Niels 已提交
5835
    @since version 1.0.0
N
Niels 已提交
5836
    */
N
Niels 已提交
5837
    static basic_json parse(std::istream& i, parser_callback_t cb = nullptr)
N
Niels 已提交
5838
    {
N
Niels 已提交
5839
        return parser(i, cb).parse();
N
Niels 已提交
5840 5841
    }

N
Niels 已提交
5842 5843 5844
    /*!
    @copydoc parse(std::istream&, parser_callback_t)
    */
N
Cleanup  
Niels 已提交
5845 5846 5847 5848 5849
    static basic_json parse(std::istream&& i, parser_callback_t cb = nullptr)
    {
        return parser(i, cb).parse();
    }

N
Niels 已提交
5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862
    /*!
    @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 已提交
5863 5864
    @note A UTF-8 byte order mark is silently ignored.

N
Niels 已提交
5865 5866 5867 5868 5869
    @liveexample{The example below shows how a JSON value is constructed by
    reading a serialization from a stream.,operator_deserialize}

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

N
Niels 已提交
5871
    @since version 1.0.0
N
Niels 已提交
5872 5873
    */
    friend std::istream& operator<<(basic_json& j, std::istream& i)
N
Niels 已提交
5874 5875 5876 5877 5878
    {
        j = parser(i).parse();
        return i;
    }

N
Niels 已提交
5879 5880 5881 5882 5883
    /*!
    @brief deserialize from stream
    @copydoc operator<<(basic_json&, std::istream&)
    */
    friend std::istream& operator>>(std::istream& i, basic_json& j)
N
Niels 已提交
5884 5885 5886 5887 5888
    {
        j = parser(i).parse();
        return i;
    }

N
Niels 已提交
5889 5890
    /// @}

N
Niels 已提交
5891 5892 5893 5894 5895 5896 5897

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

    /// return the type as string
N
Niels 已提交
5898
    string_t type_name() const noexcept
N
Niels 已提交
5899 5900 5901
    {
        switch (m_type)
        {
5902
            case value_t::null:
N
Niels 已提交
5903
                return "null";
5904
            case value_t::object:
N
Niels 已提交
5905
                return "object";
5906
            case value_t::array:
N
Niels 已提交
5907
                return "array";
5908
            case value_t::string:
N
Niels 已提交
5909
                return "string";
5910
            case value_t::boolean:
N
Niels 已提交
5911
                return "boolean";
5912
            case value_t::discarded:
N
Niels 已提交
5913
                return "discarded";
N
Niels 已提交
5914
            default:
N
Niels 已提交
5915 5916 5917 5918
                return "number";
        }
    }

N
Niels 已提交
5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962
    /*!
    @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
    {
        std::size_t result = 0;

        for (const auto& c : s)
        {
            switch (c)
            {
                case '"':
                case '\\':
                case '\b':
                case '\f':
                case '\n':
                case '\r':
                case '\t':
                {
                    // from c (1 byte) to \x (2 bytes)
                    result += 1;
                    break;
                }

                default:
                {
                    if (c >= 0x00 and c <= 0x1f)
                    {
                        // from c (1 byte) to \uxxxx (6 bytes)
                        result += 5;
                    }
                    break;
                }
            }
        }

        return result;
    }

N
Niels 已提交
5963 5964
    /*!
    @brief escape a string
N
Niels 已提交
5965

N
Niels 已提交
5966 5967 5968 5969 5970
    Escape a string by replacing certain special characters by a sequence of an
    escape character (backslash) and another character and other control
    characters by a sequence of "\u" followed by a four-digit hex
    representation.

N
Niels 已提交
5971
    @param[in] s  the string to escape
N
Niels 已提交
5972 5973 5974
    @return  the escaped string

    @complexity Linear in the length of string @a s.
N
Niels 已提交
5975
    */
N
Niels 已提交
5976
    static string_t escape_string(const string_t& s)
N
Niels 已提交
5977
    {
N
Niels 已提交
5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988
        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 已提交
5989 5990 5991 5992 5993 5994
        {
            switch (c)
            {
                // quotation mark (0x22)
                case '"':
                {
N
Niels 已提交
5995 5996
                    result[pos + 1] = '"';
                    pos += 2;
N
Niels 已提交
5997 5998
                    break;
                }
N
Niels 已提交
5999

N
Niels 已提交
6000 6001 6002
                // reverse solidus (0x5c)
                case '\\':
                {
N
Niels 已提交
6003 6004
                    // nothing to change
                    pos += 2;
N
Niels 已提交
6005 6006
                    break;
                }
N
Niels 已提交
6007

N
Niels 已提交
6008 6009 6010
                // backspace (0x08)
                case '\b':
                {
N
Niels 已提交
6011 6012
                    result[pos + 1] = 'b';
                    pos += 2;
N
Niels 已提交
6013 6014
                    break;
                }
N
Niels 已提交
6015

N
Niels 已提交
6016 6017 6018
                // formfeed (0x0c)
                case '\f':
                {
N
Niels 已提交
6019 6020
                    result[pos + 1] = 'f';
                    pos += 2;
N
Niels 已提交
6021 6022
                    break;
                }
N
Niels 已提交
6023

N
Niels 已提交
6024 6025 6026
                // newline (0x0a)
                case '\n':
                {
N
Niels 已提交
6027 6028
                    result[pos + 1] = 'n';
                    pos += 2;
N
Niels 已提交
6029 6030
                    break;
                }
N
Niels 已提交
6031

N
Niels 已提交
6032 6033 6034
                // carriage return (0x0d)
                case '\r':
                {
N
Niels 已提交
6035 6036
                    result[pos + 1] = 'r';
                    pos += 2;
N
Niels 已提交
6037 6038
                    break;
                }
N
Niels 已提交
6039

N
Niels 已提交
6040 6041 6042
                // horizontal tab (0x09)
                case '\t':
                {
N
Niels 已提交
6043 6044
                    result[pos + 1] = 't';
                    pos += 2;
N
Niels 已提交
6045 6046 6047 6048 6049
                    break;
                }

                default:
                {
6050
                    if (c >= 0x00 and c <= 0x1f)
N
Niels 已提交
6051
                    {
N
Niels 已提交
6052 6053
                        // convert a number 0..15 to its hex representation
                        // (0..f)
6054 6055 6056 6057 6058
                        auto hexify = [](const char v) -> char
                        {
                            return (v < 10) ? ('0' + v) : ('a' + v - 10);
                        };

N
Niels 已提交
6059
                        // print character c as \uxxxx
N
Niels 已提交
6060 6061 6062
                        for (const char m :
                    { 'u', '0', '0', hexify(c >> 4), hexify(c & 0x0f)
                        })
6063 6064 6065 6066 6067
                        {
                            result[++pos] = m;
                        }

                        ++pos;
N
Niels 已提交
6068 6069 6070 6071
                    }
                    else
                    {
                        // all other characters are added as-is
N
Niels 已提交
6072
                        result[pos++] = c;
N
Niels 已提交
6073 6074 6075 6076 6077
                    }
                    break;
                }
            }
        }
N
Niels 已提交
6078 6079

        return result;
N
Niels 已提交
6080 6081 6082 6083
    }

    /*!
    @brief internal implementation of the serialization function
N
Niels 已提交
6084

N
Niels 已提交
6085
    This function is called by the public member function dump and organizes
N
Niels 已提交
6086
    the serialization internally. The indentation level is propagated as
N
Niels 已提交
6087 6088
    additional parameter. In case of arrays and objects, the function is called
    recursively. Note that
N
Niels 已提交
6089

N
Niels 已提交
6090 6091 6092
    - 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 已提交
6093

N
Niels 已提交
6094 6095 6096 6097
    @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 已提交
6098
    */
N
Niels 已提交
6099 6100 6101
    void dump(std::ostream& o,
              const bool pretty_print,
              const unsigned int indent_step,
N
Niels 已提交
6102
              const unsigned int current_indent = 0) const
N
Niels 已提交
6103
    {
N
Niels 已提交
6104
        // variable to hold indentation for recursive calls
N
Niels 已提交
6105
        unsigned int new_indent = current_indent;
N
Niels 已提交
6106

N
Niels 已提交
6107 6108
        switch (m_type)
        {
6109
            case value_t::object:
N
Niels 已提交
6110
            {
N
Niels 已提交
6111 6112
                assert(m_value.object != nullptr);

N
Niels 已提交
6113 6114
                if (m_value.object->empty())
                {
N
Niels 已提交
6115 6116
                    o << "{}";
                    return;
N
Niels 已提交
6117 6118
                }

N
Niels 已提交
6119
                o << "{";
N
Niels 已提交
6120 6121

                // increase indentation
N
Niels 已提交
6122
                if (pretty_print)
N
Niels 已提交
6123
                {
N
Niels 已提交
6124
                    new_indent += indent_step;
N
Niels 已提交
6125
                    o << "\n";
N
Niels 已提交
6126 6127 6128 6129 6130 6131
                }

                for (auto i = m_value.object->cbegin(); i != m_value.object->cend(); ++i)
                {
                    if (i != m_value.object->cbegin())
                    {
N
Niels 已提交
6132
                        o << (pretty_print ? ",\n" : ",");
N
Niels 已提交
6133
                    }
N
Niels 已提交
6134 6135 6136
                    o << string_t(new_indent, ' ') << "\""
                      << escape_string(i->first) << "\":"
                      << (pretty_print ? " " : "");
N
Niels 已提交
6137
                    i->second.dump(o, pretty_print, indent_step, new_indent);
N
Niels 已提交
6138 6139 6140
                }

                // decrease indentation
N
Niels 已提交
6141
                if (pretty_print)
N
Niels 已提交
6142
                {
N
Niels 已提交
6143
                    new_indent -= indent_step;
N
Niels 已提交
6144
                    o << "\n";
N
Niels 已提交
6145 6146
                }

N
Niels 已提交
6147 6148
                o << string_t(new_indent, ' ') + "}";
                return;
N
Niels 已提交
6149 6150
            }

6151
            case value_t::array:
N
Niels 已提交
6152
            {
N
Niels 已提交
6153 6154
                assert(m_value.array != nullptr);

N
Niels 已提交
6155 6156
                if (m_value.array->empty())
                {
N
Niels 已提交
6157 6158
                    o << "[]";
                    return;
N
Niels 已提交
6159 6160
                }

N
Niels 已提交
6161
                o << "[";
N
Niels 已提交
6162 6163

                // increase indentation
N
Niels 已提交
6164
                if (pretty_print)
N
Niels 已提交
6165
                {
N
Niels 已提交
6166
                    new_indent += indent_step;
N
Niels 已提交
6167
                    o << "\n";
N
Niels 已提交
6168 6169 6170 6171 6172 6173
                }

                for (auto i = m_value.array->cbegin(); i != m_value.array->cend(); ++i)
                {
                    if (i != m_value.array->cbegin())
                    {
N
Niels 已提交
6174
                        o << (pretty_print ? ",\n" : ",");
N
Niels 已提交
6175
                    }
N
Niels 已提交
6176
                    o << string_t(new_indent, ' ');
N
Niels 已提交
6177
                    i->dump(o, pretty_print, indent_step, new_indent);
N
Niels 已提交
6178 6179 6180
                }

                // decrease indentation
N
Niels 已提交
6181
                if (pretty_print)
N
Niels 已提交
6182
                {
N
Niels 已提交
6183
                    new_indent -= indent_step;
N
Niels 已提交
6184
                    o << "\n";
N
Niels 已提交
6185 6186
                }

N
Niels 已提交
6187 6188
                o << string_t(new_indent, ' ') << "]";
                return;
N
Niels 已提交
6189 6190
            }

6191
            case value_t::string:
N
Niels 已提交
6192
            {
N
Niels 已提交
6193
                assert(m_value.string != nullptr);
N
Niels 已提交
6194
                o << string_t("\"") << escape_string(*m_value.string) << "\"";
N
Niels 已提交
6195
                return;
N
Niels 已提交
6196 6197
            }

6198
            case value_t::boolean:
N
Niels 已提交
6199
            {
N
Niels 已提交
6200 6201
                o << (m_value.boolean ? "true" : "false");
                return;
N
Niels 已提交
6202 6203
            }

6204
            case value_t::number_integer:
N
Niels 已提交
6205
            {
N
Niels 已提交
6206 6207
                o << m_value.number_integer;
                return;
N
Niels 已提交
6208 6209
            }

6210 6211 6212 6213 6214 6215
            case value_t::number_unsigned:
            {
                o << m_value.number_unsigned;
                return;
            }

6216
            case value_t::number_float:
N
Niels 已提交
6217
            {
N
Niels 已提交
6218 6219 6220 6221 6222 6223
                // check if number was parsed from a string
                if (m_type.bits.parsed)
                {
                    // check if parsed number had an exponent given
                    if (m_type.bits.has_exp)
                    {
N
Niels 已提交
6224 6225 6226 6227
                        // buffer size: precision (2^8-1 = 255) + other ('-.e-xxx' = 7) + null (1)
                        char buf[263];
                        int len;

N
Niels 已提交
6228 6229 6230
                        // handle capitalization of the exponent
                        if (m_type.bits.exp_cap)
                        {
N
Niels 已提交
6231 6232
                            len = snprintf(buf, sizeof(buf), "%.*E",
                                           m_type.bits.precision, m_value.number_float) + 1;
N
Niels 已提交
6233 6234 6235
                        }
                        else
                        {
N
Niels 已提交
6236 6237
                            len = snprintf(buf, sizeof(buf), "%.*e",
                                           m_type.bits.precision, m_value.number_float) + 1;
N
Niels 已提交
6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257
                        }

                        // remove '+' sign from the exponent if necessary
                        if (not m_type.bits.exp_plus)
                        {
                            if (len > static_cast<int>(sizeof(buf)))
                            {
                                len = sizeof(buf);
                            }
                            for (int i = 0; i < len; i++)
                            {
                                if (buf[i] == '+')
                                {
                                    for (; i + 1 < len; i++)
                                    {
                                        buf[i] = buf[i + 1];
                                    }
                                }
                            }
                        }
N
Niels 已提交
6258 6259

                        o << buf;
N
Niels 已提交
6260 6261 6262 6263
                    }
                    else
                    {
                        // no exponent - output as a decimal
N
Niels 已提交
6264
                        std::stringstream ss;
N
Niels 已提交
6265
                        ss.imbue(std::locale(std::locale(), new DecimalSeparator));  // fix locale problems
N
Niels 已提交
6266 6267 6268
                        ss << std::setprecision(m_type.bits.precision)
                           << std::fixed << m_value.number_float;
                        o << ss.str();
N
Niels 已提交
6269 6270
                    }
                }
N
Niels 已提交
6271
                else
N
Niels 已提交
6272
                {
N
Niels 已提交
6273
                    if (m_value.number_float == 0)
N
Niels 已提交
6274
                    {
N
Niels 已提交
6275 6276
                        // special case for zero to get "0.0"/"-0.0"
                        o << (std::signbit(m_value.number_float) ? "-0.0" : "0.0");
N
Niels 已提交
6277 6278 6279
                    }
                    else
                    {
N
Niels 已提交
6280 6281 6282 6283 6284 6285
                        // Otherwise 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
                        std::stringstream ss;
N
Niels 已提交
6286
                        ss.imbue(std::locale(std::locale(), new DecimalSeparator));  // fix locale problems
N
Niels 已提交
6287 6288 6289
                        ss << std::setprecision(std::numeric_limits<double>::digits10)
                           << m_value.number_float;
                        o << ss.str();
N
Niels 已提交
6290
                    }
N
Niels 已提交
6291
                }
N
Niels 已提交
6292
                return;
N
Niels 已提交
6293
            }
N
Niels 已提交
6294

6295
            case value_t::discarded:
N
Niels 已提交
6296
            {
N
Niels 已提交
6297 6298
                o << "<discarded>";
                return;
N
Niels 已提交
6299
            }
N
Niels 已提交
6300

6301
            case value_t::null:
N
Niels 已提交
6302
            {
N
Niels 已提交
6303 6304
                o << "null";
                return;
N
Niels 已提交
6305
            }
N
Niels 已提交
6306 6307 6308 6309 6310 6311 6312 6313 6314
        }
    }

  private:
    //////////////////////
    // member variables //
    //////////////////////

    /// the type of the current element
N
Niels 已提交
6315
    type_data_t m_type = value_t::null;
N
Niels 已提交
6316 6317 6318 6319

    /// the value of the current element
    json_value m_value = {};

N
Niels 已提交
6320

N
Niels 已提交
6321
  private:
N
Niels 已提交
6322 6323 6324 6325
    ///////////////
    // iterators //
    ///////////////

6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338
    /*!
    @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 已提交
6339
        void set_begin() noexcept
6340 6341 6342 6343 6344
        {
            m_it = begin_value;
        }

        /// set iterator to a defined past the end
N
Niels 已提交
6345
        void set_end() noexcept
6346 6347 6348 6349 6350
        {
            m_it = end_value;
        }

        /// return whether the iterator can be dereferenced
N
Niels 已提交
6351
        constexpr bool is_begin() const noexcept
6352 6353 6354 6355 6356
        {
            return (m_it == begin_value);
        }

        /// return whether the iterator is at end
N
Niels 已提交
6357
        constexpr bool is_end() const noexcept
6358 6359 6360 6361 6362
        {
            return (m_it == end_value);
        }

        /// return reference to the value to change and compare
N
Niels 已提交
6363
        operator difference_type& () noexcept
6364 6365 6366 6367 6368
        {
            return m_it;
        }

        /// return value to compare
N
Niels 已提交
6369
        constexpr operator difference_type () const noexcept
6370 6371 6372 6373 6374 6375 6376 6377 6378
        {
            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 已提交
6379
        difference_type m_it = std::numeric_limits<std::ptrdiff_t>::denorm_min();
6380 6381
    };

N
Niels 已提交
6382 6383 6384 6385 6386 6387 6388 6389
    /*!
    @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 已提交
6390 6391
    {
        /// iterator for JSON objects
N
Niels 已提交
6392
        typename object_t::iterator object_iterator;
N
Niels 已提交
6393
        /// iterator for JSON arrays
N
Niels 已提交
6394
        typename array_t::iterator array_iterator;
N
Niels 已提交
6395
        /// generic iterator for all other types
N
Niels 已提交
6396 6397 6398
        primitive_iterator_t primitive_iterator;

        /// create an uninitialized internal_iterator
N
Niels 已提交
6399
        internal_iterator() noexcept
N
Niels 已提交
6400 6401
            : object_iterator(), array_iterator(), primitive_iterator()
        {}
N
Niels 已提交
6402 6403
    };

N
cleanup  
Niels 已提交
6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418
    /// 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 已提交
6419
            explicit iteration_proxy_internal(IteratorType it) noexcept
N
cleanup  
Niels 已提交
6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438
                : 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 已提交
6439
            bool operator!= (const iteration_proxy_internal& o) const
N
cleanup  
Niels 已提交
6440 6441 6442 6443 6444 6445 6446
            {
                return anchor != o.anchor;
            }

            /// return key of the iterator
            typename basic_json::string_t key() const
            {
N
Niels 已提交
6447 6448
                assert(anchor.m_object != nullptr);

N
cleanup  
Niels 已提交
6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482
                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 已提交
6483
        explicit iteration_proxy(typename IteratorType::reference cont)
N
cleanup  
Niels 已提交
6484 6485 6486 6487
            : container(cont)
        {}

        /// return iterator begin (needed for range-based for)
N
Niels 已提交
6488
        iteration_proxy_internal begin() noexcept
N
cleanup  
Niels 已提交
6489 6490 6491 6492 6493
        {
            return iteration_proxy_internal(container.begin());
        }

        /// return iterator end (needed for range-based for)
N
Niels 已提交
6494
        iteration_proxy_internal end() noexcept
N
cleanup  
Niels 已提交
6495 6496 6497 6498 6499
        {
            return iteration_proxy_internal(container.end());
        }
    };

N
Niels 已提交
6500
  public:
N
Niels 已提交
6501 6502 6503 6504 6505 6506 6507 6508 6509 6510
    /*!
    @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.

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

N
Niels 已提交
6512
    @since version 1.0.0
N
Niels 已提交
6513
    */
N
Niels 已提交
6514
    class const_iterator : public std::iterator<std::random_access_iterator_tag, const basic_json>
N
Niels 已提交
6515
    {
N
Niels 已提交
6516
        /// allow basic_json to access private members
6517 6518
        friend class basic_json;

N
Niels 已提交
6519 6520
      public:
        /// the type of the values when the iterator is dereferenced
N
Niels 已提交
6521
        using value_type = typename basic_json::value_type;
N
Niels 已提交
6522
        /// a type to represent differences between iterators
N
Niels 已提交
6523
        using difference_type = typename basic_json::difference_type;
N
Niels 已提交
6524
        /// defines a pointer to the type iterated over (value_type)
N
Niels 已提交
6525
        using pointer = typename basic_json::const_pointer;
N
Niels 已提交
6526
        /// defines a reference to the type iterated over (value_type)
N
Niels 已提交
6527
        using reference = typename basic_json::const_reference;
N
Niels 已提交
6528
        /// the category of the iterator
N
Niels 已提交
6529
        using iterator_category = std::bidirectional_iterator_tag;
N
Niels 已提交
6530

6531
        /// default constructor
N
Niels 已提交
6532
        const_iterator() = default;
6533

N
Niels 已提交
6534
        /// constructor for a given JSON instance
N
Niels 已提交
6535 6536
        explicit const_iterator(pointer object) noexcept
            : m_object(object)
N
Niels 已提交
6537
        {
N
Niels 已提交
6538 6539
            assert(m_object != nullptr);

N
Niels 已提交
6540 6541
            switch (m_object->m_type)
            {
6542
                case basic_json::value_t::object:
N
Niels 已提交
6543 6544 6545 6546
                {
                    m_it.object_iterator = typename object_t::iterator();
                    break;
                }
6547 6548

                case basic_json::value_t::array:
N
Niels 已提交
6549 6550 6551 6552
                {
                    m_it.array_iterator = typename array_t::iterator();
                    break;
                }
6553

N
Niels 已提交
6554 6555
                default:
                {
6556
                    m_it.primitive_iterator = primitive_iterator_t();
N
Niels 已提交
6557 6558 6559 6560 6561
                    break;
                }
            }
        }

N
Niels 已提交
6562
        /// copy constructor given a nonconst iterator
N
Niels 已提交
6563 6564
        explicit const_iterator(const iterator& other) noexcept
            : m_object(other.m_object)
N
Niels 已提交
6565
        {
N
Niels 已提交
6566 6567
            assert(m_object != nullptr);

N
Niels 已提交
6568 6569
            switch (m_object->m_type)
            {
6570
                case basic_json::value_t::object:
N
Niels 已提交
6571 6572 6573 6574 6575
                {
                    m_it.object_iterator = other.m_it.object_iterator;
                    break;
                }

6576
                case basic_json::value_t::array:
N
Niels 已提交
6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589
                {
                    m_it.array_iterator = other.m_it.array_iterator;
                    break;
                }

                default:
                {
                    m_it.primitive_iterator = other.m_it.primitive_iterator;
                    break;
                }
            }
        }

N
Niels 已提交
6590
        /// copy constructor
N
Niels 已提交
6591
        const_iterator(const const_iterator& other) noexcept
N
Niels 已提交
6592 6593 6594
            : m_object(other.m_object), m_it(other.m_it)
        {}

N
Niels 已提交
6595
        /// copy assignment
N
Niels 已提交
6596
        const_iterator& operator=(const_iterator other) noexcept(
N
Niels 已提交
6597 6598
            std::is_nothrow_move_constructible<pointer>::value and
            std::is_nothrow_move_assignable<pointer>::value and
N
Niels 已提交
6599 6600
            std::is_nothrow_move_constructible<internal_iterator>::value and
            std::is_nothrow_move_assignable<internal_iterator>::value
N
Niels 已提交
6601 6602 6603 6604
        )
        {
            std::swap(m_object, other.m_object);
            std::swap(m_it, other.m_it);
N
Niels 已提交
6605 6606 6607
            return *this;
        }

N
Niels 已提交
6608
      private:
N
Niels 已提交
6609
        /// set the iterator to the first value
N
Niels 已提交
6610
        void set_begin() noexcept
N
Niels 已提交
6611
        {
N
Niels 已提交
6612 6613
            assert(m_object != nullptr);

N
Niels 已提交
6614 6615
            switch (m_object->m_type)
            {
6616
                case basic_json::value_t::object:
N
Niels 已提交
6617
                {
N
Niels 已提交
6618
                    assert(m_object->m_value.object != nullptr);
N
Niels 已提交
6619 6620 6621 6622
                    m_it.object_iterator = m_object->m_value.object->begin();
                    break;
                }

6623
                case basic_json::value_t::array:
N
Niels 已提交
6624
                {
N
Niels 已提交
6625
                    assert(m_object->m_value.array != nullptr);
N
Niels 已提交
6626 6627 6628 6629
                    m_it.array_iterator = m_object->m_value.array->begin();
                    break;
                }

6630
                case basic_json::value_t::null:
N
Niels 已提交
6631
                {
N
Niels 已提交
6632
                    // set to end so begin()==end() is true: null is empty
6633
                    m_it.primitive_iterator.set_end();
N
Niels 已提交
6634 6635 6636 6637 6638
                    break;
                }

                default:
                {
6639
                    m_it.primitive_iterator.set_begin();
N
Niels 已提交
6640 6641 6642 6643 6644 6645
                    break;
                }
            }
        }

        /// set the iterator past the last value
N
Niels 已提交
6646
        void set_end() noexcept
N
Niels 已提交
6647
        {
N
Niels 已提交
6648 6649
            assert(m_object != nullptr);

N
Niels 已提交
6650 6651
            switch (m_object->m_type)
            {
6652
                case basic_json::value_t::object:
N
Niels 已提交
6653
                {
N
Niels 已提交
6654
                    assert(m_object->m_value.object != nullptr);
N
Niels 已提交
6655 6656 6657 6658
                    m_it.object_iterator = m_object->m_value.object->end();
                    break;
                }

6659
                case basic_json::value_t::array:
N
Niels 已提交
6660
                {
N
Niels 已提交
6661
                    assert(m_object->m_value.array != nullptr);
N
Niels 已提交
6662 6663 6664 6665 6666 6667
                    m_it.array_iterator = m_object->m_value.array->end();
                    break;
                }

                default:
                {
6668
                    m_it.primitive_iterator.set_end();
N
Niels 已提交
6669 6670 6671 6672 6673
                    break;
                }
            }
        }

N
Niels 已提交
6674
      public:
N
Niels 已提交
6675
        /// return a reference to the value pointed to by the iterator
N
Niels 已提交
6676
        reference operator*() const
N
Niels 已提交
6677
        {
N
Niels 已提交
6678 6679
            assert(m_object != nullptr);

N
Niels 已提交
6680 6681
            switch (m_object->m_type)
            {
6682
                case basic_json::value_t::object:
N
Niels 已提交
6683
                {
N
Niels 已提交
6684 6685
                    assert(m_object->m_value.object);
                    assert(m_it.object_iterator != m_object->m_value.object->end());
N
Niels 已提交
6686 6687 6688
                    return m_it.object_iterator->second;
                }

6689
                case basic_json::value_t::array:
N
Niels 已提交
6690
                {
N
Niels 已提交
6691 6692
                    assert(m_object->m_value.array);
                    assert(m_it.array_iterator != m_object->m_value.array->end());
N
Niels 已提交
6693 6694 6695
                    return *m_it.array_iterator;
                }

6696
                case basic_json::value_t::null:
N
Niels 已提交
6697 6698 6699 6700 6701 6702
                {
                    throw std::out_of_range("cannot get value");
                }

                default:
                {
6703
                    if (m_it.primitive_iterator.is_begin())
N
Niels 已提交
6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715
                    {
                        return *m_object;
                    }
                    else
                    {
                        throw std::out_of_range("cannot get value");
                    }
                }
            }
        }

        /// dereference the iterator
N
Niels 已提交
6716
        pointer operator->() const
N
Niels 已提交
6717
        {
N
Niels 已提交
6718 6719
            assert(m_object != nullptr);

N
Niels 已提交
6720 6721
            switch (m_object->m_type)
            {
6722
                case basic_json::value_t::object:
N
Niels 已提交
6723
                {
N
Niels 已提交
6724 6725
                    assert(m_object->m_value.object);
                    assert(m_it.object_iterator != m_object->m_value.object->end());
N
Niels 已提交
6726 6727 6728
                    return &(m_it.object_iterator->second);
                }

6729
                case basic_json::value_t::array:
N
Niels 已提交
6730
                {
N
Niels 已提交
6731 6732
                    assert(m_object->m_value.array);
                    assert(m_it.array_iterator != m_object->m_value.array->end());
N
Niels 已提交
6733 6734 6735 6736 6737
                    return &*m_it.array_iterator;
                }

                default:
                {
6738
                    if (m_it.primitive_iterator.is_begin())
N
Niels 已提交
6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750
                    {
                        return m_object;
                    }
                    else
                    {
                        throw std::out_of_range("cannot get value");
                    }
                }
            }
        }

        /// post-increment (it++)
N
Niels 已提交
6751
        const_iterator operator++(int)
N
Niels 已提交
6752
        {
N
Niels 已提交
6753
            auto result = *this;
N
Niels 已提交
6754
            ++(*this);
N
Niels 已提交
6755 6756 6757 6758
            return result;
        }

        /// pre-increment (++it)
N
Niels 已提交
6759
        const_iterator& operator++()
N
Niels 已提交
6760
        {
N
Niels 已提交
6761 6762
            assert(m_object != nullptr);

N
Niels 已提交
6763 6764
            switch (m_object->m_type)
            {
6765
                case basic_json::value_t::object:
N
Niels 已提交
6766 6767 6768 6769 6770
                {
                    ++m_it.object_iterator;
                    break;
                }

6771
                case basic_json::value_t::array:
N
Niels 已提交
6772 6773 6774 6775 6776 6777 6778
                {
                    ++m_it.array_iterator;
                    break;
                }

                default:
                {
6779
                    ++m_it.primitive_iterator;
N
Niels 已提交
6780 6781 6782 6783 6784 6785 6786 6787
                    break;
                }
            }

            return *this;
        }

        /// post-decrement (it--)
N
Niels 已提交
6788
        const_iterator operator--(int)
N
Niels 已提交
6789
        {
N
Niels 已提交
6790
            auto result = *this;
N
Niels 已提交
6791
            --(*this);
N
Niels 已提交
6792 6793 6794 6795
            return result;
        }

        /// pre-decrement (--it)
N
Niels 已提交
6796
        const_iterator& operator--()
N
Niels 已提交
6797
        {
N
Niels 已提交
6798 6799
            assert(m_object != nullptr);

N
Niels 已提交
6800 6801
            switch (m_object->m_type)
            {
6802
                case basic_json::value_t::object:
N
Niels 已提交
6803 6804 6805 6806 6807
                {
                    --m_it.object_iterator;
                    break;
                }

6808
                case basic_json::value_t::array:
N
Niels 已提交
6809 6810 6811 6812 6813 6814 6815
                {
                    --m_it.array_iterator;
                    break;
                }

                default:
                {
6816
                    --m_it.primitive_iterator;
N
Niels 已提交
6817 6818 6819 6820 6821 6822 6823 6824
                    break;
                }
            }

            return *this;
        }

        /// comparison: equal
N
Niels 已提交
6825
        bool operator==(const const_iterator& other) const
N
Niels 已提交
6826
        {
N
Niels 已提交
6827 6828
            // if objects are not the same, the comparison is undefined
            if (m_object != other.m_object)
N
Niels 已提交
6829
            {
N
Niels 已提交
6830
                throw std::domain_error("cannot compare iterators of different containers");
N
Niels 已提交
6831 6832
            }

N
Niels 已提交
6833 6834
            assert(m_object != nullptr);

N
Niels 已提交
6835 6836
            switch (m_object->m_type)
            {
6837
                case basic_json::value_t::object:
N
Niels 已提交
6838 6839 6840 6841
                {
                    return (m_it.object_iterator == other.m_it.object_iterator);
                }

6842
                case basic_json::value_t::array:
N
Niels 已提交
6843 6844 6845 6846 6847 6848
                {
                    return (m_it.array_iterator == other.m_it.array_iterator);
                }

                default:
                {
6849
                    return (m_it.primitive_iterator == other.m_it.primitive_iterator);
N
Niels 已提交
6850 6851 6852 6853 6854
                }
            }
        }

        /// comparison: not equal
N
Niels 已提交
6855
        bool operator!=(const const_iterator& other) const
N
Niels 已提交
6856 6857 6858 6859
        {
            return not operator==(other);
        }

N
Niels 已提交
6860
        /// comparison: smaller
N
Niels 已提交
6861
        bool operator<(const const_iterator& other) const
N
Niels 已提交
6862 6863 6864 6865 6866 6867 6868
        {
            // 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 已提交
6869 6870
            assert(m_object != nullptr);

N
Niels 已提交
6871 6872
            switch (m_object->m_type)
            {
6873
                case basic_json::value_t::object:
N
Niels 已提交
6874
                {
N
Niels 已提交
6875
                    throw std::domain_error("cannot compare order of object iterators");
N
Niels 已提交
6876 6877
                }

6878
                case basic_json::value_t::array:
N
Niels 已提交
6879 6880 6881 6882 6883 6884
                {
                    return (m_it.array_iterator < other.m_it.array_iterator);
                }

                default:
                {
6885
                    return (m_it.primitive_iterator < other.m_it.primitive_iterator);
N
Niels 已提交
6886 6887 6888 6889 6890
                }
            }
        }

        /// comparison: less than or equal
N
Niels 已提交
6891
        bool operator<=(const const_iterator& other) const
N
Niels 已提交
6892 6893 6894 6895 6896
        {
            return not other.operator < (*this);
        }

        /// comparison: greater than
N
Niels 已提交
6897
        bool operator>(const const_iterator& other) const
N
Niels 已提交
6898 6899 6900 6901 6902
        {
            return not operator<=(other);
        }

        /// comparison: greater than or equal
N
Niels 已提交
6903
        bool operator>=(const const_iterator& other) const
N
Niels 已提交
6904 6905 6906 6907 6908
        {
            return not operator<(other);
        }

        /// add to iterator
N
Niels 已提交
6909
        const_iterator& operator+=(difference_type i)
N
Niels 已提交
6910
        {
N
Niels 已提交
6911 6912
            assert(m_object != nullptr);

N
Niels 已提交
6913 6914
            switch (m_object->m_type)
            {
6915
                case basic_json::value_t::object:
N
Niels 已提交
6916
                {
N
Niels 已提交
6917
                    throw std::domain_error("cannot use offsets with object iterators");
N
Niels 已提交
6918 6919
                }

6920
                case basic_json::value_t::array:
N
Niels 已提交
6921 6922 6923 6924 6925 6926 6927
                {
                    m_it.array_iterator += i;
                    break;
                }

                default:
                {
6928
                    m_it.primitive_iterator += i;
N
Niels 已提交
6929 6930 6931 6932 6933 6934 6935 6936
                    break;
                }
            }

            return *this;
        }

        /// subtract from iterator
N
Niels 已提交
6937
        const_iterator& operator-=(difference_type i)
N
Niels 已提交
6938 6939 6940 6941 6942
        {
            return operator+=(-i);
        }

        /// add to iterator
N
Niels 已提交
6943
        const_iterator operator+(difference_type i)
N
Niels 已提交
6944 6945 6946 6947 6948 6949 6950
        {
            auto result = *this;
            result += i;
            return result;
        }

        /// subtract from iterator
N
Niels 已提交
6951
        const_iterator operator-(difference_type i)
N
Niels 已提交
6952 6953 6954 6955 6956 6957 6958
        {
            auto result = *this;
            result -= i;
            return result;
        }

        /// return difference
N
Niels 已提交
6959
        difference_type operator-(const const_iterator& other) const
N
Niels 已提交
6960
        {
N
Niels 已提交
6961 6962
            assert(m_object != nullptr);

N
Niels 已提交
6963 6964
            switch (m_object->m_type)
            {
6965
                case basic_json::value_t::object:
N
Niels 已提交
6966
                {
N
Niels 已提交
6967
                    throw std::domain_error("cannot use offsets with object iterators");
N
Niels 已提交
6968 6969
                }

6970
                case basic_json::value_t::array:
N
Niels 已提交
6971 6972 6973 6974 6975 6976
                {
                    return m_it.array_iterator - other.m_it.array_iterator;
                }

                default:
                {
6977
                    return m_it.primitive_iterator - other.m_it.primitive_iterator;
N
Niels 已提交
6978 6979 6980 6981 6982
                }
            }
        }

        /// access to successor
N
Niels 已提交
6983
        reference operator[](difference_type n) const
N
Niels 已提交
6984
        {
N
Niels 已提交
6985 6986
            assert(m_object != nullptr);

N
Niels 已提交
6987 6988
            switch (m_object->m_type)
            {
6989
                case basic_json::value_t::object:
N
Niels 已提交
6990 6991 6992 6993
                {
                    throw std::domain_error("cannot use operator[] for object iterators");
                }

6994
                case basic_json::value_t::array:
N
Niels 已提交
6995 6996 6997 6998
                {
                    return *(m_it.array_iterator + n);
                }

6999
                case basic_json::value_t::null:
N
Niels 已提交
7000 7001 7002 7003 7004 7005
                {
                    throw std::out_of_range("cannot get value");
                }

                default:
                {
7006
                    if (m_it.primitive_iterator == -n)
N
Niels 已提交
7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017
                    {
                        return *m_object;
                    }
                    else
                    {
                        throw std::out_of_range("cannot get value");
                    }
                }
            }
        }

7018
        /// return the key of an object iterator
N
Niels 已提交
7019
        typename object_t::key_type key() const
N
Niels 已提交
7020
        {
N
Niels 已提交
7021
            assert(m_object != nullptr);
N
Niels 已提交
7022

7023 7024 7025 7026 7027 7028 7029
            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 已提交
7030 7031 7032
            }
        }

N
Niels 已提交
7033 7034
        /// return the value of an iterator
        reference value() const
N
Niels 已提交
7035 7036 7037 7038
        {
            return operator*();
        }

N
Niels 已提交
7039 7040 7041 7042
      private:
        /// associated JSON instance
        pointer m_object = nullptr;
        /// the actual iterator of the associated instance
N
Niels 已提交
7043
        internal_iterator m_it = internal_iterator();
N
Niels 已提交
7044 7045
    };

N
Niels 已提交
7046 7047 7048 7049 7050 7051 7052 7053 7054
    /*!
    @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 已提交
7055

N
Niels 已提交
7056
    @since version 1.0.0
N
Niels 已提交
7057
    */
N
Niels 已提交
7058
    class iterator : public const_iterator
N
Niels 已提交
7059 7060
    {
      public:
N
Niels 已提交
7061 7062 7063
        using base_iterator = const_iterator;
        using pointer = typename basic_json::pointer;
        using reference = typename basic_json::reference;
N
Niels 已提交
7064

7065
        /// default constructor
N
Niels 已提交
7066
        iterator() = default;
7067

N
Niels 已提交
7068
        /// constructor for a given JSON instance
N
Niels 已提交
7069
        explicit iterator(pointer object) noexcept
N
cleanup  
Niels 已提交
7070
            : base_iterator(object)
N
Niels 已提交
7071
        {}
N
Niels 已提交
7072

N
Niels 已提交
7073
        /// copy constructor
N
Niels 已提交
7074 7075
        iterator(const iterator& other) noexcept
            : base_iterator(other)
N
Niels 已提交
7076 7077
        {}

N
Niels 已提交
7078
        /// copy assignment
N
Niels 已提交
7079
        iterator& operator=(iterator other) noexcept(
N
Niels 已提交
7080 7081
            std::is_nothrow_move_constructible<pointer>::value and
            std::is_nothrow_move_assignable<pointer>::value and
N
Niels 已提交
7082 7083
            std::is_nothrow_move_constructible<internal_iterator>::value and
            std::is_nothrow_move_assignable<internal_iterator>::value
N
Niels 已提交
7084 7085
        )
        {
N
Niels 已提交
7086
            base_iterator::operator=(other);
N
Niels 已提交
7087 7088 7089
            return *this;
        }

N
Niels 已提交
7090
        /// return a reference to the value pointed to by the iterator
7091
        reference operator*() const
N
Niels 已提交
7092
        {
N
Niels 已提交
7093 7094
            return const_cast<reference>(base_iterator::operator*());
        }
N
Niels 已提交
7095

N
Niels 已提交
7096
        /// dereference the iterator
7097
        pointer operator->() const
N
Niels 已提交
7098 7099 7100
        {
            return const_cast<pointer>(base_iterator::operator->());
        }
N
Niels 已提交
7101

N
Niels 已提交
7102 7103 7104 7105 7106 7107 7108
        /// post-increment (it++)
        iterator operator++(int)
        {
            iterator result = *this;
            base_iterator::operator++();
            return result;
        }
N
Niels 已提交
7109

N
Niels 已提交
7110 7111 7112 7113 7114
        /// pre-increment (++it)
        iterator& operator++()
        {
            base_iterator::operator++();
            return *this;
N
Niels 已提交
7115 7116
        }

N
Niels 已提交
7117 7118
        /// post-decrement (it--)
        iterator operator--(int)
N
Niels 已提交
7119
        {
N
Niels 已提交
7120 7121 7122 7123
            iterator result = *this;
            base_iterator::operator--();
            return result;
        }
N
Niels 已提交
7124

N
Niels 已提交
7125 7126 7127 7128 7129 7130
        /// pre-decrement (--it)
        iterator& operator--()
        {
            base_iterator::operator--();
            return *this;
        }
N
Niels 已提交
7131 7132

        /// add to iterator
N
Niels 已提交
7133
        iterator& operator+=(difference_type i)
N
Niels 已提交
7134
        {
N
Niels 已提交
7135
            base_iterator::operator+=(i);
N
Niels 已提交
7136 7137 7138 7139
            return *this;
        }

        /// subtract from iterator
N
Niels 已提交
7140
        iterator& operator-=(difference_type i)
N
Niels 已提交
7141
        {
N
Niels 已提交
7142 7143
            base_iterator::operator-=(i);
            return *this;
N
Niels 已提交
7144 7145 7146
        }

        /// add to iterator
N
Niels 已提交
7147
        iterator operator+(difference_type i)
N
Niels 已提交
7148 7149 7150 7151 7152 7153 7154
        {
            auto result = *this;
            result += i;
            return result;
        }

        /// subtract from iterator
N
Niels 已提交
7155
        iterator operator-(difference_type i)
N
Niels 已提交
7156 7157 7158 7159 7160 7161
        {
            auto result = *this;
            result -= i;
            return result;
        }

N
Niels 已提交
7162
        /// return difference
N
Niels 已提交
7163
        difference_type operator-(const iterator& other) const
N
Niels 已提交
7164
        {
N
Niels 已提交
7165
            return base_iterator::operator-(other);
N
Niels 已提交
7166 7167 7168
        }

        /// access to successor
N
Niels 已提交
7169
        reference operator[](difference_type n) const
N
Niels 已提交
7170
        {
N
Niels 已提交
7171
            return const_cast<reference>(base_iterator::operator[](n));
N
Niels 已提交
7172 7173
        }

7174
        /// return the value of an iterator
N
Niels 已提交
7175
        reference value() const
N
Niels 已提交
7176
        {
N
Niels 已提交
7177
            return const_cast<reference>(base_iterator::value());
N
Niels 已提交
7178
        }
N
Niels 已提交
7179 7180
    };

N
Niels 已提交
7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194
    /*!
    @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 已提交
7195

N
Niels 已提交
7196
    @since version 1.0.0
N
Niels 已提交
7197
    */
N
Niels 已提交
7198 7199
    template<typename Base>
    class json_reverse_iterator : public std::reverse_iterator<Base>
7200 7201
    {
      public:
7202
        /// shortcut to the reverse iterator adaptor
N
Niels 已提交
7203
        using base_iterator = std::reverse_iterator<Base>;
N
Niels 已提交
7204
        /// the reference type for the pointed-to element
N
Niels 已提交
7205
        using reference = typename Base::reference;
7206

7207
        /// create reverse iterator from iterator
N
Niels 已提交
7208
        json_reverse_iterator(const typename base_iterator::iterator_type& it) noexcept
N
cleanup  
Niels 已提交
7209 7210
            : base_iterator(it)
        {}
7211 7212

        /// create reverse iterator from base class
N
Niels 已提交
7213
        json_reverse_iterator(const base_iterator& it) noexcept
N
cleanup  
Niels 已提交
7214 7215
            : base_iterator(it)
        {}
7216 7217

        /// post-increment (it++)
N
Niels 已提交
7218
        json_reverse_iterator operator++(int)
7219 7220 7221 7222 7223
        {
            return base_iterator::operator++(1);
        }

        /// pre-increment (++it)
N
Niels 已提交
7224
        json_reverse_iterator& operator++()
7225 7226 7227 7228 7229 7230
        {
            base_iterator::operator++();
            return *this;
        }

        /// post-decrement (it--)
N
Niels 已提交
7231
        json_reverse_iterator operator--(int)
7232 7233 7234 7235 7236
        {
            return base_iterator::operator--(1);
        }

        /// pre-decrement (--it)
N
Niels 已提交
7237
        json_reverse_iterator& operator--()
7238 7239 7240 7241 7242 7243
        {
            base_iterator::operator--();
            return *this;
        }

        /// add to iterator
N
Niels 已提交
7244
        json_reverse_iterator& operator+=(difference_type i)
7245 7246 7247 7248 7249 7250
        {
            base_iterator::operator+=(i);
            return *this;
        }

        /// add to iterator
N
Niels 已提交
7251
        json_reverse_iterator operator+(difference_type i) const
7252 7253 7254 7255 7256 7257 7258
        {
            auto result = *this;
            result += i;
            return result;
        }

        /// subtract from iterator
N
Niels 已提交
7259
        json_reverse_iterator operator-(difference_type i) const
7260 7261 7262 7263 7264 7265 7266
        {
            auto result = *this;
            result -= i;
            return result;
        }

        /// return difference
N
Niels 已提交
7267
        difference_type operator-(const json_reverse_iterator& other) const
7268 7269 7270 7271 7272 7273 7274 7275 7276
        {
            return this->base() - other.base();
        }

        /// access to successor
        reference operator[](difference_type n) const
        {
            return *(this->operator+(n));
        }
N
Niels 已提交
7277

7278
        /// return the key of an object iterator
N
Niels 已提交
7279
        typename object_t::key_type key() const
7280
        {
N
Niels 已提交
7281 7282
            auto it = --this->base();
            return it.key();
7283 7284 7285
        }

        /// return the value of an iterator
N
Niels 已提交
7286
        reference value() const
7287
        {
N
Niels 已提交
7288 7289
            auto it = --this->base();
            return it.operator * ();
7290 7291 7292
        }
    };

N
Niels 已提交
7293

N
Niels 已提交
7294
  private:
N
Niels 已提交
7295 7296 7297
    //////////////////////
    // lexer and parser //
    //////////////////////
N
Niels 已提交
7298

N
Niels 已提交
7299 7300 7301 7302
    /*!
    @brief lexical analysis

    This class organizes the lexical analysis during JSON deserialization. The
7303
    core of it is a scanner generated by [re2c](http://re2c.org) that processes
7304
    a buffer and recognizes tokens according to RFC 7159.
N
Niels 已提交
7305
    */
N
Niels 已提交
7306
    class lexer
N
Niels 已提交
7307
    {
N
Niels 已提交
7308
      public:
N
Niels 已提交
7309 7310 7311
        /// token types for the parser
        enum class token_type
        {
N
Niels 已提交
7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325
            uninitialized,   ///< indicating the scanner is uninitialized
            literal_true,    ///< the "true" literal
            literal_false,   ///< the "false" literal
            literal_null,    ///< the "null" literal
            value_string,    ///< a string -- use get_string() for actual value
            value_number,    ///< a number -- use get_number() for actual value
            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 ","
            parse_error,     ///< indicating a parse error
            end_of_input     ///< indicating the end of the input buffer
N
Niels 已提交
7326 7327
        };

N
Niels 已提交
7328
        /// the char type to use in the lexer
N
Niels 已提交
7329
        using lexer_char_t = unsigned char;
N
Niels 已提交
7330

N
Niels 已提交
7331
        /// constructor with a given buffer
N
Niels 已提交
7332
        explicit lexer(const string_t& s) noexcept
N
Niels 已提交
7333
            : m_stream(nullptr), m_buffer(s)
N
Niels 已提交
7334
        {
N
Niels 已提交
7335
            m_content = reinterpret_cast<const lexer_char_t*>(s.c_str());
N
Niels 已提交
7336
            assert(m_content != nullptr);
N
Niels 已提交
7337
            m_start = m_cursor = m_content;
N
Niels 已提交
7338
            m_limit = m_content + s.size();
N
Niels 已提交
7339
        }
N
Niels 已提交
7340 7341

        /// constructor with a given stream
N
Niels 已提交
7342
        explicit lexer(std::istream* s) noexcept
N
Niels 已提交
7343
            : m_stream(s), m_buffer()
N
Niels 已提交
7344
        {
N
Niels 已提交
7345
            assert(m_stream != nullptr);
N
Niels 已提交
7346 7347
            getline(*m_stream, m_buffer);
            m_content = reinterpret_cast<const lexer_char_t*>(m_buffer.c_str());
N
Niels 已提交
7348
            assert(m_content != nullptr);
N
Niels 已提交
7349 7350 7351
            m_start = m_cursor = m_content;
            m_limit = m_content + m_buffer.size();
        }
N
Niels 已提交
7352

N
Niels 已提交
7353
        /// default constructor
N
Niels 已提交
7354
        lexer() = default;
N
Niels 已提交
7355

N
Niels 已提交
7356
        // switch off unwanted functions
N
Niels 已提交
7357 7358 7359
        lexer(const lexer&) = delete;
        lexer operator=(const lexer&) = delete;

N
Niels 已提交
7360 7361 7362
        /*!
        @brief create a string from a Unicode code point

N
Niels 已提交
7363 7364
        @param[in] codepoint1  the code point (can be high surrogate)
        @param[in] codepoint2  the code point (can be low surrogate or 0)
N
Niels 已提交
7365

N
Niels 已提交
7366
        @return string representation of the code point
N
Niels 已提交
7367

N
Niels 已提交
7368 7369
        @throw std::out_of_range if code point is >0x10ffff; example: `"code
        points above 0x10FFFF are invalid"`
N
Niels 已提交
7370 7371
        @throw std::invalid_argument if the low surrogate is invalid; example:
        `""missing or wrong low surrogate""`
N
Niels 已提交
7372 7373 7374

        @see <http://en.wikipedia.org/wiki/UTF-8#Sample_code>
        */
N
Niels 已提交
7375 7376
        static string_t to_unicode(const std::size_t codepoint1,
                                   const std::size_t codepoint2 = 0)
N
Niels 已提交
7377
        {
N
Niels 已提交
7378
            // calculate the codepoint from the given code points
N
Niels 已提交
7379
            std::size_t codepoint = codepoint1;
N
Niels 已提交
7380 7381

            // check if codepoint1 is a high surrogate
N
Niels 已提交
7382 7383
            if (codepoint1 >= 0xD800 and codepoint1 <= 0xDBFF)
            {
N
Niels 已提交
7384
                // check if codepoint2 is a low surrogate
N
Niels 已提交
7385 7386 7387 7388 7389 7390 7391 7392
                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 已提交
7393
                        // in the result so we have to subtract with:
N
Niels 已提交
7394 7395 7396 7397 7398 7399 7400 7401 7402
                        // (0xD800 << 10) + DC00 - 0x10000 = 0x35FDC00
                        - 0x35FDC00;
                }
                else
                {
                    throw std::invalid_argument("missing or wrong low surrogate");
                }
            }

N
Niels 已提交
7403 7404
            string_t result;

N
Niels 已提交
7405
            if (codepoint < 0x80)
N
Niels 已提交
7406
            {
N
Niels 已提交
7407
                // 1-byte characters: 0xxxxxxx (ASCII)
N
Niels 已提交
7408
                result.append(1, static_cast<typename string_t::value_type>(codepoint));
N
Niels 已提交
7409 7410 7411 7412
            }
            else if (codepoint <= 0x7ff)
            {
                // 2-byte characters: 110xxxxx 10xxxxxx
N
Niels 已提交
7413 7414
                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 已提交
7415 7416 7417 7418
            }
            else if (codepoint <= 0xffff)
            {
                // 3-byte characters: 1110xxxx 10xxxxxx 10xxxxxx
N
Niels 已提交
7419 7420 7421
                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 已提交
7422 7423 7424 7425
            }
            else if (codepoint <= 0x10ffff)
            {
                // 4-byte characters: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
N
Niels 已提交
7426 7427 7428 7429
                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 已提交
7430 7431 7432
            }
            else
            {
N
Niels 已提交
7433
                throw std::out_of_range("code points above 0x10FFFF are invalid");
N
Niels 已提交
7434 7435 7436 7437 7438
            }

            return result;
        }

7439
        /// return name of values of type token_type (only used for errors)
N
Niels 已提交
7440
        static std::string token_type_name(token_type t)
N
cleanup  
Niels 已提交
7441 7442 7443
        {
            switch (t)
            {
7444
                case token_type::uninitialized:
N
cleanup  
Niels 已提交
7445
                    return "<uninitialized>";
7446
                case token_type::literal_true:
N
cleanup  
Niels 已提交
7447
                    return "true literal";
7448
                case token_type::literal_false:
N
cleanup  
Niels 已提交
7449
                    return "false literal";
7450
                case token_type::literal_null:
N
cleanup  
Niels 已提交
7451
                    return "null literal";
7452
                case token_type::value_string:
N
cleanup  
Niels 已提交
7453
                    return "string literal";
7454
                case token_type::value_number:
N
cleanup  
Niels 已提交
7455
                    return "number literal";
7456
                case token_type::begin_array:
N
Niels 已提交
7457
                    return "'['";
7458
                case token_type::begin_object:
N
Niels 已提交
7459
                    return "'{'";
7460
                case token_type::end_array:
N
Niels 已提交
7461
                    return "']'";
7462
                case token_type::end_object:
N
Niels 已提交
7463
                    return "'}'";
7464
                case token_type::name_separator:
N
Niels 已提交
7465
                    return "':'";
7466
                case token_type::value_separator:
N
Niels 已提交
7467
                    return "','";
7468
                case token_type::parse_error:
N
Niels 已提交
7469
                    return "<parse error>";
7470
                case token_type::end_of_input:
N
Niels 已提交
7471
                    return "end of input";
N
Niels 已提交
7472 7473 7474 7475 7476
                default:
                {
                    // catch non-enum values
                    return "unknown token"; // LCOV_EXCL_LINE
                }
N
cleanup  
Niels 已提交
7477 7478 7479
            }
        }

N
fixes  
Niels 已提交
7480 7481
        /*!
        This function implements a scanner for JSON. It is specified using
7482
        regular expressions that try to follow RFC 7159 as close as possible.
7483 7484 7485 7486
        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 已提交
7487 7488 7489

        @return the class of the next token read from the buffer
        */
N
Niels 已提交
7490
        token_type scan() noexcept
N
Niels 已提交
7491
        {
N
cleanup  
Niels 已提交
7492
            // pointer for backtracking information
N
Niels 已提交
7493
            m_marker = nullptr;
N
Niels 已提交
7494 7495 7496

            // remember the begin of the token
            m_start = m_cursor;
N
Niels 已提交
7497
            assert(m_start != nullptr);
N
Niels 已提交
7498

N
Niels 已提交
7499 7500 7501 7502 7503 7504 7505 7506

            {
                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 已提交
7507 7508 7509 7510
                    128, 128, 128, 128, 128, 128, 128, 128,
                    128, 128, 128, 128, 128, 128, 128, 128,
                    160, 128,   0, 128, 128, 128, 128, 128,
                    128, 128, 128, 128, 128, 128, 128, 128,
N
Niels 已提交
7511
                    192, 192, 192, 192, 192, 192, 192, 192,
N
Niels 已提交
7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536
                    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,
N
Niels 已提交
7537 7538 7539 7540 7541 7542
                };
                if ((m_limit - m_cursor) < 5)
                {
                    yyfill();    // LCOV_EXCL_LINE;
                }
                yych = *m_cursor;
N
Niels 已提交
7543 7544 7545 7546 7547
                if (yybm[0 + yych] & 32)
                {
                    goto basic_json_parser_6;
                }
                if (yych <= '\\')
N
Niels 已提交
7548
                {
N
Niels 已提交
7549
                    if (yych <= '-')
N
Niels 已提交
7550
                    {
N
Niels 已提交
7551
                        if (yych <= '"')
N
Niels 已提交
7552 7553 7554
                        {
                            if (yych <= 0x00)
                            {
N
Niels 已提交
7555
                                goto basic_json_parser_2;
N
Niels 已提交
7556
                            }
N
Niels 已提交
7557
                            if (yych <= '!')
N
Niels 已提交
7558 7559 7560
                            {
                                goto basic_json_parser_4;
                            }
N
Niels 已提交
7561
                            goto basic_json_parser_9;
N
Niels 已提交
7562 7563 7564
                        }
                        else
                        {
N
Niels 已提交
7565
                            if (yych <= '+')
N
Niels 已提交
7566
                            {
N
Niels 已提交
7567
                                goto basic_json_parser_4;
N
Niels 已提交
7568
                            }
N
Niels 已提交
7569
                            if (yych <= ',')
N
Niels 已提交
7570
                            {
N
Niels 已提交
7571
                                goto basic_json_parser_10;
N
Niels 已提交
7572
                            }
N
Niels 已提交
7573
                            goto basic_json_parser_12;
N
Niels 已提交
7574 7575 7576 7577
                        }
                    }
                    else
                    {
N
Niels 已提交
7578
                        if (yych <= '9')
N
Niels 已提交
7579
                        {
N
Niels 已提交
7580
                            if (yych <= '/')
N
Niels 已提交
7581
                            {
N
Niels 已提交
7582
                                goto basic_json_parser_4;
N
Niels 已提交
7583
                            }
N
Niels 已提交
7584
                            if (yych <= '0')
N
Niels 已提交
7585
                            {
N
Niels 已提交
7586
                                goto basic_json_parser_13;
N
Niels 已提交
7587
                            }
N
Niels 已提交
7588
                            goto basic_json_parser_15;
N
Niels 已提交
7589 7590 7591
                        }
                        else
                        {
N
Niels 已提交
7592
                            if (yych <= ':')
N
Niels 已提交
7593
                            {
N
Niels 已提交
7594
                                goto basic_json_parser_17;
N
Niels 已提交
7595
                            }
N
Niels 已提交
7596
                            if (yych == '[')
N
Niels 已提交
7597
                            {
N
Niels 已提交
7598
                                goto basic_json_parser_19;
N
Niels 已提交
7599
                            }
N
Niels 已提交
7600
                            goto basic_json_parser_4;
N
Niels 已提交
7601
                        }
N
Niels 已提交
7602 7603
                    }
                }
N
Niels 已提交
7604 7605
                else
                {
N
Niels 已提交
7606
                    if (yych <= 't')
N
Niels 已提交
7607
                    {
N
Niels 已提交
7608
                        if (yych <= 'f')
N
Niels 已提交
7609
                        {
N
Niels 已提交
7610
                            if (yych <= ']')
N
Niels 已提交
7611
                            {
N
Niels 已提交
7612
                                goto basic_json_parser_21;
N
Niels 已提交
7613
                            }
N
Niels 已提交
7614
                            if (yych <= 'e')
N
Niels 已提交
7615
                            {
N
Niels 已提交
7616
                                goto basic_json_parser_4;
N
Niels 已提交
7617
                            }
N
Niels 已提交
7618
                            goto basic_json_parser_23;
N
Niels 已提交
7619 7620 7621
                        }
                        else
                        {
N
Niels 已提交
7622
                            if (yych == 'n')
N
Niels 已提交
7623
                            {
N
Niels 已提交
7624
                                goto basic_json_parser_24;
N
Niels 已提交
7625
                            }
N
Niels 已提交
7626
                            if (yych <= 's')
N
Niels 已提交
7627
                            {
N
Niels 已提交
7628
                                goto basic_json_parser_4;
N
Niels 已提交
7629
                            }
N
Niels 已提交
7630
                            goto basic_json_parser_25;
N
Niels 已提交
7631 7632 7633 7634
                        }
                    }
                    else
                    {
N
Niels 已提交
7635
                        if (yych <= '|')
N
Niels 已提交
7636
                        {
N
Niels 已提交
7637
                            if (yych == '{')
N
Niels 已提交
7638
                            {
N
Niels 已提交
7639
                                goto basic_json_parser_26;
N
Niels 已提交
7640
                            }
N
Niels 已提交
7641
                            goto basic_json_parser_4;
N
Niels 已提交
7642 7643 7644 7645 7646
                        }
                        else
                        {
                            if (yych <= '}')
                            {
N
Niels 已提交
7647
                                goto basic_json_parser_28;
N
Niels 已提交
7648
                            }
N
Niels 已提交
7649
                            if (yych == 0xEF)
N
Niels 已提交
7650 7651 7652
                            {
                                goto basic_json_parser_30;
                            }
N
Niels 已提交
7653
                            goto basic_json_parser_4;
N
Niels 已提交
7654
                        }
N
Niels 已提交
7655
                    }
N
Niels 已提交
7656 7657
                }
basic_json_parser_2:
N
Niels 已提交
7658 7659
                ++m_cursor;
                {
N
Niels 已提交
7660
                    return token_type::end_of_input;
N
Niels 已提交
7661
                }
N
Niels 已提交
7662
basic_json_parser_4:
N
Niels 已提交
7663
                ++m_cursor;
N
Niels 已提交
7664 7665 7666 7667 7668 7669
basic_json_parser_5:
                {
                    return token_type::parse_error;
                }
basic_json_parser_6:
                ++m_cursor;
N
Niels 已提交
7670 7671 7672 7673 7674 7675 7676
                if (m_limit <= m_cursor)
                {
                    yyfill();    // LCOV_EXCL_LINE;
                }
                yych = *m_cursor;
                if (yybm[0 + yych] & 32)
                {
N
Niels 已提交
7677
                    goto basic_json_parser_6;
N
Niels 已提交
7678 7679
                }
                {
N
Niels 已提交
7680
                    return scan();
N
Niels 已提交
7681
                }
N
Niels 已提交
7682 7683 7684 7685
basic_json_parser_9:
                yyaccept = 0;
                yych = *(m_marker = ++m_cursor);
                if (yych <= 0x0F)
N
Niels 已提交
7686
                {
N
Niels 已提交
7687
                    goto basic_json_parser_5;
N
Niels 已提交
7688
                }
N
Niels 已提交
7689
                goto basic_json_parser_32;
N
Niels 已提交
7690
basic_json_parser_10:
N
Niels 已提交
7691 7692
                ++m_cursor;
                {
N
Niels 已提交
7693
                    return token_type::value_separator;
N
Niels 已提交
7694
                }
N
Niels 已提交
7695
basic_json_parser_12:
N
Niels 已提交
7696 7697
                yych = *++m_cursor;
                if (yych <= '/')
N
Niels 已提交
7698
                {
N
Niels 已提交
7699
                    goto basic_json_parser_5;
N
Niels 已提交
7700
                }
N
Niels 已提交
7701
                if (yych <= '0')
N
Niels 已提交
7702
                {
N
Niels 已提交
7703
                    goto basic_json_parser_13;
N
Niels 已提交
7704
                }
N
Niels 已提交
7705
                if (yych <= '9')
N
Niels 已提交
7706
                {
N
Niels 已提交
7707
                    goto basic_json_parser_15;
N
Niels 已提交
7708
                }
N
Niels 已提交
7709 7710 7711
                goto basic_json_parser_5;
basic_json_parser_13:
                yyaccept = 1;
N
Niels 已提交
7712
                yych = *(m_marker = ++m_cursor);
N
Niels 已提交
7713
                if (yych <= 'D')
N
Niels 已提交
7714
                {
N
Niels 已提交
7715 7716 7717 7718
                    if (yych == '.')
                    {
                        goto basic_json_parser_37;
                    }
N
Niels 已提交
7719
                }
N
Niels 已提交
7720
                else
N
Niels 已提交
7721
                {
N
Niels 已提交
7722 7723 7724 7725 7726 7727 7728 7729
                    if (yych <= 'E')
                    {
                        goto basic_json_parser_38;
                    }
                    if (yych == 'e')
                    {
                        goto basic_json_parser_38;
                    }
N
Niels 已提交
7730
                }
N
Niels 已提交
7731
basic_json_parser_14:
N
Niels 已提交
7732
                {
N
Niels 已提交
7733
                    return token_type::value_number;
N
Niels 已提交
7734
                }
N
Niels 已提交
7735 7736 7737 7738
basic_json_parser_15:
                yyaccept = 1;
                m_marker = ++m_cursor;
                if ((m_limit - m_cursor) < 3)
N
Niels 已提交
7739
                {
N
Niels 已提交
7740
                    yyfill();    // LCOV_EXCL_LINE;
N
Niels 已提交
7741
                }
N
Niels 已提交
7742 7743
                yych = *m_cursor;
                if (yybm[0 + yych] & 64)
N
Niels 已提交
7744
                {
N
Niels 已提交
7745
                    goto basic_json_parser_15;
N
Niels 已提交
7746 7747 7748 7749 7750
                }
                if (yych <= 'D')
                {
                    if (yych == '.')
                    {
N
Niels 已提交
7751
                        goto basic_json_parser_37;
N
Niels 已提交
7752
                    }
N
Niels 已提交
7753
                    goto basic_json_parser_14;
N
Niels 已提交
7754 7755 7756 7757 7758
                }
                else
                {
                    if (yych <= 'E')
                    {
N
Niels 已提交
7759
                        goto basic_json_parser_38;
N
Niels 已提交
7760 7761 7762
                    }
                    if (yych == 'e')
                    {
N
Niels 已提交
7763
                        goto basic_json_parser_38;
N
Niels 已提交
7764
                    }
N
Niels 已提交
7765
                    goto basic_json_parser_14;
N
Niels 已提交
7766
                }
N
Niels 已提交
7767 7768
basic_json_parser_17:
                ++m_cursor;
N
Niels 已提交
7769
                {
N
Niels 已提交
7770
                    return token_type::name_separator;
N
Niels 已提交
7771
                }
N
Niels 已提交
7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783
basic_json_parser_19:
                ++m_cursor;
                {
                    return token_type::begin_array;
                }
basic_json_parser_21:
                ++m_cursor;
                {
                    return token_type::end_array;
                }
basic_json_parser_23:
                yyaccept = 0;
N
Niels 已提交
7784
                yych = *(m_marker = ++m_cursor);
N
Niels 已提交
7785 7786 7787 7788 7789 7790
                if (yych == 'a')
                {
                    goto basic_json_parser_39;
                }
                goto basic_json_parser_5;
basic_json_parser_24:
N
Niels 已提交
7791 7792
                yyaccept = 0;
                yych = *(m_marker = ++m_cursor);
N
Niels 已提交
7793
                if (yych == 'u')
N
Niels 已提交
7794
                {
N
Niels 已提交
7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809
                    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;
                {
                    return token_type::begin_object;
N
Niels 已提交
7810
                }
N
Niels 已提交
7811
basic_json_parser_28:
N
Niels 已提交
7812 7813
                ++m_cursor;
                {
N
Niels 已提交
7814
                    return token_type::end_object;
N
Niels 已提交
7815
                }
N
Niels 已提交
7816
basic_json_parser_30:
N
Niels 已提交
7817 7818 7819 7820 7821 7822 7823
                yyaccept = 0;
                yych = *(m_marker = ++m_cursor);
                if (yych == 0xBB)
                {
                    goto basic_json_parser_42;
                }
                goto basic_json_parser_5;
N
Niels 已提交
7824
basic_json_parser_31:
N
Niels 已提交
7825 7826 7827 7828 7829 7830
                ++m_cursor;
                if (m_limit <= m_cursor)
                {
                    yyfill();    // LCOV_EXCL_LINE;
                }
                yych = *m_cursor;
N
Niels 已提交
7831
basic_json_parser_32:
N
Niels 已提交
7832
                if (yybm[0 + yych] & 128)
N
Niels 已提交
7833
                {
T
Trevor Welsby 已提交
7834
                    goto basic_json_parser_31;
N
Niels 已提交
7835
                }
N
Niels 已提交
7836 7837
                if (yych <= 0x0F)
                {
T
Trevor Welsby 已提交
7838
                    goto basic_json_parser_33;
N
Niels 已提交
7839
                }
N
Niels 已提交
7840 7841
                if (yych <= '"')
                {
N
Niels 已提交
7842
                    goto basic_json_parser_34;
N
Niels 已提交
7843
                }
N
Niels 已提交
7844
                goto basic_json_parser_36;
N
Niels 已提交
7845 7846 7847 7848
basic_json_parser_33:
                m_cursor = m_marker;
                if (yyaccept == 0)
                {
N
Niels 已提交
7849
                    goto basic_json_parser_5;
N
Niels 已提交
7850 7851 7852
                }
                else
                {
N
Niels 已提交
7853
                    goto basic_json_parser_14;
N
Niels 已提交
7854 7855
                }
basic_json_parser_34:
N
Niels 已提交
7856 7857 7858 7859 7860
                ++m_cursor;
                {
                    return token_type::value_string;
                }
basic_json_parser_36:
N
Niels 已提交
7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932
                ++m_cursor;
                if (m_limit <= m_cursor)
                {
                    yyfill();    // LCOV_EXCL_LINE;
                }
                yych = *m_cursor;
                if (yych <= 'e')
                {
                    if (yych <= '/')
                    {
                        if (yych == '"')
                        {
                            goto basic_json_parser_31;
                        }
                        if (yych <= '.')
                        {
                            goto basic_json_parser_33;
                        }
                        goto basic_json_parser_31;
                    }
                    else
                    {
                        if (yych <= '\\')
                        {
                            if (yych <= '[')
                            {
                                goto basic_json_parser_33;
                            }
                            goto basic_json_parser_31;
                        }
                        else
                        {
                            if (yych == 'b')
                            {
                                goto basic_json_parser_31;
                            }
                            goto basic_json_parser_33;
                        }
                    }
                }
                else
                {
                    if (yych <= 'q')
                    {
                        if (yych <= 'f')
                        {
                            goto basic_json_parser_31;
                        }
                        if (yych == 'n')
                        {
                            goto basic_json_parser_31;
                        }
                        goto basic_json_parser_33;
                    }
                    else
                    {
                        if (yych <= 's')
                        {
                            if (yych <= 'r')
                            {
                                goto basic_json_parser_31;
                            }
                            goto basic_json_parser_33;
                        }
                        else
                        {
                            if (yych <= 't')
                            {
                                goto basic_json_parser_31;
                            }
                            if (yych <= 'u')
                            {
N
Niels 已提交
7933
                                goto basic_json_parser_43;
N
Niels 已提交
7934 7935 7936 7937 7938
                            }
                            goto basic_json_parser_33;
                        }
                    }
                }
N
Niels 已提交
7939
basic_json_parser_37:
N
Niels 已提交
7940 7941
                yych = *++m_cursor;
                if (yych <= '/')
N
Niels 已提交
7942
                {
N
Niels 已提交
7943
                    goto basic_json_parser_33;
N
Niels 已提交
7944
                }
N
Niels 已提交
7945
                if (yych <= '9')
N
Niels 已提交
7946
                {
N
Niels 已提交
7947
                    goto basic_json_parser_44;
N
Niels 已提交
7948
                }
N
Niels 已提交
7949
                goto basic_json_parser_33;
N
Niels 已提交
7950
basic_json_parser_38:
N
Niels 已提交
7951 7952
                yych = *++m_cursor;
                if (yych <= ',')
N
Niels 已提交
7953
                {
N
Niels 已提交
7954
                    if (yych == '+')
N
Niels 已提交
7955
                    {
N
Niels 已提交
7956
                        goto basic_json_parser_46;
N
Niels 已提交
7957
                    }
N
Niels 已提交
7958
                    goto basic_json_parser_33;
N
Niels 已提交
7959
                }
N
Niels 已提交
7960
                else
N
Niels 已提交
7961
                {
N
Niels 已提交
7962
                    if (yych <= '-')
N
Niels 已提交
7963
                    {
N
Niels 已提交
7964
                        goto basic_json_parser_46;
N
Niels 已提交
7965
                    }
N
Niels 已提交
7966
                    if (yych <= '/')
N
Niels 已提交
7967 7968 7969
                    {
                        goto basic_json_parser_33;
                    }
N
Niels 已提交
7970
                    if (yych <= '9')
N
Niels 已提交
7971
                    {
N
Niels 已提交
7972
                        goto basic_json_parser_47;
N
Niels 已提交
7973
                    }
N
Niels 已提交
7974
                    goto basic_json_parser_33;
N
Niels 已提交
7975
                }
N
Niels 已提交
7976
basic_json_parser_39:
N
Niels 已提交
7977 7978
                yych = *++m_cursor;
                if (yych == 'l')
N
Niels 已提交
7979
                {
N
Niels 已提交
7980
                    goto basic_json_parser_49;
N
Niels 已提交
7981
                }
N
Niels 已提交
7982 7983 7984 7985
                goto basic_json_parser_33;
basic_json_parser_40:
                yych = *++m_cursor;
                if (yych == 'l')
N
Niels 已提交
7986
                {
N
Niels 已提交
7987
                    goto basic_json_parser_50;
N
Niels 已提交
7988
                }
N
Niels 已提交
7989 7990 7991 7992
                goto basic_json_parser_33;
basic_json_parser_41:
                yych = *++m_cursor;
                if (yych == 'u')
N
Niels 已提交
7993
                {
N
Niels 已提交
7994
                    goto basic_json_parser_51;
N
Niels 已提交
7995
                }
N
Niels 已提交
7996 7997 7998 7999 8000 8001 8002 8003 8004
                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:
N
Niels 已提交
8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018
                ++m_cursor;
                if (m_limit <= m_cursor)
                {
                    yyfill();    // LCOV_EXCL_LINE;
                }
                yych = *m_cursor;
                if (yych <= '@')
                {
                    if (yych <= '/')
                    {
                        goto basic_json_parser_33;
                    }
                    if (yych <= '9')
                    {
N
Niels 已提交
8019
                        goto basic_json_parser_54;
N
Niels 已提交
8020 8021 8022 8023 8024 8025 8026
                    }
                    goto basic_json_parser_33;
                }
                else
                {
                    if (yych <= 'F')
                    {
N
Niels 已提交
8027
                        goto basic_json_parser_54;
N
Niels 已提交
8028 8029 8030 8031 8032 8033 8034
                    }
                    if (yych <= '`')
                    {
                        goto basic_json_parser_33;
                    }
                    if (yych <= 'f')
                    {
N
Niels 已提交
8035
                        goto basic_json_parser_54;
N
Niels 已提交
8036 8037 8038
                    }
                    goto basic_json_parser_33;
                }
N
Niels 已提交
8039
basic_json_parser_44:
N
Niels 已提交
8040 8041 8042 8043 8044 8045 8046 8047 8048
                yyaccept = 1;
                m_marker = ++m_cursor;
                if ((m_limit - m_cursor) < 3)
                {
                    yyfill();    // LCOV_EXCL_LINE;
                }
                yych = *m_cursor;
                if (yych <= 'D')
                {
N
Niels 已提交
8049
                    if (yych <= '/')
N
Niels 已提交
8050
                    {
N
Niels 已提交
8051
                        goto basic_json_parser_14;
N
Niels 已提交
8052
                    }
N
Niels 已提交
8053
                    if (yych <= '9')
N
Niels 已提交
8054 8055 8056
                    {
                        goto basic_json_parser_44;
                    }
N
Niels 已提交
8057
                    goto basic_json_parser_14;
N
Niels 已提交
8058 8059 8060
                }
                else
                {
N
Niels 已提交
8061
                    if (yych <= 'E')
N
Niels 已提交
8062
                    {
N
Niels 已提交
8063
                        goto basic_json_parser_38;
N
Niels 已提交
8064
                    }
N
Niels 已提交
8065
                    if (yych == 'e')
N
Niels 已提交
8066
                    {
N
Niels 已提交
8067
                        goto basic_json_parser_38;
N
Niels 已提交
8068
                    }
N
Niels 已提交
8069
                    goto basic_json_parser_14;
N
Niels 已提交
8070
                }
N
Niels 已提交
8071
basic_json_parser_46:
N
Niels 已提交
8072 8073 8074 8075 8076 8077 8078 8079 8080
                yych = *++m_cursor;
                if (yych <= '/')
                {
                    goto basic_json_parser_33;
                }
                if (yych >= ':')
                {
                    goto basic_json_parser_33;
                }
N
Niels 已提交
8081
basic_json_parser_47:
N
Niels 已提交
8082 8083 8084 8085 8086 8087 8088 8089
                ++m_cursor;
                if (m_limit <= m_cursor)
                {
                    yyfill();    // LCOV_EXCL_LINE;
                }
                yych = *m_cursor;
                if (yych <= '/')
                {
N
Niels 已提交
8090
                    goto basic_json_parser_14;
N
Niels 已提交
8091 8092 8093
                }
                if (yych <= '9')
                {
N
Niels 已提交
8094
                    goto basic_json_parser_47;
N
Niels 已提交
8095
                }
N
Niels 已提交
8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125
                goto basic_json_parser_14;
basic_json_parser_49:
                yych = *++m_cursor;
                if (yych == 's')
                {
                    goto basic_json_parser_55;
                }
                goto basic_json_parser_33;
basic_json_parser_50:
                yych = *++m_cursor;
                if (yych == 'l')
                {
                    goto basic_json_parser_56;
                }
                goto basic_json_parser_33;
basic_json_parser_51:
                yych = *++m_cursor;
                if (yych == 'e')
                {
                    goto basic_json_parser_58;
                }
                goto basic_json_parser_33;
basic_json_parser_52:
                ++m_cursor;
                {
                    return scan();
                }
basic_json_parser_54:
                ++m_cursor;
                if (m_limit <= m_cursor)
N
Niels 已提交
8126 8127 8128 8129
                {
                    yyfill();    // LCOV_EXCL_LINE;
                }
                yych = *m_cursor;
N
Niels 已提交
8130
                if (yych <= '@')
N
Niels 已提交
8131 8132 8133
                {
                    if (yych <= '/')
                    {
N
Niels 已提交
8134
                        goto basic_json_parser_33;
N
Niels 已提交
8135 8136 8137
                    }
                    if (yych <= '9')
                    {
N
Niels 已提交
8138
                        goto basic_json_parser_60;
N
Niels 已提交
8139
                    }
N
Niels 已提交
8140
                    goto basic_json_parser_33;
N
Niels 已提交
8141 8142 8143
                }
                else
                {
N
Niels 已提交
8144
                    if (yych <= 'F')
N
Niels 已提交
8145
                    {
N
Niels 已提交
8146
                        goto basic_json_parser_60;
N
Niels 已提交
8147
                    }
N
Niels 已提交
8148
                    if (yych <= '`')
N
Niels 已提交
8149
                    {
N
Niels 已提交
8150
                        goto basic_json_parser_33;
N
Niels 已提交
8151
                    }
N
Niels 已提交
8152
                    if (yych <= 'f')
N
Niels 已提交
8153
                    {
N
Niels 已提交
8154
                        goto basic_json_parser_60;
N
Niels 已提交
8155 8156
                    }
                    goto basic_json_parser_33;
N
Niels 已提交
8157
                }
N
Niels 已提交
8158
basic_json_parser_55:
N
Niels 已提交
8159
                yych = *++m_cursor;
N
Niels 已提交
8160
                if (yych == 'e')
N
Niels 已提交
8161
                {
N
Niels 已提交
8162
                    goto basic_json_parser_61;
N
Niels 已提交
8163
                }
N
Niels 已提交
8164 8165 8166
                goto basic_json_parser_33;
basic_json_parser_56:
                ++m_cursor;
N
Niels 已提交
8167
                {
N
Niels 已提交
8168
                    return token_type::literal_null;
N
Niels 已提交
8169
                }
N
Niels 已提交
8170
basic_json_parser_58:
N
Niels 已提交
8171
                ++m_cursor;
N
Niels 已提交
8172
                {
N
Niels 已提交
8173
                    return token_type::literal_true;
N
Niels 已提交
8174
                }
N
Niels 已提交
8175 8176 8177
basic_json_parser_60:
                ++m_cursor;
                if (m_limit <= m_cursor)
N
Niels 已提交
8178
                {
N
Niels 已提交
8179
                    yyfill();    // LCOV_EXCL_LINE;
N
Niels 已提交
8180
                }
N
Niels 已提交
8181 8182
                yych = *m_cursor;
                if (yych <= '@')
N
Niels 已提交
8183
                {
N
Niels 已提交
8184 8185 8186 8187 8188 8189 8190 8191
                    if (yych <= '/')
                    {
                        goto basic_json_parser_33;
                    }
                    if (yych <= '9')
                    {
                        goto basic_json_parser_63;
                    }
N
Niels 已提交
8192 8193
                    goto basic_json_parser_33;
                }
N
Niels 已提交
8194
                else
N
Niels 已提交
8195
                {
N
Niels 已提交
8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207
                    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 已提交
8208
                    goto basic_json_parser_33;
N
Niels 已提交
8209
                }
N
Niels 已提交
8210 8211
basic_json_parser_61:
                ++m_cursor;
N
Niels 已提交
8212
                {
N
Niels 已提交
8213
                    return token_type::literal_false;
N
Niels 已提交
8214
                }
N
Niels 已提交
8215
basic_json_parser_63:
N
Niels 已提交
8216
                ++m_cursor;
N
Niels 已提交
8217
                if (m_limit <= m_cursor)
N
Niels 已提交
8218
                {
N
Niels 已提交
8219
                    yyfill();    // LCOV_EXCL_LINE;
N
Niels 已提交
8220
                }
N
Niels 已提交
8221 8222
                yych = *m_cursor;
                if (yych <= '@')
N
Niels 已提交
8223
                {
N
Niels 已提交
8224 8225 8226 8227 8228 8229 8230 8231
                    if (yych <= '/')
                    {
                        goto basic_json_parser_33;
                    }
                    if (yych <= '9')
                    {
                        goto basic_json_parser_31;
                    }
N
Niels 已提交
8232
                    goto basic_json_parser_33;
N
Niels 已提交
8233
                }
N
Niels 已提交
8234
                else
N
Niels 已提交
8235
                {
N
Niels 已提交
8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248
                    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 已提交
8249
                }
N
Niels 已提交
8250
            }
N
Niels 已提交
8251

N
Niels 已提交
8252 8253 8254
        }

        /// append data from the stream to the internal buffer
N
Niels 已提交
8255
        void yyfill() noexcept
N
Niels 已提交
8256
        {
N
Niels 已提交
8257
            if (m_stream == nullptr or not * m_stream)
N
Niels 已提交
8258 8259 8260 8261
            {
                return;
            }

8262 8263 8264
            const auto offset_start = m_start - m_content;
            const auto offset_marker = m_marker - m_start;
            const auto offset_cursor = m_cursor - m_start;
N
Niels 已提交
8265 8266 8267

            m_buffer.erase(0, static_cast<size_t>(offset_start));
            std::string line;
N
Niels 已提交
8268
            assert(m_stream != nullptr);
N
Niels 已提交
8269
            std::getline(*m_stream, line);
N
Niels 已提交
8270
            m_buffer += "\n" + line; // add line with newline symbol
N
Niels 已提交
8271 8272

            m_content = reinterpret_cast<const lexer_char_t*>(m_buffer.c_str());
N
Niels 已提交
8273
            assert(m_content != nullptr);
N
Niels 已提交
8274 8275 8276 8277
            m_start  = m_content;
            m_marker = m_start + offset_marker;
            m_cursor = m_start + offset_cursor;
            m_limit  = m_start + m_buffer.size() - 1;
N
Niels 已提交
8278 8279
        }

N
Niels 已提交
8280
        /// return string representation of last read token
N
Niels 已提交
8281
        string_t get_token() const
N
Niels 已提交
8282
        {
N
Niels 已提交
8283
            assert(m_start != nullptr);
N
Niels 已提交
8284 8285
            return string_t(reinterpret_cast<typename string_t::const_pointer>(m_start),
                            static_cast<size_t>(m_cursor - m_start));
N
Niels 已提交
8286 8287 8288
        }

        /*!
N
Niels 已提交
8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299
        @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 已提交
8300 8301 8302
           characters (e.g., `"\\n"` is replaced by `"\n"`), some are copied as
           is (e.g., `"\\\\"`). Furthermore, Unicode escapes of the shape
           `"\\uxxxx"` need special care. In this case, to_unicode takes care
N
Niels 已提交
8303 8304
           of the construction of the values.
        2. Unescaped characters are copied as is.
N
Niels 已提交
8305 8306

        @return string value of current token without opening and closing quotes
N
Niels 已提交
8307
        @throw std::out_of_range if to_unicode fails
N
Niels 已提交
8308
        */
N
Niels 已提交
8309
        string_t get_string() const
N
Niels 已提交
8310
        {
N
Niels 已提交
8311
            string_t result;
N
Niels 已提交
8312 8313 8314
            result.reserve(static_cast<size_t>(m_cursor - m_start - 2));

            // iterate the result between the quotes
N
Niels 已提交
8315
            for (const lexer_char_t* i = m_start + 1; i < m_cursor - 1; ++i)
N
Niels 已提交
8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352
            {
                // 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 已提交
8353
                            result += "\\";
N
Niels 已提交
8354 8355 8356 8357
                            break;
                        }
                        case '/':
                        {
N
Niels 已提交
8358
                            result += "/";
N
Niels 已提交
8359 8360 8361 8362
                            break;
                        }
                        case '"':
                        {
N
Niels 已提交
8363
                            result += "\"";
N
Niels 已提交
8364 8365 8366 8367 8368 8369
                            break;
                        }

                        // unicode
                        case 'u':
                        {
N
Niels 已提交
8370
                            // get code xxxx from uxxxx
N
Niels 已提交
8371 8372
                            auto codepoint = std::strtoul(std::string(reinterpret_cast<typename string_t::const_pointer>(i + 1),
                                                          4).c_str(), nullptr, 16);
N
Niels 已提交
8373

N
Niels 已提交
8374
                            // check if codepoint is a high surrogate
N
Niels 已提交
8375 8376
                            if (codepoint >= 0xD800 and codepoint <= 0xDBFF)
                            {
N
Niels 已提交
8377
                                // make sure there is a subsequent unicode
N
Niels 已提交
8378
                                if ((i + 6 >= m_limit) or * (i + 5) != '\\' or * (i + 6) != 'u')
N
Niels 已提交
8379 8380 8381 8382
                                {
                                    throw std::invalid_argument("missing low surrogate");
                                }

N
Niels 已提交
8383
                                // get code yyyy from uxxxx\uyyyy
N
Niels 已提交
8384 8385
                                auto codepoint2 = std::strtoul(std::string(reinterpret_cast<typename string_t::const_pointer>
                                                               (i + 7), 4).c_str(), nullptr, 16);
N
Niels 已提交
8386
                                result += to_unicode(codepoint, codepoint2);
8387 8388
                                // skip the next 10 characters (xxxx\uyyyy)
                                i += 10;
N
Niels 已提交
8389 8390 8391 8392 8393 8394 8395 8396
                            }
                            else
                            {
                                // add unicode character(s)
                                result += to_unicode(codepoint);
                                // skip the next four characters (xxxx)
                                i += 4;
                            }
N
Niels 已提交
8397 8398 8399 8400 8401 8402 8403 8404
                            break;
                        }
                    }
                }
                else
                {
                    // all other characters are just copied to the end of the
                    // string
N
Niels 已提交
8405
                    result.append(1, static_cast<typename string_t::value_type>(*i));
N
Niels 已提交
8406 8407 8408 8409
                }
            }

            return result;
N
Niels 已提交
8410 8411
        }

8412 8413 8414 8415
        /*!
        @brief parse floating point number

        This function (and its overloads) serves to select the most approprate
8416 8417 8418
        standard floating point number parsing function based on the type
        supplied via the first parameter.  Set this to
        @a static_cast<number_float_t*>(nullptr).
8419

N
Niels 已提交
8420
        @param[in] type  the @ref number_float_t in use
8421

N
Niels 已提交
8422 8423
        @param[in,out] endptr recieves a pointer to the first character after
        the number
8424 8425

        @return the floating point number
N
Niels 已提交
8426

N
Niels 已提交
8427 8428 8429 8430
        @bug This function uses `std::strtof`, `std::strtod`, or `std::strtold`
        which use the current C locale to determine which character is used as
        decimal point character. This may yield to parse errors if the locale
        does not used `.`.
8431
        */
8432
        long double str_to_float_t(long double* /* type */, char** endptr) const
8433 8434 8435 8436
        {
            return std::strtold(reinterpret_cast<typename string_t::const_pointer>(m_start), endptr);
        }

8437 8438 8439 8440 8441 8442 8443 8444
        /*!
        @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
        supplied via the first parameter.  Set this to
        @a static_cast<number_float_t*>(nullptr).

N
Niels 已提交
8445
        @param[in] type  the @ref number_float_t in use
8446

N
Niels 已提交
8447 8448
        @param[in,out] endptr  recieves a pointer to the first character after
        the number
8449 8450 8451

        @return the floating point number
        */
8452
        double str_to_float_t(double* /* type */, char** endptr) const
8453 8454 8455 8456
        {
            return std::strtod(reinterpret_cast<typename string_t::const_pointer>(m_start), endptr);
        }

8457 8458 8459 8460 8461 8462 8463 8464
        /*!
        @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
        supplied via the first parameter.  Set this to
        @a static_cast<number_float_t*>(nullptr).

N
Niels 已提交
8465
        @param[in] type  the @ref number_float_t in use
8466

N
Niels 已提交
8467 8468
        @param[in,out] endptr  recieves a pointer to the first character after
        the number
8469 8470 8471

        @return the floating point number
        */
8472
        float str_to_float_t(float* /* type */, char** endptr) const
8473 8474 8475 8476
        {
            return std::strtof(reinterpret_cast<typename string_t::const_pointer>(m_start), endptr);
        }

8477 8478
        /*!
        @brief return number value for number tokens
N
Niels 已提交
8479

N
Niels 已提交
8480
        This function translates the last token into the most appropriate
N
Niels 已提交
8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502
        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
        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.

        The 'floating point representation' includes the number of significant
        figures after the radix point, whether the number is in exponential
        or decimal form, the capitalization of the exponent marker, and if the
        optional '+' is present in the exponent. This information is necessary
        to perform accurate round trips of floating point numbers.

        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
          NAN if the conversion read past the current token. The latter case
          needs to be treated by the caller function.
N
Niels 已提交
8503
        */
8504
        void get_number(basic_json& result) const
N
Niels 已提交
8505
        {
N
Niels 已提交
8506
            assert(m_start != nullptr);
N
Niels 已提交
8507

N
Niels 已提交
8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529
            const lexer::lexer_char_t* curptr = m_start;

            // remember this number was parsed (for later serialization)
            result.m_type.bits.parsed = true;

            // 'found_radix_point' will be set to 0xFF upon finding a radix
            // point and later used to mask in/out the precision depending
            // whether a radix is found i.e. 'precision &= found_radix_point'
            uint8_t found_radix_point = 0;
            uint8_t precision = 0;

            // 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 == '-')
8530
            {
N
Niels 已提交
8531 8532 8533 8534 8535 8536 8537 8538 8539
                type = value_t::number_integer;
                max = static_cast<uint64_t>(std::numeric_limits<number_integer_t>::max()) + 1;
                curptr++;
            }
            else
            {
                type = value_t::number_unsigned;
                max = static_cast<uint64_t>(std::numeric_limits<number_unsigned_t>::max());
                if (*curptr == '+')
N
Niels 已提交
8540
                {
N
Niels 已提交
8541
                    curptr++;
N
Niels 已提交
8542
                }
8543
            }
N
Niels 已提交
8544 8545 8546

            // count the significant figures
            for (; curptr < m_cursor; curptr++)
8547
            {
N
Niels 已提交
8548 8549
                // quickly skip tests if a digit
                if (*curptr < '0' || *curptr > '9')
N
Niels 已提交
8550
                {
N
Niels 已提交
8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571
                    if (*curptr == '.')
                    {
                        // don't count '.' but change to float
                        type = value_t::number_float;

                        // reset precision count
                        precision = 0;
                        found_radix_point = 0xFF;
                        continue;
                    }
                    // assume exponent (if not then will fail parse): change to
                    // float, stop counting and record exponent details
                    type = value_t::number_float;
                    result.m_type.bits.has_exp = true;

                    // exponent capitalization
                    result.m_type.bits.exp_cap = (*curptr == 'E');

                    // exponent '+' sign
                    result.m_type.bits.exp_plus = (*(++curptr) == '+');
                    break;
N
Niels 已提交
8572
                }
N
Niels 已提交
8573 8574 8575

                // skip if definitely not an integer
                if (type != value_t::number_float)
N
Niels 已提交
8576
                {
N
Niels 已提交
8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590
                    // multiply last value by ten and add the new digit
                    auto temp = value * 10 + *curptr - 0x30;

                    // test for overflow
                    if (temp < value || temp > max)
                    {
                        // overflow
                        type = value_t::number_float;
                    }
                    else
                    {
                        // no overflow - save it
                        value = temp;
                    }
N
Niels 已提交
8591
                }
N
Niels 已提交
8592
                ++precision;
8593
            }
N
Niels 已提交
8594

N
Niels 已提交
8595 8596 8597 8598 8599 8600
            // If no radix point was found then precision would now be set to
            // the number of digits, which is wrong - clear it.
            result.m_type.bits.precision = precision & found_radix_point;

            // save the value (if not a float)
            if (type == value_t::number_unsigned)
N
Niels 已提交
8601
            {
N
Niels 已提交
8602
                result.m_value.number_unsigned = value;
N
Niels 已提交
8603
            }
N
Niels 已提交
8604 8605 8606 8607 8608
            else if (type == value_t::number_integer)
            {
                result.m_value.number_integer = -static_cast<number_integer_t>(value);
            }
            else
8609
            {
N
Niels 已提交
8610
                // parse with strtod
N
Niels 已提交
8611
                result.m_value.number_float = str_to_float_t(static_cast<number_float_t*>(nullptr), NULL);
8612
            }
N
Niels 已提交
8613 8614 8615

            // save the type
            result.m_type = type;
N
Niels 已提交
8616 8617 8618
        }

      private:
N
Niels 已提交
8619
        /// optional input stream
N
Niels 已提交
8620
        std::istream* m_stream = nullptr;
N
fixes  
Niels 已提交
8621
        /// the buffer
N
Niels 已提交
8622 8623
        string_t m_buffer;
        /// the buffer pointer
N
Niels 已提交
8624
        const lexer_char_t* m_content = nullptr;
N
Niels 已提交
8625
        /// pointer to the beginning of the current symbol
N
Niels 已提交
8626
        const lexer_char_t* m_start = nullptr;
N
Niels 已提交
8627 8628
        /// pointer for backtracking information
        const lexer_char_t* m_marker = nullptr;
N
fixes  
Niels 已提交
8629
        /// pointer to the current symbol
N
Niels 已提交
8630
        const lexer_char_t* m_cursor = nullptr;
N
fixes  
Niels 已提交
8631
        /// pointer to the end of the buffer
N
Niels 已提交
8632
        const lexer_char_t* m_limit = nullptr;
N
Niels 已提交
8633 8634
    };

N
Niels 已提交
8635 8636
    /*!
    @brief syntax analysis
N
Niels 已提交
8637 8638

    This class implements a recursive decent parser.
N
Niels 已提交
8639
    */
N
Niels 已提交
8640 8641 8642 8643
    class parser
    {
      public:
        /// constructor for strings
N
Niels 已提交
8644
        parser(const string_t& s, parser_callback_t cb = nullptr) noexcept
N
Niels 已提交
8645
            : callback(cb), m_lexer(s)
N
Niels 已提交
8646 8647 8648 8649 8650 8651
        {
            // read first token
            get_token();
        }

        /// a parser reading from an input stream
N
Niels 已提交
8652
        parser(std::istream& _is, parser_callback_t cb = nullptr) noexcept
N
Niels 已提交
8653
            : callback(cb), m_lexer(&_is)
N
Niels 已提交
8654 8655 8656 8657 8658
        {
            // read first token
            get_token();
        }

N
Niels 已提交
8659
        /// public parser interface
N
Niels 已提交
8660
        basic_json parse()
N
Niels 已提交
8661
        {
N
Niels 已提交
8662
            basic_json result = parse_internal(true);
N
Niels 已提交
8663 8664 8665

            expect(lexer::token_type::end_of_input);

N
Niels 已提交
8666 8667 8668
            // return parser result and replace it with null in case the
            // top-level value was discarded by the callback function
            return result.is_discarded() ? basic_json() : result;
N
Niels 已提交
8669 8670 8671 8672
        }

      private:
        /// the actual parser
N
Niels 已提交
8673
        basic_json parse_internal(bool keep)
N
Niels 已提交
8674
        {
N
Niels 已提交
8675 8676
            auto result = basic_json(value_t::discarded);

N
Niels 已提交
8677 8678
            switch (last_token)
            {
8679
                case lexer::token_type::begin_object:
N
Niels 已提交
8680
                {
N
Niels 已提交
8681
                    if (keep and (not callback or (keep = callback(depth++, parse_event_t::object_start, result))))
N
Niels 已提交
8682 8683
                    {
                        // explicitly set result to object to cope with {}
N
Niels 已提交
8684 8685
                        result.m_type = value_t::object;
                        result.m_value = json_value(value_t::object);
N
Niels 已提交
8686
                    }
N
Niels 已提交
8687 8688 8689 8690 8691 8692 8693

                    // read next token
                    get_token();

                    // closing } -> we are done
                    if (last_token == lexer::token_type::end_object)
                    {
N
Niels 已提交
8694
                        get_token();
N
Niels 已提交
8695
                        if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
N
Niels 已提交
8696 8697 8698
                        {
                            result = basic_json(value_t::discarded);
                        }
N
Niels 已提交
8699
                        return result;
N
Niels 已提交
8700 8701
                    }

N
Niels 已提交
8702 8703 8704
                    // no comma is expected here
                    unexpect(lexer::token_type::value_separator);

N
Niels 已提交
8705 8706 8707
                    // otherwise: parse key-value pairs
                    do
                    {
N
Niels 已提交
8708 8709 8710 8711 8712 8713
                        // ugly, but could be fixed with loop reorganization
                        if (last_token == lexer::token_type::value_separator)
                        {
                            get_token();
                        }

N
Niels 已提交
8714 8715 8716 8717
                        // store key
                        expect(lexer::token_type::value_string);
                        const auto key = m_lexer.get_string();

N
Niels 已提交
8718 8719 8720
                        bool keep_tag = false;
                        if (keep)
                        {
N
Niels 已提交
8721 8722 8723 8724 8725 8726 8727 8728 8729
                            if (callback)
                            {
                                basic_json k(key);
                                keep_tag = callback(depth, parse_event_t::key, k);
                            }
                            else
                            {
                                keep_tag = true;
                            }
N
Niels 已提交
8730 8731
                        }

N
Niels 已提交
8732 8733 8734 8735
                        // parse separator (:)
                        get_token();
                        expect(lexer::token_type::name_separator);

8736
                        // parse and add value
N
Niels 已提交
8737
                        get_token();
N
Niels 已提交
8738 8739 8740
                        auto value = parse_internal(keep);
                        if (keep and keep_tag and not value.is_discarded())
                        {
N
Niels 已提交
8741
                            result[key] = std::move(value);
N
Niels 已提交
8742
                        }
N
Niels 已提交
8743
                    }
N
Niels 已提交
8744
                    while (last_token == lexer::token_type::value_separator);
N
Niels 已提交
8745 8746 8747

                    // closing }
                    expect(lexer::token_type::end_object);
N
Niels 已提交
8748
                    get_token();
N
Niels 已提交
8749
                    if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
N
Niels 已提交
8750 8751 8752
                    {
                        result = basic_json(value_t::discarded);
                    }
N
Niels 已提交
8753 8754

                    return result;
N
Niels 已提交
8755 8756
                }

8757
                case lexer::token_type::begin_array:
N
Niels 已提交
8758
                {
N
Niels 已提交
8759
                    if (keep and (not callback or (keep = callback(depth++, parse_event_t::array_start, result))))
N
Niels 已提交
8760 8761
                    {
                        // explicitly set result to object to cope with []
N
Niels 已提交
8762 8763
                        result.m_type = value_t::array;
                        result.m_value = json_value(value_t::array);
N
Niels 已提交
8764
                    }
N
Niels 已提交
8765 8766 8767 8768 8769 8770 8771

                    // read next token
                    get_token();

                    // closing ] -> we are done
                    if (last_token == lexer::token_type::end_array)
                    {
N
Niels 已提交
8772
                        get_token();
N
Niels 已提交
8773
                        if (callback and not callback(--depth, parse_event_t::array_end, result))
N
Niels 已提交
8774 8775 8776
                        {
                            result = basic_json(value_t::discarded);
                        }
N
Niels 已提交
8777
                        return result;
N
Niels 已提交
8778 8779
                    }

N
Niels 已提交
8780 8781 8782
                    // no comma is expected here
                    unexpect(lexer::token_type::value_separator);

N
Niels 已提交
8783 8784 8785
                    // otherwise: parse values
                    do
                    {
N
Niels 已提交
8786 8787 8788 8789 8790
                        // ugly, but could be fixed with loop reorganization
                        if (last_token == lexer::token_type::value_separator)
                        {
                            get_token();
                        }
N
Niels 已提交
8791

N
Niels 已提交
8792 8793 8794 8795
                        // parse value
                        auto value = parse_internal(keep);
                        if (keep and not value.is_discarded())
                        {
N
Niels 已提交
8796
                            result.push_back(std::move(value));
N
Niels 已提交
8797
                        }
N
Niels 已提交
8798
                    }
N
Niels 已提交
8799
                    while (last_token == lexer::token_type::value_separator);
N
Niels 已提交
8800 8801 8802

                    // closing ]
                    expect(lexer::token_type::end_array);
N
Niels 已提交
8803
                    get_token();
N
Niels 已提交
8804
                    if (keep and callback and not callback(--depth, parse_event_t::array_end, result))
N
Niels 已提交
8805 8806 8807
                    {
                        result = basic_json(value_t::discarded);
                    }
N
Niels 已提交
8808 8809

                    return result;
N
Niels 已提交
8810 8811
                }

8812
                case lexer::token_type::literal_null:
N
Niels 已提交
8813
                {
N
Niels 已提交
8814
                    get_token();
N
Niels 已提交
8815
                    result.m_type = value_t::null;
N
Niels 已提交
8816
                    break;
N
Niels 已提交
8817 8818
                }

8819
                case lexer::token_type::value_string:
N
Niels 已提交
8820
                {
N
Niels 已提交
8821
                    const auto s = m_lexer.get_string();
N
Niels 已提交
8822
                    get_token();
N
Niels 已提交
8823 8824
                    result = basic_json(s);
                    break;
N
Niels 已提交
8825 8826
                }

8827
                case lexer::token_type::literal_true:
N
Niels 已提交
8828
                {
N
Niels 已提交
8829
                    get_token();
N
Niels 已提交
8830 8831
                    result.m_type = value_t::boolean;
                    result.m_value = true;
N
Niels 已提交
8832
                    break;
N
Niels 已提交
8833 8834
                }

8835
                case lexer::token_type::literal_false:
N
Niels 已提交
8836
                {
N
Niels 已提交
8837
                    get_token();
N
Niels 已提交
8838 8839
                    result.m_type = value_t::boolean;
                    result.m_value = false;
N
Niels 已提交
8840
                    break;
N
Niels 已提交
8841 8842
                }

8843
                case lexer::token_type::value_number:
N
Niels 已提交
8844
                {
8845
                    m_lexer.get_number(result);
N
Niels 已提交
8846
                    get_token();
N
Niels 已提交
8847
                    break;
N
Niels 已提交
8848 8849 8850 8851
                }

                default:
                {
N
Niels 已提交
8852 8853
                    // the last token was unexpected
                    unexpect(last_token);
N
Niels 已提交
8854 8855
                }
            }
N
Niels 已提交
8856

N
Niels 已提交
8857
            if (keep and callback and not callback(depth, parse_event_t::value, result))
N
Niels 已提交
8858 8859 8860 8861
            {
                result = basic_json(value_t::discarded);
            }
            return result;
N
Niels 已提交
8862 8863 8864
        }

        /// get next token from lexer
N
Niels 已提交
8865
        typename lexer::token_type get_token() noexcept
N
Niels 已提交
8866 8867 8868 8869 8870
        {
            last_token = m_lexer.scan();
            return last_token;
        }

N
Niels 已提交
8871
        void expect(typename lexer::token_type t) const
N
Niels 已提交
8872 8873 8874
        {
            if (t != last_token)
            {
N
Niels 已提交
8875 8876 8877 8878
                std::string error_msg = "parse error - unexpected ";
                error_msg += (last_token == lexer::token_type::parse_error ? ("'" +  m_lexer.get_token() + "'") :
                              lexer::token_type_name(last_token));
                error_msg += "; expected " + lexer::token_type_name(t);
N
Niels 已提交
8879 8880 8881 8882
                throw std::invalid_argument(error_msg);
            }
        }

N
Niels 已提交
8883
        void unexpect(typename lexer::token_type t) const
N
Niels 已提交
8884 8885 8886
        {
            if (t == last_token)
            {
N
Niels 已提交
8887 8888 8889
                std::string error_msg = "parse error - unexpected ";
                error_msg += (last_token == lexer::token_type::parse_error ? ("'" +  m_lexer.get_token() + "'") :
                              lexer::token_type_name(last_token));
N
Niels 已提交
8890 8891 8892 8893
                throw std::invalid_argument(error_msg);
            }
        }

N
Niels 已提交
8894
      private:
N
Niels 已提交
8895
        /// current level of recursion
N
Niels 已提交
8896 8897 8898
        int depth = 0;
        /// callback function
        parser_callback_t callback;
N
Niels 已提交
8899
        /// the type of the last read token
N
Niels 已提交
8900
        typename lexer::token_type last_token = lexer::token_type::uninitialized;
N
Niels 已提交
8901
        /// the lexer
N
Niels 已提交
8902
        lexer m_lexer;
N
Niels 已提交
8903
    };
N
Niels 已提交
8904 8905

  public:
N
Niels 已提交
8906 8907 8908 8909
    /*!
    @brief JSON Pointer

    @sa [RFC 6901](https://tools.ietf.org/html/rfc6901)
N
Niels 已提交
8910 8911

    @since version 2.0.0
N
Niels 已提交
8912
    */
N
Niels 已提交
8913 8914
    class json_pointer
    {
N
Niels 已提交
8915 8916 8917
        /// allow basic_json to access private members
        friend class basic_json;

N
Niels 已提交
8918
      public:
N
Niels 已提交
8919 8920 8921 8922 8923 8924 8925 8926 8927 8928
        /*!
        @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 已提交
8929 8930 8931 8932 8933 8934
        @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 已提交
8935 8936 8937

        @liveexample{The example shows the construction several valid JSON
        pointers as well as the exceptional behavior.,json_pointer}
N
Niels 已提交
8938

N
Niels 已提交
8939 8940 8941
        @since version 2.0.0
        */
        explicit json_pointer(const std::string& s = "")
N
Niels 已提交
8942 8943
            : reference_tokens(split(s))
        {}
N
Niels 已提交
8944

N
Niels 已提交
8945
      private:
N
Niels 已提交
8946 8947 8948 8949
        /*!
        @brief create and return a reference to the pointed to value
        */
        reference get_and_create(reference j) const
N
Niels 已提交
8950
        {
8951
            pointer result = &j;
N
Niels 已提交
8952

N
Niels 已提交
8953 8954
            // in case no reference tokens exist, return a reference to the
            // JSON value j which will be overwritten by a primitive value
N
Niels 已提交
8955 8956
            for (const auto& reference_token : reference_tokens)
            {
8957
                switch (result->m_type)
N
Niels 已提交
8958
                {
N
Niels 已提交
8959 8960 8961 8962
                    case value_t::null:
                    {
                        if (reference_token == "0")
                        {
N
Niels 已提交
8963
                            // start a new array if reference token is 0
N
Niels 已提交
8964 8965 8966 8967
                            result = &result->operator[](0);
                        }
                        else
                        {
N
Niels 已提交
8968
                            // start a new object otherwise
N
Niels 已提交
8969 8970
                            result = &result->operator[](reference_token);
                        }
N
Niels 已提交
8971
                        break;
N
Niels 已提交
8972 8973
                    }

N
Niels 已提交
8974
                    case value_t::object:
N
Niels 已提交
8975
                    {
N
Niels 已提交
8976
                        // create an entry in the object
N
Niels 已提交
8977
                        result = &result->operator[](reference_token);
N
Niels 已提交
8978
                        break;
N
Niels 已提交
8979
                    }
N
Niels 已提交
8980 8981

                    case value_t::array:
N
Niels 已提交
8982
                    {
N
Niels 已提交
8983
                        // create an entry in the array
N
Niels 已提交
8984
                        result = &result->operator[](static_cast<size_t>(std::stoi(reference_token)));
N
Niels 已提交
8985
                        break;
N
Niels 已提交
8986
                    }
N
Niels 已提交
8987

N
Niels 已提交
8988
                    /*
N
Niels 已提交
8989 8990 8991 8992 8993
                    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 已提交
8994
                    */
N
Niels 已提交
8995
                    default:
N
Niels 已提交
8996
                    {
N
Niels 已提交
8997
                        throw std::domain_error("invalid value to unflatten");
N
Niels 已提交
8998
                    }
N
Niels 已提交
8999 9000 9001
                }
            }

9002 9003 9004
            return *result;
        }

N
Niels 已提交
9005 9006 9007 9008 9009 9010 9011 9012 9013
        /*!
        @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.

9014 9015 9016
        @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 已提交
9017 9018
        */
        reference get_unchecked(pointer ptr) const
N
Niels 已提交
9019
        {
N
Niels 已提交
9020 9021 9022 9023 9024 9025
            for (const auto& reference_token : reference_tokens)
            {
                switch (ptr->m_type)
                {
                    case value_t::object:
                    {
9026
                        // use unchecked object access
N
Niels 已提交
9027 9028 9029 9030 9031 9032
                        ptr = &ptr->operator[](reference_token);
                        break;
                    }

                    case value_t::array:
                    {
9033 9034 9035 9036 9037 9038
                        // 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 已提交
9039 9040
                        if (reference_token == "-")
                        {
9041
                            // explicityly treat "-" as index beyond the end
N
Niels 已提交
9042 9043 9044 9045
                            ptr = &ptr->operator[](ptr->m_value.array->size());
                        }
                        else
                        {
9046
                            // convert array index to number; unchecked access
N
Niels 已提交
9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060
                            ptr = &ptr->operator[](static_cast<size_t>(std::stoi(reference_token)));
                        }
                        break;
                    }

                    default:
                    {
                        throw std::out_of_range("unresolved reference token '" + reference_token + "'");
                    }
                }
            }

            return *ptr;
        }
N
Niels 已提交
9061

N
Niels 已提交
9062 9063
        reference get_checked(pointer ptr) const
        {
N
Niels 已提交
9064 9065
            for (const auto& reference_token : reference_tokens)
            {
N
Niels 已提交
9066
                switch (ptr->m_type)
N
Niels 已提交
9067
                {
N
Niels 已提交
9068
                    case value_t::object:
N
Niels 已提交
9069
                    {
9070
                        // note: at performs range check
N
Niels 已提交
9071 9072 9073 9074 9075 9076 9077
                        ptr = &ptr->at(reference_token);
                        break;
                    }

                    case value_t::array:
                    {
                        if (reference_token == "-")
N
Niels 已提交
9078
                        {
9079 9080 9081 9082
                            // "-" 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 已提交
9083
                        }
9084 9085 9086

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
N
Niels 已提交
9087
                        {
9088
                            throw std::domain_error("array index must not begin with '0'");
N
Niels 已提交
9089
                        }
9090 9091 9092

                        // note: at performs range check
                        ptr = &ptr->at(static_cast<size_t>(std::stoi(reference_token)));
N
Niels 已提交
9093 9094 9095 9096 9097 9098
                        break;
                    }

                    default:
                    {
                        throw std::out_of_range("unresolved reference token '" + reference_token + "'");
N
Niels 已提交
9099
                    }
N
Niels 已提交
9100 9101 9102 9103 9104 9105 9106 9107 9108 9109
                }
            }

            return *ptr;
        }

        /*!
        @brief return a const reference to the pointed to value

        @param[in] ptr  a JSON value
N
Niels 已提交
9110

N
Niels 已提交
9111 9112 9113 9114 9115 9116 9117 9118 9119
        @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 已提交
9120 9121
                    case value_t::object:
                    {
9122
                        // use unchecked object access
N
Niels 已提交
9123
                        ptr = &ptr->operator[](reference_token);
N
Niels 已提交
9124
                        break;
N
Niels 已提交
9125 9126 9127 9128
                    }

                    case value_t::array:
                    {
N
Niels 已提交
9129 9130
                        if (reference_token == "-")
                        {
9131
                            // "-" cannot be used for const access
N
Niels 已提交
9132 9133 9134 9135
                            throw std::out_of_range("array index '-' (" +
                                                    std::to_string(ptr->m_value.array->size()) +
                                                    ") is out of range");
                        }
9136 9137 9138 9139 9140 9141 9142 9143

                        // 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 已提交
9144
                        ptr = &ptr->operator[](static_cast<size_t>(std::stoi(reference_token)));
N
Niels 已提交
9145
                        break;
N
Niels 已提交
9146 9147 9148 9149
                    }

                    default:
                    {
N
Niels 已提交
9150
                        throw std::out_of_range("unresolved reference token '" + reference_token + "'");
N
Niels 已提交
9151 9152 9153 9154
                    }
                }
            }

N
Niels 已提交
9155
            return *ptr;
N
Niels 已提交
9156 9157
        }

N
Niels 已提交
9158
        const_reference get_checked(const_pointer ptr) const
9159 9160 9161
        {
            for (const auto& reference_token : reference_tokens)
            {
N
Niels 已提交
9162
                switch (ptr->m_type)
9163 9164
                {
                    case value_t::object:
N
Niels 已提交
9165
                    {
9166
                        // note: at performs range check
N
Niels 已提交
9167
                        ptr = &ptr->at(reference_token);
N
Niels 已提交
9168
                        break;
N
Niels 已提交
9169
                    }
9170 9171

                    case value_t::array:
N
Niels 已提交
9172 9173 9174
                    {
                        if (reference_token == "-")
                        {
9175
                            // "-" always fails the range check
N
Niels 已提交
9176 9177 9178 9179
                            throw std::out_of_range("array index '-' (" +
                                                    std::to_string(ptr->m_value.array->size()) +
                                                    ") is out of range");
                        }
9180 9181 9182 9183 9184 9185 9186 9187

                        // 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 已提交
9188
                        ptr = &ptr->at(static_cast<size_t>(std::stoi(reference_token)));
N
Niels 已提交
9189
                        break;
N
Niels 已提交
9190
                    }
9191 9192

                    default:
N
Niels 已提交
9193 9194 9195
                    {
                        throw std::out_of_range("unresolved reference token '" + reference_token + "'");
                    }
9196 9197 9198
                }
            }

N
Niels 已提交
9199
            return *ptr;
N
Niels 已提交
9200 9201 9202
        }

        /// split the string input to reference tokens
N
Niels 已提交
9203
        std::vector<std::string> split(std::string reference_string)
N
Niels 已提交
9204
        {
N
Niels 已提交
9205 9206
            std::vector<std::string> result;

N
Niels 已提交
9207 9208 9209
            // special case: empty reference string -> no reference tokens
            if (reference_string.empty())
            {
N
Niels 已提交
9210
                return result;
N
Niels 已提交
9211 9212 9213 9214 9215 9216 9217 9218
            }

            // 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 已提交
9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229
            // 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 已提交
9230
                // (will eventually be 0 if slash == std::string::npos)
N
Niels 已提交
9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253
                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'");
                    }
                }
9254 9255 9256 9257 9258

                // first transform any occurrence of the sequence '~1' to '/'
                replace_substring(reference_token, "~1", "/");
                // then transform any occurrence of the sequence '~0' to '~'
                replace_substring(reference_token, "~0", "~");
N
Niels 已提交
9259

N
Niels 已提交
9260
                // finally, store the reference token
N
Niels 已提交
9261
                result.push_back(reference_token);
9262
            }
N
Niels 已提交
9263 9264

            return result;
N
Niels 已提交
9265
        }
N
Niels 已提交
9266

N
Niels 已提交
9267
      private:
N
Niels 已提交
9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299
        /*!
        @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
        @param[out]    t  the string to replace @a f

        @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
            );
        }

        /*!
        @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 已提交
9300 9301

        @note Empty objects or arrays are flattened to `null`.
N
Niels 已提交
9302 9303 9304 9305 9306 9307 9308 9309 9310
        */
        static void flatten(const std::string reference_string,
                            const basic_json& value,
                            basic_json& result)
        {
            switch (value.m_type)
            {
                case value_t::array:
                {
N
Niels 已提交
9311
                    if (value.m_value.array->empty())
N
Niels 已提交
9312
                    {
N
Niels 已提交
9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323
                        // 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 已提交
9324 9325 9326 9327 9328 9329
                    }
                    break;
                }

                case value_t::object:
                {
N
Niels 已提交
9330
                    if (value.m_value.object->empty())
N
Niels 已提交
9331
                    {
N
Niels 已提交
9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343
                        // 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)
                        {
                            // escape "~"" to "~0" and "/" to "~1"
                            std::string key(element.first);
                            replace_substring(key, "~", "~0");
                            replace_substring(key, "/", "~1");
N
Niels 已提交
9344

N
Niels 已提交
9345 9346 9347
                            flatten(reference_string + "/" + key,
                                    element.second, result);
                        }
N
Niels 已提交
9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359
                    }
                    break;
                }

                default:
                {
                    // add primitive value with its reference string
                    result[reference_string] = value;
                    break;
                }
            }
        }
N
Niels 已提交
9360 9361 9362 9363

        /*!
        @param[in] value  flattened JSON

N
Niels 已提交
9364
        @return unflattened JSON
N
Niels 已提交
9365
        */
N
Niels 已提交
9366
        static basic_json unflatten(const basic_json& value)
N
Niels 已提交
9367 9368 9369
        {
            if (not value.is_object())
            {
N
Niels 已提交
9370
                throw std::domain_error("only objects can be unflattened");
N
Niels 已提交
9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382
            }

            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 已提交
9383 9384 9385 9386 9387
                // 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 已提交
9388
                json_pointer(element.first).get_and_create(result) = element.second;
N
Niels 已提交
9389 9390 9391 9392
            }

            return result;
        }
N
Niels 已提交
9393 9394 9395 9396

      private:
        /// the reference tokens
        const std::vector<std::string> reference_tokens {};
N
Niels 已提交
9397
    };
N
Niels 已提交
9398

N
Niels 已提交
9399 9400 9401 9402 9403 9404 9405
    ////////////////////////////
    // JSON Pointer functions //
    ////////////////////////////

    /// @name JSON Pointer functions
    /// @{

N
Niels 已提交
9406
    /*!
N
Niels 已提交
9407 9408 9409 9410 9411 9412 9413
    @brief return flattened JSON value

    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 已提交
9414
    @return an object that maps JSON pointers to primitve values
N
Niels 已提交
9415

N
Niels 已提交
9416 9417
    @note Empty objects and arrays are flattened to `null` and will not be
          reconstructed correctly by the @ref unflatten() function.
N
Niels 已提交
9418 9419 9420 9421 9422 9423 9424 9425 9426

    @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 已提交
9427 9428 9429 9430 9431 9432 9433
    */
    basic_json flatten() const
    {
        basic_json result(value_t::object);
        json_pointer::flatten("", *this, result);
        return result;
    }
N
Niels 已提交
9434 9435

    /*!
N
Niels 已提交
9436 9437 9438 9439 9440 9441 9442 9443 9444 9445
    @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 已提交
9446
    @return the original JSON from a flattened version
N
Niels 已提交
9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460

    @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 已提交
9461
    */
N
Niels 已提交
9462
    basic_json unflatten() const
N
Niels 已提交
9463
    {
N
Niels 已提交
9464
        return json_pointer::unflatten(*this);
N
Niels 已提交
9465
    }
N
Niels 已提交
9466 9467

    /// @}
N
Niels 已提交
9468 9469 9470 9471 9472 9473 9474
};


/////////////
// presets //
/////////////

N
Niels 已提交
9475 9476 9477 9478 9479
/*!
@brief default JSON class

This type is the default specialization of the @ref basic_json class which uses
the standard template types.
N
Niels 已提交
9480

N
Niels 已提交
9481
@since version 1.0.0
N
Niels 已提交
9482
*/
N
Niels 已提交
9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493
using json = basic_json<>;
}


/////////////////////////
// nonmember functions //
/////////////////////////

// specialization of std::swap, and std::hash
namespace std
{
N
Niels 已提交
9494 9495
/*!
@brief exchanges the values of two JSON objects
N
Niels 已提交
9496

N
Niels 已提交
9497
@since version 1.0.0
N
Niels 已提交
9498
*/
N
Niels 已提交
9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512
template <>
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
template <>
struct hash<nlohmann::json>
{
N
Niels 已提交
9513 9514 9515
    /*!
    @brief return a hash value for a JSON object

N
Niels 已提交
9516
    @since version 1.0.0
N
Niels 已提交
9517
    */
N
Niels 已提交
9518
    std::size_t operator()(const nlohmann::json& j) const
N
Niels 已提交
9519 9520
    {
        // a naive hashing via the string representation
N
Niels 已提交
9521 9522
        const auto& h = hash<nlohmann::json::string_t>();
        return h(j.dump());
N
Niels 已提交
9523 9524 9525 9526 9527
    }
};
}

/*!
N
Niels 已提交
9528 9529
@brief user-defined string literal for JSON values

N
Niels 已提交
9530 9531 9532
This operator implements a user-defined string literal for JSON objects. It
can be used by adding \p "_json" to a string literal and returns a JSON object
if no parse error occurred.
N
Niels 已提交
9533

N
Niels 已提交
9534
@param[in] s  a string representation of a JSON object
N
Niels 已提交
9535
@return a JSON object
N
Niels 已提交
9536

N
Niels 已提交
9537
@since version 1.0.0
N
Niels 已提交
9538
*/
N
Niels 已提交
9539
inline nlohmann::json operator "" _json(const char* s, std::size_t)
N
Niels 已提交
9540
{
N
Niels 已提交
9541
    return nlohmann::json::parse(reinterpret_cast<const nlohmann::json::string_t::value_type*>(s));
N
Niels 已提交
9542 9543
}

N
Niels 已提交
9544 9545 9546 9547 9548 9549 9550 9551 9552 9553
/*!
@brief user-defined string literal for JSON pointer

@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);
}

9554 9555 9556 9557 9558
// restore GCC/clang diagnostic settings
#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
    #pragma GCC diagnostic pop
#endif

N
Niels 已提交
9559
#endif