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

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

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

N
Niels Lohmann 已提交
32
#include <algorithm> // all_of, copy, fill, find, for_each, none_of, remove, reverse, transform
N
Niels 已提交
33 34 35 36
#include <array> // array
#include <cassert> // assert
#include <cctype> // isdigit
#include <ciso646> // and, not, or
37
#include <clocale> // lconv, localeconv
N
Niels Lohmann 已提交
38
#include <cmath> // isfinite, labs, ldexp, signbit
N
Niels 已提交
39 40
#include <cstddef> // nullptr_t, ptrdiff_t, size_t
#include <cstdint> // int64_t, uint64_t
N
Niels Lohmann 已提交
41
#include <cstdlib> // abort, strtod, strtof, strtold, strtoul, strtoll, strtoull
42
#include <cstring> // strlen
43
#include <forward_list> // forward_list
N
Niels 已提交
44 45 46 47
#include <functional> // function, hash, less
#include <initializer_list> // initializer_list
#include <iomanip> // setw
#include <iostream> // istream, ostream
N
Niels Lohmann 已提交
48
#include <iterator> // advance, begin, back_inserter, bidirectional_iterator_tag, distance, end, inserter, iterator, iterator_traits, next, random_access_iterator_tag, reverse_iterator
N
Niels 已提交
49
#include <limits> // numeric_limits
N
Niels 已提交
50
#include <locale> // locale
N
Niels 已提交
51 52 53 54 55
#include <map> // map
#include <memory> // addressof, allocator, allocator_traits, unique_ptr
#include <numeric> // accumulate
#include <sstream> // stringstream
#include <string> // getline, stoi, string, to_string
N
Niels Lohmann 已提交
56
#include <type_traits> // add_pointer, conditional, decay, enable_if, false_type, integral_constant, is_arithmetic, is_base_of, is_const, is_constructible, is_convertible, is_default_constructible, is_enum, is_floating_point, is_integral, is_nothrow_move_assignable, is_nothrow_move_constructible, is_pointer, is_reference, is_same, is_scalar, is_signed, remove_const, remove_cv, remove_pointer, remove_reference, true_type, underlying_type
N
Niels 已提交
57 58
#include <utility> // declval, forward, make_pair, move, pair, swap
#include <vector> // vector
N
Niels 已提交
59

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

71 72 73 74
// disable float-equal warnings on GCC/clang
#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
    #pragma GCC diagnostic push
    #pragma GCC diagnostic ignored "-Wfloat-equal"
N
Niels Lohmann 已提交
75 76 77 78 79
#endif

// disable documentation warnings on clang
#if defined(__clang__)
    #pragma GCC diagnostic push
80
    #pragma GCC diagnostic ignored "-Wdocumentation"
81 82
#endif

83
// allow to disable exceptions
84
#if (defined(__cpp_exceptions) || defined(__EXCEPTIONS) || defined(_CPPUNWIND)) && not defined(JSON_NOEXCEPTION)
85 86 87
    #define JSON_THROW(exception) throw exception
    #define JSON_TRY try
    #define JSON_CATCH(exception) catch(exception)
N
Niels Lohmann 已提交
88 89 90 91
#else
    #define JSON_THROW(exception) std::abort()
    #define JSON_TRY if(true)
    #define JSON_CATCH(exception) if(false)
92 93
#endif

N
Niels 已提交
94
/*!
N
Niels 已提交
95
@brief namespace for Niels Lohmann
N
Niels 已提交
96
@see https://github.com/nlohmann
N
Niels 已提交
97
@since version 1.0.0
N
Niels 已提交
98 99 100
*/
namespace nlohmann
{
101

102 103
/*!
@brief unnamed namespace with internal helper functions
104

105 106 107 108 109
This namespace collects some functions that could not be defined inside the
@ref basic_json class.

@since version 2.1.0
*/
110 111
namespace detail
{
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
////////////////
// exceptions //
////////////////

/*!
@brief general exception of the @ref basic_json class

Extension of std::exception objects with a member @a id for exception ids.

@since version 3.0.0
*/
class exception : public std::exception
{
  public:
    /// create exception with id an explanatory string
    exception(int id_, const std::string& ename, const std::string& what_arg_)
        : id(id_),
          what_arg("[json.exception." + ename + "." + std::to_string(id_) + "] " + what_arg_)
    {}

    /// returns the explanatory string
    virtual const char* what() const noexcept
    {
        return what_arg.c_str();
    }

    /// the id of the exception
    const int id;

  private:
    /// the explanatory string
    const std::string what_arg;
};

/*!
@brief exception indicating a parse error

This excpetion is thrown by the library when a parse error occurs. Parse
errors can occur during the deserialization of JSON text as well as when
using JSON Patch.

Member @a byte holds the byte index of the last read character in the input
file.

@note For an input with n bytes, 1 is the index of the first character
      and n+1 is the index of the terminating null byte or the end of
158 159
      file. This also holds true when reading a byte vector (CBOR or
      MessagePack).
160 161 162 163 164

Exceptions have ids 1xx.

name / id                      | example massage | description
------------------------------ | --------------- | -------------------------
165 166 167 168 169 170 171 172 173 174 175 176
json.exception.parse_error.101 | parse error at 2: unexpected end of input; expected string literal | This error indicates a syntax error while deserializing a JSON text. The error message describes that an unexpected token (character) was encountered, and the member @a byte indicates the error position.
json.exception.parse_error.102 | parse error at 14: missing or wrong low surrogate | JSON uses the `\uxxxx` format to describe Unicode characters. Code points above above 0xFFFF are split into two `\uxxxx` entries ("surrogate pairs"). This error indicates that the surrogate pair is incomplete or contains an invalid code point.
json.exception.parse_error.103 | parse error: code points above 0x10FFFF are invalid | Unicode supports code points up to 0x10FFFF. Code points above 0x10FFFF are invalid.
json.exception.parse_error.104 | parse error: JSON patch must be an array of objects | [RFC 6902](https://tools.ietf.org/html/rfc6902) requires a JSON Patch document to be a JSON document that represents an array of objects.
json.exception.parse_error.105 | parse error: operation must have string member 'op' | An operation of a JSON Patch document must contain exactly one "op" member, whose value indicates the operation to perform. Its value must be one of "add", "remove", "replace", "move", "copy", or "test"; other values are errors.
json.exception.parse_error.106 | parse error: array index '01' must not begin with '0' | An array index in a JSON Pointer ([RFC 6901](https://tools.ietf.org/html/rfc6901)) may be `0` or any number wihtout a leading `0`.
json.exception.parse_error.107 | parse error: JSON pointer must be empty or begin with '/' - was: 'foo' | A JSON Pointer must be a Unicode string containing a sequence of zero or more reference tokens, each prefixed by a `/` character.
json.exception.parse_error.108 | parse error: escape character '~' must be followed with '0' or '1' | In a JSON Pointer, only `~0` and `~1` are valid escape sequences.
json.exception.parse_error.109 | parse error: array index 'one' is not a number | A JSON Pointer array index must be a number.
json.exception.parse_error.110 | parse error at 1: cannot read 2 bytes from vector | When parsing CBOR or MessagePack, the byte vector ends before the complete value has been read.
json.exception.parse_error.111 | parse error: bad input stream | Parsing CBOR or MessagePack from an input stream where the [`badbit` or `failbit`](http://en.cppreference.com/w/cpp/io/ios_base/iostate) is set.
json.exception.parse_error.112 | parse error at 1: error reading CBOR; last byte: 0xf8 | Not all types of CBOR or MessagePack are supported. This exception occurs if an unsupported byte was read.
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203

@since version 3.0.0
*/
class parse_error : public exception
{
  public:
    /*!
    @brief create a parse error exception
    @param[in] id_        the id of the exception
    @param[in] byte_      the byte index where the error occured (or 0 if
                          the position cannot be determined)
    @param[in] what_arg_  the explanatory string
    */
    parse_error(int id_, size_t byte_, const std::string& what_arg_)
        : exception(id_, "parse_error", "parse error" +
                    (byte_ != 0 ? (" at " + std::to_string(byte_)) : "") +
                    ": " + what_arg_),
          byte(byte_)
    {}

    /*!
    @brief byte index of the parse error

    The byte index of the last read character in the input file.

    @note For an input with n bytes, 1 is the index of the first character
          and n+1 is the index of the terminating null byte or the end of
204 205
          file. This also holds true when reading a byte vector (CBOR or
          MessagePack).
206 207 208 209 210 211 212 213 214
    */
    const size_t byte;
};

/*!
@brief exception indicating errors with iterators

Exceptions have ids 2xx.

215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
name / id                           | example massage | description
----------------------------------- | --------------- | -------------------------
json.exception.invalid_iterator.201 | iterators are not compatible | The iterators passed to constructor @ref basic_json(InputIT first, InputIT last) are not compatible, meaning they do not belong to the same container. Therefore, the range (@a first, @a last) is invalid.
json.exception.invalid_iterator.202 | iterator does not fit current value | In an erase or insert function, the passed iterator @a pos does not belong to the JSON value for which the function was called. It hence does not define a valid position for the deletion/insertion.
json.exception.invalid_iterator.203 | iterators do not fit current value | Either iterator passed to function @ref erase(IteratorType first, IteratorType last) does not belong to the JSON value from which values shall be erased. It hence does not define a valid range to delete values from.
json.exception.invalid_iterator.204 | iterators out of range | When an iterator range for a primitive type (number, boolean, or string) is passed to a constructor or an erase function, this range has to be exactly (@ref begin(), @ref end()), because this is the only way the single stored value is expressed. All other ranges are invalid.
json.exception.invalid_iterator.205 | iterator out of range | When an iterator for a primitive type (number, boolean, or string) is passed to an erase function, the iterator has to be the @ref begin() iterator, because it is the only way to address the stored value. All other iterators are invalid.
json.exception.invalid_iterator.206 | cannot construct with iterators from null | The iterators passed to constructor @ref basic_json(InputIT first, InputIT last) belong to a JSON null value and hence to not define a valid range.
json.exception.invalid_iterator.207 | cannot use key() for non-object iterators | The key() member function can only be used on iterators belonging to a JSON object, because other types do not have a concept of a key.
json.exception.invalid_iterator.208 | cannot use operator[] for object iterators | The operator[] to specify a concrete offset cannot be used on iterators belonging to a JSON object, because JSON objects are unordered.
json.exception.invalid_iterator.209 | cannot use offsets with object iterators | The offset operators (+, -, +=, -=) cannot be used on iterators belonging to a JSON object, because JSON objects are unordered.
json.exception.invalid_iterator.210 | iterators do not fit | The iterator range passed to the insert function are not compatible, meaning they do not belong to the same container. Therefore, the range (@a first, @a last) is invalid.
json.exception.invalid_iterator.211 | passed iterators may not belong to container | The iterator range passed to the insert function must not be a subrange of the container to insert to.
json.exception.invalid_iterator.212 | cannot compare iterators of different containers | When two iterators are compared, they must belong to the same container.
json.exception.invalid_iterator.213 | cannot compare order of object iterators | The order of object iterators cannot be compated, because JSON objects are unordered.
json.exception.invalid_iterator.214 | cannot get value | Cannot get value for iterator: Either the iterator belongs to a null value or it is an iterator to a primitive type (number, boolean, or string), but the iterator is different to @ref begin().
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246

@since version 3.0.0
*/
class invalid_iterator : public exception
{
  public:
    invalid_iterator(int id_, const std::string& what_arg_)
        : exception(id_, "invalid_iterator", what_arg_)
    {}
};

/*!
@brief exception indicating executing a member function with a wrong type

Exceptions have ids 3xx.

247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
name / id                     | example massage | description
----------------------------- | --------------- | -------------------------
json.exception.type_error.301 | cannot create object from initializer list | To create an object from an initializer list, the initializer list must consist only of a list of pairs whose first element is a string. When this constraint is violated, an array is created instead.
json.exception.type_error.302 | type must be object, but is array | During implicit or explicit value conversion, the JSON type must be compatible to the target type. For instance, a JSON string can only be converted into string types, but not into numbers or boolean types.
json.exception.type_error.303 | incompatible ReferenceType for get_ref, actual type is object | To retrieve a reference to a value stored in a @ref basic_json object with @ref get_ref, the type of the reference must match the value type. For instance, for a JSON array, the @a ReferenceType must be @ref array_t&.
json.exception.type_error.304 | cannot use at() with string | The @ref at() member functions can only be executed for certain JSON types.
json.exception.type_error.305 | cannot use operator[] with string | The @ref operator[] member functions can only be executed for certain JSON types.
json.exception.type_error.306 | cannot use value() with string | The @ref value() member functions can only be executed for certain JSON types.
json.exception.type_error.307 | cannot use erase() with string | The @ref erase() member functions can only be executed for certain JSON types.
json.exception.type_error.308 | cannot use push_back() with string | The @ref push_back() and @ref operator+= member functions can only be executed for certain JSON types.
json.exception.type_error.309 | cannot use insert() with | The @ref insert() member functions can only be executed for certain JSON types.
json.exception.type_error.310 | cannot use swap() with number | The @ref swap() member functions can only be executed for certain JSON types.
json.exception.type_error.311 | cannot use emplace_back() with string | The @ref emplace_back() member function can only be executed for certain JSON types.
json.exception.type_error.313 | invalid value to unflatten | The @ref unflatten function converts an object whose keys are JSON Pointers back into an arbitrary nested JSON value. The JSON Pointers must not overlap, because then the resulting value would not be well defined.
json.exception.type_error.314 | only objects can be unflattened | The @ref unflatten function only works for an object whose keys are JSON Pointers.
json.exception.type_error.315 | values in object must be primitive | The @ref unflatten function only works for an object whose keys are JSON Pointers and whose values are primitive.
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278

@since version 3.0.0
*/
class type_error : public exception
{
  public:
    type_error(int id_, const std::string& what_arg_)
        : exception(id_, "type_error", what_arg_)
    {}
};

/*!
@brief exception indicating access out of the defined range

Exceptions have ids 4xx.

279 280 281 282 283 284 285
name / id                       | example massage | description
------------------------------- | --------------- | -------------------------
json.exception.out_of_range.401 | array index 3 is out of range | The provided array index @a i is larger than @a size-1.
json.exception.out_of_range.402 | array index '-' (3) is out of range | The special array index `-` in a JSON Pointer never describes a valid element of the array, but the index past the end. That is, it can only be used to add elements at this position, but not to read it.
json.exception.out_of_range.403 | key 'foo' not found | The provided key was not found in the JSON object.
json.exception.out_of_range.404 | unresolved reference token 'foo' | A reference token in a JSON Pointer could not be resolved.
json.exception.out_of_range.405 | JSON pointer has no parent | The JSON Patch operations 'remove' and 'add' can not be applied to the root element of the JSON value.
286
json.exception.out_of_range.406 | number overflow parsing '10E1000' | A parsed number could not be stored as without changing it to NaN or INF.
287 288 289 290 291 292 293 294 295 296 297

@since version 3.0.0
*/
class out_of_range : public exception
{
  public:
    out_of_range(int id_, const std::string& what_arg_)
        : exception(id_, "out_of_range", what_arg_)
    {}
};

298 299 300 301 302 303 304
/*!
@brief exception indicating other errors

Exceptions have ids 5xx.

name / id                      | example massage | description
------------------------------ | --------------- | -------------------------
305
json.exception.other_error.501 | unsuccessful: {"op":"test","path":"/baz", "value":"bar"} | A JSON Patch operation 'test' failed. The unsuccessful operation is also printed.
306 307 308 309 310 311 312 313 314 315 316 317

@since version 3.0.0
*/
class other_error : public exception
{
  public:
    other_error(int id_, const std::string& what_arg_)
        : exception(id_, "other_error", what_arg_)
    {}
};


318

319 320 321 322 323 324 325
///////////////////////////
// JSON type enumeration //
///////////////////////////

/*!
@brief the JSON type enumeration

326 327 328 329 330 331 332
This enumeration collects the different JSON types. It is internally used to
distinguish the stored values, and the functions @ref basic_json::is_null(),
@ref basic_json::is_object(), @ref basic_json::is_array(),
@ref basic_json::is_string(), @ref basic_json::is_boolean(),
@ref basic_json::is_number() (with @ref basic_json::is_number_integer(),
@ref basic_json::is_number_unsigned(), and @ref basic_json::is_number_float()),
@ref basic_json::is_discarded(), @ref basic_json::is_primitive(), and
T
Théo DELRIEU 已提交
333
@ref basic_json::is_structured() rely on it.
334

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

342 343
@sa @ref basic_json::basic_json(const value_t value_type) -- create a JSON
value with the default value for a given type
344 345 346 347 348

@since version 1.0.0
*/
enum class value_t : uint8_t
{
T
Théo DELRIEU 已提交
349 350 351 352 353 354 355 356 357
    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 (signed integer)
    number_unsigned, ///< number value (unsigned integer)
    number_float,    ///< number value (floating-point)
    discarded        ///< discarded by the the parser callback function
358 359
};

360 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 386 387 388 389 390 391 392
/*!
@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

@since version 1.0.0
*/
inline bool operator<(const value_t lhs, const value_t rhs) noexcept
{
    static constexpr std::array<uint8_t, 8> order = {{
            0, // null
            3, // object
            4, // array
            5, // string
            1, // boolean
            2, // integer
            2, // unsigned
            2, // float
        }
    };

    // 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)];
}

393 394 395 396 397

/////////////
// helpers //
/////////////

398
// alias templates to reduce boilerplate
399
template<bool B, typename T = void>
400 401
using enable_if_t = typename std::enable_if<B, T>::type;

402
template<typename T>
T
Théo DELRIEU 已提交
403
using uncvref_t = typename std::remove_cv<typename std::remove_reference<T>::type>::type;
404

N
Niels Lohmann 已提交
405
// taken from http://stackoverflow.com/a/26936864/266378
406
template<typename T>
T
Théo DELRIEU 已提交
407 408
using is_unscoped_enum =
    std::integral_constant<bool, std::is_convertible<T, int>::value and
409
    std::is_enum<T>::value>;
T
Théo DELRIEU 已提交
410

411
/*
N
Niels Lohmann 已提交
412
Implementation of two C++17 constructs: conjunction, negation. This is needed
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
to avoid evaluating all the traits in a condition

For example: not std::is_same<void, T>::value and has_value_type<T>::value
will not compile when T = void (on MSVC at least). Whereas
conjunction<negation<std::is_same<void, T>>, has_value_type<T>>::value will
stop evaluating if negation<...>::value == false

Please note that those constructs must be used with caution, since symbols can
become very long quickly (which can slow down compilation and cause MSVC
internal compiler errors). Only use it when you have to (see example ahead).
*/
template<class...> struct conjunction : std::true_type {};
template<class B1> struct conjunction<B1> : B1 {};
template<class B1, class... Bn>
struct conjunction<B1, Bn...> : std::conditional<bool(B1::value), conjunction<Bn...>, B1>::type {};
428

429
template<class B> struct negation : std::integral_constant < bool, !B::value > {};
430

431
// dispatch utility (taken from ranges-v3)
432 433
template<unsigned N> struct priority_tag : priority_tag < N - 1 > {};
template<> struct priority_tag<0> {};
434

435 436 437 438

//////////////////
// constructors //
//////////////////
439

440
template<value_t> struct external_constructor;
441

442
template<>
443 444
struct external_constructor<value_t::boolean>
{
445
    template<typename BasicJsonType>
446
    static void construct(BasicJsonType& j, typename BasicJsonType::boolean_t b) noexcept
T
Théo DELRIEU 已提交
447 448 449 450 451
    {
        j.m_type = value_t::boolean;
        j.m_value = b;
        j.assert_invariant();
    }
452
};
453

454
template<>
455 456
struct external_constructor<value_t::string>
{
457
    template<typename BasicJsonType>
458
    static void construct(BasicJsonType& j, const typename BasicJsonType::string_t& s)
T
Théo DELRIEU 已提交
459 460 461 462 463
    {
        j.m_type = value_t::string;
        j.m_value = s;
        j.assert_invariant();
    }
464
};
465

466
template<>
467 468
struct external_constructor<value_t::number_float>
{
469
    template<typename BasicJsonType>
470
    static void construct(BasicJsonType& j, typename BasicJsonType::number_float_t val) noexcept
471
    {
472 473
        j.m_type = value_t::number_float;
        j.m_value = val;
T
Théo DELRIEU 已提交
474
        j.assert_invariant();
475 476 477
    }
};

478
template<>
479 480
struct external_constructor<value_t::number_unsigned>
{
481
    template<typename BasicJsonType>
482
    static void construct(BasicJsonType& j, typename BasicJsonType::number_unsigned_t val) noexcept
T
Théo DELRIEU 已提交
483 484 485 486 487
    {
        j.m_type = value_t::number_unsigned;
        j.m_value = val;
        j.assert_invariant();
    }
488 489
};

490
template<>
491 492
struct external_constructor<value_t::number_integer>
{
493
    template<typename BasicJsonType>
494
    static void construct(BasicJsonType& j, typename BasicJsonType::number_integer_t val) noexcept
T
Théo DELRIEU 已提交
495 496 497 498 499
    {
        j.m_type = value_t::number_integer;
        j.m_value = val;
        j.assert_invariant();
    }
500 501
};

502
template<>
503 504
struct external_constructor<value_t::array>
{
505
    template<typename BasicJsonType>
506
    static void construct(BasicJsonType& j, const typename BasicJsonType::array_t& arr)
T
Théo DELRIEU 已提交
507 508 509 510 511 512
    {
        j.m_type = value_t::array;
        j.m_value = arr;
        j.assert_invariant();
    }

513 514 515 516
    template<typename BasicJsonType, typename CompatibleArrayType,
             enable_if_t<not std::is_same<CompatibleArrayType,
                                          typename BasicJsonType::array_t>::value,
                         int> = 0>
517
    static void construct(BasicJsonType& j, const CompatibleArrayType& arr)
T
Théo DELRIEU 已提交
518 519 520 521
    {
        using std::begin;
        using std::end;
        j.m_type = value_t::array;
522
        j.m_value.array = j.template create<typename BasicJsonType::array_t>(begin(arr), end(arr));
T
Théo DELRIEU 已提交
523 524
        j.assert_invariant();
    }
525 526 527 528 529 530 531 532 533 534 535 536 537

    template<typename BasicJsonType>
    static void construct(BasicJsonType& j, const std::vector<bool>& arr)
    {
        j.m_type = value_t::array;
        j.m_value = value_t::array;
        j.m_value.array->reserve(arr.size());
        for (bool x : arr)
        {
            j.m_value.array->push_back(x);
        }
        j.assert_invariant();
    }
538 539
};

540
template<>
541 542
struct external_constructor<value_t::object>
{
543
    template<typename BasicJsonType>
544
    static void construct(BasicJsonType& j, const typename BasicJsonType::object_t& obj)
T
Théo DELRIEU 已提交
545 546 547 548 549 550
    {
        j.m_type = value_t::object;
        j.m_value = obj;
        j.assert_invariant();
    }

551 552 553 554
    template<typename BasicJsonType, typename CompatibleObjectType,
             enable_if_t<not std::is_same<CompatibleObjectType,
                                          typename BasicJsonType::object_t>::value,
                         int> = 0>
555
    static void construct(BasicJsonType& j, const CompatibleObjectType& obj)
T
Théo DELRIEU 已提交
556 557 558
    {
        using std::begin;
        using std::end;
559

T
Théo DELRIEU 已提交
560
        j.m_type = value_t::object;
561
        j.m_value.object = j.template create<typename BasicJsonType::object_t>(begin(obj), end(obj));
T
Théo DELRIEU 已提交
562 563
        j.assert_invariant();
    }
564 565
};

566 567 568 569 570

////////////////////////
// has_/is_ functions //
////////////////////////

571 572
/*!
@brief Helper to determine whether there's a key_type for T.
N
Niels Lohmann 已提交
573 574

This helper is used to tell associative containers apart from other containers
N
Niels 已提交
575 576
such as sequence containers. For instance, `std::map` passes the test as it
contains a `mapped_type`, whereas `std::vector` fails the test.
N
Niels Lohmann 已提交
577

578
@sa http://stackoverflow.com/a/7728728/266378
N
Niels 已提交
579
@since version 1.0.0, overworked in version 2.0.6
580
*/
N
Niels Lohmann 已提交
581
#define NLOHMANN_JSON_HAS_HELPER(type)                                        \
582
    template<typename T> struct has_##type {                                  \
N
Niels Lohmann 已提交
583
    private:                                                                  \
584
        template<typename U, typename = typename U::type>                     \
N
Niels Lohmann 已提交
585 586 587 588 589
        static int detect(U &&);                                              \
        static void detect(...);                                              \
    public:                                                                   \
        static constexpr bool value =                                         \
                std::is_integral<decltype(detect(std::declval<T>()))>::value; \
T
Théo DELRIEU 已提交
590
    }
T
Théo Delrieu 已提交
591

N
Niels Lohmann 已提交
592 593 594 595
NLOHMANN_JSON_HAS_HELPER(mapped_type);
NLOHMANN_JSON_HAS_HELPER(key_type);
NLOHMANN_JSON_HAS_HELPER(value_type);
NLOHMANN_JSON_HAS_HELPER(iterator);
T
Théo Delrieu 已提交
596 597

#undef NLOHMANN_JSON_HAS_HELPER
598

N
Niels Lohmann 已提交
599

600
template<bool B, class RealType, class CompatibleObjectType>
601
struct is_compatible_object_type_impl : std::false_type {};
T
Théo DELRIEU 已提交
602

603
template<class RealType, class CompatibleObjectType>
T
Théo DELRIEU 已提交
604 605
struct is_compatible_object_type_impl<true, RealType, CompatibleObjectType>
{
606 607 608 609 610
    static constexpr auto value =
        std::is_constructible<typename RealType::key_type,
        typename CompatibleObjectType::key_type>::value and
        std::is_constructible<typename RealType::mapped_type,
        typename CompatibleObjectType::mapped_type>::value;
T
Théo DELRIEU 已提交
611 612
};

613
template<class BasicJsonType, class CompatibleObjectType>
T
Théo DELRIEU 已提交
614 615
struct is_compatible_object_type
{
T
Théo DELRIEU 已提交
616 617 618 619
    static auto constexpr value = is_compatible_object_type_impl <
                                  conjunction<negation<std::is_same<void, CompatibleObjectType>>,
                                  has_mapped_type<CompatibleObjectType>,
                                  has_key_type<CompatibleObjectType>>::value,
620
                                  typename BasicJsonType::object_t, CompatibleObjectType >::value;
T
Théo DELRIEU 已提交
621 622
};

623
template<typename BasicJsonType, typename T>
624
struct is_basic_json_nested_type
T
Théo DELRIEU 已提交
625
{
626 627 628 629 630
    static auto constexpr value = std::is_same<T, typename BasicJsonType::iterator>::value or
                                  std::is_same<T, typename BasicJsonType::const_iterator>::value or
                                  std::is_same<T, typename BasicJsonType::reverse_iterator>::value or
                                  std::is_same<T, typename BasicJsonType::const_reverse_iterator>::value or
                                  std::is_same<T, typename BasicJsonType::json_pointer>::value;
T
Théo DELRIEU 已提交
631 632
};

633
template<class BasicJsonType, class CompatibleArrayType>
T
Théo DELRIEU 已提交
634 635
struct is_compatible_array_type
{
T
Théo DELRIEU 已提交
636
    static auto constexpr value =
637
        conjunction<negation<std::is_same<void, CompatibleArrayType>>,
T
Théo DELRIEU 已提交
638
        negation<is_compatible_object_type<
639 640
        BasicJsonType, CompatibleArrayType>>,
        negation<std::is_constructible<typename BasicJsonType::string_t,
T
Théo DELRIEU 已提交
641
        CompatibleArrayType>>,
642
        negation<is_basic_json_nested_type<BasicJsonType, CompatibleArrayType>>,
T
Théo DELRIEU 已提交
643 644
        has_value_type<CompatibleArrayType>,
        has_iterator<CompatibleArrayType>>::value;
T
Théo DELRIEU 已提交
645 646
};

647
template<bool, typename, typename>
648
struct is_compatible_integer_type_impl : std::false_type {};
649

650
template<typename RealIntegerType, typename CompatibleNumberIntegerType>
651
struct is_compatible_integer_type_impl<true, RealIntegerType, CompatibleNumberIntegerType>
T
Théo DELRIEU 已提交
652
{
T
Théo DELRIEU 已提交
653
    // is there an assert somewhere on overflows?
654 655 656 657 658 659 660 661
    using RealLimits = std::numeric_limits<RealIntegerType>;
    using CompatibleLimits = std::numeric_limits<CompatibleNumberIntegerType>;

    static constexpr auto value =
        std::is_constructible<RealIntegerType,
        CompatibleNumberIntegerType>::value and
        CompatibleLimits::is_integer and
        RealLimits::is_signed == CompatibleLimits::is_signed;
T
Théo DELRIEU 已提交
662 663
};

664
template<typename RealIntegerType, typename CompatibleNumberIntegerType>
665 666
struct is_compatible_integer_type
{
667 668 669 670 671
    static constexpr auto value =
        is_compatible_integer_type_impl <
        std::is_integral<CompatibleNumberIntegerType>::value and
        not std::is_same<bool, CompatibleNumberIntegerType>::value,
        RealIntegerType, CompatibleNumberIntegerType > ::value;
672 673
};

674

N
Niels Lohmann 已提交
675
// trait checking if JSONSerializer<T>::from_json(json const&, udt&) exists
676
template<typename BasicJsonType, typename T>
677 678
struct has_from_json
{
679 680
  private:
    // also check the return type of from_json
681 682
    template<typename U, typename = enable_if_t<std::is_same<void, decltype(uncvref_t<U>::from_json(
                 std::declval<BasicJsonType>(), std::declval<T&>()))>::value>>
683 684
    static int detect(U&&);
    static void detect(...);
685

686 687
  public:
    static constexpr bool value = std::is_integral<decltype(
688
                                      detect(std::declval<typename BasicJsonType::template json_serializer<T, void>>()))>::value;
689 690 691 692
};

// This trait checks if JSONSerializer<T>::from_json(json const&) exists
// this overload is used for non-default-constructible user-defined-types
693
template<typename BasicJsonType, typename T>
694 695
struct has_non_default_from_json
{
T
Théo DELRIEU 已提交
696 697 698 699
  private:
    template <
        typename U,
        typename = enable_if_t<std::is_same<
700
                                   T, decltype(uncvref_t<U>::from_json(std::declval<BasicJsonType>()))>::value >>
T
Théo DELRIEU 已提交
701 702 703 704 705
    static int detect(U&&);
    static void detect(...);

  public:
    static constexpr bool value = std::is_integral<decltype(detect(
706
                                      std::declval<typename BasicJsonType::template json_serializer<T, void>>()))>::value;
707 708
};

709
// This trait checks if BasicJsonType::json_serializer<T>::to_json exists
710
template<typename BasicJsonType, typename T>
711 712
struct has_to_json
{
T
Théo DELRIEU 已提交
713
  private:
714 715
    template<typename U, typename = decltype(uncvref_t<U>::to_json(
                 std::declval<BasicJsonType&>(), std::declval<T>()))>
T
Théo DELRIEU 已提交
716 717 718 719 720
    static int detect(U&&);
    static void detect(...);

  public:
    static constexpr bool value = std::is_integral<decltype(detect(
721
                                      std::declval<typename BasicJsonType::template json_serializer<T, void>>()))>::value;
722 723
};

724

725 726 727
/////////////
// to_json //
/////////////
728

N
Niels Lohmann 已提交
729
template<typename BasicJsonType, typename T, enable_if_t<
730
             std::is_same<T, typename BasicJsonType::boolean_t>::value, int> = 0>
N
Niels Lohmann 已提交
731
void to_json(BasicJsonType& j, T b) noexcept
732
{
T
Théo DELRIEU 已提交
733
    external_constructor<value_t::boolean>::construct(j, b);
734 735
}

736 737
template<typename BasicJsonType, typename CompatibleString,
         enable_if_t<std::is_constructible<typename BasicJsonType::string_t,
N
Niels Lohmann 已提交
738
                     CompatibleString>::value, int> = 0>
739
void to_json(BasicJsonType& j, const CompatibleString& s)
740
{
T
Théo DELRIEU 已提交
741
    external_constructor<value_t::string>::construct(j, s);
742 743
}

744 745
template<typename BasicJsonType, typename FloatType,
         enable_if_t<std::is_floating_point<FloatType>::value, int> = 0>
746
void to_json(BasicJsonType& j, FloatType val) noexcept
747
{
748
    external_constructor<value_t::number_float>::construct(j, static_cast<typename BasicJsonType::number_float_t>(val));
749 750
}

751
template <
752 753
    typename BasicJsonType, typename CompatibleNumberUnsignedType,
    enable_if_t<is_compatible_integer_type<typename BasicJsonType::number_unsigned_t,
N
Niels Lohmann 已提交
754
                CompatibleNumberUnsignedType>::value, int> = 0 >
755
void to_json(BasicJsonType& j, CompatibleNumberUnsignedType val) noexcept
756
{
757
    external_constructor<value_t::number_unsigned>::construct(j, static_cast<typename BasicJsonType::number_unsigned_t>(val));
758 759
}

760
template <
761 762
    typename BasicJsonType, typename CompatibleNumberIntegerType,
    enable_if_t<is_compatible_integer_type<typename BasicJsonType::number_integer_t,
N
Niels Lohmann 已提交
763
                CompatibleNumberIntegerType>::value, int> = 0 >
764
void to_json(BasicJsonType& j, CompatibleNumberIntegerType val) noexcept
765
{
766
    external_constructor<value_t::number_integer>::construct(j, static_cast<typename BasicJsonType::number_integer_t>(val));
767 768
}

769 770
template<typename BasicJsonType, typename UnscopedEnumType,
         enable_if_t<is_unscoped_enum<UnscopedEnumType>::value, int> = 0>
771
void to_json(BasicJsonType& j, UnscopedEnumType e) noexcept
772
{
T
Théo DELRIEU 已提交
773
    external_constructor<value_t::number_integer>::construct(j, e);
774 775
}

776
template<typename BasicJsonType>
777
void to_json(BasicJsonType& j, const std::vector<bool>& e)
778 779
{
    external_constructor<value_t::array>::construct(j, e);
780 781
}

782
template <
783
    typename BasicJsonType, typename CompatibleArrayType,
T
Théo DELRIEU 已提交
784
    enable_if_t <
785 786
        is_compatible_array_type<BasicJsonType, CompatibleArrayType>::value or
        std::is_same<typename BasicJsonType::array_t, CompatibleArrayType>::value,
T
Théo DELRIEU 已提交
787
        int > = 0 >
788
void to_json(BasicJsonType& j, const  CompatibleArrayType& arr)
789
{
T
Théo DELRIEU 已提交
790
    external_constructor<value_t::array>::construct(j, arr);
791 792
}

793
template <
794 795
    typename BasicJsonType, typename CompatibleObjectType,
    enable_if_t<is_compatible_object_type<BasicJsonType, CompatibleObjectType>::value,
T
Théo DELRIEU 已提交
796
                int> = 0 >
797
void to_json(BasicJsonType& j, const  CompatibleObjectType& arr)
798
{
T
Théo DELRIEU 已提交
799
    external_constructor<value_t::object>::construct(j, arr);
800 801
}

802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836

///////////////
// from_json //
///////////////

// overloads for basic_json template parameters
template<typename BasicJsonType, typename ArithmeticType,
         enable_if_t<std::is_arithmetic<ArithmeticType>::value and
                     not std::is_same<ArithmeticType,
                                      typename BasicJsonType::boolean_t>::value,
                     int> = 0>
void get_arithmetic_value(const BasicJsonType& j, ArithmeticType& val)
{
    switch (static_cast<value_t>(j))
    {
        case value_t::number_unsigned:
        {
            val = static_cast<ArithmeticType>(
                      *j.template get_ptr<const typename BasicJsonType::number_unsigned_t*>());
            break;
        }
        case value_t::number_integer:
        {
            val = static_cast<ArithmeticType>(
                      *j.template get_ptr<const typename BasicJsonType::number_integer_t*>());
            break;
        }
        case value_t::number_float:
        {
            val = static_cast<ArithmeticType>(
                      *j.template get_ptr<const typename BasicJsonType::number_float_t*>());
            break;
        }
        default:
        {
837
            JSON_THROW(type_error(302, "type must be number, but is " + j.type_name()));
838 839 840 841 842
        }
    }
}

template<typename BasicJsonType>
843
void from_json(const BasicJsonType& j, typename BasicJsonType::boolean_t& b)
844
{
N
Niels Lohmann 已提交
845
    if (not j.is_boolean())
T
Théo DELRIEU 已提交
846
    {
847
        JSON_THROW(type_error(302, "type must be boolean, but is " + j.type_name()));
T
Théo DELRIEU 已提交
848
    }
849
    b = *j.template get_ptr<const typename BasicJsonType::boolean_t*>();
850 851
}

852
template<typename BasicJsonType>
853
void from_json(const BasicJsonType& j, typename BasicJsonType::string_t& s)
854
{
N
Niels Lohmann 已提交
855
    if (not j.is_string())
T
Théo DELRIEU 已提交
856
    {
857
        JSON_THROW(type_error(302, "type must be string, but is " + j.type_name()));
T
Théo DELRIEU 已提交
858
    }
859
    s = *j.template get_ptr<const typename BasicJsonType::string_t*>();
860 861
}

862
template<typename BasicJsonType>
863
void from_json(const BasicJsonType& j, typename BasicJsonType::number_float_t& val)
864
{
T
Théo DELRIEU 已提交
865
    get_arithmetic_value(j, val);
866 867
}

868
template<typename BasicJsonType>
869
void from_json(const BasicJsonType& j, typename BasicJsonType::number_unsigned_t& val)
870
{
T
Théo DELRIEU 已提交
871
    get_arithmetic_value(j, val);
872 873
}

874
template<typename BasicJsonType>
875
void from_json(const BasicJsonType& j, typename BasicJsonType::number_integer_t& val)
876
{
T
Théo DELRIEU 已提交
877
    get_arithmetic_value(j, val);
878 879
}

880 881 882
template<typename BasicJsonType, typename UnscopedEnumType,
         enable_if_t<is_unscoped_enum<UnscopedEnumType>::value, int> = 0>
void from_json(const BasicJsonType& j, UnscopedEnumType& e)
883
{
884
    typename std::underlying_type<UnscopedEnumType>::type val;
T
Théo DELRIEU 已提交
885 886
    get_arithmetic_value(j, val);
    e = static_cast<UnscopedEnumType>(val);
887 888
}

889 890
template<typename BasicJsonType>
void from_json(const BasicJsonType& j, typename BasicJsonType::array_t& arr)
891
{
N
Niels Lohmann 已提交
892
    if (not j.is_array())
T
Théo DELRIEU 已提交
893
    {
894
        JSON_THROW(type_error(302, "type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
895
    }
896
    arr = *j.template get_ptr<const typename BasicJsonType::array_t*>();
897 898
}

899
// forward_list doesn't have an insert method
900 901
template<typename BasicJsonType, typename T, typename Allocator,
         enable_if_t<std::is_convertible<BasicJsonType, T>::value, int> = 0>
902
void from_json(const BasicJsonType& j, std::forward_list<T, Allocator>& l)
903
{
904
    if (not j.is_array())
T
Théo DELRIEU 已提交
905
    {
906
        JSON_THROW(type_error(302, "type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
907
    }
908

T
Théo DELRIEU 已提交
909 910 911 912
    for (auto it = j.rbegin(), end = j.rend(); it != end; ++it)
    {
        l.push_front(it->template get<T>());
    }
913 914
}

915 916
template<typename BasicJsonType, typename CompatibleArrayType>
void from_json_array_impl(const BasicJsonType& j, CompatibleArrayType& arr, priority_tag<0>)
917
{
T
Théo DELRIEU 已提交
918 919
    using std::begin;
    using std::end;
920

921 922
    std::transform(j.begin(), j.end(),
                   std::inserter(arr, end(arr)), [](const BasicJsonType & i)
T
Théo DELRIEU 已提交
923
    {
924 925
        // get<BasicJsonType>() returns *this, this won't call a from_json
        // method when value_type is BasicJsonType
926
        return i.template get<typename CompatibleArrayType::value_type>();
T
Théo DELRIEU 已提交
927
    });
928 929
}

930 931
template<typename BasicJsonType, typename CompatibleArrayType>
auto from_json_array_impl(const BasicJsonType& j, CompatibleArrayType& arr, priority_tag<1>)
T
Théo DELRIEU 已提交
932 933 934
-> decltype(
    arr.reserve(std::declval<typename CompatibleArrayType::size_type>()),
    void())
935
{
T
Théo DELRIEU 已提交
936 937
    using std::begin;
    using std::end;
938

T
Théo DELRIEU 已提交
939
    arr.reserve(j.size());
940 941
    std::transform(j.begin(), j.end(),
                   std::inserter(arr, end(arr)), [](const BasicJsonType & i)
T
Théo DELRIEU 已提交
942
    {
943 944
        // get<BasicJsonType>() returns *this, this won't call a from_json
        // method when value_type is BasicJsonType
945
        return i.template get<typename CompatibleArrayType::value_type>();
T
Théo DELRIEU 已提交
946
    });
947 948
}

949 950
template<typename BasicJsonType, typename CompatibleArrayType,
         enable_if_t<is_compatible_array_type<BasicJsonType, CompatibleArrayType>::value and
951
                     std::is_convertible<BasicJsonType, typename CompatibleArrayType::value_type>::value and
952 953
                     not std::is_same<typename BasicJsonType::array_t, CompatibleArrayType>::value, int> = 0>
void from_json(const BasicJsonType& j, CompatibleArrayType& arr)
954
{
955
    if (not j.is_array())
T
Théo DELRIEU 已提交
956
    {
957
        JSON_THROW(type_error(302, "type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
958
    }
959

T
Théo DELRIEU 已提交
960
    from_json_array_impl(j, arr, priority_tag<1> {});
961 962
}

963 964 965
template<typename BasicJsonType, typename CompatibleObjectType,
         enable_if_t<is_compatible_object_type<BasicJsonType, CompatibleObjectType>::value, int> = 0>
void from_json(const BasicJsonType& j, CompatibleObjectType& obj)
966
{
N
Niels Lohmann 已提交
967
    if (not j.is_object())
T
Théo DELRIEU 已提交
968
    {
969
        JSON_THROW(type_error(302, "type must be object, but is " + j.type_name()));
T
Théo DELRIEU 已提交
970 971
    }

972
    auto inner_object = j.template get_ptr<const typename BasicJsonType::object_t*>();
T
Théo DELRIEU 已提交
973 974 975
    using std::begin;
    using std::end;
    // we could avoid the assignment, but this might require a for loop, which
N
Niels Lohmann 已提交
976 977
    // might be less efficient than the container constructor for some
    // containers (would it?)
T
Théo DELRIEU 已提交
978
    obj = CompatibleObjectType(begin(*inner_object), end(*inner_object));
979 980
}

N
Niels Lohmann 已提交
981 982 983 984
// overload for arithmetic types, not chosen for basic_json template arguments
// (BooleanType, etc..); note: Is it really necessary to provide explicit
// overloads for boolean_t etc. in case of a custom BooleanType which is not
// an arithmetic type?
985 986 987 988 989 990 991 992
template<typename BasicJsonType, typename ArithmeticType,
         enable_if_t <
             std::is_arithmetic<ArithmeticType>::value and
             not std::is_same<ArithmeticType, typename BasicJsonType::number_unsigned_t>::value and
             not std::is_same<ArithmeticType, typename BasicJsonType::number_integer_t>::value and
             not std::is_same<ArithmeticType, typename BasicJsonType::number_float_t>::value and
             not std::is_same<ArithmeticType, typename BasicJsonType::boolean_t>::value,
             int> = 0>
993
void from_json(const BasicJsonType& j, ArithmeticType& val)
T
Théo DELRIEU 已提交
994 995 996 997
{
    switch (static_cast<value_t>(j))
    {
        case value_t::number_unsigned:
N
Niels Lohmann 已提交
998
        {
999
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_unsigned_t*>());
T
Théo DELRIEU 已提交
1000
            break;
N
Niels Lohmann 已提交
1001
        }
T
Théo DELRIEU 已提交
1002
        case value_t::number_integer:
N
Niels Lohmann 已提交
1003
        {
1004
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_integer_t*>());
T
Théo DELRIEU 已提交
1005
            break;
N
Niels Lohmann 已提交
1006
        }
T
Théo DELRIEU 已提交
1007
        case value_t::number_float:
N
Niels Lohmann 已提交
1008
        {
1009
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_float_t*>());
T
Théo DELRIEU 已提交
1010
            break;
N
Niels Lohmann 已提交
1011
        }
T
Théo DELRIEU 已提交
1012
        case value_t::boolean:
N
Niels Lohmann 已提交
1013
        {
1014
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::boolean_t*>());
T
Théo DELRIEU 已提交
1015
            break;
N
Niels Lohmann 已提交
1016
        }
T
Théo DELRIEU 已提交
1017
        default:
N
Niels Lohmann 已提交
1018
        {
1019
            JSON_THROW(type_error(302, "type must be number, but is " + j.type_name()));
N
Niels Lohmann 已提交
1020
        }
T
Théo DELRIEU 已提交
1021
    }
1022 1023
}

1024 1025
struct to_json_fn
{
N
Niels Lohmann 已提交
1026
  private:
1027 1028 1029
    template<typename BasicJsonType, typename T>
    auto call(BasicJsonType& j, T&& val, priority_tag<1>) const noexcept(noexcept(to_json(j, std::forward<T>(val))))
    -> decltype(to_json(j, std::forward<T>(val)), void())
1030
    {
1031
        return to_json(j, std::forward<T>(val));
1032
    }
T
Théo DELRIEU 已提交
1033

1034
    template<typename BasicJsonType, typename T>
1035
    void call(BasicJsonType&, T&&, priority_tag<0>) const noexcept
T
Théo DELRIEU 已提交
1036
    {
1037 1038
        static_assert(sizeof(BasicJsonType) == 0,
                      "could not find to_json() method in T's namespace");
T
Théo DELRIEU 已提交
1039 1040
    }

T
Théo DELRIEU 已提交
1041
  public:
1042
    template<typename BasicJsonType, typename T>
1043
    void operator()(BasicJsonType& j, T&& val) const
T
Théo DELRIEU 已提交
1044 1045 1046 1047
    noexcept(noexcept(std::declval<to_json_fn>().call(j, std::forward<T>(val), priority_tag<1> {})))
    {
        return call(j, std::forward<T>(val), priority_tag<1> {});
    }
1048 1049 1050 1051
};

struct from_json_fn
{
T
Théo DELRIEU 已提交
1052
  private:
1053 1054
    template<typename BasicJsonType, typename T>
    auto call(const BasicJsonType& j, T& val, priority_tag<1>) const
T
Théo DELRIEU 已提交
1055 1056 1057 1058 1059 1060
    noexcept(noexcept(from_json(j, val)))
    -> decltype(from_json(j, val), void())
    {
        return from_json(j, val);
    }

1061
    template<typename BasicJsonType, typename T>
1062
    void call(const BasicJsonType&, T&, priority_tag<0>) const noexcept
T
Théo DELRIEU 已提交
1063
    {
1064 1065
        static_assert(sizeof(BasicJsonType) == 0,
                      "could not find from_json() method in T's namespace");
T
Théo DELRIEU 已提交
1066 1067 1068
    }

  public:
1069 1070
    template<typename BasicJsonType, typename T>
    void operator()(const BasicJsonType& j, T& val) const
T
Théo DELRIEU 已提交
1071 1072 1073 1074
    noexcept(noexcept(std::declval<from_json_fn>().call(j, val, priority_tag<1> {})))
    {
        return call(j, val, priority_tag<1> {});
    }
1075
};
1076

1077
// taken from ranges-v3
1078
template<typename T>
1079 1080 1081 1082 1083
struct static_const
{
    static constexpr T value{};
};

1084
template<typename T>
1085
constexpr T static_const<T>::value;
1086 1087
} // namespace detail

N
Niels 已提交
1088

N
Niels Lohmann 已提交
1089
/// namespace to hold default `to_json` / `from_json` functions
1090
namespace
1091
{
T
Théo DELRIEU 已提交
1092 1093
constexpr const auto& to_json = detail::static_const<detail::to_json_fn>::value;
constexpr const auto& from_json = detail::static_const<detail::from_json_fn>::value;
1094 1095
}

N
Niels Lohmann 已提交
1096 1097 1098 1099 1100 1101 1102 1103

/*!
@brief default JSONSerializer template argument

This serializer ignores the template arguments and uses ADL
([argument-dependent lookup](http://en.cppreference.com/w/cpp/language/adl))
for serialization.
*/
1104
template<typename = void, typename = void>
1105 1106
struct adl_serializer
{
N
Niels Lohmann 已提交
1107 1108 1109 1110 1111 1112 1113
    /*!
    @brief convert a JSON value to any value type

    This function is usually called by the `get()` function of the
    @ref basic_json class (either explicit or via conversion operators).

    @param[in] j         JSON value to read from
1114
    @param[in,out] val  value to write to
N
Niels Lohmann 已提交
1115 1116 1117 1118
    */
    template<typename BasicJsonType, typename ValueType>
    static void from_json(BasicJsonType&& j, ValueType& val) noexcept(
        noexcept(::nlohmann::from_json(std::forward<BasicJsonType>(j), val)))
1119
    {
1120
        ::nlohmann::from_json(std::forward<BasicJsonType>(j), val);
1121 1122
    }

N
Niels Lohmann 已提交
1123 1124 1125 1126 1127 1128
    /*!
    @brief convert any value type to a JSON value

    This function is usually called by the constructors of the @ref basic_json
    class.

1129
    @param[in,out] j  JSON value to write to
N
Niels Lohmann 已提交
1130 1131 1132 1133 1134
    @param[in] val     value to read from
    */
    template<typename BasicJsonType, typename ValueType>
    static void to_json(BasicJsonType& j, ValueType&& val) noexcept(
        noexcept(::nlohmann::to_json(j, std::forward<ValueType>(val))))
1135
    {
N
Niels Lohmann 已提交
1136
        ::nlohmann::to_json(j, std::forward<ValueType>(val));
1137
    }
1138 1139
};

1140

N
Niels 已提交
1141
/*!
N
Niels 已提交
1142
@brief a class to store JSON values
N
Niels 已提交
1143

N
Niels 已提交
1144
@tparam ObjectType type for JSON objects (`std::map` by default; will be used
N
Niels 已提交
1145
in @ref object_t)
N
Niels 已提交
1146
@tparam ArrayType type for JSON arrays (`std::vector` by default; will be used
N
Niels 已提交
1147
in @ref array_t)
N
Niels 已提交
1148
@tparam StringType type for JSON strings and object keys (`std::string` by
N
Niels 已提交
1149
default; will be used in @ref string_t)
N
Niels 已提交
1150
@tparam BooleanType type for JSON booleans (`bool` by default; will be used
N
Niels 已提交
1151
in @ref boolean_t)
N
Niels 已提交
1152
@tparam NumberIntegerType type for JSON integer numbers (`int64_t` by
N
Niels 已提交
1153
default; will be used in @ref number_integer_t)
N
Niels 已提交
1154 1155
@tparam NumberUnsignedType type for JSON unsigned integer numbers (@c
`uint64_t` by default; will be used in @ref number_unsigned_t)
N
Niels 已提交
1156
@tparam NumberFloatType type for JSON floating-point numbers (`double` by
N
Niels 已提交
1157
default; will be used in @ref number_float_t)
N
Niels 已提交
1158
@tparam AllocatorType type of the allocator to use (`std::allocator` by
N
Niels 已提交
1159
default)
N
Niels Lohmann 已提交
1160
@tparam JSONSerializer the serializer to resolve internal calls to `to_json()`
N
Niels Lohmann 已提交
1161
and `from_json()` (@ref adl_serializer by default)
N
Niels 已提交
1162

N
Niels 已提交
1163 1164
@requirement The class satisfies the following concept requirements:
- Basic
N
Niels 已提交
1165
 - [DefaultConstructible](http://en.cppreference.com/w/cpp/concept/DefaultConstructible):
N
Niels Lohmann 已提交
1166 1167
   JSON values can be default constructed. The result will be a JSON null
   value.
N
Niels 已提交
1168 1169 1170
 - [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 已提交
1171
   A JSON value can be copy-constructed from an lvalue expression.
N
Niels 已提交
1172 1173 1174 1175 1176 1177
 - [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 已提交
1178
- Layout
N
Niels 已提交
1179 1180 1181
 - [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):
N
Niels Lohmann 已提交
1182 1183
   All non-static data members are private and standard layout types, the
   class has no virtual functions or (virtual) base classes.
N
Niels 已提交
1184
- Library-wide
N
Niels 已提交
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196
 - [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 已提交
1197
- Container
N
Niels 已提交
1198 1199 1200 1201 1202
 - [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 已提交
1203

1204 1205 1206 1207 1208 1209 1210
@invariant The member variables @a m_value and @a m_type have the following
relationship:
- If `m_type == value_t::object`, then `m_value.object != nullptr`.
- If `m_type == value_t::array`, then `m_value.array != nullptr`.
- If `m_type == value_t::string`, then `m_value.string != nullptr`.
The invariants are checked by member function assert_invariant().

N
Niels 已提交
1211
@internal
N
Niels 已提交
1212
@note ObjectType trick from http://stackoverflow.com/a/9860911
N
Niels 已提交
1213
@endinternal
N
Niels 已提交
1214

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

N
Niels 已提交
1218
@since version 1.0.0
N
Niels 已提交
1219 1220

@nosubgrouping
N
Niels 已提交
1221 1222 1223 1224 1225 1226
*/
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,
1227 1228
    class NumberIntegerType = std::int64_t,
    class NumberUnsignedType = std::uint64_t,
N
Niels 已提交
1229
    class NumberFloatType = double,
1230
    template<typename U> class AllocatorType = std::allocator,
1231
    template<typename T, typename SFINAE = void> class JSONSerializer = adl_serializer
N
Niels 已提交
1232 1233 1234
    >
class basic_json
{
1235
  private:
1236
    template<detail::value_t> friend struct detail::external_constructor;
1237
    /// workaround type for MSVC
N
Niels 已提交
1238 1239
    using basic_json_t = basic_json<ObjectType, ArrayType, StringType,
          BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType,
1240
          AllocatorType, JSONSerializer>;
1241 1242

  public:
1243
    using value_t = detail::value_t;
N
Niels 已提交
1244
    // forward declarations
N
Niels Lohmann 已提交
1245
    template<typename U> class iter_impl;
N
Niels 已提交
1246 1247
    template<typename Base> class json_reverse_iterator;
    class json_pointer;
1248
    template<typename T, typename SFINAE>
1249
    using json_serializer = JSONSerializer<T, SFINAE>;
1250

1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267

    ////////////////
    // exceptions //
    ////////////////

    /// @name exceptions
    /// Classes to implement user-defined exceptions.
    /// @{

    /// @copydoc detail::parse_error
    using parse_error = detail::parse_error;
    /// @copydoc detail::invalid_iterator
    using invalid_iterator = detail::invalid_iterator;
    /// @copydoc detail::type_error
    using type_error = detail::type_error;
    /// @copydoc detail::out_of_range
    using out_of_range = detail::out_of_range;
1268 1269
    /// @copydoc detail::other_error
    using other_error = detail::other_error;
1270 1271 1272 1273

    /// @}


N
Niels 已提交
1274 1275 1276 1277
    /////////////////////
    // container types //
    /////////////////////

N
Niels 已提交
1278
    /// @name container types
N
Niels 已提交
1279 1280
    /// The canonic container types to use @ref basic_json like any other STL
    /// container.
N
Niels 已提交
1281 1282
    /// @{

N
Niels 已提交
1283
    /// the type of elements in a basic_json container
N
Niels 已提交
1284
    using value_type = basic_json;
N
Niels 已提交
1285

N
Niels 已提交
1286
    /// the type of an element reference
N
Niels 已提交
1287
    using reference = value_type&;
N
Niels 已提交
1288
    /// the type of an element const reference
N
Niels 已提交
1289
    using const_reference = const value_type&;
N
Niels 已提交
1290

N
Niels 已提交
1291
    /// a type to represent differences between iterators
N
Niels 已提交
1292
    using difference_type = std::ptrdiff_t;
N
Niels 已提交
1293
    /// a type to represent container sizes
N
Niels 已提交
1294 1295 1296
    using size_type = std::size_t;

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

N
Niels 已提交
1299
    /// the type of an element pointer
N
Niels 已提交
1300
    using pointer = typename std::allocator_traits<allocator_type>::pointer;
N
Niels 已提交
1301
    /// the type of an element const pointer
N
Niels 已提交
1302
    using const_pointer = typename std::allocator_traits<allocator_type>::const_pointer;
N
Niels 已提交
1303

N
Niels 已提交
1304
    /// an iterator for a basic_json container
1305
    using iterator = iter_impl<basic_json>;
N
Niels 已提交
1306
    /// a const iterator for a basic_json container
1307
    using const_iterator = iter_impl<const basic_json>;
N
Niels 已提交
1308
    /// a reverse iterator for a basic_json container
N
Niels 已提交
1309
    using reverse_iterator = json_reverse_iterator<typename basic_json::iterator>;
N
Niels 已提交
1310
    /// a const reverse iterator for a basic_json container
N
Niels 已提交
1311
    using const_reverse_iterator = json_reverse_iterator<typename basic_json::const_iterator>;
N
Niels 已提交
1312

N
Niels 已提交
1313 1314 1315
    /// @}


N
Niels 已提交
1316 1317 1318
    /*!
    @brief returns the allocator associated with the container
    */
N
Niels 已提交
1319
    static allocator_type get_allocator()
N
Niels 已提交
1320 1321 1322 1323
    {
        return allocator_type();
    }

1324 1325
    /*!
    @brief returns version information on the library
1326

N
Niels Lohmann 已提交
1327
    This function returns a JSON object with information about the library,
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345
    including the version number and information on the platform and compiler.

    @return JSON object holding version information
    key         | description
    ----------- | ---------------
    `compiler`  | Information on the used compiler. It is an object with the following keys: `c++` (the used C++ standard), `family` (the compiler family; possible values are `clang`, `icc`, `gcc`, `ilecpp`, `msvc`, `pgcpp`, `sunpro`, and `unknown`), and `version` (the compiler version).
    `copyright` | The copyright line for the library as string.
    `name`      | The name of the library as string.
    `platform`  | The used platform as string. Possible values are `win32`, `linux`, `apple`, `unix`, and `unknown`.
    `url`       | The URL of the project as string.
    `version`   | The version of the library. It is an object with the following keys: `major`, `minor`, and `patch` as defined by [Semantic Versioning](http://semver.org), and `string` (the version string).

    @liveexample{The following code shows an example output of the `meta()`
    function.,meta}

    @complexity Constant.

    @since 2.1.0
1346
    */
1347
    static basic_json meta()
1348 1349 1350
    {
        basic_json result;

1351
        result["copyright"] = "(C) 2013-2017 Niels Lohmann";
1352 1353 1354 1355
        result["name"] = "JSON for Modern C++";
        result["url"] = "https://github.com/nlohmann/json";
        result["version"] =
        {
N
Niels Lohmann 已提交
1356
            {"string", "2.1.1"}, {"major", 2}, {"minor", 1}, {"patch", 1}
1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371
        };

#ifdef _WIN32
        result["platform"] = "win32";
#elif defined __linux__
        result["platform"] = "linux";
#elif defined __APPLE__
        result["platform"] = "apple";
#elif defined __unix__
        result["platform"] = "unix";
#else
        result["platform"] = "unknown";
#endif

#if defined(__clang__)
1372
        result["compiler"] = {{"family", "clang"}, {"version", __clang_version__}};
1373 1374 1375
#elif defined(__ICC) || defined(__INTEL_COMPILER)
        result["compiler"] = {{"family", "icc"}, {"version", __INTEL_COMPILER}};
#elif defined(__GNUC__) || defined(__GNUG__)
1376
        result["compiler"] = {{"family", "gcc"}, {"version", std::to_string(__GNUC__) + "." + std::to_string(__GNUC_MINOR__) + "." + std::to_string(__GNUC_PATCHLEVEL__)}};
1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398
#elif defined(__HP_cc) || defined(__HP_aCC)
        result["compiler"] = "hp"
#elif defined(__IBMCPP__)
        result["compiler"] = {{"family", "ilecpp"}, {"version", __IBMCPP__}};
#elif defined(_MSC_VER)
        result["compiler"] = {{"family", "msvc"}, {"version", _MSC_VER}};
#elif defined(__PGI)
        result["compiler"] = {{"family", "pgcpp"}, {"version", __PGI}};
#elif defined(__SUNPRO_CC)
        result["compiler"] = {{"family", "sunpro"}, {"version", __SUNPRO_CC}};
#else
        result["compiler"] = {{"family", "unknown"}, {"version", "unknown"}};
#endif

#ifdef __cplusplus
        result["compiler"]["c++"] = std::to_string(__cplusplus);
#else
        result["compiler"]["c++"] = "unknown";
#endif
        return result;
    }

N
Niels 已提交
1399

N
Niels 已提交
1400 1401 1402 1403
    ///////////////////////////
    // JSON value data types //
    ///////////////////////////

N
Niels 已提交
1404
    /// @name JSON value data types
N
Niels 已提交
1405 1406
    /// The data types to store a JSON value. These types are derived from
    /// the template arguments passed to class @ref basic_json.
N
Niels 已提交
1407 1408
    /// @{

N
Niels 已提交
1409 1410 1411 1412 1413 1414 1415 1416
    /*!
    @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 已提交
1417 1418 1419 1420 1421
    To store objects in C++, a type is defined by the template parameters
    described below.

    @tparam ObjectType  the container to store objects (e.g., `std::map` or
    `std::unordered_map`)
N
Niels 已提交
1422 1423
    @tparam StringType the type of the keys or names (e.g., `std::string`).
    The comparison function `std::less<StringType>` is used to order elements
N
Niels 已提交
1424 1425 1426
    inside the container.
    @tparam AllocatorType the allocator to use for objects (e.g.,
    `std::allocator`)
N
Niels 已提交
1427 1428 1429 1430

    #### Default type

    With the default values for @a ObjectType (`std::map`), @a StringType
N
Niels 已提交
1431 1432
    (`std::string`), and @a AllocatorType (`std::allocator`), the default
    value for @a object_t is:
N
Niels 已提交
1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448

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

    #### Behavior

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

    - When all names are unique, objects will be interoperable in the sense
N
Niels 已提交
1449 1450
      that all software implementations receiving that object will agree on
      the name-value mappings.
N
Niels 已提交
1451 1452 1453 1454 1455
    - When the names within an object are not unique, later stored name/value
      pairs overwrite previously stored name/value pairs, leaving the used
      names unique. For instance, `{"key": 1}` and `{"key": 2, "key": 1}` will
      be treated as equal and both stored as `{"key": 1}`.
    - Internally, name/value pairs are stored in lexicographical order of the
N
Niels 已提交
1456 1457 1458
      names. Objects will also be serialized (see @ref dump) in this order.
      For instance, `{"b": 1, "a": 2}` and `{"a": 2, "b": 1}` will be stored
      and serialized as `{"a": 2, "b": 1}`.
N
Niels 已提交
1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470
    - When comparing objects, the order of the name/value pairs is irrelevant.
      This makes objects interoperable in the sense that they will not be
      affected by these differences. For instance, `{"b": 1, "a": 2}` and
      `{"a": 2, "b": 1}` will be treated as equal.

    #### Limits

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

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

    #### Storage

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

1480 1481
    @sa @ref array_t -- type for an array value

N
Niels 已提交
1482
    @since version 1.0.0
N
Niels 已提交
1483

N
Niels 已提交
1484 1485 1486 1487 1488
    @note The order name/value pairs are added to the object is *not*
    preserved by the library. Therefore, iterating an object may return
    name/value pairs in a different order than they were originally stored. In
    fact, keys will be traversed in alphabetical order as `std::map` with
    `std::less` is used by default. Please note this behavior conforms to [RFC
N
Niels 已提交
1489 1490
    7159](http://rfc7159.net/rfc7159), because any order implements the
    specified "unordered" nature of JSON objects.
N
Niels 已提交
1491
    */
N
Niels 已提交
1492 1493 1494 1495 1496
    using object_t = ObjectType<StringType,
          basic_json,
          std::less<StringType>,
          AllocatorType<std::pair<const StringType,
          basic_json>>>;
N
Niels 已提交
1497 1498 1499 1500 1501 1502 1503

    /*!
    @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 已提交
1504 1505 1506 1507 1508
    To store objects in C++, a type is defined by the template parameters
    explained below.

    @tparam ArrayType  container type to store arrays (e.g., `std::vector` or
    `std::list`)
N
Niels 已提交
1509
    @tparam AllocatorType allocator to use for arrays (e.g., `std::allocator`)
N
Niels 已提交
1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529

    #### Default type

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

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

    #### Limits

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

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

    #### Storage

1535
    Arrays are stored as pointers in a @ref basic_json type. That is, for any
N
Niels 已提交
1536
    access to array values, a pointer of type `array_t*` must be dereferenced.
1537 1538 1539

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

N
Niels 已提交
1540
    @since version 1.0.0
N
Niels 已提交
1541
    */
N
Niels 已提交
1542
    using array_t = ArrayType<basic_json, AllocatorType<basic_json>>;
N
Niels 已提交
1543 1544 1545 1546 1547 1548 1549

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

N
Niels 已提交
1554 1555
    @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 已提交
1556 1557 1558 1559 1560 1561 1562 1563 1564 1565

    #### Default type

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

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

1566 1567 1568 1569 1570 1571
    #### Encoding

    Strings are stored in UTF-8 encoding. Therefore, functions like
    `std::string::size()` or `std::string::length()` return the number of
    bytes in the string rather than the number of characters or glyphs.

N
Niels 已提交
1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588
    #### 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

1589 1590
    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 已提交
1591
    dereferenced.
1592

N
Niels 已提交
1593
    @since version 1.0.0
N
Niels 已提交
1594
    */
N
Niels 已提交
1595
    using string_t = StringType;
N
Niels 已提交
1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616

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

1617 1618
    Boolean values are stored directly inside a @ref basic_json type.

N
Niels 已提交
1619
    @since version 1.0.0
N
Niels 已提交
1620
    */
N
Niels 已提交
1621
    using boolean_t = BooleanType;
N
Niels 已提交
1622 1623 1624 1625 1626

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

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639
    > The representation of numbers is similar to that used in most
    > programming languages. A number is represented in base 10 using decimal
    > digits. It contains an integer component that may be prefixed with an
    > optional minus sign, which may be followed by a fraction part and/or an
    > exponent part. Leading zeros are not allowed. (...) Numeric values that
    > cannot be represented in the grammar below (such as Infinity and NaN)
    > are not permitted.

    This description includes both integer and floating-point numbers.
    However, C++ allows more precise storage if it is known whether the number
    is a signed integer, an unsigned integer or a floating-point number.
    Therefore, three different types, @ref number_integer_t, @ref
    number_unsigned_t and @ref number_float_t are used.
N
Niels 已提交
1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657

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

    #### Default type

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

    @code {.cpp}
    int64_t
    @endcode

    #### Default behavior

    - The restrictions about leading zeros is not enforced in C++. Instead,
      leading zeros in integer literals lead to an interpretation as octal
      number. Internally, the value will be stored as decimal number. For
N
Niels 已提交
1658 1659
      instance, the C++ integer literal `010` will be serialized to `8`.
      During deserialization, leading zeros yield an error.
N
Niels 已提交
1660 1661 1662 1663 1664 1665 1666 1667 1668 1669
    - Not-a-number (NaN) values will be serialized to `null`.

    #### Limits

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

    When the default type is used, the maximal integer number that can be
    stored is `9223372036854775807` (INT64_MAX) and the minimal integer number
    that can be stored is `-9223372036854775808` (INT64_MIN). Integer numbers
N
Niels 已提交
1670 1671 1672 1673
    that are out of range will yield over/underflow when used in a
    constructor. During deserialization, too large or small integer numbers
    will be automatically be stored as @ref number_unsigned_t or @ref
    number_float_t.
N
Niels 已提交
1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684

    [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

1685 1686 1687 1688
    Integer number values are stored directly inside a @ref basic_json type.

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

1689 1690
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
1691
    @since version 1.0.0
N
Niels 已提交
1692
    */
N
Niels 已提交
1693
    using number_integer_t = NumberIntegerType;
N
Niels 已提交
1694

1695 1696 1697 1698
    /*!
    @brief a type for a number (unsigned)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714
    > The representation of numbers is similar to that used in most
    > programming languages. A number is represented in base 10 using decimal
    > digits. It contains an integer component that may be prefixed with an
    > optional minus sign, which may be followed by a fraction part and/or an
    > exponent part. Leading zeros are not allowed. (...) Numeric values that
    > cannot be represented in the grammar below (such as Infinity and NaN)
    > are not permitted.

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

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

    #### Default type

N
Niels 已提交
1718 1719
    With the default values for @a NumberUnsignedType (`uint64_t`), the
    default value for @a number_unsigned_t is:
1720 1721 1722 1723 1724 1725 1726 1727 1728 1729

    @code {.cpp}
    uint64_t
    @endcode

    #### Default behavior

    - The restrictions about leading zeros is not enforced in C++. Instead,
      leading zeros in integer literals lead to an interpretation as octal
      number. Internally, the value will be stored as decimal number. For
N
Niels 已提交
1730 1731
      instance, the C++ integer literal `010` will be serialized to `8`.
      During deserialization, leading zeros yield an error.
1732 1733 1734 1735 1736 1737 1738 1739
    - 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 已提交
1740 1741 1742 1743 1744
    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.
1745 1746 1747 1748 1749 1750 1751

    [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 已提交
1752 1753
    number_integer_t type) of the exactly supported range [0, UINT64_MAX],
    this class's integer type is interoperable.
1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764

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

N
Niels 已提交
1766 1767 1768 1769
    /*!
    @brief a type for a number (floating-point)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782
    > The representation of numbers is similar to that used in most
    > programming languages. A number is represented in base 10 using decimal
    > digits. It contains an integer component that may be prefixed with an
    > optional minus sign, which may be followed by a fraction part and/or an
    > exponent part. Leading zeros are not allowed. (...) Numeric values that
    > cannot be represented in the grammar below (such as Infinity and NaN)
    > are not permitted.

    This description includes both integer and floating-point numbers.
    However, C++ allows more precise storage if it is known whether the number
    is a signed integer, an unsigned integer or a floating-point number.
    Therefore, three different types, @ref number_integer_t, @ref
    number_unsigned_t and @ref number_float_t are used.
N
Niels 已提交
1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798

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

    #### Default type

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

    @code {.cpp}
    double
    @endcode

    #### Default behavior

    - The restrictions about leading zeros is not enforced in C++. Instead,
N
Niels 已提交
1799 1800
      leading zeros in floating-point literals will be ignored. Internally,
      the value will be stored as decimal number. For instance, the C++
N
Niels 已提交
1801 1802 1803 1804 1805 1806 1807 1808 1809 1810
      floating-point literal `01.2` will be serialized to `1.2`. During
      deserialization, leading zeros yield an error.
    - Not-a-number (NaN) values will be serialized to `null`.

    #### Limits

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

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

    #### Storage

1823 1824 1825 1826 1827
    Floating-point number values are stored directly inside a @ref basic_json
    type.

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

1828 1829
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
1830
    @since version 1.0.0
N
Niels 已提交
1831
    */
N
Niels 已提交
1832 1833
    using number_float_t = NumberFloatType;

N
Niels 已提交
1834 1835
    /// @}

N
Niels 已提交
1836
  private:
N
Niels 已提交
1837

N
Cleanup  
Niels 已提交
1838 1839
    /// helper for exception-safe object creation
    template<typename T, typename... Args>
N
cleanup  
Niels 已提交
1840
    static T* create(Args&& ... args)
N
Cleanup  
Niels 已提交
1841 1842 1843 1844 1845 1846 1847 1848
    {
        AllocatorType<T> alloc;
        auto deleter = [&](T * object)
        {
            alloc.deallocate(object, 1);
        };
        std::unique_ptr<T, decltype(deleter)> object(alloc.allocate(1), deleter);
        alloc.construct(object.get(), std::forward<Args>(args)...);
N
Niels Lohmann 已提交
1849
        assert(object != nullptr);
N
Cleanup  
Niels 已提交
1850 1851 1852
        return object.release();
    }

N
Niels 已提交
1853 1854 1855 1856
    ////////////////////////
    // JSON value storage //
    ////////////////////////

1857 1858 1859
    /*!
    @brief a JSON value

N
Niels 已提交
1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877
    The actual storage for a JSON value of the @ref basic_json class. This
    union combines the different storage types for the JSON value types
    defined in @ref value_t.

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

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

N
Niels 已提交
1879
    @since version 1.0.0
1880
    */
N
Niels 已提交
1881 1882 1883 1884 1885 1886 1887 1888
    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 已提交
1889
        /// boolean
N
Niels 已提交
1890 1891 1892
        boolean_t boolean;
        /// number (integer)
        number_integer_t number_integer;
1893 1894
        /// number (unsigned integer)
        number_unsigned_t number_unsigned;
N
Niels 已提交
1895
        /// number (floating-point)
N
Niels 已提交
1896 1897 1898
        number_float_t number_float;

        /// default constructor (for null values)
N
Niels 已提交
1899
        json_value() = default;
N
Niels 已提交
1900
        /// constructor for booleans
N
Niels 已提交
1901
        json_value(boolean_t v) noexcept : boolean(v) {}
N
Niels 已提交
1902
        /// constructor for numbers (integer)
N
Niels 已提交
1903
        json_value(number_integer_t v) noexcept : number_integer(v) {}
1904 1905
        /// constructor for numbers (unsigned)
        json_value(number_unsigned_t v) noexcept : number_unsigned(v) {}
N
Niels 已提交
1906
        /// constructor for numbers (floating-point)
N
Niels 已提交
1907
        json_value(number_float_t v) noexcept : number_float(v) {}
N
Niels 已提交
1908
        /// constructor for empty values of a given type
N
Niels 已提交
1909
        json_value(value_t t)
N
Niels 已提交
1910 1911 1912
        {
            switch (t)
            {
1913
                case value_t::object:
N
Niels 已提交
1914
                {
N
Cleanup  
Niels 已提交
1915
                    object = create<object_t>();
N
Niels 已提交
1916 1917
                    break;
                }
N
Niels 已提交
1918

1919
                case value_t::array:
N
Niels 已提交
1920
                {
N
Cleanup  
Niels 已提交
1921
                    array = create<array_t>();
N
Niels 已提交
1922 1923
                    break;
                }
N
Niels 已提交
1924

1925
                case value_t::string:
N
Niels 已提交
1926
                {
N
Cleanup  
Niels 已提交
1927
                    string = create<string_t>("");
N
Niels 已提交
1928 1929
                    break;
                }
N
Niels 已提交
1930

1931
                case value_t::boolean:
N
Niels 已提交
1932 1933 1934 1935 1936
                {
                    boolean = boolean_t(false);
                    break;
                }

1937
                case value_t::number_integer:
N
Niels 已提交
1938 1939 1940 1941
                {
                    number_integer = number_integer_t(0);
                    break;
                }
N
Niels 已提交
1942

1943 1944 1945 1946 1947
                case value_t::number_unsigned:
                {
                    number_unsigned = number_unsigned_t(0);
                    break;
                }
N
Niels 已提交
1948

1949
                case value_t::number_float:
N
Niels 已提交
1950 1951 1952 1953
                {
                    number_float = number_float_t(0.0);
                    break;
                }
1954

1955 1956 1957 1958 1959
                case value_t::null:
                {
                    break;
                }

1960 1961
                default:
                {
1962 1963
                    if (t == value_t::null)
                    {
1964
                        JSON_THROW(other_error(500, "961c151d2e87f2686a955a9be24d316f1362bf21 2.1.1")); // LCOV_EXCL_LINE
1965
                    }
1966 1967
                    break;
                }
N
Niels 已提交
1968 1969
            }
        }
N
Niels 已提交
1970 1971

        /// constructor for strings
N
Niels 已提交
1972
        json_value(const string_t& value)
N
Niels 已提交
1973
        {
N
Cleanup  
Niels 已提交
1974
            string = create<string_t>(value);
N
Niels 已提交
1975 1976 1977
        }

        /// constructor for objects
N
Niels 已提交
1978
        json_value(const object_t& value)
N
Niels 已提交
1979
        {
N
Cleanup  
Niels 已提交
1980
            object = create<object_t>(value);
N
Niels 已提交
1981 1982 1983
        }

        /// constructor for arrays
N
Niels 已提交
1984
        json_value(const array_t& value)
N
Niels 已提交
1985
        {
N
Cleanup  
Niels 已提交
1986
            array = create<array_t>(value);
N
Niels 已提交
1987
        }
N
Niels 已提交
1988 1989
    };

1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004
    /*!
    @brief checks the class invariants

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

  public:
N
Niels 已提交
2007 2008 2009 2010
    //////////////////////////
    // JSON parser callback //
    //////////////////////////

N
Niels 已提交
2011 2012 2013 2014 2015
    /*!
    @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.
2016

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

N
Niels 已提交
2019
    @since version 1.0.0
N
Niels 已提交
2020
    */
N
Niels 已提交
2021 2022
    enum class parse_event_t : uint8_t
    {
N
Niels 已提交
2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034
        /// 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 已提交
2035 2036
    };

N
Niels 已提交
2037 2038 2039 2040
    /*!
    @brief per-element parser callback type

    With a parser callback function, the result of parsing a JSON text can be
N
Niels 已提交
2041
    influenced. When passed to @ref parse(std::istream&, const
2042
    parser_callback_t) or @ref parse(const CharT, const parser_callback_t),
N
Niels 已提交
2043 2044 2045 2046 2047
    it is called on certain events (passed as @ref parse_event_t via parameter
    @a event) with a set recursion depth @a depth and context JSON value
    @a parsed. The return value of the callback function is a boolean
    indicating whether the element that emitted the callback shall be kept or
    not.
N
Niels 已提交
2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061

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

N
Niels 已提交
2064 2065
    Discarding a value (i.e., returning `false`) has different effects
    depending on the context in which function was called:
N
Niels 已提交
2066 2067 2068

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

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

N
Niels 已提交
2074
    @param[in] event  an event of type parse_event_t indicating the context in
N
Niels 已提交
2075 2076 2077 2078 2079 2080 2081 2082 2083 2084
    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
2085
    @ref parse(const CharT, const parser_callback_t) for examples
2086

N
Niels 已提交
2087
    @since version 1.0.0
N
Niels 已提交
2088
    */
N
Niels 已提交
2089 2090 2091
    using parser_callback_t = std::function<bool(int depth,
                              parse_event_t event,
                              basic_json& parsed)>;
N
Niels 已提交
2092

N
Niels 已提交
2093 2094 2095 2096 2097

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

N
Niels 已提交
2098
    /// @name constructors and destructors
N
Niels 已提交
2099 2100
    /// Constructors of class @ref basic_json, copy/move constructor, copy
    /// assignment, static functions creating objects, and the destructor.
N
Niels 已提交
2101 2102
    /// @{

N
Niels 已提交
2103 2104 2105
    /*!
    @brief create an empty value with a given type

N
Niels 已提交
2106 2107 2108 2109 2110
    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 已提交
2111 2112 2113 2114 2115 2116
    null        | `null`
    boolean     | `false`
    string      | `""`
    number      | `0`
    object      | `{}`
    array       | `[]`
N
Niels 已提交
2117

2118
    @param[in] value_type  the type of the value to create
N
Niels 已提交
2119 2120 2121 2122 2123

    @complexity Constant.

    @liveexample{The following code shows the constructor for different @ref
    value_t values,basic_json__value_t}
2124

N
Niels 已提交
2125
    @since version 1.0.0
N
Niels 已提交
2126
    */
2127 2128
    basic_json(const value_t value_type)
        : m_type(value_type), m_value(value_type)
2129 2130 2131
    {
        assert_invariant();
    }
N
Niels 已提交
2132

N
Niels 已提交
2133
    /*!
N
Niels 已提交
2134
    @brief create a null object
N
Niels 已提交
2135

N
Niels 已提交
2136 2137
    Create a `null` JSON value. It either takes a null pointer as parameter
    (explicitly creating `null`) or no parameter (implicitly creating `null`).
N
Niels 已提交
2138 2139
    The passed null pointer itself is not read -- it is only used to choose
    the right constructor.
N
Niels 已提交
2140 2141 2142

    @complexity Constant.

N
Niels 已提交
2143 2144 2145
    @exceptionsafety No-throw guarantee: this constructor never throws
    exceptions.

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

N
Niels 已提交
2149
    @since version 1.0.0
N
Niels 已提交
2150
    */
N
Niels 已提交
2151
    basic_json(std::nullptr_t = nullptr) noexcept
N
Niels 已提交
2152
        : basic_json(value_t::null)
2153 2154 2155
    {
        assert_invariant();
    }
N
Niels 已提交
2156

T
Théo DELRIEU 已提交
2157
    /*!
2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195
    @brief create a JSON value

    This is a "catch all" constructor for all compatible JSON types; that is,
    types for which a `to_json()` method exsits. The constructor forwards the
    parameter @a val to that method (to `json_serializer<U>::to_json` method
    with `U = uncvref_t<CompatibleType>`, to be exact).

    Template type @a CompatibleType includes, but is not limited to, the
    following types:
    - **arrays**: @ref array_t and all kinds of compatible containers such as
      `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.
    - **objects**: @ref object_t and all kinds of compatible associative
      containers such as `std::map`, `std::unordered_map`, `std::multimap`,
      and `std::unordered_multimap` with a `key_type` compatible to
      @ref string_t and a `value_type` from which a @ref basic_json value can
      be constructed.
    - **strings**: @ref string_t, string literals, and all compatible string
      containers can be used.
    - **numbers**: @ref number_integer_t, @ref number_unsigned_t,
      @ref number_float_t, and all convertible number types such as `int`,
      `size_t`, `int64_t`, `float` or `double` can be used.
    - **boolean**: @ref boolean_t / `bool` can be used.

    See the examples below.

    @tparam CompatibleType a type such that:
    - @a CompatibleType is not derived from `std::istream`,
    - @a CompatibleType is not @ref basic_json (to avoid hijacking copy/move
         constructors),
    - @a CompatibleType is not a @ref basic_json nested type (e.g.,
         @ref json_pointer, @ref iterator, etc ...)
    - @ref @ref json_serializer<U> has a
         `to_json(basic_json_t&, CompatibleType&&)` method

    @tparam U = `uncvref_t<CompatibleType>`
T
Théo DELRIEU 已提交
2196 2197 2198

    @param[in] val the value to be forwarded

2199 2200 2201 2202 2203 2204 2205 2206
    @complexity Usually linear in the size of the passed @a val, also
                depending on the implementation of the called `to_json()`
                method.

    @throw what `json_serializer<U>::to_json()` throws

    @liveexample{The following code shows the constructor with several
    compatible types.,basic_json__CompatibleType}
T
Théo DELRIEU 已提交
2207 2208 2209

    @since version 2.1.0
    */
2210
    template<typename CompatibleType, typename U = detail::uncvref_t<CompatibleType>,
2211 2212 2213 2214 2215 2216
             detail::enable_if_t<not std::is_base_of<std::istream, U>::value and
                                 not std::is_same<U, basic_json_t>::value and
                                 not detail::is_basic_json_nested_type<
                                     basic_json_t, U>::value and
                                 detail::has_to_json<basic_json, U>::value,
                                 int> = 0>
2217 2218
    basic_json(CompatibleType && val) noexcept(noexcept(JSONSerializer<U>::to_json(
                std::declval<basic_json_t&>(), std::forward<CompatibleType>(val))))
2219
    {
2220 2221
        JSONSerializer<U>::to_json(*this, std::forward<CompatibleType>(val));
        assert_invariant();
2222
    }
2223

N
Niels 已提交
2224 2225 2226 2227 2228 2229 2230 2231 2232 2233
    /*!
    @brief create a container (array or object) from an initializer list

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

    1. If the list is empty, an empty JSON object value `{}` is created.
    2. If the list consists of pairs whose first element is a string, a JSON
N
Niels 已提交
2234 2235
       object value is created where the first elements of the pairs are
       treated as keys and the second elements are as values.
N
Niels 已提交
2236 2237 2238
    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 已提交
2239
    JSON values. The rationale is as follows:
N
Niels 已提交
2240 2241

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

N
Niels 已提交
2250 2251
    With the rules described above, the following JSON values cannot be
    expressed by an initializer list:
N
Niels 已提交
2252

N
Niels 已提交
2253 2254 2255 2256 2257
    - 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 已提交
2258 2259 2260 2261 2262

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

N
Niels 已提交
2265 2266 2267
    @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 已提交
2268 2269
    used by the functions @ref array(std::initializer_list<basic_json>) and
    @ref object(std::initializer_list<basic_json>).
N
Niels 已提交
2270

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

2276 2277
    @throw type_error.301 if @a type_deduction is `false`, @a manual_type is
    `value_t::object`, but @a init contains an element which is not a pair
2278 2279 2280 2281
    whose first element is a string. In this case, the constructor could not
    create an object. If @a type_deduction would have be `true`, an array
    would have been created. See @ref object(std::initializer_list<basic_json>)
    for an example.
N
Niels 已提交
2282 2283 2284 2285

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

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

N
Niels 已提交
2288
    @sa @ref array(std::initializer_list<basic_json>) -- create a JSON array
2289
    value from an initializer list
N
Niels 已提交
2290
    @sa @ref object(std::initializer_list<basic_json>) -- create a JSON object
2291 2292
    value from an initializer list

N
Niels 已提交
2293
    @since version 1.0.0
N
Niels 已提交
2294
    */
N
Niels 已提交
2295 2296
    basic_json(std::initializer_list<basic_json> init,
               bool type_deduction = true,
N
Niels 已提交
2297
               value_t manual_type = value_t::array)
N
Niels 已提交
2298
    {
N
Niels 已提交
2299 2300
        // check if each element is an array with two elements whose first
        // element is a string
N
Niels 已提交
2301 2302
        bool is_an_object = std::all_of(init.begin(), init.end(),
                                        [](const basic_json & element)
N
Niels 已提交
2303
        {
N
Niels 已提交
2304 2305
            return element.is_array() and element.size() == 2 and element[0].is_string();
        });
N
Niels 已提交
2306 2307 2308 2309 2310 2311 2312

        // 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)
            {
2313
                is_an_object = false;
N
Niels 已提交
2314 2315 2316
            }

            // if object is wanted but impossible, throw an exception
2317
            if (manual_type == value_t::object and not is_an_object)
N
Niels 已提交
2318
            {
2319
                JSON_THROW(type_error(301, "cannot create object from initializer list"));
N
Niels 已提交
2320 2321 2322
            }
        }

2323
        if (is_an_object)
N
Niels 已提交
2324 2325 2326
        {
            // the initializer list is a list of pairs -> create object
            m_type = value_t::object;
N
Niels 已提交
2327
            m_value = value_t::object;
N
Niels 已提交
2328

N
Niels 已提交
2329
            std::for_each(init.begin(), init.end(), [this](const basic_json & element)
N
Niels 已提交
2330
            {
N
Niels 已提交
2331
                m_value.object->emplace(*(element[0].m_value.string), element[1]);
N
Niels 已提交
2332
            });
N
Niels 已提交
2333 2334 2335 2336 2337
        }
        else
        {
            // the initializer list describes an array -> create array
            m_type = value_t::array;
N
Niels 已提交
2338
            m_value.array = create<array_t>(init);
N
Niels 已提交
2339
        }
2340 2341

        assert_invariant();
N
Niels 已提交
2342 2343
    }

N
Niels 已提交
2344 2345 2346 2347 2348 2349 2350
    /*!
    @brief explicitly create an array from an initializer list

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

N
Niels 已提交
2351 2352
    @note This function is only needed to express two edge cases that cannot
    be realized with the initializer list constructor (@ref
N
Niels 已提交
2353 2354
    basic_json(std::initializer_list<basic_json>, bool, value_t)). These cases
    are:
N
Niels 已提交
2355
    1. creating an array whose elements are all pairs whose first element is a
N
Niels 已提交
2356
    string -- in this case, the initializer list constructor would create an
N
Niels 已提交
2357
    object, taking the first elements as keys
N
Niels 已提交
2358
    2. creating an empty array -- passing the empty initializer list to the
N
Niels 已提交
2359 2360
    initializer list constructor yields an empty object

N
Niels 已提交
2361
    @param[in] init  initializer list with JSON values to create an array from
N
Niels 已提交
2362 2363 2364 2365 2366 2367
    (optional)

    @return JSON array value

    @complexity Linear in the size of @a init.

N
Niels 已提交
2368
    @liveexample{The following code shows an example for the `array`
N
Niels 已提交
2369 2370
    function.,array}

2371 2372 2373 2374 2375
    @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 已提交
2376
    @since version 1.0.0
N
Niels 已提交
2377
    */
N
Niels 已提交
2378
    static basic_json array(std::initializer_list<basic_json> init =
T
Théo DELRIEU 已提交
2379
                                std::initializer_list<basic_json>())
N
Niels 已提交
2380
    {
N
Niels 已提交
2381
        return basic_json(init, false, value_t::array);
N
Niels 已提交
2382 2383
    }

N
Niels 已提交
2384 2385 2386 2387
    /*!
    @brief explicitly create an object from an initializer list

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

    @note This function is only added for symmetry reasons. In contrast to the
2392 2393 2394
    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
2395
    constructor @ref basic_json(std::initializer_list<basic_json>, bool, value_t).
N
Niels 已提交
2396

N
Niels 已提交
2397
    @param[in] init  initializer list to create an object from (optional)
N
Niels 已提交
2398 2399 2400

    @return JSON object value

2401 2402 2403 2404 2405
    @throw type_error.301 if @a init is not a list of pairs whose first
    elements are strings. In this case, no object can be created. When such a
    value is passed to @ref basic_json(std::initializer_list<basic_json>, bool, value_t),
    an array would have been created from the passed initializer list @a init.
    See example below.
N
Niels 已提交
2406 2407 2408

    @complexity Linear in the size of @a init.

N
Niels 已提交
2409
    @liveexample{The following code shows an example for the `object`
N
Niels 已提交
2410 2411
    function.,object}

2412 2413 2414 2415 2416
    @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 已提交
2417
    @since version 1.0.0
N
Niels 已提交
2418
    */
N
Niels 已提交
2419
    static basic_json object(std::initializer_list<basic_json> init =
T
Théo DELRIEU 已提交
2420
                                 std::initializer_list<basic_json>())
N
Niels 已提交
2421
    {
N
Niels 已提交
2422
        return basic_json(init, false, value_t::object);
N
Niels 已提交
2423 2424
    }

N
Niels 已提交
2425 2426 2427
    /*!
    @brief construct an array with count copies of given value

N
Niels 已提交
2428 2429
    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,
2430
    `std::distance(begin(),end()) == cnt` holds.
N
Niels 已提交
2431

2432 2433
    @param[in] cnt  the number of JSON copies of @a val to create
    @param[in] val  the JSON value to copy
N
Niels 已提交
2434

2435
    @complexity Linear in @a cnt.
N
Niels 已提交
2436 2437 2438 2439

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

N
Niels 已提交
2441
    @since version 1.0.0
N
Niels 已提交
2442
    */
2443
    basic_json(size_type cnt, const basic_json& val)
N
Niels 已提交
2444 2445
        : m_type(value_t::array)
    {
2446
        m_value.array = create<array_t>(cnt, val);
2447
        assert_invariant();
N
Niels 已提交
2448
    }
N
Niels 已提交
2449

N
Niels 已提交
2450 2451 2452 2453 2454
    /*!
    @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 已提交
2455
    - In case of primitive types (number, boolean, or string), @a first must
N
Niels 已提交
2456
      be `begin()` and @a last must be `end()`. In this case, the value is
2457
      copied. Otherwise, invalid_iterator.204 is thrown.
N
Niels 已提交
2458 2459
    - In case of structured types (array, object), the constructor behaves as
      similar versions for `std::vector`.
2460
    - In case of a null type, invalid_iterator.206 is thrown.
N
Niels 已提交
2461 2462 2463 2464 2465 2466 2467

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

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

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

2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483
    @pre Range `[first, last)` is valid. Usually, this precondition cannot be
         checked efficiently. Only certain edge cases are detected; see the
         description of the exceptions below.

    @throw invalid_iterator.201 if iterators @a first and @a last are not
    compatible (i.e., do not belong to the same JSON value). In this case,
    the range `[first, last)` is undefined.
    @throw invalid_iterator.204 if iterators @a first and @a last belong to a
    primitive type (number, boolean, or string), but @a first does not point
    to the first element any more. In this case, the range `[first, last)` is
    undefined. See example code below.
    @throw invalid_iterator.206 if iterators @a first and @a last belong to a
    null value. In this case, the range `[first, last)` is undefined.
N
Niels 已提交
2484 2485 2486 2487 2488

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

N
Niels 已提交
2490
    @since version 1.0.0
N
Niels 已提交
2491
    */
N
Niels 已提交
2492 2493 2494
    template<class InputIT, typename std::enable_if<
                 std::is_same<InputIT, typename basic_json_t::iterator>::value or
                 std::is_same<InputIT, typename basic_json_t::const_iterator>::value, int>::type = 0>
N
Niels 已提交
2495
    basic_json(InputIT first, InputIT last)
N
Niels 已提交
2496
    {
N
Niels 已提交
2497 2498 2499
        assert(first.m_object != nullptr);
        assert(last.m_object != nullptr);

N
Niels 已提交
2500
        // make sure iterator fits the current value
N
Niels 已提交
2501
        if (first.m_object != last.m_object)
N
Niels 已提交
2502
        {
2503
            JSON_THROW(invalid_iterator(201, "iterators are not compatible"));
N
Niels 已提交
2504 2505
        }

N
Niels 已提交
2506 2507 2508
        // copy type from first iterator
        m_type = first.m_object->m_type;

N
Niels 已提交
2509
        // check if iterator range is complete for primitive values
N
Niels 已提交
2510 2511 2512
        switch (m_type)
        {
            case value_t::boolean:
2513 2514
            case value_t::number_float:
            case value_t::number_integer:
2515
            case value_t::number_unsigned:
N
Niels 已提交
2516 2517
            case value_t::string:
            {
2518
                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
N
Niels 已提交
2519
                {
2520
                    JSON_THROW(invalid_iterator(204, "iterators out of range"));
N
Niels 已提交
2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537
                }
                break;
            }

            default:
            {
                break;
            }
        }

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

2539 2540 2541 2542 2543
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = first.m_object->m_value.number_unsigned;
                break;
            }
N
Niels 已提交
2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558

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

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

            case value_t::string:
            {
N
Niels 已提交
2559
                m_value = *first.m_object->m_value.string;
N
Niels 已提交
2560 2561 2562 2563 2564
                break;
            }

            case value_t::object:
            {
N
Niels Lohmann 已提交
2565 2566
                m_value.object = create<object_t>(first.m_it.object_iterator,
                                                  last.m_it.object_iterator);
N
Niels 已提交
2567 2568 2569 2570 2571
                break;
            }

            case value_t::array:
            {
N
Niels Lohmann 已提交
2572 2573
                m_value.array = create<array_t>(first.m_it.array_iterator,
                                                last.m_it.array_iterator);
N
Niels 已提交
2574 2575 2576 2577 2578
                break;
            }

            default:
            {
2579 2580
                JSON_THROW(invalid_iterator(206, "cannot construct with iterators from " +
                                            first.m_object->type_name()));
N
Niels 已提交
2581 2582
            }
        }
2583 2584

        assert_invariant();
N
Niels 已提交
2585 2586
    }

N
Niels 已提交
2587

N
Niels 已提交
2588 2589 2590 2591
    ///////////////////////////////////////
    // other constructors and destructor //
    ///////////////////////////////////////

N
Niels 已提交
2592 2593
    /*!
    @brief copy constructor
N
Niels 已提交
2594

N
Niels 已提交
2595 2596
    Creates a copy of a given JSON value.

N
Niels 已提交
2597
    @param[in] other  the JSON value to copy
N
Niels 已提交
2598 2599 2600

    @complexity Linear in the size of @a other.

N
Niels 已提交
2601 2602 2603
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2604 2605 2606 2607
    - The complexity is linear.
    - As postcondition, it holds: `other == basic_json(other)`.

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

N
Niels 已提交
2610
    @since version 1.0.0
N
Niels 已提交
2611
    */
N
Niels 已提交
2612
    basic_json(const basic_json& other)
N
Niels 已提交
2613 2614
        : m_type(other.m_type)
    {
2615 2616 2617
        // check of passed value is valid
        other.assert_invariant();

N
Niels 已提交
2618 2619
        switch (m_type)
        {
2620
            case value_t::object:
N
Niels 已提交
2621
            {
N
Niels 已提交
2622
                m_value = *other.m_value.object;
N
Niels 已提交
2623 2624
                break;
            }
N
Niels 已提交
2625

2626
            case value_t::array:
N
Niels 已提交
2627
            {
N
Niels 已提交
2628
                m_value = *other.m_value.array;
N
Niels 已提交
2629 2630
                break;
            }
N
Niels 已提交
2631

2632
            case value_t::string:
N
Niels 已提交
2633
            {
N
Niels 已提交
2634
                m_value = *other.m_value.string;
N
Niels 已提交
2635 2636
                break;
            }
N
Niels 已提交
2637

2638
            case value_t::boolean:
N
Niels 已提交
2639
            {
N
Niels 已提交
2640
                m_value = other.m_value.boolean;
N
Niels 已提交
2641 2642
                break;
            }
N
Niels 已提交
2643

2644
            case value_t::number_integer:
N
Niels 已提交
2645
            {
N
Niels 已提交
2646
                m_value = other.m_value.number_integer;
N
Niels 已提交
2647 2648
                break;
            }
N
Niels 已提交
2649

2650 2651 2652 2653 2654
            case value_t::number_unsigned:
            {
                m_value = other.m_value.number_unsigned;
                break;
            }
N
Niels 已提交
2655

2656
            case value_t::number_float:
N
Niels 已提交
2657
            {
N
Niels 已提交
2658
                m_value = other.m_value.number_float;
N
Niels 已提交
2659 2660
                break;
            }
2661 2662 2663 2664 2665

            default:
            {
                break;
            }
N
Niels 已提交
2666
        }
2667 2668

        assert_invariant();
N
Niels 已提交
2669 2670
    }

N
Niels 已提交
2671 2672 2673 2674 2675 2676 2677
    /*!
    @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 已提交
2678
    @param[in,out] other  value to move to this object
N
Niels 已提交
2679 2680 2681 2682 2683 2684 2685

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

N
Niels 已提交
2687
    @since version 1.0.0
N
Niels 已提交
2688
    */
N
Niels 已提交
2689
    basic_json(basic_json&& other) noexcept
N
Niels 已提交
2690 2691
        : m_type(std::move(other.m_type)),
          m_value(std::move(other.m_value))
N
Niels 已提交
2692
    {
2693 2694 2695
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2696
        // invalidate payload
N
Niels 已提交
2697 2698
        other.m_type = value_t::null;
        other.m_value = {};
2699 2700

        assert_invariant();
N
Niels 已提交
2701 2702
    }

N
Niels 已提交
2703 2704
    /*!
    @brief copy assignment
N
Niels 已提交
2705

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

N
Niels 已提交
2710
    @param[in] other  value to copy from
N
Niels 已提交
2711 2712 2713

    @complexity Linear.

N
Niels 已提交
2714 2715 2716
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2717 2718
    - The complexity is linear.

N
Niels 已提交
2719 2720 2721 2722
    @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 已提交
2723

N
Niels 已提交
2724
    @since version 1.0.0
N
Niels 已提交
2725
    */
N
Niels 已提交
2726
    reference& operator=(basic_json other) noexcept (
N
Niels 已提交
2727 2728 2729 2730
        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
T
Théo DELRIEU 已提交
2731
    )
N
Niels 已提交
2732
    {
2733 2734 2735
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2736
        using std::swap;
N
Cleanup  
Niels 已提交
2737 2738
        swap(m_type, other.m_type);
        swap(m_value, other.m_value);
2739 2740

        assert_invariant();
N
Niels 已提交
2741 2742 2743
        return *this;
    }

2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761
    /*!
    @brief destructor

    Destroys the JSON value and frees all allocated memory.

    @complexity Linear.

    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
    - The complexity is linear.
    - All stored elements are destroyed and all memory is freed.

    @since version 1.0.0
    */
    ~basic_json()
    {
        assert_invariant();
N
Niels 已提交
2762

2763 2764 2765 2766 2767 2768 2769 2770 2771
        switch (m_type)
        {
            case value_t::object:
            {
                AllocatorType<object_t> alloc;
                alloc.destroy(m_value.object);
                alloc.deallocate(m_value.object, 1);
                break;
            }
N
Niels 已提交
2772

2773 2774 2775 2776 2777 2778 2779
            case value_t::array:
            {
                AllocatorType<array_t> alloc;
                alloc.destroy(m_value.array);
                alloc.deallocate(m_value.array, 1);
                break;
            }
2780

2781 2782 2783 2784 2785 2786 2787
            case value_t::string:
            {
                AllocatorType<string_t> alloc;
                alloc.destroy(m_value.string);
                alloc.deallocate(m_value.string, 1);
                break;
            }
2788

2789 2790 2791 2792 2793 2794
            default:
            {
                // all other types need no specific destructor
                break;
            }
        }
N
Niels 已提交
2795 2796
    }

N
Niels 已提交
2797
    /// @}
N
Niels 已提交
2798 2799 2800 2801 2802 2803

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

N
Niels 已提交
2804
    /// @name object inspection
N
Niels 已提交
2805
    /// Functions to inspect the type of a JSON value.
N
Niels 已提交
2806 2807
    /// @{

N
Niels 已提交
2808
    /*!
N
Niels 已提交
2809 2810
    @brief serialization

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

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

N
Niels 已提交
2820 2821 2822 2823 2824
    @return string containing the serialization of the JSON value

    @complexity Linear.

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

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

N
Niels 已提交
2829
    @since version 1.0.0
N
Niels 已提交
2830
    */
N
Niels 已提交
2831
    string_t dump(const int indent = -1) const
N
Niels 已提交
2832
    {
N
Niels 已提交
2833
        std::stringstream ss;
2834
        serializer s(ss);
2835

N
Niels 已提交
2836 2837
        if (indent >= 0)
        {
2838
            s.dump(*this, true, static_cast<unsigned int>(indent));
N
Niels 已提交
2839 2840 2841
        }
        else
        {
2842
            s.dump(*this, false, 0);
N
Niels 已提交
2843
        }
N
Niels 已提交
2844 2845

        return ss.str();
N
Niels 已提交
2846 2847
    }

N
Niels 已提交
2848 2849 2850 2851 2852 2853 2854
    /*!
    @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 已提交
2855 2856 2857

    @complexity Constant.

N
Niels 已提交
2858 2859 2860
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2861
    @liveexample{The following code exemplifies `type()` for all JSON
N
Niels 已提交
2862
    types.,type}
N
Niels 已提交
2863

N
Niels 已提交
2864
    @since version 1.0.0
N
Niels 已提交
2865
    */
N
Niels 已提交
2866
    constexpr value_t type() const noexcept
N
Niels 已提交
2867 2868 2869 2870
    {
        return m_type;
    }

N
Niels 已提交
2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881
    /*!
    @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 已提交
2882 2883 2884
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2885
    @liveexample{The following code exemplifies `is_primitive()` for all JSON
N
Niels 已提交
2886
    types.,is_primitive}
N
Niels 已提交
2887

N
Niels 已提交
2888 2889 2890 2891 2892 2893
    @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 已提交
2894
    @since version 1.0.0
N
Niels 已提交
2895
    */
N
Niels 已提交
2896
    constexpr bool is_primitive() const noexcept
N
Niels 已提交
2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910
    {
        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 已提交
2911 2912 2913
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2914
    @liveexample{The following code exemplifies `is_structured()` for all JSON
N
Niels 已提交
2915
    types.,is_structured}
N
Niels 已提交
2916

N
Niels 已提交
2917 2918 2919 2920
    @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 已提交
2921
    @since version 1.0.0
N
Niels 已提交
2922
    */
N
Niels 已提交
2923
    constexpr bool is_structured() const noexcept
N
Niels 已提交
2924 2925 2926 2927
    {
        return is_array() or is_object();
    }

N
Niels 已提交
2928 2929 2930 2931 2932
    /*!
    @brief return whether value is null

    This function returns true iff the JSON value is null.

N
Niels 已提交
2933
    @return `true` if type is null, `false` otherwise.
N
Niels 已提交
2934 2935 2936

    @complexity Constant.

N
Niels 已提交
2937 2938 2939
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2940
    @liveexample{The following code exemplifies `is_null()` for all JSON
N
Niels 已提交
2941
    types.,is_null}
N
Niels 已提交
2942

N
Niels 已提交
2943
    @since version 1.0.0
N
Niels 已提交
2944
    */
N
Niels 已提交
2945
    constexpr bool is_null() const noexcept
N
Niels 已提交
2946 2947 2948 2949
    {
        return m_type == value_t::null;
    }

N
Niels 已提交
2950 2951 2952 2953 2954
    /*!
    @brief return whether value is a boolean

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

N
Niels 已提交
2955
    @return `true` if type is boolean, `false` otherwise.
N
Niels 已提交
2956 2957 2958

    @complexity Constant.

N
Niels 已提交
2959 2960 2961
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2962
    @liveexample{The following code exemplifies `is_boolean()` for all JSON
N
Niels 已提交
2963
    types.,is_boolean}
N
Niels 已提交
2964

N
Niels 已提交
2965
    @since version 1.0.0
N
Niels 已提交
2966
    */
N
Niels 已提交
2967
    constexpr bool is_boolean() const noexcept
N
Niels 已提交
2968 2969 2970 2971
    {
        return m_type == value_t::boolean;
    }

N
Niels 已提交
2972 2973 2974 2975 2976 2977
    /*!
    @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.

2978 2979
    @return `true` if type is number (regardless whether integer, unsigned
    integer or floating-type), `false` otherwise.
N
Niels 已提交
2980 2981 2982

    @complexity Constant.

N
Niels 已提交
2983 2984 2985
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2986
    @liveexample{The following code exemplifies `is_number()` for all JSON
N
Niels 已提交
2987
    types.,is_number}
N
Niels 已提交
2988

N
Niels 已提交
2989
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
2990
    integer number
N
Niels 已提交
2991 2992
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2993 2994
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
2995
    @since version 1.0.0
N
Niels 已提交
2996
    */
N
Niels 已提交
2997
    constexpr bool is_number() const noexcept
N
Niels 已提交
2998
    {
N
Niels 已提交
2999
        return is_number_integer() or is_number_float();
N
Niels 已提交
3000 3001
    }

N
Niels 已提交
3002 3003 3004
    /*!
    @brief return whether value is an integer number

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

N
Niels 已提交
3008
    @return `true` if type is an integer or unsigned integer number, `false`
3009
    otherwise.
N
Niels 已提交
3010 3011 3012

    @complexity Constant.

N
Niels 已提交
3013 3014 3015
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3016
    @liveexample{The following code exemplifies `is_number_integer()` for all
N
Niels 已提交
3017
    JSON types.,is_number_integer}
N
Niels 已提交
3018 3019

    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
3020 3021
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
3022 3023
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
3024
    @since version 1.0.0
N
Niels 已提交
3025
    */
N
Niels 已提交
3026
    constexpr bool is_number_integer() const noexcept
N
Niels 已提交
3027
    {
3028 3029
        return m_type == value_t::number_integer or m_type == value_t::number_unsigned;
    }
N
Niels 已提交
3030

3031 3032 3033
    /*!
    @brief return whether value is an unsigned integer number

N
Niels 已提交
3034 3035
    This function returns true iff the JSON value is an unsigned integer
    number. This excludes floating-point and (signed) integer values.
3036 3037 3038 3039 3040

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

    @complexity Constant.

N
Niels 已提交
3041 3042 3043
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3044
    @liveexample{The following code exemplifies `is_number_unsigned()` for all
N
Niels 已提交
3045 3046
    JSON types.,is_number_unsigned}

3047
    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
3048
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
3049 3050 3051 3052 3053
    integer number
    @sa @ref is_number_float() -- check if value is a floating-point number

    @since version 2.0.0
    */
N
Niels 已提交
3054
    constexpr bool is_number_unsigned() const noexcept
3055 3056
    {
        return m_type == value_t::number_unsigned;
N
Niels 已提交
3057 3058
    }

N
Niels 已提交
3059 3060 3061 3062
    /*!
    @brief return whether value is a floating-point number

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

N
Niels 已提交
3065
    @return `true` if type is a floating-point number, `false` otherwise.
N
Niels 已提交
3066 3067 3068

    @complexity Constant.

N
Niels 已提交
3069 3070 3071
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3072
    @liveexample{The following code exemplifies `is_number_float()` for all
N
Niels 已提交
3073
    JSON types.,is_number_float}
N
Niels 已提交
3074 3075 3076

    @sa @ref is_number() -- check if value is number
    @sa @ref is_number_integer() -- check if value is an integer number
N
Niels 已提交
3077 3078
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
3079

N
Niels 已提交
3080
    @since version 1.0.0
N
Niels 已提交
3081
    */
N
Niels 已提交
3082
    constexpr bool is_number_float() const noexcept
N
Niels 已提交
3083 3084 3085 3086
    {
        return m_type == value_t::number_float;
    }

N
Niels 已提交
3087 3088 3089 3090 3091
    /*!
    @brief return whether value is an object

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

N
Niels 已提交
3092
    @return `true` if type is object, `false` otherwise.
N
Niels 已提交
3093 3094 3095

    @complexity Constant.

N
Niels 已提交
3096 3097 3098
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3099
    @liveexample{The following code exemplifies `is_object()` for all JSON
N
Niels 已提交
3100
    types.,is_object}
N
Niels 已提交
3101

N
Niels 已提交
3102
    @since version 1.0.0
N
Niels 已提交
3103
    */
N
Niels 已提交
3104
    constexpr bool is_object() const noexcept
N
Niels 已提交
3105 3106 3107 3108
    {
        return m_type == value_t::object;
    }

N
Niels 已提交
3109 3110 3111 3112 3113
    /*!
    @brief return whether value is an array

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

N
Niels 已提交
3114
    @return `true` if type is array, `false` otherwise.
N
Niels 已提交
3115 3116 3117

    @complexity Constant.

N
Niels 已提交
3118 3119 3120
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3121
    @liveexample{The following code exemplifies `is_array()` for all JSON
N
Niels 已提交
3122
    types.,is_array}
N
Niels 已提交
3123

N
Niels 已提交
3124
    @since version 1.0.0
N
Niels 已提交
3125
    */
N
Niels 已提交
3126
    constexpr bool is_array() const noexcept
N
Niels 已提交
3127 3128 3129 3130
    {
        return m_type == value_t::array;
    }

N
Niels 已提交
3131 3132 3133 3134 3135
    /*!
    @brief return whether value is a string

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

N
Niels 已提交
3136
    @return `true` if type is string, `false` otherwise.
N
Niels 已提交
3137 3138 3139

    @complexity Constant.

N
Niels 已提交
3140 3141 3142
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3143
    @liveexample{The following code exemplifies `is_string()` for all JSON
N
Niels 已提交
3144
    types.,is_string}
N
Niels 已提交
3145

N
Niels 已提交
3146
    @since version 1.0.0
N
Niels 已提交
3147
    */
N
Niels 已提交
3148
    constexpr bool is_string() const noexcept
N
Niels 已提交
3149 3150 3151 3152
    {
        return m_type == value_t::string;
    }

N
Niels 已提交
3153 3154 3155 3156 3157 3158
    /*!
    @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 已提交
3159 3160 3161 3162
    @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 已提交
3163 3164 3165 3166
    @return `true` if type is discarded, `false` otherwise.

    @complexity Constant.

N
Niels 已提交
3167 3168 3169
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3170
    @liveexample{The following code exemplifies `is_discarded()` for all JSON
N
Niels 已提交
3171
    types.,is_discarded}
N
Niels 已提交
3172

N
Niels 已提交
3173
    @since version 1.0.0
N
Niels 已提交
3174
    */
N
Niels 已提交
3175
    constexpr bool is_discarded() const noexcept
N
Niels 已提交
3176 3177 3178 3179
    {
        return m_type == value_t::discarded;
    }

N
Niels 已提交
3180 3181 3182 3183 3184 3185 3186 3187 3188 3189
    /*!
    @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 已提交
3190 3191 3192
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

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

N
Niels 已提交
3196
    @since version 1.0.0
N
Niels 已提交
3197
    */
N
Niels 已提交
3198
    constexpr operator value_t() const noexcept
N
Niels 已提交
3199 3200 3201 3202
    {
        return m_type;
    }

N
Niels 已提交
3203 3204
    /// @}

N
Niels 已提交
3205
  private:
N
Niels Lohmann 已提交
3206 3207 3208 3209
    //////////////////
    // value access //
    //////////////////

N
Niels 已提交
3210
    /// get a boolean (explicit)
3211
    boolean_t get_impl(boolean_t* /*unused*/) const
N
Niels 已提交
3212
    {
3213 3214 3215 3216
        if (is_boolean())
        {
            return m_value.boolean;
        }
N
Niels Lohmann 已提交
3217

3218
        JSON_THROW(type_error(302, "type must be boolean, but is " + type_name()));
N
Niels 已提交
3219 3220
    }

N
Niels 已提交
3221
    /// get a pointer to the value (object)
N
Niels Lohmann 已提交
3222
    object_t* get_impl_ptr(object_t* /*unused*/) noexcept
N
Niels 已提交
3223 3224 3225 3226
    {
        return is_object() ? m_value.object : nullptr;
    }

N
Niels 已提交
3227
    /// get a pointer to the value (object)
N
Niels Lohmann 已提交
3228
    constexpr const object_t* get_impl_ptr(const object_t* /*unused*/) const noexcept
N
Niels 已提交
3229 3230 3231 3232 3233
    {
        return is_object() ? m_value.object : nullptr;
    }

    /// get a pointer to the value (array)
N
Niels Lohmann 已提交
3234
    array_t* get_impl_ptr(array_t* /*unused*/) noexcept
N
Niels 已提交
3235 3236 3237 3238
    {
        return is_array() ? m_value.array : nullptr;
    }

N
Niels 已提交
3239
    /// get a pointer to the value (array)
N
Niels Lohmann 已提交
3240
    constexpr const array_t* get_impl_ptr(const array_t* /*unused*/) const noexcept
N
Niels 已提交
3241 3242 3243 3244 3245
    {
        return is_array() ? m_value.array : nullptr;
    }

    /// get a pointer to the value (string)
N
Niels Lohmann 已提交
3246
    string_t* get_impl_ptr(string_t* /*unused*/) noexcept
N
Niels 已提交
3247 3248 3249 3250 3251
    {
        return is_string() ? m_value.string : nullptr;
    }

    /// get a pointer to the value (string)
N
Niels Lohmann 已提交
3252
    constexpr const string_t* get_impl_ptr(const string_t* /*unused*/) const noexcept
N
Niels 已提交
3253 3254 3255 3256 3257
    {
        return is_string() ? m_value.string : nullptr;
    }

    /// get a pointer to the value (boolean)
N
Niels Lohmann 已提交
3258
    boolean_t* get_impl_ptr(boolean_t* /*unused*/) noexcept
N
Niels 已提交
3259 3260 3261 3262 3263
    {
        return is_boolean() ? &m_value.boolean : nullptr;
    }

    /// get a pointer to the value (boolean)
N
Niels Lohmann 已提交
3264
    constexpr const boolean_t* get_impl_ptr(const boolean_t* /*unused*/) const noexcept
N
Niels 已提交
3265 3266 3267 3268 3269
    {
        return is_boolean() ? &m_value.boolean : nullptr;
    }

    /// get a pointer to the value (integer number)
N
Niels Lohmann 已提交
3270
    number_integer_t* get_impl_ptr(number_integer_t* /*unused*/) noexcept
N
Niels 已提交
3271 3272 3273 3274 3275
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }

    /// get a pointer to the value (integer number)
N
Niels Lohmann 已提交
3276
    constexpr const number_integer_t* get_impl_ptr(const number_integer_t* /*unused*/) const noexcept
N
Niels 已提交
3277 3278 3279
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }
N
Niels 已提交
3280

3281
    /// get a pointer to the value (unsigned number)
N
Niels Lohmann 已提交
3282
    number_unsigned_t* get_impl_ptr(number_unsigned_t* /*unused*/) noexcept
3283 3284 3285
    {
        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
    }
N
Niels 已提交
3286

3287
    /// get a pointer to the value (unsigned number)
N
Niels Lohmann 已提交
3288
    constexpr const number_unsigned_t* get_impl_ptr(const number_unsigned_t* /*unused*/) const noexcept
3289 3290 3291
    {
        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
    }
N
Niels 已提交
3292

N
Niels 已提交
3293
    /// get a pointer to the value (floating-point number)
N
Niels Lohmann 已提交
3294
    number_float_t* get_impl_ptr(number_float_t* /*unused*/) noexcept
N
Niels 已提交
3295 3296 3297 3298 3299
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

    /// get a pointer to the value (floating-point number)
N
Niels Lohmann 已提交
3300
    constexpr const number_float_t* get_impl_ptr(const number_float_t* /*unused*/) const noexcept
N
Niels 已提交
3301 3302 3303 3304
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

N
Niels 已提交
3305 3306 3307 3308 3309 3310 3311 3312
    /*!
    @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`

3313
    @throw type_error.303 if ReferenceType does not match underlying value
N
Niels 已提交
3314 3315 3316
    type of the current JSON
    */
    template<typename ReferenceType, typename ThisType>
3317
    static ReferenceType get_ref_impl(ThisType& obj)
D
dariomt 已提交
3318
    {
N
Niels 已提交
3319
        // helper type
N
Niels 已提交
3320 3321
        using PointerType = typename std::add_pointer<ReferenceType>::type;

N
Niels 已提交
3322
        // delegate the call to get_ptr<>()
3323 3324 3325 3326 3327 3328
        auto ptr = obj.template get_ptr<PointerType>();

        if (ptr != nullptr)
        {
            return *ptr;
        }
N
Niels Lohmann 已提交
3329

3330
        JSON_THROW(type_error(303, "incompatible ReferenceType for get_ref, actual type is " + obj.type_name()));
D
dariomt 已提交
3331 3332
    }

N
Niels 已提交
3333
  public:
N
Niels Lohmann 已提交
3334 3335 3336 3337
    /// @name value access
    /// Direct access to the stored value of a JSON value.
    /// @{

T
Théo DELRIEU 已提交
3338 3339 3340
    /*!
    @brief get special-case overload

N
Niels Lohmann 已提交
3341 3342
    This overloads avoids a lot of template boilerplate, it can be seen as the
    identity method
T
Théo DELRIEU 已提交
3343

N
Niels Lohmann 已提交
3344
    @tparam BasicJsonType == @ref basic_json
T
Théo DELRIEU 已提交
3345 3346 3347 3348 3349 3350 3351

    @return a copy of *this

    @complexity Constant.

    @since version 2.1.0
    */
3352
    template <
N
Niels Lohmann 已提交
3353 3354
        typename BasicJsonType,
        detail::enable_if_t<std::is_same<typename std::remove_const<BasicJsonType>::type,
3355 3356
                                         basic_json_t>::value,
                            int> = 0 >
3357 3358
    basic_json get() const
    {
T
Théo DELRIEU 已提交
3359
        return *this;
3360 3361
    }

T
Théo DELRIEU 已提交
3362
    /*!
N
Niels Lohmann 已提交
3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376
    @brief get a value (explicit)

    Explicit type conversion between the JSON value and a compatible value
    which is [CopyConstructible](http://en.cppreference.com/w/cpp/concept/CopyConstructible)
    and [DefaultConstructible](http://en.cppreference.com/w/cpp/concept/DefaultConstructible).
    The value is converted by calling the @ref json_serializer<ValueType>
    `from_json()` method.

    The function is equivalent to executing
    @code {.cpp}
    ValueType ret;
    JSONSerializer<ValueType>::from_json(*this, ret);
    return ret;
    @endcode
T
Théo DELRIEU 已提交
3377 3378

    This overloads is chosen if:
N
Niels Lohmann 已提交
3379 3380 3381 3382 3383 3384 3385 3386
    - @a ValueType is not @ref basic_json,
    - @ref json_serializer<ValueType> has a `from_json()` method of the form
      `void from_json(const @ref basic_json&, ValueType&)`, and
    - @ref json_serializer<ValueType> does not have a `from_json()` method of
      the form `ValueType from_json(const @ref basic_json&)`

    @tparam ValueTypeCV the provided value type
    @tparam ValueType the returned value type
T
Théo DELRIEU 已提交
3387

N
Niels Lohmann 已提交
3388
    @return copy of the JSON value, converted to @a ValueType
T
Théo DELRIEU 已提交
3389

N
Niels Lohmann 已提交
3390 3391 3392 3393 3394 3395 3396 3397
    @throw what @ref json_serializer<ValueType> `from_json()` method throws

    @liveexample{The example below shows several conversions from JSON values
    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++
    associative containers such as `std::unordered_map<std::string\,
    json>`.,get__ValueType_const}
T
Théo DELRIEU 已提交
3398 3399 3400

    @since version 2.1.0
    */
T
Théo DELRIEU 已提交
3401
    template <
N
Niels Lohmann 已提交
3402 3403
        typename ValueTypeCV,
        typename ValueType = detail::uncvref_t<ValueTypeCV>,
3404
        detail::enable_if_t <
N
Niels Lohmann 已提交
3405 3406 3407
            not std::is_same<basic_json_t, ValueType>::value and
            detail::has_from_json<basic_json_t, ValueType>::value and
            not detail::has_non_default_from_json<basic_json_t, ValueType>::value,
T
Théo DELRIEU 已提交
3408
            int > = 0 >
N
Niels Lohmann 已提交
3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421
    ValueType get() const noexcept(noexcept(
                                       JSONSerializer<ValueType>::from_json(std::declval<const basic_json_t&>(), std::declval<ValueType&>())))
    {
        // we cannot static_assert on ValueTypeCV being non-const, because
        // there is support for get<const basic_json_t>(), which is why we
        // still need the uncvref
        static_assert(not std::is_reference<ValueTypeCV>::value,
                      "get() cannot be used with reference types, you might want to use get_ref()");
        static_assert(std::is_default_constructible<ValueType>::value,
                      "types must be DefaultConstructible when used with get()");

        ValueType ret;
        JSONSerializer<ValueType>::from_json(*this, ret);
T
Théo DELRIEU 已提交
3422
        return ret;
3423
    }
3424

T
Théo DELRIEU 已提交
3425
    /*!
N
Niels Lohmann 已提交
3426 3427 3428 3429 3430 3431 3432
    @brief get a value (explicit); special case

    Explicit type conversion between the JSON value and a compatible value
    which is **not** [CopyConstructible](http://en.cppreference.com/w/cpp/concept/CopyConstructible)
    and **not** [DefaultConstructible](http://en.cppreference.com/w/cpp/concept/DefaultConstructible).
    The value is converted by calling the @ref json_serializer<ValueType>
    `from_json()` method.
T
Théo DELRIEU 已提交
3433

N
Niels Lohmann 已提交
3434 3435 3436 3437
    The function is equivalent to executing
    @code {.cpp}
    return JSONSerializer<ValueTypeCV>::from_json(*this);
    @endcode
T
Théo DELRIEU 已提交
3438 3439

    This overloads is chosen if:
N
Niels Lohmann 已提交
3440 3441 3442 3443 3444 3445 3446 3447 3448
    - @a ValueType is not @ref basic_json and
    - @ref json_serializer<ValueType> has a `from_json()` method of the form
      `ValueType from_json(const @ref basic_json&)`

    @note If @ref json_serializer<ValueType> has both overloads of
    `from_json()`, this one is chosen.

    @tparam ValueTypeCV the provided value type
    @tparam ValueType the returned value type
T
Théo DELRIEU 已提交
3449

N
Niels Lohmann 已提交
3450
    @return copy of the JSON value, converted to @a ValueType
T
Théo DELRIEU 已提交
3451

N
Niels Lohmann 已提交
3452
    @throw what @ref json_serializer<ValueType> `from_json()` method throws
T
Théo DELRIEU 已提交
3453 3454 3455

    @since version 2.1.0
    */
3456
    template <
N
Niels Lohmann 已提交
3457 3458 3459
        typename ValueTypeCV,
        typename ValueType = detail::uncvref_t<ValueTypeCV>,
        detail::enable_if_t<not std::is_same<basic_json_t, ValueType>::value and
3460
                            detail::has_non_default_from_json<basic_json_t,
N
Niels Lohmann 已提交
3461 3462 3463
                                    ValueType>::value, int> = 0 >
    ValueType get() const noexcept(noexcept(
                                       JSONSerializer<ValueTypeCV>::from_json(std::declval<const basic_json_t&>())))
3464
    {
N
Niels Lohmann 已提交
3465 3466 3467
        static_assert(not std::is_reference<ValueTypeCV>::value,
                      "get() cannot be used with reference types, you might want to use get_ref()");
        return JSONSerializer<ValueTypeCV>::from_json(*this);
3468 3469
    }

N
Niels 已提交
3470 3471 3472 3473 3474 3475
    /*!
    @brief get a pointer value (explicit)

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

N
Niels 已提交
3476 3477
    @warning The pointer becomes invalid if the underlying JSON object
    changes.
N
Niels 已提交
3478 3479

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

N
Niels 已提交
3483 3484
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
3485 3486 3487 3488 3489 3490 3491 3492 3493

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

N
Niels 已提交
3495
    @since version 1.0.0
N
Niels 已提交
3496
    */
N
Niels 已提交
3497 3498
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3499 3500 3501 3502 3503 3504 3505 3506 3507 3508
    PointerType get() noexcept
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

    /*!
    @brief get a pointer value (explicit)
    @copydoc get()
    */
N
Niels 已提交
3509 3510
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3511
    constexpr const PointerType get() const noexcept
N
Niels 已提交
3512 3513 3514 3515 3516 3517 3518 3519
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

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

N
Niels 已提交
3520
    Implicit pointer access to the internally stored JSON value. No copies are
N
Niels 已提交
3521 3522 3523 3524 3525 3526
    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 已提交
3527
    object_t, @ref string_t, @ref boolean_t, @ref number_integer_t,
N
Niels 已提交
3528 3529
    @ref number_unsigned_t, or @ref number_float_t. Enforced by a static
    assertion.
N
Niels 已提交
3530

N
Niels 已提交
3531 3532
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
3533 3534 3535 3536 3537 3538 3539

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

N
Niels 已提交
3541
    @since version 1.0.0
N
Niels 已提交
3542
    */
N
Niels 已提交
3543 3544
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3545 3546
    PointerType get_ptr() noexcept
    {
N
Niels 已提交
3547 3548
        // get the type of the PointerType (remove pointer and const)
        using pointee_t = typename std::remove_const<typename
T
Théo DELRIEU 已提交
3549 3550
                          std::remove_pointer<typename
                          std::remove_const<PointerType>::type>::type>::type;
N
Niels 已提交
3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561
        // make sure the type matches the allowed types
        static_assert(
            std::is_same<object_t, pointee_t>::value
            or std::is_same<array_t, pointee_t>::value
            or std::is_same<string_t, pointee_t>::value
            or std::is_same<boolean_t, pointee_t>::value
            or std::is_same<number_integer_t, pointee_t>::value
            or std::is_same<number_unsigned_t, pointee_t>::value
            or std::is_same<number_float_t, pointee_t>::value
            , "incompatible pointer type");

N
Niels 已提交
3562 3563 3564 3565 3566 3567 3568 3569
        // delegate the call to get_impl_ptr<>()
        return get_impl_ptr(static_cast<PointerType>(nullptr));
    }

    /*!
    @brief get a pointer value (implicit)
    @copydoc get_ptr()
    */
N
Niels 已提交
3570 3571 3572
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value and
                 std::is_const<typename std::remove_pointer<PointerType>::type>::value, int>::type = 0>
N
Niels 已提交
3573
    constexpr const PointerType get_ptr() const noexcept
N
Niels 已提交
3574
    {
N
Niels 已提交
3575 3576
        // get the type of the PointerType (remove pointer and const)
        using pointee_t = typename std::remove_const<typename
T
Théo DELRIEU 已提交
3577 3578
                          std::remove_pointer<typename
                          std::remove_const<PointerType>::type>::type>::type;
N
Niels 已提交
3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589
        // make sure the type matches the allowed types
        static_assert(
            std::is_same<object_t, pointee_t>::value
            or std::is_same<array_t, pointee_t>::value
            or std::is_same<string_t, pointee_t>::value
            or std::is_same<boolean_t, pointee_t>::value
            or std::is_same<number_integer_t, pointee_t>::value
            or std::is_same<number_unsigned_t, pointee_t>::value
            or std::is_same<number_float_t, pointee_t>::value
            , "incompatible pointer type");

N
Niels 已提交
3590
        // delegate the call to get_impl_ptr<>() const
D
dariomt 已提交
3591
        return get_impl_ptr(static_cast<const PointerType>(nullptr));
D
dariomt 已提交
3592 3593
    }

N
Niels 已提交
3594
    /*!
D
dariomt 已提交
3595 3596
    @brief get a reference value (implicit)

N
Niels Lohmann 已提交
3597
    Implicit reference access to the internally stored JSON value. No copies
N
Niels 已提交
3598
    are made.
D
dariomt 已提交
3599 3600 3601 3602

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

N
Niels 已提交
3603 3604
    @tparam ReferenceType reference type; must be a reference to @ref array_t,
    @ref object_t, @ref string_t, @ref boolean_t, @ref number_integer_t, or
N
Niels 已提交
3605
    @ref number_float_t. Enforced by static assertion.
D
dariomt 已提交
3606

N
Niels 已提交
3607 3608
    @return reference to the internally stored JSON value if the requested
    reference type @a ReferenceType fits to the JSON value; throws
3609
    type_error.303 otherwise
D
dariomt 已提交
3610

3611
    @throw type_error.303 in case passed type @a ReferenceType is incompatible
3612
    with the stored JSON value; see example below
D
dariomt 已提交
3613 3614

    @complexity Constant.
N
Niels 已提交
3615 3616 3617

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

N
Niels 已提交
3618
    @since version 1.1.0
D
dariomt 已提交
3619
    */
N
Niels 已提交
3620 3621
    template<typename ReferenceType, typename std::enable_if<
                 std::is_reference<ReferenceType>::value, int>::type = 0>
D
dariomt 已提交
3622 3623
    ReferenceType get_ref()
    {
N
Niels 已提交
3624 3625
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
D
dariomt 已提交
3626 3627 3628 3629 3630 3631
    }

    /*!
    @brief get a reference value (implicit)
    @copydoc get_ref()
    */
N
Niels 已提交
3632 3633 3634
    template<typename ReferenceType, typename std::enable_if<
                 std::is_reference<ReferenceType>::value and
                 std::is_const<typename std::remove_reference<ReferenceType>::type>::value, int>::type = 0>
3635
    ReferenceType get_ref() const
D
dariomt 已提交
3636
    {
N
Niels 已提交
3637 3638
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
N
Niels 已提交
3639 3640 3641 3642 3643
    }

    /*!
    @brief get a value (implicit)

N
Niels 已提交
3644 3645
    Implicit type conversion between the JSON value and a compatible value.
    The call is realized by calling @ref get() const.
N
Niels 已提交
3646 3647 3648

    @tparam ValueType non-pointer type compatible to the JSON value, for
    instance `int` for JSON integer numbers, `bool` for JSON booleans, or
N
Niels 已提交
3649 3650 3651
    `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 已提交
3652 3653 3654

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

N
Niels Lohmann 已提交
3655
    @throw type_error.302 in case passed type @a ValueType is incompatible
3656 3657
    to the JSON value type (e.g., the JSON value is of type boolean, but a
    string is requested); see example below
N
Niels 已提交
3658 3659 3660

    @complexity Linear in the size of the JSON value.

N
Niels 已提交
3661
    @liveexample{The example below shows several conversions from JSON values
N
Niels 已提交
3662 3663 3664
    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 已提交
3665
    associative containers such as `std::unordered_map<std::string\,
N
Niels 已提交
3666
    json>`.,operator__ValueType}
N
Niels 已提交
3667

N
Niels 已提交
3668
    @since version 1.0.0
N
Niels 已提交
3669
    */
N
Niels 已提交
3670 3671 3672
    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
N
Niels Lohmann 已提交
3673
#ifndef _MSC_VER  // fix for issue #167 operator<< ambiguity under VS2015
N
Niels 已提交
3674
                   and not std::is_same<ValueType, std::initializer_list<typename string_t::value_type>>::value
3675
#endif
N
Niels 已提交
3676
                   , int >::type = 0 >
N
Niels 已提交
3677
    operator ValueType() const
N
Niels 已提交
3678
    {
N
Niels 已提交
3679 3680
        // delegate the call to get<>() const
        return get<ValueType>();
N
Niels 已提交
3681 3682
    }

N
Niels 已提交
3683 3684
    /// @}

N
Niels 已提交
3685 3686 3687 3688 3689

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

N
Niels 已提交
3690
    /// @name element access
N
Niels 已提交
3691
    /// Access to the JSON value.
N
Niels 已提交
3692 3693
    /// @{

N
Niels 已提交
3694 3695 3696 3697 3698 3699 3700 3701 3702 3703
    /*!
    @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

3704
    @throw type_error.304 if the JSON value is not an array; in this case,
3705
    calling `at` with an index makes no sense. See example below.
3706
    @throw out_of_range.401 if the index @a idx is out of range of the array;
3707
    that is, `idx >= size()`. See example below.
N
Niels 已提交
3708

3709 3710
    @exceptionsafety Strong guarantee: if an exception is thrown, there are no
    changes in the JSON value.
N
Niels 已提交
3711

3712
    @complexity Constant.
N
Niels 已提交
3713

N
Niels 已提交
3714
    @since version 1.0.0
3715 3716 3717 3718

    @liveexample{The example below shows how array elements can be read and
    written using `at()`. It also demonstrates the different exceptions that
    can be thrown.,at__size_type}
N
Niels 已提交
3719
    */
N
Niels 已提交
3720
    reference at(size_type idx)
N
Niels 已提交
3721 3722
    {
        // at only works for arrays
3723 3724
        if (is_array())
        {
3725
            JSON_TRY
N
Niels 已提交
3726 3727 3728
            {
                return m_value.array->at(idx);
            }
3729
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3730 3731
            {
                // create better exception explanation
3732
                JSON_THROW(out_of_range(401, "array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
3733
            }
3734 3735
        }
        else
N
Niels 已提交
3736
        {
3737
            JSON_THROW(type_error(304, "cannot use at() with " + type_name()));
N
Niels 已提交
3738 3739 3740
        }
    }

N
Niels 已提交
3741 3742 3743
    /*!
    @brief access specified array element with bounds checking

N
Niels 已提交
3744 3745
    Returns a const reference to the element at specified location @a idx,
    with bounds checking.
N
Niels 已提交
3746 3747 3748 3749 3750

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

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

3751
    @throw type_error.304 if the JSON value is not an array; in this case,
3752
    calling `at` with an index makes no sense. See example below.
3753
    @throw out_of_range.401 if the index @a idx is out of range of the array;
3754
    that is, `idx >= size()`. See example below.
N
Niels 已提交
3755

3756 3757
    @exceptionsafety Strong guarantee: if an exception is thrown, there are no
    changes in the JSON value.
N
Niels 已提交
3758

3759
    @complexity Constant.
N
Niels 已提交
3760

N
Niels 已提交
3761
    @since version 1.0.0
3762 3763 3764 3765

    @liveexample{The example below shows how array elements can be read using
    `at()`. It also demonstrates the different exceptions that can be thrown.,
    at__size_type_const}
N
Niels 已提交
3766
    */
N
Niels 已提交
3767
    const_reference at(size_type idx) const
N
Niels 已提交
3768 3769
    {
        // at only works for arrays
3770 3771
        if (is_array())
        {
3772
            JSON_TRY
N
Niels 已提交
3773 3774 3775
            {
                return m_value.array->at(idx);
            }
3776
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3777 3778
            {
                // create better exception explanation
3779
                JSON_THROW(out_of_range(401, "array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
3780
            }
3781 3782
        }
        else
N
Niels 已提交
3783
        {
3784
            JSON_THROW(type_error(304, "cannot use at() with " + type_name()));
N
Niels 已提交
3785
        }
3786 3787
    }

N
Niels 已提交
3788 3789 3790 3791 3792 3793 3794 3795 3796 3797
    /*!
    @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

3798
    @throw type_error.304 if the JSON value is not an object; in this case,
3799
    calling `at` with a key makes no sense. See example below.
3800
    @throw out_of_range.403 if the key @a key is is not stored in the object;
3801
    that is, `find(key) == end()`. See example below.
N
Niels 已提交
3802

3803 3804
    @exceptionsafety Strong guarantee: if an exception is thrown, there are no
    changes in the JSON value.
N
Niels 已提交
3805

3806
    @complexity Logarithmic in the size of the container.
N
Niels 已提交
3807 3808 3809 3810

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

N
Niels 已提交
3812
    @since version 1.0.0
3813 3814 3815 3816

    @liveexample{The example below shows how object elements can be read and
    written using `at()`. It also demonstrates the different exceptions that
    can be thrown.,at__object_t_key_type}
N
Niels 已提交
3817
    */
N
Niels 已提交
3818
    reference at(const typename object_t::key_type& key)
3819 3820
    {
        // at only works for objects
3821 3822
        if (is_object())
        {
3823
            JSON_TRY
N
Niels 已提交
3824 3825 3826
            {
                return m_value.object->at(key);
            }
3827
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3828 3829
            {
                // create better exception explanation
3830
                JSON_THROW(out_of_range(403, "key '" + key + "' not found"));
N
Niels 已提交
3831
            }
3832 3833
        }
        else
3834
        {
3835
            JSON_THROW(type_error(304, "cannot use at() with " + type_name()));
3836 3837 3838
        }
    }

N
Niels 已提交
3839 3840 3841
    /*!
    @brief access specified object element with bounds checking

N
Niels 已提交
3842 3843
    Returns a const reference to the element at with specified key @a key,
    with bounds checking.
N
Niels 已提交
3844 3845 3846 3847 3848

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

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

3849
    @throw type_error.304 if the JSON value is not an object; in this case,
3850
    calling `at` with a key makes no sense. See example below.
3851
    @throw out_of_range.403 if the key @a key is is not stored in the object;
3852
    that is, `find(key) == end()`. See example below.
N
Niels 已提交
3853

3854 3855
    @exceptionsafety Strong guarantee: if an exception is thrown, there are no
    changes in the JSON value.
N
Niels 已提交
3856

3857
    @complexity Logarithmic in the size of the container.
N
Niels 已提交
3858 3859 3860 3861

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

N
Niels 已提交
3863
    @since version 1.0.0
3864 3865 3866 3867

    @liveexample{The example below shows how object elements can be read using
    `at()`. It also demonstrates the different exceptions that can be thrown.,
    at__object_t_key_type_const}
N
Niels 已提交
3868
    */
N
Niels 已提交
3869
    const_reference at(const typename object_t::key_type& key) const
3870 3871
    {
        // at only works for objects
3872 3873
        if (is_object())
        {
3874
            JSON_TRY
N
Niels 已提交
3875 3876 3877
            {
                return m_value.object->at(key);
            }
3878
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3879 3880
            {
                // create better exception explanation
3881
                JSON_THROW(out_of_range(403, "key '" + key + "' not found"));
N
Niels 已提交
3882
            }
3883 3884
        }
        else
3885
        {
3886
            JSON_THROW(type_error(304, "cannot use at() with " + type_name()));
3887
        }
N
Niels 已提交
3888 3889
    }

N
Niels 已提交
3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902
    /*!
    @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

3903 3904
    @throw type_error.305 if the JSON value is not an array or null; in that
    cases, using the [] operator with an index makes no sense.
N
Niels 已提交
3905 3906 3907 3908 3909

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

N
Niels 已提交
3913
    @since version 1.0.0
N
Niels 已提交
3914
    */
N
Niels 已提交
3915
    reference operator[](size_type idx)
N
Niels 已提交
3916
    {
N
Niels 已提交
3917
        // implicitly convert null value to an empty array
N
cleanup  
Niels 已提交
3918
        if (is_null())
N
Niels 已提交
3919 3920
        {
            m_type = value_t::array;
N
Cleanup  
Niels 已提交
3921
            m_value.array = create<array_t>();
3922
            assert_invariant();
N
Niels 已提交
3923 3924
        }

N
Niels 已提交
3925
        // operator[] only works for arrays
N
cleanup  
Niels 已提交
3926
        if (is_array())
N
Niels 已提交
3927
        {
N
Niels 已提交
3928 3929
            // fill up array with null values if given idx is outside range
            if (idx >= m_value.array->size())
N
cleanup  
Niels 已提交
3930
            {
N
Niels 已提交
3931 3932 3933
                m_value.array->insert(m_value.array->end(),
                                      idx - m_value.array->size() + 1,
                                      basic_json());
N
cleanup  
Niels 已提交
3934
            }
N
Niels 已提交
3935

N
cleanup  
Niels 已提交
3936 3937
            return m_value.array->operator[](idx);
        }
N
Niels Lohmann 已提交
3938

3939
        JSON_THROW(type_error(305, "cannot use operator[] with " + type_name()));
N
Niels 已提交
3940 3941
    }

N
Niels 已提交
3942 3943 3944 3945 3946 3947 3948 3949 3950
    /*!
    @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

3951 3952
    @throw type_error.305 if the JSON value is not an array; in that cases,
    using the [] operator with an index makes no sense.
N
Niels 已提交
3953 3954 3955 3956

    @complexity Constant.

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

N
Niels 已提交
3959
    @since version 1.0.0
N
Niels 已提交
3960
    */
N
Niels 已提交
3961
    const_reference operator[](size_type idx) const
N
Niels 已提交
3962
    {
N
Niels 已提交
3963
        // const operator[] only works for arrays
N
Niels 已提交
3964 3965 3966 3967
        if (is_array())
        {
            return m_value.array->operator[](idx);
        }
N
Niels Lohmann 已提交
3968

3969
        JSON_THROW(type_error(305, "cannot use operator[] with " + type_name()));
N
Niels 已提交
3970 3971
    }

N
Niels 已提交
3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984
    /*!
    @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

3985 3986
    @throw type_error.305 if the JSON value is not an object or null; in that
    cases, using the [] operator with a key makes no sense.
N
Niels 已提交
3987 3988 3989 3990

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3991
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
3992 3993 3994 3995

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

N
Niels 已提交
3997
    @since version 1.0.0
N
Niels 已提交
3998
    */
N
Niels 已提交
3999
    reference operator[](const typename object_t::key_type& key)
N
Niels 已提交
4000
    {
N
Niels 已提交
4001
        // implicitly convert null value to an empty object
N
cleanup  
Niels 已提交
4002
        if (is_null())
N
Niels 已提交
4003 4004
        {
            m_type = value_t::object;
N
Cleanup  
Niels 已提交
4005
            m_value.object = create<object_t>();
4006
            assert_invariant();
N
Niels 已提交
4007 4008
        }

N
Niels 已提交
4009
        // operator[] only works for objects
N
Niels 已提交
4010 4011 4012 4013
        if (is_object())
        {
            return m_value.object->operator[](key);
        }
N
Niels Lohmann 已提交
4014

4015
        JSON_THROW(type_error(305, "cannot use operator[] with " + type_name()));
N
Niels 已提交
4016 4017
    }

N
Niels 已提交
4018
    /*!
4019
    @brief read-only access specified object element
N
Niels 已提交
4020

4021 4022 4023 4024 4025
    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 已提交
4026 4027 4028

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

4029
    @return const reference to the element at key @a key
N
Niels 已提交
4030

N
Niels 已提交
4031 4032 4033
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

4034 4035
    @throw type_error.305 if the JSON value is not an object; in that cases,
    using the [] operator with a key makes no sense.
N
Niels 已提交
4036 4037 4038 4039

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
4040
    the `[]` operator.,operatorarray__key_type_const}
4041 4042 4043 4044 4045

    @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 已提交
4046
    @since version 1.0.0
N
Niels 已提交
4047
    */
N
Niels 已提交
4048
    const_reference operator[](const typename object_t::key_type& key) const
4049
    {
N
Niels 已提交
4050
        // const operator[] only works for objects
N
Niels 已提交
4051 4052 4053 4054 4055
        if (is_object())
        {
            assert(m_value.object->find(key) != m_value.object->end());
            return m_value.object->find(key)->second;
        }
N
Niels Lohmann 已提交
4056

4057
        JSON_THROW(type_error(305, "cannot use operator[] with " + type_name()));
4058 4059
    }

N
Niels 已提交
4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072
    /*!
    @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

4073 4074
    @throw type_error.305 if the JSON value is not an object or null; in that
    cases, using the [] operator with a key makes no sense.
N
Niels 已提交
4075 4076 4077 4078

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
4079
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
4080 4081 4082 4083

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

N
Niels 已提交
4085
    @since version 1.0.0
N
Niels 已提交
4086
    */
N
Niels 已提交
4087
    template<typename T, std::size_t n>
N
Niels 已提交
4088
    reference operator[](T * (&key)[n])
4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107
    {
        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

4108 4109
    @throw type_error.305 if the JSON value is not an object; in that cases,
    using the [] operator with a key makes no sense.
4110 4111 4112 4113

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
4114
    the `[]` operator.,operatorarray__key_type_const}
4115 4116 4117 4118 4119 4120 4121 4122

    @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 已提交
4123
    const_reference operator[](T * (&key)[n]) const
4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140
    {
        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

4141 4142
    @throw type_error.305 if the JSON value is not an object or null; in that
    cases, using the [] operator with a key makes no sense.
4143 4144 4145 4146

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
4147
    written using the `[]` operator.,operatorarray__key_type}
4148 4149 4150 4151 4152

    @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 已提交
4153
    @since version 1.1.0
4154 4155 4156
    */
    template<typename T>
    reference operator[](T* key)
N
Niels 已提交
4157
    {
N
Niels 已提交
4158
        // implicitly convert null to object
N
cleanup  
Niels 已提交
4159
        if (is_null())
N
Niels 已提交
4160 4161
        {
            m_type = value_t::object;
N
Niels 已提交
4162
            m_value = value_t::object;
4163
            assert_invariant();
N
Niels 已提交
4164 4165
        }

N
Niels 已提交
4166
        // at only works for objects
N
Niels 已提交
4167 4168 4169 4170
        if (is_object())
        {
            return m_value.object->operator[](key);
        }
N
Niels Lohmann 已提交
4171

4172
        JSON_THROW(type_error(305, "cannot use operator[] with " + type_name()));
N
Niels 已提交
4173 4174
    }

N
Niels 已提交
4175
    /*!
4176
    @brief read-only access specified object element
N
Niels 已提交
4177

4178 4179 4180 4181 4182
    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 已提交
4183 4184 4185

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

4186
    @return const reference to the element at key @a key
N
Niels 已提交
4187

N
Niels 已提交
4188 4189 4190
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

4191 4192
    @throw type_error.305 if the JSON value is not an object; in that cases,
    using the [] operator with a key makes no sense.
N
Niels 已提交
4193 4194 4195 4196

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
4197
    the `[]` operator.,operatorarray__key_type_const}
4198 4199 4200 4201 4202

    @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 已提交
4203
    @since version 1.1.0
N
Niels 已提交
4204
    */
4205 4206
    template<typename T>
    const_reference operator[](T* key) const
4207 4208
    {
        // at only works for objects
N
Niels 已提交
4209 4210 4211 4212 4213
        if (is_object())
        {
            assert(m_value.object->find(key) != m_value.object->end());
            return m_value.object->find(key)->second;
        }
N
Niels Lohmann 已提交
4214

4215
        JSON_THROW(type_error(305, "cannot use operator[] with " + type_name()));
4216 4217
    }

N
Niels 已提交
4218 4219 4220
    /*!
    @brief access specified object element with default value

N
Niels 已提交
4221 4222
    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.
4223

N
Niels 已提交
4224
    The function is basically equivalent to executing
4225
    @code {.cpp}
N
Niels 已提交
4226 4227
    try {
        return at(key);
4228
    } catch(out_of_range) {
N
Niels 已提交
4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250
        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

4251 4252
    @throw type_error.306 if the JSON value is not an objec; in that cases,
    using `value()` with a key makes no sense.
N
Niels 已提交
4253 4254 4255 4256 4257 4258 4259 4260 4261 4262

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

N
Niels 已提交
4264
    @since version 1.0.0
N
Niels 已提交
4265
    */
N
Niels 已提交
4266 4267
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278
    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;
            }
N
Niels Lohmann 已提交
4279 4280

            return default_value;
N
Niels 已提交
4281 4282 4283
        }
        else
        {
4284
            JSON_THROW(type_error(306, "cannot use value() with " + type_name()));
N
Niels 已提交
4285 4286 4287 4288
        }
    }

    /*!
N
Niels 已提交
4289
    @brief overload for a default value of type const char*
N
Niels 已提交
4290
    @copydoc basic_json::value(const typename object_t::key_type&, ValueType) const
N
Niels 已提交
4291 4292 4293 4294
    */
    string_t value(const typename object_t::key_type& key, const char* default_value) const
    {
        return value(key, string_t(default_value));
4295 4296
    }

N
Niels 已提交
4297 4298 4299
    /*!
    @brief access specified object element via JSON Pointer with default value

N
Niels 已提交
4300 4301 4302 4303 4304 4305 4306
    Returns either a copy of an object's element at the specified key @a key
    or a given default value if no element with key @a key exists.

    The function is basically equivalent to executing
    @code {.cpp}
    try {
        return at(ptr);
4307
    } catch(out_of_range) {
N
Niels 已提交
4308 4309 4310 4311 4312 4313 4314
        return default_value;
    }
    @endcode

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

N
Niels 已提交
4315 4316 4317 4318 4319 4320 4321 4322
    @param[in] ptr  a JSON pointer to the element to access
    @param[in] default_value  the value to return if @a ptr found no value

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

N
Niels 已提交
4323 4324 4325
    @return copy of the element at key @a key or @a default_value if @a key
    is not found

4326 4327
    @throw type_error.306 if the JSON value is not an objec; in that cases,
    using `value()` with a key makes no sense.
N
Niels 已提交
4328 4329 4330 4331 4332 4333

    @complexity Logarithmic in the size of the container.

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

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

N
Niels 已提交
4336 4337
    @since version 2.0.2
    */
N
Niels 已提交
4338 4339
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
4340 4341 4342 4343 4344 4345
    ValueType value(const json_pointer& ptr, ValueType default_value) const
    {
        // at only works for objects
        if (is_object())
        {
            // if pointer resolves a value, return it or use default value
4346
            JSON_TRY
N
Niels 已提交
4347 4348 4349
            {
                return ptr.get_checked(this);
            }
4350
            JSON_CATCH (out_of_range&)
N
Niels 已提交
4351 4352 4353 4354
            {
                return default_value;
            }
        }
N
Niels Lohmann 已提交
4355

4356
        JSON_THROW(type_error(306, "cannot use value() with " + type_name()));
N
Niels 已提交
4357 4358 4359 4360
    }

    /*!
    @brief overload for a default value of type const char*
N
Niels 已提交
4361
    @copydoc basic_json::value(const json_pointer&, ValueType) const
N
Niels 已提交
4362 4363 4364 4365 4366 4367
    */
    string_t value(const json_pointer& ptr, const char* default_value) const
    {
        return value(ptr, string_t(default_value));
    }

N
Niels 已提交
4368 4369 4370 4371 4372 4373
    /*!
    @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 已提交
4374
    @return In case of a structured type (array or object), a reference to the
4375
    first element is returned. In case of number, string, or boolean values, a
N
Niels 已提交
4376 4377 4378 4379
    reference to the value is returned.

    @complexity Constant.

N
Niels 已提交
4380
    @pre The JSON value must not be `null` (would throw `std::out_of_range`)
N
Niels 已提交
4381 4382
    or an empty array or object (undefined behavior, **guarded by
    assertions**).
N
Niels 已提交
4383 4384
    @post The JSON value remains unchanged.

N
Niels Lohmann 已提交
4385
    @throw invalid_iterator.214 when called on `null` value
N
Niels 已提交
4386

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

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

N
Niels 已提交
4391
    @since version 1.0.0
N
Niels 已提交
4392
    */
N
Niels 已提交
4393
    reference front()
N
Niels 已提交
4394 4395 4396 4397
    {
        return *begin();
    }

N
Niels 已提交
4398 4399 4400
    /*!
    @copydoc basic_json::front()
    */
N
Niels 已提交
4401
    const_reference front() const
N
Niels 已提交
4402 4403 4404 4405
    {
        return *cbegin();
    }

N
Niels 已提交
4406 4407 4408 4409
    /*!
    @brief access the last element

    Returns a reference to the last element in the container. For a JSON
N
Niels 已提交
4410 4411 4412 4413 4414 4415
    container `c`, the expression `c.back()` is equivalent to
    @code {.cpp}
    auto tmp = c.end();
    --tmp;
    return *tmp;
    @endcode
N
Niels 已提交
4416

N
Niels 已提交
4417
    @return In case of a structured type (array or object), a reference to the
4418
    last element is returned. In case of number, string, or boolean values, a
N
Niels 已提交
4419 4420 4421 4422
    reference to the value is returned.

    @complexity Constant.

N
Niels 已提交
4423
    @pre The JSON value must not be `null` (would throw `std::out_of_range`)
N
Niels 已提交
4424 4425
    or an empty array or object (undefined behavior, **guarded by
    assertions**).
N
Niels 已提交
4426
    @post The JSON value remains unchanged.
N
Niels 已提交
4427

4428 4429
    @throw invalid_iterator.214 when called on a `null` value. See example
    below.
N
Niels 已提交
4430

N
Niels 已提交
4431 4432 4433
    @liveexample{The following code shows an example for `back()`.,back}

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

N
Niels 已提交
4435
    @since version 1.0.0
N
Niels 已提交
4436
    */
N
Niels 已提交
4437
    reference back()
N
Niels 已提交
4438 4439 4440 4441 4442 4443
    {
        auto tmp = end();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
4444 4445 4446
    /*!
    @copydoc basic_json::back()
    */
N
Niels 已提交
4447
    const_reference back() const
N
Niels 已提交
4448 4449 4450 4451 4452 4453
    {
        auto tmp = cend();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
4454 4455 4456
    /*!
    @brief remove element given an iterator

N
Niels 已提交
4457 4458 4459
    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 已提交
4460

N
Niels 已提交
4461
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
4462 4463 4464
    will be `null`.

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

4468
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
4469

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

4473 4474
    @throw type_error.307 if called on a `null` value; example: `"cannot use
    erase() with null"`
4475 4476 4477
    @throw invalid_iterator.202 if called on an iterator which does not belong
    to the current JSON value; example: `"iterator does not fit current
    value"`
4478
    @throw invalid_iterator.205 if called on a primitive type with invalid
N
Niels 已提交
4479 4480
    iterator (i.e., any iterator which is not `begin()`); example: `"iterator
    out of range"`
N
Niels 已提交
4481 4482 4483

    @complexity The complexity depends on the type:
    - objects: amortized constant
N
Niels Lohmann 已提交
4484
    - arrays: linear in distance between @a pos and the end of the container
N
Niels 已提交
4485 4486 4487
    - strings: linear in the length of the string
    - other types: constant

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

4491
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4492
    the given range
N
Niels 已提交
4493
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4494
    from an object at the given key
N
Niels 已提交
4495 4496
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4497

N
Niels 已提交
4498
    @since version 1.0.0
N
Niels 已提交
4499
    */
N
Niels 已提交
4500 4501 4502 4503
    template<class IteratorType, typename std::enable_if<
                 std::is_same<IteratorType, typename basic_json_t::iterator>::value or
                 std::is_same<IteratorType, typename basic_json_t::const_iterator>::value, int>::type
             = 0>
4504
    IteratorType erase(IteratorType pos)
4505 4506
    {
        // make sure iterator fits the current value
N
Niels 已提交
4507
        if (this != pos.m_object)
4508
        {
4509
            JSON_THROW(invalid_iterator(202, "iterator does not fit current value"));
4510 4511
        }

4512
        IteratorType result = end();
4513 4514 4515 4516

        switch (m_type)
        {
            case value_t::boolean:
4517 4518
            case value_t::number_float:
            case value_t::number_integer:
4519
            case value_t::number_unsigned:
4520 4521
            case value_t::string:
            {
4522
                if (not pos.m_it.primitive_iterator.is_begin())
4523
                {
4524
                    JSON_THROW(invalid_iterator(205, "iterator out of range"));
4525 4526
                }

N
cleanup  
Niels 已提交
4527
                if (is_string())
4528
                {
4529 4530 4531
                    AllocatorType<string_t> alloc;
                    alloc.destroy(m_value.string);
                    alloc.deallocate(m_value.string, 1);
4532 4533 4534 4535
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
4536
                assert_invariant();
4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553
                break;
            }

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

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

            default:
            {
4554
                JSON_THROW(type_error(307, "cannot use erase() with " + type_name()));
4555 4556 4557 4558 4559 4560
            }
        }

        return result;
    }

N
Niels 已提交
4561 4562 4563
    /*!
    @brief remove elements given an iterator range

N
Niels 已提交
4564 4565 4566
    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 已提交
4567

N
Niels 已提交
4568
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
4569 4570 4571 4572 4573
    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 已提交
4574
    second refers to the last element, the `end()` iterator is returned.
N
Niels 已提交
4575

4576
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
4577

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

4581 4582
    @throw type_error.307 if called on a `null` value; example: `"cannot use
    erase() with null"`
4583 4584 4585
    @throw invalid_iterator.203 if called on iterators which does not belong
    to the current JSON value; example: `"iterators do not fit current value"`
    @throw invalid_iterator.204 if called on a primitive type with invalid
N
Niels 已提交
4586 4587
    iterators (i.e., if `first != begin()` and `last != end()`); example:
    `"iterators out of range"`
N
Niels 已提交
4588 4589 4590 4591 4592 4593 4594 4595

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

4599
    @sa @ref erase(IteratorType) -- removes the element at a given position
N
Niels 已提交
4600
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4601
    from an object at the given key
N
Niels 已提交
4602 4603
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4604

N
Niels 已提交
4605
    @since version 1.0.0
N
Niels 已提交
4606
    */
N
Niels 已提交
4607 4608 4609 4610
    template<class IteratorType, typename std::enable_if<
                 std::is_same<IteratorType, typename basic_json_t::iterator>::value or
                 std::is_same<IteratorType, typename basic_json_t::const_iterator>::value, int>::type
             = 0>
4611
    IteratorType erase(IteratorType first, IteratorType last)
4612 4613
    {
        // make sure iterator fits the current value
N
Niels 已提交
4614
        if (this != first.m_object or this != last.m_object)
4615
        {
4616
            JSON_THROW(invalid_iterator(203, "iterators do not fit current value"));
4617 4618
        }

4619
        IteratorType result = end();
4620 4621 4622 4623

        switch (m_type)
        {
            case value_t::boolean:
4624 4625
            case value_t::number_float:
            case value_t::number_integer:
4626
            case value_t::number_unsigned:
4627 4628
            case value_t::string:
            {
4629
                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
4630
                {
4631
                    JSON_THROW(invalid_iterator(204, "iterators out of range"));
4632 4633
                }

N
cleanup  
Niels 已提交
4634
                if (is_string())
4635
                {
4636 4637 4638
                    AllocatorType<string_t> alloc;
                    alloc.destroy(m_value.string);
                    alloc.deallocate(m_value.string, 1);
4639 4640 4641 4642
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
4643
                assert_invariant();
4644 4645 4646 4647 4648 4649
                break;
            }

            case value_t::object:
            {
                result.m_it.object_iterator = m_value.object->erase(first.m_it.object_iterator,
T
Théo DELRIEU 已提交
4650
                                              last.m_it.object_iterator);
4651 4652 4653 4654 4655 4656
                break;
            }

            case value_t::array:
            {
                result.m_it.array_iterator = m_value.array->erase(first.m_it.array_iterator,
T
Théo DELRIEU 已提交
4657
                                             last.m_it.array_iterator);
4658 4659 4660 4661 4662
                break;
            }

            default:
            {
4663
                JSON_THROW(type_error(307, "cannot use erase() with " + type_name()));
4664 4665 4666 4667 4668 4669
            }
        }

        return result;
    }

N
Niels 已提交
4670 4671 4672 4673 4674 4675 4676
    /*!
    @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 已提交
4677
    @return Number of elements removed. If @a ObjectType is the default
N
Niels 已提交
4678 4679
    `std::map` type, the return value will always be `0` (@a key was not
    found) or `1` (@a key was found).
N
Niels 已提交
4680 4681 4682

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

4684
    @throw type_error.307 when called on a type other than JSON object;
N
Niels 已提交
4685
    example: `"cannot use erase() with null"`
N
Niels 已提交
4686 4687 4688

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

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

4691 4692
    @sa @ref erase(IteratorType) -- removes the element at a given position
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4693 4694 4695
    the given range
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4696

N
Niels 已提交
4697
    @since version 1.0.0
N
Niels 已提交
4698
    */
N
Niels 已提交
4699
    size_type erase(const typename object_t::key_type& key)
4700
    {
N
Niels 已提交
4701
        // this erase only works for objects
N
Niels 已提交
4702 4703 4704 4705
        if (is_object())
        {
            return m_value.object->erase(key);
        }
N
Niels Lohmann 已提交
4706

4707
        JSON_THROW(type_error(307, "cannot use erase() with " + type_name()));
4708 4709
    }

N
Niels 已提交
4710 4711 4712 4713 4714 4715 4716
    /*!
    @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

4717
    @throw type_error.307 when called on a type other than JSON object;
N
Niels 已提交
4718
    example: `"cannot use erase() with null"`
N
Niels Lohmann 已提交
4719
    @throw out_of_range.401 when `idx >= size()`; example: `"array index 17
N
Niels 已提交
4720
    is out of range"`
N
Niels 已提交
4721 4722 4723

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

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

4726 4727
    @sa @ref erase(IteratorType) -- removes the element at a given position
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4728
    the given range
N
Niels 已提交
4729
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4730 4731
    from an object at the given key

N
Niels 已提交
4732
    @since version 1.0.0
N
Niels 已提交
4733
    */
N
Niels 已提交
4734
    void erase(const size_type idx)
N
Niels 已提交
4735 4736
    {
        // this erase only works for arrays
N
cleanup  
Niels 已提交
4737
        if (is_array())
N
Niels 已提交
4738
        {
N
cleanup  
Niels 已提交
4739 4740
            if (idx >= size())
            {
4741
                JSON_THROW(out_of_range(401, "array index " + std::to_string(idx) + " is out of range"));
N
cleanup  
Niels 已提交
4742
            }
N
Niels 已提交
4743

N
cleanup  
Niels 已提交
4744 4745 4746
            m_value.array->erase(m_value.array->begin() + static_cast<difference_type>(idx));
        }
        else
N
Niels 已提交
4747
        {
4748
            JSON_THROW(type_error(307, "cannot use erase() with " + type_name()));
N
Niels 已提交
4749 4750 4751
        }
    }

N
Niels 已提交
4752 4753 4754 4755 4756 4757 4758 4759 4760 4761
    /// @}


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

    /// @name lookup
    /// @{

N
Niels 已提交
4762 4763 4764 4765
    /*!
    @brief find an element in a JSON object

    Finds an element in a JSON object with key equivalent to @a key. If the
N
Niels 已提交
4766 4767
    element is not found or the JSON value is not an object, end() is
    returned.
N
Niels 已提交
4768

4769 4770 4771
    @note This method always returns @ref end() when executed on a JSON type
          that is not an object.

N
Niels 已提交
4772 4773 4774
    @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
4775 4776
    element is found or the JSON value is not an object, past-the-end (see
    @ref end()) iterator is returned.
N
Niels 已提交
4777 4778 4779

    @complexity Logarithmic in the size of the JSON object.

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

N
Niels 已提交
4782
    @since version 1.0.0
N
Niels 已提交
4783
    */
N
Niels 已提交
4784
    iterator find(typename object_t::key_type key)
N
Niels 已提交
4785 4786 4787
    {
        auto result = end();

N
cleanup  
Niels 已提交
4788
        if (is_object())
N
Niels 已提交
4789 4790 4791 4792 4793 4794 4795
        {
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4796 4797 4798 4799
    /*!
    @brief find an element in a JSON object
    @copydoc find(typename object_t::key_type)
    */
N
Niels 已提交
4800
    const_iterator find(typename object_t::key_type key) const
N
Niels 已提交
4801 4802 4803
    {
        auto result = cend();

N
cleanup  
Niels 已提交
4804
        if (is_object())
N
Niels 已提交
4805 4806 4807 4808 4809 4810 4811
        {
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4812 4813 4814 4815 4816 4817 4818
    /*!
    @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).

4819 4820 4821
    @note This method always returns `0` when executed on a JSON type that is
          not an object.

N
Niels 已提交
4822 4823 4824 4825 4826 4827 4828
    @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 已提交
4829
    @liveexample{The example shows how `count()` is used.,count}
N
Niels 已提交
4830

N
Niels 已提交
4831
    @since version 1.0.0
N
Niels 已提交
4832
    */
N
Niels 已提交
4833
    size_type count(typename object_t::key_type key) const
4834 4835
    {
        // return 0 for all nonobject types
N
Niels 已提交
4836
        return is_object() ? m_value.object->count(key) : 0;
4837 4838
    }

N
Niels 已提交
4839 4840
    /// @}

N
Niels 已提交
4841

N
Niels 已提交
4842 4843 4844 4845
    ///////////////
    // iterators //
    ///////////////

N
Niels 已提交
4846 4847 4848
    /// @name iterators
    /// @{

N
Niels 已提交
4849 4850
    /*!
    @brief returns an iterator to the first element
N
Niels 已提交
4851 4852 4853 4854 4855 4856 4857 4858 4859

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

N
Niels 已提交
4865 4866 4867 4868 4869
    @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 已提交
4870

N
Niels 已提交
4871
    @since version 1.0.0
N
Niels 已提交
4872
    */
N
Niels 已提交
4873
    iterator begin() noexcept
N
Niels 已提交
4874 4875 4876 4877 4878 4879
    {
        iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4880
    /*!
N
Niels 已提交
4881
    @copydoc basic_json::cbegin()
N
Niels 已提交
4882
    */
N
Niels 已提交
4883
    const_iterator begin() const noexcept
N
Niels 已提交
4884
    {
N
Niels 已提交
4885
        return cbegin();
N
Niels 已提交
4886 4887
    }

N
Niels 已提交
4888 4889
    /*!
    @brief returns a const iterator to the first element
N
Niels 已提交
4890 4891 4892 4893 4894 4895 4896 4897 4898

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

N
Niels 已提交
4905 4906 4907 4908 4909
    @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 已提交
4910

N
Niels 已提交
4911
    @since version 1.0.0
N
Niels 已提交
4912
    */
N
Niels 已提交
4913
    const_iterator cbegin() const noexcept
N
Niels 已提交
4914 4915 4916 4917 4918 4919
    {
        const_iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4920 4921
    /*!
    @brief returns an iterator to one past the last element
N
Niels 已提交
4922 4923 4924 4925 4926 4927 4928 4929 4930

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

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

N
Niels 已提交
4942
    @since version 1.0.0
N
Niels 已提交
4943
    */
N
Niels 已提交
4944
    iterator end() noexcept
N
Niels 已提交
4945 4946 4947 4948 4949 4950
    {
        iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
4951
    /*!
N
Niels 已提交
4952
    @copydoc basic_json::cend()
N
Niels 已提交
4953
    */
N
Niels 已提交
4954
    const_iterator end() const noexcept
N
Niels 已提交
4955
    {
N
Niels 已提交
4956
        return cend();
N
Niels 已提交
4957 4958
    }

N
Niels 已提交
4959 4960
    /*!
    @brief returns a const iterator to one past the last element
N
Niels 已提交
4961 4962 4963 4964 4965 4966 4967 4968 4969

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

N
Niels 已提交
4976 4977 4978 4979 4980
    @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 已提交
4981

N
Niels 已提交
4982
    @since version 1.0.0
N
Niels 已提交
4983
    */
N
Niels 已提交
4984
    const_iterator cend() const noexcept
N
Niels 已提交
4985 4986 4987 4988 4989 4990
    {
        const_iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
4991
    /*!
N
Niels 已提交
4992 4993 4994 4995 4996 4997 4998 4999
    @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 已提交
5000 5001 5002
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
5003 5004 5005
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(end())`.

N
Niels 已提交
5006 5007 5008 5009 5010
    @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 已提交
5011

N
Niels 已提交
5012
    @since version 1.0.0
N
Niels 已提交
5013
    */
N
Niels 已提交
5014
    reverse_iterator rbegin() noexcept
N
Niels 已提交
5015 5016 5017 5018
    {
        return reverse_iterator(end());
    }

N
Niels 已提交
5019
    /*!
N
Niels 已提交
5020
    @copydoc basic_json::crbegin()
N
Niels 已提交
5021
    */
N
Niels 已提交
5022
    const_reverse_iterator rbegin() const noexcept
N
Niels 已提交
5023
    {
N
Niels 已提交
5024
        return crbegin();
N
Niels 已提交
5025 5026
    }

N
Niels 已提交
5027
    /*!
N
Niels 已提交
5028 5029 5030 5031 5032 5033 5034 5035 5036
    @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 已提交
5037 5038 5039
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
5040 5041 5042
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(begin())`.

N
Niels 已提交
5043 5044 5045 5046 5047
    @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 已提交
5048

N
Niels 已提交
5049
    @since version 1.0.0
N
Niels 已提交
5050
    */
N
Niels 已提交
5051
    reverse_iterator rend() noexcept
N
Niels 已提交
5052 5053 5054 5055
    {
        return reverse_iterator(begin());
    }

N
Niels 已提交
5056
    /*!
N
Niels 已提交
5057
    @copydoc basic_json::crend()
N
Niels 已提交
5058
    */
N
Niels 已提交
5059
    const_reverse_iterator rend() const noexcept
N
Niels 已提交
5060
    {
N
Niels 已提交
5061
        return crend();
N
Niels 已提交
5062 5063
    }

N
Niels 已提交
5064
    /*!
N
Niels 已提交
5065 5066 5067 5068 5069 5070 5071 5072 5073
    @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 已提交
5074 5075 5076
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
5077 5078 5079
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).rbegin()`.

N
Niels 已提交
5080 5081 5082 5083 5084
    @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 已提交
5085

N
Niels 已提交
5086
    @since version 1.0.0
N
Niels 已提交
5087
    */
N
Niels 已提交
5088
    const_reverse_iterator crbegin() const noexcept
N
Niels 已提交
5089 5090 5091 5092
    {
        return const_reverse_iterator(cend());
    }

N
Niels 已提交
5093
    /*!
N
Niels 已提交
5094 5095 5096 5097 5098 5099 5100 5101 5102
    @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 已提交
5103 5104 5105
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
5106 5107 5108
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).rend()`.

N
Niels 已提交
5109 5110 5111 5112 5113
    @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 已提交
5114

N
Niels 已提交
5115
    @since version 1.0.0
N
Niels 已提交
5116
    */
N
Niels 已提交
5117
    const_reverse_iterator crend() const noexcept
N
Niels 已提交
5118 5119 5120 5121
    {
        return const_reverse_iterator(cbegin());
    }

N
cleanup  
Niels 已提交
5122 5123 5124 5125 5126 5127 5128 5129
  private:
    // forward declaration
    template<typename IteratorType> class iteration_proxy;

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

N
Niels 已提交
5130
    This function allows to access @ref iterator::key() and @ref
N
Niels 已提交
5131 5132 5133
    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 已提交
5134 5135 5136

    @note The name of this function is not yet final and may change in the
    future.
N
cleanup  
Niels 已提交
5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150
    */
    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 已提交
5151 5152
    /// @}

N
Niels 已提交
5153 5154 5155 5156 5157

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

N
Niels 已提交
5158 5159 5160
    /// @name capacity
    /// @{

N
Niels 已提交
5161 5162
    /*!
    @brief checks whether the container is empty
N
Niels 已提交
5163 5164 5165

    Checks if a JSON value has no elements.

N
Niels 已提交
5166
    @return The return value depends on the different types and is
N
Niels 已提交
5167 5168 5169
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
5170 5171 5172 5173 5174 5175
            null        | `true`
            boolean     | `false`
            string      | `false`
            number      | `false`
            object      | result of function `object_t::empty()`
            array       | result of function `array_t::empty()`
N
Niels 已提交
5176

N
Niels 已提交
5177 5178 5179 5180
    @note This function does not return whether a string stored as JSON value
    is empty - it returns whether the JSON container itself is empty which is
    false in the case of a string.

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

N
Niels 已提交
5185 5186 5187
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
5188 5189 5190
    - The complexity is constant.
    - Has the semantics of `begin() == end()`.

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

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

N
Niels 已提交
5196
    @since version 1.0.0
N
Niels 已提交
5197
    */
N
Niels 已提交
5198
    bool empty() const noexcept
N
Niels 已提交
5199 5200 5201
    {
        switch (m_type)
        {
5202
            case value_t::null:
N
Niels 已提交
5203
            {
N
Niels 已提交
5204
                // null values are empty
N
Niels 已提交
5205 5206
                return true;
            }
N
Niels 已提交
5207

5208
            case value_t::array:
N
Niels 已提交
5209
            {
N
Niels 已提交
5210
                // delegate call to array_t::empty()
N
Niels 已提交
5211 5212
                return m_value.array->empty();
            }
N
Niels 已提交
5213

5214
            case value_t::object:
N
Niels 已提交
5215
            {
N
Niels 已提交
5216
                // delegate call to object_t::empty()
N
Niels 已提交
5217 5218
                return m_value.object->empty();
            }
N
Niels 已提交
5219

N
Niels 已提交
5220 5221 5222 5223 5224 5225
            default:
            {
                // all other types are nonempty
                return false;
            }
        }
N
Niels 已提交
5226 5227
    }

N
Niels 已提交
5228 5229
    /*!
    @brief returns the number of elements
N
Niels 已提交
5230 5231 5232

    Returns the number of elements in a JSON value.

N
Niels 已提交
5233
    @return The return value depends on the different types and is
N
Niels 已提交
5234 5235 5236
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
5237 5238 5239 5240
            null        | `0`
            boolean     | `1`
            string      | `1`
            number      | `1`
N
Niels 已提交
5241 5242 5243
            object      | result of function object_t::size()
            array       | result of function array_t::size()

N
Niels 已提交
5244 5245 5246 5247
    @note This function does not return the length of a string stored as JSON
    value - it returns the number of elements in the JSON value which is 1 in
    the case of a string.

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

N
Niels 已提交
5252 5253 5254
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
5255 5256 5257
    - The complexity is constant.
    - Has the semantics of `std::distance(begin(), end())`.

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

N
Niels 已提交
5261 5262 5263
    @sa @ref empty() -- checks whether the container is empty
    @sa @ref max_size() -- returns the maximal number of elements

N
Niels 已提交
5264
    @since version 1.0.0
N
Niels 已提交
5265
    */
N
Niels 已提交
5266
    size_type size() const noexcept
N
Niels 已提交
5267 5268 5269
    {
        switch (m_type)
        {
5270
            case value_t::null:
N
Niels 已提交
5271
            {
N
Niels 已提交
5272
                // null values are empty
N
Niels 已提交
5273 5274
                return 0;
            }
N
Niels 已提交
5275

5276
            case value_t::array:
N
Niels 已提交
5277
            {
N
Niels 已提交
5278
                // delegate call to array_t::size()
N
Niels 已提交
5279 5280
                return m_value.array->size();
            }
N
Niels 已提交
5281

5282
            case value_t::object:
N
Niels 已提交
5283
            {
N
Niels 已提交
5284
                // delegate call to object_t::size()
N
Niels 已提交
5285 5286
                return m_value.object->size();
            }
N
Niels 已提交
5287

N
Niels 已提交
5288 5289 5290 5291 5292 5293
            default:
            {
                // all other types have size 1
                return 1;
            }
        }
N
Niels 已提交
5294 5295
    }

N
Niels 已提交
5296 5297
    /*!
    @brief returns the maximum possible number of elements
N
Niels 已提交
5298 5299 5300 5301 5302

    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 已提交
5303
    @return The return value depends on the different types and is
N
Niels 已提交
5304 5305 5306
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
5307 5308 5309 5310 5311 5312
            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 已提交
5313

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

N
Niels 已提交
5318 5319 5320
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
5321 5322 5323 5324
    - The complexity is constant.
    - Has the semantics of returning `b.size()` where `b` is the largest
      possible JSON value.

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

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

N
Niels 已提交
5330
    @since version 1.0.0
N
Niels 已提交
5331
    */
N
Niels 已提交
5332
    size_type max_size() const noexcept
N
Niels 已提交
5333 5334 5335
    {
        switch (m_type)
        {
5336
            case value_t::array:
N
Niels 已提交
5337
            {
N
Niels 已提交
5338
                // delegate call to array_t::max_size()
N
Niels 已提交
5339 5340
                return m_value.array->max_size();
            }
N
Niels 已提交
5341

5342
            case value_t::object:
N
Niels 已提交
5343
            {
N
Niels 已提交
5344
                // delegate call to object_t::max_size()
N
Niels 已提交
5345 5346
                return m_value.object->max_size();
            }
N
Niels 已提交
5347

N
Niels 已提交
5348 5349
            default:
            {
5350 5351
                // all other types have max_size() == size()
                return size();
N
Niels 已提交
5352 5353
            }
        }
N
Niels 已提交
5354 5355
    }

N
Niels 已提交
5356 5357
    /// @}

N
Niels 已提交
5358 5359 5360 5361 5362

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

N
Niels 已提交
5363 5364 5365
    /// @name modifiers
    /// @{

N
Niels 已提交
5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382
    /*!
    @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       | `[]`

    @complexity Linear in the size of the JSON value.

N
Niels 已提交
5383
    @liveexample{The example below shows the effect of `clear()` to different
N
Niels 已提交
5384
    JSON types.,clear}
N
Niels 已提交
5385

N
Niels 已提交
5386
    @since version 1.0.0
N
Niels 已提交
5387
    */
N
Niels 已提交
5388
    void clear() noexcept
N
Niels 已提交
5389 5390 5391
    {
        switch (m_type)
        {
5392
            case value_t::number_integer:
N
Niels 已提交
5393
            {
N
Niels 已提交
5394
                m_value.number_integer = 0;
N
Niels 已提交
5395 5396
                break;
            }
N
Niels 已提交
5397

5398 5399 5400 5401 5402 5403
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = 0;
                break;
            }

5404
            case value_t::number_float:
N
Niels 已提交
5405
            {
N
Niels 已提交
5406
                m_value.number_float = 0.0;
N
Niels 已提交
5407 5408
                break;
            }
N
Niels 已提交
5409

5410
            case value_t::boolean:
N
Niels 已提交
5411
            {
N
Niels 已提交
5412
                m_value.boolean = false;
N
Niels 已提交
5413 5414
                break;
            }
N
Niels 已提交
5415

5416
            case value_t::string:
N
Niels 已提交
5417 5418 5419 5420
            {
                m_value.string->clear();
                break;
            }
N
Niels 已提交
5421

5422
            case value_t::array:
N
Niels 已提交
5423 5424 5425 5426
            {
                m_value.array->clear();
                break;
            }
N
Niels 已提交
5427

5428
            case value_t::object:
N
Niels 已提交
5429 5430 5431 5432
            {
                m_value.object->clear();
                break;
            }
5433 5434 5435 5436 5437

            default:
            {
                break;
            }
N
Niels 已提交
5438 5439 5440
        }
    }

5441 5442 5443
    /*!
    @brief add an object to an array

5444
    Appends the given element @a val to the end of the JSON value. If the
5445
    function is called on a JSON null value, an empty array is created before
5446
    appending @a val.
5447

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

5450
    @throw type_error.308 when called on a type other than JSON array or
N
Niels 已提交
5451
    null; example: `"cannot use push_back() with number"`
5452 5453 5454

    @complexity Amortized constant.

N
Niels 已提交
5455 5456 5457
    @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 已提交
5458

N
Niels 已提交
5459
    @since version 1.0.0
5460
    */
5461
    void push_back(basic_json&& val)
N
Niels 已提交
5462 5463
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
5464
        if (not(is_null() or is_array()))
N
Niels 已提交
5465
        {
5466
            JSON_THROW(type_error(308, "cannot use push_back() with " + type_name()));
N
Niels 已提交
5467 5468 5469
        }

        // transform null object into an array
N
cleanup  
Niels 已提交
5470
        if (is_null())
N
Niels 已提交
5471 5472
        {
            m_type = value_t::array;
N
Niels 已提交
5473
            m_value = value_t::array;
5474
            assert_invariant();
N
Niels 已提交
5475 5476 5477
        }

        // add element to array (move semantics)
5478
        m_value.array->push_back(std::move(val));
N
Niels 已提交
5479
        // invalidate object
5480
        val.m_type = value_t::null;
N
Niels 已提交
5481 5482
    }

5483 5484 5485 5486
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5487
    reference operator+=(basic_json&& val)
N
Niels 已提交
5488
    {
5489
        push_back(std::move(val));
N
Niels 已提交
5490 5491 5492
        return *this;
    }

5493 5494 5495 5496
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5497
    void push_back(const basic_json& val)
N
Niels 已提交
5498 5499
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
5500
        if (not(is_null() or is_array()))
N
Niels 已提交
5501
        {
5502
            JSON_THROW(type_error(308, "cannot use push_back() with " + type_name()));
N
Niels 已提交
5503 5504 5505
        }

        // transform null object into an array
N
cleanup  
Niels 已提交
5506
        if (is_null())
N
Niels 已提交
5507 5508
        {
            m_type = value_t::array;
N
Niels 已提交
5509
            m_value = value_t::array;
5510
            assert_invariant();
N
Niels 已提交
5511 5512 5513
        }

        // add element to array
5514
        m_value.array->push_back(val);
N
Niels 已提交
5515 5516
    }

5517 5518 5519 5520
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5521
    reference operator+=(const basic_json& val)
N
Niels 已提交
5522
    {
5523
        push_back(val);
N
Niels 已提交
5524 5525 5526
        return *this;
    }

5527 5528 5529
    /*!
    @brief add an object to an object

5530
    Inserts the given element @a val to the JSON object. If the function is
N
Niels 已提交
5531 5532
    called on a JSON null value, an empty object is created before inserting
    @a val.
5533

5534
    @param[in] val the value to add to the JSON object
5535

5536
    @throw type_error.308 when called on a type other than JSON object or
N
Niels 已提交
5537
    null; example: `"cannot use push_back() with number"`
5538 5539 5540

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

N
Niels 已提交
5541 5542 5543
    @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 已提交
5544

N
Niels 已提交
5545
    @since version 1.0.0
5546
    */
5547
    void push_back(const typename object_t::value_type& val)
N
Niels 已提交
5548 5549
    {
        // push_back only works for null objects or objects
N
cleanup  
Niels 已提交
5550
        if (not(is_null() or is_object()))
N
Niels 已提交
5551
        {
5552
            JSON_THROW(type_error(308, "cannot use push_back() with " + type_name()));
N
Niels 已提交
5553 5554 5555
        }

        // transform null object into an object
N
cleanup  
Niels 已提交
5556
        if (is_null())
N
Niels 已提交
5557 5558
        {
            m_type = value_t::object;
N
Niels 已提交
5559
            m_value = value_t::object;
5560
            assert_invariant();
N
Niels 已提交
5561 5562 5563
        }

        // add element to array
5564
        m_value.object->insert(val);
N
Niels 已提交
5565 5566
    }

5567 5568 5569 5570
    /*!
    @brief add an object to an object
    @copydoc push_back(const typename object_t::value_type&)
    */
5571
    reference operator+=(const typename object_t::value_type& val)
N
Niels 已提交
5572
    {
5573
        push_back(val);
N
Niels 已提交
5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622
        return *this;
    }

    /*!
    @brief add an object to an object

    This function allows to use `push_back` with an initializer list. In case

    1. the current value is an object,
    2. the initializer list @a init contains only two elements, and
    3. the first element of @a init is a string,

    @a init is converted into an object element and added using
    @ref push_back(const typename object_t::value_type&). Otherwise, @a init
    is converted to a JSON value and added using @ref push_back(basic_json&&).

    @param init  an initializer list

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

    @note This function is required to resolve an ambiguous overload error,
          because pairs like `{"key", "value"}` can be both interpreted as
          `object_t::value_type` or `std::initializer_list<basic_json>`, see
          https://github.com/nlohmann/json/issues/235 for more information.

    @liveexample{The example shows how initializer lists are treated as
    objects when possible.,push_back__initializer_list}
    */
    void push_back(std::initializer_list<basic_json> init)
    {
        if (is_object() and init.size() == 2 and init.begin()->is_string())
        {
            const string_t key = *init.begin();
            push_back(typename object_t::value_type(key, *(init.begin() + 1)));
        }
        else
        {
            push_back(basic_json(init));
        }
    }

    /*!
    @brief add an object to an object
    @copydoc push_back(std::initializer_list<basic_json>)
    */
    reference operator+=(std::initializer_list<basic_json> init)
    {
        push_back(init);
        return *this;
N
Niels 已提交
5623 5624
    }

N
Niels 已提交
5625 5626 5627 5628 5629 5630 5631 5632 5633 5634
    /*!
    @brief add an object to an array

    Creates a JSON value from the passed parameters @a args to the end of the
    JSON value. If the function is called on a JSON null value, an empty array
    is created before appending the value created from @a args.

    @param[in] args arguments to forward to a constructor of @ref basic_json
    @tparam Args compatible types to create a @ref basic_json object

5635
    @throw type_error.311 when called on a type other than JSON array or
N
Niels 已提交
5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651
    null; example: `"cannot use emplace_back() with number"`

    @complexity Amortized constant.

    @liveexample{The example shows how `push_back()` can be used to add
    elements to a JSON array. Note how the `null` value was silently converted
    to a JSON array.,emplace_back}

    @since version 2.0.8
    */
    template<class... Args>
    void emplace_back(Args&& ... args)
    {
        // emplace_back only works for null objects or arrays
        if (not(is_null() or is_array()))
        {
5652
            JSON_THROW(type_error(311, "cannot use emplace_back() with " + type_name()));
N
Niels 已提交
5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667
        }

        // transform null object into an array
        if (is_null())
        {
            m_type = value_t::array;
            m_value = value_t::array;
            assert_invariant();
        }

        // add element to array (perfect forwarding)
        m_value.array->emplace_back(std::forward<Args>(args)...);
    }

    /*!
5668
    @brief add an object to an object if key does not exist
N
Niels 已提交
5669

N
Niels Lohmann 已提交
5670 5671
    Inserts a new element into a JSON object constructed in-place with the
    given @a args if there is no element with the key in the container. If the
5672 5673
    function is called on a JSON null value, an empty object is created before
    appending the value created from @a args.
N
Niels 已提交
5674 5675 5676 5677

    @param[in] args arguments to forward to a constructor of @ref basic_json
    @tparam Args compatible types to create a @ref basic_json object

5678 5679 5680 5681
    @return a pair consisting of an iterator to the inserted element, or the
            already-existing element if no insertion happened, and a bool
            denoting whether the insertion took place.

5682
    @throw type_error.311 when called on a type other than JSON object or
N
Niels 已提交
5683 5684 5685 5686 5687 5688
    null; example: `"cannot use emplace() with number"`

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

    @liveexample{The example shows how `emplace()` can be used to add elements
    to a JSON object. Note how the `null` value was silently converted to a
5689 5690
    JSON object. Further note how no value is added if there was already one
    value stored with the same key.,emplace}
N
Niels 已提交
5691 5692 5693 5694

    @since version 2.0.8
    */
    template<class... Args>
5695
    std::pair<iterator, bool> emplace(Args&& ... args)
N
Niels 已提交
5696 5697 5698 5699
    {
        // emplace only works for null objects or arrays
        if (not(is_null() or is_object()))
        {
5700
            JSON_THROW(type_error(311, "cannot use emplace() with " + type_name()));
N
Niels 已提交
5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711
        }

        // transform null object into an object
        if (is_null())
        {
            m_type = value_t::object;
            m_value = value_t::object;
            assert_invariant();
        }

        // add element to array (perfect forwarding)
5712 5713 5714 5715 5716 5717 5718
        auto res = m_value.object->emplace(std::forward<Args>(args)...);
        // create result iterator and set iterator to the result of emplace
        auto it = begin();
        it.m_it.object_iterator = res.first;

        // return pair of iterator and boolean
        return {it, res.second};
N
Niels 已提交
5719 5720
    }

N
Niels 已提交
5721 5722 5723
    /*!
    @brief inserts element

5724
    Inserts element @a val before iterator @a pos.
N
Niels 已提交
5725 5726 5727

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

5731
    @throw type_error.309 if called on JSON values other than arrays;
N
Niels 已提交
5732
    example: `"cannot use insert() with string"`
5733 5734
    @throw invalid_iterator.202 if @a pos is not an iterator of *this;
    example: `"iterator does not fit current value"`
N
Niels 已提交
5735

N
Niels Lohmann 已提交
5736
    @complexity Constant plus linear in the distance between @a pos and end of
N
Niels Lohmann 已提交
5737
    the container.
N
Niels 已提交
5738

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

N
Niels 已提交
5741
    @since version 1.0.0
N
Niels 已提交
5742
    */
5743
    iterator insert(const_iterator pos, const basic_json& val)
N
Niels 已提交
5744 5745
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5746
        if (is_array())
N
Niels 已提交
5747
        {
N
cleanup  
Niels 已提交
5748 5749 5750
            // check if iterator pos fits to this JSON value
            if (pos.m_object != this)
            {
5751
                JSON_THROW(invalid_iterator(202, "iterator does not fit current value"));
N
cleanup  
Niels 已提交
5752
            }
N
Niels 已提交
5753

N
cleanup  
Niels 已提交
5754 5755
            // insert to array and return iterator
            iterator result(this);
5756
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, val);
N
cleanup  
Niels 已提交
5757 5758
            return result;
        }
N
Niels Lohmann 已提交
5759

5760
        JSON_THROW(type_error(309, "cannot use insert() with " + type_name()));
N
Niels 已提交
5761 5762 5763 5764 5765 5766
    }

    /*!
    @brief inserts element
    @copydoc insert(const_iterator, const basic_json&)
    */
5767
    iterator insert(const_iterator pos, basic_json&& val)
N
Niels 已提交
5768
    {
5769
        return insert(pos, val);
N
Niels 已提交
5770 5771 5772 5773 5774
    }

    /*!
    @brief inserts elements

5775
    Inserts @a cnt copies of @a val before iterator @a pos.
N
Niels 已提交
5776 5777 5778

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

5784 5785
    @throw type_error.309 if called on JSON values other than arrays; example:
    `"cannot use insert() with string"`
5786 5787
    @throw invalid_iterator.202 if @a pos is not an iterator of *this;
    example: `"iterator does not fit current value"`
N
Niels 已提交
5788

5789
    @complexity Linear in @a cnt plus linear in the distance between @a pos
N
Niels 已提交
5790 5791
    and end of the container.

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

N
Niels 已提交
5794
    @since version 1.0.0
N
Niels 已提交
5795
    */
5796
    iterator insert(const_iterator pos, size_type cnt, const basic_json& val)
N
Niels 已提交
5797 5798
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5799
        if (is_array())
N
Niels 已提交
5800
        {
N
cleanup  
Niels 已提交
5801 5802 5803
            // check if iterator pos fits to this JSON value
            if (pos.m_object != this)
            {
5804
                JSON_THROW(invalid_iterator(202, "iterator does not fit current value"));
N
cleanup  
Niels 已提交
5805
            }
N
Niels 已提交
5806

N
cleanup  
Niels 已提交
5807 5808
            // insert to array and return iterator
            iterator result(this);
5809
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, cnt, val);
N
cleanup  
Niels 已提交
5810 5811
            return result;
        }
N
Niels Lohmann 已提交
5812

5813
        JSON_THROW(type_error(309, "cannot use insert() with " + type_name()));
N
Niels 已提交
5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825
    }

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

5826 5827
    @throw type_error.309 if called on JSON values other than arrays; example:
    `"cannot use insert() with string"`
5828 5829
    @throw invalid_iterator.202 if @a pos is not an iterator of *this;
    example: `"iterator does not fit current value"`
5830 5831 5832
    @throw invalid_iterator.210 if @a first and @a last do not belong to the
    same JSON value; example: `"iterators do not fit"`
    @throw invalid_iterator.211 if @a first or @a last are iterators into
N
Niels 已提交
5833 5834 5835
    container for which insert is called; example: `"passed iterators may not
    belong to container"`

N
Niels 已提交
5836 5837 5838 5839 5840 5841
    @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 已提交
5842
    @liveexample{The example shows how `insert()` is used.,insert__range}
N
Niels 已提交
5843

N
Niels 已提交
5844
    @since version 1.0.0
N
Niels 已提交
5845 5846 5847 5848
    */
    iterator insert(const_iterator pos, const_iterator first, const_iterator last)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5849
        if (not is_array())
N
Niels 已提交
5850
        {
5851
            JSON_THROW(type_error(309, "cannot use insert() with " + type_name()));
N
Niels 已提交
5852 5853 5854 5855 5856
        }

        // check if iterator pos fits to this JSON value
        if (pos.m_object != this)
        {
5857
            JSON_THROW(invalid_iterator(202, "iterator does not fit current value"));
N
Niels 已提交
5858 5859
        }

N
Niels 已提交
5860
        // check if range iterators belong to the same JSON object
N
Niels 已提交
5861 5862
        if (first.m_object != last.m_object)
        {
5863
            JSON_THROW(invalid_iterator(210, "iterators do not fit"));
N
Niels 已提交
5864 5865 5866 5867
        }

        if (first.m_object == this or last.m_object == this)
        {
5868
            JSON_THROW(invalid_iterator(211, "passed iterators may not belong to container"));
N
Niels 已提交
5869 5870 5871 5872
        }

        // insert to array and return iterator
        iterator result(this);
N
Niels 已提交
5873
        result.m_it.array_iterator = m_value.array->insert(
T
Théo DELRIEU 已提交
5874 5875 5876
                                         pos.m_it.array_iterator,
                                         first.m_it.array_iterator,
                                         last.m_it.array_iterator);
N
Niels 已提交
5877 5878 5879
        return result;
    }

N
Niels 已提交
5880 5881 5882 5883 5884 5885 5886 5887 5888
    /*!
    @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

5889 5890
    @throw type_error.309 if called on JSON values other than arrays; example:
    `"cannot use insert() with string"`
5891 5892
    @throw invalid_iterator.202 if @a pos is not an iterator of *this;
    example: `"iterator does not fit current value"`
N
Niels 已提交
5893

N
Niels 已提交
5894 5895 5896
    @return iterator pointing to the first element inserted, or @a pos if
    `ilist` is empty

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

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

N
Niels 已提交
5902
    @since version 1.0.0
N
Niels 已提交
5903 5904 5905 5906
    */
    iterator insert(const_iterator pos, std::initializer_list<basic_json> ilist)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5907
        if (not is_array())
N
Niels 已提交
5908
        {
5909
            JSON_THROW(type_error(309, "cannot use insert() with " + type_name()));
N
Niels 已提交
5910 5911 5912 5913 5914
        }

        // check if iterator pos fits to this JSON value
        if (pos.m_object != this)
        {
5915
            JSON_THROW(invalid_iterator(202, "iterator does not fit current value"));
N
Niels 已提交
5916 5917 5918 5919 5920 5921 5922 5923
        }

        // insert to array and return iterator
        iterator result(this);
        result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, ilist);
        return result;
    }

N
Niels 已提交
5924 5925
    /*!
    @brief exchanges the values
N
Niels 已提交
5926 5927 5928 5929 5930 5931 5932 5933 5934 5935

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

N
Niels 已提交
5939
    @since version 1.0.0
N
Niels 已提交
5940
    */
N
Niels 已提交
5941
    void swap(reference other) noexcept (
N
Niels 已提交
5942 5943 5944 5945
        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
T
Théo DELRIEU 已提交
5946
    )
N
Niels 已提交
5947 5948 5949
    {
        std::swap(m_type, other.m_type);
        std::swap(m_value, other.m_value);
5950
        assert_invariant();
N
Niels 已提交
5951 5952
    }

N
Niels 已提交
5953 5954 5955 5956 5957 5958 5959 5960 5961 5962
    /*!
    @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

5963 5964
    @throw type_error.310 when JSON value is not an array; example: `"cannot
    use swap() with string"`
N
Niels 已提交
5965 5966 5967

    @complexity Constant.

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

N
Niels 已提交
5971
    @since version 1.0.0
N
Niels 已提交
5972
    */
N
Niels 已提交
5973
    void swap(array_t& other)
N
Niels 已提交
5974 5975
    {
        // swap only works for arrays
N
cleanup  
Niels 已提交
5976 5977 5978 5979 5980
        if (is_array())
        {
            std::swap(*(m_value.array), other);
        }
        else
N
Niels 已提交
5981
        {
5982
            JSON_THROW(type_error(310, "cannot use swap() with " + type_name()));
N
Niels 已提交
5983 5984 5985
        }
    }

5986 5987 5988 5989 5990 5991 5992 5993 5994 5995
    /*!
    @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

5996
    @throw type_error.310 when JSON value is not an object; example:
N
Niels 已提交
5997
    `"cannot use swap() with string"`
5998 5999 6000

    @complexity Constant.

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

N
Niels 已提交
6004
    @since version 1.0.0
6005
    */
N
Niels 已提交
6006
    void swap(object_t& other)
N
Niels 已提交
6007 6008
    {
        // swap only works for objects
N
cleanup  
Niels 已提交
6009 6010 6011 6012 6013
        if (is_object())
        {
            std::swap(*(m_value.object), other);
        }
        else
N
Niels 已提交
6014
        {
6015
            JSON_THROW(type_error(310, "cannot use swap() with " + type_name()));
N
Niels 已提交
6016 6017 6018
        }
    }

6019 6020 6021 6022 6023 6024 6025 6026 6027 6028
    /*!
    @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

6029
    @throw type_error.310 when JSON value is not a string; example: `"cannot
N
Niels 已提交
6030
    use swap() with boolean"`
6031 6032 6033

    @complexity Constant.

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

N
Niels 已提交
6037
    @since version 1.0.0
6038
    */
N
Niels 已提交
6039
    void swap(string_t& other)
N
Niels 已提交
6040 6041
    {
        // swap only works for strings
N
cleanup  
Niels 已提交
6042 6043 6044 6045 6046
        if (is_string())
        {
            std::swap(*(m_value.string), other);
        }
        else
N
Niels 已提交
6047
        {
6048
            JSON_THROW(type_error(310, "cannot use swap() with " + type_name()));
N
Niels 已提交
6049 6050 6051
        }
    }

N
Niels 已提交
6052 6053
    /// @}

N
Niels 已提交
6054
  public:
6055 6056 6057 6058 6059 6060 6061
    //////////////////////////////////////////
    // lexicographical comparison operators //
    //////////////////////////////////////////

    /// @name lexicographical comparison operators
    /// @{

N
Niels 已提交
6062 6063
    /*!
    @brief comparison: equal
N
Niels 已提交
6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079

    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.

6080 6081
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__equal}
N
Niels 已提交
6082

N
Niels 已提交
6083
    @since version 1.0.0
N
Niels 已提交
6084
    */
N
Niels 已提交
6085
    friend bool operator==(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6086
    {
F
Florian Weber 已提交
6087 6088
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
6089

F
Florian Weber 已提交
6090
        if (lhs_type == rhs_type)
N
Niels 已提交
6091
        {
F
Florian Weber 已提交
6092
            switch (lhs_type)
N
Niels 已提交
6093
            {
6094
                case value_t::array:
N
Niels 已提交
6095
                {
N
Niels 已提交
6096
                    return *lhs.m_value.array == *rhs.m_value.array;
N
Niels 已提交
6097
                }
6098
                case value_t::object:
N
Niels 已提交
6099
                {
N
Niels 已提交
6100
                    return *lhs.m_value.object == *rhs.m_value.object;
N
Niels 已提交
6101
                }
6102
                case value_t::null:
N
Niels 已提交
6103
                {
N
Niels 已提交
6104
                    return true;
N
Niels 已提交
6105
                }
6106
                case value_t::string:
N
Niels 已提交
6107
                {
N
Niels 已提交
6108
                    return *lhs.m_value.string == *rhs.m_value.string;
N
Niels 已提交
6109
                }
6110
                case value_t::boolean:
N
Niels 已提交
6111
                {
N
Niels 已提交
6112
                    return lhs.m_value.boolean == rhs.m_value.boolean;
N
Niels 已提交
6113
                }
6114
                case value_t::number_integer:
N
Niels 已提交
6115
                {
N
Niels 已提交
6116
                    return lhs.m_value.number_integer == rhs.m_value.number_integer;
N
Niels 已提交
6117
                }
6118 6119 6120 6121
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned == rhs.m_value.number_unsigned;
                }
6122
                case value_t::number_float:
N
Niels 已提交
6123
                {
6124
                    return lhs.m_value.number_float == rhs.m_value.number_float;
N
Niels 已提交
6125
                }
6126
                default:
N
Niels 已提交
6127
                {
N
Niels 已提交
6128
                    return false;
N
Niels 已提交
6129
                }
N
Niels 已提交
6130 6131
            }
        }
F
Florian Weber 已提交
6132 6133
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
N
Niels 已提交
6134
            return static_cast<number_float_t>(lhs.m_value.number_integer) == rhs.m_value.number_float;
F
Florian Weber 已提交
6135 6136 6137
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
6138
            return lhs.m_value.number_float == static_cast<number_float_t>(rhs.m_value.number_integer);
F
Florian Weber 已提交
6139
        }
6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154
        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 已提交
6155
        }
6156

N
Niels 已提交
6157 6158 6159
        return false;
    }

N
Niels 已提交
6160 6161
    /*!
    @brief comparison: equal
M
Mihai STAN 已提交
6162
    @copydoc operator==(const_reference, const_reference)
N
Niels 已提交
6163
    */
M
Mihai STAN 已提交
6164
    template<typename ScalarType, typename std::enable_if<
6165 6166
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator==(const_reference lhs, const ScalarType rhs) noexcept
N
Niels 已提交
6167
    {
M
Mihai STAN 已提交
6168
        return (lhs == basic_json(rhs));
N
Niels 已提交
6169 6170 6171 6172
    }

    /*!
    @brief comparison: equal
M
Mihai STAN 已提交
6173
    @copydoc operator==(const_reference, const_reference)
N
Niels 已提交
6174
    */
M
Mihai STAN 已提交
6175
    template<typename ScalarType, typename std::enable_if<
6176 6177
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator==(const ScalarType lhs, const_reference rhs) noexcept
N
Niels 已提交
6178
    {
M
Mihai STAN 已提交
6179
        return (basic_json(lhs) == rhs);
N
Niels 已提交
6180 6181
    }

N
Niels 已提交
6182 6183
    /*!
    @brief comparison: not equal
N
Niels 已提交
6184 6185 6186 6187 6188 6189 6190 6191 6192

    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.

6193 6194
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__notequal}
N
Niels 已提交
6195

N
Niels 已提交
6196
    @since version 1.0.0
N
Niels 已提交
6197
    */
N
Niels 已提交
6198
    friend bool operator!=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6199 6200 6201 6202
    {
        return not (lhs == rhs);
    }

N
Niels 已提交
6203 6204
    /*!
    @brief comparison: not equal
M
Mihai STAN 已提交
6205
    @copydoc operator!=(const_reference, const_reference)
N
Niels 已提交
6206
    */
M
Mihai STAN 已提交
6207 6208 6209
    template<typename ScalarType, typename std::enable_if<
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator!=(const_reference lhs, const ScalarType rhs) noexcept
N
Niels 已提交
6210
    {
M
Mihai STAN 已提交
6211
        return (lhs != basic_json(rhs));
N
Niels 已提交
6212 6213 6214 6215
    }

    /*!
    @brief comparison: not equal
M
Mihai STAN 已提交
6216
    @copydoc operator!=(const_reference, const_reference)
N
Niels 已提交
6217
    */
M
Mihai STAN 已提交
6218 6219 6220
    template<typename ScalarType, typename std::enable_if<
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator!=(const ScalarType lhs, const_reference rhs) noexcept
N
Niels 已提交
6221
    {
M
Mihai STAN 已提交
6222
        return (basic_json(lhs) != rhs);
N
Niels 已提交
6223 6224
    }

N
Niels 已提交
6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243
    /*!
    @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.

6244 6245
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__less}
N
Niels 已提交
6246

N
Niels 已提交
6247
    @since version 1.0.0
N
Niels 已提交
6248
    */
N
Niels 已提交
6249
    friend bool operator<(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6250
    {
F
Florian Weber 已提交
6251 6252
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
6253

F
Florian Weber 已提交
6254
        if (lhs_type == rhs_type)
N
Niels 已提交
6255
        {
F
Florian Weber 已提交
6256
            switch (lhs_type)
N
Niels 已提交
6257
            {
6258
                case value_t::array:
N
Niels 已提交
6259
                {
N
Niels 已提交
6260
                    return *lhs.m_value.array < *rhs.m_value.array;
N
Niels 已提交
6261
                }
6262
                case value_t::object:
N
Niels 已提交
6263
                {
N
Niels 已提交
6264
                    return *lhs.m_value.object < *rhs.m_value.object;
N
Niels 已提交
6265
                }
6266
                case value_t::null:
N
Niels 已提交
6267
                {
N
Niels 已提交
6268
                    return false;
N
Niels 已提交
6269
                }
6270
                case value_t::string:
N
Niels 已提交
6271
                {
N
Niels 已提交
6272
                    return *lhs.m_value.string < *rhs.m_value.string;
N
Niels 已提交
6273
                }
6274
                case value_t::boolean:
N
Niels 已提交
6275
                {
N
Niels 已提交
6276
                    return lhs.m_value.boolean < rhs.m_value.boolean;
N
Niels 已提交
6277
                }
6278
                case value_t::number_integer:
N
Niels 已提交
6279
                {
N
Niels 已提交
6280
                    return lhs.m_value.number_integer < rhs.m_value.number_integer;
N
Niels 已提交
6281
                }
6282 6283 6284 6285
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned < rhs.m_value.number_unsigned;
                }
6286
                case value_t::number_float:
N
Niels 已提交
6287
                {
N
Niels 已提交
6288
                    return lhs.m_value.number_float < rhs.m_value.number_float;
N
Niels 已提交
6289
                }
6290
                default:
N
Niels 已提交
6291
                {
N
Niels 已提交
6292
                    return false;
N
Niels 已提交
6293
                }
N
Niels 已提交
6294 6295
            }
        }
F
Florian Weber 已提交
6296 6297
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
6298
            return static_cast<number_float_t>(lhs.m_value.number_integer) < rhs.m_value.number_float;
F
Florian Weber 已提交
6299 6300 6301
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318
            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 已提交
6319
        }
N
Niels 已提交
6320

N
Niels 已提交
6321
        // We only reach this line if we cannot compare values. In that case,
N
Niels 已提交
6322 6323 6324
        // we compare types. Note we have to call the operator explicitly,
        // because MSVC has problems otherwise.
        return operator<(lhs_type, rhs_type);
N
Niels 已提交
6325 6326
    }

N
Niels 已提交
6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338
    /*!
    @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.

6339 6340
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greater}
N
Niels 已提交
6341

N
Niels 已提交
6342
    @since version 1.0.0
N
Niels 已提交
6343
    */
N
Niels 已提交
6344
    friend bool operator<=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6345 6346 6347 6348
    {
        return not (rhs < lhs);
    }

N
Niels 已提交
6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360
    /*!
    @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.

6361 6362
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__lessequal}
N
Niels 已提交
6363

N
Niels 已提交
6364
    @since version 1.0.0
N
Niels 已提交
6365
    */
N
Niels 已提交
6366
    friend bool operator>(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6367 6368 6369 6370
    {
        return not (lhs <= rhs);
    }

N
Niels 已提交
6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382
    /*!
    @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.

6383 6384
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greaterequal}
N
Niels 已提交
6385

N
Niels 已提交
6386
    @since version 1.0.0
N
Niels 已提交
6387
    */
N
Niels 已提交
6388
    friend bool operator>=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6389 6390 6391 6392
    {
        return not (lhs < rhs);
    }

N
Niels 已提交
6393 6394
    /// @}

N
Niels 已提交
6395 6396 6397 6398 6399

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

N
Niels 已提交
6400 6401 6402
    /// @name serialization
    /// @{

6403
  private:
6404 6405 6406
    /*!
    @brief wrapper around the serialization functions
    */
6407 6408
    class serializer
    {
T
Ted Lyngmo 已提交
6409 6410 6411 6412
      private:
        serializer(const serializer&) = delete;
        serializer& operator=(const serializer&) = delete;

6413
      public:
N
Niels Lohmann 已提交
6414 6415 6416
        /*!
        @param[in] s  output stream to serialize to
        */
6417
        serializer(std::ostream& s)
6418 6419 6420
            : o(s), loc(std::localeconv()),
              thousands_sep(!loc->thousands_sep ? '\0' : loc->thousands_sep[0]),
              decimal_point(!loc->decimal_point ? '\0' : loc->decimal_point[0])
6421 6422 6423 6424 6425
        {}

        /*!
        @brief internal implementation of the serialization function

N
Niels Lohmann 已提交
6426 6427 6428 6429
        This function is called by the public member function dump and
        organizes the serialization internally. The indentation level is
        propagated as additional parameter. In case of arrays and objects, the
        function is called recursively.
6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442

        - 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

        @param[in] val             value to serialize
        @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)
        */
        void dump(const basic_json& val,
                  const bool pretty_print,
                  const unsigned int indent_step,
6443
                  const unsigned int current_indent = 0)
6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460
        {
            switch (val.m_type)
            {
                case value_t::object:
                {
                    if (val.m_value.object->empty())
                    {
                        o.write("{}", 2);
                        return;
                    }

                    if (pretty_print)
                    {
                        o.write("{\n", 2);

                        // variable to hold indentation for recursive calls
                        const auto new_indent = current_indent + indent_step;
6461 6462 6463 6464
                        if (indent_string.size() < new_indent)
                        {
                            indent_string.resize(new_indent, ' ');
                        }
6465 6466 6467 6468 6469 6470 6471

                        // first n-1 elements
                        auto i = val.m_value.object->cbegin();
                        for (size_t cnt = 0; cnt < val.m_value.object->size() - 1; ++cnt, ++i)
                        {
                            o.write(indent_string.c_str(), new_indent);
                            o.put('\"');
6472
                            dump_escaped(i->first);
6473 6474 6475 6476 6477 6478 6479 6480 6481
                            o.write("\": ", 3);
                            dump(i->second, true, indent_step, new_indent);
                            o.write(",\n", 2);
                        }

                        // last element
                        assert(i != val.m_value.object->cend());
                        o.write(indent_string.c_str(), new_indent);
                        o.put('\"');
6482
                        dump_escaped(i->first);
6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498
                        o.write("\": ", 3);
                        dump(i->second, true, indent_step, new_indent);

                        o.put('\n');
                        o.write(indent_string.c_str(), current_indent);
                        o.put('}');
                    }
                    else
                    {
                        o.put('{');

                        // first n-1 elements
                        auto i = val.m_value.object->cbegin();
                        for (size_t cnt = 0; cnt < val.m_value.object->size() - 1; ++cnt, ++i)
                        {
                            o.put('\"');
6499
                            dump_escaped(i->first);
6500 6501 6502 6503 6504 6505 6506 6507
                            o.write("\":", 2);
                            dump(i->second, false, indent_step, current_indent);
                            o.put(',');
                        }

                        // last element
                        assert(i != val.m_value.object->cend());
                        o.put('\"');
6508
                        dump_escaped(i->first);
6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531
                        o.write("\":", 2);
                        dump(i->second, false, indent_step, current_indent);

                        o.put('}');
                    }

                    return;
                }

                case value_t::array:
                {
                    if (val.m_value.array->empty())
                    {
                        o.write("[]", 2);
                        return;
                    }

                    if (pretty_print)
                    {
                        o.write("[\n", 2);

                        // variable to hold indentation for recursive calls
                        const auto new_indent = current_indent + indent_step;
6532 6533 6534 6535
                        if (indent_string.size() < new_indent)
                        {
                            indent_string.resize(new_indent, ' ');
                        }
6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577

                        // first n-1 elements
                        for (auto i = val.m_value.array->cbegin(); i != val.m_value.array->cend() - 1; ++i)
                        {
                            o.write(indent_string.c_str(), new_indent);
                            dump(*i, true, indent_step, new_indent);
                            o.write(",\n", 2);
                        }

                        // last element
                        assert(not val.m_value.array->empty());
                        o.write(indent_string.c_str(), new_indent);
                        dump(val.m_value.array->back(), true, indent_step, new_indent);

                        o.put('\n');
                        o.write(indent_string.c_str(), current_indent);
                        o.put(']');
                    }
                    else
                    {
                        o.put('[');

                        // first n-1 elements
                        for (auto i = val.m_value.array->cbegin(); i != val.m_value.array->cend() - 1; ++i)
                        {
                            dump(*i, false, indent_step, current_indent);
                            o.put(',');
                        }

                        // last element
                        assert(not val.m_value.array->empty());
                        dump(val.m_value.array->back(), false, indent_step, current_indent);

                        o.put(']');
                    }

                    return;
                }

                case value_t::string:
                {
                    o.put('\"');
6578
                    dump_escaped(*val.m_value.string);
6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597
                    o.put('\"');
                    return;
                }

                case value_t::boolean:
                {
                    if (val.m_value.boolean)
                    {
                        o.write("true", 4);
                    }
                    else
                    {
                        o.write("false", 5);
                    }
                    return;
                }

                case value_t::number_integer:
                {
6598
                    dump_integer(val.m_value.number_integer);
6599 6600 6601 6602 6603
                    return;
                }

                case value_t::number_unsigned:
                {
6604
                    dump_integer(val.m_value.number_unsigned);
6605 6606 6607 6608 6609
                    return;
                }

                case value_t::number_float:
                {
6610
                    dump_float(val.m_value.number_float);
6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655
                    return;
                }

                case value_t::discarded:
                {
                    o.write("<discarded>", 11);
                    return;
                }

                case value_t::null:
                {
                    o.write("null", 4);
                    return;
                }
            }
        }

      private:
        /*!
        @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
        {
            return std::accumulate(s.begin(), s.end(), size_t{},
                                   [](size_t res, typename string_t::value_type c)
            {
                switch (c)
                {
                    case '"':
                    case '\\':
                    case '\b':
                    case '\f':
                    case '\n':
                    case '\r':
                    case '\t':
                    {
                        // from c (1 byte) to \x (2 bytes)
                        return res + 1;
                    }

6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682
                    case 0x00:
                    case 0x01:
                    case 0x02:
                    case 0x03:
                    case 0x04:
                    case 0x05:
                    case 0x06:
                    case 0x07:
                    case 0x0b:
                    case 0x0e:
                    case 0x0f:
                    case 0x10:
                    case 0x11:
                    case 0x12:
                    case 0x13:
                    case 0x14:
                    case 0x15:
                    case 0x16:
                    case 0x17:
                    case 0x18:
                    case 0x19:
                    case 0x1a:
                    case 0x1b:
                    case 0x1c:
                    case 0x1d:
                    case 0x1e:
                    case 0x1f:
6683
                    {
6684 6685 6686
                        // from c (1 byte) to \uxxxx (6 bytes)
                        return res + 5;
                    }
6687

6688 6689
                    default:
                    {
6690 6691 6692 6693 6694 6695 6696
                        return res;
                    }
                }
            });
        }

        /*!
N
Niels Lohmann 已提交
6697
        @brief dump escaped string
6698

N
Niels Lohmann 已提交
6699 6700 6701 6702
        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. The escaped string is written to output stream @a o.
6703 6704 6705 6706 6707

        @param[in] s  the string to escape

        @complexity Linear in the length of string @a s.
        */
6708
        void dump_escaped(const string_t& s) const
6709 6710 6711 6712
        {
            const auto space = extra_space(s);
            if (space == 0)
            {
6713 6714
                o.write(s.c_str(), static_cast<std::streamsize>(s.size()));
                return;
6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780
            }

            // create a result string of necessary size
            string_t result(s.size() + space, '\\');
            std::size_t pos = 0;

            for (const auto& c : s)
            {
                switch (c)
                {
                    // quotation mark (0x22)
                    case '"':
                    {
                        result[pos + 1] = '"';
                        pos += 2;
                        break;
                    }

                    // reverse solidus (0x5c)
                    case '\\':
                    {
                        // nothing to change
                        pos += 2;
                        break;
                    }

                    // backspace (0x08)
                    case '\b':
                    {
                        result[pos + 1] = 'b';
                        pos += 2;
                        break;
                    }

                    // formfeed (0x0c)
                    case '\f':
                    {
                        result[pos + 1] = 'f';
                        pos += 2;
                        break;
                    }

                    // newline (0x0a)
                    case '\n':
                    {
                        result[pos + 1] = 'n';
                        pos += 2;
                        break;
                    }

                    // carriage return (0x0d)
                    case '\r':
                    {
                        result[pos + 1] = 'r';
                        pos += 2;
                        break;
                    }

                    // horizontal tab (0x09)
                    case '\t':
                    {
                        result[pos + 1] = 't';
                        pos += 2;
                        break;
                    }

6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807
                    case 0x00:
                    case 0x01:
                    case 0x02:
                    case 0x03:
                    case 0x04:
                    case 0x05:
                    case 0x06:
                    case 0x07:
                    case 0x0b:
                    case 0x0e:
                    case 0x0f:
                    case 0x10:
                    case 0x11:
                    case 0x12:
                    case 0x13:
                    case 0x14:
                    case 0x15:
                    case 0x16:
                    case 0x17:
                    case 0x18:
                    case 0x19:
                    case 0x1a:
                    case 0x1b:
                    case 0x1c:
                    case 0x1d:
                    case 0x1e:
                    case 0x1f:
6808
                    {
6809 6810 6811
                        // convert a number 0..15 to its hex representation
                        // (0..f)
                        static const char hexify[16] =
6812
                        {
6813 6814 6815 6816 6817 6818 6819 6820
                            '0', '1', '2', '3', '4', '5', '6', '7',
                            '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'
                        };

                        // print character c as \uxxxx
                        for (const char m :
                    { 'u', '0', '0', hexify[c >> 4], hexify[c & 0x0f]
                        })
6821
                        {
6822
                            result[++pos] = m;
6823
                        }
6824 6825 6826 6827 6828 6829 6830 6831 6832

                        ++pos;
                        break;
                    }

                    default:
                    {
                        // all other characters are added as-is
                        result[pos++] = c;
6833 6834 6835 6836 6837
                        break;
                    }
                }
            }

6838 6839
            assert(pos == s.size() + space);
            o.write(result.c_str(), static_cast<std::streamsize>(result.size()));
6840 6841
        }

N
Niels Lohmann 已提交
6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853
        /*!
        @brief dump an integer

        Dump a given integer to output stream @a o. Works internally with
        @a number_buffer.

        @param[in] x  integer number (signed or unsigned) to dump
        @tparam NumberType either @a number_integer_t or @a number_unsigned_t
        */
        template<typename NumberType, detail::enable_if_t <
                     std::is_same<NumberType, number_unsigned_t>::value or
                     std::is_same<NumberType, number_integer_t>::value, int> = 0>
6854
        void dump_integer(NumberType x)
6855
        {
6856 6857
            // special case for "0"
            if (x == 0)
6858
            {
6859 6860
                o.put('0');
                return;
6861 6862
            }

6863 6864 6865 6866
            const bool is_negative = x < 0;
            size_t i = 0;

            // spare 1 byte for '\0'
N
Niels Lohmann 已提交
6867
            while (x != 0 and i < number_buffer.size() - 1)
6868
            {
6869
                const auto digit = std::labs(static_cast<long>(x % 10));
N
Niels Lohmann 已提交
6870
                number_buffer[i++] = static_cast<char>('0' + digit);
6871
                x /= 10;
6872 6873
            }

6874 6875
            // make sure the number has been processed completely
            assert(x == 0);
6876

6877
            if (is_negative)
6878
            {
6879
                // make sure there is capacity for the '-'
N
Niels Lohmann 已提交
6880 6881
                assert(i < number_buffer.size() - 2);
                number_buffer[i++] = '-';
6882
            }
6883

N
Niels Lohmann 已提交
6884 6885
            std::reverse(number_buffer.begin(), number_buffer.begin() + i);
            o.write(number_buffer.data(), static_cast<std::streamsize>(i));
6886
        }
6887

N
Niels Lohmann 已提交
6888 6889 6890 6891 6892 6893 6894 6895
        /*!
        @brief dump a floating-point number

        Dump a given floating-point number to output stream @a o. Works
        internally with @a number_buffer.

        @param[in] x  floating-point number to dump
        */
6896
        void dump_float(number_float_t x)
6897
        {
6898 6899 6900 6901 6902 6903 6904
            // NaN / inf
            if (not std::isfinite(x) or std::isnan(x))
            {
                o.write("null", 4);
                return;
            }

6905 6906 6907 6908
            // special case for 0.0 and -0.0
            if (x == 0)
            {
                if (std::signbit(x))
6909
                {
6910
                    o.write("-0.0", 4);
6911
                }
6912
                else
6913
                {
6914
                    o.write("0.0", 3);
6915
                }
6916
                return;
6917 6918
            }

6919 6920
            // get number of digits for a text -> float -> text round-trip
            static constexpr auto d = std::numeric_limits<number_float_t>::digits10;
6921

6922
            // the actual conversion
N
Niels Lohmann 已提交
6923 6924
            long len = snprintf(number_buffer.data(), number_buffer.size(),
                                "%.*g", d, x);
6925

6926
            // negative value indicates an error
N
Niels Lohmann 已提交
6927
            assert(len > 0);
6928
            // check if buffer was large enough
N
Niels Lohmann 已提交
6929
            assert(static_cast<size_t>(len) < number_buffer.size());
6930

6931 6932 6933
            // erase thousands separator
            if (thousands_sep != '\0')
            {
N
Niels Lohmann 已提交
6934 6935 6936 6937 6938 6939
                const auto end = std::remove(number_buffer.begin(),
                                             number_buffer.begin() + len,
                                             thousands_sep);
                std::fill(end, number_buffer.end(), '\0');
                assert((end - number_buffer.begin()) <= len);
                len = (end - number_buffer.begin());
6940
            }
6941

6942 6943 6944
            // convert decimal point to '.'
            if (decimal_point != '\0' and decimal_point != '.')
            {
N
Niels Lohmann 已提交
6945
                for (auto& c : number_buffer)
6946
                {
6947
                    if (c == decimal_point)
6948
                    {
6949 6950
                        c = '.';
                        break;
6951 6952
                    }
                }
6953
            }
6954

N
Niels Lohmann 已提交
6955 6956
            o.write(number_buffer.data(), static_cast<std::streamsize>(len));

6957
            // determine if need to append ".0"
N
Niels Lohmann 已提交
6958 6959 6960
            const bool value_is_int_like = std::none_of(number_buffer.begin(),
                                           number_buffer.begin() + len + 1,
                                           [](char c)
6961
            {
N
Niels Lohmann 已提交
6962 6963
                return c == '.' or c == 'e';
            });
6964

6965 6966 6967
            if (value_is_int_like)
            {
                o.write(".0", 2);
6968
            }
6969
        }
6970 6971

      private:
N
Niels Lohmann 已提交
6972
        /// the output of the serializer
6973
        std::ostream& o;
6974 6975

        /// a (hopefully) large enough character buffer
N
Niels Lohmann 已提交
6976
        std::array<char, 64> number_buffer{{}};
6977

N
Niels Lohmann 已提交
6978
        /// the locale
6979
        const std::lconv* loc = nullptr;
N
Niels Lohmann 已提交
6980
        /// the locale's thousand separator character
6981
        const char thousands_sep = '\0';
N
Niels Lohmann 已提交
6982
        /// the locale's decimal point character
6983 6984
        const char decimal_point = '\0';

N
Niels Lohmann 已提交
6985
        /// the indentation string
6986
        string_t indent_string = string_t(512, ' ');
6987 6988 6989
    };

  public:
N
Niels 已提交
6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006
    /*!
    @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 已提交
7007 7008
    @liveexample{The example below shows the serialization with different
    parameters to `width` to adjust the indentation level.,operator_serialize}
N
Niels 已提交
7009

N
Niels 已提交
7010
    @since version 1.0.0
N
Niels 已提交
7011
    */
N
Niels 已提交
7012 7013
    friend std::ostream& operator<<(std::ostream& o, const basic_json& j)
    {
N
Niels 已提交
7014
        // read width member and use it as indentation parameter if nonzero
N
Niels 已提交
7015 7016
        const bool pretty_print = (o.width() > 0);
        const auto indentation = (pretty_print ? o.width() : 0);
N
Niels 已提交
7017

N
Niels 已提交
7018 7019
        // reset width to 0 for subsequent calls to this stream
        o.width(0);
7020

N
Niels 已提交
7021
        // do the actual serialization
7022 7023
        serializer s(o);
        s.dump(j, pretty_print, static_cast<unsigned int>(indentation));
N
Niels 已提交
7024 7025 7026
        return o;
    }

N
Niels 已提交
7027 7028 7029 7030
    /*!
    @brief serialize to stream
    @copydoc operator<<(std::ostream&, const basic_json&)
    */
N
Niels 已提交
7031 7032
    friend std::ostream& operator>>(const basic_json& j, std::ostream& o)
    {
N
Niels 已提交
7033
        return o << j;
N
Niels 已提交
7034 7035
    }

N
Niels 已提交
7036 7037
    /// @}

N
Niels 已提交
7038 7039 7040 7041 7042

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

N
Niels 已提交
7043 7044 7045
    /// @name deserialization
    /// @{

N
Niels 已提交
7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061
    /*!
    @brief deserialize from an array

    This function reads from an array of 1-byte values.

    @pre Each element of the container has a size of 1 byte. Violating this
    precondition yields undefined behavior. **This precondition is enforced
    with a static assertion.**

    @param[in] array  array to read from
    @param[in] cb  a parser callback function of type @ref parser_callback_t
    which is used to control the deserialization by filtering unwanted values
    (optional)

    @return result of the deserialization

7062 7063
    @throw parse_error.101 if a parse error occurs; example: `""unexpected end
    of input; expected string literal""`
N
Niels Lohmann 已提交
7064 7065
    @throw parse_error.102 if to_unicode fails or surrogate error
    @throw parse_error.103 if to_unicode fails
7066

N
Niels 已提交
7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096
    @complexity Linear in the length of the input. The parser is a predictive
    LL(1) parser. The complexity can be higher if the parser callback function
    @a cb has a super-linear complexity.

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

    @liveexample{The example below demonstrates the `parse()` function reading
    from an array.,parse__array__parser_callback_t}

    @since version 2.0.3
    */
    template<class T, std::size_t N>
    static basic_json parse(T (&array)[N],
                            const parser_callback_t cb = nullptr)
    {
        // delegate the call to the iterator-range parse overload
        return parse(std::begin(array), std::end(array), cb);
    }

    /*!
    @brief deserialize from string literal

    @tparam CharT character/literal type with size of 1 byte
    @param[in] s  string literal to read a serialized JSON value from
    @param[in] cb a parser callback function of type @ref parser_callback_t
    which is used to control the deserialization by filtering unwanted values
    (optional)

    @return result of the deserialization

N
Niels Lohmann 已提交
7097 7098 7099 7100
    @throw parse_error.101 in case of an unexpected token
    @throw parse_error.102 if to_unicode fails or surrogate error
    @throw parse_error.103 if to_unicode fails

N
Niels 已提交
7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116
    @complexity Linear in the length of the input. The parser is a predictive
    LL(1) parser. The complexity can be higher if the parser callback function
    @a cb has a super-linear complexity.

    @note A UTF-8 byte order mark is silently ignored.
    @note String containers like `std::string` or @ref string_t can be parsed
          with @ref parse(const ContiguousContainer&, const parser_callback_t)

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

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

    @since version 1.0.0 (originally for @ref string_t)
    */
7117 7118 7119 7120 7121
    template<typename CharT, typename std::enable_if<
                 std::is_pointer<CharT>::value and
                 std::is_integral<typename std::remove_pointer<CharT>::type>::value and
                 sizeof(typename std::remove_pointer<CharT>::type) == 1, int>::type = 0>
    static basic_json parse(const CharT s,
N
Niels 已提交
7122 7123 7124 7125 7126
                            const parser_callback_t cb = nullptr)
    {
        return parser(reinterpret_cast<const char*>(s), cb).parse();
    }

N
Niels 已提交
7127 7128 7129 7130
    /*!
    @brief deserialize from stream

    @param[in,out] i  stream to read a serialized JSON value from
N
Niels 已提交
7131 7132 7133
    @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 已提交
7134 7135 7136

    @return result of the deserialization

N
Niels Lohmann 已提交
7137 7138 7139 7140 7141
    @throw parse_error.101 in case of an unexpected token
    @throw parse_error.102 if to_unicode fails or surrogate error
    @throw parse_error.103 if to_unicode fails
    @throw parse_error.111 if input stream is in a bad state

N
Niels 已提交
7142 7143 7144 7145
    @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 已提交
7146 7147
    @note A UTF-8 byte order mark is silently ignored.

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

7151
    @sa @ref parse(const CharT, const parser_callback_t) for a version
N
Niels 已提交
7152
    that reads from a string
N
Niels 已提交
7153

N
Niels 已提交
7154
    @since version 1.0.0
N
Niels 已提交
7155
    */
N
Niels 已提交
7156 7157
    static basic_json parse(std::istream& i,
                            const parser_callback_t cb = nullptr)
N
Niels 已提交
7158
    {
N
Niels 已提交
7159
        return parser(i, cb).parse();
N
Niels 已提交
7160 7161
    }

N
Niels 已提交
7162
    /*!
N
Niels 已提交
7163
    @copydoc parse(std::istream&, const parser_callback_t)
N
Niels 已提交
7164
    */
N
Niels 已提交
7165 7166
    static basic_json parse(std::istream&& i,
                            const parser_callback_t cb = nullptr)
N
Cleanup  
Niels 已提交
7167 7168 7169 7170
    {
        return parser(i, cb).parse();
    }

7171
    /*!
N
Niels 已提交
7172
    @brief deserialize from an iterator range with contiguous storage
7173

7174 7175
    This function reads from an iterator range of a container with contiguous
    storage of 1-byte values. Compatible container types include
7176 7177 7178 7179 7180 7181 7182 7183 7184
    `std::vector`, `std::string`, `std::array`, `std::valarray`, and
    `std::initializer_list`. Furthermore, C-style arrays can be used with
    `std::begin()`/`std::end()`. User-defined containers can be used as long
    as they implement random-access iterators and a contiguous storage.

    @pre The iterator range is contiguous. Violating this precondition yields
    undefined behavior. **This precondition is enforced with an assertion.**
    @pre Each element in the range has a size of 1 byte. Violating this
    precondition yields undefined behavior. **This precondition is enforced
7185
    with a static assertion.**
7186

N
Niels 已提交
7187 7188 7189 7190
    @warning There is no way to enforce all preconditions at compile-time. If
             the function is called with noncompliant iterators and with
             assertions switched off, the behavior is undefined and will most
             likely yield segmentation violation.
7191

N
Niels 已提交
7192
    @tparam IteratorType iterator of container with contiguous storage
N
Niels 已提交
7193 7194 7195
    @param[in] first  begin of the range to parse (included)
    @param[in] last  end of the range to parse (excluded)
    @param[in] cb  a parser callback function of type @ref parser_callback_t
7196 7197 7198 7199 7200
    which is used to control the deserialization by filtering unwanted values
    (optional)

    @return result of the deserialization

N
Niels Lohmann 已提交
7201 7202 7203 7204
    @throw parse_error.101 in case of an unexpected token
    @throw parse_error.102 if to_unicode fails or surrogate error
    @throw parse_error.103 if to_unicode fails

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

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

N
Niels 已提交
7211 7212
    @liveexample{The example below demonstrates the `parse()` function reading
    from an iterator range.,parse__iteratortype__parser_callback_t}
7213 7214 7215

    @since version 2.0.3
    */
N
Niels 已提交
7216 7217 7218 7219
    template<class IteratorType, typename std::enable_if<
                 std::is_base_of<
                     std::random_access_iterator_tag,
                     typename std::iterator_traits<IteratorType>::iterator_category>::value, int>::type = 0>
7220 7221 7222 7223 7224
    static basic_json parse(IteratorType first, IteratorType last,
                            const parser_callback_t cb = nullptr)
    {
        // assertion to check that the iterator range is indeed contiguous,
        // see http://stackoverflow.com/a/35008842/266378 for more discussion
N
Niels Lohmann 已提交
7225
        assert(std::accumulate(first, last, std::pair<bool, int>(true, 0),
7226 7227 7228 7229 7230 7231 7232
                               [&first](std::pair<bool, int> res, decltype(*first) val)
        {
            res.first &= (val == *(std::next(std::addressof(*first), res.second++)));
            return res;
        }).first);

        // assertion to check that each element is 1 byte long
7233 7234
        static_assert(sizeof(typename std::iterator_traits<IteratorType>::value_type) == 1,
                      "each element in the iterator range must have the size of 1 byte");
7235

7236 7237 7238 7239 7240 7241
        // if iterator range is empty, create a parser with an empty string
        // to generate "unexpected EOF" error message
        if (std::distance(first, last) <= 0)
        {
            return parser("").parse();
        }
7242 7243 7244 7245

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

N
Niels 已提交
7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266
    /*!
    @brief deserialize from a container with contiguous storage

    This function reads from a container with contiguous storage of 1-byte
    values. Compatible container types include `std::vector`, `std::string`,
    `std::array`, and `std::initializer_list`. User-defined containers can be
    used as long as they implement random-access iterators and a contiguous
    storage.

    @pre The container storage is contiguous. Violating this precondition
    yields undefined behavior. **This precondition is enforced with an
    assertion.**
    @pre Each element of the container has a size of 1 byte. Violating this
    precondition yields undefined behavior. **This precondition is enforced
    with a static assertion.**

    @warning There is no way to enforce all preconditions at compile-time. If
             the function is called with a noncompliant container and with
             assertions switched off, the behavior is undefined and will most
             likely yield segmentation violation.

N
Niels 已提交
7267
    @tparam ContiguousContainer container type with contiguous storage
N
Niels 已提交
7268 7269 7270 7271 7272 7273 7274
    @param[in] c  container to read from
    @param[in] cb  a parser callback function of type @ref parser_callback_t
    which is used to control the deserialization by filtering unwanted values
    (optional)

    @return result of the deserialization

N
Niels Lohmann 已提交
7275 7276 7277 7278
    @throw parse_error.101 in case of an unexpected token
    @throw parse_error.102 if to_unicode fails or surrogate error
    @throw parse_error.103 if to_unicode fails

N
Niels 已提交
7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289
    @complexity Linear in the length of the input. The parser is a predictive
    LL(1) parser. The complexity can be higher if the parser callback function
    @a cb has a super-linear complexity.

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

    @liveexample{The example below demonstrates the `parse()` function reading
    from a contiguous container.,parse__contiguouscontainer__parser_callback_t}

    @since version 2.0.3
    */
N
Niels 已提交
7290
    template<class ContiguousContainer, typename std::enable_if<
N
Niels 已提交
7291
                 not std::is_pointer<ContiguousContainer>::value and
7292 7293
                 std::is_base_of<
                     std::random_access_iterator_tag,
N
Niels 已提交
7294
                     typename std::iterator_traits<decltype(std::begin(std::declval<ContiguousContainer const>()))>::iterator_category>::value
7295 7296 7297 7298 7299 7300 7301 7302
                 , int>::type = 0>
    static basic_json parse(const ContiguousContainer& c,
                            const parser_callback_t cb = nullptr)
    {
        // delegate the call to the iterator-range parse overload
        return parse(std::begin(c), std::end(c), cb);
    }

N
Niels 已提交
7303 7304 7305 7306 7307 7308 7309 7310
    /*!
    @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

N
Niels Lohmann 已提交
7311 7312 7313 7314
    @throw parse_error.101 in case of an unexpected token
    @throw parse_error.102 if to_unicode fails or surrogate error
    @throw parse_error.103 if to_unicode fails
    @throw parse_error.111 if input stream is in a bad state
N
Niels 已提交
7315 7316 7317 7318

    @complexity Linear in the length of the input. The parser is a predictive
    LL(1) parser.

N
Niels 已提交
7319 7320
    @note A UTF-8 byte order mark is silently ignored.

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

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

N
Niels 已提交
7327
    @since version 1.0.0
N
Niels 已提交
7328 7329
    */
    friend std::istream& operator<<(basic_json& j, std::istream& i)
N
Niels 已提交
7330 7331 7332 7333 7334
    {
        j = parser(i).parse();
        return i;
    }

N
Niels 已提交
7335 7336 7337 7338 7339
    /*!
    @brief deserialize from stream
    @copydoc operator<<(basic_json&, std::istream&)
    */
    friend std::istream& operator>>(std::istream& i, basic_json& j)
N
Niels 已提交
7340 7341 7342 7343 7344
    {
        j = parser(i).parse();
        return i;
    }

N
Niels 已提交
7345 7346
    /// @}

N
Niels Lohmann 已提交
7347 7348 7349
    //////////////////////////////////////////
    // binary serialization/deserialization //
    //////////////////////////////////////////
N
Niels 已提交
7350

N
Niels Lohmann 已提交
7351
    /// @name binary serialization/deserialization support
N
Niels 已提交
7352 7353 7354
    /// @{

  private:
7355 7356 7357 7358 7359
    /*!
    @note Some code in the switch cases has been copied, because otherwise
          copilers would complain about implicit fallthrough and there is no
          portable attribute to mute such warnings.
    */
7360 7361 7362 7363 7364 7365 7366 7367 7368
    template<typename T>
    static void add_to_vector(std::vector<uint8_t>& vec, size_t bytes, const T number)
    {
        assert(bytes == 1 or bytes == 2 or bytes == 4 or bytes == 8);

        switch (bytes)
        {
            case 8:
            {
7369 7370 7371 7372
                vec.push_back(static_cast<uint8_t>((static_cast<uint64_t>(number) >> 070) & 0xff));
                vec.push_back(static_cast<uint8_t>((static_cast<uint64_t>(number) >> 060) & 0xff));
                vec.push_back(static_cast<uint8_t>((static_cast<uint64_t>(number) >> 050) & 0xff));
                vec.push_back(static_cast<uint8_t>((static_cast<uint64_t>(number) >> 040) & 0xff));
7373 7374 7375 7376 7377
                vec.push_back(static_cast<uint8_t>((number >> 030) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 020) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 010) & 0xff));
                vec.push_back(static_cast<uint8_t>(number & 0xff));
                break;
7378 7379 7380 7381 7382 7383
            }

            case 4:
            {
                vec.push_back(static_cast<uint8_t>((number >> 030) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 020) & 0xff));
7384 7385 7386
                vec.push_back(static_cast<uint8_t>((number >> 010) & 0xff));
                vec.push_back(static_cast<uint8_t>(number & 0xff));
                break;
7387 7388 7389 7390 7391
            }

            case 2:
            {
                vec.push_back(static_cast<uint8_t>((number >> 010) & 0xff));
7392 7393
                vec.push_back(static_cast<uint8_t>(number & 0xff));
                break;
7394 7395 7396 7397 7398 7399 7400 7401 7402 7403
            }

            case 1:
            {
                vec.push_back(static_cast<uint8_t>(number & 0xff));
                break;
            }
        }
    }

7404 7405 7406 7407 7408 7409 7410 7411
    /*!
    @brief take sufficient bytes from a vector to fill an integer variable

    In the context of binary serialization formats, we need to read several
    bytes from a byte vector and combine them to multi-byte integral data
    types.

    @param[in] vec  byte vector to read from
7412
    @param[in] current_index  the position in the vector after which to read
7413 7414 7415 7416 7417

    @return the next sizeof(T) bytes from @a vec, in reverse order as T

    @tparam T the integral return type

7418
    @throw parse_error.110 if there are less than sizeof(T)+1 bytes in the
7419 7420
           vector @a vec to read

7421 7422 7423 7424
    In the for loop, the bytes from the vector are copied in reverse order into
    the return value. In the figures below, let sizeof(T)=4 and `i` be the loop
    variable.

7425 7426
    Precondition:

7427 7428 7429
    vec:   |   |   | a | b | c | d |      T: |   |   |   |   |
                 ^               ^             ^                ^
           current_index         i            ptr        sizeof(T)
7430 7431 7432

    Postcondition:

7433 7434 7435
    vec:   |   |   | a | b | c | d |      T: | d | c | b | a |
                 ^   ^                                     ^
                 |   i                                    ptr
7436 7437
           current_index

7438
    @sa Code adapted from <http://stackoverflow.com/a/41031865/266378>.
7439 7440 7441
    */
    template<typename T>
    static T get_from_vector(const std::vector<uint8_t>& vec, const size_t current_index)
7442
    {
7443
        // check if we can read sizeof(T) bytes starting the next index
N
Niels Lohmann 已提交
7444
        check_length(vec.size(), sizeof(T), current_index + 1);
7445

7446
        T result;
N
Niels Lohmann 已提交
7447
        auto* ptr = reinterpret_cast<uint8_t*>(&result);
7448
        for (size_t i = 0; i < sizeof(T); ++i)
7449
        {
7450
            *ptr++ = vec[current_index + sizeof(T) - i];
7451 7452
        }
        return result;
7453 7454
    }

7455 7456 7457 7458 7459 7460 7461 7462 7463 7464
    /*!
    @brief create a MessagePack serialization of a given JSON value

    This is a straightforward implementation of the MessagePack specification.

    @param[in] j  JSON value to serialize
    @param[in,out] v  byte vector to write the serialization to

    @sa https://github.com/msgpack/msgpack/blob/master/spec.md
    */
N
Niels 已提交
7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484
    static void to_msgpack_internal(const basic_json& j, std::vector<uint8_t>& v)
    {
        switch (j.type())
        {
            case value_t::null:
            {
                // nil
                v.push_back(0xc0);
                break;
            }

            case value_t::boolean:
            {
                // true and false
                v.push_back(j.m_value.boolean ? 0xc3 : 0xc2);
                break;
            }

            case value_t::number_integer:
            {
7485
                if (j.m_value.number_integer >= 0)
N
Niels 已提交
7486
                {
7487
                    // MessagePack does not differentiate between positive
N
Niels Lohmann 已提交
7488 7489 7490
                    // signed integers and unsigned integers. Therefore, we
                    // used the code from the value_t::number_unsigned case
                    // here.
7491 7492 7493 7494 7495
                    if (j.m_value.number_unsigned < 128)
                    {
                        // positive fixnum
                        add_to_vector(v, 1, j.m_value.number_unsigned);
                    }
7496
                    else if (j.m_value.number_unsigned <= std::numeric_limits<uint8_t>::max())
7497 7498 7499 7500 7501
                    {
                        // uint 8
                        v.push_back(0xcc);
                        add_to_vector(v, 1, j.m_value.number_unsigned);
                    }
7502
                    else if (j.m_value.number_unsigned <= std::numeric_limits<uint16_t>::max())
7503 7504 7505 7506 7507
                    {
                        // uint 16
                        v.push_back(0xcd);
                        add_to_vector(v, 2, j.m_value.number_unsigned);
                    }
7508
                    else if (j.m_value.number_unsigned <= std::numeric_limits<uint32_t>::max())
7509 7510 7511 7512 7513
                    {
                        // uint 32
                        v.push_back(0xce);
                        add_to_vector(v, 4, j.m_value.number_unsigned);
                    }
7514
                    else if (j.m_value.number_unsigned <= std::numeric_limits<uint64_t>::max())
7515 7516 7517 7518 7519
                    {
                        // uint 64
                        v.push_back(0xcf);
                        add_to_vector(v, 8, j.m_value.number_unsigned);
                    }
N
Niels 已提交
7520
                }
7521
                else
N
Niels 已提交
7522
                {
7523 7524 7525 7526 7527
                    if (j.m_value.number_integer >= -32)
                    {
                        // negative fixnum
                        add_to_vector(v, 1, j.m_value.number_integer);
                    }
7528
                    else if (j.m_value.number_integer >= std::numeric_limits<int8_t>::min() and j.m_value.number_integer <= std::numeric_limits<int8_t>::max())
7529 7530 7531 7532 7533
                    {
                        // int 8
                        v.push_back(0xd0);
                        add_to_vector(v, 1, j.m_value.number_integer);
                    }
7534
                    else if (j.m_value.number_integer >= std::numeric_limits<int16_t>::min() and j.m_value.number_integer <= std::numeric_limits<int16_t>::max())
7535 7536 7537 7538 7539
                    {
                        // int 16
                        v.push_back(0xd1);
                        add_to_vector(v, 2, j.m_value.number_integer);
                    }
7540
                    else if (j.m_value.number_integer >= std::numeric_limits<int32_t>::min() and j.m_value.number_integer <= std::numeric_limits<int32_t>::max())
7541 7542 7543 7544 7545
                    {
                        // int 32
                        v.push_back(0xd2);
                        add_to_vector(v, 4, j.m_value.number_integer);
                    }
7546
                    else if (j.m_value.number_integer >= std::numeric_limits<int64_t>::min() and j.m_value.number_integer <= std::numeric_limits<int64_t>::max())
7547 7548 7549 7550 7551
                    {
                        // int 64
                        v.push_back(0xd3);
                        add_to_vector(v, 8, j.m_value.number_integer);
                    }
N
Niels 已提交
7552 7553 7554 7555 7556 7557 7558 7559 7560
                }
                break;
            }

            case value_t::number_unsigned:
            {
                if (j.m_value.number_unsigned < 128)
                {
                    // positive fixnum
7561
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels 已提交
7562
                }
7563
                else if (j.m_value.number_unsigned <= std::numeric_limits<uint8_t>::max())
N
Niels 已提交
7564 7565 7566
                {
                    // uint 8
                    v.push_back(0xcc);
7567
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels 已提交
7568
                }
7569
                else if (j.m_value.number_unsigned <= std::numeric_limits<uint16_t>::max())
N
Niels 已提交
7570 7571 7572
                {
                    // uint 16
                    v.push_back(0xcd);
7573
                    add_to_vector(v, 2, j.m_value.number_unsigned);
N
Niels 已提交
7574
                }
7575
                else if (j.m_value.number_unsigned <= std::numeric_limits<uint32_t>::max())
N
Niels 已提交
7576 7577 7578
                {
                    // uint 32
                    v.push_back(0xce);
7579
                    add_to_vector(v, 4, j.m_value.number_unsigned);
N
Niels 已提交
7580
                }
7581
                else if (j.m_value.number_unsigned <= std::numeric_limits<uint64_t>::max())
N
Niels 已提交
7582 7583 7584
                {
                    // uint 64
                    v.push_back(0xcf);
7585
                    add_to_vector(v, 8, j.m_value.number_unsigned);
N
Niels 已提交
7586 7587 7588 7589 7590 7591 7592 7593
                }
                break;
            }

            case value_t::number_float:
            {
                // float 64
                v.push_back(0xcb);
N
Niels Lohmann 已提交
7594
                const auto* helper = reinterpret_cast<const uint8_t*>(&(j.m_value.number_float));
N
Niels 已提交
7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613
                for (size_t i = 0; i < 8; ++i)
                {
                    v.push_back(helper[7 - i]);
                }
                break;
            }

            case value_t::string:
            {
                const auto N = j.m_value.string->size();
                if (N <= 31)
                {
                    // fixstr
                    v.push_back(static_cast<uint8_t>(0xa0 | N));
                }
                else if (N <= 255)
                {
                    // str 8
                    v.push_back(0xd9);
7614
                    add_to_vector(v, 1, N);
N
Niels 已提交
7615 7616 7617 7618 7619
                }
                else if (N <= 65535)
                {
                    // str 16
                    v.push_back(0xda);
7620
                    add_to_vector(v, 2, N);
N
Niels 已提交
7621 7622 7623 7624 7625
                }
                else if (N <= 4294967295)
                {
                    // str 32
                    v.push_back(0xdb);
7626
                    add_to_vector(v, 4, N);
N
Niels 已提交
7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646
                }

                // append string
                std::copy(j.m_value.string->begin(), j.m_value.string->end(),
                          std::back_inserter(v));
                break;
            }

            case value_t::array:
            {
                const auto N = j.m_value.array->size();
                if (N <= 15)
                {
                    // fixarray
                    v.push_back(static_cast<uint8_t>(0x90 | N));
                }
                else if (N <= 0xffff)
                {
                    // array 16
                    v.push_back(0xdc);
7647
                    add_to_vector(v, 2, N);
N
Niels 已提交
7648 7649 7650 7651 7652
                }
                else if (N <= 0xffffffff)
                {
                    // array 32
                    v.push_back(0xdd);
7653
                    add_to_vector(v, 4, N);
N
Niels 已提交
7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675
                }

                // append each element
                for (const auto& el : *j.m_value.array)
                {
                    to_msgpack_internal(el, v);
                }
                break;
            }

            case value_t::object:
            {
                const auto N = j.m_value.object->size();
                if (N <= 15)
                {
                    // fixmap
                    v.push_back(static_cast<uint8_t>(0x80 | (N & 0xf)));
                }
                else if (N <= 65535)
                {
                    // map 16
                    v.push_back(0xde);
7676
                    add_to_vector(v, 2, N);
N
Niels 已提交
7677 7678 7679 7680 7681
                }
                else if (N <= 4294967295)
                {
                    // map 32
                    v.push_back(0xdf);
7682
                    add_to_vector(v, 4, N);
N
Niels 已提交
7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700
                }

                // append each element
                for (const auto& el : *j.m_value.object)
                {
                    to_msgpack_internal(el.first, v);
                    to_msgpack_internal(el.second, v);
                }
                break;
            }

            default:
            {
                break;
            }
        }
    }

7701 7702 7703 7704 7705 7706 7707 7708 7709 7710
    /*!
    @brief create a CBOR serialization of a given JSON value

    This is a straightforward implementation of the CBOR specification.

    @param[in] j  JSON value to serialize
    @param[in,out] v  byte vector to write the serialization to

    @sa https://tools.ietf.org/html/rfc7049
    */
N
Niels Lohmann 已提交
7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733
    static void to_cbor_internal(const basic_json& j, std::vector<uint8_t>& v)
    {
        switch (j.type())
        {
            case value_t::null:
            {
                v.push_back(0xf6);
                break;
            }

            case value_t::boolean:
            {
                v.push_back(j.m_value.boolean ? 0xf5 : 0xf4);
                break;
            }

            case value_t::number_integer:
            {
                if (j.m_value.number_integer >= 0)
                {
                    // CBOR does not differentiate between positive signed
                    // integers and unsigned integers. Therefore, we used the
                    // code from the value_t::number_unsigned case here.
7734
                    if (j.m_value.number_integer <= 0x17)
N
Niels Lohmann 已提交
7735
                    {
7736
                        add_to_vector(v, 1, j.m_value.number_integer);
N
Niels Lohmann 已提交
7737
                    }
7738
                    else if (j.m_value.number_integer <= std::numeric_limits<uint8_t>::max())
N
Niels Lohmann 已提交
7739 7740 7741
                    {
                        v.push_back(0x18);
                        // one-byte uint8_t
7742
                        add_to_vector(v, 1, j.m_value.number_integer);
N
Niels Lohmann 已提交
7743
                    }
7744
                    else if (j.m_value.number_integer <= std::numeric_limits<uint16_t>::max())
N
Niels Lohmann 已提交
7745 7746 7747
                    {
                        v.push_back(0x19);
                        // two-byte uint16_t
7748
                        add_to_vector(v, 2, j.m_value.number_integer);
N
Niels Lohmann 已提交
7749
                    }
7750
                    else if (j.m_value.number_integer <= std::numeric_limits<uint32_t>::max())
N
Niels Lohmann 已提交
7751 7752 7753
                    {
                        v.push_back(0x1a);
                        // four-byte uint32_t
7754
                        add_to_vector(v, 4, j.m_value.number_integer);
N
Niels Lohmann 已提交
7755
                    }
7756
                    else
N
Niels Lohmann 已提交
7757
                    {
N
Niels Lohmann 已提交
7758
                        v.push_back(0x1b);
N
Niels Lohmann 已提交
7759
                        // eight-byte uint64_t
7760
                        add_to_vector(v, 8, j.m_value.number_integer);
N
Niels Lohmann 已提交
7761 7762 7763 7764
                    }
                }
                else
                {
N
Niels Lohmann 已提交
7765 7766
                    // The conversions below encode the sign in the first
                    // byte, and the value is converted to a positive number.
N
Niels Lohmann 已提交
7767
                    const auto positive_number = -1 - j.m_value.number_integer;
7768
                    if (j.m_value.number_integer >= -24)
N
Niels Lohmann 已提交
7769 7770 7771
                    {
                        v.push_back(static_cast<uint8_t>(0x20 + positive_number));
                    }
7772
                    else if (positive_number <= std::numeric_limits<uint8_t>::max())
N
Niels Lohmann 已提交
7773 7774 7775
                    {
                        // int 8
                        v.push_back(0x38);
7776
                        add_to_vector(v, 1, positive_number);
N
Niels Lohmann 已提交
7777
                    }
7778
                    else if (positive_number <= std::numeric_limits<uint16_t>::max())
N
Niels Lohmann 已提交
7779 7780 7781
                    {
                        // int 16
                        v.push_back(0x39);
7782
                        add_to_vector(v, 2, positive_number);
N
Niels Lohmann 已提交
7783
                    }
7784
                    else if (positive_number <= std::numeric_limits<uint32_t>::max())
N
Niels Lohmann 已提交
7785 7786 7787
                    {
                        // int 32
                        v.push_back(0x3a);
7788
                        add_to_vector(v, 4, positive_number);
N
Niels Lohmann 已提交
7789
                    }
7790
                    else
N
Niels Lohmann 已提交
7791 7792 7793
                    {
                        // int 64
                        v.push_back(0x3b);
7794
                        add_to_vector(v, 8, positive_number);
N
Niels Lohmann 已提交
7795 7796
                    }
                }
7797
                break;
N
Niels Lohmann 已提交
7798 7799 7800 7801
            }

            case value_t::number_unsigned:
            {
7802
                if (j.m_value.number_unsigned <= 0x17)
N
Niels Lohmann 已提交
7803 7804 7805 7806 7807 7808 7809
                {
                    v.push_back(static_cast<uint8_t>(j.m_value.number_unsigned));
                }
                else if (j.m_value.number_unsigned <= 0xff)
                {
                    v.push_back(0x18);
                    // one-byte uint8_t
7810
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7811 7812 7813 7814 7815
                }
                else if (j.m_value.number_unsigned <= 0xffff)
                {
                    v.push_back(0x19);
                    // two-byte uint16_t
7816
                    add_to_vector(v, 2, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7817 7818 7819 7820 7821
                }
                else if (j.m_value.number_unsigned <= 0xffffffff)
                {
                    v.push_back(0x1a);
                    // four-byte uint32_t
7822
                    add_to_vector(v, 4, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7823 7824 7825
                }
                else if (j.m_value.number_unsigned <= 0xffffffffffffffff)
                {
N
Niels Lohmann 已提交
7826
                    v.push_back(0x1b);
N
Niels Lohmann 已提交
7827
                    // eight-byte uint64_t
7828
                    add_to_vector(v, 8, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7829 7830 7831 7832 7833 7834 7835 7836
                }
                break;
            }

            case value_t::number_float:
            {
                // Double-Precision Float
                v.push_back(0xfb);
N
Niels Lohmann 已提交
7837
                const auto* helper = reinterpret_cast<const uint8_t*>(&(j.m_value.number_float));
N
Niels Lohmann 已提交
7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849
                for (size_t i = 0; i < 8; ++i)
                {
                    v.push_back(helper[7 - i]);
                }
                break;
            }

            case value_t::string:
            {
                const auto N = j.m_value.string->size();
                if (N <= 0x17)
                {
7850
                    v.push_back(0x60 + static_cast<uint8_t>(N));  // 1 byte for string + size
N
Niels Lohmann 已提交
7851 7852 7853
                }
                else if (N <= 0xff)
                {
7854
                    v.push_back(0x78);  // one-byte uint8_t for N
7855
                    add_to_vector(v, 1, N);
N
Niels Lohmann 已提交
7856 7857 7858
                }
                else if (N <= 0xffff)
                {
7859
                    v.push_back(0x79);  // two-byte uint16_t for N
7860
                    add_to_vector(v, 2, N);
N
Niels Lohmann 已提交
7861 7862 7863
                }
                else if (N <= 0xffffffff)
                {
7864
                    v.push_back(0x7a); // four-byte uint32_t for N
7865
                    add_to_vector(v, 4, N);
N
Niels Lohmann 已提交
7866
                }
7867
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
7868 7869
                else if (N <= 0xffffffffffffffff)
                {
7870
                    v.push_back(0x7b);  // eight-byte uint64_t for N
7871
                    add_to_vector(v, 8, N);
N
Niels Lohmann 已提交
7872
                }
7873
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885

                // append string
                std::copy(j.m_value.string->begin(), j.m_value.string->end(),
                          std::back_inserter(v));
                break;
            }

            case value_t::array:
            {
                const auto N = j.m_value.array->size();
                if (N <= 0x17)
                {
7886
                    v.push_back(0x80 + static_cast<uint8_t>(N));  // 1 byte for array + size
N
Niels Lohmann 已提交
7887 7888 7889
                }
                else if (N <= 0xff)
                {
7890
                    v.push_back(0x98);  // one-byte uint8_t for N
7891
                    add_to_vector(v, 1, N);
N
Niels Lohmann 已提交
7892 7893 7894
                }
                else if (N <= 0xffff)
                {
7895
                    v.push_back(0x99);  // two-byte uint16_t for N
7896
                    add_to_vector(v, 2, N);
N
Niels Lohmann 已提交
7897 7898 7899
                }
                else if (N <= 0xffffffff)
                {
7900
                    v.push_back(0x9a);  // four-byte uint32_t for N
7901
                    add_to_vector(v, 4, N);
N
Niels Lohmann 已提交
7902
                }
7903
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
7904 7905
                else if (N <= 0xffffffffffffffff)
                {
7906
                    v.push_back(0x9b);  // eight-byte uint64_t for N
7907
                    add_to_vector(v, 8, N);
N
Niels Lohmann 已提交
7908
                }
7909
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923

                // append each element
                for (const auto& el : *j.m_value.array)
                {
                    to_cbor_internal(el, v);
                }
                break;
            }

            case value_t::object:
            {
                const auto N = j.m_value.object->size();
                if (N <= 0x17)
                {
7924
                    v.push_back(0xa0 + static_cast<uint8_t>(N));  // 1 byte for object + size
N
Niels Lohmann 已提交
7925 7926 7927 7928
                }
                else if (N <= 0xff)
                {
                    v.push_back(0xb8);
7929
                    add_to_vector(v, 1, N);  // one-byte uint8_t for N
N
Niels Lohmann 已提交
7930 7931 7932 7933
                }
                else if (N <= 0xffff)
                {
                    v.push_back(0xb9);
7934
                    add_to_vector(v, 2, N);  // two-byte uint16_t for N
N
Niels Lohmann 已提交
7935 7936 7937 7938
                }
                else if (N <= 0xffffffff)
                {
                    v.push_back(0xba);
7939
                    add_to_vector(v, 4, N);  // four-byte uint32_t for N
N
Niels Lohmann 已提交
7940
                }
7941
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
7942 7943 7944
                else if (N <= 0xffffffffffffffff)
                {
                    v.push_back(0xbb);
7945
                    add_to_vector(v, 8, N);  // eight-byte uint64_t for N
N
Niels Lohmann 已提交
7946
                }
7947
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964

                // append each element
                for (const auto& el : *j.m_value.object)
                {
                    to_cbor_internal(el.first, v);
                    to_cbor_internal(el.second, v);
                }
                break;
            }

            default:
            {
                break;
            }
        }
    }

7965 7966 7967 7968 7969 7970

    /*
    @brief checks if given lengths do not exceed the size of a given vector

    To secure the access to the byte vector during CBOR/MessagePack
    deserialization, bytes are copied from the vector into buffers. This
N
Niels Lohmann 已提交
7971 7972 7973
    function checks if the number of bytes to copy (@a len) does not exceed
    the size @s size of the vector. Additionally, an @a offset is given from
    where to start reading the bytes.
7974

N
Niels Lohmann 已提交
7975 7976
    This function checks whether reading the bytes is safe; that is, offset is
    a valid index in the vector, offset+len
7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992

    @param[in] size    size of the byte vector
    @param[in] len     number of bytes to read
    @param[in] offset  offset where to start reading

    vec:  x x x x x X X X X X
          ^         ^         ^
          0         offset    len

    @throws out_of_range if `len > v.size()`
    */
    static void check_length(const size_t size, const size_t len, const size_t offset)
    {
        // simple case: requested length is greater than the vector's length
        if (len > size or offset > size)
        {
N
Niels Lohmann 已提交
7993
            JSON_THROW(parse_error(110, offset + 1, "cannot read " + std::to_string(len) + " bytes from vector"));
7994 7995 7996 7997 7998
        }

        // second case: adding offset would result in overflow
        if ((size > (std::numeric_limits<size_t>::max() - offset)))
        {
N
Niels Lohmann 已提交
7999
            JSON_THROW(parse_error(110, offset + 1, "cannot read " + std::to_string(len) + " bytes from vector"));
8000
        }
N
Niels Lohmann 已提交
8001 8002 8003 8004

        // last case: reading past the end of the vector
        if (len + offset > size)
        {
N
Niels Lohmann 已提交
8005
            JSON_THROW(parse_error(110, offset + 1, "cannot read " + std::to_string(len) + " bytes from vector"));
N
Niels Lohmann 已提交
8006
        }
8007 8008
    }

8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037
    /*!
    @brief check if the next byte belongs to a string

    While parsing a map, the keys must be strings. This function checks if the
    current byte is one of the start bytes for a string in MessagePack:

    - 0xa0 - 0xbf: fixstr
    - 0xd9: str 8
    - 0xda: str 16
    - 0xdb: str 32

    @param[in] v  MessagePack serialization
    @param[in] idx  byte index in @a v to check for a string

    @throw std::invalid_argument if `v[idx]` does not belong to a string
    */
    static void msgpack_expect_string(const std::vector<uint8_t>& v, size_t idx)
    {
        check_length(v.size(), 1, idx);

        const auto byte = v[idx];
        if ((byte >= 0xa0 and byte <= 0xbf) or (byte >= 0xd9 and byte <= 0xdb))
        {
            return;
        }

        JSON_THROW(std::invalid_argument("error parsing a msgpack string @ " + std::to_string(idx) + ": " + std::to_string(static_cast<int>(v[idx]))));
    }

N
Niels 已提交
8038
    /*!
8039 8040
    @brief create a JSON value from a given MessagePack vector

N
Niels 已提交
8041 8042
    @param[in] v  MessagePack serialization
    @param[in] idx  byte index to start reading from @a v
8043 8044 8045

    @return deserialized JSON value

N
Niels Lohmann 已提交
8046 8047
    @throw parse_error.110 if the given vector ends prematurely
    @throw parse_error.112 if unsupported features from MessagePack were
8048 8049 8050
    used in the given vector @a v or if the input is not valid MessagePack

    @sa https://github.com/msgpack/msgpack/blob/master/spec.md
N
Niels 已提交
8051 8052 8053 8054 8055 8056
    */
    static basic_json from_msgpack_internal(const std::vector<uint8_t>& v, size_t& idx)
    {
        // store and increment index
        const size_t current_idx = idx++;

8057 8058 8059
        // make sure reading 1 byte is safe
        check_length(v.size(), 1, current_idx);

N
Niels Lohmann 已提交
8060
        if (v[current_idx] <= 0xbf)
N
Niels 已提交
8061
        {
N
Niels Lohmann 已提交
8062
            if (v[current_idx] <= 0x7f) // positive fixint
N
Niels 已提交
8063
            {
N
Niels Lohmann 已提交
8064
                return v[current_idx];
N
Niels 已提交
8065
            }
N
Niels Lohmann 已提交
8066
            if (v[current_idx] <= 0x8f) // fixmap
N
Niels 已提交
8067
            {
N
Niels Lohmann 已提交
8068 8069 8070 8071
                basic_json result = value_t::object;
                const size_t len = v[current_idx] & 0x0f;
                for (size_t i = 0; i < len; ++i)
                {
8072
                    msgpack_expect_string(v, idx);
N
Niels Lohmann 已提交
8073 8074 8075 8076
                    std::string key = from_msgpack_internal(v, idx);
                    result[key] = from_msgpack_internal(v, idx);
                }
                return result;
N
Niels 已提交
8077
            }
N
Niels Lohmann 已提交
8078
            else if (v[current_idx] <= 0x9f) // fixarray
N
Niels 已提交
8079
            {
N
Niels Lohmann 已提交
8080 8081 8082 8083 8084 8085 8086
                basic_json result = value_t::array;
                const size_t len = v[current_idx] & 0x0f;
                for (size_t i = 0; i < len; ++i)
                {
                    result.push_back(from_msgpack_internal(v, idx));
                }
                return result;
N
Niels 已提交
8087
            }
N
Niels Lohmann 已提交
8088
            else // fixstr
N
Niels 已提交
8089
            {
N
Niels Lohmann 已提交
8090 8091 8092
                const size_t len = v[current_idx] & 0x1f;
                const size_t offset = current_idx + 1;
                idx += len; // skip content bytes
8093
                check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
8094
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels 已提交
8095 8096
            }
        }
N
Niels Lohmann 已提交
8097
        else if (v[current_idx] >= 0xe0) // negative fixint
N
Niels 已提交
8098
        {
N
Niels Lohmann 已提交
8099
            return static_cast<int8_t>(v[current_idx]);
N
Niels 已提交
8100
        }
N
Niels Lohmann 已提交
8101
        else
N
Niels 已提交
8102
        {
N
Niels Lohmann 已提交
8103
            switch (v[current_idx])
N
Niels 已提交
8104
            {
N
Niels Lohmann 已提交
8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123
                case 0xc0: // nil
                {
                    return value_t::null;
                }

                case 0xc2: // false
                {
                    return false;
                }

                case 0xc3: // true
                {
                    return true;
                }

                case 0xca: // float 32
                {
                    // copy bytes in reverse order into the double variable
                    float res;
8124
                    check_length(v.size(), sizeof(float), current_idx + 1);
N
Niels Lohmann 已提交
8125 8126
                    for (size_t byte = 0; byte < sizeof(float); ++byte)
                    {
8127
                        reinterpret_cast<uint8_t*>(&res)[sizeof(float) - byte - 1] = v[current_idx + 1 + byte];
N
Niels Lohmann 已提交
8128 8129 8130 8131 8132 8133 8134 8135 8136
                    }
                    idx += sizeof(float); // skip content bytes
                    return res;
                }

                case 0xcb: // float 64
                {
                    // copy bytes in reverse order into the double variable
                    double res;
8137
                    check_length(v.size(), sizeof(double), current_idx + 1);
N
Niels Lohmann 已提交
8138 8139
                    for (size_t byte = 0; byte < sizeof(double); ++byte)
                    {
8140
                        reinterpret_cast<uint8_t*>(&res)[sizeof(double) - byte - 1] = v[current_idx + 1 + byte];
N
Niels Lohmann 已提交
8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195
                    }
                    idx += sizeof(double); // skip content bytes
                    return res;
                }

                case 0xcc: // uint 8
                {
                    idx += 1; // skip content byte
                    return get_from_vector<uint8_t>(v, current_idx);
                }

                case 0xcd: // uint 16
                {
                    idx += 2; // skip 2 content bytes
                    return get_from_vector<uint16_t>(v, current_idx);
                }

                case 0xce: // uint 32
                {
                    idx += 4; // skip 4 content bytes
                    return get_from_vector<uint32_t>(v, current_idx);
                }

                case 0xcf: // uint 64
                {
                    idx += 8; // skip 8 content bytes
                    return get_from_vector<uint64_t>(v, current_idx);
                }

                case 0xd0: // int 8
                {
                    idx += 1; // skip content byte
                    return get_from_vector<int8_t>(v, current_idx);
                }

                case 0xd1: // int 16
                {
                    idx += 2; // skip 2 content bytes
                    return get_from_vector<int16_t>(v, current_idx);
                }

                case 0xd2: // int 32
                {
                    idx += 4; // skip 4 content bytes
                    return get_from_vector<int32_t>(v, current_idx);
                }

                case 0xd3: // int 64
                {
                    idx += 8; // skip 8 content bytes
                    return get_from_vector<int64_t>(v, current_idx);
                }

                case 0xd9: // str 8
                {
8196
                    const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
N
Niels Lohmann 已提交
8197 8198
                    const size_t offset = current_idx + 2;
                    idx += len + 1; // skip size byte + content bytes
8199
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
8200 8201 8202 8203 8204
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xda: // str 16
                {
8205
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
8206 8207
                    const size_t offset = current_idx + 3;
                    idx += len + 2; // skip 2 size bytes + content bytes
8208
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
8209 8210 8211 8212 8213
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xdb: // str 32
                {
8214
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
8215 8216
                    const size_t offset = current_idx + 5;
                    idx += len + 4; // skip 4 size bytes + content bytes
8217
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
8218 8219 8220 8221 8222 8223
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xdc: // array 16
                {
                    basic_json result = value_t::array;
8224
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235
                    idx += 2; // skip 2 size bytes
                    for (size_t i = 0; i < len; ++i)
                    {
                        result.push_back(from_msgpack_internal(v, idx));
                    }
                    return result;
                }

                case 0xdd: // array 32
                {
                    basic_json result = value_t::array;
8236
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247
                    idx += 4; // skip 4 size bytes
                    for (size_t i = 0; i < len; ++i)
                    {
                        result.push_back(from_msgpack_internal(v, idx));
                    }
                    return result;
                }

                case 0xde: // map 16
                {
                    basic_json result = value_t::object;
8248
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
8249 8250 8251
                    idx += 2; // skip 2 size bytes
                    for (size_t i = 0; i < len; ++i)
                    {
8252
                        msgpack_expect_string(v, idx);
N
Niels Lohmann 已提交
8253 8254 8255 8256 8257 8258 8259 8260 8261
                        std::string key = from_msgpack_internal(v, idx);
                        result[key] = from_msgpack_internal(v, idx);
                    }
                    return result;
                }

                case 0xdf: // map 32
                {
                    basic_json result = value_t::object;
8262
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
8263 8264 8265
                    idx += 4; // skip 4 size bytes
                    for (size_t i = 0; i < len; ++i)
                    {
8266
                        msgpack_expect_string(v, idx);
N
Niels Lohmann 已提交
8267 8268 8269 8270 8271 8272 8273 8274
                        std::string key = from_msgpack_internal(v, idx);
                        result[key] = from_msgpack_internal(v, idx);
                    }
                    return result;
                }

                default:
                {
8275 8276 8277
                    std::stringstream ss;
                    ss << std::hex << static_cast<int>(v[current_idx]);
                    JSON_THROW(parse_error(112, current_idx + 1, "error reading MessagePack; last byte: 0x" + ss.str()));
N
Niels Lohmann 已提交
8278
                }
N
Niels 已提交
8279 8280 8281 8282
            }
        }
    }

8283 8284 8285 8286 8287 8288 8289 8290
    /*!
    @brief create a JSON value from a given CBOR vector

    @param[in] v  CBOR serialization
    @param[in] idx  byte index to start reading from @a v

    @return deserialized JSON value

N
Niels Lohmann 已提交
8291 8292 8293
    @throw parse_error.110 if the given vector ends prematurely
    @throw parse_error.112 if unsupported features from CBOR were
    used in the given vector @a v or if the input is not valid CBOR
8294 8295 8296

    @sa https://tools.ietf.org/html/rfc7049
    */
N
Niels Lohmann 已提交
8297 8298 8299 8300 8301
    static basic_json from_cbor_internal(const std::vector<uint8_t>& v, size_t& idx)
    {
        // store and increment index
        const size_t current_idx = idx++;

8302 8303 8304 8305
        // make sure reading 1 byte is safe
        check_length(v.size(), 1, current_idx);

        switch (v[current_idx])
8306
        {
N
Niels Lohmann 已提交
8307
            // Integer 0x00..0x17 (0..23)
8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331
            case 0x00:
            case 0x01:
            case 0x02:
            case 0x03:
            case 0x04:
            case 0x05:
            case 0x06:
            case 0x07:
            case 0x08:
            case 0x09:
            case 0x0a:
            case 0x0b:
            case 0x0c:
            case 0x0d:
            case 0x0e:
            case 0x0f:
            case 0x10:
            case 0x11:
            case 0x12:
            case 0x13:
            case 0x14:
            case 0x15:
            case 0x16:
            case 0x17:
8332
            {
8333
                return v[current_idx];
8334
            }
8335

N
Niels Lohmann 已提交
8336
            case 0x18: // Unsigned integer (one-byte uint8_t follows)
N
Niels Lohmann 已提交
8337
            {
8338 8339
                idx += 1; // skip content byte
                return get_from_vector<uint8_t>(v, current_idx);
N
Niels Lohmann 已提交
8340
            }
8341

N
Niels Lohmann 已提交
8342
            case 0x19: // Unsigned integer (two-byte uint16_t follows)
N
Niels Lohmann 已提交
8343
            {
8344 8345
                idx += 2; // skip 2 content bytes
                return get_from_vector<uint16_t>(v, current_idx);
N
Niels Lohmann 已提交
8346
            }
8347

N
Niels Lohmann 已提交
8348
            case 0x1a: // Unsigned integer (four-byte uint32_t follows)
N
Niels Lohmann 已提交
8349
            {
8350 8351
                idx += 4; // skip 4 content bytes
                return get_from_vector<uint32_t>(v, current_idx);
N
Niels Lohmann 已提交
8352
            }
8353

N
Niels Lohmann 已提交
8354
            case 0x1b: // Unsigned integer (eight-byte uint64_t follows)
N
Niels Lohmann 已提交
8355
            {
8356 8357
                idx += 8; // skip 8 content bytes
                return get_from_vector<uint64_t>(v, current_idx);
N
Niels Lohmann 已提交
8358
            }
8359

N
Niels Lohmann 已提交
8360
            // Negative integer -1-0x00..-1-0x17 (-1..-24)
8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384
            case 0x20:
            case 0x21:
            case 0x22:
            case 0x23:
            case 0x24:
            case 0x25:
            case 0x26:
            case 0x27:
            case 0x28:
            case 0x29:
            case 0x2a:
            case 0x2b:
            case 0x2c:
            case 0x2d:
            case 0x2e:
            case 0x2f:
            case 0x30:
            case 0x31:
            case 0x32:
            case 0x33:
            case 0x34:
            case 0x35:
            case 0x36:
            case 0x37:
N
Niels Lohmann 已提交
8385
            {
8386
                return static_cast<int8_t>(0x20 - 1 - v[current_idx]);
N
Niels Lohmann 已提交
8387
            }
8388

N
Niels Lohmann 已提交
8389
            case 0x38: // Negative integer (one-byte uint8_t follows)
8390
            {
8391 8392
                idx += 1; // skip content byte
                // must be uint8_t !
8393
                return static_cast<number_integer_t>(-1) - get_from_vector<uint8_t>(v, current_idx);
8394
            }
8395

N
Niels Lohmann 已提交
8396
            case 0x39: // Negative integer -1-n (two-byte uint16_t follows)
N
Niels Lohmann 已提交
8397
            {
8398
                idx += 2; // skip 2 content bytes
8399
                return static_cast<number_integer_t>(-1) - get_from_vector<uint16_t>(v, current_idx);
N
Niels Lohmann 已提交
8400
            }
8401

N
Niels Lohmann 已提交
8402
            case 0x3a: // Negative integer -1-n (four-byte uint32_t follows)
N
Niels Lohmann 已提交
8403
            {
8404
                idx += 4; // skip 4 content bytes
8405
                return static_cast<number_integer_t>(-1) - get_from_vector<uint32_t>(v, current_idx);
N
Niels Lohmann 已提交
8406
            }
8407

N
Niels Lohmann 已提交
8408
            case 0x3b: // Negative integer -1-n (eight-byte uint64_t follows)
N
Niels Lohmann 已提交
8409
            {
8410
                idx += 8; // skip 8 content bytes
8411
                return static_cast<number_integer_t>(-1) - static_cast<number_integer_t>(get_from_vector<uint64_t>(v, current_idx));
N
Niels Lohmann 已提交
8412
            }
8413

N
Niels Lohmann 已提交
8414
            // UTF-8 string (0x00..0x17 bytes follow)
8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438
            case 0x60:
            case 0x61:
            case 0x62:
            case 0x63:
            case 0x64:
            case 0x65:
            case 0x66:
            case 0x67:
            case 0x68:
            case 0x69:
            case 0x6a:
            case 0x6b:
            case 0x6c:
            case 0x6d:
            case 0x6e:
            case 0x6f:
            case 0x70:
            case 0x71:
            case 0x72:
            case 0x73:
            case 0x74:
            case 0x75:
            case 0x76:
            case 0x77:
N
Niels Lohmann 已提交
8439
            {
8440
                const auto len = static_cast<size_t>(v[current_idx] - 0x60);
8441 8442
                const size_t offset = current_idx + 1;
                idx += len; // skip content bytes
8443
                check_length(v.size(), len, offset);
8444
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels Lohmann 已提交
8445
            }
8446

N
Niels Lohmann 已提交
8447
            case 0x78: // UTF-8 string (one-byte uint8_t for n follows)
N
Niels Lohmann 已提交
8448
            {
8449
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
8450 8451
                const size_t offset = current_idx + 2;
                idx += len + 1; // skip size byte + content bytes
8452
                check_length(v.size(), len, offset);
8453
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels Lohmann 已提交
8454
            }
8455

N
Niels Lohmann 已提交
8456
            case 0x79: // UTF-8 string (two-byte uint16_t for n follow)
8457
            {
8458
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
8459 8460
                const size_t offset = current_idx + 3;
                idx += len + 2; // skip 2 size bytes + content bytes
8461
                check_length(v.size(), len, offset);
8462
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
8463
            }
8464

N
Niels Lohmann 已提交
8465
            case 0x7a: // UTF-8 string (four-byte uint32_t for n follow)
8466
            {
8467
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
8468 8469
                const size_t offset = current_idx + 5;
                idx += len + 4; // skip 4 size bytes + content bytes
8470
                check_length(v.size(), len, offset);
8471
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
8472
            }
8473

N
Niels Lohmann 已提交
8474
            case 0x7b: // UTF-8 string (eight-byte uint64_t for n follow)
8475
            {
8476
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
8477 8478
                const size_t offset = current_idx + 9;
                idx += len + 8; // skip 8 size bytes + content bytes
8479
                check_length(v.size(), len, offset);
8480
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
8481
            }
8482 8483

            case 0x7f: // UTF-8 string (indefinite length)
8484
            {
8485
                std::string result;
8486
                while (check_length(v.size(), 1, idx), v[idx] != 0xff)
8487 8488 8489 8490 8491 8492 8493
                {
                    string_t s = from_cbor_internal(v, idx);
                    result += s;
                }
                // skip break byte (0xFF)
                idx += 1;
                return result;
8494
            }
8495

N
Niels Lohmann 已提交
8496
            // array (0x00..0x17 data items follow)
8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520
            case 0x80:
            case 0x81:
            case 0x82:
            case 0x83:
            case 0x84:
            case 0x85:
            case 0x86:
            case 0x87:
            case 0x88:
            case 0x89:
            case 0x8a:
            case 0x8b:
            case 0x8c:
            case 0x8d:
            case 0x8e:
            case 0x8f:
            case 0x90:
            case 0x91:
            case 0x92:
            case 0x93:
            case 0x94:
            case 0x95:
            case 0x96:
            case 0x97:
N
Niels Lohmann 已提交
8521
            {
8522
                basic_json result = value_t::array;
8523
                const auto len = static_cast<size_t>(v[current_idx] - 0x80);
8524 8525 8526 8527 8528
                for (size_t i = 0; i < len; ++i)
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                return result;
N
Niels Lohmann 已提交
8529
            }
8530

N
Niels Lohmann 已提交
8531
            case 0x98: // array (one-byte uint8_t for n follows)
N
Niels Lohmann 已提交
8532
            {
8533
                basic_json result = value_t::array;
8534
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
8535 8536 8537 8538 8539 8540
                idx += 1; // skip 1 size byte
                for (size_t i = 0; i < len; ++i)
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                return result;
N
Niels Lohmann 已提交
8541 8542
            }

N
Niels Lohmann 已提交
8543
            case 0x99: // array (two-byte uint16_t for n follow)
8544 8545
            {
                basic_json result = value_t::array;
8546
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
8547 8548 8549 8550 8551 8552 8553 8554
                idx += 2; // skip 4 size bytes
                for (size_t i = 0; i < len; ++i)
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                return result;
            }

N
Niels Lohmann 已提交
8555
            case 0x9a: // array (four-byte uint32_t for n follow)
8556 8557
            {
                basic_json result = value_t::array;
8558
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
8559 8560 8561 8562 8563 8564 8565 8566
                idx += 4; // skip 4 size bytes
                for (size_t i = 0; i < len; ++i)
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                return result;
            }

N
Niels Lohmann 已提交
8567
            case 0x9b: // array (eight-byte uint64_t for n follow)
8568 8569
            {
                basic_json result = value_t::array;
8570
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581
                idx += 8; // skip 8 size bytes
                for (size_t i = 0; i < len; ++i)
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                return result;
            }

            case 0x9f: // array (indefinite length)
            {
                basic_json result = value_t::array;
8582
                while (check_length(v.size(), 1, idx), v[idx] != 0xff)
8583 8584 8585 8586 8587 8588 8589 8590
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                // skip break byte (0xFF)
                idx += 1;
                return result;
            }

N
Niels Lohmann 已提交
8591
            // map (0x00..0x17 pairs of data items follow)
8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617
            case 0xa0:
            case 0xa1:
            case 0xa2:
            case 0xa3:
            case 0xa4:
            case 0xa5:
            case 0xa6:
            case 0xa7:
            case 0xa8:
            case 0xa9:
            case 0xaa:
            case 0xab:
            case 0xac:
            case 0xad:
            case 0xae:
            case 0xaf:
            case 0xb0:
            case 0xb1:
            case 0xb2:
            case 0xb3:
            case 0xb4:
            case 0xb5:
            case 0xb6:
            case 0xb7:
            {
                basic_json result = value_t::object;
8618
                const auto len = static_cast<size_t>(v[current_idx] - 0xa0);
8619 8620 8621 8622 8623 8624 8625 8626
                for (size_t i = 0; i < len; ++i)
                {
                    std::string key = from_cbor_internal(v, idx);
                    result[key] = from_cbor_internal(v, idx);
                }
                return result;
            }

N
Niels Lohmann 已提交
8627
            case 0xb8: // map (one-byte uint8_t for n follows)
8628 8629
            {
                basic_json result = value_t::object;
8630
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
8631 8632 8633 8634 8635 8636 8637 8638 8639
                idx += 1; // skip 1 size byte
                for (size_t i = 0; i < len; ++i)
                {
                    std::string key = from_cbor_internal(v, idx);
                    result[key] = from_cbor_internal(v, idx);
                }
                return result;
            }

N
Niels Lohmann 已提交
8640
            case 0xb9: // map (two-byte uint16_t for n follow)
8641 8642
            {
                basic_json result = value_t::object;
8643
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
8644 8645 8646 8647 8648 8649 8650 8651 8652
                idx += 2; // skip 2 size bytes
                for (size_t i = 0; i < len; ++i)
                {
                    std::string key = from_cbor_internal(v, idx);
                    result[key] = from_cbor_internal(v, idx);
                }
                return result;
            }

N
Niels Lohmann 已提交
8653
            case 0xba: // map (four-byte uint32_t for n follow)
8654 8655
            {
                basic_json result = value_t::object;
8656
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
8657 8658 8659 8660 8661 8662 8663 8664 8665
                idx += 4; // skip 4 size bytes
                for (size_t i = 0; i < len; ++i)
                {
                    std::string key = from_cbor_internal(v, idx);
                    result[key] = from_cbor_internal(v, idx);
                }
                return result;
            }

N
Niels Lohmann 已提交
8666
            case 0xbb: // map (eight-byte uint64_t for n follow)
8667 8668
            {
                basic_json result = value_t::object;
8669
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681
                idx += 8; // skip 8 size bytes
                for (size_t i = 0; i < len; ++i)
                {
                    std::string key = from_cbor_internal(v, idx);
                    result[key] = from_cbor_internal(v, idx);
                }
                return result;
            }

            case 0xbf: // map (indefinite length)
            {
                basic_json result = value_t::object;
8682
                while (check_length(v.size(), 1, idx), v[idx] != 0xff)
8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706
                {
                    std::string key = from_cbor_internal(v, idx);
                    result[key] = from_cbor_internal(v, idx);
                }
                // skip break byte (0xFF)
                idx += 1;
                return result;
            }

            case 0xf4: // false
            {
                return false;
            }

            case 0xf5: // true
            {
                return true;
            }

            case 0xf6: // null
            {
                return value_t::null;
            }

N
Niels Lohmann 已提交
8707
            case 0xf9: // Half-Precision Float (two-byte IEEE 754)
8708 8709 8710 8711
            {
                idx += 2; // skip two content bytes

                // code from RFC 7049, Appendix D, Figure 3:
N
Niels Lohmann 已提交
8712 8713 8714 8715 8716 8717
                // As half-precision floating-point numbers were only added to
                // IEEE 754 in 2008, today's programming platforms often still
                // only have limited support for them. It is very easy to
                // include at least decoding support for them even without such
                // support. An example of a small decoder for half-precision
                // floating-point numbers in the C language is shown in Fig. 3.
8718 8719
                check_length(v.size(), 2, current_idx + 1);
                const int half = (v[current_idx + 1] << 8) + v[current_idx + 2];
8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732
                const int exp = (half >> 10) & 0x1f;
                const int mant = half & 0x3ff;
                double val;
                if (exp == 0)
                {
                    val = std::ldexp(mant, -24);
                }
                else if (exp != 31)
                {
                    val = std::ldexp(mant + 1024, exp - 25);
                }
                else
                {
8733 8734 8735
                    val = mant == 0
                          ? std::numeric_limits<double>::infinity()
                          : std::numeric_limits<double>::quiet_NaN();
8736
                }
N
Niels Lohmann 已提交
8737
                return (half & 0x8000) != 0 ? -val : val;
8738 8739
            }

N
Niels Lohmann 已提交
8740
            case 0xfa: // Single-Precision Float (four-byte IEEE 754)
8741 8742 8743
            {
                // copy bytes in reverse order into the float variable
                float res;
8744
                check_length(v.size(), sizeof(float), current_idx + 1);
8745 8746
                for (size_t byte = 0; byte < sizeof(float); ++byte)
                {
8747
                    reinterpret_cast<uint8_t*>(&res)[sizeof(float) - byte - 1] = v[current_idx + 1 + byte];
8748 8749 8750 8751 8752
                }
                idx += sizeof(float); // skip content bytes
                return res;
            }

N
Niels Lohmann 已提交
8753
            case 0xfb: // Double-Precision Float (eight-byte IEEE 754)
8754 8755 8756
            {
                // copy bytes in reverse order into the double variable
                double res;
8757
                check_length(v.size(), sizeof(double), current_idx + 1);
8758 8759
                for (size_t byte = 0; byte < sizeof(double); ++byte)
                {
8760
                    reinterpret_cast<uint8_t*>(&res)[sizeof(double) - byte - 1] = v[current_idx + 1 + byte];
8761 8762 8763 8764 8765
                }
                idx += sizeof(double); // skip content bytes
                return res;
            }

N
Niels Lohmann 已提交
8766
            default: // anything else (0xFF is handled inside the other types)
8767
            {
8768 8769 8770
                std::stringstream ss;
                ss << std::hex << static_cast<int>(v[current_idx]);
                JSON_THROW(parse_error(112, current_idx + 1, "error reading CBOR; last byte: 0x" + ss.str()));
8771 8772
            }
        }
N
Niels Lohmann 已提交
8773 8774
    }

N
Niels 已提交
8775 8776
  public:
    /*!
8777 8778 8779 8780 8781 8782
    @brief create a MessagePack serialization of a given JSON value

    Serializes a given JSON value @a j to a byte vector using the MessagePack
    serialization format. MessagePack is a binary serialization format which
    aims to be more compact than JSON itself, yet more efficient to parse.

N
Niels 已提交
8783
    @param[in] j  JSON value to serialize
8784 8785 8786 8787 8788 8789 8790 8791
    @return MessagePack serialization as byte vector

    @complexity Linear in the size of the JSON value @a j.

    @liveexample{The example shows the serialization of a JSON value to a byte
    vector in MessagePack format.,to_msgpack}

    @sa http://msgpack.org
8792 8793
    @sa @ref from_msgpack(const std::vector<uint8_t>&, const size_t) for the
        analogous deserialization
8794
    @sa @ref to_cbor(const basic_json& for the related CBOR format
8795 8796

    @since version 2.0.9
N
Niels 已提交
8797 8798 8799 8800 8801 8802 8803 8804
    */
    static std::vector<uint8_t> to_msgpack(const basic_json& j)
    {
        std::vector<uint8_t> result;
        to_msgpack_internal(j, result);
        return result;
    }

8805 8806 8807 8808 8809 8810 8811
    /*!
    @brief create a JSON value from a byte vector in MessagePack format

    Deserializes a given byte vector @a v to a JSON value using the MessagePack
    serialization format.

    @param[in] v  a byte vector in MessagePack format
8812
    @param[in] start_index the index to start reading from @a v (0 by default)
8813 8814
    @return deserialized JSON value

N
Niels Lohmann 已提交
8815 8816
    @throw parse_error.110 if the given vector ends prematurely
    @throw parse_error.112 if unsupported features from MessagePack were
8817 8818 8819 8820 8821 8822 8823 8824 8825
    used in the given vector @a v or if the input is not valid MessagePack

    @complexity Linear in the size of the byte vector @a v.

    @liveexample{The example shows the deserialization of a byte vector in
    MessagePack format to a JSON value.,from_msgpack}

    @sa http://msgpack.org
    @sa @ref to_msgpack(const basic_json&) for the analogous serialization
8826 8827 8828
    @sa @ref from_cbor(const std::vector<uint8_t>&, const size_t) for the
        related CBOR format

N
Niels Lohmann 已提交
8829
    @since version 2.0.9, parameter @a start_index since 2.1.1
8830
    */
8831 8832
    static basic_json from_msgpack(const std::vector<uint8_t>& v,
                                   const size_t start_index = 0)
N
Niels 已提交
8833
    {
8834
        size_t i = start_index;
N
Niels 已提交
8835 8836 8837
        return from_msgpack_internal(v, i);
    }

N
Niels Lohmann 已提交
8838
    /*!
8839 8840 8841 8842 8843 8844 8845
    @brief create a MessagePack serialization of a given JSON value

    Serializes a given JSON value @a j to a byte vector using the CBOR (Concise
    Binary Object Representation) serialization format. CBOR is a binary
    serialization format which aims to be more compact than JSON itself, yet
    more efficient to parse.

N
Niels Lohmann 已提交
8846
    @param[in] j  JSON value to serialize
8847 8848 8849 8850 8851 8852 8853 8854
    @return MessagePack serialization as byte vector

    @complexity Linear in the size of the JSON value @a j.

    @liveexample{The example shows the serialization of a JSON value to a byte
    vector in CBOR format.,to_cbor}

    @sa http://cbor.io
8855 8856
    @sa @ref from_cbor(const std::vector<uint8_t>&, const size_t) for the
        analogous deserialization
8857
    @sa @ref to_msgpack(const basic_json& for the related MessagePack format
8858 8859

    @since version 2.0.9
N
Niels Lohmann 已提交
8860 8861 8862 8863 8864 8865 8866 8867
    */
    static std::vector<uint8_t> to_cbor(const basic_json& j)
    {
        std::vector<uint8_t> result;
        to_cbor_internal(j, result);
        return result;
    }

8868 8869 8870 8871 8872 8873 8874
    /*!
    @brief create a JSON value from a byte vector in CBOR format

    Deserializes a given byte vector @a v to a JSON value using the CBOR
    (Concise Binary Object Representation) serialization format.

    @param[in] v  a byte vector in CBOR format
8875
    @param[in] start_index the index to start reading from @a v (0 by default)
8876 8877
    @return deserialized JSON value

N
Niels Lohmann 已提交
8878 8879 8880
    @throw parse_error.110 if the given vector ends prematurely
    @throw parse_error.112 if unsupported features from CBOR were
    used in the given vector @a v or if the input is not valid CBOR
8881 8882 8883 8884 8885 8886 8887 8888

    @complexity Linear in the size of the byte vector @a v.

    @liveexample{The example shows the deserialization of a byte vector in CBOR
    format to a JSON value.,from_cbor}

    @sa http://cbor.io
    @sa @ref to_cbor(const basic_json&) for the analogous serialization
8889 8890 8891
    @sa @ref from_msgpack(const std::vector<uint8_t>&, const size_t) for the
        related MessagePack format

N
Niels Lohmann 已提交
8892
    @since version 2.0.9, parameter @a start_index since 2.1.1
8893
    */
8894 8895
    static basic_json from_cbor(const std::vector<uint8_t>& v,
                                const size_t start_index = 0)
N
Niels Lohmann 已提交
8896
    {
8897
        size_t i = start_index;
N
Niels Lohmann 已提交
8898 8899 8900
        return from_cbor_internal(v, i);
    }

N
Niels 已提交
8901
    /// @}
N
Niels 已提交
8902 8903 8904 8905 8906

    ///////////////////////////
    // convenience functions //
    ///////////////////////////

N
Niels 已提交
8907 8908 8909 8910 8911 8912
    /*!
    @brief return the type as string

    Returns the type name as string to be used in error messages - usually to
    indicate that a function was called on a wrong JSON type.

N
Niels 已提交
8913
    @return basically a string representation of a the @a m_type member
N
Niels 已提交
8914 8915 8916

    @complexity Constant.

8917
    @liveexample{The following code exemplifies `type_name()` for all JSON
8918
    types.,type_name}
8919

8920
    @since version 1.0.0, public since 2.1.0
N
Niels 已提交
8921
    */
T
Théo DELRIEU 已提交
8922 8923
    std::string type_name() const
    {
T
Théo DELRIEU 已提交
8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942
        {
            switch (m_type)
            {
                case value_t::null:
                    return "null";
                case value_t::object:
                    return "object";
                case value_t::array:
                    return "array";
                case value_t::string:
                    return "string";
                case value_t::boolean:
                    return "boolean";
                case value_t::discarded:
                    return "discarded";
                default:
                    return "number";
            }
        }
T
Théo DELRIEU 已提交
8943
    }
N
Niels 已提交
8944 8945 8946 8947 8948 8949 8950 8951


  private:
    //////////////////////
    // member variables //
    //////////////////////

    /// the type of the current element
N
Niels 已提交
8952
    value_t m_type = value_t::null;
N
Niels 已提交
8953 8954 8955 8956

    /// the value of the current element
    json_value m_value = {};

N
Niels 已提交
8957

N
Niels 已提交
8958
  private:
N
Niels 已提交
8959 8960 8961 8962
    ///////////////
    // iterators //
    ///////////////

8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973
    /*!
    @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
    {
T
Théo DELRIEU 已提交
8974
      public:
T
Théo Delrieu 已提交
8975 8976

        difference_type get_value() const noexcept
T
Théo DELRIEU 已提交
8977 8978 8979 8980 8981 8982 8983 8984
        {
            return m_it;
        }
        /// set iterator to a defined beginning
        void set_begin() noexcept
        {
            m_it = begin_value;
        }
8985

T
Théo DELRIEU 已提交
8986 8987 8988 8989 8990
        /// set iterator to a defined past the end
        void set_end() noexcept
        {
            m_it = end_value;
        }
8991

T
Théo DELRIEU 已提交
8992 8993 8994 8995 8996
        /// return whether the iterator can be dereferenced
        constexpr bool is_begin() const noexcept
        {
            return (m_it == begin_value);
        }
8997

T
Théo DELRIEU 已提交
8998 8999 9000 9001 9002
        /// return whether the iterator is at end
        constexpr bool is_end() const noexcept
        {
            return (m_it == end_value);
        }
9003

T
Théo DELRIEU 已提交
9004 9005 9006 9007
        friend constexpr bool operator==(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it == rhs.m_it;
        }
T
Théo Delrieu 已提交
9008

T
Théo DELRIEU 已提交
9009 9010 9011 9012
        friend constexpr bool operator!=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return !(lhs == rhs);
        }
T
Théo Delrieu 已提交
9013

T
Théo DELRIEU 已提交
9014 9015 9016 9017
        friend constexpr bool operator<(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it < rhs.m_it;
        }
T
Théo Delrieu 已提交
9018

T
Théo DELRIEU 已提交
9019 9020 9021 9022
        friend constexpr bool operator<=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it <= rhs.m_it;
        }
T
Théo Delrieu 已提交
9023

T
Théo DELRIEU 已提交
9024 9025 9026 9027
        friend constexpr bool operator>(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it > rhs.m_it;
        }
T
Théo Delrieu 已提交
9028

T
Théo DELRIEU 已提交
9029 9030 9031 9032
        friend constexpr bool operator>=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it >= rhs.m_it;
        }
T
Théo Delrieu 已提交
9033

T
Théo DELRIEU 已提交
9034 9035 9036 9037 9038 9039
        primitive_iterator_t operator+(difference_type i)
        {
            auto result = *this;
            result += i;
            return result;
        }
T
Théo Delrieu 已提交
9040

T
Théo DELRIEU 已提交
9041 9042 9043 9044
        friend constexpr difference_type operator-(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it - rhs.m_it;
        }
T
Théo Delrieu 已提交
9045

T
Théo DELRIEU 已提交
9046 9047 9048 9049
        friend std::ostream& operator<<(std::ostream& os, primitive_iterator_t it)
        {
            return os << it.m_it;
        }
T
Théo Delrieu 已提交
9050

T
Théo DELRIEU 已提交
9051 9052 9053 9054 9055
        primitive_iterator_t& operator++()
        {
            ++m_it;
            return *this;
        }
T
Théo Delrieu 已提交
9056

N
Niels Lohmann 已提交
9057
        primitive_iterator_t operator++(int)
T
Théo DELRIEU 已提交
9058
        {
N
Niels Lohmann 已提交
9059
            auto result = *this;
T
Théo DELRIEU 已提交
9060
            m_it++;
N
Niels Lohmann 已提交
9061
            return result;
T
Théo DELRIEU 已提交
9062
        }
T
Théo Delrieu 已提交
9063

T
Théo DELRIEU 已提交
9064 9065 9066 9067 9068
        primitive_iterator_t& operator--()
        {
            --m_it;
            return *this;
        }
T
Théo Delrieu 已提交
9069

N
Niels Lohmann 已提交
9070
        primitive_iterator_t operator--(int)
T
Théo DELRIEU 已提交
9071
        {
N
Niels Lohmann 已提交
9072
            auto result = *this;
T
Théo DELRIEU 已提交
9073
            m_it--;
N
Niels Lohmann 已提交
9074
            return result;
T
Théo DELRIEU 已提交
9075
        }
T
Théo Delrieu 已提交
9076

T
Théo DELRIEU 已提交
9077 9078 9079 9080 9081
        primitive_iterator_t& operator+=(difference_type n)
        {
            m_it += n;
            return *this;
        }
9082

T
Théo DELRIEU 已提交
9083 9084 9085 9086 9087
        primitive_iterator_t& operator-=(difference_type n)
        {
            m_it -= n;
            return *this;
        }
9088

T
Théo DELRIEU 已提交
9089 9090 9091
      private:
        static constexpr difference_type begin_value = 0;
        static constexpr difference_type end_value = begin_value + 1;
9092

T
Théo DELRIEU 已提交
9093 9094 9095
        /// iterator as signed integer type
        difference_type m_it = std::numeric_limits<std::ptrdiff_t>::denorm_min();
    };
9096

N
Niels 已提交
9097 9098 9099 9100 9101 9102 9103 9104
    /*!
    @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 已提交
9105 9106
    {
        /// iterator for JSON objects
N
Niels 已提交
9107
        typename object_t::iterator object_iterator;
N
Niels 已提交
9108
        /// iterator for JSON arrays
N
Niels 已提交
9109
        typename array_t::iterator array_iterator;
N
Niels 已提交
9110
        /// generic iterator for all other types
N
Niels 已提交
9111 9112 9113
        primitive_iterator_t primitive_iterator;

        /// create an uninitialized internal_iterator
N
Niels 已提交
9114
        internal_iterator() noexcept
T
Théo DELRIEU 已提交
9115 9116
            : object_iterator(), array_iterator(), primitive_iterator()
        {}
N
Niels 已提交
9117 9118
    };

N
cleanup  
Niels 已提交
9119 9120 9121 9122
    /// proxy class for the iterator_wrapper functions
    template<typename IteratorType>
    class iteration_proxy
    {
T
Théo DELRIEU 已提交
9123
      private:
N
cleanup  
Niels 已提交
9124 9125 9126
        /// helper class for iteration
        class iteration_proxy_internal
        {
T
Théo DELRIEU 已提交
9127
          private:
N
cleanup  
Niels 已提交
9128 9129 9130 9131 9132
            /// the iterator
            IteratorType anchor;
            /// an index for arrays (used to create key names)
            size_t array_index = 0;

T
Théo DELRIEU 已提交
9133
          public:
N
Niels 已提交
9134
            explicit iteration_proxy_internal(IteratorType it) noexcept
T
Théo DELRIEU 已提交
9135 9136
                : anchor(it)
            {}
N
cleanup  
Niels 已提交
9137

T
Théo DELRIEU 已提交
9138 9139 9140 9141 9142
            /// dereference operator (needed for range-based for)
            iteration_proxy_internal& operator*()
            {
                return *this;
            }
9143

T
Théo DELRIEU 已提交
9144 9145 9146 9147 9148
            /// increment operator (needed for range-based for)
            iteration_proxy_internal& operator++()
            {
                ++anchor;
                ++array_index;
9149

T
Théo DELRIEU 已提交
9150 9151
                return *this;
            }
N
cleanup  
Niels 已提交
9152

T
Théo DELRIEU 已提交
9153 9154
            /// inequality operator (needed for range-based for)
            bool operator!= (const iteration_proxy_internal& o) const
N
cleanup  
Niels 已提交
9155
            {
T
Théo DELRIEU 已提交
9156
                return anchor != o.anchor;
N
cleanup  
Niels 已提交
9157 9158
            }

T
Théo DELRIEU 已提交
9159 9160
            /// return key of the iterator
            typename basic_json::string_t key() const
N
cleanup  
Niels 已提交
9161
            {
T
Théo DELRIEU 已提交
9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183
                assert(anchor.m_object != nullptr);

                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 "";
                    }
                }
N
cleanup  
Niels 已提交
9184 9185
            }

T
Théo DELRIEU 已提交
9186 9187
            /// return value of the iterator
            typename IteratorType::reference value() const
N
cleanup  
Niels 已提交
9188
            {
T
Théo DELRIEU 已提交
9189
                return anchor.value();
N
cleanup  
Niels 已提交
9190 9191 9192
            }
        };

T
Théo DELRIEU 已提交
9193 9194
        /// the container to iterate
        typename IteratorType::reference container;
N
cleanup  
Niels 已提交
9195

T
Théo DELRIEU 已提交
9196 9197 9198 9199 9200
      public:
        /// construct iteration proxy from a container
        explicit iteration_proxy(typename IteratorType::reference cont)
            : container(cont)
        {}
N
cleanup  
Niels 已提交
9201

T
Théo DELRIEU 已提交
9202 9203 9204 9205 9206
        /// return iterator begin (needed for range-based for)
        iteration_proxy_internal begin() noexcept
        {
            return iteration_proxy_internal(container.begin());
        }
N
cleanup  
Niels 已提交
9207

T
Théo DELRIEU 已提交
9208 9209 9210 9211 9212 9213
        /// return iterator end (needed for range-based for)
        iteration_proxy_internal end() noexcept
        {
            return iteration_proxy_internal(container.end());
        }
    };
N
cleanup  
Niels 已提交
9214

N
Niels 已提交
9215
  public:
N
Niels 已提交
9216
    /*!
9217
    @brief a template for a random access iterator for the @ref basic_json class
N
Niels 已提交
9218

N
Niels Lohmann 已提交
9219 9220
    This class implements a both iterators (iterator and const_iterator) for the
    @ref basic_json class.
N
Niels 已提交
9221

N
Niels 已提交
9222 9223 9224
    @note An iterator is called *initialized* when a pointer to a JSON value
          has been set (e.g., by a constructor or a copy assignment). If the
          iterator is default-constructed, it is *uninitialized* and most
N
Niels 已提交
9225 9226
          methods are undefined. **The library uses assertions to detect calls
          on uninitialized iterators.**
N
Niels 已提交
9227

N
Niels 已提交
9228 9229 9230 9231
    @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 已提交
9232

N
Niels Lohmann 已提交
9233
    @since version 1.0.0, simplified in version 2.0.9
N
Niels 已提交
9234
    */
N
Niels Lohmann 已提交
9235
    template<typename U>
T
Théo DELRIEU 已提交
9236
    class iter_impl : public std::iterator<std::random_access_iterator_tag, U>
N
Niels 已提交
9237
    {
N
Niels 已提交
9238
        /// allow basic_json to access private members
9239 9240
        friend class basic_json;

9241 9242 9243 9244 9245
        // make sure U is basic_json or const basic_json
        static_assert(std::is_same<U, basic_json>::value
                      or std::is_same<U, const basic_json>::value,
                      "iter_impl only accepts (const) basic_json");

T
Théo DELRIEU 已提交
9246
      public:
N
Niels 已提交
9247
        /// the type of the values when the iterator is dereferenced
N
Niels 已提交
9248
        using value_type = typename basic_json::value_type;
N
Niels 已提交
9249
        /// a type to represent differences between iterators
N
Niels 已提交
9250
        using difference_type = typename basic_json::difference_type;
N
Niels 已提交
9251
        /// defines a pointer to the type iterated over (value_type)
9252
        using pointer = typename std::conditional<std::is_const<U>::value,
T
Théo DELRIEU 已提交
9253 9254
              typename basic_json::const_pointer,
              typename basic_json::pointer>::type;
N
Niels 已提交
9255
        /// defines a reference to the type iterated over (value_type)
9256
        using reference = typename std::conditional<std::is_const<U>::value,
T
Théo DELRIEU 已提交
9257 9258
              typename basic_json::const_reference,
              typename basic_json::reference>::type;
N
Niels 已提交
9259
        /// the category of the iterator
N
Niels 已提交
9260
        using iterator_category = std::bidirectional_iterator_tag;
N
Niels 已提交
9261

9262
        /// default constructor
9263
        iter_impl() = default;
9264

N
Niels 已提交
9265 9266 9267 9268 9269 9270
        /*!
        @brief constructor for a given JSON instance
        @param[in] object  pointer to a JSON object for this iterator
        @pre object != nullptr
        @post The iterator is initialized; i.e. `m_object != nullptr`.
        */
9271
        explicit iter_impl(pointer object) noexcept
T
Théo DELRIEU 已提交
9272
            : m_object(object)
9273
        {
T
Théo DELRIEU 已提交
9274
            assert(m_object != nullptr);
9275

T
Théo DELRIEU 已提交
9276
            switch (m_object->m_type)
9277
            {
T
Théo DELRIEU 已提交
9278 9279 9280 9281 9282
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = typename object_t::iterator();
                    break;
                }
9283

T
Théo DELRIEU 已提交
9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294
                case basic_json::value_t::array:
                {
                    m_it.array_iterator = typename array_t::iterator();
                    break;
                }

                default:
                {
                    m_it.primitive_iterator = primitive_iterator_t();
                    break;
                }
N
Niels 已提交
9295 9296
            }
        }
N
Niels 已提交
9297

T
Théo DELRIEU 已提交
9298 9299 9300 9301
        /*
        Use operator `const_iterator` instead of `const_iterator(const iterator&
        other) noexcept` to avoid two class definitions for @ref iterator and
        @ref const_iterator.
9302

T
Théo DELRIEU 已提交
9303 9304 9305 9306
        This function is only called if this class is an @ref iterator. If this
        class is a @ref const_iterator this function is not called.
        */
        operator const_iterator() const
N
Niels Lohmann 已提交
9307
        {
T
Théo DELRIEU 已提交
9308
            const_iterator ret;
N
Niels 已提交
9309

T
Théo DELRIEU 已提交
9310 9311 9312 9313 9314
            if (m_object)
            {
                ret.m_object = m_object;
                ret.m_it = m_it;
            }
9315

T
Théo DELRIEU 已提交
9316 9317
            return ret;
        }
N
Niels 已提交
9318

T
Théo DELRIEU 已提交
9319 9320 9321 9322 9323 9324 9325 9326
        /*!
        @brief copy constructor
        @param[in] other  iterator to copy from
        @note It is not checked whether @a other is initialized.
        */
        iter_impl(const iter_impl& other) noexcept
            : m_object(other.m_object), m_it(other.m_it)
        {}
N
Niels 已提交
9327

T
Théo DELRIEU 已提交
9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343
        /*!
        @brief copy assignment
        @param[in,out] other  iterator to copy from
        @note It is not checked whether @a other is initialized.
        */
        iter_impl& operator=(iter_impl other) noexcept(
            std::is_nothrow_move_constructible<pointer>::value and
            std::is_nothrow_move_assignable<pointer>::value and
            std::is_nothrow_move_constructible<internal_iterator>::value and
            std::is_nothrow_move_assignable<internal_iterator>::value
        )
        {
            std::swap(m_object, other.m_object);
            std::swap(m_it, other.m_it);
            return *this;
        }
N
Niels 已提交
9344

T
Théo DELRIEU 已提交
9345 9346 9347 9348 9349 9350
      private:
        /*!
        @brief set the iterator to the first value
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        void set_begin() noexcept
N
Niels 已提交
9351
        {
T
Théo DELRIEU 已提交
9352
            assert(m_object != nullptr);
N
Niels 已提交
9353

T
Théo DELRIEU 已提交
9354
            switch (m_object->m_type)
N
Niels 已提交
9355
            {
T
Théo DELRIEU 已提交
9356 9357 9358 9359 9360
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = m_object->m_value.object->begin();
                    break;
                }
N
Niels 已提交
9361

T
Théo DELRIEU 已提交
9362 9363 9364 9365 9366
                case basic_json::value_t::array:
                {
                    m_it.array_iterator = m_object->m_value.array->begin();
                    break;
                }
N
Niels 已提交
9367

T
Théo DELRIEU 已提交
9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379
                case basic_json::value_t::null:
                {
                    // set to end so begin()==end() is true: null is empty
                    m_it.primitive_iterator.set_end();
                    break;
                }

                default:
                {
                    m_it.primitive_iterator.set_begin();
                    break;
                }
N
Niels 已提交
9380 9381 9382
            }
        }

T
Théo DELRIEU 已提交
9383 9384 9385 9386 9387
        /*!
        @brief set the iterator past the last value
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        void set_end() noexcept
9388
        {
T
Théo DELRIEU 已提交
9389
            assert(m_object != nullptr);
N
Niels 已提交
9390

T
Théo DELRIEU 已提交
9391
            switch (m_object->m_type)
9392
            {
T
Théo DELRIEU 已提交
9393 9394 9395 9396 9397
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = m_object->m_value.object->end();
                    break;
                }
N
Niels 已提交
9398

T
Théo DELRIEU 已提交
9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409
                case basic_json::value_t::array:
                {
                    m_it.array_iterator = m_object->m_value.array->end();
                    break;
                }

                default:
                {
                    m_it.primitive_iterator.set_end();
                    break;
                }
N
Niels 已提交
9410 9411
            }
        }
N
Niels 已提交
9412

T
Théo DELRIEU 已提交
9413 9414 9415 9416 9417 9418
      public:
        /*!
        @brief return a reference to the value pointed to by the iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        reference operator*() const
9419
        {
T
Théo DELRIEU 已提交
9420
            assert(m_object != nullptr);
N
Niels 已提交
9421

T
Théo DELRIEU 已提交
9422
            switch (m_object->m_type)
9423
            {
T
Théo DELRIEU 已提交
9424 9425 9426 9427 9428
                case basic_json::value_t::object:
                {
                    assert(m_it.object_iterator != m_object->m_value.object->end());
                    return m_it.object_iterator->second;
                }
N
Niels Lohmann 已提交
9429

T
Théo DELRIEU 已提交
9430 9431 9432 9433 9434
                case basic_json::value_t::array:
                {
                    assert(m_it.array_iterator != m_object->m_value.array->end());
                    return *m_it.array_iterator;
                }
N
Niels 已提交
9435

T
Théo DELRIEU 已提交
9436
                case basic_json::value_t::null:
N
Niels 已提交
9437
                {
9438
                    JSON_THROW(invalid_iterator(214, "cannot get value"));
N
Niels 已提交
9439 9440
                }

T
Théo DELRIEU 已提交
9441 9442 9443 9444 9445 9446 9447
                default:
                {
                    if (m_it.primitive_iterator.is_begin())
                    {
                        return *m_object;
                    }

9448
                    JSON_THROW(invalid_iterator(214, "cannot get value"));
T
Théo DELRIEU 已提交
9449
                }
N
Niels 已提交
9450 9451 9452
            }
        }

T
Théo DELRIEU 已提交
9453 9454 9455 9456 9457
        /*!
        @brief dereference the iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        pointer operator->() const
N
Niels 已提交
9458
        {
T
Théo DELRIEU 已提交
9459
            assert(m_object != nullptr);
N
Niels 已提交
9460

T
Théo DELRIEU 已提交
9461
            switch (m_object->m_type)
N
Niels 已提交
9462
            {
T
Théo DELRIEU 已提交
9463 9464 9465 9466 9467
                case basic_json::value_t::object:
                {
                    assert(m_it.object_iterator != m_object->m_value.object->end());
                    return &(m_it.object_iterator->second);
                }
N
Niels 已提交
9468

T
Théo DELRIEU 已提交
9469
                case basic_json::value_t::array:
N
Niels 已提交
9470
                {
T
Théo DELRIEU 已提交
9471 9472
                    assert(m_it.array_iterator != m_object->m_value.array->end());
                    return &*m_it.array_iterator;
N
Niels 已提交
9473 9474
                }

T
Théo DELRIEU 已提交
9475 9476 9477 9478 9479 9480 9481
                default:
                {
                    if (m_it.primitive_iterator.is_begin())
                    {
                        return m_object;
                    }

9482
                    JSON_THROW(invalid_iterator(214, "cannot get value"));
T
Théo DELRIEU 已提交
9483
                }
N
Niels 已提交
9484 9485 9486
            }
        }

T
Théo DELRIEU 已提交
9487 9488 9489 9490 9491 9492 9493 9494 9495 9496
        /*!
        @brief post-increment (it++)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl operator++(int)
        {
            auto result = *this;
            ++(*this);
            return result;
        }
N
Niels 已提交
9497

T
Théo DELRIEU 已提交
9498 9499 9500 9501 9502
        /*!
        @brief pre-increment (++it)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator++()
9503
        {
T
Théo DELRIEU 已提交
9504
            assert(m_object != nullptr);
N
Niels 已提交
9505

T
Théo DELRIEU 已提交
9506
            switch (m_object->m_type)
9507
            {
T
Théo DELRIEU 已提交
9508 9509 9510 9511 9512
                case basic_json::value_t::object:
                {
                    std::advance(m_it.object_iterator, 1);
                    break;
                }
N
Niels 已提交
9513

T
Théo DELRIEU 已提交
9514 9515 9516 9517 9518
                case basic_json::value_t::array:
                {
                    std::advance(m_it.array_iterator, 1);
                    break;
                }
N
Niels 已提交
9519

T
Théo DELRIEU 已提交
9520 9521 9522 9523 9524 9525
                default:
                {
                    ++m_it.primitive_iterator;
                    break;
                }
            }
9526

T
Théo DELRIEU 已提交
9527 9528
            return *this;
        }
9529

T
Théo DELRIEU 已提交
9530 9531 9532 9533 9534 9535 9536 9537 9538 9539
        /*!
        @brief post-decrement (it--)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl operator--(int)
        {
            auto result = *this;
            --(*this);
            return result;
        }
9540

T
Théo DELRIEU 已提交
9541 9542 9543 9544 9545
        /*!
        @brief pre-decrement (--it)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator--()
N
Niels 已提交
9546
        {
T
Théo DELRIEU 已提交
9547 9548 9549
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
9550
            {
T
Théo DELRIEU 已提交
9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567
                case basic_json::value_t::object:
                {
                    std::advance(m_it.object_iterator, -1);
                    break;
                }

                case basic_json::value_t::array:
                {
                    std::advance(m_it.array_iterator, -1);
                    break;
                }

                default:
                {
                    --m_it.primitive_iterator;
                    break;
                }
N
Niels 已提交
9568 9569
            }

T
Théo DELRIEU 已提交
9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580
            return *this;
        }

        /*!
        @brief  comparison: equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator==(const iter_impl& other) const
        {
            // if objects are not the same, the comparison is undefined
            if (m_object != other.m_object)
N
Niels 已提交
9581
            {
9582
                JSON_THROW(invalid_iterator(212, "cannot compare iterators of different containers"));
9583
            }
N
Niels 已提交
9584

T
Théo DELRIEU 已提交
9585 9586 9587
            assert(m_object != nullptr);

            switch (m_object->m_type)
9588
            {
T
Théo DELRIEU 已提交
9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602
                case basic_json::value_t::object:
                {
                    return (m_it.object_iterator == other.m_it.object_iterator);
                }

                case basic_json::value_t::array:
                {
                    return (m_it.array_iterator == other.m_it.array_iterator);
                }

                default:
                {
                    return (m_it.primitive_iterator == other.m_it.primitive_iterator);
                }
N
Niels 已提交
9603 9604 9605
            }
        }

T
Théo DELRIEU 已提交
9606 9607 9608 9609 9610
        /*!
        @brief  comparison: not equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator!=(const iter_impl& other) const
N
Niels 已提交
9611
        {
T
Théo DELRIEU 已提交
9612
            return not operator==(other);
N
Niels 已提交
9613 9614
        }

T
Théo DELRIEU 已提交
9615 9616 9617 9618 9619
        /*!
        @brief  comparison: smaller
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator<(const iter_impl& other) const
N
Niels 已提交
9620
        {
T
Théo DELRIEU 已提交
9621 9622
            // if objects are not the same, the comparison is undefined
            if (m_object != other.m_object)
N
Niels 已提交
9623
            {
9624
                JSON_THROW(invalid_iterator(212, "cannot compare iterators of different containers"));
N
Niels 已提交
9625 9626
            }

T
Théo DELRIEU 已提交
9627
            assert(m_object != nullptr);
N
Niels 已提交
9628

T
Théo DELRIEU 已提交
9629
            switch (m_object->m_type)
9630
            {
T
Théo DELRIEU 已提交
9631 9632
                case basic_json::value_t::object:
                {
9633
                    JSON_THROW(invalid_iterator(213, "cannot compare order of object iterators"));
T
Théo DELRIEU 已提交
9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644
                }

                case basic_json::value_t::array:
                {
                    return (m_it.array_iterator < other.m_it.array_iterator);
                }

                default:
                {
                    return (m_it.primitive_iterator < other.m_it.primitive_iterator);
                }
N
Niels 已提交
9645 9646 9647
            }
        }

T
Théo DELRIEU 已提交
9648 9649 9650 9651 9652
        /*!
        @brief  comparison: less than or equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator<=(const iter_impl& other) const
N
Niels 已提交
9653
        {
T
Théo DELRIEU 已提交
9654
            return not other.operator < (*this);
N
Niels 已提交
9655 9656
        }

T
Théo DELRIEU 已提交
9657 9658 9659 9660 9661
        /*!
        @brief  comparison: greater than
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator>(const iter_impl& other) const
N
Niels 已提交
9662
        {
T
Théo DELRIEU 已提交
9663
            return not operator<=(other);
N
Niels 已提交
9664
        }
9665

T
Théo DELRIEU 已提交
9666 9667 9668 9669 9670 9671 9672 9673
        /*!
        @brief  comparison: greater than or equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator>=(const iter_impl& other) const
        {
            return not operator<(other);
        }
9674

T
Théo DELRIEU 已提交
9675 9676 9677 9678 9679
        /*!
        @brief  add to iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator+=(difference_type i)
N
Niels 已提交
9680
        {
T
Théo DELRIEU 已提交
9681 9682 9683
            assert(m_object != nullptr);

            switch (m_object->m_type)
9684
            {
T
Théo DELRIEU 已提交
9685 9686
                case basic_json::value_t::object:
                {
9687
                    JSON_THROW(invalid_iterator(209, "cannot use offsets with object iterators"));
T
Théo DELRIEU 已提交
9688
                }
9689

T
Théo DELRIEU 已提交
9690 9691 9692 9693 9694
                case basic_json::value_t::array:
                {
                    std::advance(m_it.array_iterator, i);
                    break;
                }
9695

T
Théo DELRIEU 已提交
9696 9697 9698 9699 9700
                default:
                {
                    m_it.primitive_iterator += i;
                    break;
                }
9701 9702
            }

T
Théo DELRIEU 已提交
9703 9704
            return *this;
        }
9705

T
Théo DELRIEU 已提交
9706 9707 9708 9709 9710 9711 9712 9713
        /*!
        @brief  subtract from iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator-=(difference_type i)
        {
            return operator+=(-i);
        }
9714

T
Théo DELRIEU 已提交
9715 9716 9717 9718 9719 9720 9721 9722 9723 9724
        /*!
        @brief  add to iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl operator+(difference_type i)
        {
            auto result = *this;
            result += i;
            return result;
        }
9725

T
Théo DELRIEU 已提交
9726 9727 9728 9729 9730 9731 9732 9733 9734 9735
        /*!
        @brief  subtract from iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl operator-(difference_type i)
        {
            auto result = *this;
            result -= i;
            return result;
        }
N
Niels 已提交
9736

T
Théo DELRIEU 已提交
9737 9738 9739 9740 9741
        /*!
        @brief  return difference
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        difference_type operator-(const iter_impl& other) const
9742
        {
T
Théo DELRIEU 已提交
9743 9744 9745
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
9746
            {
T
Théo DELRIEU 已提交
9747 9748
                case basic_json::value_t::object:
                {
9749
                    JSON_THROW(invalid_iterator(209, "cannot use offsets with object iterators"));
T
Théo DELRIEU 已提交
9750
                }
N
Niels 已提交
9751

T
Théo DELRIEU 已提交
9752 9753 9754 9755
                case basic_json::value_t::array:
                {
                    return m_it.array_iterator - other.m_it.array_iterator;
                }
N
Niels 已提交
9756

T
Théo DELRIEU 已提交
9757 9758 9759 9760
                default:
                {
                    return m_it.primitive_iterator - other.m_it.primitive_iterator;
                }
N
Niels 已提交
9761 9762
            }
        }
N
Niels 已提交
9763

T
Théo DELRIEU 已提交
9764 9765 9766 9767 9768
        /*!
        @brief  access to successor
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        reference operator[](difference_type n) const
9769
        {
T
Théo DELRIEU 已提交
9770 9771 9772
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
9773
            {
T
Théo DELRIEU 已提交
9774 9775
                case basic_json::value_t::object:
                {
9776
                    JSON_THROW(invalid_iterator(208, "cannot use operator[] for object iterators"));
T
Théo DELRIEU 已提交
9777
                }
N
Niels 已提交
9778

T
Théo DELRIEU 已提交
9779 9780 9781 9782
                case basic_json::value_t::array:
                {
                    return *std::next(m_it.array_iterator, n);
                }
N
Niels 已提交
9783

T
Théo DELRIEU 已提交
9784 9785
                case basic_json::value_t::null:
                {
9786
                    JSON_THROW(invalid_iterator(214, "cannot get value"));
T
Théo DELRIEU 已提交
9787
                }
N
Niels 已提交
9788

T
Théo DELRIEU 已提交
9789
                default:
N
Niels 已提交
9790
                {
T
Théo DELRIEU 已提交
9791 9792 9793 9794
                    if (m_it.primitive_iterator.get_value() == -n)
                    {
                        return *m_object;
                    }
N
Niels Lohmann 已提交
9795

9796
                    JSON_THROW(invalid_iterator(214, "cannot get value"));
T
Théo DELRIEU 已提交
9797
                }
N
Niels 已提交
9798 9799
            }
        }
N
Niels 已提交
9800

T
Théo DELRIEU 已提交
9801 9802 9803 9804 9805
        /*!
        @brief  return the key of an object iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        typename object_t::key_type key() const
9806
        {
T
Théo DELRIEU 已提交
9807 9808 9809 9810 9811 9812
            assert(m_object != nullptr);

            if (m_object->is_object())
            {
                return m_it.object_iterator->first;
            }
N
Niels Lohmann 已提交
9813

9814
            JSON_THROW(invalid_iterator(207, "cannot use key() for non-object iterators"));
T
Théo DELRIEU 已提交
9815
        }
N
Niels 已提交
9816

T
Théo DELRIEU 已提交
9817 9818 9819 9820 9821 9822 9823 9824
        /*!
        @brief  return the value of an iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        reference value() const
        {
            return operator*();
        }
N
Niels 已提交
9825

T
Théo DELRIEU 已提交
9826 9827 9828 9829 9830 9831
      private:
        /// associated JSON instance
        pointer m_object = nullptr;
        /// the actual iterator of the associated instance
        internal_iterator m_it = internal_iterator();
    };
N
Niels 已提交
9832

N
Niels 已提交
9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846
    /*!
    @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 已提交
9847

N
Niels 已提交
9848
    @since version 1.0.0
N
Niels 已提交
9849
    */
N
Niels 已提交
9850
    template<typename Base>
T
Théo DELRIEU 已提交
9851
    class json_reverse_iterator : public std::reverse_iterator<Base>
9852
    {
T
Théo DELRIEU 已提交
9853
      public:
9854
        /// shortcut to the reverse iterator adaptor
N
Niels 已提交
9855
        using base_iterator = std::reverse_iterator<Base>;
N
Niels 已提交
9856
        /// the reference type for the pointed-to element
N
Niels 已提交
9857
        using reference = typename Base::reference;
9858

9859
        /// create reverse iterator from iterator
N
Niels 已提交
9860
        json_reverse_iterator(const typename base_iterator::iterator_type& it) noexcept
T
Théo DELRIEU 已提交
9861 9862
            : base_iterator(it)
        {}
9863

T
Théo DELRIEU 已提交
9864 9865 9866 9867
        /// create reverse iterator from base class
        json_reverse_iterator(const base_iterator& it) noexcept
            : base_iterator(it)
        {}
9868

T
Théo DELRIEU 已提交
9869 9870 9871 9872 9873
        /// post-increment (it++)
        json_reverse_iterator operator++(int)
        {
            return base_iterator::operator++(1);
        }
9874

T
Théo DELRIEU 已提交
9875 9876 9877 9878 9879 9880
        /// pre-increment (++it)
        json_reverse_iterator& operator++()
        {
            base_iterator::operator++();
            return *this;
        }
9881

T
Théo DELRIEU 已提交
9882 9883 9884 9885 9886
        /// post-decrement (it--)
        json_reverse_iterator operator--(int)
        {
            return base_iterator::operator--(1);
        }
9887

T
Théo DELRIEU 已提交
9888 9889 9890 9891 9892 9893
        /// pre-decrement (--it)
        json_reverse_iterator& operator--()
        {
            base_iterator::operator--();
            return *this;
        }
9894

T
Théo DELRIEU 已提交
9895 9896 9897 9898 9899 9900
        /// add to iterator
        json_reverse_iterator& operator+=(difference_type i)
        {
            base_iterator::operator+=(i);
            return *this;
        }
9901

T
Théo DELRIEU 已提交
9902 9903 9904 9905 9906 9907 9908
        /// add to iterator
        json_reverse_iterator operator+(difference_type i) const
        {
            auto result = *this;
            result += i;
            return result;
        }
9909

T
Théo DELRIEU 已提交
9910 9911 9912 9913 9914 9915 9916
        /// subtract from iterator
        json_reverse_iterator operator-(difference_type i) const
        {
            auto result = *this;
            result -= i;
            return result;
        }
9917

T
Théo DELRIEU 已提交
9918 9919 9920 9921 9922
        /// return difference
        difference_type operator-(const json_reverse_iterator& other) const
        {
            return this->base() - other.base();
        }
9923

T
Théo DELRIEU 已提交
9924 9925 9926 9927 9928
        /// access to successor
        reference operator[](difference_type n) const
        {
            return *(this->operator+(n));
        }
N
Niels 已提交
9929

T
Théo DELRIEU 已提交
9930 9931 9932 9933 9934 9935
        /// return the key of an object iterator
        typename object_t::key_type key() const
        {
            auto it = --this->base();
            return it.key();
        }
9936

T
Théo DELRIEU 已提交
9937 9938 9939 9940 9941 9942 9943
        /// return the value of an iterator
        reference value() const
        {
            auto it = --this->base();
            return it.operator * ();
        }
    };
9944

N
Niels 已提交
9945

N
Niels 已提交
9946
  private:
N
Niels 已提交
9947 9948 9949
    //////////////////////
    // lexer and parser //
    //////////////////////
N
Niels 已提交
9950

N
Niels 已提交
9951 9952 9953 9954
    /*!
    @brief lexical analysis

    This class organizes the lexical analysis during JSON deserialization. The
N
Niels 已提交
9955 9956
    core of it is a scanner generated by [re2c](http://re2c.org) that
    processes a buffer and recognizes tokens according to RFC 7159.
N
Niels 已提交
9957
    */
N
Niels 已提交
9958
    class lexer
N
Niels 已提交
9959
    {
T
Théo DELRIEU 已提交
9960
      public:
N
Niels 已提交
9961 9962
        /// token types for the parser
        enum class token_type
T
Théo DELRIEU 已提交
9963 9964 9965 9966 9967 9968
        {
            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
N
Niels Lohmann 已提交
9969 9970
            value_unsigned,  ///< an unsigned integer -- use get_number() for actual value
            value_integer,   ///< a signed integer -- use get_number() for actual value
9971
            value_float,     ///< an floating point number -- use get_number() for actual value
T
Théo DELRIEU 已提交
9972 9973 9974 9975 9976 9977 9978 9979 9980
            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 已提交
9981

T
Théo DELRIEU 已提交
9982 9983
        /// the char type to use in the lexer
        using lexer_char_t = unsigned char;
N
Niels 已提交
9984

T
Théo DELRIEU 已提交
9985 9986 9987 9988 9989 9990 9991 9992
        /// a lexer from a buffer with given length
        lexer(const lexer_char_t* buff, const size_t len) noexcept
            : m_content(buff)
        {
            assert(m_content != nullptr);
            m_start = m_cursor = m_content;
            m_limit = m_content + len;
        }
N
Niels 已提交
9993

N
Niels Lohmann 已提交
9994 9995 9996 9997
        /*!
        @brief a lexer from an input stream
        @throw parse_error.111 if input stream is in a bad state
        */
T
Théo DELRIEU 已提交
9998 9999
        explicit lexer(std::istream& s)
            : m_stream(&s), m_line_buffer()
N
Niels 已提交
10000
        {
T
Théo DELRIEU 已提交
10001 10002 10003
            // immediately abort if stream is erroneous
            if (s.fail())
            {
10004
                JSON_THROW(parse_error(111, 0, "bad input stream"));
T
Théo DELRIEU 已提交
10005
            }
N
Niels 已提交
10006

T
Théo DELRIEU 已提交
10007 10008
            // fill buffer
            fill_line_buffer();
N
Niels 已提交
10009

T
Théo DELRIEU 已提交
10010 10011 10012 10013 10014 10015 10016
            // skip UTF-8 byte-order mark
            if (m_line_buffer.size() >= 3 and m_line_buffer.substr(0, 3) == "\xEF\xBB\xBF")
            {
                m_line_buffer[0] = ' ';
                m_line_buffer[1] = ' ';
                m_line_buffer[2] = ' ';
            }
10017
        }
N
Niels 已提交
10018

T
Théo DELRIEU 已提交
10019 10020 10021 10022
        // switch off unwanted functions (due to pointer members)
        lexer() = delete;
        lexer(const lexer&) = delete;
        lexer operator=(const lexer&) = delete;
N
Niels 已提交
10023

T
Théo DELRIEU 已提交
10024 10025
        /*!
        @brief create a string from one or two Unicode code points
N
Niels 已提交
10026

T
Théo DELRIEU 已提交
10027 10028 10029 10030
        There are two cases: (1) @a codepoint1 is in the Basic Multilingual
        Plane (U+0000 through U+FFFF) and @a codepoint2 is 0, or (2)
        @a codepoint1 and @a codepoint2 are a UTF-16 surrogate pair to
        represent a code point above U+FFFF.
N
Niels 已提交
10031

T
Théo DELRIEU 已提交
10032 10033
        @param[in] codepoint1  the code point (can be high surrogate)
        @param[in] codepoint2  the code point (can be low surrogate or 0)
N
Niels 已提交
10034

T
Théo DELRIEU 已提交
10035 10036
        @return string representation of the code point; the length of the
        result string is between 1 and 4 characters.
N
Niels 已提交
10037

10038
        @throw parse_error.102 if the low surrogate is invalid; example:
T
Théo DELRIEU 已提交
10039
        `""missing or wrong low surrogate""`
10040 10041
        @throw parse_error.103 if code point is > 0x10ffff; example: `"code
        points above 0x10FFFF are invalid"`
N
Niels 已提交
10042

T
Théo DELRIEU 已提交
10043
        @complexity Constant.
N
Niels 已提交
10044

T
Théo DELRIEU 已提交
10045 10046
        @see <http://en.wikipedia.org/wiki/UTF-8#Sample_code>
        */
10047 10048
        string_t to_unicode(const std::size_t codepoint1,
                            const std::size_t codepoint2 = 0) const
10049
        {
T
Théo DELRIEU 已提交
10050 10051 10052 10053 10054
            // calculate the code point from the given code points
            std::size_t codepoint = codepoint1;

            // check if codepoint1 is a high surrogate
            if (codepoint1 >= 0xD800 and codepoint1 <= 0xDBFF)
N
Niels 已提交
10055
            {
T
Théo DELRIEU 已提交
10056 10057 10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070
                // check if codepoint2 is a low surrogate
                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
                        // in the result so we have to subtract with:
                        // (0xD800 << 10) + DC00 - 0x10000 = 0x35FDC00
                        - 0x35FDC00;
                }
                else
                {
10071
                    JSON_THROW(parse_error(102, get_position(), "missing or wrong low surrogate"));
T
Théo DELRIEU 已提交
10072
                }
N
Niels 已提交
10073 10074
            }

T
Théo DELRIEU 已提交
10075
            string_t result;
10076

T
Théo DELRIEU 已提交
10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104
            if (codepoint < 0x80)
            {
                // 1-byte characters: 0xxxxxxx (ASCII)
                result.append(1, static_cast<typename string_t::value_type>(codepoint));
            }
            else if (codepoint <= 0x7ff)
            {
                // 2-byte characters: 110xxxxx 10xxxxxx
                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)));
            }
            else if (codepoint <= 0xffff)
            {
                // 3-byte characters: 1110xxxx 10xxxxxx 10xxxxxx
                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)));
            }
            else if (codepoint <= 0x10ffff)
            {
                // 4-byte characters: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
                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)));
            }
            else
            {
10105
                JSON_THROW(parse_error(103, get_position(), "code points above 0x10FFFF are invalid"));
T
Théo DELRIEU 已提交
10106
            }
10107

T
Théo DELRIEU 已提交
10108 10109
            return result;
        }
10110

T
Théo DELRIEU 已提交
10111 10112 10113 10114
        /// return name of values of type token_type (only used for errors)
        static std::string token_type_name(const token_type t)
        {
            switch (t)
N
cleanup  
Niels 已提交
10115
            {
T
Théo DELRIEU 已提交
10116 10117 10118 10119 10120 10121 10122 10123 10124 10125
                case token_type::uninitialized:
                    return "<uninitialized>";
                case token_type::literal_true:
                    return "true literal";
                case token_type::literal_false:
                    return "false literal";
                case token_type::literal_null:
                    return "null literal";
                case token_type::value_string:
                    return "string literal";
N
Niels Lohmann 已提交
10126 10127
                case lexer::token_type::value_unsigned:
                case lexer::token_type::value_integer:
10128
                case lexer::token_type::value_float:
T
Théo DELRIEU 已提交
10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150
                    return "number literal";
                case token_type::begin_array:
                    return "'['";
                case token_type::begin_object:
                    return "'{'";
                case token_type::end_array:
                    return "']'";
                case token_type::end_object:
                    return "'}'";
                case token_type::name_separator:
                    return "':'";
                case token_type::value_separator:
                    return "','";
                case token_type::parse_error:
                    return "<parse error>";
                case token_type::end_of_input:
                    return "end of input";
                default:
                {
                    // catch non-enum values
                    return "unknown token"; // LCOV_EXCL_LINE
                }
N
cleanup  
Niels 已提交
10151 10152 10153
            }
        }

T
Théo DELRIEU 已提交
10154 10155 10156 10157 10158 10159 10160
        /*!
        This function implements a scanner for JSON. It is specified using
        regular expressions that try to follow RFC 7159 as close as possible.
        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 已提交
10161

T
Théo DELRIEU 已提交
10162
        @return the class of the next token read from the buffer
N
Niels 已提交
10163

T
Théo DELRIEU 已提交
10164
        @complexity Linear in the length of the input.\n
N
Niels 已提交
10165

T
Théo DELRIEU 已提交
10166
        Proposition: The loop below will always terminate for finite input.\n
N
Niels 已提交
10167

T
Théo DELRIEU 已提交
10168 10169 10170 10171 10172 10173 10174 10175
        Proof (by contradiction): Assume a finite input. To loop forever, the
        loop must never hit code with a `break` statement. The only code
        snippets without a `break` statement are the continue statements for
        whitespace and byte-order-marks. To loop forever, the input must be an
        infinite sequence of whitespace or byte-order-marks. This contradicts
        the assumption of finite input, q.e.d.
        */
        token_type scan()
N
Niels 已提交
10176
        {
T
Théo DELRIEU 已提交
10177 10178 10179 10180
            while (true)
            {
                // pointer for backtracking information
                m_marker = nullptr;
N
Niels 已提交
10181

T
Théo DELRIEU 已提交
10182 10183 10184
                // remember the begin of the token
                m_start = m_cursor;
                assert(m_start != nullptr);
N
Niels 已提交
10185

10186 10187 10188 10189 10190 10191 10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339

                {
                    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,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        160, 128,   0, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        192, 192, 192, 192, 192, 192, 192, 192,
                        192, 192, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128,   0, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                    };
                    if ((m_limit - m_cursor) < 5)
                    {
                        fill_line_buffer(5);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yybm[0 + yych] & 32)
                    {
                        goto basic_json_parser_6;
                    }
                    if (yych <= '[')
                    {
                        if (yych <= '-')
                        {
                            if (yych <= '"')
                            {
                                if (yych <= 0x00)
                                {
                                    goto basic_json_parser_2;
                                }
                                if (yych <= '!')
                                {
                                    goto basic_json_parser_4;
                                }
                                goto basic_json_parser_9;
                            }
                            else
                            {
                                if (yych <= '+')
                                {
                                    goto basic_json_parser_4;
                                }
                                if (yych <= ',')
                                {
                                    goto basic_json_parser_10;
                                }
                                goto basic_json_parser_12;
                            }
                        }
                        else
                        {
                            if (yych <= '9')
                            {
                                if (yych <= '/')
                                {
                                    goto basic_json_parser_4;
                                }
                                if (yych <= '0')
                                {
                                    goto basic_json_parser_13;
                                }
                                goto basic_json_parser_15;
                            }
                            else
                            {
                                if (yych <= ':')
                                {
                                    goto basic_json_parser_17;
                                }
                                if (yych <= 'Z')
                                {
                                    goto basic_json_parser_4;
                                }
                                goto basic_json_parser_19;
                            }
                        }
                    }
                    else
                    {
                        if (yych <= 'n')
                        {
                            if (yych <= 'e')
                            {
                                if (yych == ']')
                                {
                                    goto basic_json_parser_21;
                                }
                                goto basic_json_parser_4;
                            }
                            else
                            {
                                if (yych <= 'f')
                                {
                                    goto basic_json_parser_23;
                                }
                                if (yych <= 'm')
                                {
                                    goto basic_json_parser_4;
                                }
                                goto basic_json_parser_24;
                            }
                        }
                        else
                        {
                            if (yych <= 'z')
                            {
                                if (yych == 't')
                                {
                                    goto basic_json_parser_25;
                                }
                                goto basic_json_parser_4;
                            }
                            else
                            {
                                if (yych <= '{')
                                {
                                    goto basic_json_parser_26;
                                }
                                if (yych == '}')
                                {
                                    goto basic_json_parser_28;
                                }
                                goto basic_json_parser_4;
                            }
                        }
                    }
10340
basic_json_parser_2:
10341 10342 10343 10344 10345
                    ++m_cursor;
                    {
                        last_token_type = token_type::end_of_input;
                        break;
                    }
N
Niels 已提交
10346
basic_json_parser_4:
10347
                    ++m_cursor;
N
Niels 已提交
10348
basic_json_parser_5:
10349 10350 10351 10352
                    {
                        last_token_type = token_type::parse_error;
                        break;
                    }
N
Niels 已提交
10353
basic_json_parser_6:
10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yybm[0 + yych] & 32)
                    {
                        goto basic_json_parser_6;
                    }
                    {
10365
                        position += static_cast<size_t>((m_cursor - m_start));
10366 10367
                        continue;
                    }
N
Niels 已提交
10368
basic_json_parser_9:
10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387
                    yyaccept = 0;
                    yych = *(m_marker = ++m_cursor);
                    if (yych <= 0x1F)
                    {
                        goto basic_json_parser_5;
                    }
                    if (yych <= 0x7F)
                    {
                        goto basic_json_parser_31;
                    }
                    if (yych <= 0xC1)
                    {
                        goto basic_json_parser_5;
                    }
                    if (yych <= 0xF4)
                    {
                        goto basic_json_parser_31;
                    }
                    goto basic_json_parser_5;
10388
basic_json_parser_10:
10389 10390 10391 10392 10393
                    ++m_cursor;
                    {
                        last_token_type = token_type::value_separator;
                        break;
                    }
10394
basic_json_parser_12:
10395 10396 10397 10398 10399 10400 10401
                    yych = *++m_cursor;
                    if (yych <= '/')
                    {
                        goto basic_json_parser_5;
                    }
                    if (yych <= '0')
                    {
10402
                        goto basic_json_parser_43;
10403 10404 10405
                    }
                    if (yych <= '9')
                    {
10406
                        goto basic_json_parser_45;
10407 10408
                    }
                    goto basic_json_parser_5;
10409
basic_json_parser_13:
10410 10411
                    yyaccept = 1;
                    yych = *(m_marker = ++m_cursor);
N
Niels Lohmann 已提交
10412
                    if (yych <= '9')
10413 10414 10415
                    {
                        if (yych == '.')
                        {
10416
                            goto basic_json_parser_47;
10417
                        }
N
Niels Lohmann 已提交
10418 10419 10420 10421
                        if (yych >= '0')
                        {
                            goto basic_json_parser_48;
                        }
10422 10423 10424 10425 10426
                    }
                    else
                    {
                        if (yych <= 'E')
                        {
N
Niels Lohmann 已提交
10427 10428 10429 10430
                            if (yych >= 'E')
                            {
                                goto basic_json_parser_51;
                            }
10431
                        }
N
Niels Lohmann 已提交
10432
                        else
10433
                        {
N
Niels Lohmann 已提交
10434 10435 10436 10437
                            if (yych == 'e')
                            {
                                goto basic_json_parser_51;
                            }
10438 10439
                        }
                    }
10440
basic_json_parser_14:
10441
                    {
N
Niels Lohmann 已提交
10442
                        last_token_type = token_type::value_unsigned;
10443 10444
                        break;
                    }
10445
basic_json_parser_15:
10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460
                    yyaccept = 1;
                    m_marker = ++m_cursor;
                    if ((m_limit - m_cursor) < 3)
                    {
                        fill_line_buffer(3);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yybm[0 + yych] & 64)
                    {
                        goto basic_json_parser_15;
                    }
                    if (yych <= 'D')
                    {
                        if (yych == '.')
                        {
10461
                            goto basic_json_parser_47;
10462 10463 10464 10465 10466 10467 10468
                        }
                        goto basic_json_parser_14;
                    }
                    else
                    {
                        if (yych <= 'E')
                        {
N
Niels Lohmann 已提交
10469
                            goto basic_json_parser_51;
10470 10471 10472
                        }
                        if (yych == 'e')
                        {
N
Niels Lohmann 已提交
10473
                            goto basic_json_parser_51;
10474 10475 10476
                        }
                        goto basic_json_parser_14;
                    }
10477
basic_json_parser_17:
10478 10479 10480 10481 10482
                    ++m_cursor;
                    {
                        last_token_type = token_type::name_separator;
                        break;
                    }
10483
basic_json_parser_19:
10484 10485 10486 10487 10488
                    ++m_cursor;
                    {
                        last_token_type = token_type::begin_array;
                        break;
                    }
10489
basic_json_parser_21:
10490 10491 10492 10493 10494
                    ++m_cursor;
                    {
                        last_token_type = token_type::end_array;
                        break;
                    }
10495
basic_json_parser_23:
10496 10497 10498 10499
                    yyaccept = 0;
                    yych = *(m_marker = ++m_cursor);
                    if (yych == 'a')
                    {
N
Niels Lohmann 已提交
10500
                        goto basic_json_parser_52;
10501 10502
                    }
                    goto basic_json_parser_5;
10503
basic_json_parser_24:
10504 10505 10506 10507
                    yyaccept = 0;
                    yych = *(m_marker = ++m_cursor);
                    if (yych == 'u')
                    {
N
Niels Lohmann 已提交
10508
                        goto basic_json_parser_53;
10509 10510
                    }
                    goto basic_json_parser_5;
10511
basic_json_parser_25:
10512 10513 10514 10515
                    yyaccept = 0;
                    yych = *(m_marker = ++m_cursor);
                    if (yych == 'r')
                    {
N
Niels Lohmann 已提交
10516
                        goto basic_json_parser_54;
10517 10518
                    }
                    goto basic_json_parser_5;
10519
basic_json_parser_26:
10520 10521 10522 10523 10524
                    ++m_cursor;
                    {
                        last_token_type = token_type::begin_object;
                        break;
                    }
10525
basic_json_parser_28:
10526 10527 10528 10529 10530
                    ++m_cursor;
                    {
                        last_token_type = token_type::end_object;
                        break;
                    }
10531
basic_json_parser_30:
10532 10533 10534 10535 10536 10537
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
10538
basic_json_parser_31:
10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595
                    if (yybm[0 + yych] & 128)
                    {
                        goto basic_json_parser_30;
                    }
                    if (yych <= 0xE0)
                    {
                        if (yych <= '\\')
                        {
                            if (yych <= 0x1F)
                            {
                                goto basic_json_parser_32;
                            }
                            if (yych <= '"')
                            {
                                goto basic_json_parser_33;
                            }
                            goto basic_json_parser_35;
                        }
                        else
                        {
                            if (yych <= 0xC1)
                            {
                                goto basic_json_parser_32;
                            }
                            if (yych <= 0xDF)
                            {
                                goto basic_json_parser_36;
                            }
                            goto basic_json_parser_37;
                        }
                    }
                    else
                    {
                        if (yych <= 0xEF)
                        {
                            if (yych == 0xED)
                            {
                                goto basic_json_parser_39;
                            }
                            goto basic_json_parser_38;
                        }
                        else
                        {
                            if (yych <= 0xF0)
                            {
                                goto basic_json_parser_40;
                            }
                            if (yych <= 0xF3)
                            {
                                goto basic_json_parser_41;
                            }
                            if (yych <= 0xF4)
                            {
                                goto basic_json_parser_42;
                            }
                        }
                    }
10596
basic_json_parser_32:
10597
                    m_cursor = m_marker;
10598
                    if (yyaccept <= 1)
10599
                    {
10600 10601 10602 10603 10604 10605 10606 10607
                        if (yyaccept == 0)
                        {
                            goto basic_json_parser_5;
                        }
                        else
                        {
                            goto basic_json_parser_14;
                        }
10608 10609 10610
                    }
                    else
                    {
10611 10612 10613 10614 10615 10616
                        if (yyaccept == 2)
                        {
                            goto basic_json_parser_44;
                        }
                        else
                        {
N
Niels Lohmann 已提交
10617
                            goto basic_json_parser_58;
10618
                        }
10619
                    }
10620
basic_json_parser_33:
10621 10622 10623 10624 10625
                    ++m_cursor;
                    {
                        last_token_type = token_type::value_string;
                        break;
                    }
10626
basic_json_parser_35:
10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= 'e')
                    {
                        if (yych <= '/')
                        {
                            if (yych == '"')
                            {
                                goto basic_json_parser_30;
                            }
                            if (yych <= '.')
                            {
                                goto basic_json_parser_32;
                            }
                            goto basic_json_parser_30;
                        }
                        else
                        {
                            if (yych <= '\\')
                            {
                                if (yych <= '[')
                                {
                                    goto basic_json_parser_32;
                                }
                                goto basic_json_parser_30;
                            }
                            else
                            {
                                if (yych == 'b')
                                {
                                    goto basic_json_parser_30;
                                }
                                goto basic_json_parser_32;
                            }
                        }
                    }
                    else
                    {
                        if (yych <= 'q')
                        {
                            if (yych <= 'f')
                            {
                                goto basic_json_parser_30;
                            }
                            if (yych == 'n')
                            {
                                goto basic_json_parser_30;
                            }
                            goto basic_json_parser_32;
                        }
                        else
                        {
                            if (yych <= 's')
                            {
                                if (yych <= 'r')
                                {
                                    goto basic_json_parser_30;
                                }
                                goto basic_json_parser_32;
                            }
                            else
                            {
                                if (yych <= 't')
                                {
                                    goto basic_json_parser_30;
                                }
                                if (yych <= 'u')
                                {
N
Niels Lohmann 已提交
10699
                                    goto basic_json_parser_55;
10700 10701 10702 10703 10704
                                }
                                goto basic_json_parser_32;
                            }
                        }
                    }
10705
basic_json_parser_36:
10706 10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= 0x7F)
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= 0xBF)
                    {
                        goto basic_json_parser_30;
                    }
                    goto basic_json_parser_32;
10721
basic_json_parser_37:
10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= 0x9F)
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= 0xBF)
                    {
                        goto basic_json_parser_36;
                    }
                    goto basic_json_parser_32;
10737
basic_json_parser_38:
10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= 0x7F)
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= 0xBF)
                    {
                        goto basic_json_parser_36;
                    }
                    goto basic_json_parser_32;
N
Niels 已提交
10753
basic_json_parser_39:
10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764 10765 10766 10767 10768
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= 0x7F)
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= 0x9F)
                    {
                        goto basic_json_parser_36;
                    }
                    goto basic_json_parser_32;
N
Niels 已提交
10769
basic_json_parser_40:
10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783 10784
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= 0x8F)
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= 0xBF)
                    {
                        goto basic_json_parser_38;
                    }
                    goto basic_json_parser_32;
N
Niels 已提交
10785
basic_json_parser_41:
10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= 0x7F)
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= 0xBF)
                    {
                        goto basic_json_parser_38;
                    }
                    goto basic_json_parser_32;
N
Niels 已提交
10801
basic_json_parser_42:
10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= 0x7F)
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= 0x8F)
                    {
                        goto basic_json_parser_38;
                    }
                    goto basic_json_parser_32;
N
Niels 已提交
10817
basic_json_parser_43:
10818 10819
                    yyaccept = 2;
                    yych = *(m_marker = ++m_cursor);
N
Niels Lohmann 已提交
10820
                    if (yych <= '9')
10821 10822 10823 10824 10825
                    {
                        if (yych == '.')
                        {
                            goto basic_json_parser_47;
                        }
N
Niels Lohmann 已提交
10826 10827 10828 10829
                        if (yych >= '0')
                        {
                            goto basic_json_parser_48;
                        }
10830 10831 10832 10833 10834
                    }
                    else
                    {
                        if (yych <= 'E')
                        {
N
Niels Lohmann 已提交
10835 10836 10837 10838
                            if (yych >= 'E')
                            {
                                goto basic_json_parser_51;
                            }
10839
                        }
N
Niels Lohmann 已提交
10840
                        else
10841
                        {
N
Niels Lohmann 已提交
10842 10843 10844 10845
                            if (yych == 'e')
                            {
                                goto basic_json_parser_51;
                            }
10846 10847 10848 10849
                        }
                    }
basic_json_parser_44:
                    {
N
Niels Lohmann 已提交
10850
                        last_token_type = token_type::value_integer;
10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880
                        break;
                    }
basic_json_parser_45:
                    yyaccept = 2;
                    m_marker = ++m_cursor;
                    if ((m_limit - m_cursor) < 3)
                    {
                        fill_line_buffer(3);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= '9')
                    {
                        if (yych == '.')
                        {
                            goto basic_json_parser_47;
                        }
                        if (yych <= '/')
                        {
                            goto basic_json_parser_44;
                        }
                        goto basic_json_parser_45;
                    }
                    else
                    {
                        if (yych <= 'E')
                        {
                            if (yych <= 'D')
                            {
                                goto basic_json_parser_44;
                            }
N
Niels Lohmann 已提交
10881
                            goto basic_json_parser_51;
10882 10883 10884 10885 10886
                        }
                        else
                        {
                            if (yych == 'e')
                            {
N
Niels Lohmann 已提交
10887
                                goto basic_json_parser_51;
10888 10889 10890 10891 10892
                            }
                            goto basic_json_parser_44;
                        }
                    }
basic_json_parser_47:
10893 10894 10895 10896 10897 10898 10899
                    yych = *++m_cursor;
                    if (yych <= '/')
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= '9')
                    {
N
Niels Lohmann 已提交
10900
                        goto basic_json_parser_56;
10901 10902
                    }
                    goto basic_json_parser_32;
10903
basic_json_parser_48:
N
Niels Lohmann 已提交
10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= '/')
                    {
                        goto basic_json_parser_50;
                    }
                    if (yych <= '9')
                    {
                        goto basic_json_parser_48;
                    }
basic_json_parser_50:
                    {
                        last_token_type = token_type::parse_error;
                        break;
                    }
basic_json_parser_51:
10924 10925 10926 10927 10928
                    yych = *++m_cursor;
                    if (yych <= ',')
                    {
                        if (yych == '+')
                        {
N
Niels Lohmann 已提交
10929
                            goto basic_json_parser_59;
10930 10931 10932 10933 10934 10935 10936
                        }
                        goto basic_json_parser_32;
                    }
                    else
                    {
                        if (yych <= '-')
                        {
N
Niels Lohmann 已提交
10937
                            goto basic_json_parser_59;
10938 10939 10940 10941 10942 10943 10944
                        }
                        if (yych <= '/')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= '9')
                        {
N
Niels Lohmann 已提交
10945
                            goto basic_json_parser_60;
10946 10947 10948
                        }
                        goto basic_json_parser_32;
                    }
N
Niels Lohmann 已提交
10949
basic_json_parser_52:
10950 10951 10952
                    yych = *++m_cursor;
                    if (yych == 'l')
                    {
N
Niels Lohmann 已提交
10953
                        goto basic_json_parser_62;
10954 10955
                    }
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10956
basic_json_parser_53:
10957 10958 10959
                    yych = *++m_cursor;
                    if (yych == 'l')
                    {
N
Niels Lohmann 已提交
10960
                        goto basic_json_parser_63;
10961 10962
                    }
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10963
basic_json_parser_54:
10964 10965 10966
                    yych = *++m_cursor;
                    if (yych == 'u')
                    {
N
Niels Lohmann 已提交
10967
                        goto basic_json_parser_64;
10968 10969
                    }
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10970
basic_json_parser_55:
10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= '@')
                    {
                        if (yych <= '/')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= '9')
                        {
N
Niels Lohmann 已提交
10985
                            goto basic_json_parser_65;
10986 10987 10988 10989 10990 10991 10992
                        }
                        goto basic_json_parser_32;
                    }
                    else
                    {
                        if (yych <= 'F')
                        {
N
Niels Lohmann 已提交
10993
                            goto basic_json_parser_65;
10994 10995 10996 10997 10998 10999 11000
                        }
                        if (yych <= '`')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= 'f')
                        {
N
Niels Lohmann 已提交
11001
                            goto basic_json_parser_65;
11002 11003 11004
                        }
                        goto basic_json_parser_32;
                    }
N
Niels Lohmann 已提交
11005
basic_json_parser_56:
11006
                    yyaccept = 3;
11007 11008 11009 11010 11011 11012 11013 11014 11015 11016
                    m_marker = ++m_cursor;
                    if ((m_limit - m_cursor) < 3)
                    {
                        fill_line_buffer(3);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= 'D')
                    {
                        if (yych <= '/')
                        {
N
Niels Lohmann 已提交
11017
                            goto basic_json_parser_58;
11018 11019 11020
                        }
                        if (yych <= '9')
                        {
N
Niels Lohmann 已提交
11021
                            goto basic_json_parser_56;
11022 11023 11024 11025 11026 11027
                        }
                    }
                    else
                    {
                        if (yych <= 'E')
                        {
N
Niels Lohmann 已提交
11028
                            goto basic_json_parser_51;
11029 11030 11031
                        }
                        if (yych == 'e')
                        {
N
Niels Lohmann 已提交
11032
                            goto basic_json_parser_51;
11033 11034
                        }
                    }
N
Niels Lohmann 已提交
11035
basic_json_parser_58:
11036 11037 11038 11039
                    {
                        last_token_type = token_type::value_float;
                        break;
                    }
N
Niels Lohmann 已提交
11040
basic_json_parser_59:
11041 11042 11043 11044 11045 11046 11047 11048 11049
                    yych = *++m_cursor;
                    if (yych <= '/')
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych >= ':')
                    {
                        goto basic_json_parser_32;
                    }
N
Niels Lohmann 已提交
11050
basic_json_parser_60:
11051 11052 11053 11054 11055 11056 11057 11058
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= '/')
                    {
N
Niels Lohmann 已提交
11059
                        goto basic_json_parser_58;
11060 11061 11062
                    }
                    if (yych <= '9')
                    {
N
Niels Lohmann 已提交
11063
                        goto basic_json_parser_60;
11064
                    }
N
Niels Lohmann 已提交
11065 11066
                    goto basic_json_parser_58;
basic_json_parser_62:
11067 11068 11069
                    yych = *++m_cursor;
                    if (yych == 's')
                    {
N
Niels Lohmann 已提交
11070
                        goto basic_json_parser_66;
11071 11072
                    }
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
11073
basic_json_parser_63:
11074 11075 11076
                    yych = *++m_cursor;
                    if (yych == 'l')
                    {
N
Niels Lohmann 已提交
11077
                        goto basic_json_parser_67;
11078 11079
                    }
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
11080
basic_json_parser_64:
11081 11082 11083
                    yych = *++m_cursor;
                    if (yych == 'e')
                    {
N
Niels Lohmann 已提交
11084
                        goto basic_json_parser_69;
11085 11086
                    }
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
11087
basic_json_parser_65:
11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= '@')
                    {
                        if (yych <= '/')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= '9')
                        {
N
Niels Lohmann 已提交
11102
                            goto basic_json_parser_71;
11103 11104 11105 11106 11107 11108 11109
                        }
                        goto basic_json_parser_32;
                    }
                    else
                    {
                        if (yych <= 'F')
                        {
N
Niels Lohmann 已提交
11110
                            goto basic_json_parser_71;
11111 11112 11113 11114 11115 11116 11117
                        }
                        if (yych <= '`')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= 'f')
                        {
N
Niels Lohmann 已提交
11118
                            goto basic_json_parser_71;
11119 11120 11121
                        }
                        goto basic_json_parser_32;
                    }
N
Niels Lohmann 已提交
11122
basic_json_parser_66:
11123 11124 11125
                    yych = *++m_cursor;
                    if (yych == 'e')
                    {
N
Niels Lohmann 已提交
11126
                        goto basic_json_parser_72;
11127 11128
                    }
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
11129
basic_json_parser_67:
11130 11131 11132 11133 11134
                    ++m_cursor;
                    {
                        last_token_type = token_type::literal_null;
                        break;
                    }
N
Niels Lohmann 已提交
11135
basic_json_parser_69:
11136 11137 11138 11139 11140
                    ++m_cursor;
                    {
                        last_token_type = token_type::literal_true;
                        break;
                    }
N
Niels Lohmann 已提交
11141
basic_json_parser_71:
11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= '@')
                    {
                        if (yych <= '/')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= '9')
                        {
N
Niels Lohmann 已提交
11156
                            goto basic_json_parser_74;
11157 11158 11159 11160 11161 11162 11163
                        }
                        goto basic_json_parser_32;
                    }
                    else
                    {
                        if (yych <= 'F')
                        {
N
Niels Lohmann 已提交
11164
                            goto basic_json_parser_74;
11165 11166 11167 11168 11169 11170 11171
                        }
                        if (yych <= '`')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= 'f')
                        {
N
Niels Lohmann 已提交
11172
                            goto basic_json_parser_74;
11173 11174 11175
                        }
                        goto basic_json_parser_32;
                    }
N
Niels Lohmann 已提交
11176
basic_json_parser_72:
11177 11178 11179 11180 11181
                    ++m_cursor;
                    {
                        last_token_type = token_type::literal_false;
                        break;
                    }
N
Niels Lohmann 已提交
11182
basic_json_parser_74:
11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210 11211 11212 11213 11214 11215 11216 11217
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= '@')
                    {
                        if (yych <= '/')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= '9')
                        {
                            goto basic_json_parser_30;
                        }
                        goto basic_json_parser_32;
                    }
                    else
                    {
                        if (yych <= 'F')
                        {
                            goto basic_json_parser_30;
                        }
                        if (yych <= '`')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= 'f')
                        {
                            goto basic_json_parser_30;
                        }
                        goto basic_json_parser_32;
                    }
                }
11218

T
Théo DELRIEU 已提交
11219
            }
11220

11221
            position += static_cast<size_t>((m_cursor - m_start));
T
Théo DELRIEU 已提交
11222 11223
            return last_token_type;
        }
11224

T
Théo DELRIEU 已提交
11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257
        /*!
        @brief append data from the stream to the line buffer

        This function is called by the scan() function when the end of the
        buffer (`m_limit`) is reached and the `m_cursor` pointer cannot be
        incremented without leaving the limits of the line buffer. Note re2c
        decides when to call this function.

        If the lexer reads from contiguous storage, there is no trailing null
        byte. Therefore, this function must make sure to add these padding
        null bytes.

        If the lexer reads from an input stream, this function reads the next
        line of the input.

        @pre
            p p p p p p u u u u u x . . . . . .
            ^           ^       ^   ^
            m_content   m_start |   m_limit
                                m_cursor

        @post
            u u u u u x x x x x x x . . . . . .
            ^       ^               ^
            |       m_cursor        m_limit
            m_start
            m_content
        */
        void fill_line_buffer(size_t n = 0)
        {
            // if line buffer is used, m_content points to its data
            assert(m_line_buffer.empty()
                   or m_content == reinterpret_cast<const lexer_char_t*>(m_line_buffer.data()));
N
Niels Lohmann 已提交
11258

T
Théo DELRIEU 已提交
11259 11260 11261
            // if line buffer is used, m_limit is set past the end of its data
            assert(m_line_buffer.empty()
                   or m_limit == m_content + m_line_buffer.size());
N
Niels Lohmann 已提交
11262

T
Théo DELRIEU 已提交
11263 11264 11265 11266 11267
            // pointer relationships
            assert(m_content <= m_start);
            assert(m_start <= m_cursor);
            assert(m_cursor <= m_limit);
            assert(m_marker == nullptr or m_marker  <= m_limit);
N
Niels Lohmann 已提交
11268

T
Théo DELRIEU 已提交
11269
            // number of processed characters (p)
N
Niels Lohmann 已提交
11270
            const auto num_processed_chars = static_cast<size_t>(m_start - m_content);
T
Théo DELRIEU 已提交
11271 11272 11273 11274
            // offset for m_marker wrt. to m_start
            const auto offset_marker = (m_marker == nullptr) ? 0 : m_marker - m_start;
            // number of unprocessed characters (u)
            const auto offset_cursor = m_cursor - m_start;
N
Niels 已提交
11275

T
Théo DELRIEU 已提交
11276 11277 11278 11279
            // no stream is used or end of file is reached
            if (m_stream == nullptr or m_stream->eof())
            {
                // m_start may or may not be pointing into m_line_buffer at
N
Niels Lohmann 已提交
11280
                // this point. We trust the standard library to do the right
T
Théo DELRIEU 已提交
11281 11282
                // thing. See http://stackoverflow.com/q/28142011/266378
                m_line_buffer.assign(m_start, m_limit);
11283

T
Théo DELRIEU 已提交
11284 11285 11286 11287 11288 11289 11290 11291 11292
                // append n characters to make sure that there is sufficient
                // space between m_cursor and m_limit
                m_line_buffer.append(1, '\x00');
                if (n > 0)
                {
                    m_line_buffer.append(n - 1, '\x01');
                }
            }
            else
11293
            {
T
Théo DELRIEU 已提交
11294 11295 11296 11297 11298 11299 11300 11301 11302
                // delete processed characters from line buffer
                m_line_buffer.erase(0, num_processed_chars);
                // read next line from input stream
                m_line_buffer_tmp.clear();
                std::getline(*m_stream, m_line_buffer_tmp, '\n');

                // add line with newline symbol to the line buffer
                m_line_buffer += m_line_buffer_tmp;
                m_line_buffer.push_back('\n');
11303
            }
11304

T
Théo DELRIEU 已提交
11305 11306 11307 11308 11309 11310 11311
            // set pointers
            m_content = reinterpret_cast<const lexer_char_t*>(m_line_buffer.data());
            assert(m_content != nullptr);
            m_start  = m_content;
            m_marker = m_start + offset_marker;
            m_cursor = m_start + offset_cursor;
            m_limit  = m_start + m_line_buffer.size();
N
Niels 已提交
11312 11313
        }

T
Théo DELRIEU 已提交
11314 11315 11316 11317 11318 11319 11320
        /// return string representation of last read token
        string_t get_token_string() const
        {
            assert(m_start != nullptr);
            return string_t(reinterpret_cast<typename string_t::const_pointer>(m_start),
                            static_cast<size_t>(m_cursor - m_start));
        }
11321

T
Théo DELRIEU 已提交
11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367
        /*!
        @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
           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
           of the construction of the values.
        2. Unescaped characters are copied as is.

        @pre `m_cursor - m_start >= 2`, meaning the length of the last token
        is at least 2 bytes which is trivially true for any string (which
        consists of at least two quotes).

            " c1 c2 c3 ... "
            ^                ^
            m_start          m_cursor

        @complexity Linear in the length of the string.\n

        Lemma: The loop body will always terminate.\n

        Proof (by contradiction): Assume the loop body does not terminate. As
        the loop body does not contain another loop, one of the called
        functions must never return. The called functions are `std::strtoul`
        and to_unicode. Neither function can loop forever, so the loop body
        will never loop forever which contradicts the assumption that the loop
        body does not terminate, q.e.d.\n

        Lemma: The loop condition for the for loop is eventually false.\n

        Proof (by contradiction): Assume the loop does not terminate. Due to
        the above lemma, this can only be due to a tautological loop
        condition; that is, the loop condition i < m_cursor - 1 must always be
        true. Let x be the change of i for any loop iteration. Then
        m_start + 1 + x < m_cursor - 1 must hold to loop indefinitely. This
        can be rephrased to m_cursor - m_start - 2 > x. With the
        precondition, we x <= 0, meaning that the loop condition holds
N
Niels Lohmann 已提交
11368
        indefinitely if i is always decreased. However, observe that the value
T
Théo DELRIEU 已提交
11369 11370 11371 11372 11373 11374 11375 11376
        of i is strictly increasing with each iteration, as it is incremented
        by 1 in the iteration expression and never decremented inside the loop
        body. Hence, the loop condition will eventually be false which
        contradicts the assumption that the loop condition is a tautology,
        q.e.d.

        @return string value of current token without opening and closing
        quotes
N
Niels Lohmann 已提交
11377
        @throw parse_error.102 if to_unicode fails or surrogate error
11378
        @throw parse_error.103 if to_unicode fails
T
Théo DELRIEU 已提交
11379 11380 11381 11382
        */
        string_t get_string() const
        {
            assert(m_cursor - m_start >= 2);
11383

T
Théo DELRIEU 已提交
11384 11385
            string_t result;
            result.reserve(static_cast<size_t>(m_cursor - m_start - 2));
11386

T
Théo DELRIEU 已提交
11387 11388
            // iterate the result between the quotes
            for (const lexer_char_t* i = m_start + 1; i < m_cursor - 1; ++i)
N
Niels 已提交
11389
            {
T
Théo DELRIEU 已提交
11390 11391 11392
                // find next escape character
                auto e = std::find(i, m_cursor - 1, '\\');
                if (e != i)
N
Niels 已提交
11393
                {
T
Théo DELRIEU 已提交
11394 11395
                    // see https://github.com/nlohmann/json/issues/365#issuecomment-262874705
                    for (auto k = i; k < e; k++)
11396
                    {
T
Théo DELRIEU 已提交
11397
                        result.push_back(static_cast<typename string_t::value_type>(*k));
11398
                    }
T
Théo DELRIEU 已提交
11399 11400 11401 11402 11403 11404 11405
                    i = e - 1; // -1 because of ++i
                }
                else
                {
                    // processing escaped character
                    // read next character
                    ++i;
N
Niels 已提交
11406

T
Théo DELRIEU 已提交
11407
                    switch (*i)
N
Niels 已提交
11408
                    {
T
Théo DELRIEU 已提交
11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449
                        // 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 '\\':
                        {
                            result += "\\";
                            break;
                        }
                        case '/':
                        {
                            result += "/";
                            break;
                        }
                        case '"':
                        {
                            result += "\"";
                            break;
                        }
N
Niels 已提交
11450

T
Théo DELRIEU 已提交
11451 11452
                        // unicode
                        case 'u':
N
Niels 已提交
11453
                        {
T
Théo DELRIEU 已提交
11454 11455 11456 11457 11458 11459
                            // get code xxxx from uxxxx
                            auto codepoint = std::strtoul(std::string(reinterpret_cast<typename string_t::const_pointer>(i + 1),
                                                          4).c_str(), nullptr, 16);

                            // check if codepoint is a high surrogate
                            if (codepoint >= 0xD800 and codepoint <= 0xDBFF)
N
Niels 已提交
11460
                            {
T
Théo DELRIEU 已提交
11461 11462 11463
                                // make sure there is a subsequent unicode
                                if ((i + 6 >= m_limit) or * (i + 5) != '\\' or * (i + 6) != 'u')
                                {
11464
                                    JSON_THROW(parse_error(102, get_position(), "missing low surrogate"));
T
Théo DELRIEU 已提交
11465 11466 11467 11468 11469 11470 11471 11472
                                }

                                // get code yyyy from uxxxx\uyyyy
                                auto codepoint2 = std::strtoul(std::string(reinterpret_cast<typename string_t::const_pointer>
                                                               (i + 7), 4).c_str(), nullptr, 16);
                                result += to_unicode(codepoint, codepoint2);
                                // skip the next 10 characters (xxxx\uyyyy)
                                i += 10;
N
Niels 已提交
11473
                            }
T
Théo DELRIEU 已提交
11474 11475 11476
                            else if (codepoint >= 0xDC00 and codepoint <= 0xDFFF)
                            {
                                // we found a lone low surrogate
11477
                                JSON_THROW(parse_error(102, get_position(), "missing high surrogate"));
T
Théo DELRIEU 已提交
11478 11479 11480 11481 11482 11483 11484 11485 11486
                            }
                            else
                            {
                                // add unicode character(s)
                                result += to_unicode(codepoint);
                                // skip the next four characters (xxxx)
                                i += 4;
                            }
                            break;
N
Niels 已提交
11487 11488 11489 11490
                        }
                    }
                }
            }
T
Théo DELRIEU 已提交
11491 11492

            return result;
N
Niels 已提交
11493 11494
        }

11495

T
Théo DELRIEU 已提交
11496
        /*!
N
Niels Lohmann 已提交
11497 11498
        @brief parse string into a built-in arithmetic type as if the current
               locale is POSIX.
11499

N
Niels Lohmann 已提交
11500 11501
        @note in floating-point case strtod may parse past the token's end -
              this is not an error
11502

N
Niels Lohmann 已提交
11503
        @note any leading blanks are not handled
T
Théo DELRIEU 已提交
11504
        */
11505
        struct strtonum
T
Théo DELRIEU 已提交
11506
        {
11507
          public:
11508
            strtonum(const char* start, const char* end)
11509 11510
                : m_start(start), m_end(end)
            {}
11511

N
Niels Lohmann 已提交
11512 11513 11514 11515 11516 11517 11518
            /*!
            @return true iff parsed successfully as number of type T

            @param[in,out] val shall contain parsed value, or undefined value
            if could not parse
            */
            template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>
11519 11520 11521 11522
            bool to(T& val) const
            {
                return parse(val, std::is_integral<T>());
            }
N
Niels 已提交
11523

11524
          private:
11525
            const char* const m_start = nullptr;
N
Niels Lohmann 已提交
11526
            const char* const m_end = nullptr;
N
Niels 已提交
11527

11528 11529
            // floating-point conversion

A
Alex Astashyn 已提交
11530 11531
            // overloaded wrappers for strtod/strtof/strtold
            // that will be called from parse<floating_point_t>
N
Niels Lohmann 已提交
11532
            static void strtof(float& f, const char* str, char** endptr)
11533
            {
11534
                f = std::strtof(str, endptr);
N
Niels 已提交
11535 11536
            }

N
Niels Lohmann 已提交
11537
            static void strtof(double& f, const char* str, char** endptr)
T
Théo DELRIEU 已提交
11538
            {
11539
                f = std::strtod(str, endptr);
T
Théo DELRIEU 已提交
11540
            }
N
Niels 已提交
11541

N
Niels Lohmann 已提交
11542
            static void strtof(long double& f, const char* str, char** endptr)
T
Théo DELRIEU 已提交
11543
            {
11544
                f = std::strtold(str, endptr);
T
Théo DELRIEU 已提交
11545
            }
11546

11547 11548
            template<typename T>
            bool parse(T& value, /*is_integral=*/std::false_type) const
T
Théo DELRIEU 已提交
11549
            {
N
Niels Lohmann 已提交
11550 11551 11552
                // replace decimal separator with locale-specific version,
                // when necessary; data will point to either the original
                // string, or buf, or tempstr containing the fixed string.
11553 11554
                std::string tempstr;
                std::array<char, 64> buf;
11555 11556
                const size_t len = static_cast<size_t>(m_end - m_start);

11557 11558 11559
                // lexer will reject empty numbers
                assert(len > 0);

N
Niels Lohmann 已提交
11560 11561 11562
                // since dealing with strtod family of functions, we're
                // getting the decimal point char from the C locale facilities
                // instead of C++'s numpunct facet of the current std::locale
11563 11564
                const auto loc = localeconv();
                assert(loc != nullptr);
N
Niels Lohmann 已提交
11565
                const char decimal_point_char = (loc->decimal_point == nullptr) ? '.' : loc->decimal_point[0];
11566 11567 11568

                const char* data = m_start;

11569
                if (decimal_point_char != '.')
T
Théo DELRIEU 已提交
11570
                {
N
Niels Lohmann 已提交
11571
                    const size_t ds_pos = static_cast<size_t>(std::find(m_start, m_end, '.') - m_start);
11572

11573
                    if (ds_pos != len)
T
Théo DELRIEU 已提交
11574
                    {
N
Niels Lohmann 已提交
11575 11576 11577 11578
                        // copy the data into the local buffer or tempstr, if
                        // buffer is too small; replace decimal separator, and
                        // update data to point to the modified bytes
                        if ((len + 1) < buf.size())
11579
                        {
11580
                            std::copy(m_start, m_end, buf.begin());
11581 11582 11583 11584 11585 11586 11587 11588 11589 11590
                            buf[len] = 0;
                            buf[ds_pos] = decimal_point_char;
                            data = buf.data();
                        }
                        else
                        {
                            tempstr.assign(m_start, m_end);
                            tempstr[ds_pos] = decimal_point_char;
                            data = tempstr.c_str();
                        }
T
Théo DELRIEU 已提交
11591 11592
                    }
                }
11593

11594 11595
                char* endptr = nullptr;
                value = 0;
11596
                // this calls appropriate overload depending on T
11597
                strtof(value, data, &endptr);
T
Théo DELRIEU 已提交
11598

11599 11600 11601
                // parsing was successful iff strtof parsed exactly the number
                // of characters determined by the lexer (len)
                const bool ok = (endptr == (data + len));
11602

11603
                if (ok and (value == static_cast<T>(0.0)) and (*data == '-'))
A
Alex Astashyn 已提交
11604
                {
11605 11606
                    // some implementations forget to negate the zero
                    value = -0.0;
N
Niels 已提交
11607
                }
N
Niels 已提交
11608

11609
                return ok;
N
Niels 已提交
11610
            }
11611

11612 11613
            // integral conversion

N
Niels Lohmann 已提交
11614
            signed long long parse_integral(char** endptr, /*is_signed*/std::true_type) const
11615 11616
            {
                return std::strtoll(m_start, endptr, 10);
11617
            }
N
Niels 已提交
11618

N
Niels Lohmann 已提交
11619
            unsigned long long parse_integral(char** endptr, /*is_signed*/std::false_type) const
T
Théo DELRIEU 已提交
11620
            {
11621
                return std::strtoull(m_start, endptr, 10);
T
Théo DELRIEU 已提交
11622
            }
11623 11624 11625

            template<typename T>
            bool parse(T& value, /*is_integral=*/std::true_type) const
N
Niels 已提交
11626
            {
11627
                char* endptr = nullptr;
N
Niels Lohmann 已提交
11628
                errno = 0; // these are thread-local
11629
                const auto x = parse_integral(&endptr, std::is_signed<T>());
N
Niels Lohmann 已提交
11630

N
Niels Lohmann 已提交
11631 11632
                // called right overload?
                static_assert(std::is_signed<T>() == std::is_signed<decltype(x)>(), "");
11633 11634 11635

                value = static_cast<T>(x);

N
Niels Lohmann 已提交
11636 11637
                return (x == static_cast<decltype(x)>(value)) // x fits into destination T
                       and (x < 0) == (value < 0)             // preserved sign
11638
                       //and ((x != 0) or is_integral())        // strto[u]ll did nto fail
N
Niels Lohmann 已提交
11639 11640 11641
                       and (errno == 0)                       // strto[u]ll did not overflow
                       and (m_start < m_end)                  // token was not empty
                       and (endptr == m_end);                 // parsed entire token exactly
11642
            }
11643 11644 11645 11646 11647 11648 11649 11650
        };

        /*!
        @brief return number value for number tokens

        This function translates the last token into the most appropriate
        number type (either integer, unsigned integer or floating point),
        which is passed back to the caller via the result parameter.
11651

11652 11653
        integral numbers that don't fit into the the range of the respective
        type are parsed as number_float_t
N
Niels 已提交
11654

11655 11656
        floating-point values do not satisfy std::isfinite predicate
        are converted to value_t::null
11657 11658

        throws if the entire string [m_start .. m_cursor) cannot be
11659 11660 11661
        interpreted as a number

        @param[out] result  @ref basic_json object to receive the number.
11662
        @param[in]  token   the type of the number token
11663
        */
11664
        bool get_number(basic_json& result, const token_type token) const
11665 11666 11667
        {
            assert(m_start != nullptr);
            assert(m_start < m_cursor);
N
Niels Lohmann 已提交
11668 11669
            assert((token == token_type::value_unsigned) or
                   (token == token_type::value_integer) or
11670
                   (token == token_type::value_float));
11671

N
Niels Lohmann 已提交
11672 11673
            strtonum num_converter(reinterpret_cast<const char*>(m_start),
                                   reinterpret_cast<const char*>(m_cursor));
11674

11675
            switch (token)
11676
            {
N
Niels Lohmann 已提交
11677
                case lexer::token_type::value_unsigned:
N
Niels Lohmann 已提交
11678
                {
N
Niels Lohmann 已提交
11679 11680
                    number_unsigned_t val;
                    if (num_converter.to(val))
11681
                    {
11682
                        // parsing successful
11683 11684
                        result.m_type = value_t::number_unsigned;
                        result.m_value = val;
11685
                        return true;
11686 11687
                    }
                    break;
N
Niels Lohmann 已提交
11688
                }
11689

N
Niels Lohmann 已提交
11690
                case lexer::token_type::value_integer:
11691
                {
N
Niels Lohmann 已提交
11692 11693
                    number_integer_t val;
                    if (num_converter.to(val))
11694
                    {
11695
                        // parsing successful
11696 11697
                        result.m_type = value_t::number_integer;
                        result.m_value = val;
11698
                        return true;
11699 11700 11701 11702 11703
                    }
                    break;
                }

                default:
T
Théo DELRIEU 已提交
11704
                {
11705
                    break;
T
Théo DELRIEU 已提交
11706 11707 11708
                }
            }

N
Niels Lohmann 已提交
11709 11710 11711
            // parse float (either explicitly or because a previous conversion
            // failed)
            number_float_t val;
11712
            if (num_converter.to(val))
A
Alex Astashyn 已提交
11713
            {
11714 11715 11716
                // parsing successful
                result.m_type = value_t::number_float;
                result.m_value = val;
N
Niels 已提交
11717

11718
                // throw in case of infinity or NAN
11719 11720
                if (not std::isfinite(result.m_value.number_float))
                {
11721
                    JSON_THROW(out_of_range(406, "number overflow parsing '" + get_token_string() + "'"));
11722
                }
11723

11724
                return true;
11725
            }
11726 11727 11728

            // couldn't parse number in any format
            return false;
T
Théo DELRIEU 已提交
11729 11730
        }

11731 11732 11733 11734 11735
        constexpr size_t get_position() const
        {
            return position;
        }

T
Théo DELRIEU 已提交
11736 11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754
      private:
        /// optional input stream
        std::istream* m_stream = nullptr;
        /// line buffer buffer for m_stream
        string_t m_line_buffer {};
        /// used for filling m_line_buffer
        string_t m_line_buffer_tmp {};
        /// the buffer pointer
        const lexer_char_t* m_content = nullptr;
        /// pointer to the beginning of the current symbol
        const lexer_char_t* m_start = nullptr;
        /// pointer for backtracking information
        const lexer_char_t* m_marker = nullptr;
        /// pointer to the current symbol
        const lexer_char_t* m_cursor = nullptr;
        /// pointer to the end of the buffer
        const lexer_char_t* m_limit = nullptr;
        /// the last token type
        token_type last_token_type = token_type::end_of_input;
11755 11756
        /// current position in the input (read bytes)
        size_t position = 0;
T
Théo DELRIEU 已提交
11757
    };
N
Niels 已提交
11758

N
Niels 已提交
11759 11760
    /*!
    @brief syntax analysis
N
Niels 已提交
11761 11762

    This class implements a recursive decent parser.
N
Niels 已提交
11763
    */
N
Niels 已提交
11764 11765
    class parser
    {
T
Théo DELRIEU 已提交
11766
      public:
11767
        /// a parser reading from a string literal
N
Niels 已提交
11768
        parser(const char* buff, const parser_callback_t cb = nullptr)
T
Théo DELRIEU 已提交
11769 11770 11771
            : callback(cb),
              m_lexer(reinterpret_cast<const typename lexer::lexer_char_t*>(buff), std::strlen(buff))
        {}
11772

N
Niels Lohmann 已提交
11773 11774 11775 11776
        /*!
        @brief a parser reading from an input stream
        @throw parse_error.111 if input stream is in a bad state
        */
T
Théo DELRIEU 已提交
11777 11778 11779
        parser(std::istream& is, const parser_callback_t cb = nullptr)
            : callback(cb), m_lexer(is)
        {}
11780

T
Théo DELRIEU 已提交
11781 11782 11783 11784 11785 11786 11787 11788 11789 11790
        /// a parser reading from an iterator range with contiguous storage
        template<class IteratorType, typename std::enable_if<
                     std::is_same<typename std::iterator_traits<IteratorType>::iterator_category, std::random_access_iterator_tag>::value
                     , int>::type
                 = 0>
        parser(IteratorType first, IteratorType last, const parser_callback_t cb = nullptr)
            : callback(cb),
              m_lexer(reinterpret_cast<const typename lexer::lexer_char_t*>(&(*first)),
                      static_cast<size_t>(std::distance(first, last)))
        {}
N
cleanup  
Niels 已提交
11791

N
Niels Lohmann 已提交
11792 11793 11794 11795 11796 11797
        /*!
        @brief public parser interface
        @throw parse_error.101 in case of an unexpected token
        @throw parse_error.102 if to_unicode fails or surrogate error
        @throw parse_error.103 if to_unicode fails
        */
T
Théo DELRIEU 已提交
11798 11799 11800 11801
        basic_json parse()
        {
            // read first token
            get_token();
N
Niels 已提交
11802

T
Théo DELRIEU 已提交
11803 11804
            basic_json result = parse_internal(true);
            result.assert_invariant();
N
Niels 已提交
11805

T
Théo DELRIEU 已提交
11806
            expect(lexer::token_type::end_of_input);
N
Niels 已提交
11807

T
Théo DELRIEU 已提交
11808 11809 11810 11811
            // 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() : std::move(result);
        }
N
Niels 已提交
11812

T
Théo DELRIEU 已提交
11813
      private:
N
Niels Lohmann 已提交
11814 11815 11816 11817 11818 11819
        /*!
        @brief the actual parser
        @throw parse_error.101 in case of an unexpected token
        @throw parse_error.102 if to_unicode fails or surrogate error
        @throw parse_error.103 if to_unicode fails
        */
T
Théo DELRIEU 已提交
11820
        basic_json parse_internal(bool keep)
11821
        {
T
Théo DELRIEU 已提交
11822 11823 11824
            auto result = basic_json(value_t::discarded);

            switch (last_token)
N
Niels 已提交
11825
            {
T
Théo DELRIEU 已提交
11826
                case lexer::token_type::begin_object:
N
Niels 已提交
11827
                {
T
Théo DELRIEU 已提交
11828 11829 11830 11831 11832 11833 11834
                    if (keep and (not callback
                                  or ((keep = callback(depth++, parse_event_t::object_start, result)) != 0)))
                    {
                        // explicitly set result to object to cope with {}
                        result.m_type = value_t::object;
                        result.m_value = value_t::object;
                    }
N
Niels 已提交
11835

T
Théo DELRIEU 已提交
11836 11837
                    // read next token
                    get_token();
N
Niels 已提交
11838

T
Théo DELRIEU 已提交
11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853 11854 11855 11856 11857 11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895
                    // closing } -> we are done
                    if (last_token == lexer::token_type::end_object)
                    {
                        get_token();
                        if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
                        {
                            result = basic_json(value_t::discarded);
                        }
                        return result;
                    }

                    // no comma is expected here
                    unexpect(lexer::token_type::value_separator);

                    // otherwise: parse key-value pairs
                    do
                    {
                        // ugly, but could be fixed with loop reorganization
                        if (last_token == lexer::token_type::value_separator)
                        {
                            get_token();
                        }

                        // store key
                        expect(lexer::token_type::value_string);
                        const auto key = m_lexer.get_string();

                        bool keep_tag = false;
                        if (keep)
                        {
                            if (callback)
                            {
                                basic_json k(key);
                                keep_tag = callback(depth, parse_event_t::key, k);
                            }
                            else
                            {
                                keep_tag = true;
                            }
                        }

                        // parse separator (:)
                        get_token();
                        expect(lexer::token_type::name_separator);

                        // parse and add value
                        get_token();
                        auto value = parse_internal(keep);
                        if (keep and keep_tag and not value.is_discarded())
                        {
                            result[key] = std::move(value);
                        }
                    }
                    while (last_token == lexer::token_type::value_separator);

                    // closing }
                    expect(lexer::token_type::end_object);
N
Niels 已提交
11896
                    get_token();
N
Niels 已提交
11897
                    if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
N
Niels 已提交
11898 11899 11900
                    {
                        result = basic_json(value_t::discarded);
                    }
T
Théo DELRIEU 已提交
11901

N
Niels 已提交
11902
                    return result;
N
Niels 已提交
11903 11904
                }

T
Théo DELRIEU 已提交
11905
                case lexer::token_type::begin_array:
11906
                {
T
Théo DELRIEU 已提交
11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919
                    if (keep and (not callback
                                  or ((keep = callback(depth++, parse_event_t::array_start, result)) != 0)))
                    {
                        // explicitly set result to object to cope with []
                        result.m_type = value_t::array;
                        result.m_value = value_t::array;
                    }

                    // read next token
                    get_token();

                    // closing ] -> we are done
                    if (last_token == lexer::token_type::end_array)
N
Niels 已提交
11920
                    {
N
Niels 已提交
11921
                        get_token();
T
Théo DELRIEU 已提交
11922 11923 11924 11925 11926
                        if (callback and not callback(--depth, parse_event_t::array_end, result))
                        {
                            result = basic_json(value_t::discarded);
                        }
                        return result;
N
Niels 已提交
11927 11928
                    }

T
Théo DELRIEU 已提交
11929 11930
                    // no comma is expected here
                    unexpect(lexer::token_type::value_separator);
N
Niels 已提交
11931

T
Théo DELRIEU 已提交
11932 11933
                    // otherwise: parse values
                    do
N
Niels 已提交
11934
                    {
T
Théo DELRIEU 已提交
11935 11936
                        // ugly, but could be fixed with loop reorganization
                        if (last_token == lexer::token_type::value_separator)
N
Niels 已提交
11937
                        {
T
Théo DELRIEU 已提交
11938
                            get_token();
N
Niels 已提交
11939
                        }
T
Théo DELRIEU 已提交
11940 11941 11942 11943

                        // parse value
                        auto value = parse_internal(keep);
                        if (keep and not value.is_discarded())
N
Niels 已提交
11944
                        {
T
Théo DELRIEU 已提交
11945
                            result.push_back(std::move(value));
N
Niels 已提交
11946
                        }
N
Niels 已提交
11947
                    }
T
Théo DELRIEU 已提交
11948
                    while (last_token == lexer::token_type::value_separator);
N
Niels 已提交
11949

T
Théo DELRIEU 已提交
11950 11951
                    // closing ]
                    expect(lexer::token_type::end_array);
11952
                    get_token();
T
Théo DELRIEU 已提交
11953
                    if (keep and callback and not callback(--depth, parse_event_t::array_end, result))
N
Niels 已提交
11954
                    {
T
Théo DELRIEU 已提交
11955
                        result = basic_json(value_t::discarded);
N
Niels 已提交
11956
                    }
T
Théo DELRIEU 已提交
11957 11958

                    return result;
N
Niels 已提交
11959 11960
                }

T
Théo DELRIEU 已提交
11961
                case lexer::token_type::literal_null:
N
Niels 已提交
11962
                {
T
Théo DELRIEU 已提交
11963 11964 11965
                    get_token();
                    result.m_type = value_t::null;
                    break;
N
Niels 已提交
11966 11967
                }

T
Théo DELRIEU 已提交
11968
                case lexer::token_type::value_string:
N
Niels 已提交
11969
                {
T
Théo DELRIEU 已提交
11970 11971 11972 11973
                    const auto s = m_lexer.get_string();
                    get_token();
                    result = basic_json(s);
                    break;
N
Niels 已提交
11974 11975
                }

T
Théo DELRIEU 已提交
11976
                case lexer::token_type::literal_true:
N
Niels 已提交
11977
                {
N
Niels 已提交
11978
                    get_token();
T
Théo DELRIEU 已提交
11979 11980 11981
                    result.m_type = value_t::boolean;
                    result.m_value = true;
                    break;
N
Niels 已提交
11982 11983
                }

T
Théo DELRIEU 已提交
11984
                case lexer::token_type::literal_false:
N
Niels 已提交
11985
                {
T
Théo DELRIEU 已提交
11986 11987 11988 11989
                    get_token();
                    result.m_type = value_t::boolean;
                    result.m_value = false;
                    break;
N
Niels 已提交
11990 11991
                }

N
Niels Lohmann 已提交
11992 11993
                case lexer::token_type::value_unsigned:
                case lexer::token_type::value_integer:
11994
                case lexer::token_type::value_float:
N
Niels 已提交
11995
                {
N
Niels Lohmann 已提交
11996
                    m_lexer.get_number(result, last_token);
T
Théo DELRIEU 已提交
11997 11998
                    get_token();
                    break;
N
Niels 已提交
11999
                }
12000

T
Théo DELRIEU 已提交
12001 12002 12003 12004 12005
                default:
                {
                    // the last token was unexpected
                    unexpect(last_token);
                }
12006 12007
            }

T
Théo DELRIEU 已提交
12008
            if (keep and callback and not callback(depth, parse_event_t::value, result))
12009
            {
T
Théo DELRIEU 已提交
12010
                result = basic_json(value_t::discarded);
N
Niels 已提交
12011
            }
T
Théo DELRIEU 已提交
12012
            return result;
N
Niels 已提交
12013 12014
        }

T
Théo DELRIEU 已提交
12015 12016
        /// get next token from lexer
        typename lexer::token_type get_token()
N
Niels 已提交
12017
        {
T
Théo DELRIEU 已提交
12018 12019
            last_token = m_lexer.scan();
            return last_token;
N
Niels 已提交
12020 12021
        }

N
Niels Lohmann 已提交
12022 12023 12024
        /*!
        @throw parse_error.101 if expected token did not occur
        */
T
Théo DELRIEU 已提交
12025
        void expect(typename lexer::token_type t) const
N
Niels 已提交
12026
        {
T
Théo DELRIEU 已提交
12027 12028 12029 12030 12031 12032 12033
            if (t != last_token)
            {
                std::string error_msg = "parse error - unexpected ";
                error_msg += (last_token == lexer::token_type::parse_error ? ("'" +  m_lexer.get_token_string() +
                              "'") :
                              lexer::token_type_name(last_token));
                error_msg += "; expected " + lexer::token_type_name(t);
12034
                JSON_THROW(parse_error(101, m_lexer.get_position(), error_msg));
T
Théo DELRIEU 已提交
12035
            }
N
Niels 已提交
12036 12037
        }

N
Niels Lohmann 已提交
12038 12039 12040
        /*!
        @throw parse_error.101 if unexpected token occurred
        */
T
Théo DELRIEU 已提交
12041
        void unexpect(typename lexer::token_type t) const
N
Niels 已提交
12042
        {
T
Théo DELRIEU 已提交
12043 12044 12045 12046 12047 12048
            if (t == last_token)
            {
                std::string error_msg = "parse error - unexpected ";
                error_msg += (last_token == lexer::token_type::parse_error ? ("'" +  m_lexer.get_token_string() +
                              "'") :
                              lexer::token_type_name(last_token));
12049
                JSON_THROW(parse_error(101, m_lexer.get_position(), error_msg));
T
Théo DELRIEU 已提交
12050
            }
N
Niels 已提交
12051 12052
        }

T
Théo DELRIEU 已提交
12053 12054 12055 12056 12057 12058 12059 12060 12061 12062
      private:
        /// current level of recursion
        int depth = 0;
        /// callback function
        const parser_callback_t callback = nullptr;
        /// the type of the last read token
        typename lexer::token_type last_token = lexer::token_type::uninitialized;
        /// the lexer
        lexer m_lexer;
    };
N
Niels 已提交
12063 12064

  public:
N
Niels 已提交
12065 12066 12067
    /*!
    @brief JSON Pointer

N
Niels 已提交
12068 12069 12070 12071
    A JSON pointer defines a string syntax for identifying a specific value
    within a JSON document. It can be used with functions `at` and
    `operator[]`. Furthermore, JSON pointers are the base for JSON patches.

N
Niels 已提交
12072
    @sa [RFC 6901](https://tools.ietf.org/html/rfc6901)
N
Niels 已提交
12073 12074

    @since version 2.0.0
N
Niels 已提交
12075
    */
N
Niels 已提交
12076 12077
    class json_pointer
    {
N
Niels 已提交
12078 12079 12080
        /// allow basic_json to access private members
        friend class basic_json;

T
Théo DELRIEU 已提交
12081
      public:
N
Niels 已提交
12082 12083 12084 12085 12086 12087 12088 12089 12090 12091
        /*!
        @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 Lohmann 已提交
12092 12093 12094 12095 12096 12097
        @throw parse_error.107 if the given JSON pointer @a s is nonempty and
        does not begin with a slash (`/`); see example below

        @throw parse_error.108 if a tilde (`~`) in the given JSON pointer @a s
        is not followed by `0` (representing `~`) or `1` (representing `/`);
        see example below
N
Niels 已提交
12098 12099 12100

        @liveexample{The example shows the construction several valid JSON
        pointers as well as the exceptional behavior.,json_pointer}
N
Niels 已提交
12101

N
Niels 已提交
12102 12103 12104
        @since version 2.0.0
        */
        explicit json_pointer(const std::string& s = "")
T
Théo DELRIEU 已提交
12105 12106
            : reference_tokens(split(s))
        {}
N
Niels 已提交
12107

T
Théo DELRIEU 已提交
12108 12109
        /*!
        @brief return a string representation of the JSON pointer
N
Niels 已提交
12110

T
Théo DELRIEU 已提交
12111 12112 12113 12114
        @invariant For each JSON pointer `ptr`, it holds:
        @code {.cpp}
        ptr == json_pointer(ptr.to_string());
        @endcode
N
Niels 已提交
12115

T
Théo DELRIEU 已提交
12116
        @return a string representation of the JSON pointer
N
Niels 已提交
12117

T
Théo DELRIEU 已提交
12118 12119
        @liveexample{The example shows the result of `to_string`.,
        json_pointer__to_string}
N
Niels 已提交
12120

T
Théo DELRIEU 已提交
12121 12122 12123
        @since version 2.0.0
        */
        std::string to_string() const noexcept
N
Niels 已提交
12124
        {
T
Théo DELRIEU 已提交
12125 12126 12127 12128 12129 12130 12131
            return std::accumulate(reference_tokens.begin(),
                                   reference_tokens.end(), std::string{},
                                   [](const std::string & a, const std::string & b)
            {
                return a + "/" + escape(b);
            });
        }
N
Niels 已提交
12132

T
Théo DELRIEU 已提交
12133 12134
        /// @copydoc to_string()
        operator std::string() const
N
Niels 已提交
12135
        {
T
Théo DELRIEU 已提交
12136
            return to_string();
N
Niels 已提交
12137 12138
        }

T
Théo DELRIEU 已提交
12139
      private:
N
Niels Lohmann 已提交
12140 12141 12142 12143
        /*!
        @brief remove and return last reference pointer
        @throw out_of_range.405 if JSON pointer has no parent
        */
T
Théo DELRIEU 已提交
12144 12145 12146 12147
        std::string pop_back()
        {
            if (is_root())
            {
12148
                JSON_THROW(out_of_range(405, "JSON pointer has no parent"));
T
Théo DELRIEU 已提交
12149
            }
12150

T
Théo DELRIEU 已提交
12151 12152 12153 12154
            auto last = reference_tokens.back();
            reference_tokens.pop_back();
            return last;
        }
N
Niels 已提交
12155

T
Théo DELRIEU 已提交
12156 12157
        /// return whether pointer points to the root document
        bool is_root() const
N
Niels 已提交
12158
        {
T
Théo DELRIEU 已提交
12159
            return reference_tokens.empty();
N
Niels 已提交
12160 12161
        }

T
Théo DELRIEU 已提交
12162 12163 12164 12165
        json_pointer top() const
        {
            if (is_root())
            {
12166
                JSON_THROW(out_of_range(405, "JSON pointer has no parent"));
T
Théo DELRIEU 已提交
12167
            }
N
Niels 已提交
12168

T
Théo DELRIEU 已提交
12169 12170 12171 12172
            json_pointer result = *this;
            result.reference_tokens = {reference_tokens[0]};
            return result;
        }
N
Niels 已提交
12173

T
Théo DELRIEU 已提交
12174 12175
        /*!
        @brief create and return a reference to the pointed to value
12176

T
Théo DELRIEU 已提交
12177
        @complexity Linear in the number of reference tokens.
N
Niels Lohmann 已提交
12178 12179 12180

        @throw parse_error.109 if array index is not a number
        @throw type_error.313 if value cannot be unflattened
T
Théo DELRIEU 已提交
12181 12182
        */
        reference get_and_create(reference j) const
12183
        {
T
Théo DELRIEU 已提交
12184 12185 12186 12187 12188
            pointer result = &j;

            // in case no reference tokens exist, return a reference to the
            // JSON value j which will be overwritten by a primitive value
            for (const auto& reference_token : reference_tokens)
N
Niels 已提交
12189
            {
T
Théo DELRIEU 已提交
12190
                switch (result->m_type)
N
Niels 已提交
12191
                {
T
Théo DELRIEU 已提交
12192
                    case value_t::null:
N
Niels 已提交
12193
                    {
T
Théo DELRIEU 已提交
12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204
                        if (reference_token == "0")
                        {
                            // start a new array if reference token is 0
                            result = &result->operator[](0);
                        }
                        else
                        {
                            // start a new object otherwise
                            result = &result->operator[](reference_token);
                        }
                        break;
N
Niels 已提交
12205
                    }
T
Théo DELRIEU 已提交
12206 12207

                    case value_t::object:
N
Niels 已提交
12208
                    {
T
Théo DELRIEU 已提交
12209
                        // create an entry in the object
N
Niels 已提交
12210
                        result = &result->operator[](reference_token);
T
Théo DELRIEU 已提交
12211
                        break;
N
Niels 已提交
12212
                    }
N
Niels 已提交
12213

T
Théo DELRIEU 已提交
12214 12215 12216
                    case value_t::array:
                    {
                        // create an entry in the array
12217 12218 12219 12220 12221 12222 12223 12224
                        JSON_TRY
                        {
                            result = &result->operator[](static_cast<size_type>(std::stoi(reference_token)));
                        }
                        JSON_CATCH(std::invalid_argument&)
                        {
                            JSON_THROW(parse_error(109, 0, "array index '" + reference_token + "' is not a number"));
                        }
T
Théo DELRIEU 已提交
12225 12226
                        break;
                    }
12227

T
Théo DELRIEU 已提交
12228 12229 12230 12231 12232 12233 12234 12235 12236
                    /*
                    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.
                    */
                    default:
                    {
12237
                        JSON_THROW(type_error(313, "invalid value to unflatten"));
T
Théo DELRIEU 已提交
12238
                    }
N
Niels 已提交
12239 12240
                }
            }
12241

T
Théo DELRIEU 已提交
12242 12243
            return *result;
        }
12244

T
Théo DELRIEU 已提交
12245 12246
        /*!
        @brief return a reference to the pointed to value
12247

T
Théo DELRIEU 已提交
12248 12249 12250 12251 12252
        @note This version does not throw if a value is not present, but tries
        to create nested values instead. For instance, calling this function
        with pointer `"/this/that"` on a null value is equivalent to calling
        `operator[]("this").operator[]("that")` on that value, effectively
        changing the null value to an object.
N
Niels 已提交
12253

T
Théo DELRIEU 已提交
12254
        @param[in] ptr  a JSON value
N
Niels 已提交
12255

T
Théo DELRIEU 已提交
12256
        @return reference to the JSON value pointed to by the JSON pointer
N
Niels 已提交
12257

T
Théo DELRIEU 已提交
12258
        @complexity Linear in the length of the JSON pointer.
12259

N
Niels Lohmann 已提交
12260 12261 12262
        @throw parse_error.106   if an array index begins with '0'
        @throw parse_error.109   if an array index was not a number
        @throw out_of_range.404  if the JSON pointer can not be resolved
T
Théo DELRIEU 已提交
12263 12264
        */
        reference get_unchecked(pointer ptr) const
12265
        {
T
Théo DELRIEU 已提交
12266
            for (const auto& reference_token : reference_tokens)
12267
            {
T
Théo DELRIEU 已提交
12268 12269
                // convert null values to arrays or objects before continuing
                if (ptr->m_type == value_t::null)
12270
                {
T
Théo DELRIEU 已提交
12271 12272 12273 12274
                    // check if reference token is a number
                    const bool nums = std::all_of(reference_token.begin(),
                                                  reference_token.end(),
                                                  [](const char x)
N
Niels 已提交
12275
                    {
T
Théo DELRIEU 已提交
12276 12277
                        return std::isdigit(x);
                    });
N
Niels 已提交
12278

T
Théo DELRIEU 已提交
12279 12280 12281
                    // change value to array for numbers or "-" or to object
                    // otherwise
                    if (nums or reference_token == "-")
N
Niels 已提交
12282
                    {
T
Théo DELRIEU 已提交
12283
                        *ptr = value_t::array;
N
Niels 已提交
12284 12285 12286
                    }
                    else
                    {
T
Théo DELRIEU 已提交
12287
                        *ptr = value_t::object;
N
Niels 已提交
12288
                    }
N
Niels 已提交
12289 12290
                }

T
Théo DELRIEU 已提交
12291
                switch (ptr->m_type)
N
Niels 已提交
12292
                {
T
Théo DELRIEU 已提交
12293 12294 12295 12296 12297 12298 12299 12300 12301 12302 12303 12304
                    case value_t::object:
                    {
                        // use unchecked object access
                        ptr = &ptr->operator[](reference_token);
                        break;
                    }

                    case value_t::array:
                    {
                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
12305
                            JSON_THROW(parse_error(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
12306 12307 12308 12309
                        }

                        if (reference_token == "-")
                        {
N
Niels Lohmann 已提交
12310
                            // explicitly treat "-" as index beyond the end
T
Théo DELRIEU 已提交
12311 12312 12313 12314 12315
                            ptr = &ptr->operator[](ptr->m_value.array->size());
                        }
                        else
                        {
                            // convert array index to number; unchecked access
12316 12317 12318 12319 12320 12321 12322 12323
                            JSON_TRY
                            {
                                ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
                            }
                            JSON_CATCH(std::invalid_argument&)
                            {
                                JSON_THROW(parse_error(109, 0, "array index '" + reference_token + "' is not a number"));
                            }
T
Théo DELRIEU 已提交
12324 12325 12326 12327 12328 12329
                        }
                        break;
                    }

                    default:
                    {
12330
                        JSON_THROW(out_of_range(404, "unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
12331
                    }
N
Niels 已提交
12332 12333
                }
            }
N
Niels 已提交
12334

T
Théo DELRIEU 已提交
12335 12336
            return *ptr;
        }
12337

N
Niels Lohmann 已提交
12338 12339 12340 12341 12342 12343
        /*!
        @throw parse_error.106   if an array index begins with '0'
        @throw parse_error.109   if an array index was not a number
        @throw out_of_range.402  if the array index '-' is used
        @throw out_of_range.404  if the JSON pointer can not be resolved
        */
T
Théo DELRIEU 已提交
12344
        reference get_checked(pointer ptr) const
N
Niels 已提交
12345
        {
T
Théo DELRIEU 已提交
12346
            for (const auto& reference_token : reference_tokens)
N
Niels 已提交
12347
            {
T
Théo DELRIEU 已提交
12348
                switch (ptr->m_type)
12349
                {
T
Théo DELRIEU 已提交
12350
                    case value_t::object:
N
Niels 已提交
12351
                    {
T
Théo DELRIEU 已提交
12352 12353 12354
                        // note: at performs range check
                        ptr = &ptr->at(reference_token);
                        break;
N
Niels 已提交
12355 12356
                    }

T
Théo DELRIEU 已提交
12357
                    case value_t::array:
N
Niels 已提交
12358
                    {
T
Théo DELRIEU 已提交
12359 12360 12361
                        if (reference_token == "-")
                        {
                            // "-" always fails the range check
12362 12363 12364
                            JSON_THROW(out_of_range(402, "array index '-' (" +
                                                    std::to_string(ptr->m_value.array->size()) +
                                                    ") is out of range"));
T
Théo DELRIEU 已提交
12365 12366 12367 12368 12369
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
12370
                            JSON_THROW(parse_error(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
12371
                        }
N
Niels 已提交
12372

T
Théo DELRIEU 已提交
12373
                        // note: at performs range check
12374 12375 12376 12377 12378 12379 12380 12381
                        JSON_TRY
                        {
                            ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
                        }
                        JSON_CATCH(std::invalid_argument&)
                        {
                            JSON_THROW(parse_error(109, 0, "array index '" + reference_token + "' is not a number"));
                        }
T
Théo DELRIEU 已提交
12382 12383
                        break;
                    }
12384

T
Théo DELRIEU 已提交
12385 12386
                    default:
                    {
12387
                        JSON_THROW(out_of_range(404, "unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
12388
                    }
N
Niels 已提交
12389 12390 12391
                }
            }

T
Théo DELRIEU 已提交
12392 12393
            return *ptr;
        }
N
Niels 已提交
12394

T
Théo DELRIEU 已提交
12395 12396
        /*!
        @brief return a const reference to the pointed to value
N
Niels 已提交
12397

T
Théo DELRIEU 已提交
12398
        @param[in] ptr  a JSON value
12399

T
Théo DELRIEU 已提交
12400 12401
        @return const reference to the JSON value pointed to by the JSON
                pointer
N
Niels Lohmann 已提交
12402 12403 12404 12405 12406

        @throw parse_error.106   if an array index begins with '0'
        @throw parse_error.109   if an array index was not a number
        @throw out_of_range.402  if the array index '-' is used
        @throw out_of_range.404  if the JSON pointer can not be resolved
T
Théo DELRIEU 已提交
12407 12408
        */
        const_reference get_unchecked(const_pointer ptr) const
N
Niels 已提交
12409
        {
T
Théo DELRIEU 已提交
12410
            for (const auto& reference_token : reference_tokens)
N
Niels 已提交
12411
            {
T
Théo DELRIEU 已提交
12412
                switch (ptr->m_type)
12413
                {
T
Théo DELRIEU 已提交
12414
                    case value_t::object:
N
Niels 已提交
12415
                    {
T
Théo DELRIEU 已提交
12416 12417 12418
                        // use unchecked object access
                        ptr = &ptr->operator[](reference_token);
                        break;
N
Niels 已提交
12419 12420
                    }

T
Théo DELRIEU 已提交
12421
                    case value_t::array:
N
Niels 已提交
12422
                    {
T
Théo DELRIEU 已提交
12423 12424 12425
                        if (reference_token == "-")
                        {
                            // "-" cannot be used for const access
12426 12427 12428
                            JSON_THROW(out_of_range(402, "array index '-' (" +
                                                    std::to_string(ptr->m_value.array->size()) +
                                                    ") is out of range"));
T
Théo DELRIEU 已提交
12429 12430 12431 12432 12433
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
12434
                            JSON_THROW(parse_error(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
12435
                        }
N
Niels 已提交
12436

T
Théo DELRIEU 已提交
12437
                        // use unchecked array access
12438 12439 12440 12441 12442 12443 12444 12445
                        JSON_TRY
                        {
                            ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
                        }
                        JSON_CATCH(std::invalid_argument&)
                        {
                            JSON_THROW(parse_error(109, 0, "array index '" + reference_token + "' is not a number"));
                        }
T
Théo DELRIEU 已提交
12446 12447
                        break;
                    }
12448

T
Théo DELRIEU 已提交
12449 12450
                    default:
                    {
12451
                        JSON_THROW(out_of_range(404, "unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
12452
                    }
N
Niels 已提交
12453 12454 12455
                }
            }

T
Théo DELRIEU 已提交
12456 12457
            return *ptr;
        }
12458

N
Niels Lohmann 已提交
12459 12460 12461 12462 12463 12464
        /*!
        @throw parse_error.106   if an array index begins with '0'
        @throw parse_error.109   if an array index was not a number
        @throw out_of_range.402  if the array index '-' is used
        @throw out_of_range.404  if the JSON pointer can not be resolved
        */
T
Théo DELRIEU 已提交
12465
        const_reference get_checked(const_pointer ptr) const
12466
        {
T
Théo DELRIEU 已提交
12467
            for (const auto& reference_token : reference_tokens)
12468
            {
T
Théo DELRIEU 已提交
12469
                switch (ptr->m_type)
12470
                {
T
Théo DELRIEU 已提交
12471
                    case value_t::object:
N
Niels 已提交
12472
                    {
T
Théo DELRIEU 已提交
12473 12474 12475
                        // note: at performs range check
                        ptr = &ptr->at(reference_token);
                        break;
N
Niels 已提交
12476
                    }
12477

T
Théo DELRIEU 已提交
12478
                    case value_t::array:
N
Niels 已提交
12479
                    {
T
Théo DELRIEU 已提交
12480 12481 12482
                        if (reference_token == "-")
                        {
                            // "-" always fails the range check
12483 12484 12485
                            JSON_THROW(out_of_range(402, "array index '-' (" +
                                                    std::to_string(ptr->m_value.array->size()) +
                                                    ") is out of range"));
T
Théo DELRIEU 已提交
12486 12487 12488 12489 12490
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
12491
                            JSON_THROW(parse_error(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
12492
                        }
12493

T
Théo DELRIEU 已提交
12494
                        // note: at performs range check
12495 12496 12497 12498 12499 12500 12501 12502
                        JSON_TRY
                        {
                            ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
                        }
                        JSON_CATCH(std::invalid_argument&)
                        {
                            JSON_THROW(parse_error(109, 0, "array index '" + reference_token + "' is not a number"));
                        }
T
Théo DELRIEU 已提交
12503 12504
                        break;
                    }
12505

T
Théo DELRIEU 已提交
12506 12507
                    default:
                    {
12508
                        JSON_THROW(out_of_range(404, "unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
12509
                    }
12510 12511
                }
            }
N
Niels 已提交
12512

T
Théo DELRIEU 已提交
12513
            return *ptr;
12514 12515
        }

N
Niels Lohmann 已提交
12516 12517 12518 12519 12520 12521 12522 12523 12524
        /*!
        @brief split the string input to reference tokens

        @note This function is only called by the json_pointer constructor.
              All exceptions below are documented there.

        @throw parse_error.107  if the pointer is not empty or begins with '/'
        @throw parse_error.108  if character '~' is not followed by '0' or '1'
        */
T
Théo DELRIEU 已提交
12525
        static std::vector<std::string> split(const std::string& reference_string)
12526
        {
T
Théo DELRIEU 已提交
12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537
            std::vector<std::string> result;

            // special case: empty reference string -> no reference tokens
            if (reference_string.empty())
            {
                return result;
            }

            // check if nonempty reference string begins with slash
            if (reference_string[0] != '/')
            {
12538
                JSON_THROW(parse_error(107, 1, "JSON pointer must be empty or begin with '/' - was: '" + reference_string + "'"));
T
Théo DELRIEU 已提交
12539
            }
N
Niels 已提交
12540

T
Théo DELRIEU 已提交
12541 12542 12543 12544 12545
            // 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
N
Niels Lohmann 已提交
12546
                size_t slash = reference_string.find_first_of('/', 1),
T
Théo DELRIEU 已提交
12547 12548 12549 12550 12551 12552 12553 12554
                // 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
                // (will eventually be 0 if slash == std::string::npos)
                start = slash + 1,
                // find next slash
N
Niels Lohmann 已提交
12555
                slash = reference_string.find_first_of('/', start))
T
Théo DELRIEU 已提交
12556 12557 12558 12559
            {
                // 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);
N
Niels 已提交
12560

T
Théo DELRIEU 已提交
12561
                // check reference tokens are properly escaped
N
Niels Lohmann 已提交
12562
                for (size_t pos = reference_token.find_first_of('~');
T
Théo DELRIEU 已提交
12563
                        pos != std::string::npos;
N
Niels Lohmann 已提交
12564
                        pos = reference_token.find_first_of('~', pos + 1))
12565
                {
T
Théo DELRIEU 已提交
12566 12567 12568 12569 12570 12571 12572
                    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'))
                    {
12573
                        JSON_THROW(parse_error(108, 0, "escape character '~' must be followed with '0' or '1'"));
T
Théo DELRIEU 已提交
12574
                    }
N
Niels 已提交
12575
                }
T
Théo DELRIEU 已提交
12576 12577 12578 12579

                // finally, store the reference token
                unescape(reference_token);
                result.push_back(reference_token);
12580
            }
N
Niels 已提交
12581

T
Théo DELRIEU 已提交
12582
            return result;
N
Niels 已提交
12583
        }
N
Niels 已提交
12584

T
Théo DELRIEU 已提交
12585 12586
        /*!
        @brief replace all occurrences of a substring by another string
N
Niels 已提交
12587

T
Théo DELRIEU 已提交
12588 12589 12590 12591
        @param[in,out] s  the string to manipulate; changed so that all
                          occurrences of @a f are replaced with @a t
        @param[in]     f  the substring to replace with @a t
        @param[in]     t  the string to replace @a f
N
Niels 已提交
12592

N
Niels Lohmann 已提交
12593 12594
        @pre The search string @a f must not be empty. **This precondition is
             enforced with an assertion.**
N
Niels 已提交
12595

T
Théo DELRIEU 已提交
12596 12597 12598 12599 12600 12601 12602
        @since version 2.0.0
        */
        static void replace_substring(std::string& s,
                                      const std::string& f,
                                      const std::string& t)
        {
            assert(not f.empty());
N
Niels 已提交
12603

T
Théo DELRIEU 已提交
12604 12605 12606 12607 12608 12609 12610
            for (
                size_t pos = s.find(f);         // find first occurrence of f
                pos != std::string::npos;       // make sure f was found
                s.replace(pos, f.size(), t),    // replace with t
                pos = s.find(f, pos + t.size()) // find next occurrence of f
            );
        }
N
Niels 已提交
12611

T
Théo DELRIEU 已提交
12612 12613 12614 12615 12616 12617 12618 12619
        /// escape tilde and slash
        static std::string escape(std::string s)
        {
            // escape "~"" to "~0" and "/" to "~1"
            replace_substring(s, "~", "~0");
            replace_substring(s, "/", "~1");
            return s;
        }
N
Niels 已提交
12620

T
Théo DELRIEU 已提交
12621 12622 12623 12624 12625 12626 12627 12628
        /// unescape tilde and slash
        static void unescape(std::string& s)
        {
            // first transform any occurrence of the sequence '~1' to '/'
            replace_substring(s, "~1", "/");
            // then transform any occurrence of the sequence '~0' to '~'
            replace_substring(s, "~0", "~");
        }
N
Niels 已提交
12629

T
Théo DELRIEU 已提交
12630 12631 12632 12633
        /*!
        @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
12634

T
Théo DELRIEU 已提交
12635 12636 12637 12638 12639
        @note Empty objects or arrays are flattened to `null`.
        */
        static void flatten(const std::string& reference_string,
                            const basic_json& value,
                            basic_json& result)
N
Niels 已提交
12640
        {
T
Théo DELRIEU 已提交
12641
            switch (value.m_type)
N
Niels 已提交
12642
            {
T
Théo DELRIEU 已提交
12643
                case value_t::array:
12644
                {
T
Théo DELRIEU 已提交
12645 12646 12647 12648 12649 12650
                    if (value.m_value.array->empty())
                    {
                        // flatten empty array as null
                        result[reference_string] = nullptr;
                    }
                    else
N
Niels 已提交
12651
                    {
T
Théo DELRIEU 已提交
12652 12653 12654 12655 12656 12657
                        // 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 已提交
12658
                    }
T
Théo DELRIEU 已提交
12659
                    break;
N
Niels 已提交
12660 12661
                }

T
Théo DELRIEU 已提交
12662
                case value_t::object:
12663
                {
T
Théo DELRIEU 已提交
12664 12665 12666 12667 12668 12669
                    if (value.m_value.object->empty())
                    {
                        // flatten empty object as null
                        result[reference_string] = nullptr;
                    }
                    else
N
Niels 已提交
12670
                    {
T
Théo DELRIEU 已提交
12671 12672 12673 12674 12675 12676
                        // iterate object and use keys as reference string
                        for (const auto& element : *value.m_value.object)
                        {
                            flatten(reference_string + "/" + escape(element.first),
                                    element.second, result);
                        }
N
Niels 已提交
12677
                    }
T
Théo DELRIEU 已提交
12678
                    break;
N
Niels 已提交
12679 12680
                }

T
Théo DELRIEU 已提交
12681 12682 12683 12684 12685 12686
                default:
                {
                    // add primitive value with its reference string
                    result[reference_string] = value;
                    break;
                }
N
Niels 已提交
12687 12688
            }
        }
N
Niels 已提交
12689

T
Théo DELRIEU 已提交
12690 12691
        /*!
        @param[in] value  flattened JSON
N
Niels 已提交
12692

T
Théo DELRIEU 已提交
12693
        @return unflattened JSON
N
Niels Lohmann 已提交
12694 12695 12696 12697 12698

        @throw parse_error.109 if array index is not a number
        @throw type_error.314  if value is not an object
        @throw type_error.315  if object values are not primitive
        @throw type_error.313  if value cannot be unflattened
T
Théo DELRIEU 已提交
12699 12700
        */
        static basic_json unflatten(const basic_json& value)
N
Niels 已提交
12701
        {
T
Théo DELRIEU 已提交
12702 12703
            if (not value.is_object())
            {
12704
                JSON_THROW(type_error(314, "only objects can be unflattened"));
T
Théo DELRIEU 已提交
12705
            }
N
Niels 已提交
12706

T
Théo DELRIEU 已提交
12707
            basic_json result;
N
Niels 已提交
12708

T
Théo DELRIEU 已提交
12709 12710
            // iterate the JSON object values
            for (const auto& element : *value.m_value.object)
N
Niels 已提交
12711
            {
T
Théo DELRIEU 已提交
12712 12713
                if (not element.second.is_primitive())
                {
12714
                    JSON_THROW(type_error(315, "values in object must be primitive"));
T
Théo DELRIEU 已提交
12715 12716 12717 12718 12719 12720 12721 12722
                }

                // 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.
                json_pointer(element.first).get_and_create(result) = element.second;
N
Niels 已提交
12723 12724
            }

T
Théo DELRIEU 已提交
12725
            return result;
N
Niels 已提交
12726
        }
N
Niels 已提交
12727

T
Théo DELRIEU 已提交
12728 12729 12730 12731 12732
        friend bool operator==(json_pointer const& lhs,
                               json_pointer const& rhs) noexcept
        {
            return lhs.reference_tokens == rhs.reference_tokens;
        }
12733

T
Théo DELRIEU 已提交
12734 12735 12736 12737 12738
        friend bool operator!=(json_pointer const& lhs,
                               json_pointer const& rhs) noexcept
        {
            return !(lhs == rhs);
        }
12739

T
Théo DELRIEU 已提交
12740 12741
        /// the reference tokens
        std::vector<std::string> reference_tokens {};
12742
    };
N
Niels 已提交
12743

N
Niels 已提交
12744 12745 12746
    //////////////////////////
    // JSON Pointer support //
    //////////////////////////
N
Niels 已提交
12747 12748 12749 12750

    /// @name JSON Pointer functions
    /// @{

N
Niels 已提交
12751 12752 12753 12754
    /*!
    @brief access specified element via JSON Pointer

    Uses a JSON pointer to retrieve a reference to the respective JSON value.
N
Niels 已提交
12755 12756 12757
    No bound checking is performed. Similar to @ref operator[](const typename
    object_t::key_type&), `null` values are created in arrays and objects if
    necessary.
N
Niels 已提交
12758 12759 12760 12761 12762 12763 12764 12765 12766 12767 12768 12769 12770 12771 12772 12773 12774 12775

    In particular:
    - If the JSON pointer points to an object key that does not exist, it
      is created an filled with a `null` value before a reference to it
      is returned.
    - If the JSON pointer points to an array index that does not exist, it
      is created an filled with a `null` value before a reference to it
      is returned. All indices between the current maximum and the given
      index are also filled with `null`.
    - The special value `-` is treated as a synonym for the index past the
      end.

    @param[in] ptr  a JSON pointer

    @return reference to the element pointed to by @a ptr

    @complexity Constant.

N
Niels Lohmann 已提交
12776 12777 12778
    @throw parse_error.106   if an array index begins with '0'
    @throw parse_error.109   if an array index was not a number
    @throw out_of_range.404  if the JSON pointer can not be resolved
N
Niels 已提交
12779 12780 12781 12782 12783 12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794 12795 12796 12797 12798 12799 12800 12801 12802

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

    @since version 2.0.0
    */
    reference operator[](const json_pointer& ptr)
    {
        return ptr.get_unchecked(this);
    }

    /*!
    @brief access specified element via JSON Pointer

    Uses a JSON pointer to retrieve a reference to the respective JSON value.
    No bound checking is performed. The function does not change the JSON
    value; no `null` values are created. In particular, the the special value
    `-` yields an exception.

    @param[in] ptr  JSON pointer to the desired element

    @return const reference to the element pointed to by @a ptr

    @complexity Constant.

N
Niels Lohmann 已提交
12803 12804 12805 12806
    @throw parse_error.106   if an array index begins with '0'
    @throw parse_error.109   if an array index was not a number
    @throw out_of_range.402  if the array index '-' is used
    @throw out_of_range.404  if the JSON pointer can not be resolved
N
Niels 已提交
12807 12808 12809 12810 12811 12812 12813 12814 12815 12816 12817 12818 12819 12820 12821 12822 12823 12824 12825 12826

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

    @since version 2.0.0
    */
    const_reference operator[](const json_pointer& ptr) const
    {
        return ptr.get_unchecked(this);
    }

    /*!
    @brief access specified element via JSON Pointer

    Returns a reference to the element at with specified JSON pointer @a ptr,
    with bounds checking.

    @param[in] ptr  JSON pointer to the desired element

    @return reference to the element pointed to by @a ptr

12827
    @throw parse_error.106 if an array index in the passed JSON pointer @a ptr
12828
    begins with '0'. See example below.
12829 12830

    @throw parse_error.109 if an array index in the passed JSON pointer @a ptr
12831
    is not a number. See example below.
12832

12833 12834 12835 12836
    @throw out_of_range.401 if an array index in the passed JSON pointer @a ptr
    is out of range. See example below.

    @throw out_of_range.402 if the array index '-' is used in the passed JSON
12837
    pointer @a ptr. As `at` provides checked access (and no elements are
12838 12839 12840 12841
    implicitly inserted), the index '-' is always invalid. See example below.

    @throw out_of_range.404 if the JSON pointer @a ptr can not be resolved.
    See example below.
12842

12843 12844
    @exceptionsafety Strong guarantee: if an exception is thrown, there are no
    changes in the JSON value.
N
Niels 已提交
12845

12846
    @complexity Constant.
N
Niels 已提交
12847 12848

    @since version 2.0.0
12849 12850

    @liveexample{The behavior is shown in the example.,at_json_pointer}
N
Niels 已提交
12851 12852 12853 12854 12855 12856 12857 12858 12859
    */
    reference at(const json_pointer& ptr)
    {
        return ptr.get_checked(this);
    }

    /*!
    @brief access specified element via JSON Pointer

N
Niels 已提交
12860 12861
    Returns a const reference to the element at with specified JSON pointer @a
    ptr, with bounds checking.
N
Niels 已提交
12862 12863 12864 12865 12866

    @param[in] ptr  JSON pointer to the desired element

    @return reference to the element pointed to by @a ptr

12867
    @throw parse_error.106 if an array index in the passed JSON pointer @a ptr
12868
    begins with '0'. See example below.
12869 12870

    @throw parse_error.109 if an array index in the passed JSON pointer @a ptr
12871 12872 12873 12874
    is not a number. See example below.

    @throw out_of_range.401 if an array index in the passed JSON pointer @a ptr
    is out of range. See example below.
12875

12876
    @throw out_of_range.402 if the array index '-' is used in the passed JSON
12877
    pointer @a ptr. As `at` provides checked access (and no elements are
12878
    implicitly inserted), the index '-' is always invalid. See example below.
12879

12880 12881
    @throw out_of_range.404 if the JSON pointer @a ptr can not be resolved.
    See example below.
N
Niels 已提交
12882

12883 12884 12885 12886
    @exceptionsafety Strong guarantee: if an exception is thrown, there are no
    changes in the JSON value.

    @complexity Constant.
N
Niels 已提交
12887 12888

    @since version 2.0.0
12889 12890

    @liveexample{The behavior is shown in the example.,at_json_pointer_const}
N
Niels 已提交
12891 12892 12893 12894 12895 12896
    */
    const_reference at(const json_pointer& ptr) const
    {
        return ptr.get_checked(this);
    }

N
Niels 已提交
12897
    /*!
N
Niels 已提交
12898 12899
    @brief return flattened JSON value

N
Niels 已提交
12900 12901 12902 12903
    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 已提交
12904

N
Niels Lohmann 已提交
12905
    @return an object that maps JSON pointers to primitive values
N
Niels 已提交
12906

N
Niels 已提交
12907 12908
    @note Empty objects and arrays are flattened to `null` and will not be
          reconstructed correctly by the @ref unflatten() function.
N
Niels 已提交
12909 12910 12911 12912 12913 12914 12915 12916 12917

    @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 已提交
12918 12919 12920 12921 12922 12923 12924
    */
    basic_json flatten() const
    {
        basic_json result(value_t::object);
        json_pointer::flatten("", *this, result);
        return result;
    }
N
Niels 已提交
12925 12926

    /*!
N
Niels 已提交
12927 12928 12929 12930 12931 12932 12933 12934 12935 12936
    @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 已提交
12937
    @return the original JSON from a flattened version
N
Niels 已提交
12938 12939 12940 12941 12942 12943 12944 12945

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

N
Niels Lohmann 已提交
12946 12947 12948
    @throw type_error.314  if value is not an object
    @throw type_error.315  if object values are not primitve

N
Niels 已提交
12949 12950 12951 12952 12953 12954
    @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 已提交
12955
    */
N
Niels 已提交
12956
    basic_json unflatten() const
N
Niels 已提交
12957
    {
N
Niels 已提交
12958
        return json_pointer::unflatten(*this);
N
Niels 已提交
12959
    }
N
Niels 已提交
12960 12961

    /// @}
12962

N
Niels 已提交
12963 12964 12965 12966 12967 12968 12969
    //////////////////////////
    // JSON Patch functions //
    //////////////////////////

    /// @name JSON Patch functions
    /// @{

12970 12971 12972
    /*!
    @brief applies a JSON patch

N
Niels 已提交
12973 12974
    [JSON Patch](http://jsonpatch.com) defines a JSON document structure for
    expressing a sequence of operations to apply to a JSON) document. With
N
Niels Lohmann 已提交
12975
    this function, a JSON Patch is applied to the current JSON value by
N
Niels 已提交
12976 12977
    executing all operations from the patch.

N
Niels 已提交
12978
    @param[in] json_patch  JSON patch document
12979 12980
    @return patched document

N
Niels 已提交
12981 12982 12983 12984 12985
    @note The application of a patch is atomic: Either all operations succeed
          and the patched document is returned or an exception is thrown. In
          any case, the original value is not changed: the patch is applied
          to a copy of the value.

N
Niels Lohmann 已提交
12986 12987 12988 12989 12990 12991 12992 12993
    @throw parse_error.104 if the JSON patch does not consist of an array of
    objects

    @throw parse_error.105 if the JSON patch is malformed (e.g., mandatory
    attributes are missing); example: `"operation add must have member path"`

    @throw out_of_range.401 if an array index is out of range.

12994 12995 12996
    @throw out_of_range.403 if a JSON pointer inside the patch could not be
    resolved successfully in the current JSON value; example: `"key baz not
    found"`
N
Niels Lohmann 已提交
12997 12998 12999 13000 13001

    @throw out_of_range.405 if JSON pointer has no parent ("add", "remove",
    "move")

    @throw other_error.501 if "test" operation was unsuccessful
N
Niels 已提交
13002 13003 13004 13005

    @complexity Linear in the size of the JSON value and the length of the
    JSON patch. As usually only a fraction of the JSON value is affected by
    the patch, the complexity can usually be neglected.
13006

N
Niels 已提交
13007 13008 13009 13010 13011 13012 13013 13014 13015
    @liveexample{The following code shows how a JSON patch is applied to a
    value.,patch}

    @sa @ref diff -- create a JSON patch by comparing two JSON values

    @sa [RFC 6902 (JSON Patch)](https://tools.ietf.org/html/rfc6902)
    @sa [RFC 6901 (JSON Pointer)](https://tools.ietf.org/html/rfc6901)

    @since version 2.0.0
13016
    */
N
Niels 已提交
13017
    basic_json patch(const basic_json& json_patch) const
13018
    {
N
Niels 已提交
13019
        // make a working copy to apply the patch to
13020 13021
        basic_json result = *this;

N
Niels 已提交
13022 13023 13024
        // the valid JSON Patch operations
        enum class patch_operations {add, remove, replace, move, copy, test, invalid};

N
Niels Lohmann 已提交
13025
        const auto get_op = [](const std::string & op)
N
Niels 已提交
13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036 13037 13038 13039 13040 13041 13042 13043 13044 13045 13046 13047 13048 13049 13050 13051 13052 13053 13054
        {
            if (op == "add")
            {
                return patch_operations::add;
            }
            if (op == "remove")
            {
                return patch_operations::remove;
            }
            if (op == "replace")
            {
                return patch_operations::replace;
            }
            if (op == "move")
            {
                return patch_operations::move;
            }
            if (op == "copy")
            {
                return patch_operations::copy;
            }
            if (op == "test")
            {
                return patch_operations::test;
            }

            return patch_operations::invalid;
        };

N
Niels 已提交
13055
        // wrapper for "add" operation; add value at ptr
N
Niels 已提交
13056
        const auto operation_add = [&result](json_pointer & ptr, basic_json val)
N
Niels 已提交
13057
        {
N
Niels 已提交
13058 13059
            // adding to the root of the target document means replacing it
            if (ptr.is_root())
N
Niels 已提交
13060
            {
N
Niels 已提交
13061
                result = val;
N
Niels 已提交
13062
            }
N
Niels 已提交
13063
            else
N
Niels 已提交
13064
            {
N
Niels 已提交
13065 13066 13067
                // make sure the top element of the pointer exists
                json_pointer top_pointer = ptr.top();
                if (top_pointer != ptr)
N
Niels 已提交
13068
                {
N
Niels 已提交
13069
                    result.at(top_pointer);
N
Niels 已提交
13070
                }
N
Niels 已提交
13071 13072 13073 13074 13075 13076

                // get reference to parent of JSON pointer ptr
                const auto last_path = ptr.pop_back();
                basic_json& parent = result[ptr];

                switch (parent.m_type)
N
Niels 已提交
13077
                {
N
Niels 已提交
13078 13079 13080 13081 13082 13083 13084 13085 13086 13087 13088 13089 13090 13091 13092 13093 13094 13095 13096 13097 13098
                    case value_t::null:
                    case value_t::object:
                    {
                        // use operator[] to add value
                        parent[last_path] = val;
                        break;
                    }

                    case value_t::array:
                    {
                        if (last_path == "-")
                        {
                            // special case: append to back
                            parent.push_back(val);
                        }
                        else
                        {
                            const auto idx = std::stoi(last_path);
                            if (static_cast<size_type>(idx) > parent.size())
                            {
                                // avoid undefined behavior
13099
                                JSON_THROW(out_of_range(401, "array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
13100 13101 13102 13103 13104 13105 13106 13107 13108 13109 13110 13111
                            }
                            else
                            {
                                // default case: insert add offset
                                parent.insert(parent.begin() + static_cast<difference_type>(idx), val);
                            }
                        }
                        break;
                    }

                    default:
                    {
N
Niels 已提交
13112 13113
                        // if there exists a parent it cannot be primitive
                        assert(false);  // LCOV_EXCL_LINE
N
Niels 已提交
13114
                    }
N
Niels 已提交
13115 13116 13117 13118
                }
            }
        };

N
Niels 已提交
13119
        // wrapper for "remove" operation; remove value at ptr
N
Niels 已提交
13120 13121
        const auto operation_remove = [&result](json_pointer & ptr)
        {
N
Niels 已提交
13122
            // get reference to parent of JSON pointer ptr
N
Niels 已提交
13123 13124
            const auto last_path = ptr.pop_back();
            basic_json& parent = result.at(ptr);
N
Niels 已提交
13125 13126

            // remove child
N
Niels 已提交
13127 13128
            if (parent.is_object())
            {
N
Niels 已提交
13129 13130 13131 13132 13133 13134 13135 13136
                // perform range check
                auto it = parent.find(last_path);
                if (it != parent.end())
                {
                    parent.erase(it);
                }
                else
                {
13137
                    JSON_THROW(out_of_range(403, "key '" + last_path + "' not found"));
N
Niels 已提交
13138
                }
N
Niels 已提交
13139 13140 13141
            }
            else if (parent.is_array())
            {
N
Niels 已提交
13142 13143
                // note erase performs range check
                parent.erase(static_cast<size_type>(std::stoi(last_path)));
N
Niels 已提交
13144 13145 13146
            }
        };

13147
        // type check: top level value must be an array
N
Niels 已提交
13148
        if (not json_patch.is_array())
N
Niels 已提交
13149
        {
13150
            JSON_THROW(parse_error(104, 0, "JSON patch must be an array of objects"));
N
Niels 已提交
13151 13152
        }

N
Niels Lohmann 已提交
13153
        // iterate and apply the operations
N
Niels 已提交
13154
        for (const auto& val : json_patch)
13155
        {
N
Niels 已提交
13156 13157 13158
            // wrapper to get a value for an operation
            const auto get_value = [&val](const std::string & op,
                                          const std::string & member,
N
Niels 已提交
13159
                                          bool string_type) -> basic_json&
13160
            {
N
Niels 已提交
13161 13162
                // find value
                auto it = val.m_value.object->find(member);
13163

N
Niels 已提交
13164 13165
                // context-sensitive error message
                const auto error_msg = (op == "op") ? "operation" : "operation '" + op + "'";
13166

N
Niels 已提交
13167 13168 13169
                // check if desired value is present
                if (it == val.m_value.object->end())
                {
13170
                    JSON_THROW(parse_error(105, 0, error_msg + " must have member '" + member + "'"));
N
Niels 已提交
13171
                }
13172

N
Niels 已提交
13173 13174 13175
                // check if result is of type string
                if (string_type and not it->second.is_string())
                {
13176
                    JSON_THROW(parse_error(105, 0, error_msg + " must have string member '" + member + "'"));
N
Niels 已提交
13177 13178 13179 13180 13181 13182
                }

                // no error: return value
                return it->second;
            };

13183
            // type check: every element of the array must be an object
N
Niels 已提交
13184
            if (not val.is_object())
13185
            {
13186
                JSON_THROW(parse_error(104, 0, "JSON patch must be an array of objects"));
13187 13188
            }

N
Niels 已提交
13189 13190 13191
            // collect mandatory members
            const std::string op = get_value("op", "op", true);
            const std::string path = get_value(op, "path", true);
N
oops  
Niels 已提交
13192
            json_pointer ptr(path);
13193

N
Niels 已提交
13194
            switch (get_op(op))
13195
            {
N
Niels 已提交
13196 13197 13198 13199 13200 13201 13202 13203 13204 13205 13206 13207 13208 13209 13210 13211 13212 13213 13214 13215 13216 13217 13218 13219 13220 13221 13222 13223 13224 13225 13226 13227 13228 13229 13230 13231 13232 13233 13234 13235 13236 13237 13238 13239 13240 13241 13242 13243 13244
                case patch_operations::add:
                {
                    operation_add(ptr, get_value("add", "value", false));
                    break;
                }

                case patch_operations::remove:
                {
                    operation_remove(ptr);
                    break;
                }

                case patch_operations::replace:
                {
                    // the "path" location must exist - use at()
                    result.at(ptr) = get_value("replace", "value", false);
                    break;
                }

                case patch_operations::move:
                {
                    const std::string from_path = get_value("move", "from", true);
                    json_pointer from_ptr(from_path);

                    // the "from" location must exist - use at()
                    basic_json v = result.at(from_ptr);

                    // The move operation is functionally identical to a
                    // "remove" operation on the "from" location, followed
                    // immediately by an "add" operation at the target
                    // location with the value that was just removed.
                    operation_remove(from_ptr);
                    operation_add(ptr, v);
                    break;
                }

                case patch_operations::copy:
                {
                    const std::string from_path = get_value("copy", "from", true);;
                    const json_pointer from_ptr(from_path);

                    // the "from" location must exist - use at()
                    result[ptr] = result.at(from_ptr);
                    break;
                }

                case patch_operations::test:
                {
                    bool success = false;
13245
                    JSON_TRY
N
Niels 已提交
13246 13247 13248 13249 13250
                    {
                        // check if "value" matches the one at "path"
                        // the "path" location must exist - use at()
                        success = (result.at(ptr) == get_value("test", "value", false));
                    }
13251
                    JSON_CATCH (out_of_range&)
N
Niels 已提交
13252 13253 13254 13255 13256 13257 13258
                    {
                        // ignore out of range errors: success remains false
                    }

                    // throw an exception if test fails
                    if (not success)
                    {
13259
                        JSON_THROW(other_error(501, "unsuccessful: " + val.dump()));
N
Niels 已提交
13260 13261 13262 13263 13264 13265 13266 13267 13268
                    }

                    break;
                }

                case patch_operations::invalid:
                {
                    // op must be "add", "remove", "replace", "move", "copy", or
                    // "test"
13269
                    JSON_THROW(parse_error(105, 0, "operation value '" + op + "' is invalid"));
N
Niels 已提交
13270
                }
13271
            }
N
Niels 已提交
13272 13273 13274 13275 13276 13277 13278 13279 13280 13281 13282 13283 13284 13285 13286 13287 13288 13289 13290 13291
        }

        return result;
    }

    /*!
    @brief creates a diff as a JSON patch

    Creates a [JSON Patch](http://jsonpatch.com) so that value @a source can
    be changed into the value @a target by calling @ref patch function.

    @invariant For two JSON values @a source and @a target, the following code
    yields always `true`:
    @code {.cpp}
    source.patch(diff(source, target)) == target;
    @endcode

    @note Currently, only `remove`, `add`, and `replace` operations are
          generated.

N
Niels Lohmann 已提交
13292 13293
    @param[in] source  JSON value to compare from
    @param[in] target  JSON value to compare against
N
Niels 已提交
13294 13295 13296 13297 13298 13299 13300 13301 13302 13303 13304 13305 13306 13307 13308 13309 13310
    @param[in] path    helper value to create JSON pointers

    @return a JSON patch to convert the @a source to @a target

    @complexity Linear in the lengths of @a source and @a target.

    @liveexample{The following code shows how a JSON patch is created as a
    diff for two JSON values.,diff}

    @sa @ref patch -- apply a JSON patch

    @sa [RFC 6902 (JSON Patch)](https://tools.ietf.org/html/rfc6902)

    @since version 2.0.0
    */
    static basic_json diff(const basic_json& source,
                           const basic_json& target,
13311
                           const std::string& path = "")
N
Niels 已提交
13312 13313 13314 13315 13316 13317 13318 13319 13320 13321 13322 13323 13324 13325
    {
        // the patch
        basic_json result(value_t::array);

        // if the values are the same, return empty patch
        if (source == target)
        {
            return result;
        }

        if (source.type() != target.type())
        {
            // different types: replace value
            result.push_back(
13326
            {
N
Niels 已提交
13327 13328 13329 13330 13331 13332 13333 13334
                {"op", "replace"},
                {"path", path},
                {"value", target}
            });
        }
        else
        {
            switch (source.type())
13335
            {
N
Niels 已提交
13336 13337 13338 13339 13340 13341 13342 13343 13344 13345 13346
                case value_t::array:
                {
                    // first pass: traverse common elements
                    size_t i = 0;
                    while (i < source.size() and i < target.size())
                    {
                        // recursive call to compare array values at index i
                        auto temp_diff = diff(source[i], target[i], path + "/" + std::to_string(i));
                        result.insert(result.end(), temp_diff.begin(), temp_diff.end());
                        ++i;
                    }
N
Niels 已提交
13347

N
Niels 已提交
13348 13349
                    // i now reached the end of at least one array
                    // in a second pass, traverse the remaining elements
N
Niels 已提交
13350

N
Niels 已提交
13351
                    // remove my remaining elements
N
Niels 已提交
13352
                    const auto end_index = static_cast<difference_type>(result.size());
N
Niels 已提交
13353 13354
                    while (i < source.size())
                    {
N
Niels 已提交
13355 13356
                        // add operations in reverse order to avoid invalid
                        // indices
N
Niels 已提交
13357
                        result.insert(result.begin() + end_index, object(
N
Niels 已提交
13358 13359 13360 13361 13362 13363 13364 13365 13366 13367 13368 13369 13370 13371 13372 13373 13374 13375 13376 13377 13378 13379 13380
                        {
                            {"op", "remove"},
                            {"path", path + "/" + std::to_string(i)}
                        }));
                        ++i;
                    }

                    // add other remaining elements
                    while (i < target.size())
                    {
                        result.push_back(
                        {
                            {"op", "add"},
                            {"path", path + "/" + std::to_string(i)},
                            {"value", target[i]}
                        });
                        ++i;
                    }

                    break;
                }

                case value_t::object:
13381
                {
N
Niels 已提交
13382 13383 13384 13385 13386 13387 13388 13389 13390 13391 13392 13393 13394 13395 13396 13397 13398 13399 13400 13401 13402 13403 13404 13405 13406 13407 13408 13409 13410 13411 13412 13413 13414 13415 13416 13417 13418 13419 13420 13421 13422 13423 13424 13425 13426 13427 13428 13429 13430 13431 13432 13433
                    // first pass: traverse this object's elements
                    for (auto it = source.begin(); it != source.end(); ++it)
                    {
                        // escape the key name to be used in a JSON patch
                        const auto key = json_pointer::escape(it.key());

                        if (target.find(it.key()) != target.end())
                        {
                            // recursive call to compare object values at key it
                            auto temp_diff = diff(it.value(), target[it.key()], path + "/" + key);
                            result.insert(result.end(), temp_diff.begin(), temp_diff.end());
                        }
                        else
                        {
                            // found a key that is not in o -> remove it
                            result.push_back(object(
                            {
                                {"op", "remove"},
                                {"path", path + "/" + key}
                            }));
                        }
                    }

                    // second pass: traverse other object's elements
                    for (auto it = target.begin(); it != target.end(); ++it)
                    {
                        if (source.find(it.key()) == source.end())
                        {
                            // found a key that is not in this -> add it
                            const auto key = json_pointer::escape(it.key());
                            result.push_back(
                            {
                                {"op", "add"},
                                {"path", path + "/" + key},
                                {"value", it.value()}
                            });
                        }
                    }

                    break;
                }

                default:
                {
                    // both primitive type: replace value
                    result.push_back(
                    {
                        {"op", "replace"},
                        {"path", path},
                        {"value", target}
                    });
                    break;
13434 13435 13436 13437 13438 13439
                }
            }
        }

        return result;
    }
N
Niels 已提交
13440 13441

    /// @}
N
Niels 已提交
13442 13443 13444 13445 13446 13447
};

/////////////
// presets //
/////////////

N
Niels 已提交
13448 13449 13450
/*!
@brief default JSON class

N
Niels 已提交
13451 13452
This type is the default specialization of the @ref basic_json class which
uses the standard template types.
N
Niels 已提交
13453

N
Niels 已提交
13454
@since version 1.0.0
N
Niels 已提交
13455
*/
N
Niels 已提交
13456
using json = basic_json<>;
N
Niels Lohmann 已提交
13457
} // namespace nlohmann
N
Niels 已提交
13458 13459


N
Niels 已提交
13460 13461 13462
///////////////////////
// nonmember support //
///////////////////////
N
Niels 已提交
13463 13464 13465

// specialization of std::swap, and std::hash
namespace std
T
Théo DELRIEU 已提交
13466 13467 13468 13469 13470 13471 13472 13473 13474 13475 13476 13477 13478 13479 13480 13481 13482 13483 13484
{
/*!
@brief exchanges the values of two JSON objects

@since version 1.0.0
*/
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 已提交
13485
{
N
Niels 已提交
13486
    /*!
T
Théo DELRIEU 已提交
13487
    @brief return a hash value for a JSON object
N
Niels 已提交
13488

N
Niels 已提交
13489
    @since version 1.0.0
N
Niels 已提交
13490
    */
T
Théo DELRIEU 已提交
13491
    std::size_t operator()(const nlohmann::json& j) const
N
Niels 已提交
13492 13493
    {
        // a naive hashing via the string representation
N
Niels 已提交
13494 13495
        const auto& h = hash<nlohmann::json::string_t>();
        return h(j.dump());
N
Niels 已提交
13496
    }
T
Théo DELRIEU 已提交
13497
};
13498 13499 13500 13501 13502 13503 13504 13505 13506 13507 13508 13509 13510 13511 13512 13513

/// specialization for std::less<value_t>
template <>
struct less<::nlohmann::detail::value_t>
{
    /*!
    @brief compare two value_t enum values
    @since version 3.0.0
    */
    bool operator()(nlohmann::detail::value_t lhs,
                    nlohmann::detail::value_t rhs) const noexcept
    {
        return nlohmann::detail::operator<(lhs, rhs);
    }
};

N
Niels Lohmann 已提交
13514
} // namespace std
N
Niels 已提交
13515 13516

/*!
N
Niels 已提交
13517 13518
@brief user-defined string literal for JSON values

N
Niels 已提交
13519
This operator implements a user-defined string literal for JSON objects. It
N
Niels 已提交
13520
can be used by adding `"_json"` to a string literal and returns a JSON object
N
Niels 已提交
13521
if no parse error occurred.
N
Niels 已提交
13522

N
Niels 已提交
13523
@param[in] s  a string representation of a JSON object
13524
@param[in] n  the length of string @a s
N
Niels 已提交
13525
@return a JSON object
N
Niels 已提交
13526

N
Niels 已提交
13527
@since version 1.0.0
N
Niels 已提交
13528
*/
13529
inline nlohmann::json operator "" _json(const char* s, std::size_t n)
N
Niels 已提交
13530
{
13531
    return nlohmann::json::parse(s, s + n);
N
Niels 已提交
13532 13533
}

N
Niels 已提交
13534 13535 13536
/*!
@brief user-defined string literal for JSON pointer

N
Niels 已提交
13537
This operator implements a user-defined string literal for JSON Pointers. It
N
Niels 已提交
13538
can be used by adding `"_json_pointer"` to a string literal and returns a JSON pointer
N
Niels 已提交
13539 13540 13541
object if no parse error occurred.

@param[in] s  a string representation of a JSON Pointer
13542
@param[in] n  the length of string @a s
N
Niels 已提交
13543 13544
@return a JSON pointer object

N
Niels 已提交
13545 13546
@since version 2.0.0
*/
13547
inline nlohmann::json::json_pointer operator "" _json_pointer(const char* s, std::size_t n)
N
Niels 已提交
13548
{
13549
    return nlohmann::json::json_pointer(std::string(s, n));
N
Niels 已提交
13550 13551
}

13552 13553 13554 13555 13556
// restore GCC/clang diagnostic settings
#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
    #pragma GCC diagnostic pop
#endif

13557 13558
// clean up
#undef JSON_CATCH
N
Niels Lohmann 已提交
13559 13560
#undef JSON_THROW
#undef JSON_TRY
13561

N
Niels 已提交
13562
#endif