json.hpp 458.1 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 56
#include <map> // map
#include <memory> // addressof, allocator, allocator_traits, unique_ptr
#include <numeric> // accumulate
#include <sstream> // stringstream
#include <stdexcept> // domain_error, invalid_argument, out_of_range
#include <string> // getline, stoi, string, to_string
N
Niels Lohmann 已提交
57
#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 已提交
58 59
#include <utility> // declval, forward, make_pair, move, pair, swap
#include <vector> // vector
N
Niels 已提交
60

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

72 73 74 75
// 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 已提交
76 77 78 79 80
#endif

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

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

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

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

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

@since version 2.1.0
*/
111 112
namespace detail
{
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 158
////////////////
// 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
159 160
      file. This also holds true when reading a byte vector (CBOR or
      MessagePack).
161 162 163 164 165 166 167 168 169 170 171 172 173 174

Exceptions have ids 1xx.

name / id                      | example massage | description
------------------------------ | --------------- | -------------------------
json.exception.[parse_error](@ref 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 @ref parse_error::byte indicates the error position.
json.exception.[parse_error](@ref 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](@ref 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](@ref 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](@ref 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](@ref 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](@ref 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](@ref 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](@ref parse_error).109 | "parse error: array index 'one' is not a number" | A JSON Pointer array index must be a number.
175
json.exception.[parse_error](@ref 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.
176
json.exception.[parse_error](@ref parse_error).111 | "parse error: bad input stream" | Parsing CBOR or MessagePack from an input stream where the `badbit` or `failbit` is set.
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 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
    */
    const size_t byte;
};

/*!
@brief exception indicating errors with iterators

Exceptions have ids 2xx.

name / id                      | example massage | description
------------------------------ | --------------- | -------------------------
json.exception.[invalid_iterator](@ref 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](@ref 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](@ref 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](@ref 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](@ref 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](@ref 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](@ref 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](@ref 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](@ref 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](@ref 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](@ref 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](@ref 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](@ref 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](@ref 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().

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

name / id                      | example massage | description
------------------------------ | --------------- | -------------------------
json.exception.[type_error](@ref 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](@ref 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](@ref 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](@ref 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](@ref 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](@ref 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](@ref 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](@ref 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](@ref type_error).309 | "cannot use insert() with" | The @ref insert() member functions can only be executed for certain JSON types.
json.exception.[type_error](@ref 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](@ref 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](@ref 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](@ref 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](@ref 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.

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

name / id                      | example massage | description
------------------------------ | --------------- | -------------------------
json.exception.[out_of_range](@ref 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](@ref 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.
json.exception.[out_of_range](@ref out_of_range).403 | "key 'foo' not found" | The provided key was not found in the JSON object.
json.exception.[out_of_range](@ref out_of_range).404 | "unresolved reference token 'foo'" | A reference token in a JSON Pointer could not be resolved.
json.exception.[out_of_range](@ref 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.

@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
///////////////////////////
// JSON type enumeration //
///////////////////////////

/*!
@brief the JSON type enumeration

305 306 307 308 309 310 311
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 已提交
312
@ref basic_json::is_structured() rely on it.
313

314 315 316 317 318 319
@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.
320

321 322
@sa @ref basic_json::basic_json(const value_t value_type) -- create a JSON
value with the default value for a given type
323 324 325 326 327

@since version 1.0.0
*/
enum class value_t : uint8_t
{
T
Théo DELRIEU 已提交
328 329 330 331 332 333 334 335 336
    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
337 338
};

339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
/*!
@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)];
}

372 373 374 375 376

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

377
// alias templates to reduce boilerplate
378
template<bool B, typename T = void>
379 380
using enable_if_t = typename std::enable_if<B, T>::type;

381
template<typename T>
T
Théo DELRIEU 已提交
382
using uncvref_t = typename std::remove_cv<typename std::remove_reference<T>::type>::type;
383

N
Niels Lohmann 已提交
384
// taken from http://stackoverflow.com/a/26936864/266378
385
template<typename T>
T
Théo DELRIEU 已提交
386 387
using is_unscoped_enum =
    std::integral_constant<bool, std::is_convertible<T, int>::value and
388
    std::is_enum<T>::value>;
T
Théo DELRIEU 已提交
389

390
/*
N
Niels Lohmann 已提交
391
Implementation of two C++17 constructs: conjunction, negation. This is needed
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
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 {};
407

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

410
// dispatch utility (taken from ranges-v3)
411 412
template<unsigned N> struct priority_tag : priority_tag < N - 1 > {};
template<> struct priority_tag<0> {};
413

414 415 416 417

//////////////////
// constructors //
//////////////////
418

419
template<value_t> struct external_constructor;
420

421
template<>
422 423
struct external_constructor<value_t::boolean>
{
424
    template<typename BasicJsonType>
425
    static void construct(BasicJsonType& j, typename BasicJsonType::boolean_t b) noexcept
T
Théo DELRIEU 已提交
426 427 428 429 430
    {
        j.m_type = value_t::boolean;
        j.m_value = b;
        j.assert_invariant();
    }
431
};
432

433
template<>
434 435
struct external_constructor<value_t::string>
{
436
    template<typename BasicJsonType>
437
    static void construct(BasicJsonType& j, const typename BasicJsonType::string_t& s)
T
Théo DELRIEU 已提交
438 439 440 441 442
    {
        j.m_type = value_t::string;
        j.m_value = s;
        j.assert_invariant();
    }
443
};
444

445
template<>
446 447
struct external_constructor<value_t::number_float>
{
448
    template<typename BasicJsonType>
449
    static void construct(BasicJsonType& j, typename BasicJsonType::number_float_t val) noexcept
450
    {
T
Théo DELRIEU 已提交
451 452
        // replace infinity and NAN by null
        if (not std::isfinite(val))
453
        {
454
            j = BasicJsonType{};
455
        }
T
Théo DELRIEU 已提交
456 457 458 459 460 461
        else
        {
            j.m_type = value_t::number_float;
            j.m_value = val;
        }
        j.assert_invariant();
462 463 464
    }
};

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

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

489
template<>
490 491
struct external_constructor<value_t::array>
{
492
    template<typename BasicJsonType>
493
    static void construct(BasicJsonType& j, const typename BasicJsonType::array_t& arr)
T
Théo DELRIEU 已提交
494 495 496 497 498 499
    {
        j.m_type = value_t::array;
        j.m_value = arr;
        j.assert_invariant();
    }

500 501 502 503
    template<typename BasicJsonType, typename CompatibleArrayType,
             enable_if_t<not std::is_same<CompatibleArrayType,
                                          typename BasicJsonType::array_t>::value,
                         int> = 0>
504
    static void construct(BasicJsonType& j, const CompatibleArrayType& arr)
T
Théo DELRIEU 已提交
505 506 507 508
    {
        using std::begin;
        using std::end;
        j.m_type = value_t::array;
509
        j.m_value.array = j.template create<typename BasicJsonType::array_t>(begin(arr), end(arr));
T
Théo DELRIEU 已提交
510 511
        j.assert_invariant();
    }
512 513
};

514
template<>
515 516
struct external_constructor<value_t::object>
{
517
    template<typename BasicJsonType>
518
    static void construct(BasicJsonType& j, const typename BasicJsonType::object_t& obj)
T
Théo DELRIEU 已提交
519 520 521 522 523 524
    {
        j.m_type = value_t::object;
        j.m_value = obj;
        j.assert_invariant();
    }

525 526 527 528
    template<typename BasicJsonType, typename CompatibleObjectType,
             enable_if_t<not std::is_same<CompatibleObjectType,
                                          typename BasicJsonType::object_t>::value,
                         int> = 0>
529
    static void construct(BasicJsonType& j, const CompatibleObjectType& obj)
T
Théo DELRIEU 已提交
530 531 532
    {
        using std::begin;
        using std::end;
533

T
Théo DELRIEU 已提交
534
        j.m_type = value_t::object;
535
        j.m_value.object = j.template create<typename BasicJsonType::object_t>(begin(obj), end(obj));
T
Théo DELRIEU 已提交
536 537
        j.assert_invariant();
    }
538 539
};

540 541 542 543 544

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

545 546
/*!
@brief Helper to determine whether there's a key_type for T.
N
Niels Lohmann 已提交
547 548

This helper is used to tell associative containers apart from other containers
N
Niels 已提交
549 550
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 已提交
551

552
@sa http://stackoverflow.com/a/7728728/266378
N
Niels 已提交
553
@since version 1.0.0, overworked in version 2.0.6
554
*/
N
Niels Lohmann 已提交
555
#define NLOHMANN_JSON_HAS_HELPER(type)                                        \
556
    template<typename T> struct has_##type {                                  \
N
Niels Lohmann 已提交
557
    private:                                                                  \
558
        template<typename U, typename = typename U::type>                     \
N
Niels Lohmann 已提交
559 560 561 562 563
        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 已提交
564
    }
T
Théo Delrieu 已提交
565

N
Niels Lohmann 已提交
566 567 568 569
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 已提交
570 571

#undef NLOHMANN_JSON_HAS_HELPER
572

N
Niels Lohmann 已提交
573

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

577
template<class RealType, class CompatibleObjectType>
T
Théo DELRIEU 已提交
578 579
struct is_compatible_object_type_impl<true, RealType, CompatibleObjectType>
{
580 581 582 583 584
    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 已提交
585 586
};

587
template<class BasicJsonType, class CompatibleObjectType>
T
Théo DELRIEU 已提交
588 589
struct is_compatible_object_type
{
T
Théo DELRIEU 已提交
590 591 592 593
    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,
594
                                  typename BasicJsonType::object_t, CompatibleObjectType >::value;
T
Théo DELRIEU 已提交
595 596
};

597
template<typename BasicJsonType, typename T>
598
struct is_basic_json_nested_type
T
Théo DELRIEU 已提交
599
{
600 601 602 603 604
    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 已提交
605 606
};

607
template<class BasicJsonType, class CompatibleArrayType>
T
Théo DELRIEU 已提交
608 609
struct is_compatible_array_type
{
T
Théo DELRIEU 已提交
610
    static auto constexpr value =
611
        conjunction<negation<std::is_same<void, CompatibleArrayType>>,
T
Théo DELRIEU 已提交
612
        negation<is_compatible_object_type<
613 614
        BasicJsonType, CompatibleArrayType>>,
        negation<std::is_constructible<typename BasicJsonType::string_t,
T
Théo DELRIEU 已提交
615
        CompatibleArrayType>>,
616
        negation<is_basic_json_nested_type<BasicJsonType, CompatibleArrayType>>,
T
Théo DELRIEU 已提交
617 618
        has_value_type<CompatibleArrayType>,
        has_iterator<CompatibleArrayType>>::value;
T
Théo DELRIEU 已提交
619 620
};

621
template<bool, typename, typename>
622
struct is_compatible_integer_type_impl : std::false_type {};
623

624
template<typename RealIntegerType, typename CompatibleNumberIntegerType>
625
struct is_compatible_integer_type_impl<true, RealIntegerType, CompatibleNumberIntegerType>
T
Théo DELRIEU 已提交
626
{
T
Théo DELRIEU 已提交
627
    // is there an assert somewhere on overflows?
628 629 630 631 632 633 634 635
    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 已提交
636 637
};

638
template<typename RealIntegerType, typename CompatibleNumberIntegerType>
639 640
struct is_compatible_integer_type
{
641 642 643 644 645
    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;
646 647
};

648

N
Niels Lohmann 已提交
649
// trait checking if JSONSerializer<T>::from_json(json const&, udt&) exists
650
template<typename BasicJsonType, typename T>
651 652
struct has_from_json
{
653 654
  private:
    // also check the return type of from_json
655 656
    template<typename U, typename = enable_if_t<std::is_same<void, decltype(uncvref_t<U>::from_json(
                 std::declval<BasicJsonType>(), std::declval<T&>()))>::value>>
657 658
    static int detect(U&&);
    static void detect(...);
659

660 661
  public:
    static constexpr bool value = std::is_integral<decltype(
662
                                      detect(std::declval<typename BasicJsonType::template json_serializer<T, void>>()))>::value;
663 664 665 666
};

// This trait checks if JSONSerializer<T>::from_json(json const&) exists
// this overload is used for non-default-constructible user-defined-types
667
template<typename BasicJsonType, typename T>
668 669
struct has_non_default_from_json
{
T
Théo DELRIEU 已提交
670 671 672 673
  private:
    template <
        typename U,
        typename = enable_if_t<std::is_same<
674
                                   T, decltype(uncvref_t<U>::from_json(std::declval<BasicJsonType>()))>::value >>
T
Théo DELRIEU 已提交
675 676 677 678 679
    static int detect(U&&);
    static void detect(...);

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

683
// This trait checks if BasicJsonType::json_serializer<T>::to_json exists
684
template<typename BasicJsonType, typename T>
685 686
struct has_to_json
{
T
Théo DELRIEU 已提交
687
  private:
688 689
    template<typename U, typename = decltype(uncvref_t<U>::to_json(
                 std::declval<BasicJsonType&>(), std::declval<T>()))>
T
Théo DELRIEU 已提交
690 691 692 693 694
    static int detect(U&&);
    static void detect(...);

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

698

699 700 701
/////////////
// to_json //
/////////////
702

N
Niels Lohmann 已提交
703
template<typename BasicJsonType, typename T, enable_if_t<
704
             std::is_same<T, typename BasicJsonType::boolean_t>::value, int> = 0>
N
Niels Lohmann 已提交
705
void to_json(BasicJsonType& j, T b) noexcept
706
{
T
Théo DELRIEU 已提交
707
    external_constructor<value_t::boolean>::construct(j, b);
708 709
}

710 711
template<typename BasicJsonType, typename CompatibleString,
         enable_if_t<std::is_constructible<typename BasicJsonType::string_t,
N
Niels Lohmann 已提交
712
                     CompatibleString>::value, int> = 0>
713
void to_json(BasicJsonType& j, const CompatibleString& s)
714
{
T
Théo DELRIEU 已提交
715
    external_constructor<value_t::string>::construct(j, s);
716 717
}

718 719
template<typename BasicJsonType, typename FloatType,
         enable_if_t<std::is_floating_point<FloatType>::value, int> = 0>
720
void to_json(BasicJsonType& j, FloatType val) noexcept
721
{
722
    external_constructor<value_t::number_float>::construct(j, static_cast<typename BasicJsonType::number_float_t>(val));
723 724
}

725
template <
726 727
    typename BasicJsonType, typename CompatibleNumberUnsignedType,
    enable_if_t<is_compatible_integer_type<typename BasicJsonType::number_unsigned_t,
N
Niels Lohmann 已提交
728
                CompatibleNumberUnsignedType>::value, int> = 0 >
729
void to_json(BasicJsonType& j, CompatibleNumberUnsignedType val) noexcept
730
{
731
    external_constructor<value_t::number_unsigned>::construct(j, static_cast<typename BasicJsonType::number_unsigned_t>(val));
732 733
}

734
template <
735 736
    typename BasicJsonType, typename CompatibleNumberIntegerType,
    enable_if_t<is_compatible_integer_type<typename BasicJsonType::number_integer_t,
N
Niels Lohmann 已提交
737
                CompatibleNumberIntegerType>::value, int> = 0 >
738
void to_json(BasicJsonType& j, CompatibleNumberIntegerType val) noexcept
739
{
740
    external_constructor<value_t::number_integer>::construct(j, static_cast<typename BasicJsonType::number_integer_t>(val));
741 742
}

743 744
template<typename BasicJsonType, typename UnscopedEnumType,
         enable_if_t<is_unscoped_enum<UnscopedEnumType>::value, int> = 0>
745
void to_json(BasicJsonType& j, UnscopedEnumType e) noexcept
746
{
T
Théo DELRIEU 已提交
747
    external_constructor<value_t::number_integer>::construct(j, e);
748 749
}

750
template <
751
    typename BasicJsonType, typename CompatibleArrayType,
T
Théo DELRIEU 已提交
752
    enable_if_t <
753 754
        is_compatible_array_type<BasicJsonType, CompatibleArrayType>::value or
        std::is_same<typename BasicJsonType::array_t, CompatibleArrayType>::value,
T
Théo DELRIEU 已提交
755
        int > = 0 >
756
void to_json(BasicJsonType& j, const  CompatibleArrayType& arr)
757
{
T
Théo DELRIEU 已提交
758
    external_constructor<value_t::array>::construct(j, arr);
759 760
}

761
template <
762 763
    typename BasicJsonType, typename CompatibleObjectType,
    enable_if_t<is_compatible_object_type<BasicJsonType, CompatibleObjectType>::value,
T
Théo DELRIEU 已提交
764
                int> = 0 >
765
void to_json(BasicJsonType& j, const  CompatibleObjectType& arr)
766
{
T
Théo DELRIEU 已提交
767
    external_constructor<value_t::object>::construct(j, arr);
768 769
}

770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804

///////////////
// 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:
        {
805
            JSON_THROW(type_error(302, "type must be number, but is " + j.type_name()));
806 807 808 809 810
        }
    }
}

template<typename BasicJsonType>
811
void from_json(const BasicJsonType& j, typename BasicJsonType::boolean_t& b)
812
{
N
Niels Lohmann 已提交
813
    if (not j.is_boolean())
T
Théo DELRIEU 已提交
814
    {
815
        JSON_THROW(type_error(302, "type must be boolean, but is " + j.type_name()));
T
Théo DELRIEU 已提交
816
    }
817
    b = *j.template get_ptr<const typename BasicJsonType::boolean_t*>();
818 819
}

820
template<typename BasicJsonType>
821
void from_json(const BasicJsonType& j, typename BasicJsonType::string_t& s)
822
{
N
Niels Lohmann 已提交
823
    if (not j.is_string())
T
Théo DELRIEU 已提交
824
    {
825
        JSON_THROW(type_error(302, "type must be string, but is " + j.type_name()));
T
Théo DELRIEU 已提交
826
    }
827
    s = *j.template get_ptr<const typename BasicJsonType::string_t*>();
828 829
}

830
template<typename BasicJsonType>
831
void from_json(const BasicJsonType& j, typename BasicJsonType::number_float_t& val)
832
{
T
Théo DELRIEU 已提交
833
    get_arithmetic_value(j, val);
834 835
}

836
template<typename BasicJsonType>
837
void from_json(const BasicJsonType& j, typename BasicJsonType::number_unsigned_t& val)
838
{
T
Théo DELRIEU 已提交
839
    get_arithmetic_value(j, val);
840 841
}

842
template<typename BasicJsonType>
843
void from_json(const BasicJsonType& j, typename BasicJsonType::number_integer_t& val)
844
{
T
Théo DELRIEU 已提交
845
    get_arithmetic_value(j, val);
846 847
}

848 849 850
template<typename BasicJsonType, typename UnscopedEnumType,
         enable_if_t<is_unscoped_enum<UnscopedEnumType>::value, int> = 0>
void from_json(const BasicJsonType& j, UnscopedEnumType& e)
851
{
852
    typename std::underlying_type<UnscopedEnumType>::type val;
T
Théo DELRIEU 已提交
853 854
    get_arithmetic_value(j, val);
    e = static_cast<UnscopedEnumType>(val);
855 856
}

857 858
template<typename BasicJsonType>
void from_json(const BasicJsonType& j, typename BasicJsonType::array_t& arr)
859
{
N
Niels Lohmann 已提交
860
    if (not j.is_array())
T
Théo DELRIEU 已提交
861
    {
862
        JSON_THROW(type_error(302, "type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
863
    }
864
    arr = *j.template get_ptr<const typename BasicJsonType::array_t*>();
865 866
}

867 868
// forward_list doesn't have an insert method
template<typename BasicJsonType, typename T, typename Allocator>
869
void from_json(const BasicJsonType& j, std::forward_list<T, Allocator>& l)
870
{
T
Théo DELRIEU 已提交
871 872 873 874
    // do not perform the check when user wants to retrieve jsons
    // (except when it's null.. ?)
    if (j.is_null())
    {
875
        JSON_THROW(type_error(302, "type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
876
    }
877
    if (not std::is_same<T, BasicJsonType>::value)
T
Théo DELRIEU 已提交
878
    {
N
Niels Lohmann 已提交
879
        if (not j.is_array())
T
Théo DELRIEU 已提交
880
        {
881
            JSON_THROW(type_error(302, "type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
882 883 884 885 886 887
        }
    }
    for (auto it = j.rbegin(), end = j.rend(); it != end; ++it)
    {
        l.push_front(it->template get<T>());
    }
888 889
}

890 891
template<typename BasicJsonType, typename CompatibleArrayType>
void from_json_array_impl(const BasicJsonType& j, CompatibleArrayType& arr, priority_tag<0>)
892
{
T
Théo DELRIEU 已提交
893 894
    using std::begin;
    using std::end;
895

896 897
    std::transform(j.begin(), j.end(),
                   std::inserter(arr, end(arr)), [](const BasicJsonType & i)
T
Théo DELRIEU 已提交
898
    {
899 900
        // get<BasicJsonType>() returns *this, this won't call a from_json
        // method when value_type is BasicJsonType
901
        return i.template get<typename CompatibleArrayType::value_type>();
T
Théo DELRIEU 已提交
902
    });
903 904
}

905 906
template<typename BasicJsonType, typename CompatibleArrayType>
auto from_json_array_impl(const BasicJsonType& j, CompatibleArrayType& arr, priority_tag<1>)
T
Théo DELRIEU 已提交
907 908 909
-> decltype(
    arr.reserve(std::declval<typename CompatibleArrayType::size_type>()),
    void())
910
{
T
Théo DELRIEU 已提交
911 912
    using std::begin;
    using std::end;
913

T
Théo DELRIEU 已提交
914 915
    arr.reserve(j.size());
    std::transform(
916
        j.begin(), j.end(), std::inserter(arr, end(arr)), [](const BasicJsonType & i)
T
Théo DELRIEU 已提交
917
    {
918 919
        // get<BasicJsonType>() returns *this, this won't call a from_json
        // method when value_type is BasicJsonType
920
        return i.template get<typename CompatibleArrayType::value_type>();
T
Théo DELRIEU 已提交
921
    });
922 923
}

924 925 926 927
template<typename BasicJsonType, typename CompatibleArrayType,
         enable_if_t<is_compatible_array_type<BasicJsonType, CompatibleArrayType>::value and
                     not std::is_same<typename BasicJsonType::array_t, CompatibleArrayType>::value, int> = 0>
void from_json(const BasicJsonType& j, CompatibleArrayType& arr)
928
{
T
Théo DELRIEU 已提交
929 930
    if (j.is_null())
    {
931
        JSON_THROW(type_error(302, "type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
932
    }
933

934 935
    // when T == BasicJsonType, do not check if value_t is correct
    if (not std::is_same<typename CompatibleArrayType::value_type, BasicJsonType>::value)
T
Théo DELRIEU 已提交
936
    {
N
Niels Lohmann 已提交
937
        if (not j.is_array())
T
Théo DELRIEU 已提交
938
        {
939
            JSON_THROW(type_error(302, "type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
940 941 942
        }
    }
    from_json_array_impl(j, arr, priority_tag<1> {});
943 944
}

945 946 947
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)
948
{
N
Niels Lohmann 已提交
949
    if (not j.is_object())
T
Théo DELRIEU 已提交
950
    {
951
        JSON_THROW(type_error(302, "type must be object, but is " + j.type_name()));
T
Théo DELRIEU 已提交
952 953
    }

954
    auto inner_object = j.template get_ptr<const typename BasicJsonType::object_t*>();
T
Théo DELRIEU 已提交
955 956 957
    using std::begin;
    using std::end;
    // we could avoid the assignment, but this might require a for loop, which
N
Niels Lohmann 已提交
958 959
    // might be less efficient than the container constructor for some
    // containers (would it?)
T
Théo DELRIEU 已提交
960
    obj = CompatibleObjectType(begin(*inner_object), end(*inner_object));
961 962
}

N
Niels Lohmann 已提交
963 964 965 966
// 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?
967 968 969 970 971 972 973 974
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>
975
void from_json(const BasicJsonType& j, ArithmeticType& val)
T
Théo DELRIEU 已提交
976 977 978 979
{
    switch (static_cast<value_t>(j))
    {
        case value_t::number_unsigned:
N
Niels Lohmann 已提交
980
        {
981
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_unsigned_t*>());
T
Théo DELRIEU 已提交
982
            break;
N
Niels Lohmann 已提交
983
        }
T
Théo DELRIEU 已提交
984
        case value_t::number_integer:
N
Niels Lohmann 已提交
985
        {
986
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_integer_t*>());
T
Théo DELRIEU 已提交
987
            break;
N
Niels Lohmann 已提交
988
        }
T
Théo DELRIEU 已提交
989
        case value_t::number_float:
N
Niels Lohmann 已提交
990
        {
991
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_float_t*>());
T
Théo DELRIEU 已提交
992
            break;
N
Niels Lohmann 已提交
993
        }
T
Théo DELRIEU 已提交
994
        case value_t::boolean:
N
Niels Lohmann 已提交
995
        {
996
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::boolean_t*>());
T
Théo DELRIEU 已提交
997
            break;
N
Niels Lohmann 已提交
998
        }
T
Théo DELRIEU 已提交
999
        default:
N
Niels Lohmann 已提交
1000
        {
1001
            JSON_THROW(type_error(302, "type must be number, but is " + j.type_name()));
N
Niels Lohmann 已提交
1002
        }
T
Théo DELRIEU 已提交
1003
    }
1004 1005
}

1006 1007
struct to_json_fn
{
N
Niels Lohmann 已提交
1008
  private:
1009 1010 1011
    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())
1012
    {
1013
        return to_json(j, std::forward<T>(val));
1014
    }
T
Théo DELRIEU 已提交
1015

1016
    template<typename BasicJsonType, typename T>
1017
    void call(BasicJsonType&, T&&, priority_tag<0>) const noexcept
T
Théo DELRIEU 已提交
1018
    {
1019 1020
        static_assert(sizeof(BasicJsonType) == 0,
                      "could not find to_json() method in T's namespace");
T
Théo DELRIEU 已提交
1021 1022
    }

T
Théo DELRIEU 已提交
1023
  public:
1024
    template<typename BasicJsonType, typename T>
1025
    void operator()(BasicJsonType& j, T&& val) const
T
Théo DELRIEU 已提交
1026 1027 1028 1029
    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> {});
    }
1030 1031 1032 1033
};

struct from_json_fn
{
T
Théo DELRIEU 已提交
1034
  private:
1035 1036
    template<typename BasicJsonType, typename T>
    auto call(const BasicJsonType& j, T& val, priority_tag<1>) const
T
Théo DELRIEU 已提交
1037 1038 1039 1040 1041 1042
    noexcept(noexcept(from_json(j, val)))
    -> decltype(from_json(j, val), void())
    {
        return from_json(j, val);
    }

1043
    template<typename BasicJsonType, typename T>
1044
    void call(const BasicJsonType&, T&, priority_tag<0>) const noexcept
T
Théo DELRIEU 已提交
1045
    {
1046 1047
        static_assert(sizeof(BasicJsonType) == 0,
                      "could not find from_json() method in T's namespace");
T
Théo DELRIEU 已提交
1048 1049 1050
    }

  public:
1051 1052
    template<typename BasicJsonType, typename T>
    void operator()(const BasicJsonType& j, T& val) const
T
Théo DELRIEU 已提交
1053 1054 1055 1056
    noexcept(noexcept(std::declval<from_json_fn>().call(j, val, priority_tag<1> {})))
    {
        return call(j, val, priority_tag<1> {});
    }
1057
};
1058

1059
// taken from ranges-v3
1060
template<typename T>
1061 1062 1063 1064 1065
struct static_const
{
    static constexpr T value{};
};

1066
template<typename T>
1067
constexpr T static_const<T>::value;
1068 1069
} // namespace detail

N
Niels 已提交
1070

N
Niels Lohmann 已提交
1071
/// namespace to hold default `to_json` / `from_json` functions
1072
namespace
1073
{
T
Théo DELRIEU 已提交
1074 1075
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;
1076 1077
}

N
Niels Lohmann 已提交
1078 1079 1080 1081 1082 1083 1084 1085

/*!
@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.
*/
1086
template<typename = void, typename = void>
1087 1088
struct adl_serializer
{
N
Niels Lohmann 已提交
1089 1090 1091 1092 1093 1094 1095
    /*!
    @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
1096
    @param[in,out] val  value to write to
N
Niels Lohmann 已提交
1097 1098 1099 1100
    */
    template<typename BasicJsonType, typename ValueType>
    static void from_json(BasicJsonType&& j, ValueType& val) noexcept(
        noexcept(::nlohmann::from_json(std::forward<BasicJsonType>(j), val)))
1101
    {
1102
        ::nlohmann::from_json(std::forward<BasicJsonType>(j), val);
1103 1104
    }

N
Niels Lohmann 已提交
1105 1106 1107 1108 1109 1110
    /*!
    @brief convert any value type to a JSON value

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

1111
    @param[in,out] j  JSON value to write to
N
Niels Lohmann 已提交
1112 1113 1114 1115 1116
    @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))))
1117
    {
N
Niels Lohmann 已提交
1118
        ::nlohmann::to_json(j, std::forward<ValueType>(val));
1119
    }
1120 1121
};

1122

N
Niels 已提交
1123
/*!
N
Niels 已提交
1124
@brief a class to store JSON values
N
Niels 已提交
1125

N
Niels 已提交
1126
@tparam ObjectType type for JSON objects (`std::map` by default; will be used
N
Niels 已提交
1127
in @ref object_t)
N
Niels 已提交
1128
@tparam ArrayType type for JSON arrays (`std::vector` by default; will be used
N
Niels 已提交
1129
in @ref array_t)
N
Niels 已提交
1130
@tparam StringType type for JSON strings and object keys (`std::string` by
N
Niels 已提交
1131
default; will be used in @ref string_t)
N
Niels 已提交
1132
@tparam BooleanType type for JSON booleans (`bool` by default; will be used
N
Niels 已提交
1133
in @ref boolean_t)
N
Niels 已提交
1134
@tparam NumberIntegerType type for JSON integer numbers (`int64_t` by
N
Niels 已提交
1135
default; will be used in @ref number_integer_t)
N
Niels 已提交
1136 1137
@tparam NumberUnsignedType type for JSON unsigned integer numbers (@c
`uint64_t` by default; will be used in @ref number_unsigned_t)
N
Niels 已提交
1138
@tparam NumberFloatType type for JSON floating-point numbers (`double` by
N
Niels 已提交
1139
default; will be used in @ref number_float_t)
N
Niels 已提交
1140
@tparam AllocatorType type of the allocator to use (`std::allocator` by
N
Niels 已提交
1141
default)
N
Niels Lohmann 已提交
1142
@tparam JSONSerializer the serializer to resolve internal calls to `to_json()`
N
Niels Lohmann 已提交
1143
and `from_json()` (@ref adl_serializer by default)
N
Niels 已提交
1144

N
Niels 已提交
1145 1146
@requirement The class satisfies the following concept requirements:
- Basic
N
Niels 已提交
1147
 - [DefaultConstructible](http://en.cppreference.com/w/cpp/concept/DefaultConstructible):
N
Niels Lohmann 已提交
1148 1149
   JSON values can be default constructed. The result will be a JSON null
   value.
N
Niels 已提交
1150 1151 1152
 - [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 已提交
1153
   A JSON value can be copy-constructed from an lvalue expression.
N
Niels 已提交
1154 1155 1156 1157 1158 1159
 - [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 已提交
1160
- Layout
N
Niels 已提交
1161 1162 1163
 - [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 已提交
1164 1165
   All non-static data members are private and standard layout types, the
   class has no virtual functions or (virtual) base classes.
N
Niels 已提交
1166
- Library-wide
N
Niels 已提交
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178
 - [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 已提交
1179
- Container
N
Niels 已提交
1180 1181 1182 1183 1184
 - [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 已提交
1185

1186 1187 1188 1189 1190 1191 1192
@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 已提交
1193
@internal
N
Niels 已提交
1194
@note ObjectType trick from http://stackoverflow.com/a/9860911
N
Niels 已提交
1195
@endinternal
N
Niels 已提交
1196

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

N
Niels 已提交
1200
@since version 1.0.0
N
Niels 已提交
1201 1202

@nosubgrouping
N
Niels 已提交
1203 1204 1205 1206 1207 1208
*/
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,
1209 1210
    class NumberIntegerType = std::int64_t,
    class NumberUnsignedType = std::uint64_t,
N
Niels 已提交
1211
    class NumberFloatType = double,
1212
    template<typename U> class AllocatorType = std::allocator,
1213
    template<typename T, typename SFINAE = void> class JSONSerializer = adl_serializer
N
Niels 已提交
1214 1215 1216
    >
class basic_json
{
1217
  private:
1218
    template<detail::value_t> friend struct detail::external_constructor;
1219
    /// workaround type for MSVC
N
Niels 已提交
1220 1221
    using basic_json_t = basic_json<ObjectType, ArrayType, StringType,
          BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType,
1222
          AllocatorType, JSONSerializer>;
1223 1224

  public:
1225
    using value_t = detail::value_t;
N
Niels 已提交
1226
    // forward declarations
N
Niels Lohmann 已提交
1227
    template<typename U> class iter_impl;
N
Niels 已提交
1228 1229
    template<typename Base> class json_reverse_iterator;
    class json_pointer;
1230
    template<typename T, typename SFINAE>
1231
    using json_serializer = JSONSerializer<T, SFINAE>;
1232

1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259

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

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

    /*
    name / id                      | example massage | description
    ------------------------------ | --------------- | -------------------------
    json.exception.other.500 | "unsuccessful" | A JSON Patch operation 'test' failed.
    */

    /// @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;

    /// @}


N
Niels 已提交
1260 1261 1262 1263
    /////////////////////
    // container types //
    /////////////////////

N
Niels 已提交
1264
    /// @name container types
N
Niels 已提交
1265 1266
    /// The canonic container types to use @ref basic_json like any other STL
    /// container.
N
Niels 已提交
1267 1268
    /// @{

N
Niels 已提交
1269
    /// the type of elements in a basic_json container
N
Niels 已提交
1270
    using value_type = basic_json;
N
Niels 已提交
1271

N
Niels 已提交
1272
    /// the type of an element reference
N
Niels 已提交
1273
    using reference = value_type&;
N
Niels 已提交
1274
    /// the type of an element const reference
N
Niels 已提交
1275
    using const_reference = const value_type&;
N
Niels 已提交
1276

N
Niels 已提交
1277
    /// a type to represent differences between iterators
N
Niels 已提交
1278
    using difference_type = std::ptrdiff_t;
N
Niels 已提交
1279
    /// a type to represent container sizes
N
Niels 已提交
1280 1281 1282
    using size_type = std::size_t;

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

N
Niels 已提交
1285
    /// the type of an element pointer
N
Niels 已提交
1286
    using pointer = typename std::allocator_traits<allocator_type>::pointer;
N
Niels 已提交
1287
    /// the type of an element const pointer
N
Niels 已提交
1288
    using const_pointer = typename std::allocator_traits<allocator_type>::const_pointer;
N
Niels 已提交
1289

N
Niels 已提交
1290
    /// an iterator for a basic_json container
1291
    using iterator = iter_impl<basic_json>;
N
Niels 已提交
1292
    /// a const iterator for a basic_json container
1293
    using const_iterator = iter_impl<const basic_json>;
N
Niels 已提交
1294
    /// a reverse iterator for a basic_json container
N
Niels 已提交
1295
    using reverse_iterator = json_reverse_iterator<typename basic_json::iterator>;
N
Niels 已提交
1296
    /// a const reverse iterator for a basic_json container
N
Niels 已提交
1297
    using const_reverse_iterator = json_reverse_iterator<typename basic_json::const_iterator>;
N
Niels 已提交
1298

N
Niels 已提交
1299 1300 1301
    /// @}


N
Niels 已提交
1302 1303 1304
    /*!
    @brief returns the allocator associated with the container
    */
N
Niels 已提交
1305
    static allocator_type get_allocator()
N
Niels 已提交
1306 1307 1308 1309
    {
        return allocator_type();
    }

1310 1311
    /*!
    @brief returns version information on the library
1312

N
Niels Lohmann 已提交
1313
    This function returns a JSON object with information about the library,
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
    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
1332
    */
1333
    static basic_json meta()
1334 1335 1336
    {
        basic_json result;

1337
        result["copyright"] = "(C) 2013-2017 Niels Lohmann";
1338 1339 1340 1341
        result["name"] = "JSON for Modern C++";
        result["url"] = "https://github.com/nlohmann/json";
        result["version"] =
        {
N
Niels Lohmann 已提交
1342
            {"string", "2.1.1"}, {"major", 2}, {"minor", 1}, {"patch", 1}
1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357
        };

#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__)
1358
        result["compiler"] = {{"family", "clang"}, {"version", __clang_version__}};
1359 1360 1361
#elif defined(__ICC) || defined(__INTEL_COMPILER)
        result["compiler"] = {{"family", "icc"}, {"version", __INTEL_COMPILER}};
#elif defined(__GNUC__) || defined(__GNUG__)
1362
        result["compiler"] = {{"family", "gcc"}, {"version", std::to_string(__GNUC__) + "." + std::to_string(__GNUC_MINOR__) + "." + std::to_string(__GNUC_PATCHLEVEL__)}};
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384
#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 已提交
1385

N
Niels 已提交
1386 1387 1388 1389
    ///////////////////////////
    // JSON value data types //
    ///////////////////////////

N
Niels 已提交
1390
    /// @name JSON value data types
N
Niels 已提交
1391 1392
    /// The data types to store a JSON value. These types are derived from
    /// the template arguments passed to class @ref basic_json.
N
Niels 已提交
1393 1394
    /// @{

N
Niels 已提交
1395 1396 1397 1398 1399 1400 1401 1402
    /*!
    @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 已提交
1403 1404 1405 1406 1407
    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 已提交
1408 1409
    @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 已提交
1410 1411 1412
    inside the container.
    @tparam AllocatorType the allocator to use for objects (e.g.,
    `std::allocator`)
N
Niels 已提交
1413 1414 1415 1416

    #### Default type

    With the default values for @a ObjectType (`std::map`), @a StringType
N
Niels 已提交
1417 1418
    (`std::string`), and @a AllocatorType (`std::allocator`), the default
    value for @a object_t is:
N
Niels 已提交
1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434

    @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 已提交
1435 1436
      that all software implementations receiving that object will agree on
      the name-value mappings.
N
Niels 已提交
1437 1438 1439 1440 1441
    - 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 已提交
1442 1443 1444
      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 已提交
1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456
    - 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 已提交
1457 1458
    runtime environment. A theoretical limit can be queried by calling the
    @ref max_size function of a JSON object.
N
Niels 已提交
1459 1460 1461

    #### Storage

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

1466 1467
    @sa @ref array_t -- type for an array value

N
Niels 已提交
1468
    @since version 1.0.0
N
Niels 已提交
1469

N
Niels 已提交
1470 1471 1472 1473 1474
    @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 已提交
1475 1476
    7159](http://rfc7159.net/rfc7159), because any order implements the
    specified "unordered" nature of JSON objects.
N
Niels 已提交
1477
    */
N
Niels 已提交
1478 1479 1480 1481 1482
    using object_t = ObjectType<StringType,
          basic_json,
          std::less<StringType>,
          AllocatorType<std::pair<const StringType,
          basic_json>>>;
N
Niels 已提交
1483 1484 1485 1486 1487 1488 1489

    /*!
    @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 已提交
1490 1491 1492 1493 1494
    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 已提交
1495
    @tparam AllocatorType allocator to use for arrays (e.g., `std::allocator`)
N
Niels 已提交
1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515

    #### 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 已提交
1516 1517
    runtime environment. A theoretical limit can be queried by calling the
    @ref max_size function of a JSON array.
N
Niels 已提交
1518 1519 1520

    #### Storage

1521
    Arrays are stored as pointers in a @ref basic_json type. That is, for any
N
Niels 已提交
1522
    access to array values, a pointer of type `array_t*` must be dereferenced.
1523 1524 1525

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

N
Niels 已提交
1526
    @since version 1.0.0
N
Niels 已提交
1527
    */
N
Niels 已提交
1528
    using array_t = ArrayType<basic_json, AllocatorType<basic_json>>;
N
Niels 已提交
1529 1530 1531 1532 1533 1534 1535

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

N
Niels 已提交
1540 1541
    @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 已提交
1542 1543 1544 1545 1546 1547 1548 1549 1550 1551

    #### Default type

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

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

1552 1553 1554 1555 1556 1557
    #### 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 已提交
1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574
    #### 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

1575 1576
    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 已提交
1577
    dereferenced.
1578

N
Niels 已提交
1579
    @since version 1.0.0
N
Niels 已提交
1580
    */
N
Niels 已提交
1581
    using string_t = StringType;
N
Niels 已提交
1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602

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

1603 1604
    Boolean values are stored directly inside a @ref basic_json type.

N
Niels 已提交
1605
    @since version 1.0.0
N
Niels 已提交
1606
    */
N
Niels 已提交
1607
    using boolean_t = BooleanType;
N
Niels 已提交
1608 1609 1610 1611 1612

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

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625
    > 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 已提交
1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643

    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 已提交
1644 1645
      instance, the C++ integer literal `010` will be serialized to `8`.
      During deserialization, leading zeros yield an error.
N
Niels 已提交
1646 1647 1648 1649 1650 1651 1652 1653 1654 1655
    - 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 已提交
1656 1657 1658 1659
    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 已提交
1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670

    [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

1671 1672 1673 1674
    Integer number values are stored directly inside a @ref basic_json type.

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

1675 1676
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
1677
    @since version 1.0.0
N
Niels 已提交
1678
    */
N
Niels 已提交
1679
    using number_integer_t = NumberIntegerType;
N
Niels 已提交
1680

1681 1682 1683 1684
    /*!
    @brief a type for a number (unsigned)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700
    > 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.
1701 1702 1703

    #### Default type

N
Niels 已提交
1704 1705
    With the default values for @a NumberUnsignedType (`uint64_t`), the
    default value for @a number_unsigned_t is:
1706 1707 1708 1709 1710 1711 1712 1713 1714 1715

    @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 已提交
1716 1717
      instance, the C++ integer literal `010` will be serialized to `8`.
      During deserialization, leading zeros yield an error.
1718 1719 1720 1721 1722 1723 1724 1725
    - 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 已提交
1726 1727 1728 1729 1730
    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.
1731 1732 1733 1734 1735 1736 1737

    [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 已提交
1738 1739
    number_integer_t type) of the exactly supported range [0, UINT64_MAX],
    this class's integer type is interoperable.
1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750

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

N
Niels 已提交
1752 1753 1754 1755
    /*!
    @brief a type for a number (floating-point)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768
    > 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 已提交
1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784

    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 已提交
1785 1786
      leading zeros in floating-point literals will be ignored. Internally,
      the value will be stored as decimal number. For instance, the C++
N
Niels 已提交
1787 1788 1789 1790 1791 1792 1793 1794 1795 1796
      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 已提交
1797 1798 1799
    > 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 已提交
1800 1801 1802 1803
    > precision.

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

    #### Storage

1809 1810 1811 1812 1813
    Floating-point number values are stored directly inside a @ref basic_json
    type.

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

1814 1815
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
1816
    @since version 1.0.0
N
Niels 已提交
1817
    */
N
Niels 已提交
1818 1819
    using number_float_t = NumberFloatType;

N
Niels 已提交
1820 1821
    /// @}

N
Niels 已提交
1822
  private:
N
Niels 已提交
1823

N
Cleanup  
Niels 已提交
1824 1825
    /// helper for exception-safe object creation
    template<typename T, typename... Args>
N
cleanup  
Niels 已提交
1826
    static T* create(Args&& ... args)
N
Cleanup  
Niels 已提交
1827 1828 1829 1830 1831 1832 1833 1834
    {
        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 已提交
1835
        assert(object != nullptr);
N
Cleanup  
Niels 已提交
1836 1837 1838
        return object.release();
    }

N
Niels 已提交
1839 1840 1841 1842
    ////////////////////////
    // JSON value storage //
    ////////////////////////

1843 1844 1845
    /*!
    @brief a JSON value

N
Niels 已提交
1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863
    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.
1864

N
Niels 已提交
1865
    @since version 1.0.0
1866
    */
N
Niels 已提交
1867 1868 1869 1870 1871 1872 1873 1874
    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 已提交
1875
        /// boolean
N
Niels 已提交
1876 1877 1878
        boolean_t boolean;
        /// number (integer)
        number_integer_t number_integer;
1879 1880
        /// number (unsigned integer)
        number_unsigned_t number_unsigned;
N
Niels 已提交
1881
        /// number (floating-point)
N
Niels 已提交
1882 1883 1884
        number_float_t number_float;

        /// default constructor (for null values)
N
Niels 已提交
1885
        json_value() = default;
N
Niels 已提交
1886
        /// constructor for booleans
N
Niels 已提交
1887
        json_value(boolean_t v) noexcept : boolean(v) {}
N
Niels 已提交
1888
        /// constructor for numbers (integer)
N
Niels 已提交
1889
        json_value(number_integer_t v) noexcept : number_integer(v) {}
1890 1891
        /// constructor for numbers (unsigned)
        json_value(number_unsigned_t v) noexcept : number_unsigned(v) {}
N
Niels 已提交
1892
        /// constructor for numbers (floating-point)
N
Niels 已提交
1893
        json_value(number_float_t v) noexcept : number_float(v) {}
N
Niels 已提交
1894
        /// constructor for empty values of a given type
N
Niels 已提交
1895
        json_value(value_t t)
N
Niels 已提交
1896 1897 1898
        {
            switch (t)
            {
1899
                case value_t::object:
N
Niels 已提交
1900
                {
N
Cleanup  
Niels 已提交
1901
                    object = create<object_t>();
N
Niels 已提交
1902 1903
                    break;
                }
N
Niels 已提交
1904

1905
                case value_t::array:
N
Niels 已提交
1906
                {
N
Cleanup  
Niels 已提交
1907
                    array = create<array_t>();
N
Niels 已提交
1908 1909
                    break;
                }
N
Niels 已提交
1910

1911
                case value_t::string:
N
Niels 已提交
1912
                {
N
Cleanup  
Niels 已提交
1913
                    string = create<string_t>("");
N
Niels 已提交
1914 1915
                    break;
                }
N
Niels 已提交
1916

1917
                case value_t::boolean:
N
Niels 已提交
1918 1919 1920 1921 1922
                {
                    boolean = boolean_t(false);
                    break;
                }

1923
                case value_t::number_integer:
N
Niels 已提交
1924 1925 1926 1927
                {
                    number_integer = number_integer_t(0);
                    break;
                }
N
Niels 已提交
1928

1929 1930 1931 1932 1933
                case value_t::number_unsigned:
                {
                    number_unsigned = number_unsigned_t(0);
                    break;
                }
N
Niels 已提交
1934

1935
                case value_t::number_float:
N
Niels 已提交
1936 1937 1938 1939
                {
                    number_float = number_float_t(0.0);
                    break;
                }
1940

1941 1942 1943 1944 1945
                case value_t::null:
                {
                    break;
                }

1946 1947
                default:
                {
1948 1949
                    if (t == value_t::null)
                    {
N
Niels Lohmann 已提交
1950
                        JSON_THROW(std::domain_error("961c151d2e87f2686a955a9be24d316f1362bf21 2.1.1")); // LCOV_EXCL_LINE
1951
                    }
1952 1953
                    break;
                }
N
Niels 已提交
1954 1955
            }
        }
N
Niels 已提交
1956 1957

        /// constructor for strings
N
Niels 已提交
1958
        json_value(const string_t& value)
N
Niels 已提交
1959
        {
N
Cleanup  
Niels 已提交
1960
            string = create<string_t>(value);
N
Niels 已提交
1961 1962 1963
        }

        /// constructor for objects
N
Niels 已提交
1964
        json_value(const object_t& value)
N
Niels 已提交
1965
        {
N
Cleanup  
Niels 已提交
1966
            object = create<object_t>(value);
N
Niels 已提交
1967 1968 1969
        }

        /// constructor for arrays
N
Niels 已提交
1970
        json_value(const array_t& value)
N
Niels 已提交
1971
        {
N
Cleanup  
Niels 已提交
1972
            array = create<array_t>(value);
N
Niels 已提交
1973
        }
N
Niels 已提交
1974 1975
    };

1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990
    /*!
    @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 已提交
1991 1992

  public:
N
Niels 已提交
1993 1994 1995 1996
    //////////////////////////
    // JSON parser callback //
    //////////////////////////

N
Niels 已提交
1997 1998 1999 2000 2001
    /*!
    @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.
2002

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

N
Niels 已提交
2005
    @since version 1.0.0
N
Niels 已提交
2006
    */
N
Niels 已提交
2007 2008
    enum class parse_event_t : uint8_t
    {
N
Niels 已提交
2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020
        /// 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 已提交
2021 2022
    };

N
Niels 已提交
2023 2024 2025 2026
    /*!
    @brief per-element parser callback type

    With a parser callback function, the result of parsing a JSON text can be
N
Niels 已提交
2027
    influenced. When passed to @ref parse(std::istream&, const
2028
    parser_callback_t) or @ref parse(const CharT, const parser_callback_t),
N
Niels 已提交
2029 2030 2031 2032 2033
    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 已提交
2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047

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

N
Niels 已提交
2050 2051
    Discarding a value (i.e., returning `false`) has different effects
    depending on the context in which function was called:
N
Niels 已提交
2052 2053 2054

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

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

N
Niels 已提交
2060
    @param[in] event  an event of type parse_event_t indicating the context in
N
Niels 已提交
2061 2062 2063 2064 2065 2066 2067 2068 2069 2070
    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
2071
    @ref parse(const CharT, const parser_callback_t) for examples
2072

N
Niels 已提交
2073
    @since version 1.0.0
N
Niels 已提交
2074
    */
N
Niels 已提交
2075 2076 2077
    using parser_callback_t = std::function<bool(int depth,
                              parse_event_t event,
                              basic_json& parsed)>;
N
Niels 已提交
2078

N
Niels 已提交
2079 2080 2081 2082 2083

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

N
Niels 已提交
2084
    /// @name constructors and destructors
N
Niels 已提交
2085 2086
    /// Constructors of class @ref basic_json, copy/move constructor, copy
    /// assignment, static functions creating objects, and the destructor.
N
Niels 已提交
2087 2088
    /// @{

N
Niels 已提交
2089 2090 2091
    /*!
    @brief create an empty value with a given type

N
Niels 已提交
2092 2093 2094 2095 2096
    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 已提交
2097 2098 2099 2100 2101 2102
    null        | `null`
    boolean     | `false`
    string      | `""`
    number      | `0`
    object      | `{}`
    array       | `[]`
N
Niels 已提交
2103

2104
    @param[in] value_type  the type of the value to create
N
Niels 已提交
2105 2106 2107

    @complexity Constant.

N
Niels 已提交
2108
    @throw std::bad_alloc if allocation for object, array, or string value
N
Niels 已提交
2109
    fails
N
Niels 已提交
2110 2111 2112

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

N
Niels 已提交
2114
    @since version 1.0.0
N
Niels 已提交
2115
    */
2116 2117
    basic_json(const value_t value_type)
        : m_type(value_type), m_value(value_type)
2118 2119 2120
    {
        assert_invariant();
    }
N
Niels 已提交
2121

N
Niels 已提交
2122
    /*!
N
Niels 已提交
2123
    @brief create a null object
N
Niels 已提交
2124

N
Niels 已提交
2125 2126
    Create a `null` JSON value. It either takes a null pointer as parameter
    (explicitly creating `null`) or no parameter (implicitly creating `null`).
N
Niels 已提交
2127 2128
    The passed null pointer itself is not read -- it is only used to choose
    the right constructor.
N
Niels 已提交
2129 2130 2131

    @complexity Constant.

N
Niels 已提交
2132 2133 2134
    @exceptionsafety No-throw guarantee: this constructor never throws
    exceptions.

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

N
Niels 已提交
2138
    @since version 1.0.0
N
Niels 已提交
2139
    */
N
Niels 已提交
2140
    basic_json(std::nullptr_t = nullptr) noexcept
N
Niels 已提交
2141
        : basic_json(value_t::null)
2142 2143 2144
    {
        assert_invariant();
    }
N
Niels 已提交
2145

T
Théo DELRIEU 已提交
2146
    /*!
2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 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
    @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 已提交
2185 2186 2187

    @param[in] val the value to be forwarded

2188 2189 2190 2191 2192 2193 2194 2195
    @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 已提交
2196 2197 2198

    @since version 2.1.0
    */
2199
    template<typename CompatibleType, typename U = detail::uncvref_t<CompatibleType>,
2200 2201 2202 2203 2204 2205
             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>
2206 2207
    basic_json(CompatibleType && val) noexcept(noexcept(JSONSerializer<U>::to_json(
                std::declval<basic_json_t&>(), std::forward<CompatibleType>(val))))
2208
    {
2209 2210
        JSONSerializer<U>::to_json(*this, std::forward<CompatibleType>(val));
        assert_invariant();
2211
    }
2212

N
Niels 已提交
2213 2214 2215 2216 2217 2218 2219 2220 2221 2222
    /*!
    @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 已提交
2223 2224
       object value is created where the first elements of the pairs are
       treated as keys and the second elements are as values.
N
Niels 已提交
2225 2226 2227
    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 已提交
2228
    JSON values. The rationale is as follows:
N
Niels 已提交
2229 2230

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

N
Niels 已提交
2239 2240
    With the rules described above, the following JSON values cannot be
    expressed by an initializer list:
N
Niels 已提交
2241

N
Niels 已提交
2242 2243 2244 2245 2246
    - 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 已提交
2247 2248 2249 2250 2251

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

N
Niels 已提交
2254 2255 2256
    @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 已提交
2257 2258
    used by the functions @ref array(std::initializer_list<basic_json>) and
    @ref object(std::initializer_list<basic_json>).
N
Niels 已提交
2259

N
Niels 已提交
2260 2261
    @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 已提交
2262 2263 2264
    value_t::array and @ref value_t::object are valid); when @a type_deduction
    is set to `true`, this parameter has no effect

2265 2266
    @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
N
Niels 已提交
2267 2268
    whose first element is a string; example: `"cannot create object from
    initializer list"`
N
Niels 已提交
2269 2270 2271 2272

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

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

N
Niels 已提交
2275
    @sa @ref array(std::initializer_list<basic_json>) -- create a JSON array
2276
    value from an initializer list
N
Niels 已提交
2277
    @sa @ref object(std::initializer_list<basic_json>) -- create a JSON object
2278 2279
    value from an initializer list

N
Niels 已提交
2280
    @since version 1.0.0
N
Niels 已提交
2281
    */
N
Niels 已提交
2282 2283
    basic_json(std::initializer_list<basic_json> init,
               bool type_deduction = true,
N
Niels 已提交
2284
               value_t manual_type = value_t::array)
N
Niels 已提交
2285
    {
N
Niels 已提交
2286 2287
        // check if each element is an array with two elements whose first
        // element is a string
N
Niels 已提交
2288 2289
        bool is_an_object = std::all_of(init.begin(), init.end(),
                                        [](const basic_json & element)
N
Niels 已提交
2290
        {
N
Niels 已提交
2291 2292
            return element.is_array() and element.size() == 2 and element[0].is_string();
        });
N
Niels 已提交
2293 2294 2295 2296 2297 2298 2299

        // 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)
            {
2300
                is_an_object = false;
N
Niels 已提交
2301 2302 2303
            }

            // if object is wanted but impossible, throw an exception
2304
            if (manual_type == value_t::object and not is_an_object)
N
Niels 已提交
2305
            {
2306
                JSON_THROW(type_error(301, "cannot create object from initializer list"));
N
Niels 已提交
2307 2308 2309
            }
        }

2310
        if (is_an_object)
N
Niels 已提交
2311 2312 2313
        {
            // the initializer list is a list of pairs -> create object
            m_type = value_t::object;
N
Niels 已提交
2314
            m_value = value_t::object;
N
Niels 已提交
2315

N
Niels 已提交
2316
            std::for_each(init.begin(), init.end(), [this](const basic_json & element)
N
Niels 已提交
2317
            {
N
Niels 已提交
2318
                m_value.object->emplace(*(element[0].m_value.string), element[1]);
N
Niels 已提交
2319
            });
N
Niels 已提交
2320 2321 2322 2323 2324
        }
        else
        {
            // the initializer list describes an array -> create array
            m_type = value_t::array;
N
Niels 已提交
2325
            m_value.array = create<array_t>(init);
N
Niels 已提交
2326
        }
2327 2328

        assert_invariant();
N
Niels 已提交
2329 2330
    }

N
Niels 已提交
2331 2332 2333 2334 2335 2336 2337
    /*!
    @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 已提交
2338 2339
    @note This function is only needed to express two edge cases that cannot
    be realized with the initializer list constructor (@ref
N
Niels 已提交
2340 2341
    basic_json(std::initializer_list<basic_json>, bool, value_t)). These cases
    are:
N
Niels 已提交
2342
    1. creating an array whose elements are all pairs whose first element is a
N
Niels 已提交
2343
    string -- in this case, the initializer list constructor would create an
N
Niels 已提交
2344
    object, taking the first elements as keys
N
Niels 已提交
2345
    2. creating an empty array -- passing the empty initializer list to the
N
Niels 已提交
2346 2347
    initializer list constructor yields an empty object

N
Niels 已提交
2348
    @param[in] init  initializer list with JSON values to create an array from
N
Niels 已提交
2349 2350 2351 2352 2353 2354
    (optional)

    @return JSON array value

    @complexity Linear in the size of @a init.

N
Niels 已提交
2355
    @liveexample{The following code shows an example for the `array`
N
Niels 已提交
2356 2357
    function.,array}

2358 2359 2360 2361 2362
    @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 已提交
2363
    @since version 1.0.0
N
Niels 已提交
2364
    */
N
Niels 已提交
2365
    static basic_json array(std::initializer_list<basic_json> init =
T
Théo DELRIEU 已提交
2366
                                std::initializer_list<basic_json>())
N
Niels 已提交
2367
    {
N
Niels 已提交
2368
        return basic_json(init, false, value_t::array);
N
Niels 已提交
2369 2370
    }

N
Niels 已提交
2371 2372 2373 2374
    /*!
    @brief explicitly create an object from an initializer list

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

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

N
Niels 已提交
2385
    @param[in] init  initializer list to create an object from (optional)
N
Niels 已提交
2386 2387 2388

    @return JSON object value

2389
    @throw type_error.301 if @a init is not a pair whose first elements are
2390 2391
    strings; thrown by
    @ref basic_json(std::initializer_list<basic_json>, bool, value_t)
N
Niels 已提交
2392 2393 2394

    @complexity Linear in the size of @a init.

N
Niels 已提交
2395
    @liveexample{The following code shows an example for the `object`
N
Niels 已提交
2396 2397
    function.,object}

2398 2399 2400 2401 2402
    @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 已提交
2403
    @since version 1.0.0
N
Niels 已提交
2404
    */
N
Niels 已提交
2405
    static basic_json object(std::initializer_list<basic_json> init =
T
Théo DELRIEU 已提交
2406
                                 std::initializer_list<basic_json>())
N
Niels 已提交
2407
    {
N
Niels 已提交
2408
        return basic_json(init, false, value_t::object);
N
Niels 已提交
2409 2410
    }

N
Niels 已提交
2411 2412 2413
    /*!
    @brief construct an array with count copies of given value

N
Niels 已提交
2414 2415
    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,
2416
    `std::distance(begin(),end()) == cnt` holds.
N
Niels 已提交
2417

2418 2419
    @param[in] cnt  the number of JSON copies of @a val to create
    @param[in] val  the JSON value to copy
N
Niels 已提交
2420

2421
    @complexity Linear in @a cnt.
N
Niels 已提交
2422 2423 2424 2425

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

N
Niels 已提交
2427
    @since version 1.0.0
N
Niels 已提交
2428
    */
2429
    basic_json(size_type cnt, const basic_json& val)
N
Niels 已提交
2430 2431
        : m_type(value_t::array)
    {
2432
        m_value.array = create<array_t>(cnt, val);
2433
        assert_invariant();
N
Niels 已提交
2434
    }
N
Niels 已提交
2435

N
Niels 已提交
2436 2437 2438 2439 2440
    /*!
    @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 已提交
2441
    - In case of primitive types (number, boolean, or string), @a first must
N
Niels 已提交
2442 2443
      be `begin()` and @a last must be `end()`. In this case, the value is
      copied. Otherwise, std::out_of_range is thrown.
N
Niels 已提交
2444 2445
    - In case of structured types (array, object), the constructor behaves as
      similar versions for `std::vector`.
N
Niels 已提交
2446
    - In case of a null type, std::domain_error is thrown.
N
Niels 已提交
2447 2448 2449 2450 2451 2452 2453

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

2457 2458 2459
    @throw invalid_iterator.201 if iterators are not compatible; that is, do
    not belong to the same JSON value; example: `"iterators are not
    compatible"`
2460
    @throw invalid_iterator.204 if iterators are for a primitive type (number,
N
Niels 已提交
2461 2462
    boolean, or string) where an out of range error can be detected easily;
    example: `"iterators out of range"`
N
Niels 已提交
2463
    @throw std::bad_alloc if allocation for object, array, or string fails
2464 2465
    @throw invalid_iterator.206 if called with a null value; example: `"cannot
    construct with iterators from null"`
N
Niels 已提交
2466 2467 2468 2469 2470

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

N
Niels 已提交
2472
    @since version 1.0.0
N
Niels 已提交
2473
    */
N
Niels 已提交
2474 2475 2476
    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 已提交
2477
    basic_json(InputIT first, InputIT last)
N
Niels 已提交
2478
    {
N
Niels 已提交
2479 2480 2481
        assert(first.m_object != nullptr);
        assert(last.m_object != nullptr);

N
Niels 已提交
2482
        // make sure iterator fits the current value
N
Niels 已提交
2483
        if (first.m_object != last.m_object)
N
Niels 已提交
2484
        {
2485
            JSON_THROW(invalid_iterator(201, "iterators are not compatible"));
N
Niels 已提交
2486 2487
        }

N
Niels 已提交
2488 2489 2490
        // copy type from first iterator
        m_type = first.m_object->m_type;

N
Niels 已提交
2491
        // check if iterator range is complete for primitive values
N
Niels 已提交
2492 2493 2494
        switch (m_type)
        {
            case value_t::boolean:
2495 2496
            case value_t::number_float:
            case value_t::number_integer:
2497
            case value_t::number_unsigned:
N
Niels 已提交
2498 2499
            case value_t::string:
            {
2500
                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
N
Niels 已提交
2501
                {
2502
                    JSON_THROW(invalid_iterator(204, "iterators out of range"));
N
Niels 已提交
2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519
                }
                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 已提交
2520

2521 2522 2523 2524 2525
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = first.m_object->m_value.number_unsigned;
                break;
            }
N
Niels 已提交
2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540

            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 已提交
2541
                m_value = *first.m_object->m_value.string;
N
Niels 已提交
2542 2543 2544 2545 2546
                break;
            }

            case value_t::object:
            {
N
Niels Lohmann 已提交
2547 2548
                m_value.object = create<object_t>(first.m_it.object_iterator,
                                                  last.m_it.object_iterator);
N
Niels 已提交
2549 2550 2551 2552 2553
                break;
            }

            case value_t::array:
            {
N
Niels Lohmann 已提交
2554 2555
                m_value.array = create<array_t>(first.m_it.array_iterator,
                                                last.m_it.array_iterator);
N
Niels 已提交
2556 2557 2558 2559 2560
                break;
            }

            default:
            {
2561 2562
                JSON_THROW(invalid_iterator(206, "cannot construct with iterators from " +
                                            first.m_object->type_name()));
N
Niels 已提交
2563 2564
            }
        }
2565 2566

        assert_invariant();
N
Niels 已提交
2567 2568
    }

N
Niels 已提交
2569

N
Niels 已提交
2570 2571 2572 2573
    ///////////////////////////////////////
    // other constructors and destructor //
    ///////////////////////////////////////

N
Niels 已提交
2574 2575
    /*!
    @brief copy constructor
N
Niels 已提交
2576

N
Niels 已提交
2577 2578
    Creates a copy of a given JSON value.

N
Niels 已提交
2579
    @param[in] other  the JSON value to copy
N
Niels 已提交
2580 2581 2582

    @complexity Linear in the size of @a other.

N
Niels 已提交
2583 2584 2585
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2586 2587 2588
    - The complexity is linear.
    - As postcondition, it holds: `other == basic_json(other)`.

N
Niels 已提交
2589
    @throw std::bad_alloc if allocation for object, array, or string fails.
N
Niels 已提交
2590 2591

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

N
Niels 已提交
2594
    @since version 1.0.0
N
Niels 已提交
2595
    */
N
Niels 已提交
2596
    basic_json(const basic_json& other)
N
Niels 已提交
2597 2598
        : m_type(other.m_type)
    {
2599 2600 2601
        // check of passed value is valid
        other.assert_invariant();

N
Niels 已提交
2602 2603
        switch (m_type)
        {
2604
            case value_t::object:
N
Niels 已提交
2605
            {
N
Niels 已提交
2606
                m_value = *other.m_value.object;
N
Niels 已提交
2607 2608
                break;
            }
N
Niels 已提交
2609

2610
            case value_t::array:
N
Niels 已提交
2611
            {
N
Niels 已提交
2612
                m_value = *other.m_value.array;
N
Niels 已提交
2613 2614
                break;
            }
N
Niels 已提交
2615

2616
            case value_t::string:
N
Niels 已提交
2617
            {
N
Niels 已提交
2618
                m_value = *other.m_value.string;
N
Niels 已提交
2619 2620
                break;
            }
N
Niels 已提交
2621

2622
            case value_t::boolean:
N
Niels 已提交
2623
            {
N
Niels 已提交
2624
                m_value = other.m_value.boolean;
N
Niels 已提交
2625 2626
                break;
            }
N
Niels 已提交
2627

2628
            case value_t::number_integer:
N
Niels 已提交
2629
            {
N
Niels 已提交
2630
                m_value = other.m_value.number_integer;
N
Niels 已提交
2631 2632
                break;
            }
N
Niels 已提交
2633

2634 2635 2636 2637 2638
            case value_t::number_unsigned:
            {
                m_value = other.m_value.number_unsigned;
                break;
            }
N
Niels 已提交
2639

2640
            case value_t::number_float:
N
Niels 已提交
2641
            {
N
Niels 已提交
2642
                m_value = other.m_value.number_float;
N
Niels 已提交
2643 2644
                break;
            }
2645 2646 2647 2648 2649

            default:
            {
                break;
            }
N
Niels 已提交
2650
        }
2651 2652

        assert_invariant();
N
Niels 已提交
2653 2654
    }

N
Niels 已提交
2655 2656 2657 2658 2659 2660 2661
    /*!
    @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 已提交
2662
    @param[in,out] other  value to move to this object
N
Niels 已提交
2663 2664 2665 2666 2667 2668 2669

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

N
Niels 已提交
2671
    @since version 1.0.0
N
Niels 已提交
2672
    */
N
Niels 已提交
2673
    basic_json(basic_json&& other) noexcept
N
Niels 已提交
2674 2675
        : m_type(std::move(other.m_type)),
          m_value(std::move(other.m_value))
N
Niels 已提交
2676
    {
2677 2678 2679
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2680
        // invalidate payload
N
Niels 已提交
2681 2682
        other.m_type = value_t::null;
        other.m_value = {};
2683 2684

        assert_invariant();
N
Niels 已提交
2685 2686
    }

N
Niels 已提交
2687 2688
    /*!
    @brief copy assignment
N
Niels 已提交
2689

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

N
Niels 已提交
2694
    @param[in] other  value to copy from
N
Niels 已提交
2695 2696 2697

    @complexity Linear.

N
Niels 已提交
2698 2699 2700
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2701 2702
    - The complexity is linear.

N
Niels 已提交
2703 2704 2705 2706
    @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 已提交
2707

N
Niels 已提交
2708
    @since version 1.0.0
N
Niels 已提交
2709
    */
N
Niels 已提交
2710
    reference& operator=(basic_json other) noexcept (
N
Niels 已提交
2711 2712 2713 2714
        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 已提交
2715
    )
N
Niels 已提交
2716
    {
2717 2718 2719
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2720
        using std::swap;
N
Cleanup  
Niels 已提交
2721 2722
        swap(m_type, other.m_type);
        swap(m_value, other.m_value);
2723 2724

        assert_invariant();
N
Niels 已提交
2725 2726 2727
        return *this;
    }

2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745
    /*!
    @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 已提交
2746

2747 2748 2749 2750 2751 2752 2753 2754 2755
        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 已提交
2756

2757 2758 2759 2760 2761 2762 2763
            case value_t::array:
            {
                AllocatorType<array_t> alloc;
                alloc.destroy(m_value.array);
                alloc.deallocate(m_value.array, 1);
                break;
            }
2764

2765 2766 2767 2768 2769 2770 2771
            case value_t::string:
            {
                AllocatorType<string_t> alloc;
                alloc.destroy(m_value.string);
                alloc.deallocate(m_value.string, 1);
                break;
            }
2772

2773 2774 2775 2776 2777 2778
            default:
            {
                // all other types need no specific destructor
                break;
            }
        }
N
Niels 已提交
2779 2780
    }

N
Niels 已提交
2781
    /// @}
N
Niels 已提交
2782 2783 2784 2785 2786 2787

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

N
Niels 已提交
2788
    /// @name object inspection
N
Niels 已提交
2789
    /// Functions to inspect the type of a JSON value.
N
Niels 已提交
2790 2791
    /// @{

N
Niels 已提交
2792
    /*!
N
Niels 已提交
2793 2794
    @brief serialization

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

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

N
Niels 已提交
2804 2805 2806 2807 2808
    @return string containing the serialization of the JSON value

    @complexity Linear.

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

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

N
Niels 已提交
2813
    @since version 1.0.0
N
Niels 已提交
2814
    */
N
Niels 已提交
2815
    string_t dump(const int indent = -1) const
N
Niels 已提交
2816
    {
N
Niels 已提交
2817
        std::stringstream ss;
2818
        serializer s(ss);
2819

N
Niels 已提交
2820 2821
        if (indent >= 0)
        {
2822
            s.dump(*this, true, static_cast<unsigned int>(indent));
N
Niels 已提交
2823 2824 2825
        }
        else
        {
2826
            s.dump(*this, false, 0);
N
Niels 已提交
2827
        }
N
Niels 已提交
2828 2829

        return ss.str();
N
Niels 已提交
2830 2831
    }

N
Niels 已提交
2832 2833 2834 2835 2836 2837 2838
    /*!
    @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 已提交
2839 2840 2841

    @complexity Constant.

N
Niels 已提交
2842 2843 2844
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2845
    @liveexample{The following code exemplifies `type()` for all JSON
N
Niels 已提交
2846
    types.,type}
N
Niels 已提交
2847

N
Niels 已提交
2848
    @since version 1.0.0
N
Niels 已提交
2849
    */
N
Niels 已提交
2850
    constexpr value_t type() const noexcept
N
Niels 已提交
2851 2852 2853 2854
    {
        return m_type;
    }

N
Niels 已提交
2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865
    /*!
    @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 已提交
2866 2867 2868
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2869
    @liveexample{The following code exemplifies `is_primitive()` for all JSON
N
Niels 已提交
2870
    types.,is_primitive}
N
Niels 已提交
2871

N
Niels 已提交
2872 2873 2874 2875 2876 2877
    @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 已提交
2878
    @since version 1.0.0
N
Niels 已提交
2879
    */
N
Niels 已提交
2880
    constexpr bool is_primitive() const noexcept
N
Niels 已提交
2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894
    {
        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 已提交
2895 2896 2897
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2898
    @liveexample{The following code exemplifies `is_structured()` for all JSON
N
Niels 已提交
2899
    types.,is_structured}
N
Niels 已提交
2900

N
Niels 已提交
2901 2902 2903 2904
    @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 已提交
2905
    @since version 1.0.0
N
Niels 已提交
2906
    */
N
Niels 已提交
2907
    constexpr bool is_structured() const noexcept
N
Niels 已提交
2908 2909 2910 2911
    {
        return is_array() or is_object();
    }

N
Niels 已提交
2912 2913 2914 2915 2916
    /*!
    @brief return whether value is null

    This function returns true iff the JSON value is null.

N
Niels 已提交
2917
    @return `true` if type is null, `false` otherwise.
N
Niels 已提交
2918 2919 2920

    @complexity Constant.

N
Niels 已提交
2921 2922 2923
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2924
    @liveexample{The following code exemplifies `is_null()` for all JSON
N
Niels 已提交
2925
    types.,is_null}
N
Niels 已提交
2926

N
Niels 已提交
2927
    @since version 1.0.0
N
Niels 已提交
2928
    */
N
Niels 已提交
2929
    constexpr bool is_null() const noexcept
N
Niels 已提交
2930 2931 2932 2933
    {
        return m_type == value_t::null;
    }

N
Niels 已提交
2934 2935 2936 2937 2938
    /*!
    @brief return whether value is a boolean

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

N
Niels 已提交
2939
    @return `true` if type is boolean, `false` otherwise.
N
Niels 已提交
2940 2941 2942

    @complexity Constant.

N
Niels 已提交
2943 2944 2945
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2946
    @liveexample{The following code exemplifies `is_boolean()` for all JSON
N
Niels 已提交
2947
    types.,is_boolean}
N
Niels 已提交
2948

N
Niels 已提交
2949
    @since version 1.0.0
N
Niels 已提交
2950
    */
N
Niels 已提交
2951
    constexpr bool is_boolean() const noexcept
N
Niels 已提交
2952 2953 2954 2955
    {
        return m_type == value_t::boolean;
    }

N
Niels 已提交
2956 2957 2958 2959 2960 2961
    /*!
    @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.

2962 2963
    @return `true` if type is number (regardless whether integer, unsigned
    integer or floating-type), `false` otherwise.
N
Niels 已提交
2964 2965 2966

    @complexity Constant.

N
Niels 已提交
2967 2968 2969
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2970
    @liveexample{The following code exemplifies `is_number()` for all JSON
N
Niels 已提交
2971
    types.,is_number}
N
Niels 已提交
2972

N
Niels 已提交
2973
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
2974
    integer number
N
Niels 已提交
2975 2976
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2977 2978
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
2979
    @since version 1.0.0
N
Niels 已提交
2980
    */
N
Niels 已提交
2981
    constexpr bool is_number() const noexcept
N
Niels 已提交
2982
    {
N
Niels 已提交
2983
        return is_number_integer() or is_number_float();
N
Niels 已提交
2984 2985
    }

N
Niels 已提交
2986 2987 2988
    /*!
    @brief return whether value is an integer number

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

N
Niels 已提交
2992
    @return `true` if type is an integer or unsigned integer number, `false`
2993
    otherwise.
N
Niels 已提交
2994 2995 2996

    @complexity Constant.

N
Niels 已提交
2997 2998 2999
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3000
    @liveexample{The following code exemplifies `is_number_integer()` for all
N
Niels 已提交
3001
    JSON types.,is_number_integer}
N
Niels 已提交
3002 3003

    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
3004 3005
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
3006 3007
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
3008
    @since version 1.0.0
N
Niels 已提交
3009
    */
N
Niels 已提交
3010
    constexpr bool is_number_integer() const noexcept
N
Niels 已提交
3011
    {
3012 3013
        return m_type == value_t::number_integer or m_type == value_t::number_unsigned;
    }
N
Niels 已提交
3014

3015 3016 3017
    /*!
    @brief return whether value is an unsigned integer number

N
Niels 已提交
3018 3019
    This function returns true iff the JSON value is an unsigned integer
    number. This excludes floating-point and (signed) integer values.
3020 3021 3022 3023 3024

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

    @complexity Constant.

N
Niels 已提交
3025 3026 3027
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3028
    @liveexample{The following code exemplifies `is_number_unsigned()` for all
N
Niels 已提交
3029 3030
    JSON types.,is_number_unsigned}

3031
    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
3032
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
3033 3034 3035 3036 3037
    integer number
    @sa @ref is_number_float() -- check if value is a floating-point number

    @since version 2.0.0
    */
N
Niels 已提交
3038
    constexpr bool is_number_unsigned() const noexcept
3039 3040
    {
        return m_type == value_t::number_unsigned;
N
Niels 已提交
3041 3042
    }

N
Niels 已提交
3043 3044 3045 3046
    /*!
    @brief return whether value is a floating-point number

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

N
Niels 已提交
3049
    @return `true` if type is a floating-point number, `false` otherwise.
N
Niels 已提交
3050 3051 3052

    @complexity Constant.

N
Niels 已提交
3053 3054 3055
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3056
    @liveexample{The following code exemplifies `is_number_float()` for all
N
Niels 已提交
3057
    JSON types.,is_number_float}
N
Niels 已提交
3058 3059 3060

    @sa @ref is_number() -- check if value is number
    @sa @ref is_number_integer() -- check if value is an integer number
N
Niels 已提交
3061 3062
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
3063

N
Niels 已提交
3064
    @since version 1.0.0
N
Niels 已提交
3065
    */
N
Niels 已提交
3066
    constexpr bool is_number_float() const noexcept
N
Niels 已提交
3067 3068 3069 3070
    {
        return m_type == value_t::number_float;
    }

N
Niels 已提交
3071 3072 3073 3074 3075
    /*!
    @brief return whether value is an object

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

N
Niels 已提交
3076
    @return `true` if type is object, `false` otherwise.
N
Niels 已提交
3077 3078 3079

    @complexity Constant.

N
Niels 已提交
3080 3081 3082
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3083
    @liveexample{The following code exemplifies `is_object()` for all JSON
N
Niels 已提交
3084
    types.,is_object}
N
Niels 已提交
3085

N
Niels 已提交
3086
    @since version 1.0.0
N
Niels 已提交
3087
    */
N
Niels 已提交
3088
    constexpr bool is_object() const noexcept
N
Niels 已提交
3089 3090 3091 3092
    {
        return m_type == value_t::object;
    }

N
Niels 已提交
3093 3094 3095 3096 3097
    /*!
    @brief return whether value is an array

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

N
Niels 已提交
3098
    @return `true` if type is array, `false` otherwise.
N
Niels 已提交
3099 3100 3101

    @complexity Constant.

N
Niels 已提交
3102 3103 3104
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3105
    @liveexample{The following code exemplifies `is_array()` for all JSON
N
Niels 已提交
3106
    types.,is_array}
N
Niels 已提交
3107

N
Niels 已提交
3108
    @since version 1.0.0
N
Niels 已提交
3109
    */
N
Niels 已提交
3110
    constexpr bool is_array() const noexcept
N
Niels 已提交
3111 3112 3113 3114
    {
        return m_type == value_t::array;
    }

N
Niels 已提交
3115 3116 3117 3118 3119
    /*!
    @brief return whether value is a string

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

N
Niels 已提交
3120
    @return `true` if type is string, `false` otherwise.
N
Niels 已提交
3121 3122 3123

    @complexity Constant.

N
Niels 已提交
3124 3125 3126
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3127
    @liveexample{The following code exemplifies `is_string()` for all JSON
N
Niels 已提交
3128
    types.,is_string}
N
Niels 已提交
3129

N
Niels 已提交
3130
    @since version 1.0.0
N
Niels 已提交
3131
    */
N
Niels 已提交
3132
    constexpr bool is_string() const noexcept
N
Niels 已提交
3133 3134 3135 3136
    {
        return m_type == value_t::string;
    }

N
Niels 已提交
3137 3138 3139 3140 3141 3142
    /*!
    @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 已提交
3143 3144 3145 3146
    @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 已提交
3147 3148 3149 3150
    @return `true` if type is discarded, `false` otherwise.

    @complexity Constant.

N
Niels 已提交
3151 3152 3153
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3154
    @liveexample{The following code exemplifies `is_discarded()` for all JSON
N
Niels 已提交
3155
    types.,is_discarded}
N
Niels 已提交
3156

N
Niels 已提交
3157
    @since version 1.0.0
N
Niels 已提交
3158
    */
N
Niels 已提交
3159
    constexpr bool is_discarded() const noexcept
N
Niels 已提交
3160 3161 3162 3163
    {
        return m_type == value_t::discarded;
    }

N
Niels 已提交
3164 3165 3166 3167 3168 3169 3170 3171 3172 3173
    /*!
    @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 已提交
3174 3175 3176
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

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

N
Niels 已提交
3180
    @since version 1.0.0
N
Niels 已提交
3181
    */
N
Niels 已提交
3182
    constexpr operator value_t() const noexcept
N
Niels 已提交
3183 3184 3185 3186
    {
        return m_type;
    }

N
Niels 已提交
3187 3188
    /// @}

N
Niels 已提交
3189
  private:
N
Niels Lohmann 已提交
3190 3191 3192 3193
    //////////////////
    // value access //
    //////////////////

N
Niels 已提交
3194
    /// get a boolean (explicit)
3195
    boolean_t get_impl(boolean_t* /*unused*/) const
N
Niels 已提交
3196
    {
3197 3198 3199 3200
        if (is_boolean())
        {
            return m_value.boolean;
        }
N
Niels Lohmann 已提交
3201

3202
        JSON_THROW(type_error(302, "type must be boolean, but is " + type_name()));
N
Niels 已提交
3203 3204
    }

N
Niels 已提交
3205
    /// get a pointer to the value (object)
N
Niels Lohmann 已提交
3206
    object_t* get_impl_ptr(object_t* /*unused*/) noexcept
N
Niels 已提交
3207 3208 3209 3210
    {
        return is_object() ? m_value.object : nullptr;
    }

N
Niels 已提交
3211
    /// get a pointer to the value (object)
N
Niels Lohmann 已提交
3212
    constexpr const object_t* get_impl_ptr(const object_t* /*unused*/) const noexcept
N
Niels 已提交
3213 3214 3215 3216 3217
    {
        return is_object() ? m_value.object : nullptr;
    }

    /// get a pointer to the value (array)
N
Niels Lohmann 已提交
3218
    array_t* get_impl_ptr(array_t* /*unused*/) noexcept
N
Niels 已提交
3219 3220 3221 3222
    {
        return is_array() ? m_value.array : nullptr;
    }

N
Niels 已提交
3223
    /// get a pointer to the value (array)
N
Niels Lohmann 已提交
3224
    constexpr const array_t* get_impl_ptr(const array_t* /*unused*/) const noexcept
N
Niels 已提交
3225 3226 3227 3228 3229
    {
        return is_array() ? m_value.array : nullptr;
    }

    /// get a pointer to the value (string)
N
Niels Lohmann 已提交
3230
    string_t* get_impl_ptr(string_t* /*unused*/) noexcept
N
Niels 已提交
3231 3232 3233 3234 3235
    {
        return is_string() ? m_value.string : nullptr;
    }

    /// get a pointer to the value (string)
N
Niels Lohmann 已提交
3236
    constexpr const string_t* get_impl_ptr(const string_t* /*unused*/) const noexcept
N
Niels 已提交
3237 3238 3239 3240 3241
    {
        return is_string() ? m_value.string : nullptr;
    }

    /// get a pointer to the value (boolean)
N
Niels Lohmann 已提交
3242
    boolean_t* get_impl_ptr(boolean_t* /*unused*/) noexcept
N
Niels 已提交
3243 3244 3245 3246 3247
    {
        return is_boolean() ? &m_value.boolean : nullptr;
    }

    /// get a pointer to the value (boolean)
N
Niels Lohmann 已提交
3248
    constexpr const boolean_t* get_impl_ptr(const boolean_t* /*unused*/) const noexcept
N
Niels 已提交
3249 3250 3251 3252 3253
    {
        return is_boolean() ? &m_value.boolean : nullptr;
    }

    /// get a pointer to the value (integer number)
N
Niels Lohmann 已提交
3254
    number_integer_t* get_impl_ptr(number_integer_t* /*unused*/) noexcept
N
Niels 已提交
3255 3256 3257 3258 3259
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }

    /// get a pointer to the value (integer number)
N
Niels Lohmann 已提交
3260
    constexpr const number_integer_t* get_impl_ptr(const number_integer_t* /*unused*/) const noexcept
N
Niels 已提交
3261 3262 3263
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }
N
Niels 已提交
3264

3265
    /// get a pointer to the value (unsigned number)
N
Niels Lohmann 已提交
3266
    number_unsigned_t* get_impl_ptr(number_unsigned_t* /*unused*/) noexcept
3267 3268 3269
    {
        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
    }
N
Niels 已提交
3270

3271
    /// get a pointer to the value (unsigned number)
N
Niels Lohmann 已提交
3272
    constexpr const number_unsigned_t* get_impl_ptr(const number_unsigned_t* /*unused*/) const noexcept
3273 3274 3275
    {
        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
    }
N
Niels 已提交
3276

N
Niels 已提交
3277
    /// get a pointer to the value (floating-point number)
N
Niels Lohmann 已提交
3278
    number_float_t* get_impl_ptr(number_float_t* /*unused*/) noexcept
N
Niels 已提交
3279 3280 3281 3282 3283
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

    /// get a pointer to the value (floating-point number)
N
Niels Lohmann 已提交
3284
    constexpr const number_float_t* get_impl_ptr(const number_float_t* /*unused*/) const noexcept
N
Niels 已提交
3285 3286 3287 3288
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

N
Niels 已提交
3289 3290 3291 3292 3293 3294 3295 3296
    /*!
    @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`

3297
    @throw type_error.303 if ReferenceType does not match underlying value
N
Niels 已提交
3298 3299 3300
    type of the current JSON
    */
    template<typename ReferenceType, typename ThisType>
3301
    static ReferenceType get_ref_impl(ThisType& obj)
D
dariomt 已提交
3302
    {
N
Niels 已提交
3303
        // helper type
N
Niels 已提交
3304 3305
        using PointerType = typename std::add_pointer<ReferenceType>::type;

N
Niels 已提交
3306
        // delegate the call to get_ptr<>()
3307 3308 3309 3310 3311 3312
        auto ptr = obj.template get_ptr<PointerType>();

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

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

N
Niels 已提交
3317
  public:
N
Niels Lohmann 已提交
3318 3319 3320 3321
    /// @name value access
    /// Direct access to the stored value of a JSON value.
    /// @{

T
Théo DELRIEU 已提交
3322 3323 3324
    /*!
    @brief get special-case overload

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

N
Niels Lohmann 已提交
3328
    @tparam BasicJsonType == @ref basic_json
T
Théo DELRIEU 已提交
3329 3330 3331 3332 3333 3334 3335

    @return a copy of *this

    @complexity Constant.

    @since version 2.1.0
    */
3336
    template <
N
Niels Lohmann 已提交
3337 3338
        typename BasicJsonType,
        detail::enable_if_t<std::is_same<typename std::remove_const<BasicJsonType>::type,
3339 3340
                                         basic_json_t>::value,
                            int> = 0 >
3341 3342
    basic_json get() const
    {
T
Théo DELRIEU 已提交
3343
        return *this;
3344 3345
    }

T
Théo DELRIEU 已提交
3346
    /*!
N
Niels Lohmann 已提交
3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360
    @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 已提交
3361 3362

    This overloads is chosen if:
N
Niels Lohmann 已提交
3363 3364 3365 3366 3367 3368 3369 3370
    - @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 已提交
3371

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

N
Niels Lohmann 已提交
3374 3375 3376 3377 3378 3379 3380 3381
    @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 已提交
3382 3383 3384

    @since version 2.1.0
    */
T
Théo DELRIEU 已提交
3385
    template <
N
Niels Lohmann 已提交
3386 3387
        typename ValueTypeCV,
        typename ValueType = detail::uncvref_t<ValueTypeCV>,
3388
        detail::enable_if_t <
N
Niels Lohmann 已提交
3389 3390 3391
            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 已提交
3392
            int > = 0 >
N
Niels Lohmann 已提交
3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405
    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 已提交
3406
        return ret;
3407
    }
3408

T
Théo DELRIEU 已提交
3409
    /*!
N
Niels Lohmann 已提交
3410 3411 3412 3413 3414 3415 3416
    @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 已提交
3417

N
Niels Lohmann 已提交
3418 3419 3420 3421
    The function is equivalent to executing
    @code {.cpp}
    return JSONSerializer<ValueTypeCV>::from_json(*this);
    @endcode
T
Théo DELRIEU 已提交
3422 3423

    This overloads is chosen if:
N
Niels Lohmann 已提交
3424 3425 3426 3427 3428 3429 3430 3431 3432
    - @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 已提交
3433

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

N
Niels Lohmann 已提交
3436
    @throw what @ref json_serializer<ValueType> `from_json()` method throws
T
Théo DELRIEU 已提交
3437 3438 3439

    @since version 2.1.0
    */
3440
    template <
N
Niels Lohmann 已提交
3441 3442 3443
        typename ValueTypeCV,
        typename ValueType = detail::uncvref_t<ValueTypeCV>,
        detail::enable_if_t<not std::is_same<basic_json_t, ValueType>::value and
3444
                            detail::has_non_default_from_json<basic_json_t,
N
Niels Lohmann 已提交
3445 3446 3447
                                    ValueType>::value, int> = 0 >
    ValueType get() const noexcept(noexcept(
                                       JSONSerializer<ValueTypeCV>::from_json(std::declval<const basic_json_t&>())))
3448
    {
N
Niels Lohmann 已提交
3449 3450 3451
        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);
3452 3453
    }

N
Niels 已提交
3454 3455 3456 3457 3458 3459
    /*!
    @brief get a pointer value (explicit)

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

N
Niels 已提交
3460 3461
    @warning The pointer becomes invalid if the underlying JSON object
    changes.
N
Niels 已提交
3462 3463

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

N
Niels 已提交
3467 3468
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
3469 3470 3471 3472 3473 3474 3475 3476 3477

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

N
Niels 已提交
3479
    @since version 1.0.0
N
Niels 已提交
3480
    */
N
Niels 已提交
3481 3482
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3483 3484 3485 3486 3487 3488 3489 3490 3491 3492
    PointerType get() noexcept
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

    /*!
    @brief get a pointer value (explicit)
    @copydoc get()
    */
N
Niels 已提交
3493 3494
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3495
    constexpr const PointerType get() const noexcept
N
Niels 已提交
3496 3497 3498 3499 3500 3501 3502 3503
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

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

N
Niels 已提交
3504
    Implicit pointer access to the internally stored JSON value. No copies are
N
Niels 已提交
3505 3506 3507 3508 3509 3510
    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 已提交
3511
    object_t, @ref string_t, @ref boolean_t, @ref number_integer_t,
N
Niels 已提交
3512 3513
    @ref number_unsigned_t, or @ref number_float_t. Enforced by a static
    assertion.
N
Niels 已提交
3514

N
Niels 已提交
3515 3516
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
3517 3518 3519 3520 3521 3522 3523

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

N
Niels 已提交
3525
    @since version 1.0.0
N
Niels 已提交
3526
    */
N
Niels 已提交
3527 3528
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3529 3530
    PointerType get_ptr() noexcept
    {
N
Niels 已提交
3531 3532
        // get the type of the PointerType (remove pointer and const)
        using pointee_t = typename std::remove_const<typename
T
Théo DELRIEU 已提交
3533 3534
                          std::remove_pointer<typename
                          std::remove_const<PointerType>::type>::type>::type;
N
Niels 已提交
3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545
        // 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 已提交
3546 3547 3548 3549 3550 3551 3552 3553
        // 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 已提交
3554 3555 3556
    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 已提交
3557
    constexpr const PointerType get_ptr() const noexcept
N
Niels 已提交
3558
    {
N
Niels 已提交
3559 3560
        // get the type of the PointerType (remove pointer and const)
        using pointee_t = typename std::remove_const<typename
T
Théo DELRIEU 已提交
3561 3562
                          std::remove_pointer<typename
                          std::remove_const<PointerType>::type>::type>::type;
N
Niels 已提交
3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573
        // 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 已提交
3574
        // delegate the call to get_impl_ptr<>() const
D
dariomt 已提交
3575
        return get_impl_ptr(static_cast<const PointerType>(nullptr));
D
dariomt 已提交
3576 3577
    }

N
Niels 已提交
3578
    /*!
D
dariomt 已提交
3579 3580
    @brief get a reference value (implicit)

N
Niels Lohmann 已提交
3581
    Implicit reference access to the internally stored JSON value. No copies
N
Niels 已提交
3582
    are made.
D
dariomt 已提交
3583 3584 3585 3586

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

N
Niels 已提交
3587 3588
    @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 已提交
3589
    @ref number_float_t. Enforced by static assertion.
D
dariomt 已提交
3590

N
Niels 已提交
3591 3592 3593
    @return reference to the internally stored JSON value if the requested
    reference type @a ReferenceType fits to the JSON value; throws
    std::domain_error otherwise
D
dariomt 已提交
3594

3595 3596
    @throw type_error.303 in case passed type @a ReferenceType is incompatible
    with the stored JSON value
D
dariomt 已提交
3597 3598

    @complexity Constant.
N
Niels 已提交
3599 3600 3601

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

N
Niels 已提交
3602
    @since version 1.1.0
D
dariomt 已提交
3603
    */
N
Niels 已提交
3604 3605
    template<typename ReferenceType, typename std::enable_if<
                 std::is_reference<ReferenceType>::value, int>::type = 0>
D
dariomt 已提交
3606 3607
    ReferenceType get_ref()
    {
N
Niels 已提交
3608 3609
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
D
dariomt 已提交
3610 3611 3612 3613 3614 3615
    }

    /*!
    @brief get a reference value (implicit)
    @copydoc get_ref()
    */
N
Niels 已提交
3616 3617 3618
    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>
3619
    ReferenceType get_ref() const
D
dariomt 已提交
3620
    {
N
Niels 已提交
3621 3622
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
N
Niels 已提交
3623 3624 3625 3626 3627
    }

    /*!
    @brief get a value (implicit)

N
Niels 已提交
3628 3629
    Implicit type conversion between the JSON value and a compatible value.
    The call is realized by calling @ref get() const.
N
Niels 已提交
3630 3631 3632

    @tparam ValueType non-pointer type compatible to the JSON value, for
    instance `int` for JSON integer numbers, `bool` for JSON booleans, or
N
Niels 已提交
3633 3634 3635
    `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 已提交
3636 3637 3638 3639 3640 3641 3642 3643

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

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

    @complexity Linear in the size of the JSON value.

N
Niels 已提交
3644
    @liveexample{The example below shows several conversions from JSON values
N
Niels 已提交
3645 3646 3647
    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 已提交
3648
    associative containers such as `std::unordered_map<std::string\,
N
Niels 已提交
3649
    json>`.,operator__ValueType}
N
Niels 已提交
3650

N
Niels 已提交
3651
    @since version 1.0.0
N
Niels 已提交
3652
    */
N
Niels 已提交
3653 3654 3655
    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 已提交
3656
#ifndef _MSC_VER  // fix for issue #167 operator<< ambiguity under VS2015
N
Niels 已提交
3657
                   and not std::is_same<ValueType, std::initializer_list<typename string_t::value_type>>::value
3658
#endif
N
Niels 已提交
3659
                   , int >::type = 0 >
N
Niels 已提交
3660
    operator ValueType() const
N
Niels 已提交
3661
    {
N
Niels 已提交
3662 3663
        // delegate the call to get<>() const
        return get<ValueType>();
N
Niels 已提交
3664 3665
    }

N
Niels 已提交
3666 3667
    /// @}

N
Niels 已提交
3668 3669 3670 3671 3672

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

N
Niels 已提交
3673
    /// @name element access
N
Niels 已提交
3674
    /// Access to the JSON value.
N
Niels 已提交
3675 3676
    /// @{

N
Niels 已提交
3677 3678 3679 3680 3681 3682 3683 3684 3685 3686
    /*!
    @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

3687 3688
    @throw type_error.304 if the JSON value is not an array; example: `"cannot
    use at() with string"`
3689
    @throw out_of_range.401 if the index @a idx is out of range of the array;
N
Niels 已提交
3690
    that is, `idx >= size()`; example: `"array index 7 is out of range"`
N
Niels 已提交
3691 3692 3693 3694

    @complexity Constant.

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

N
Niels 已提交
3697
    @since version 1.0.0
N
Niels 已提交
3698
    */
N
Niels 已提交
3699
    reference at(size_type idx)
N
Niels 已提交
3700 3701
    {
        // at only works for arrays
3702 3703
        if (is_array())
        {
3704
            JSON_TRY
N
Niels 已提交
3705 3706 3707
            {
                return m_value.array->at(idx);
            }
3708
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3709 3710
            {
                // create better exception explanation
3711
                JSON_THROW(out_of_range(401, "array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
3712
            }
3713 3714
        }
        else
N
Niels 已提交
3715
        {
3716
            JSON_THROW(type_error(304, "cannot use at() with " + type_name()));
N
Niels 已提交
3717 3718 3719
        }
    }

N
Niels 已提交
3720 3721 3722
    /*!
    @brief access specified array element with bounds checking

N
Niels 已提交
3723 3724
    Returns a const reference to the element at specified location @a idx,
    with bounds checking.
N
Niels 已提交
3725 3726 3727 3728 3729

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

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

3730 3731
    @throw type_error.304 if the JSON value is not an array; example: `"cannot
    use at() with string"`
3732
    @throw out_of_range.401 if the index @a idx is out of range of the array;
N
Niels 已提交
3733
    that is, `idx >= size()`; example: `"array index 7 is out of range"`
N
Niels 已提交
3734 3735 3736 3737

    @complexity Constant.

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

N
Niels 已提交
3740
    @since version 1.0.0
N
Niels 已提交
3741
    */
N
Niels 已提交
3742
    const_reference at(size_type idx) const
N
Niels 已提交
3743 3744
    {
        // at only works for arrays
3745 3746
        if (is_array())
        {
3747
            JSON_TRY
N
Niels 已提交
3748 3749 3750
            {
                return m_value.array->at(idx);
            }
3751
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3752 3753
            {
                // create better exception explanation
3754
                JSON_THROW(out_of_range(401, "array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
3755
            }
3756 3757
        }
        else
N
Niels 已提交
3758
        {
3759
            JSON_THROW(type_error(304, "cannot use at() with " + type_name()));
N
Niels 已提交
3760
        }
3761 3762
    }

N
Niels 已提交
3763 3764 3765 3766 3767 3768 3769 3770 3771 3772
    /*!
    @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

3773
    @throw type_error.304 if the JSON value is not an object; example:
N
Niels 已提交
3774
    `"cannot use at() with boolean"`
3775
    @throw out_of_range.403 if the key @a key is is not stored in the object;
N
Niels 已提交
3776
    that is, `find(key) == end()`; example: `"key "the fast" not found"`
N
Niels 已提交
3777 3778 3779 3780

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3781
    written using `at()`.,at__object_t_key_type}
N
Niels 已提交
3782 3783 3784 3785

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

N
Niels 已提交
3787
    @since version 1.0.0
N
Niels 已提交
3788
    */
N
Niels 已提交
3789
    reference at(const typename object_t::key_type& key)
3790 3791
    {
        // at only works for objects
3792 3793
        if (is_object())
        {
3794
            JSON_TRY
N
Niels 已提交
3795 3796 3797
            {
                return m_value.object->at(key);
            }
3798
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3799 3800
            {
                // create better exception explanation
3801
                JSON_THROW(out_of_range(403, "key '" + key + "' not found"));
N
Niels 已提交
3802
            }
3803 3804
        }
        else
3805
        {
3806
            JSON_THROW(type_error(304, "cannot use at() with " + type_name()));
3807 3808 3809
        }
    }

N
Niels 已提交
3810 3811 3812
    /*!
    @brief access specified object element with bounds checking

N
Niels 已提交
3813 3814
    Returns a const reference to the element at with specified key @a key,
    with bounds checking.
N
Niels 已提交
3815 3816 3817 3818 3819

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

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

3820
    @throw type_error.304 if the JSON value is not an object; example:
N
Niels 已提交
3821
    `"cannot use at() with boolean"`
3822
    @throw out_of_range.403 if the key @a key is is not stored in the object;
N
Niels 已提交
3823
    that is, `find(key) == end()`; example: `"key "the fast" not found"`
N
Niels 已提交
3824 3825 3826 3827

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3828
    `at()`.,at__object_t_key_type_const}
N
Niels 已提交
3829 3830 3831 3832

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

N
Niels 已提交
3834
    @since version 1.0.0
N
Niels 已提交
3835
    */
N
Niels 已提交
3836
    const_reference at(const typename object_t::key_type& key) const
3837 3838
    {
        // at only works for objects
3839 3840
        if (is_object())
        {
3841
            JSON_TRY
N
Niels 已提交
3842 3843 3844
            {
                return m_value.object->at(key);
            }
3845
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3846 3847
            {
                // create better exception explanation
3848
                JSON_THROW(out_of_range(403, "key '" + key + "' not found"));
N
Niels 已提交
3849
            }
3850 3851
        }
        else
3852
        {
3853
            JSON_THROW(type_error(304, "cannot use at() with " + type_name()));
3854
        }
N
Niels 已提交
3855 3856
    }

N
Niels 已提交
3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869
    /*!
    @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

3870 3871
    @throw type_error.305 if JSON is not an array or null; example: `"cannot
    use operator[] with string"
N
Niels 已提交
3872 3873 3874 3875 3876

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

N
Niels 已提交
3880
    @since version 1.0.0
N
Niels 已提交
3881
    */
N
Niels 已提交
3882
    reference operator[](size_type idx)
N
Niels 已提交
3883
    {
N
Niels 已提交
3884
        // implicitly convert null value to an empty array
N
cleanup  
Niels 已提交
3885
        if (is_null())
N
Niels 已提交
3886 3887
        {
            m_type = value_t::array;
N
Cleanup  
Niels 已提交
3888
            m_value.array = create<array_t>();
3889
            assert_invariant();
N
Niels 已提交
3890 3891
        }

N
Niels 已提交
3892
        // operator[] only works for arrays
N
cleanup  
Niels 已提交
3893
        if (is_array())
N
Niels 已提交
3894
        {
N
Niels 已提交
3895 3896
            // fill up array with null values if given idx is outside range
            if (idx >= m_value.array->size())
N
cleanup  
Niels 已提交
3897
            {
N
Niels 已提交
3898 3899 3900
                m_value.array->insert(m_value.array->end(),
                                      idx - m_value.array->size() + 1,
                                      basic_json());
N
cleanup  
Niels 已提交
3901
            }
N
Niels 已提交
3902

N
cleanup  
Niels 已提交
3903 3904
            return m_value.array->operator[](idx);
        }
N
Niels Lohmann 已提交
3905

3906
        JSON_THROW(type_error(305, "cannot use operator[] with " + type_name()));
N
Niels 已提交
3907 3908
    }

N
Niels 已提交
3909 3910 3911 3912 3913 3914 3915 3916 3917
    /*!
    @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

3918
    @throw type_error.305 if JSON is not an array; example: `"cannot use
N
Niels 已提交
3919
    operator[] with null"`
N
Niels 已提交
3920 3921 3922 3923

    @complexity Constant.

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

N
Niels 已提交
3926
    @since version 1.0.0
N
Niels 已提交
3927
    */
N
Niels 已提交
3928
    const_reference operator[](size_type idx) const
N
Niels 已提交
3929
    {
N
Niels 已提交
3930
        // const operator[] only works for arrays
N
Niels 已提交
3931 3932 3933 3934
        if (is_array())
        {
            return m_value.array->operator[](idx);
        }
N
Niels Lohmann 已提交
3935

3936
        JSON_THROW(type_error(305, "cannot use operator[] with " + type_name()));
N
Niels 已提交
3937 3938
    }

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

3952 3953
    @throw type_error.305 if JSON is not an object or null; example: `"cannot
    use operator[] with string"`
N
Niels 已提交
3954 3955 3956 3957

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3958
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
3959 3960 3961 3962

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

N
Niels 已提交
3964
    @since version 1.0.0
N
Niels 已提交
3965
    */
N
Niels 已提交
3966
    reference operator[](const typename object_t::key_type& key)
N
Niels 已提交
3967
    {
N
Niels 已提交
3968
        // implicitly convert null value to an empty object
N
cleanup  
Niels 已提交
3969
        if (is_null())
N
Niels 已提交
3970 3971
        {
            m_type = value_t::object;
N
Cleanup  
Niels 已提交
3972
            m_value.object = create<object_t>();
3973
            assert_invariant();
N
Niels 已提交
3974 3975
        }

N
Niels 已提交
3976
        // operator[] only works for objects
N
Niels 已提交
3977 3978 3979 3980
        if (is_object())
        {
            return m_value.object->operator[](key);
        }
N
Niels Lohmann 已提交
3981

3982
        JSON_THROW(type_error(305, "cannot use operator[] with " + type_name()));
N
Niels 已提交
3983 3984
    }

N
Niels 已提交
3985
    /*!
3986
    @brief read-only access specified object element
N
Niels 已提交
3987

3988 3989 3990 3991 3992
    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 已提交
3993 3994 3995

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

3996
    @return const reference to the element at key @a key
N
Niels 已提交
3997

N
Niels 已提交
3998 3999 4000
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

4001
    @throw type_error.305 if JSON is not an object; example: `"cannot use
N
Niels 已提交
4002
    operator[] with null"`
N
Niels 已提交
4003 4004 4005 4006

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
4007
    the `[]` operator.,operatorarray__key_type_const}
4008 4009 4010 4011 4012

    @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 已提交
4013
    @since version 1.0.0
N
Niels 已提交
4014
    */
N
Niels 已提交
4015
    const_reference operator[](const typename object_t::key_type& key) const
4016
    {
N
Niels 已提交
4017
        // const operator[] only works for objects
N
Niels 已提交
4018 4019 4020 4021 4022
        if (is_object())
        {
            assert(m_value.object->find(key) != m_value.object->end());
            return m_value.object->find(key)->second;
        }
N
Niels Lohmann 已提交
4023

4024
        JSON_THROW(type_error(305, "cannot use operator[] with " + type_name()));
4025 4026
    }

N
Niels 已提交
4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039
    /*!
    @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

4040 4041
    @throw type_error.305 if JSON is not an object or null; example: `"cannot
    use operator[] with string"`
N
Niels 已提交
4042 4043 4044 4045

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
4046
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
4047 4048 4049 4050

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

N
Niels 已提交
4052
    @since version 1.0.0
N
Niels 已提交
4053
    */
N
Niels 已提交
4054
    template<typename T, std::size_t n>
N
Niels 已提交
4055
    reference operator[](T * (&key)[n])
4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080
    {
        return operator[](static_cast<const T>(key));
    }

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

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

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

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

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

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

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

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
4081
    the `[]` operator.,operatorarray__key_type_const}
4082 4083 4084 4085 4086 4087 4088 4089

    @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 已提交
4090
    const_reference operator[](T * (&key)[n]) const
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 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

4108 4109
    @throw type_error.305 if JSON is not an object or null; example: `"cannot
    use operator[] with string"`
4110 4111 4112 4113

    @complexity Logarithmic in the size of the container.

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

    @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 已提交
4120
    @since version 1.1.0
4121 4122 4123
    */
    template<typename T>
    reference operator[](T* key)
N
Niels 已提交
4124
    {
N
Niels 已提交
4125
        // implicitly convert null to object
N
cleanup  
Niels 已提交
4126
        if (is_null())
N
Niels 已提交
4127 4128
        {
            m_type = value_t::object;
N
Niels 已提交
4129
            m_value = value_t::object;
4130
            assert_invariant();
N
Niels 已提交
4131 4132
        }

N
Niels 已提交
4133
        // at only works for objects
N
Niels 已提交
4134 4135 4136 4137
        if (is_object())
        {
            return m_value.object->operator[](key);
        }
N
Niels Lohmann 已提交
4138

4139
        JSON_THROW(type_error(305, "cannot use operator[] with " + type_name()));
N
Niels 已提交
4140 4141
    }

N
Niels 已提交
4142
    /*!
4143
    @brief read-only access specified object element
N
Niels 已提交
4144

4145 4146 4147 4148 4149
    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 已提交
4150 4151 4152

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

4153
    @return const reference to the element at key @a key
N
Niels 已提交
4154

N
Niels 已提交
4155 4156 4157
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

4158
    @throw type_error.305 if JSON is not an object; example: `"cannot use
N
Niels 已提交
4159
    operator[] with null"`
N
Niels 已提交
4160 4161 4162 4163

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
4164
    the `[]` operator.,operatorarray__key_type_const}
4165 4166 4167 4168 4169

    @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 已提交
4170
    @since version 1.1.0
N
Niels 已提交
4171
    */
4172 4173
    template<typename T>
    const_reference operator[](T* key) const
4174 4175
    {
        // at only works for objects
N
Niels 已提交
4176 4177 4178 4179 4180
        if (is_object())
        {
            assert(m_value.object->find(key) != m_value.object->end());
            return m_value.object->find(key)->second;
        }
N
Niels Lohmann 已提交
4181

4182
        JSON_THROW(type_error(305, "cannot use operator[] with " + type_name()));
4183 4184
    }

N
Niels 已提交
4185 4186 4187
    /*!
    @brief access specified object element with default value

N
Niels 已提交
4188 4189
    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.
4190

N
Niels 已提交
4191
    The function is basically equivalent to executing
4192
    @code {.cpp}
N
Niels 已提交
4193 4194
    try {
        return at(key);
4195
    } catch(out_of_range) {
N
Niels 已提交
4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217
        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

4218
    @throw type_error.306 if JSON is not an object; example: `"cannot use
N
Niels 已提交
4219
    value() with null"`
N
Niels 已提交
4220 4221 4222 4223 4224 4225 4226 4227 4228 4229

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

N
Niels 已提交
4231
    @since version 1.0.0
N
Niels 已提交
4232
    */
N
Niels 已提交
4233 4234
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245
    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 已提交
4246 4247

            return default_value;
N
Niels 已提交
4248 4249 4250
        }
        else
        {
4251
            JSON_THROW(type_error(306, "cannot use value() with " + type_name()));
N
Niels 已提交
4252 4253 4254 4255
        }
    }

    /*!
N
Niels 已提交
4256
    @brief overload for a default value of type const char*
N
Niels 已提交
4257
    @copydoc basic_json::value(const typename object_t::key_type&, ValueType) const
N
Niels 已提交
4258 4259 4260 4261
    */
    string_t value(const typename object_t::key_type& key, const char* default_value) const
    {
        return value(key, string_t(default_value));
4262 4263
    }

N
Niels 已提交
4264 4265 4266
    /*!
    @brief access specified object element via JSON Pointer with default value

N
Niels 已提交
4267 4268 4269 4270 4271 4272 4273
    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);
4274
    } catch(out_of_range) {
N
Niels 已提交
4275 4276 4277 4278 4279 4280 4281
        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 已提交
4282 4283 4284 4285 4286 4287 4288 4289
    @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 已提交
4290 4291 4292
    @return copy of the element at key @a key or @a default_value if @a key
    is not found

4293
    @throw type_error.306 if JSON is not an object; example: `"cannot use
N
Niels 已提交
4294 4295 4296 4297 4298 4299 4300
    value() with null"`

    @complexity Logarithmic in the size of the container.

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

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

N
Niels 已提交
4303 4304
    @since version 2.0.2
    */
N
Niels 已提交
4305 4306
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
4307 4308 4309 4310 4311 4312
    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
4313
            JSON_TRY
N
Niels 已提交
4314 4315 4316
            {
                return ptr.get_checked(this);
            }
4317
            JSON_CATCH (out_of_range&)
N
Niels 已提交
4318 4319 4320 4321
            {
                return default_value;
            }
        }
N
Niels Lohmann 已提交
4322

4323
        JSON_THROW(type_error(306, "cannot use value() with " + type_name()));
N
Niels 已提交
4324 4325 4326 4327
    }

    /*!
    @brief overload for a default value of type const char*
N
Niels 已提交
4328
    @copydoc basic_json::value(const json_pointer&, ValueType) const
N
Niels 已提交
4329 4330 4331 4332 4333 4334
    */
    string_t value(const json_pointer& ptr, const char* default_value) const
    {
        return value(ptr, string_t(default_value));
    }

N
Niels 已提交
4335 4336 4337 4338 4339 4340
    /*!
    @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 已提交
4341
    @return In case of a structured type (array or object), a reference to the
4342
    first element is returned. In case of number, string, or boolean values, a
N
Niels 已提交
4343 4344 4345 4346
    reference to the value is returned.

    @complexity Constant.

N
Niels 已提交
4347
    @pre The JSON value must not be `null` (would throw `std::out_of_range`)
N
Niels 已提交
4348 4349
    or an empty array or object (undefined behavior, **guarded by
    assertions**).
N
Niels 已提交
4350 4351 4352
    @post The JSON value remains unchanged.

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

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

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

N
Niels 已提交
4358
    @since version 1.0.0
N
Niels 已提交
4359
    */
N
Niels 已提交
4360
    reference front()
N
Niels 已提交
4361 4362 4363 4364
    {
        return *begin();
    }

N
Niels 已提交
4365 4366 4367
    /*!
    @copydoc basic_json::front()
    */
N
Niels 已提交
4368
    const_reference front() const
N
Niels 已提交
4369 4370 4371 4372
    {
        return *cbegin();
    }

N
Niels 已提交
4373 4374 4375 4376
    /*!
    @brief access the last element

    Returns a reference to the last element in the container. For a JSON
N
Niels 已提交
4377 4378 4379 4380 4381 4382
    container `c`, the expression `c.back()` is equivalent to
    @code {.cpp}
    auto tmp = c.end();
    --tmp;
    return *tmp;
    @endcode
N
Niels 已提交
4383

N
Niels 已提交
4384
    @return In case of a structured type (array or object), a reference to the
4385
    last element is returned. In case of number, string, or boolean values, a
N
Niels 已提交
4386 4387 4388 4389
    reference to the value is returned.

    @complexity Constant.

N
Niels 已提交
4390
    @pre The JSON value must not be `null` (would throw `std::out_of_range`)
N
Niels 已提交
4391 4392
    or an empty array or object (undefined behavior, **guarded by
    assertions**).
N
Niels 已提交
4393
    @post The JSON value remains unchanged.
N
Niels 已提交
4394

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

N
Niels 已提交
4397 4398 4399
    @liveexample{The following code shows an example for `back()`.,back}

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

N
Niels 已提交
4401
    @since version 1.0.0
N
Niels 已提交
4402
    */
N
Niels 已提交
4403
    reference back()
N
Niels 已提交
4404 4405 4406 4407 4408 4409
    {
        auto tmp = end();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
4410 4411 4412
    /*!
    @copydoc basic_json::back()
    */
N
Niels 已提交
4413
    const_reference back() const
N
Niels 已提交
4414 4415 4416 4417 4418 4419
    {
        auto tmp = cend();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
4420 4421 4422
    /*!
    @brief remove element given an iterator

N
Niels 已提交
4423 4424 4425
    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 已提交
4426

N
Niels 已提交
4427
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
4428 4429 4430
    will be `null`.

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

4434
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
4435

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

4439 4440
    @throw type_error.307 if called on a `null` value; example: `"cannot use
    erase() with null"`
4441 4442 4443
    @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"`
4444
    @throw invalid_iterator.205 if called on a primitive type with invalid
N
Niels 已提交
4445 4446
    iterator (i.e., any iterator which is not `begin()`); example: `"iterator
    out of range"`
N
Niels 已提交
4447 4448 4449

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

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

4457
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4458
    the given range
N
Niels 已提交
4459
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4460
    from an object at the given key
N
Niels 已提交
4461 4462
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4463

N
Niels 已提交
4464
    @since version 1.0.0
N
Niels 已提交
4465
    */
N
Niels 已提交
4466 4467 4468 4469
    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>
4470
    IteratorType erase(IteratorType pos)
4471 4472
    {
        // make sure iterator fits the current value
N
Niels 已提交
4473
        if (this != pos.m_object)
4474
        {
4475
            JSON_THROW(invalid_iterator(202, "iterator does not fit current value"));
4476 4477
        }

4478
        IteratorType result = end();
4479 4480 4481 4482

        switch (m_type)
        {
            case value_t::boolean:
4483 4484
            case value_t::number_float:
            case value_t::number_integer:
4485
            case value_t::number_unsigned:
4486 4487
            case value_t::string:
            {
4488
                if (not pos.m_it.primitive_iterator.is_begin())
4489
                {
4490
                    JSON_THROW(invalid_iterator(205, "iterator out of range"));
4491 4492
                }

N
cleanup  
Niels 已提交
4493
                if (is_string())
4494
                {
4495 4496 4497
                    AllocatorType<string_t> alloc;
                    alloc.destroy(m_value.string);
                    alloc.deallocate(m_value.string, 1);
4498 4499 4500 4501
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
4502
                assert_invariant();
4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519
                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:
            {
4520
                JSON_THROW(type_error(307, "cannot use erase() with " + type_name()));
4521 4522 4523 4524 4525 4526
            }
        }

        return result;
    }

N
Niels 已提交
4527 4528 4529
    /*!
    @brief remove elements given an iterator range

N
Niels 已提交
4530 4531 4532
    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 已提交
4533

N
Niels 已提交
4534
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
4535 4536 4537 4538 4539
    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 已提交
4540
    second refers to the last element, the `end()` iterator is returned.
N
Niels 已提交
4541

4542
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
4543

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

4547 4548
    @throw type_error.307 if called on a `null` value; example: `"cannot use
    erase() with null"`
4549 4550 4551
    @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 已提交
4552 4553
    iterators (i.e., if `first != begin()` and `last != end()`); example:
    `"iterators out of range"`
N
Niels 已提交
4554 4555 4556 4557 4558 4559 4560 4561

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

4565
    @sa @ref erase(IteratorType) -- removes the element at a given position
N
Niels 已提交
4566
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4567
    from an object at the given key
N
Niels 已提交
4568 4569
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4570

N
Niels 已提交
4571
    @since version 1.0.0
N
Niels 已提交
4572
    */
N
Niels 已提交
4573 4574 4575 4576
    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>
4577
    IteratorType erase(IteratorType first, IteratorType last)
4578 4579
    {
        // make sure iterator fits the current value
N
Niels 已提交
4580
        if (this != first.m_object or this != last.m_object)
4581
        {
4582
            JSON_THROW(invalid_iterator(203, "iterators do not fit current value"));
4583 4584
        }

4585
        IteratorType result = end();
4586 4587 4588 4589

        switch (m_type)
        {
            case value_t::boolean:
4590 4591
            case value_t::number_float:
            case value_t::number_integer:
4592
            case value_t::number_unsigned:
4593 4594
            case value_t::string:
            {
4595
                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
4596
                {
4597
                    JSON_THROW(invalid_iterator(204, "iterators out of range"));
4598 4599
                }

N
cleanup  
Niels 已提交
4600
                if (is_string())
4601
                {
4602 4603 4604
                    AllocatorType<string_t> alloc;
                    alloc.destroy(m_value.string);
                    alloc.deallocate(m_value.string, 1);
4605 4606 4607 4608
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
4609
                assert_invariant();
4610 4611 4612 4613 4614 4615
                break;
            }

            case value_t::object:
            {
                result.m_it.object_iterator = m_value.object->erase(first.m_it.object_iterator,
T
Théo DELRIEU 已提交
4616
                                              last.m_it.object_iterator);
4617 4618 4619 4620 4621 4622
                break;
            }

            case value_t::array:
            {
                result.m_it.array_iterator = m_value.array->erase(first.m_it.array_iterator,
T
Théo DELRIEU 已提交
4623
                                             last.m_it.array_iterator);
4624 4625 4626 4627 4628
                break;
            }

            default:
            {
4629
                JSON_THROW(type_error(307, "cannot use erase() with " + type_name()));
4630 4631 4632 4633 4634 4635
            }
        }

        return result;
    }

N
Niels 已提交
4636 4637 4638 4639 4640 4641 4642
    /*!
    @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 已提交
4643
    @return Number of elements removed. If @a ObjectType is the default
N
Niels 已提交
4644 4645
    `std::map` type, the return value will always be `0` (@a key was not
    found) or `1` (@a key was found).
N
Niels 已提交
4646 4647 4648

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

4650
    @throw type_error.307 when called on a type other than JSON object;
N
Niels 已提交
4651
    example: `"cannot use erase() with null"`
N
Niels 已提交
4652 4653 4654

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

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

4657 4658
    @sa @ref erase(IteratorType) -- removes the element at a given position
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4659 4660 4661
    the given range
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4662

N
Niels 已提交
4663
    @since version 1.0.0
N
Niels 已提交
4664
    */
N
Niels 已提交
4665
    size_type erase(const typename object_t::key_type& key)
4666
    {
N
Niels 已提交
4667
        // this erase only works for objects
N
Niels 已提交
4668 4669 4670 4671
        if (is_object())
        {
            return m_value.object->erase(key);
        }
N
Niels Lohmann 已提交
4672

4673
        JSON_THROW(type_error(307, "cannot use erase() with " + type_name()));
4674 4675
    }

N
Niels 已提交
4676 4677 4678 4679 4680 4681 4682
    /*!
    @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

4683
    @throw type_error.307 when called on a type other than JSON object;
N
Niels 已提交
4684
    example: `"cannot use erase() with null"`
N
Niels 已提交
4685 4686
    @throw std::out_of_range when `idx >= size()`; example: `"array index 17
    is out of range"`
N
Niels 已提交
4687 4688 4689

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

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

4692 4693
    @sa @ref erase(IteratorType) -- removes the element at a given position
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4694
    the given range
N
Niels 已提交
4695
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4696 4697
    from an object at the given key

N
Niels 已提交
4698
    @since version 1.0.0
N
Niels 已提交
4699
    */
N
Niels 已提交
4700
    void erase(const size_type idx)
N
Niels 已提交
4701 4702
    {
        // this erase only works for arrays
N
cleanup  
Niels 已提交
4703
        if (is_array())
N
Niels 已提交
4704
        {
N
cleanup  
Niels 已提交
4705 4706
            if (idx >= size())
            {
4707
                JSON_THROW(out_of_range(401, "array index " + std::to_string(idx) + " is out of range"));
N
cleanup  
Niels 已提交
4708
            }
N
Niels 已提交
4709

N
cleanup  
Niels 已提交
4710 4711 4712
            m_value.array->erase(m_value.array->begin() + static_cast<difference_type>(idx));
        }
        else
N
Niels 已提交
4713
        {
4714
            JSON_THROW(type_error(307, "cannot use erase() with " + type_name()));
N
Niels 已提交
4715 4716 4717
        }
    }

N
Niels 已提交
4718 4719 4720 4721 4722 4723 4724 4725 4726 4727
    /// @}


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

    /// @name lookup
    /// @{

N
Niels 已提交
4728 4729 4730 4731
    /*!
    @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 已提交
4732 4733
    element is not found or the JSON value is not an object, end() is
    returned.
N
Niels 已提交
4734

4735 4736 4737
    @note This method always returns @ref end() when executed on a JSON type
          that is not an object.

N
Niels 已提交
4738 4739 4740
    @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
4741 4742
    element is found or the JSON value is not an object, past-the-end (see
    @ref end()) iterator is returned.
N
Niels 已提交
4743 4744 4745

    @complexity Logarithmic in the size of the JSON object.

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

N
Niels 已提交
4748
    @since version 1.0.0
N
Niels 已提交
4749
    */
N
Niels 已提交
4750
    iterator find(typename object_t::key_type key)
N
Niels 已提交
4751 4752 4753
    {
        auto result = end();

N
cleanup  
Niels 已提交
4754
        if (is_object())
N
Niels 已提交
4755 4756 4757 4758 4759 4760 4761
        {
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4762 4763 4764 4765
    /*!
    @brief find an element in a JSON object
    @copydoc find(typename object_t::key_type)
    */
N
Niels 已提交
4766
    const_iterator find(typename object_t::key_type key) const
N
Niels 已提交
4767 4768 4769
    {
        auto result = cend();

N
cleanup  
Niels 已提交
4770
        if (is_object())
N
Niels 已提交
4771 4772 4773 4774 4775 4776 4777
        {
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4778 4779 4780 4781 4782 4783 4784
    /*!
    @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).

4785 4786 4787
    @note This method always returns `0` when executed on a JSON type that is
          not an object.

N
Niels 已提交
4788 4789 4790 4791 4792 4793 4794
    @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 已提交
4795
    @liveexample{The example shows how `count()` is used.,count}
N
Niels 已提交
4796

N
Niels 已提交
4797
    @since version 1.0.0
N
Niels 已提交
4798
    */
N
Niels 已提交
4799
    size_type count(typename object_t::key_type key) const
4800 4801
    {
        // return 0 for all nonobject types
N
Niels 已提交
4802
        return is_object() ? m_value.object->count(key) : 0;
4803 4804
    }

N
Niels 已提交
4805 4806
    /// @}

N
Niels 已提交
4807

N
Niels 已提交
4808 4809 4810 4811
    ///////////////
    // iterators //
    ///////////////

N
Niels 已提交
4812 4813 4814
    /// @name iterators
    /// @{

N
Niels 已提交
4815 4816
    /*!
    @brief returns an iterator to the first element
N
Niels 已提交
4817 4818 4819 4820 4821 4822 4823 4824 4825

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

N
Niels 已提交
4831 4832 4833 4834 4835
    @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 已提交
4836

N
Niels 已提交
4837
    @since version 1.0.0
N
Niels 已提交
4838
    */
N
Niels 已提交
4839
    iterator begin() noexcept
N
Niels 已提交
4840 4841 4842 4843 4844 4845
    {
        iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4846
    /*!
N
Niels 已提交
4847
    @copydoc basic_json::cbegin()
N
Niels 已提交
4848
    */
N
Niels 已提交
4849
    const_iterator begin() const noexcept
N
Niels 已提交
4850
    {
N
Niels 已提交
4851
        return cbegin();
N
Niels 已提交
4852 4853
    }

N
Niels 已提交
4854 4855
    /*!
    @brief returns a const iterator to the first element
N
Niels 已提交
4856 4857 4858 4859 4860 4861 4862 4863 4864

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

N
Niels 已提交
4871 4872 4873 4874 4875
    @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 已提交
4876

N
Niels 已提交
4877
    @since version 1.0.0
N
Niels 已提交
4878
    */
N
Niels 已提交
4879
    const_iterator cbegin() const noexcept
N
Niels 已提交
4880 4881 4882 4883 4884 4885
    {
        const_iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4886 4887
    /*!
    @brief returns an iterator to one past the last element
N
Niels 已提交
4888 4889 4890 4891 4892 4893 4894 4895 4896

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

N
Niels 已提交
4902 4903 4904 4905 4906
    @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 已提交
4907

N
Niels 已提交
4908
    @since version 1.0.0
N
Niels 已提交
4909
    */
N
Niels 已提交
4910
    iterator end() noexcept
N
Niels 已提交
4911 4912 4913 4914 4915 4916
    {
        iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
4917
    /*!
N
Niels 已提交
4918
    @copydoc basic_json::cend()
N
Niels 已提交
4919
    */
N
Niels 已提交
4920
    const_iterator end() const noexcept
N
Niels 已提交
4921
    {
N
Niels 已提交
4922
        return cend();
N
Niels 已提交
4923 4924
    }

N
Niels 已提交
4925 4926
    /*!
    @brief returns a const iterator to one past the last element
N
Niels 已提交
4927 4928 4929 4930 4931 4932 4933 4934 4935

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

N
Niels 已提交
4942 4943 4944 4945 4946
    @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 已提交
4947

N
Niels 已提交
4948
    @since version 1.0.0
N
Niels 已提交
4949
    */
N
Niels 已提交
4950
    const_iterator cend() const noexcept
N
Niels 已提交
4951 4952 4953 4954 4955 4956
    {
        const_iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
4957
    /*!
N
Niels 已提交
4958 4959 4960 4961 4962 4963 4964 4965
    @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 已提交
4966 4967 4968
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4969 4970 4971
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(end())`.

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

N
Niels 已提交
4978
    @since version 1.0.0
N
Niels 已提交
4979
    */
N
Niels 已提交
4980
    reverse_iterator rbegin() noexcept
N
Niels 已提交
4981 4982 4983 4984
    {
        return reverse_iterator(end());
    }

N
Niels 已提交
4985
    /*!
N
Niels 已提交
4986
    @copydoc basic_json::crbegin()
N
Niels 已提交
4987
    */
N
Niels 已提交
4988
    const_reverse_iterator rbegin() const noexcept
N
Niels 已提交
4989
    {
N
Niels 已提交
4990
        return crbegin();
N
Niels 已提交
4991 4992
    }

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

N
Niels 已提交
5009 5010 5011 5012 5013
    @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 已提交
5014

N
Niels 已提交
5015
    @since version 1.0.0
N
Niels 已提交
5016
    */
N
Niels 已提交
5017
    reverse_iterator rend() noexcept
N
Niels 已提交
5018 5019 5020 5021
    {
        return reverse_iterator(begin());
    }

N
Niels 已提交
5022
    /*!
N
Niels 已提交
5023
    @copydoc basic_json::crend()
N
Niels 已提交
5024
    */
N
Niels 已提交
5025
    const_reverse_iterator rend() const noexcept
N
Niels 已提交
5026
    {
N
Niels 已提交
5027
        return crend();
N
Niels 已提交
5028 5029
    }

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

N
Niels 已提交
5046 5047 5048 5049 5050
    @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 已提交
5051

N
Niels 已提交
5052
    @since version 1.0.0
N
Niels 已提交
5053
    */
N
Niels 已提交
5054
    const_reverse_iterator crbegin() const noexcept
N
Niels 已提交
5055 5056 5057 5058
    {
        return const_reverse_iterator(cend());
    }

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

N
Niels 已提交
5075 5076 5077 5078 5079
    @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 已提交
5080

N
Niels 已提交
5081
    @since version 1.0.0
N
Niels 已提交
5082
    */
N
Niels 已提交
5083
    const_reverse_iterator crend() const noexcept
N
Niels 已提交
5084 5085 5086 5087
    {
        return const_reverse_iterator(cbegin());
    }

N
cleanup  
Niels 已提交
5088 5089 5090 5091 5092 5093 5094 5095
  private:
    // forward declaration
    template<typename IteratorType> class iteration_proxy;

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

N
Niels 已提交
5096
    This function allows to access @ref iterator::key() and @ref
N
Niels 已提交
5097 5098 5099
    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 已提交
5100 5101 5102

    @note The name of this function is not yet final and may change in the
    future.
N
cleanup  
Niels 已提交
5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116
    */
    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 已提交
5117 5118
    /// @}

N
Niels 已提交
5119 5120 5121 5122 5123

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

N
Niels 已提交
5124 5125 5126
    /// @name capacity
    /// @{

N
Niels 已提交
5127 5128
    /*!
    @brief checks whether the container is empty
N
Niels 已提交
5129 5130 5131

    Checks if a JSON value has no elements.

N
Niels 已提交
5132
    @return The return value depends on the different types and is
N
Niels 已提交
5133 5134 5135
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
5136 5137 5138 5139 5140 5141
            null        | `true`
            boolean     | `false`
            string      | `false`
            number      | `false`
            object      | result of function `object_t::empty()`
            array       | result of function `array_t::empty()`
N
Niels 已提交
5142

N
Niels 已提交
5143 5144 5145 5146
    @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 已提交
5147 5148
    @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 已提交
5149
    complexity.
N
Niels 已提交
5150

N
Niels 已提交
5151 5152 5153
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
5154 5155 5156
    - The complexity is constant.
    - Has the semantics of `begin() == end()`.

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

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

N
Niels 已提交
5162
    @since version 1.0.0
N
Niels 已提交
5163
    */
N
Niels 已提交
5164
    bool empty() const noexcept
N
Niels 已提交
5165 5166 5167
    {
        switch (m_type)
        {
5168
            case value_t::null:
N
Niels 已提交
5169
            {
N
Niels 已提交
5170
                // null values are empty
N
Niels 已提交
5171 5172
                return true;
            }
N
Niels 已提交
5173

5174
            case value_t::array:
N
Niels 已提交
5175
            {
N
Niels 已提交
5176
                // delegate call to array_t::empty()
N
Niels 已提交
5177 5178
                return m_value.array->empty();
            }
N
Niels 已提交
5179

5180
            case value_t::object:
N
Niels 已提交
5181
            {
N
Niels 已提交
5182
                // delegate call to object_t::empty()
N
Niels 已提交
5183 5184
                return m_value.object->empty();
            }
N
Niels 已提交
5185

N
Niels 已提交
5186 5187 5188 5189 5190 5191
            default:
            {
                // all other types are nonempty
                return false;
            }
        }
N
Niels 已提交
5192 5193
    }

N
Niels 已提交
5194 5195
    /*!
    @brief returns the number of elements
N
Niels 已提交
5196 5197 5198

    Returns the number of elements in a JSON value.

N
Niels 已提交
5199
    @return The return value depends on the different types and is
N
Niels 已提交
5200 5201 5202
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
5203 5204 5205 5206
            null        | `0`
            boolean     | `1`
            string      | `1`
            number      | `1`
N
Niels 已提交
5207 5208 5209
            object      | result of function object_t::size()
            array       | result of function array_t::size()

N
Niels 已提交
5210 5211 5212 5213
    @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 已提交
5214 5215 5216
    @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 已提交
5217

N
Niels 已提交
5218 5219 5220
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
5221 5222 5223
    - The complexity is constant.
    - Has the semantics of `std::distance(begin(), end())`.

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

N
Niels 已提交
5227 5228 5229
    @sa @ref empty() -- checks whether the container is empty
    @sa @ref max_size() -- returns the maximal number of elements

N
Niels 已提交
5230
    @since version 1.0.0
N
Niels 已提交
5231
    */
N
Niels 已提交
5232
    size_type size() const noexcept
N
Niels 已提交
5233 5234 5235
    {
        switch (m_type)
        {
5236
            case value_t::null:
N
Niels 已提交
5237
            {
N
Niels 已提交
5238
                // null values are empty
N
Niels 已提交
5239 5240
                return 0;
            }
N
Niels 已提交
5241

5242
            case value_t::array:
N
Niels 已提交
5243
            {
N
Niels 已提交
5244
                // delegate call to array_t::size()
N
Niels 已提交
5245 5246
                return m_value.array->size();
            }
N
Niels 已提交
5247

5248
            case value_t::object:
N
Niels 已提交
5249
            {
N
Niels 已提交
5250
                // delegate call to object_t::size()
N
Niels 已提交
5251 5252
                return m_value.object->size();
            }
N
Niels 已提交
5253

N
Niels 已提交
5254 5255 5256 5257 5258 5259
            default:
            {
                // all other types have size 1
                return 1;
            }
        }
N
Niels 已提交
5260 5261
    }

N
Niels 已提交
5262 5263
    /*!
    @brief returns the maximum possible number of elements
N
Niels 已提交
5264 5265 5266 5267 5268

    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 已提交
5269
    @return The return value depends on the different types and is
N
Niels 已提交
5270 5271 5272
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
5273 5274 5275 5276 5277 5278
            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 已提交
5279

N
Niels 已提交
5280 5281
    @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 已提交
5282
    complexity.
N
Niels 已提交
5283

N
Niels 已提交
5284 5285 5286
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
5287 5288 5289 5290
    - The complexity is constant.
    - Has the semantics of returning `b.size()` where `b` is the largest
      possible JSON value.

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

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

N
Niels 已提交
5296
    @since version 1.0.0
N
Niels 已提交
5297
    */
N
Niels 已提交
5298
    size_type max_size() const noexcept
N
Niels 已提交
5299 5300 5301
    {
        switch (m_type)
        {
5302
            case value_t::array:
N
Niels 已提交
5303
            {
N
Niels 已提交
5304
                // delegate call to array_t::max_size()
N
Niels 已提交
5305 5306
                return m_value.array->max_size();
            }
N
Niels 已提交
5307

5308
            case value_t::object:
N
Niels 已提交
5309
            {
N
Niels 已提交
5310
                // delegate call to object_t::max_size()
N
Niels 已提交
5311 5312
                return m_value.object->max_size();
            }
N
Niels 已提交
5313

N
Niels 已提交
5314 5315
            default:
            {
5316 5317
                // all other types have max_size() == size()
                return size();
N
Niels 已提交
5318 5319
            }
        }
N
Niels 已提交
5320 5321
    }

N
Niels 已提交
5322 5323
    /// @}

N
Niels 已提交
5324 5325 5326 5327 5328

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

N
Niels 已提交
5329 5330 5331
    /// @name modifiers
    /// @{

N
Niels 已提交
5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348
    /*!
    @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 已提交
5349
    @liveexample{The example below shows the effect of `clear()` to different
N
Niels 已提交
5350
    JSON types.,clear}
N
Niels 已提交
5351

N
Niels 已提交
5352
    @since version 1.0.0
N
Niels 已提交
5353
    */
N
Niels 已提交
5354
    void clear() noexcept
N
Niels 已提交
5355 5356 5357
    {
        switch (m_type)
        {
5358
            case value_t::number_integer:
N
Niels 已提交
5359
            {
N
Niels 已提交
5360
                m_value.number_integer = 0;
N
Niels 已提交
5361 5362
                break;
            }
N
Niels 已提交
5363

5364 5365 5366 5367 5368 5369
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = 0;
                break;
            }

5370
            case value_t::number_float:
N
Niels 已提交
5371
            {
N
Niels 已提交
5372
                m_value.number_float = 0.0;
N
Niels 已提交
5373 5374
                break;
            }
N
Niels 已提交
5375

5376
            case value_t::boolean:
N
Niels 已提交
5377
            {
N
Niels 已提交
5378
                m_value.boolean = false;
N
Niels 已提交
5379 5380
                break;
            }
N
Niels 已提交
5381

5382
            case value_t::string:
N
Niels 已提交
5383 5384 5385 5386
            {
                m_value.string->clear();
                break;
            }
N
Niels 已提交
5387

5388
            case value_t::array:
N
Niels 已提交
5389 5390 5391 5392
            {
                m_value.array->clear();
                break;
            }
N
Niels 已提交
5393

5394
            case value_t::object:
N
Niels 已提交
5395 5396 5397 5398
            {
                m_value.object->clear();
                break;
            }
5399 5400 5401 5402 5403

            default:
            {
                break;
            }
N
Niels 已提交
5404 5405 5406
        }
    }

5407 5408 5409
    /*!
    @brief add an object to an array

5410
    Appends the given element @a val to the end of the JSON value. If the
5411
    function is called on a JSON null value, an empty array is created before
5412
    appending @a val.
5413

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

5416
    @throw type_error.308 when called on a type other than JSON array or
N
Niels 已提交
5417
    null; example: `"cannot use push_back() with number"`
5418 5419 5420

    @complexity Amortized constant.

N
Niels 已提交
5421 5422 5423
    @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 已提交
5424

N
Niels 已提交
5425
    @since version 1.0.0
5426
    */
5427
    void push_back(basic_json&& val)
N
Niels 已提交
5428 5429
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
5430
        if (not(is_null() or is_array()))
N
Niels 已提交
5431
        {
5432
            JSON_THROW(type_error(308, "cannot use push_back() with " + type_name()));
N
Niels 已提交
5433 5434 5435
        }

        // transform null object into an array
N
cleanup  
Niels 已提交
5436
        if (is_null())
N
Niels 已提交
5437 5438
        {
            m_type = value_t::array;
N
Niels 已提交
5439
            m_value = value_t::array;
5440
            assert_invariant();
N
Niels 已提交
5441 5442 5443
        }

        // add element to array (move semantics)
5444
        m_value.array->push_back(std::move(val));
N
Niels 已提交
5445
        // invalidate object
5446
        val.m_type = value_t::null;
N
Niels 已提交
5447 5448
    }

5449 5450 5451 5452
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5453
    reference operator+=(basic_json&& val)
N
Niels 已提交
5454
    {
5455
        push_back(std::move(val));
N
Niels 已提交
5456 5457 5458
        return *this;
    }

5459 5460 5461 5462
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5463
    void push_back(const basic_json& val)
N
Niels 已提交
5464 5465
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
5466
        if (not(is_null() or is_array()))
N
Niels 已提交
5467
        {
5468
            JSON_THROW(type_error(308, "cannot use push_back() with " + type_name()));
N
Niels 已提交
5469 5470 5471
        }

        // transform null object into an array
N
cleanup  
Niels 已提交
5472
        if (is_null())
N
Niels 已提交
5473 5474
        {
            m_type = value_t::array;
N
Niels 已提交
5475
            m_value = value_t::array;
5476
            assert_invariant();
N
Niels 已提交
5477 5478 5479
        }

        // add element to array
5480
        m_value.array->push_back(val);
N
Niels 已提交
5481 5482
    }

5483 5484 5485 5486
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5487
    reference operator+=(const basic_json& val)
N
Niels 已提交
5488
    {
5489
        push_back(val);
N
Niels 已提交
5490 5491 5492
        return *this;
    }

5493 5494 5495
    /*!
    @brief add an object to an object

5496
    Inserts the given element @a val to the JSON object. If the function is
N
Niels 已提交
5497 5498
    called on a JSON null value, an empty object is created before inserting
    @a val.
5499

5500
    @param[in] val the value to add to the JSON object
5501

5502
    @throw type_error.308 when called on a type other than JSON object or
N
Niels 已提交
5503
    null; example: `"cannot use push_back() with number"`
5504 5505 5506

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

N
Niels 已提交
5507 5508 5509
    @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 已提交
5510

N
Niels 已提交
5511
    @since version 1.0.0
5512
    */
5513
    void push_back(const typename object_t::value_type& val)
N
Niels 已提交
5514 5515
    {
        // push_back only works for null objects or objects
N
cleanup  
Niels 已提交
5516
        if (not(is_null() or is_object()))
N
Niels 已提交
5517
        {
5518
            JSON_THROW(type_error(308, "cannot use push_back() with " + type_name()));
N
Niels 已提交
5519 5520 5521
        }

        // transform null object into an object
N
cleanup  
Niels 已提交
5522
        if (is_null())
N
Niels 已提交
5523 5524
        {
            m_type = value_t::object;
N
Niels 已提交
5525
            m_value = value_t::object;
5526
            assert_invariant();
N
Niels 已提交
5527 5528 5529
        }

        // add element to array
5530
        m_value.object->insert(val);
N
Niels 已提交
5531 5532
    }

5533 5534 5535 5536
    /*!
    @brief add an object to an object
    @copydoc push_back(const typename object_t::value_type&)
    */
5537
    reference operator+=(const typename object_t::value_type& val)
N
Niels 已提交
5538
    {
5539
        push_back(val);
N
Niels 已提交
5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588
        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 已提交
5589 5590
    }

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

5601
    @throw type_error.311 when called on a type other than JSON array or
N
Niels 已提交
5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617
    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()))
        {
5618
            JSON_THROW(type_error(311, "cannot use emplace_back() with " + type_name()));
N
Niels 已提交
5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633
        }

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

    /*!
5634
    @brief add an object to an object if key does not exist
N
Niels 已提交
5635

N
Niels Lohmann 已提交
5636 5637
    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
5638 5639
    function is called on a JSON null value, an empty object is created before
    appending the value created from @a args.
N
Niels 已提交
5640 5641 5642 5643

    @param[in] args arguments to forward to a constructor of @ref basic_json
    @tparam Args compatible types to create a @ref basic_json object

5644 5645 5646 5647
    @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.

5648
    @throw type_error.311 when called on a type other than JSON object or
N
Niels 已提交
5649 5650 5651 5652 5653 5654
    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
5655 5656
    JSON object. Further note how no value is added if there was already one
    value stored with the same key.,emplace}
N
Niels 已提交
5657 5658 5659 5660

    @since version 2.0.8
    */
    template<class... Args>
5661
    std::pair<iterator, bool> emplace(Args&& ... args)
N
Niels 已提交
5662 5663 5664 5665
    {
        // emplace only works for null objects or arrays
        if (not(is_null() or is_object()))
        {
5666
            JSON_THROW(type_error(311, "cannot use emplace() with " + type_name()));
N
Niels 已提交
5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677
        }

        // 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)
5678 5679 5680 5681 5682 5683 5684
        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 已提交
5685 5686
    }

N
Niels 已提交
5687 5688 5689
    /*!
    @brief inserts element

5690
    Inserts element @a val before iterator @a pos.
N
Niels 已提交
5691 5692 5693

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

5697
    @throw type_error.309 if called on JSON values other than arrays;
N
Niels 已提交
5698
    example: `"cannot use insert() with string"`
5699 5700
    @throw invalid_iterator.202 if @a pos is not an iterator of *this;
    example: `"iterator does not fit current value"`
N
Niels 已提交
5701

N
Niels Lohmann 已提交
5702
    @complexity Constant plus linear in the distance between @a pos and end of
N
Niels Lohmann 已提交
5703
    the container.
N
Niels 已提交
5704

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

N
Niels 已提交
5707
    @since version 1.0.0
N
Niels 已提交
5708
    */
5709
    iterator insert(const_iterator pos, const basic_json& val)
N
Niels 已提交
5710 5711
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5712
        if (is_array())
N
Niels 已提交
5713
        {
N
cleanup  
Niels 已提交
5714 5715 5716
            // check if iterator pos fits to this JSON value
            if (pos.m_object != this)
            {
5717
                JSON_THROW(invalid_iterator(202, "iterator does not fit current value"));
N
cleanup  
Niels 已提交
5718
            }
N
Niels 已提交
5719

N
cleanup  
Niels 已提交
5720 5721
            // insert to array and return iterator
            iterator result(this);
5722
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, val);
N
cleanup  
Niels 已提交
5723 5724
            return result;
        }
N
Niels Lohmann 已提交
5725

5726
        JSON_THROW(type_error(309, "cannot use insert() with " + type_name()));
N
Niels 已提交
5727 5728 5729 5730 5731 5732
    }

    /*!
    @brief inserts element
    @copydoc insert(const_iterator, const basic_json&)
    */
5733
    iterator insert(const_iterator pos, basic_json&& val)
N
Niels 已提交
5734
    {
5735
        return insert(pos, val);
N
Niels 已提交
5736 5737 5738 5739 5740
    }

    /*!
    @brief inserts elements

5741
    Inserts @a cnt copies of @a val before iterator @a pos.
N
Niels 已提交
5742 5743 5744

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

5750 5751
    @throw type_error.309 if called on JSON values other than arrays; example:
    `"cannot use insert() with string"`
5752 5753
    @throw invalid_iterator.202 if @a pos is not an iterator of *this;
    example: `"iterator does not fit current value"`
N
Niels 已提交
5754

5755
    @complexity Linear in @a cnt plus linear in the distance between @a pos
N
Niels 已提交
5756 5757
    and end of the container.

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

N
Niels 已提交
5760
    @since version 1.0.0
N
Niels 已提交
5761
    */
5762
    iterator insert(const_iterator pos, size_type cnt, const basic_json& val)
N
Niels 已提交
5763 5764
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5765
        if (is_array())
N
Niels 已提交
5766
        {
N
cleanup  
Niels 已提交
5767 5768 5769
            // check if iterator pos fits to this JSON value
            if (pos.m_object != this)
            {
5770
                JSON_THROW(invalid_iterator(202, "iterator does not fit current value"));
N
cleanup  
Niels 已提交
5771
            }
N
Niels 已提交
5772

N
cleanup  
Niels 已提交
5773 5774
            // insert to array and return iterator
            iterator result(this);
5775
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, cnt, val);
N
cleanup  
Niels 已提交
5776 5777
            return result;
        }
N
Niels Lohmann 已提交
5778

5779
        JSON_THROW(type_error(309, "cannot use insert() with " + type_name()));
N
Niels 已提交
5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791
    }

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

5792 5793
    @throw type_error.309 if called on JSON values other than arrays; example:
    `"cannot use insert() with string"`
5794 5795
    @throw invalid_iterator.202 if @a pos is not an iterator of *this;
    example: `"iterator does not fit current value"`
5796 5797 5798
    @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 已提交
5799 5800 5801
    container for which insert is called; example: `"passed iterators may not
    belong to container"`

N
Niels 已提交
5802 5803 5804 5805 5806 5807
    @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 已提交
5808
    @liveexample{The example shows how `insert()` is used.,insert__range}
N
Niels 已提交
5809

N
Niels 已提交
5810
    @since version 1.0.0
N
Niels 已提交
5811 5812 5813 5814
    */
    iterator insert(const_iterator pos, const_iterator first, const_iterator last)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5815
        if (not is_array())
N
Niels 已提交
5816
        {
5817
            JSON_THROW(type_error(309, "cannot use insert() with " + type_name()));
N
Niels 已提交
5818 5819 5820 5821 5822
        }

        // check if iterator pos fits to this JSON value
        if (pos.m_object != this)
        {
5823
            JSON_THROW(invalid_iterator(202, "iterator does not fit current value"));
N
Niels 已提交
5824 5825
        }

N
Niels 已提交
5826
        // check if range iterators belong to the same JSON object
N
Niels 已提交
5827 5828
        if (first.m_object != last.m_object)
        {
5829
            JSON_THROW(invalid_iterator(210, "iterators do not fit"));
N
Niels 已提交
5830 5831 5832 5833
        }

        if (first.m_object == this or last.m_object == this)
        {
5834
            JSON_THROW(invalid_iterator(211, "passed iterators may not belong to container"));
N
Niels 已提交
5835 5836 5837 5838
        }

        // insert to array and return iterator
        iterator result(this);
N
Niels 已提交
5839
        result.m_it.array_iterator = m_value.array->insert(
T
Théo DELRIEU 已提交
5840 5841 5842
                                         pos.m_it.array_iterator,
                                         first.m_it.array_iterator,
                                         last.m_it.array_iterator);
N
Niels 已提交
5843 5844 5845
        return result;
    }

N
Niels 已提交
5846 5847 5848 5849 5850 5851 5852 5853 5854
    /*!
    @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

5855 5856
    @throw type_error.309 if called on JSON values other than arrays; example:
    `"cannot use insert() with string"`
5857 5858
    @throw invalid_iterator.202 if @a pos is not an iterator of *this;
    example: `"iterator does not fit current value"`
N
Niels 已提交
5859

N
Niels 已提交
5860 5861 5862
    @return iterator pointing to the first element inserted, or @a pos if
    `ilist` is empty

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

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

N
Niels 已提交
5868
    @since version 1.0.0
N
Niels 已提交
5869 5870 5871 5872
    */
    iterator insert(const_iterator pos, std::initializer_list<basic_json> ilist)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5873
        if (not is_array())
N
Niels 已提交
5874
        {
5875
            JSON_THROW(type_error(309, "cannot use insert() with " + type_name()));
N
Niels 已提交
5876 5877 5878 5879 5880
        }

        // check if iterator pos fits to this JSON value
        if (pos.m_object != this)
        {
5881
            JSON_THROW(invalid_iterator(202, "iterator does not fit current value"));
N
Niels 已提交
5882 5883 5884 5885 5886 5887 5888 5889
        }

        // 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 已提交
5890 5891
    /*!
    @brief exchanges the values
N
Niels 已提交
5892 5893 5894 5895 5896 5897 5898 5899 5900 5901

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

N
Niels 已提交
5905
    @since version 1.0.0
N
Niels 已提交
5906
    */
N
Niels 已提交
5907
    void swap(reference other) noexcept (
N
Niels 已提交
5908 5909 5910 5911
        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 已提交
5912
    )
N
Niels 已提交
5913 5914 5915
    {
        std::swap(m_type, other.m_type);
        std::swap(m_value, other.m_value);
5916
        assert_invariant();
N
Niels 已提交
5917 5918
    }

N
Niels 已提交
5919 5920 5921 5922 5923 5924 5925 5926 5927 5928
    /*!
    @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

5929 5930
    @throw type_error.310 when JSON value is not an array; example: `"cannot
    use swap() with string"`
N
Niels 已提交
5931 5932 5933

    @complexity Constant.

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

N
Niels 已提交
5937
    @since version 1.0.0
N
Niels 已提交
5938
    */
N
Niels 已提交
5939
    void swap(array_t& other)
N
Niels 已提交
5940 5941
    {
        // swap only works for arrays
N
cleanup  
Niels 已提交
5942 5943 5944 5945 5946
        if (is_array())
        {
            std::swap(*(m_value.array), other);
        }
        else
N
Niels 已提交
5947
        {
5948
            JSON_THROW(type_error(310, "cannot use swap() with " + type_name()));
N
Niels 已提交
5949 5950 5951
        }
    }

5952 5953 5954 5955 5956 5957 5958 5959 5960 5961
    /*!
    @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

5962
    @throw type_error.310 when JSON value is not an object; example:
N
Niels 已提交
5963
    `"cannot use swap() with string"`
5964 5965 5966

    @complexity Constant.

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

N
Niels 已提交
5970
    @since version 1.0.0
5971
    */
N
Niels 已提交
5972
    void swap(object_t& other)
N
Niels 已提交
5973 5974
    {
        // swap only works for objects
N
cleanup  
Niels 已提交
5975 5976 5977 5978 5979
        if (is_object())
        {
            std::swap(*(m_value.object), other);
        }
        else
N
Niels 已提交
5980
        {
5981
            JSON_THROW(type_error(310, "cannot use swap() with " + type_name()));
N
Niels 已提交
5982 5983 5984
        }
    }

5985 5986 5987 5988 5989 5990 5991 5992 5993 5994
    /*!
    @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

5995
    @throw type_error.310 when JSON value is not a string; example: `"cannot
N
Niels 已提交
5996
    use swap() with boolean"`
5997 5998 5999

    @complexity Constant.

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

N
Niels 已提交
6003
    @since version 1.0.0
6004
    */
N
Niels 已提交
6005
    void swap(string_t& other)
N
Niels 已提交
6006 6007
    {
        // swap only works for strings
N
cleanup  
Niels 已提交
6008 6009 6010 6011 6012
        if (is_string())
        {
            std::swap(*(m_value.string), other);
        }
        else
N
Niels 已提交
6013
        {
6014
            JSON_THROW(type_error(310, "cannot use swap() with " + type_name()));
N
Niels 已提交
6015 6016 6017
        }
    }

N
Niels 已提交
6018 6019
    /// @}

N
Niels 已提交
6020
  public:
6021 6022 6023 6024 6025 6026 6027
    //////////////////////////////////////////
    // lexicographical comparison operators //
    //////////////////////////////////////////

    /// @name lexicographical comparison operators
    /// @{

N
Niels 已提交
6028 6029
    /*!
    @brief comparison: equal
N
Niels 已提交
6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045

    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.

6046 6047
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__equal}
N
Niels 已提交
6048

N
Niels 已提交
6049
    @since version 1.0.0
N
Niels 已提交
6050
    */
N
Niels 已提交
6051
    friend bool operator==(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6052
    {
F
Florian Weber 已提交
6053 6054
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
6055

F
Florian Weber 已提交
6056
        if (lhs_type == rhs_type)
N
Niels 已提交
6057
        {
F
Florian Weber 已提交
6058
            switch (lhs_type)
N
Niels 已提交
6059
            {
6060
                case value_t::array:
N
Niels 已提交
6061
                {
N
Niels 已提交
6062
                    return *lhs.m_value.array == *rhs.m_value.array;
N
Niels 已提交
6063
                }
6064
                case value_t::object:
N
Niels 已提交
6065
                {
N
Niels 已提交
6066
                    return *lhs.m_value.object == *rhs.m_value.object;
N
Niels 已提交
6067
                }
6068
                case value_t::null:
N
Niels 已提交
6069
                {
N
Niels 已提交
6070
                    return true;
N
Niels 已提交
6071
                }
6072
                case value_t::string:
N
Niels 已提交
6073
                {
N
Niels 已提交
6074
                    return *lhs.m_value.string == *rhs.m_value.string;
N
Niels 已提交
6075
                }
6076
                case value_t::boolean:
N
Niels 已提交
6077
                {
N
Niels 已提交
6078
                    return lhs.m_value.boolean == rhs.m_value.boolean;
N
Niels 已提交
6079
                }
6080
                case value_t::number_integer:
N
Niels 已提交
6081
                {
N
Niels 已提交
6082
                    return lhs.m_value.number_integer == rhs.m_value.number_integer;
N
Niels 已提交
6083
                }
6084 6085 6086 6087
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned == rhs.m_value.number_unsigned;
                }
6088
                case value_t::number_float:
N
Niels 已提交
6089
                {
6090
                    return lhs.m_value.number_float == rhs.m_value.number_float;
N
Niels 已提交
6091
                }
6092
                default:
N
Niels 已提交
6093
                {
N
Niels 已提交
6094
                    return false;
N
Niels 已提交
6095
                }
N
Niels 已提交
6096 6097
            }
        }
F
Florian Weber 已提交
6098 6099
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
N
Niels 已提交
6100
            return static_cast<number_float_t>(lhs.m_value.number_integer) == rhs.m_value.number_float;
F
Florian Weber 已提交
6101 6102 6103
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
6104
            return lhs.m_value.number_float == static_cast<number_float_t>(rhs.m_value.number_integer);
F
Florian Weber 已提交
6105
        }
6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120
        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 已提交
6121
        }
6122

N
Niels 已提交
6123 6124 6125
        return false;
    }

N
Niels 已提交
6126 6127
    /*!
    @brief comparison: equal
M
Mihai STAN 已提交
6128
    @copydoc operator==(const_reference, const_reference)
N
Niels 已提交
6129
    */
M
Mihai STAN 已提交
6130
    template<typename ScalarType, typename std::enable_if<
6131 6132
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator==(const_reference lhs, const ScalarType rhs) noexcept
N
Niels 已提交
6133
    {
M
Mihai STAN 已提交
6134
        return (lhs == basic_json(rhs));
N
Niels 已提交
6135 6136 6137 6138
    }

    /*!
    @brief comparison: equal
M
Mihai STAN 已提交
6139
    @copydoc operator==(const_reference, const_reference)
N
Niels 已提交
6140
    */
M
Mihai STAN 已提交
6141
    template<typename ScalarType, typename std::enable_if<
6142 6143
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator==(const ScalarType lhs, const_reference rhs) noexcept
N
Niels 已提交
6144
    {
M
Mihai STAN 已提交
6145
        return (basic_json(lhs) == rhs);
N
Niels 已提交
6146 6147
    }

N
Niels 已提交
6148 6149
    /*!
    @brief comparison: not equal
N
Niels 已提交
6150 6151 6152 6153 6154 6155 6156 6157 6158

    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.

6159 6160
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__notequal}
N
Niels 已提交
6161

N
Niels 已提交
6162
    @since version 1.0.0
N
Niels 已提交
6163
    */
N
Niels 已提交
6164
    friend bool operator!=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6165 6166 6167 6168
    {
        return not (lhs == rhs);
    }

N
Niels 已提交
6169 6170
    /*!
    @brief comparison: not equal
M
Mihai STAN 已提交
6171
    @copydoc operator!=(const_reference, const_reference)
N
Niels 已提交
6172
    */
M
Mihai STAN 已提交
6173 6174 6175
    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 已提交
6176
    {
M
Mihai STAN 已提交
6177
        return (lhs != basic_json(rhs));
N
Niels 已提交
6178 6179 6180 6181
    }

    /*!
    @brief comparison: not equal
M
Mihai STAN 已提交
6182
    @copydoc operator!=(const_reference, const_reference)
N
Niels 已提交
6183
    */
M
Mihai STAN 已提交
6184 6185 6186
    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 已提交
6187
    {
M
Mihai STAN 已提交
6188
        return (basic_json(lhs) != rhs);
N
Niels 已提交
6189 6190
    }

N
Niels 已提交
6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209
    /*!
    @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.

6210 6211
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__less}
N
Niels 已提交
6212

N
Niels 已提交
6213
    @since version 1.0.0
N
Niels 已提交
6214
    */
N
Niels 已提交
6215
    friend bool operator<(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6216
    {
F
Florian Weber 已提交
6217 6218
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
6219

F
Florian Weber 已提交
6220
        if (lhs_type == rhs_type)
N
Niels 已提交
6221
        {
F
Florian Weber 已提交
6222
            switch (lhs_type)
N
Niels 已提交
6223
            {
6224
                case value_t::array:
N
Niels 已提交
6225
                {
N
Niels 已提交
6226
                    return *lhs.m_value.array < *rhs.m_value.array;
N
Niels 已提交
6227
                }
6228
                case value_t::object:
N
Niels 已提交
6229
                {
N
Niels 已提交
6230
                    return *lhs.m_value.object < *rhs.m_value.object;
N
Niels 已提交
6231
                }
6232
                case value_t::null:
N
Niels 已提交
6233
                {
N
Niels 已提交
6234
                    return false;
N
Niels 已提交
6235
                }
6236
                case value_t::string:
N
Niels 已提交
6237
                {
N
Niels 已提交
6238
                    return *lhs.m_value.string < *rhs.m_value.string;
N
Niels 已提交
6239
                }
6240
                case value_t::boolean:
N
Niels 已提交
6241
                {
N
Niels 已提交
6242
                    return lhs.m_value.boolean < rhs.m_value.boolean;
N
Niels 已提交
6243
                }
6244
                case value_t::number_integer:
N
Niels 已提交
6245
                {
N
Niels 已提交
6246
                    return lhs.m_value.number_integer < rhs.m_value.number_integer;
N
Niels 已提交
6247
                }
6248 6249 6250 6251
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned < rhs.m_value.number_unsigned;
                }
6252
                case value_t::number_float:
N
Niels 已提交
6253
                {
N
Niels 已提交
6254
                    return lhs.m_value.number_float < rhs.m_value.number_float;
N
Niels 已提交
6255
                }
6256
                default:
N
Niels 已提交
6257
                {
N
Niels 已提交
6258
                    return false;
N
Niels 已提交
6259
                }
N
Niels 已提交
6260 6261
            }
        }
F
Florian Weber 已提交
6262 6263
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
6264
            return static_cast<number_float_t>(lhs.m_value.number_integer) < rhs.m_value.number_float;
F
Florian Weber 已提交
6265 6266 6267
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284
            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 已提交
6285
        }
N
Niels 已提交
6286

N
Niels 已提交
6287
        // We only reach this line if we cannot compare values. In that case,
N
Niels 已提交
6288 6289 6290
        // we compare types. Note we have to call the operator explicitly,
        // because MSVC has problems otherwise.
        return operator<(lhs_type, rhs_type);
N
Niels 已提交
6291 6292
    }

N
Niels 已提交
6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304
    /*!
    @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.

6305 6306
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greater}
N
Niels 已提交
6307

N
Niels 已提交
6308
    @since version 1.0.0
N
Niels 已提交
6309
    */
N
Niels 已提交
6310
    friend bool operator<=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6311 6312 6313 6314
    {
        return not (rhs < lhs);
    }

N
Niels 已提交
6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326
    /*!
    @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.

6327 6328
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__lessequal}
N
Niels 已提交
6329

N
Niels 已提交
6330
    @since version 1.0.0
N
Niels 已提交
6331
    */
N
Niels 已提交
6332
    friend bool operator>(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6333 6334 6335 6336
    {
        return not (lhs <= rhs);
    }

N
Niels 已提交
6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348
    /*!
    @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.

6349 6350
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greaterequal}
N
Niels 已提交
6351

N
Niels 已提交
6352
    @since version 1.0.0
N
Niels 已提交
6353
    */
N
Niels 已提交
6354
    friend bool operator>=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6355 6356 6357 6358
    {
        return not (lhs < rhs);
    }

N
Niels 已提交
6359 6360
    /// @}

N
Niels 已提交
6361 6362 6363 6364 6365

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

N
Niels 已提交
6366 6367 6368
    /// @name serialization
    /// @{

6369
  private:
6370 6371 6372
    /*!
    @brief wrapper around the serialization functions
    */
6373 6374 6375
    class serializer
    {
      public:
N
Niels Lohmann 已提交
6376 6377 6378
        /*!
        @param[in] s  output stream to serialize to
        */
6379
        serializer(std::ostream& s)
6380 6381 6382
            : 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])
6383 6384 6385 6386 6387
        {}

        /*!
        @brief internal implementation of the serialization function

N
Niels Lohmann 已提交
6388 6389 6390 6391
        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.
6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404

        - 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,
6405
                  const unsigned int current_indent = 0)
6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422
        {
            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;
6423 6424 6425 6426
                        if (indent_string.size() < new_indent)
                        {
                            indent_string.resize(new_indent, ' ');
                        }
6427 6428 6429 6430 6431 6432 6433

                        // 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('\"');
6434
                            dump_escaped(i->first);
6435 6436 6437 6438 6439 6440 6441 6442 6443
                            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('\"');
6444
                        dump_escaped(i->first);
6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460
                        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('\"');
6461
                            dump_escaped(i->first);
6462 6463 6464 6465 6466 6467 6468 6469
                            o.write("\":", 2);
                            dump(i->second, false, indent_step, current_indent);
                            o.put(',');
                        }

                        // last element
                        assert(i != val.m_value.object->cend());
                        o.put('\"');
6470
                        dump_escaped(i->first);
6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493
                        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;
6494 6495 6496 6497
                        if (indent_string.size() < new_indent)
                        {
                            indent_string.resize(new_indent, ' ');
                        }
6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539

                        // 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('\"');
6540
                    dump_escaped(*val.m_value.string);
6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559
                    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:
                {
6560
                    dump_integer(val.m_value.number_integer);
6561 6562 6563 6564 6565
                    return;
                }

                case value_t::number_unsigned:
                {
6566
                    dump_integer(val.m_value.number_unsigned);
6567 6568 6569 6570 6571
                    return;
                }

                case value_t::number_float:
                {
6572
                    dump_float(val.m_value.number_float);
6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617
                    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;
                    }

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
                    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:
6645
                    {
6646 6647 6648
                        // from c (1 byte) to \uxxxx (6 bytes)
                        return res + 5;
                    }
6649

6650 6651
                    default:
                    {
6652 6653 6654 6655 6656 6657 6658
                        return res;
                    }
                }
            });
        }

        /*!
N
Niels Lohmann 已提交
6659
        @brief dump escaped string
6660

N
Niels Lohmann 已提交
6661 6662 6663 6664
        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.
6665 6666 6667 6668 6669

        @param[in] s  the string to escape

        @complexity Linear in the length of string @a s.
        */
6670
        void dump_escaped(const string_t& s) const
6671 6672 6673 6674
        {
            const auto space = extra_space(s);
            if (space == 0)
            {
6675 6676
                o.write(s.c_str(), static_cast<std::streamsize>(s.size()));
                return;
6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742
            }

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

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
                    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:
6770
                    {
6771 6772 6773
                        // convert a number 0..15 to its hex representation
                        // (0..f)
                        static const char hexify[16] =
6774
                        {
6775 6776 6777 6778 6779 6780 6781 6782
                            '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]
                        })
6783
                        {
6784
                            result[++pos] = m;
6785
                        }
6786 6787 6788 6789 6790 6791 6792 6793 6794

                        ++pos;
                        break;
                    }

                    default:
                    {
                        // all other characters are added as-is
                        result[pos++] = c;
6795 6796 6797 6798 6799
                        break;
                    }
                }
            }

6800 6801
            assert(pos == s.size() + space);
            o.write(result.c_str(), static_cast<std::streamsize>(result.size()));
6802 6803
        }

N
Niels Lohmann 已提交
6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815
        /*!
        @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>
6816
        void dump_integer(NumberType x)
6817
        {
6818 6819
            // special case for "0"
            if (x == 0)
6820
            {
6821 6822
                o.put('0');
                return;
6823 6824
            }

6825 6826 6827 6828
            const bool is_negative = x < 0;
            size_t i = 0;

            // spare 1 byte for '\0'
N
Niels Lohmann 已提交
6829
            while (x != 0 and i < number_buffer.size() - 1)
6830
            {
6831
                const auto digit = std::labs(static_cast<long>(x % 10));
N
Niels Lohmann 已提交
6832
                number_buffer[i++] = static_cast<char>('0' + digit);
6833
                x /= 10;
6834 6835
            }

6836 6837
            // make sure the number has been processed completely
            assert(x == 0);
6838

6839
            if (is_negative)
6840
            {
6841
                // make sure there is capacity for the '-'
N
Niels Lohmann 已提交
6842 6843
                assert(i < number_buffer.size() - 2);
                number_buffer[i++] = '-';
6844
            }
6845

N
Niels Lohmann 已提交
6846 6847
            std::reverse(number_buffer.begin(), number_buffer.begin() + i);
            o.write(number_buffer.data(), static_cast<std::streamsize>(i));
6848
        }
6849

N
Niels Lohmann 已提交
6850 6851 6852 6853 6854 6855 6856 6857
        /*!
        @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
        */
6858
        void dump_float(number_float_t x)
6859 6860 6861 6862 6863
        {
            // special case for 0.0 and -0.0
            if (x == 0)
            {
                if (std::signbit(x))
6864
                {
6865
                    o.write("-0.0", 4);
6866
                }
6867
                else
6868
                {
6869
                    o.write("0.0", 3);
6870
                }
6871
                return;
6872 6873
            }

6874 6875
            // get number of digits for a text -> float -> text round-trip
            static constexpr auto d = std::numeric_limits<number_float_t>::digits10;
6876

6877
            // the actual conversion
N
Niels Lohmann 已提交
6878 6879
            long len = snprintf(number_buffer.data(), number_buffer.size(),
                                "%.*g", d, x);
6880

6881
            // negative value indicates an error
N
Niels Lohmann 已提交
6882
            assert(len > 0);
6883
            // check if buffer was large enough
N
Niels Lohmann 已提交
6884
            assert(static_cast<size_t>(len) < number_buffer.size());
6885

6886 6887 6888
            // erase thousands separator
            if (thousands_sep != '\0')
            {
N
Niels Lohmann 已提交
6889 6890 6891 6892 6893 6894
                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());
6895
            }
6896

6897 6898 6899
            // convert decimal point to '.'
            if (decimal_point != '\0' and decimal_point != '.')
            {
N
Niels Lohmann 已提交
6900
                for (auto& c : number_buffer)
6901
                {
6902
                    if (c == decimal_point)
6903
                    {
6904 6905
                        c = '.';
                        break;
6906 6907
                    }
                }
6908
            }
6909

N
Niels Lohmann 已提交
6910 6911
            o.write(number_buffer.data(), static_cast<std::streamsize>(len));

6912
            // determine if need to append ".0"
N
Niels Lohmann 已提交
6913 6914 6915
            const bool value_is_int_like = std::none_of(number_buffer.begin(),
                                           number_buffer.begin() + len + 1,
                                           [](char c)
6916
            {
N
Niels Lohmann 已提交
6917 6918
                return c == '.' or c == 'e';
            });
6919

6920 6921 6922
            if (value_is_int_like)
            {
                o.write(".0", 2);
6923
            }
6924
        }
6925 6926

      private:
N
Niels Lohmann 已提交
6927
        /// the output of the serializer
6928
        std::ostream& o;
6929 6930

        /// a (hopefully) large enough character buffer
N
Niels Lohmann 已提交
6931
        std::array<char, 64> number_buffer{{}};
6932

N
Niels Lohmann 已提交
6933
        /// the locale
6934
        const std::lconv* loc = nullptr;
N
Niels Lohmann 已提交
6935
        /// the locale's thousand separator character
6936
        const char thousands_sep = '\0';
N
Niels Lohmann 已提交
6937
        /// the locale's decimal point character
6938 6939
        const char decimal_point = '\0';

N
Niels Lohmann 已提交
6940
        /// the indentation string
6941
        string_t indent_string = string_t(512, ' ');
6942 6943 6944
    };

  public:
N
Niels 已提交
6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961
    /*!
    @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 已提交
6962 6963
    @liveexample{The example below shows the serialization with different
    parameters to `width` to adjust the indentation level.,operator_serialize}
N
Niels 已提交
6964

N
Niels 已提交
6965
    @since version 1.0.0
N
Niels 已提交
6966
    */
N
Niels 已提交
6967 6968
    friend std::ostream& operator<<(std::ostream& o, const basic_json& j)
    {
N
Niels 已提交
6969
        // read width member and use it as indentation parameter if nonzero
N
Niels 已提交
6970 6971
        const bool pretty_print = (o.width() > 0);
        const auto indentation = (pretty_print ? o.width() : 0);
N
Niels 已提交
6972

N
Niels 已提交
6973 6974
        // reset width to 0 for subsequent calls to this stream
        o.width(0);
6975

N
Niels 已提交
6976
        // do the actual serialization
6977 6978
        serializer s(o);
        s.dump(j, pretty_print, static_cast<unsigned int>(indentation));
N
Niels 已提交
6979 6980 6981
        return o;
    }

N
Niels 已提交
6982 6983 6984 6985
    /*!
    @brief serialize to stream
    @copydoc operator<<(std::ostream&, const basic_json&)
    */
N
Niels 已提交
6986 6987
    friend std::ostream& operator>>(const basic_json& j, std::ostream& o)
    {
N
Niels 已提交
6988
        return o << j;
N
Niels 已提交
6989 6990
    }

N
Niels 已提交
6991 6992
    /// @}

N
Niels 已提交
6993 6994 6995 6996 6997

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

N
Niels 已提交
6998 6999 7000
    /// @name deserialization
    /// @{

N
Niels 已提交
7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016
    /*!
    @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

7017 7018 7019
    @throw parse_error.101 if a parse error occurs; example: `""unexpected end
    of input; expected string literal""`

N
Niels 已提交
7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065
    @complexity Linear in the length of the input. The parser is a predictive
    LL(1) parser. The complexity can be higher if the parser callback function
    @a cb has a super-linear complexity.

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

    @liveexample{The example below demonstrates the `parse()` function reading
    from an array.,parse__array__parser_callback_t}

    @since version 2.0.3
    */
    template<class T, std::size_t N>
    static basic_json parse(T (&array)[N],
                            const parser_callback_t cb = nullptr)
    {
        // delegate the call to the iterator-range parse overload
        return parse(std::begin(array), std::end(array), cb);
    }

    /*!
    @brief deserialize from string literal

    @tparam CharT character/literal type with size of 1 byte
    @param[in] s  string literal to read a serialized JSON value from
    @param[in] cb a parser callback function of type @ref parser_callback_t
    which is used to control the deserialization by filtering unwanted values
    (optional)

    @return result of the deserialization

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

    @note A UTF-8 byte order mark is silently ignored.
    @note String containers like `std::string` or @ref string_t can be parsed
          with @ref parse(const ContiguousContainer&, const parser_callback_t)

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

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

    @since version 1.0.0 (originally for @ref string_t)
    */
7066 7067 7068 7069 7070
    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 已提交
7071 7072 7073 7074 7075
                            const parser_callback_t cb = nullptr)
    {
        return parser(reinterpret_cast<const char*>(s), cb).parse();
    }

N
Niels 已提交
7076 7077 7078 7079
    /*!
    @brief deserialize from stream

    @param[in,out] i  stream to read a serialized JSON value from
N
Niels 已提交
7080 7081 7082
    @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 已提交
7083 7084 7085 7086 7087 7088 7089

    @return result of the deserialization

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

N
Niels 已提交
7090 7091
    @note A UTF-8 byte order mark is silently ignored.

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

7095
    @sa @ref parse(const CharT, const parser_callback_t) for a version
N
Niels 已提交
7096
    that reads from a string
N
Niels 已提交
7097

N
Niels 已提交
7098
    @since version 1.0.0
N
Niels 已提交
7099
    */
N
Niels 已提交
7100 7101
    static basic_json parse(std::istream& i,
                            const parser_callback_t cb = nullptr)
N
Niels 已提交
7102
    {
N
Niels 已提交
7103
        return parser(i, cb).parse();
N
Niels 已提交
7104 7105
    }

N
Niels 已提交
7106
    /*!
N
Niels 已提交
7107
    @copydoc parse(std::istream&, const parser_callback_t)
N
Niels 已提交
7108
    */
N
Niels 已提交
7109 7110
    static basic_json parse(std::istream&& i,
                            const parser_callback_t cb = nullptr)
N
Cleanup  
Niels 已提交
7111 7112 7113 7114
    {
        return parser(i, cb).parse();
    }

7115
    /*!
N
Niels 已提交
7116
    @brief deserialize from an iterator range with contiguous storage
7117

7118 7119
    This function reads from an iterator range of a container with contiguous
    storage of 1-byte values. Compatible container types include
7120 7121 7122 7123 7124 7125 7126 7127 7128
    `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
7129
    with a static assertion.**
7130

N
Niels 已提交
7131 7132 7133 7134
    @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.
7135

N
Niels 已提交
7136
    @tparam IteratorType iterator of container with contiguous storage
N
Niels 已提交
7137 7138 7139
    @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
7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150
    which is used to control the deserialization by filtering unwanted values
    (optional)

    @return result of the deserialization

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

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

N
Niels 已提交
7151 7152
    @liveexample{The example below demonstrates the `parse()` function reading
    from an iterator range.,parse__iteratortype__parser_callback_t}
7153 7154 7155

    @since version 2.0.3
    */
N
Niels 已提交
7156 7157 7158 7159
    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>
7160 7161 7162 7163 7164
    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 已提交
7165
        assert(std::accumulate(first, last, std::pair<bool, int>(true, 0),
7166 7167 7168 7169 7170 7171 7172
                               [&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
7173 7174
        static_assert(sizeof(typename std::iterator_traits<IteratorType>::value_type) == 1,
                      "each element in the iterator range must have the size of 1 byte");
7175

7176 7177 7178 7179 7180 7181
        // 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();
        }
7182 7183 7184 7185

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

N
Niels 已提交
7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206
    /*!
    @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 已提交
7207
    @tparam ContiguousContainer container type with contiguous storage
N
Niels 已提交
7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225
    @param[in] c  container to read from
    @param[in] cb  a parser callback function of type @ref parser_callback_t
    which is used to control the deserialization by filtering unwanted values
    (optional)

    @return result of the deserialization

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

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

    @liveexample{The example below demonstrates the `parse()` function reading
    from a contiguous container.,parse__contiguouscontainer__parser_callback_t}

    @since version 2.0.3
    */
N
Niels 已提交
7226
    template<class ContiguousContainer, typename std::enable_if<
N
Niels 已提交
7227
                 not std::is_pointer<ContiguousContainer>::value and
7228 7229
                 std::is_base_of<
                     std::random_access_iterator_tag,
N
Niels 已提交
7230
                     typename std::iterator_traits<decltype(std::begin(std::declval<ContiguousContainer const>()))>::iterator_category>::value
7231 7232 7233 7234 7235 7236 7237 7238
                 , 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 已提交
7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251
    /*!
    @brief deserialize from stream

    Deserializes an input stream to a JSON value.

    @param[in,out] i  input stream to read a serialized JSON value from
    @param[in,out] j  JSON value to write the deserialized input to

    @throw std::invalid_argument in case of parse errors

    @complexity Linear in the length of the input. The parser is a predictive
    LL(1) parser.

N
Niels 已提交
7252 7253
    @note A UTF-8 byte order mark is silently ignored.

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

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

N
Niels 已提交
7260
    @since version 1.0.0
N
Niels 已提交
7261 7262
    */
    friend std::istream& operator<<(basic_json& j, std::istream& i)
N
Niels 已提交
7263 7264 7265 7266 7267
    {
        j = parser(i).parse();
        return i;
    }

N
Niels 已提交
7268 7269 7270 7271 7272
    /*!
    @brief deserialize from stream
    @copydoc operator<<(basic_json&, std::istream&)
    */
    friend std::istream& operator>>(std::istream& i, basic_json& j)
N
Niels 已提交
7273 7274 7275 7276 7277
    {
        j = parser(i).parse();
        return i;
    }

N
Niels 已提交
7278 7279
    /// @}

N
Niels Lohmann 已提交
7280 7281 7282
    //////////////////////////////////////////
    // binary serialization/deserialization //
    //////////////////////////////////////////
N
Niels 已提交
7283

N
Niels Lohmann 已提交
7284
    /// @name binary serialization/deserialization support
N
Niels 已提交
7285 7286 7287
    /// @{

  private:
7288 7289 7290 7291 7292
    /*!
    @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.
    */
7293 7294 7295 7296 7297 7298 7299 7300 7301
    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:
            {
7302 7303 7304 7305
                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));
7306 7307 7308 7309 7310
                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;
7311 7312 7313 7314 7315 7316
            }

            case 4:
            {
                vec.push_back(static_cast<uint8_t>((number >> 030) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 020) & 0xff));
7317 7318 7319
                vec.push_back(static_cast<uint8_t>((number >> 010) & 0xff));
                vec.push_back(static_cast<uint8_t>(number & 0xff));
                break;
7320 7321 7322 7323 7324
            }

            case 2:
            {
                vec.push_back(static_cast<uint8_t>((number >> 010) & 0xff));
7325 7326
                vec.push_back(static_cast<uint8_t>(number & 0xff));
                break;
7327 7328 7329 7330 7331 7332 7333 7334 7335 7336
            }

            case 1:
            {
                vec.push_back(static_cast<uint8_t>(number & 0xff));
                break;
            }
        }
    }

7337 7338 7339 7340 7341 7342 7343 7344
    /*!
    @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
7345
    @param[in] current_index  the position in the vector after which to read
7346 7347 7348 7349 7350

    @return the next sizeof(T) bytes from @a vec, in reverse order as T

    @tparam T the integral return type

7351
    @throw parse_error.110 if there are less than sizeof(T)+1 bytes in the
7352 7353
           vector @a vec to read

7354 7355 7356 7357
    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.

7358 7359
    Precondition:

7360 7361 7362
    vec:   |   |   | a | b | c | d |      T: |   |   |   |   |
                 ^               ^             ^                ^
           current_index         i            ptr        sizeof(T)
7363 7364 7365

    Postcondition:

7366 7367 7368
    vec:   |   |   | a | b | c | d |      T: | d | c | b | a |
                 ^   ^                                     ^
                 |   i                                    ptr
7369 7370
           current_index

7371
    @sa Code adapted from <http://stackoverflow.com/a/41031865/266378>.
7372 7373 7374
    */
    template<typename T>
    static T get_from_vector(const std::vector<uint8_t>& vec, const size_t current_index)
7375
    {
7376 7377
        if (current_index + sizeof(T) + 1 > vec.size())
        {
7378
            JSON_THROW(parse_error(110, current_index + 1, "cannot read " + std::to_string(sizeof(T)) + " bytes from vector"));
7379 7380
        }

7381
        T result;
N
Niels Lohmann 已提交
7382
        auto* ptr = reinterpret_cast<uint8_t*>(&result);
7383
        for (size_t i = 0; i < sizeof(T); ++i)
7384
        {
7385
            *ptr++ = vec[current_index + sizeof(T) - i];
7386 7387
        }
        return result;
7388 7389
    }

7390 7391 7392 7393 7394 7395 7396 7397 7398 7399
    /*!
    @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 已提交
7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419
    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:
            {
7420
                if (j.m_value.number_integer >= 0)
N
Niels 已提交
7421
                {
7422
                    // MessagePack does not differentiate between positive
N
Niels Lohmann 已提交
7423 7424 7425
                    // signed integers and unsigned integers. Therefore, we
                    // used the code from the value_t::number_unsigned case
                    // here.
7426 7427 7428 7429 7430
                    if (j.m_value.number_unsigned < 128)
                    {
                        // positive fixnum
                        add_to_vector(v, 1, j.m_value.number_unsigned);
                    }
7431
                    else if (j.m_value.number_unsigned <= std::numeric_limits<uint8_t>::max())
7432 7433 7434 7435 7436
                    {
                        // uint 8
                        v.push_back(0xcc);
                        add_to_vector(v, 1, j.m_value.number_unsigned);
                    }
7437
                    else if (j.m_value.number_unsigned <= std::numeric_limits<uint16_t>::max())
7438 7439 7440 7441 7442
                    {
                        // uint 16
                        v.push_back(0xcd);
                        add_to_vector(v, 2, j.m_value.number_unsigned);
                    }
7443
                    else if (j.m_value.number_unsigned <= std::numeric_limits<uint32_t>::max())
7444 7445 7446 7447 7448
                    {
                        // uint 32
                        v.push_back(0xce);
                        add_to_vector(v, 4, j.m_value.number_unsigned);
                    }
7449
                    else if (j.m_value.number_unsigned <= std::numeric_limits<uint64_t>::max())
7450 7451 7452 7453 7454
                    {
                        // uint 64
                        v.push_back(0xcf);
                        add_to_vector(v, 8, j.m_value.number_unsigned);
                    }
N
Niels 已提交
7455
                }
7456
                else
N
Niels 已提交
7457
                {
7458 7459 7460 7461 7462
                    if (j.m_value.number_integer >= -32)
                    {
                        // negative fixnum
                        add_to_vector(v, 1, j.m_value.number_integer);
                    }
7463
                    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())
7464 7465 7466 7467 7468
                    {
                        // int 8
                        v.push_back(0xd0);
                        add_to_vector(v, 1, j.m_value.number_integer);
                    }
7469
                    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())
7470 7471 7472 7473 7474
                    {
                        // int 16
                        v.push_back(0xd1);
                        add_to_vector(v, 2, j.m_value.number_integer);
                    }
7475
                    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())
7476 7477 7478 7479 7480
                    {
                        // int 32
                        v.push_back(0xd2);
                        add_to_vector(v, 4, j.m_value.number_integer);
                    }
7481
                    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())
7482 7483 7484 7485 7486
                    {
                        // int 64
                        v.push_back(0xd3);
                        add_to_vector(v, 8, j.m_value.number_integer);
                    }
N
Niels 已提交
7487 7488 7489 7490 7491 7492 7493 7494 7495
                }
                break;
            }

            case value_t::number_unsigned:
            {
                if (j.m_value.number_unsigned < 128)
                {
                    // positive fixnum
7496
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels 已提交
7497
                }
7498
                else if (j.m_value.number_unsigned <= std::numeric_limits<uint8_t>::max())
N
Niels 已提交
7499 7500 7501
                {
                    // uint 8
                    v.push_back(0xcc);
7502
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels 已提交
7503
                }
7504
                else if (j.m_value.number_unsigned <= std::numeric_limits<uint16_t>::max())
N
Niels 已提交
7505 7506 7507
                {
                    // uint 16
                    v.push_back(0xcd);
7508
                    add_to_vector(v, 2, j.m_value.number_unsigned);
N
Niels 已提交
7509
                }
7510
                else if (j.m_value.number_unsigned <= std::numeric_limits<uint32_t>::max())
N
Niels 已提交
7511 7512 7513
                {
                    // uint 32
                    v.push_back(0xce);
7514
                    add_to_vector(v, 4, j.m_value.number_unsigned);
N
Niels 已提交
7515
                }
7516
                else if (j.m_value.number_unsigned <= std::numeric_limits<uint64_t>::max())
N
Niels 已提交
7517 7518 7519
                {
                    // uint 64
                    v.push_back(0xcf);
7520
                    add_to_vector(v, 8, j.m_value.number_unsigned);
N
Niels 已提交
7521 7522 7523 7524 7525 7526 7527 7528
                }
                break;
            }

            case value_t::number_float:
            {
                // float 64
                v.push_back(0xcb);
N
Niels Lohmann 已提交
7529
                const auto* helper = reinterpret_cast<const uint8_t*>(&(j.m_value.number_float));
N
Niels 已提交
7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548
                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);
7549
                    add_to_vector(v, 1, N);
N
Niels 已提交
7550 7551 7552 7553 7554
                }
                else if (N <= 65535)
                {
                    // str 16
                    v.push_back(0xda);
7555
                    add_to_vector(v, 2, N);
N
Niels 已提交
7556 7557 7558 7559 7560
                }
                else if (N <= 4294967295)
                {
                    // str 32
                    v.push_back(0xdb);
7561
                    add_to_vector(v, 4, N);
N
Niels 已提交
7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581
                }

                // 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);
7582
                    add_to_vector(v, 2, N);
N
Niels 已提交
7583 7584 7585 7586 7587
                }
                else if (N <= 0xffffffff)
                {
                    // array 32
                    v.push_back(0xdd);
7588
                    add_to_vector(v, 4, N);
N
Niels 已提交
7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610
                }

                // 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);
7611
                    add_to_vector(v, 2, N);
N
Niels 已提交
7612 7613 7614 7615 7616
                }
                else if (N <= 4294967295)
                {
                    // map 32
                    v.push_back(0xdf);
7617
                    add_to_vector(v, 4, N);
N
Niels 已提交
7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635
                }

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

7636 7637 7638 7639 7640 7641 7642 7643 7644 7645
    /*!
    @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 已提交
7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668
    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.
7669
                    if (j.m_value.number_integer <= 0x17)
N
Niels Lohmann 已提交
7670
                    {
7671
                        add_to_vector(v, 1, j.m_value.number_integer);
N
Niels Lohmann 已提交
7672
                    }
7673
                    else if (j.m_value.number_integer <= std::numeric_limits<uint8_t>::max())
N
Niels Lohmann 已提交
7674 7675 7676
                    {
                        v.push_back(0x18);
                        // one-byte uint8_t
7677
                        add_to_vector(v, 1, j.m_value.number_integer);
N
Niels Lohmann 已提交
7678
                    }
7679
                    else if (j.m_value.number_integer <= std::numeric_limits<uint16_t>::max())
N
Niels Lohmann 已提交
7680 7681 7682
                    {
                        v.push_back(0x19);
                        // two-byte uint16_t
7683
                        add_to_vector(v, 2, j.m_value.number_integer);
N
Niels Lohmann 已提交
7684
                    }
7685
                    else if (j.m_value.number_integer <= std::numeric_limits<uint32_t>::max())
N
Niels Lohmann 已提交
7686 7687 7688
                    {
                        v.push_back(0x1a);
                        // four-byte uint32_t
7689
                        add_to_vector(v, 4, j.m_value.number_integer);
N
Niels Lohmann 已提交
7690
                    }
7691
                    else
N
Niels Lohmann 已提交
7692
                    {
N
Niels Lohmann 已提交
7693
                        v.push_back(0x1b);
N
Niels Lohmann 已提交
7694
                        // eight-byte uint64_t
7695
                        add_to_vector(v, 8, j.m_value.number_integer);
N
Niels Lohmann 已提交
7696 7697 7698 7699
                    }
                }
                else
                {
N
Niels Lohmann 已提交
7700 7701
                    // The conversions below encode the sign in the first
                    // byte, and the value is converted to a positive number.
N
Niels Lohmann 已提交
7702
                    const auto positive_number = -1 - j.m_value.number_integer;
7703
                    if (j.m_value.number_integer >= -24)
N
Niels Lohmann 已提交
7704 7705 7706
                    {
                        v.push_back(static_cast<uint8_t>(0x20 + positive_number));
                    }
7707
                    else if (positive_number <= std::numeric_limits<uint8_t>::max())
N
Niels Lohmann 已提交
7708 7709 7710
                    {
                        // int 8
                        v.push_back(0x38);
7711
                        add_to_vector(v, 1, positive_number);
N
Niels Lohmann 已提交
7712
                    }
7713
                    else if (positive_number <= std::numeric_limits<uint16_t>::max())
N
Niels Lohmann 已提交
7714 7715 7716
                    {
                        // int 16
                        v.push_back(0x39);
7717
                        add_to_vector(v, 2, positive_number);
N
Niels Lohmann 已提交
7718
                    }
7719
                    else if (positive_number <= std::numeric_limits<uint32_t>::max())
N
Niels Lohmann 已提交
7720 7721 7722
                    {
                        // int 32
                        v.push_back(0x3a);
7723
                        add_to_vector(v, 4, positive_number);
N
Niels Lohmann 已提交
7724
                    }
7725
                    else
N
Niels Lohmann 已提交
7726 7727 7728
                    {
                        // int 64
                        v.push_back(0x3b);
7729
                        add_to_vector(v, 8, positive_number);
N
Niels Lohmann 已提交
7730 7731
                    }
                }
7732
                break;
N
Niels Lohmann 已提交
7733 7734 7735 7736
            }

            case value_t::number_unsigned:
            {
7737
                if (j.m_value.number_unsigned <= 0x17)
N
Niels Lohmann 已提交
7738 7739 7740 7741 7742 7743 7744
                {
                    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
7745
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7746 7747 7748 7749 7750
                }
                else if (j.m_value.number_unsigned <= 0xffff)
                {
                    v.push_back(0x19);
                    // two-byte uint16_t
7751
                    add_to_vector(v, 2, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7752 7753 7754 7755 7756
                }
                else if (j.m_value.number_unsigned <= 0xffffffff)
                {
                    v.push_back(0x1a);
                    // four-byte uint32_t
7757
                    add_to_vector(v, 4, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7758 7759 7760
                }
                else if (j.m_value.number_unsigned <= 0xffffffffffffffff)
                {
N
Niels Lohmann 已提交
7761
                    v.push_back(0x1b);
N
Niels Lohmann 已提交
7762
                    // eight-byte uint64_t
7763
                    add_to_vector(v, 8, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7764 7765 7766 7767 7768 7769 7770 7771
                }
                break;
            }

            case value_t::number_float:
            {
                // Double-Precision Float
                v.push_back(0xfb);
N
Niels Lohmann 已提交
7772
                const auto* helper = reinterpret_cast<const uint8_t*>(&(j.m_value.number_float));
N
Niels Lohmann 已提交
7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784
                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)
                {
7785
                    v.push_back(0x60 + static_cast<uint8_t>(N));  // 1 byte for string + size
N
Niels Lohmann 已提交
7786 7787 7788
                }
                else if (N <= 0xff)
                {
7789
                    v.push_back(0x78);  // one-byte uint8_t for N
7790
                    add_to_vector(v, 1, N);
N
Niels Lohmann 已提交
7791 7792 7793
                }
                else if (N <= 0xffff)
                {
7794
                    v.push_back(0x79);  // two-byte uint16_t for N
7795
                    add_to_vector(v, 2, N);
N
Niels Lohmann 已提交
7796 7797 7798
                }
                else if (N <= 0xffffffff)
                {
7799
                    v.push_back(0x7a); // four-byte uint32_t for N
7800
                    add_to_vector(v, 4, N);
N
Niels Lohmann 已提交
7801
                }
7802
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
7803 7804
                else if (N <= 0xffffffffffffffff)
                {
7805
                    v.push_back(0x7b);  // eight-byte uint64_t for N
7806
                    add_to_vector(v, 8, N);
N
Niels Lohmann 已提交
7807
                }
7808
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820

                // 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)
                {
7821
                    v.push_back(0x80 + static_cast<uint8_t>(N));  // 1 byte for array + size
N
Niels Lohmann 已提交
7822 7823 7824
                }
                else if (N <= 0xff)
                {
7825
                    v.push_back(0x98);  // one-byte uint8_t for N
7826
                    add_to_vector(v, 1, N);
N
Niels Lohmann 已提交
7827 7828 7829
                }
                else if (N <= 0xffff)
                {
7830
                    v.push_back(0x99);  // two-byte uint16_t for N
7831
                    add_to_vector(v, 2, N);
N
Niels Lohmann 已提交
7832 7833 7834
                }
                else if (N <= 0xffffffff)
                {
7835
                    v.push_back(0x9a);  // four-byte uint32_t for N
7836
                    add_to_vector(v, 4, N);
N
Niels Lohmann 已提交
7837
                }
7838
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
7839 7840
                else if (N <= 0xffffffffffffffff)
                {
7841
                    v.push_back(0x9b);  // eight-byte uint64_t for N
7842
                    add_to_vector(v, 8, N);
N
Niels Lohmann 已提交
7843
                }
7844
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858

                // 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)
                {
7859
                    v.push_back(0xa0 + static_cast<uint8_t>(N));  // 1 byte for object + size
N
Niels Lohmann 已提交
7860 7861 7862 7863
                }
                else if (N <= 0xff)
                {
                    v.push_back(0xb8);
7864
                    add_to_vector(v, 1, N);  // one-byte uint8_t for N
N
Niels Lohmann 已提交
7865 7866 7867 7868
                }
                else if (N <= 0xffff)
                {
                    v.push_back(0xb9);
7869
                    add_to_vector(v, 2, N);  // two-byte uint16_t for N
N
Niels Lohmann 已提交
7870 7871 7872 7873
                }
                else if (N <= 0xffffffff)
                {
                    v.push_back(0xba);
7874
                    add_to_vector(v, 4, N);  // four-byte uint32_t for N
N
Niels Lohmann 已提交
7875
                }
7876
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
7877 7878 7879
                else if (N <= 0xffffffffffffffff)
                {
                    v.push_back(0xbb);
7880
                    add_to_vector(v, 8, N);  // eight-byte uint64_t for N
N
Niels Lohmann 已提交
7881
                }
7882
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899

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

7900 7901 7902 7903 7904 7905

    /*
    @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 已提交
7906 7907 7908
    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.
7909

N
Niels Lohmann 已提交
7910 7911
    This function checks whether reading the bytes is safe; that is, offset is
    a valid index in the vector, offset+len
7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927

    @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)
        {
7928
            JSON_THROW(std::out_of_range("len out of range"));
7929 7930 7931 7932 7933
        }

        // second case: adding offset would result in overflow
        if ((size > (std::numeric_limits<size_t>::max() - offset)))
        {
7934
            JSON_THROW(std::out_of_range("len+offset out of range"));
7935
        }
N
Niels Lohmann 已提交
7936 7937 7938 7939

        // last case: reading past the end of the vector
        if (len + offset > size)
        {
7940
            JSON_THROW(std::out_of_range("len+offset out of range"));
N
Niels Lohmann 已提交
7941
        }
7942 7943
    }

N
Niels 已提交
7944
    /*!
7945 7946
    @brief create a JSON value from a given MessagePack vector

N
Niels 已提交
7947 7948
    @param[in] v  MessagePack serialization
    @param[in] idx  byte index to start reading from @a v
7949 7950 7951 7952 7953 7954 7955 7956

    @return deserialized JSON value

    @throw std::invalid_argument if unsupported features from MessagePack were
    used in the given vector @a v or if the input is not valid MessagePack
    @throw std::out_of_range if the given vector ends prematurely

    @sa https://github.com/msgpack/msgpack/blob/master/spec.md
N
Niels 已提交
7957 7958 7959
    */
    static basic_json from_msgpack_internal(const std::vector<uint8_t>& v, size_t& idx)
    {
N
Niels Lohmann 已提交
7960 7961 7962
        // make sure reading 1 byte is safe
        check_length(v.size(), 1, idx);

N
Niels 已提交
7963 7964 7965
        // store and increment index
        const size_t current_idx = idx++;

N
Niels Lohmann 已提交
7966
        if (v[current_idx] <= 0xbf)
N
Niels 已提交
7967
        {
N
Niels Lohmann 已提交
7968
            if (v[current_idx] <= 0x7f) // positive fixint
N
Niels 已提交
7969
            {
N
Niels Lohmann 已提交
7970
                return v[current_idx];
N
Niels 已提交
7971
            }
N
Niels Lohmann 已提交
7972
            if (v[current_idx] <= 0x8f) // fixmap
N
Niels 已提交
7973
            {
N
Niels Lohmann 已提交
7974 7975 7976 7977 7978 7979 7980 7981
                basic_json result = value_t::object;
                const size_t len = v[current_idx] & 0x0f;
                for (size_t i = 0; i < len; ++i)
                {
                    std::string key = from_msgpack_internal(v, idx);
                    result[key] = from_msgpack_internal(v, idx);
                }
                return result;
N
Niels 已提交
7982
            }
N
Niels Lohmann 已提交
7983
            else if (v[current_idx] <= 0x9f) // fixarray
N
Niels 已提交
7984
            {
N
Niels Lohmann 已提交
7985 7986 7987 7988 7989 7990 7991
                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 已提交
7992
            }
N
Niels Lohmann 已提交
7993
            else // fixstr
N
Niels 已提交
7994
            {
N
Niels Lohmann 已提交
7995 7996 7997
                const size_t len = v[current_idx] & 0x1f;
                const size_t offset = current_idx + 1;
                idx += len; // skip content bytes
7998
                check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
7999
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels 已提交
8000 8001
            }
        }
N
Niels Lohmann 已提交
8002
        else if (v[current_idx] >= 0xe0) // negative fixint
N
Niels 已提交
8003
        {
N
Niels Lohmann 已提交
8004
            return static_cast<int8_t>(v[current_idx]);
N
Niels 已提交
8005
        }
N
Niels Lohmann 已提交
8006
        else
N
Niels 已提交
8007
        {
N
Niels Lohmann 已提交
8008
            switch (v[current_idx])
N
Niels 已提交
8009
            {
N
Niels Lohmann 已提交
8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030
                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;
                    for (size_t byte = 0; byte < sizeof(float); ++byte)
                    {
N
Niels Lohmann 已提交
8031
                        reinterpret_cast<uint8_t*>(&res)[sizeof(float) - byte - 1] = v.at(current_idx + 1 + byte);
N
Niels Lohmann 已提交
8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042
                    }
                    idx += sizeof(float); // skip content bytes
                    return res;
                }

                case 0xcb: // float 64
                {
                    // copy bytes in reverse order into the double variable
                    double res;
                    for (size_t byte = 0; byte < sizeof(double); ++byte)
                    {
N
Niels Lohmann 已提交
8043
                        reinterpret_cast<uint8_t*>(&res)[sizeof(double) - byte - 1] = v.at(current_idx + 1 + byte);
N
Niels Lohmann 已提交
8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098
                    }
                    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
                {
8099
                    const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
N
Niels Lohmann 已提交
8100 8101
                    const size_t offset = current_idx + 2;
                    idx += len + 1; // skip size byte + content bytes
8102
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
8103 8104 8105 8106 8107
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xda: // str 16
                {
8108
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
8109 8110
                    const size_t offset = current_idx + 3;
                    idx += len + 2; // skip 2 size bytes + content bytes
8111
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
8112 8113 8114 8115 8116
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xdb: // str 32
                {
8117
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
8118 8119
                    const size_t offset = current_idx + 5;
                    idx += len + 4; // skip 4 size bytes + content bytes
8120
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
8121 8122 8123 8124 8125 8126
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xdc: // array 16
                {
                    basic_json result = value_t::array;
8127
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138
                    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;
8139
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150
                    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;
8151
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163
                    idx += 2; // skip 2 size bytes
                    for (size_t i = 0; i < len; ++i)
                    {
                        std::string key = from_msgpack_internal(v, idx);
                        result[key] = from_msgpack_internal(v, idx);
                    }
                    return result;
                }

                case 0xdf: // map 32
                {
                    basic_json result = value_t::object;
8164
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175
                    idx += 4; // skip 4 size bytes
                    for (size_t i = 0; i < len; ++i)
                    {
                        std::string key = from_msgpack_internal(v, idx);
                        result[key] = from_msgpack_internal(v, idx);
                    }
                    return result;
                }

                default:
                {
8176
                    JSON_THROW(std::invalid_argument("error parsing a msgpack @ " + std::to_string(current_idx) + ": " + std::to_string(static_cast<int>(v[current_idx]))));
N
Niels Lohmann 已提交
8177
                }
N
Niels 已提交
8178 8179 8180 8181
            }
        }
    }

8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195
    /*!
    @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

    @throw std::invalid_argument if unsupported features from CBOR were used in
    the given vector @a v or if the input is not valid CBOR
    @throw std::out_of_range if the given vector ends prematurely

    @sa https://tools.ietf.org/html/rfc7049
    */
N
Niels Lohmann 已提交
8196 8197 8198 8199 8200
    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++;

8201
        switch (v.at(current_idx))
8202
        {
N
Niels Lohmann 已提交
8203
            // Integer 0x00..0x17 (0..23)
8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227
            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:
8228
            {
8229
                return v[current_idx];
8230
            }
8231

N
Niels Lohmann 已提交
8232
            case 0x18: // Unsigned integer (one-byte uint8_t follows)
N
Niels Lohmann 已提交
8233
            {
8234 8235
                idx += 1; // skip content byte
                return get_from_vector<uint8_t>(v, current_idx);
N
Niels Lohmann 已提交
8236
            }
8237

N
Niels Lohmann 已提交
8238
            case 0x19: // Unsigned integer (two-byte uint16_t follows)
N
Niels Lohmann 已提交
8239
            {
8240 8241
                idx += 2; // skip 2 content bytes
                return get_from_vector<uint16_t>(v, current_idx);
N
Niels Lohmann 已提交
8242
            }
8243

N
Niels Lohmann 已提交
8244
            case 0x1a: // Unsigned integer (four-byte uint32_t follows)
N
Niels Lohmann 已提交
8245
            {
8246 8247
                idx += 4; // skip 4 content bytes
                return get_from_vector<uint32_t>(v, current_idx);
N
Niels Lohmann 已提交
8248
            }
8249

N
Niels Lohmann 已提交
8250
            case 0x1b: // Unsigned integer (eight-byte uint64_t follows)
N
Niels Lohmann 已提交
8251
            {
8252 8253
                idx += 8; // skip 8 content bytes
                return get_from_vector<uint64_t>(v, current_idx);
N
Niels Lohmann 已提交
8254
            }
8255

N
Niels Lohmann 已提交
8256
            // Negative integer -1-0x00..-1-0x17 (-1..-24)
8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280
            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 已提交
8281
            {
8282
                return static_cast<int8_t>(0x20 - 1 - v[current_idx]);
N
Niels Lohmann 已提交
8283
            }
8284

N
Niels Lohmann 已提交
8285
            case 0x38: // Negative integer (one-byte uint8_t follows)
8286
            {
8287 8288
                idx += 1; // skip content byte
                // must be uint8_t !
8289
                return static_cast<number_integer_t>(-1) - get_from_vector<uint8_t>(v, current_idx);
8290
            }
8291

N
Niels Lohmann 已提交
8292
            case 0x39: // Negative integer -1-n (two-byte uint16_t follows)
N
Niels Lohmann 已提交
8293
            {
8294
                idx += 2; // skip 2 content bytes
8295
                return static_cast<number_integer_t>(-1) - get_from_vector<uint16_t>(v, current_idx);
N
Niels Lohmann 已提交
8296
            }
8297

N
Niels Lohmann 已提交
8298
            case 0x3a: // Negative integer -1-n (four-byte uint32_t follows)
N
Niels Lohmann 已提交
8299
            {
8300
                idx += 4; // skip 4 content bytes
8301
                return static_cast<number_integer_t>(-1) - get_from_vector<uint32_t>(v, current_idx);
N
Niels Lohmann 已提交
8302
            }
8303

N
Niels Lohmann 已提交
8304
            case 0x3b: // Negative integer -1-n (eight-byte uint64_t follows)
N
Niels Lohmann 已提交
8305
            {
8306
                idx += 8; // skip 8 content bytes
8307
                return static_cast<number_integer_t>(-1) - static_cast<number_integer_t>(get_from_vector<uint64_t>(v, current_idx));
N
Niels Lohmann 已提交
8308
            }
8309

N
Niels Lohmann 已提交
8310
            // UTF-8 string (0x00..0x17 bytes follow)
8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334
            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 已提交
8335
            {
8336
                const auto len = static_cast<size_t>(v[current_idx] - 0x60);
8337 8338
                const size_t offset = current_idx + 1;
                idx += len; // skip content bytes
8339
                check_length(v.size(), len, offset);
8340
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels Lohmann 已提交
8341
            }
8342

N
Niels Lohmann 已提交
8343
            case 0x78: // UTF-8 string (one-byte uint8_t for n follows)
N
Niels Lohmann 已提交
8344
            {
8345
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
8346 8347
                const size_t offset = current_idx + 2;
                idx += len + 1; // skip size byte + content bytes
8348
                check_length(v.size(), len, offset);
8349
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels Lohmann 已提交
8350
            }
8351

N
Niels Lohmann 已提交
8352
            case 0x79: // UTF-8 string (two-byte uint16_t for n follow)
8353
            {
8354
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
8355 8356
                const size_t offset = current_idx + 3;
                idx += len + 2; // skip 2 size bytes + content bytes
8357
                check_length(v.size(), len, offset);
8358
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
8359
            }
8360

N
Niels Lohmann 已提交
8361
            case 0x7a: // UTF-8 string (four-byte uint32_t for n follow)
8362
            {
8363
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
8364 8365
                const size_t offset = current_idx + 5;
                idx += len + 4; // skip 4 size bytes + content bytes
8366
                check_length(v.size(), len, offset);
8367
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
8368
            }
8369

N
Niels Lohmann 已提交
8370
            case 0x7b: // UTF-8 string (eight-byte uint64_t for n follow)
8371
            {
8372
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
8373 8374
                const size_t offset = current_idx + 9;
                idx += len + 8; // skip 8 size bytes + content bytes
8375
                check_length(v.size(), len, offset);
8376
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
8377
            }
8378 8379

            case 0x7f: // UTF-8 string (indefinite length)
8380
            {
8381
                std::string result;
8382
                while (v.at(idx) != 0xff)
8383 8384 8385 8386 8387 8388 8389
                {
                    string_t s = from_cbor_internal(v, idx);
                    result += s;
                }
                // skip break byte (0xFF)
                idx += 1;
                return result;
8390
            }
8391

N
Niels Lohmann 已提交
8392
            // array (0x00..0x17 data items follow)
8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416
            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 已提交
8417
            {
8418
                basic_json result = value_t::array;
8419
                const auto len = static_cast<size_t>(v[current_idx] - 0x80);
8420 8421 8422 8423 8424
                for (size_t i = 0; i < len; ++i)
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                return result;
N
Niels Lohmann 已提交
8425
            }
8426

N
Niels Lohmann 已提交
8427
            case 0x98: // array (one-byte uint8_t for n follows)
N
Niels Lohmann 已提交
8428
            {
8429
                basic_json result = value_t::array;
8430
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
8431 8432 8433 8434 8435 8436
                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 已提交
8437 8438
            }

N
Niels Lohmann 已提交
8439
            case 0x99: // array (two-byte uint16_t for n follow)
8440 8441
            {
                basic_json result = value_t::array;
8442
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
8443 8444 8445 8446 8447 8448 8449 8450
                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 已提交
8451
            case 0x9a: // array (four-byte uint32_t for n follow)
8452 8453
            {
                basic_json result = value_t::array;
8454
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
8455 8456 8457 8458 8459 8460 8461 8462
                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 已提交
8463
            case 0x9b: // array (eight-byte uint64_t for n follow)
8464 8465
            {
                basic_json result = value_t::array;
8466
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477
                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;
8478
                while (v.at(idx) != 0xff)
8479 8480 8481 8482 8483 8484 8485 8486
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                // skip break byte (0xFF)
                idx += 1;
                return result;
            }

N
Niels Lohmann 已提交
8487
            // map (0x00..0x17 pairs of data items follow)
8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513
            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;
8514
                const auto len = static_cast<size_t>(v[current_idx] - 0xa0);
8515 8516 8517 8518 8519 8520 8521 8522
                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 已提交
8523
            case 0xb8: // map (one-byte uint8_t for n follows)
8524 8525
            {
                basic_json result = value_t::object;
8526
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
8527 8528 8529 8530 8531 8532 8533 8534 8535
                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 已提交
8536
            case 0xb9: // map (two-byte uint16_t for n follow)
8537 8538
            {
                basic_json result = value_t::object;
8539
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
8540 8541 8542 8543 8544 8545 8546 8547 8548
                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 已提交
8549
            case 0xba: // map (four-byte uint32_t for n follow)
8550 8551
            {
                basic_json result = value_t::object;
8552
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
8553 8554 8555 8556 8557 8558 8559 8560 8561
                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 已提交
8562
            case 0xbb: // map (eight-byte uint64_t for n follow)
8563 8564
            {
                basic_json result = value_t::object;
8565
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577
                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;
8578
                while (v.at(idx) != 0xff)
8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602
                {
                    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 已提交
8603
            case 0xf9: // Half-Precision Float (two-byte IEEE 754)
8604 8605 8606 8607
            {
                idx += 2; // skip two content bytes

                // code from RFC 7049, Appendix D, Figure 3:
N
Niels Lohmann 已提交
8608 8609 8610 8611 8612 8613
                // 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.
8614
                const int half = (v.at(current_idx + 1) << 8) + v.at(current_idx + 2);
8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627
                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
                {
8628 8629 8630
                    val = mant == 0
                          ? std::numeric_limits<double>::infinity()
                          : std::numeric_limits<double>::quiet_NaN();
8631
                }
N
Niels Lohmann 已提交
8632
                return (half & 0x8000) != 0 ? -val : val;
8633 8634
            }

N
Niels Lohmann 已提交
8635
            case 0xfa: // Single-Precision Float (four-byte IEEE 754)
8636 8637 8638 8639 8640
            {
                // copy bytes in reverse order into the float variable
                float res;
                for (size_t byte = 0; byte < sizeof(float); ++byte)
                {
N
Niels Lohmann 已提交
8641
                    reinterpret_cast<uint8_t*>(&res)[sizeof(float) - byte - 1] = v.at(current_idx + 1 + byte);
8642 8643 8644 8645 8646
                }
                idx += sizeof(float); // skip content bytes
                return res;
            }

N
Niels Lohmann 已提交
8647
            case 0xfb: // Double-Precision Float (eight-byte IEEE 754)
8648 8649 8650 8651 8652
            {
                // copy bytes in reverse order into the double variable
                double res;
                for (size_t byte = 0; byte < sizeof(double); ++byte)
                {
N
Niels Lohmann 已提交
8653
                    reinterpret_cast<uint8_t*>(&res)[sizeof(double) - byte - 1] = v.at(current_idx + 1 + byte);
8654 8655 8656 8657 8658
                }
                idx += sizeof(double); // skip content bytes
                return res;
            }

N
Niels Lohmann 已提交
8659
            default: // anything else (0xFF is handled inside the other types)
8660
            {
8661
                JSON_THROW(std::invalid_argument("error parsing a CBOR @ " + std::to_string(current_idx) + ": " + std::to_string(static_cast<int>(v[current_idx]))));
8662 8663
            }
        }
N
Niels Lohmann 已提交
8664 8665
    }

N
Niels 已提交
8666 8667
  public:
    /*!
8668 8669 8670 8671 8672 8673
    @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 已提交
8674
    @param[in] j  JSON value to serialize
8675 8676 8677 8678 8679 8680 8681 8682
    @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
8683 8684
    @sa @ref from_msgpack(const std::vector<uint8_t>&, const size_t) for the
        analogous deserialization
8685
    @sa @ref to_cbor(const basic_json& for the related CBOR format
8686 8687

    @since version 2.0.9
N
Niels 已提交
8688 8689 8690 8691 8692 8693 8694 8695
    */
    static std::vector<uint8_t> to_msgpack(const basic_json& j)
    {
        std::vector<uint8_t> result;
        to_msgpack_internal(j, result);
        return result;
    }

8696 8697 8698 8699 8700 8701 8702
    /*!
    @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
8703
    @param[in] start_index the index to start reading from @a v (0 by default)
8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716
    @return deserialized JSON value

    @throw std::invalid_argument if unsupported features from MessagePack were
    used in the given vector @a v or if the input is not valid MessagePack
    @throw std::out_of_range if the given vector ends prematurely

    @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
8717 8718 8719
    @sa @ref from_cbor(const std::vector<uint8_t>&, const size_t) for the
        related CBOR format

N
Niels Lohmann 已提交
8720
    @since version 2.0.9, parameter @a start_index since 2.1.1
8721
    */
8722 8723
    static basic_json from_msgpack(const std::vector<uint8_t>& v,
                                   const size_t start_index = 0)
N
Niels 已提交
8724
    {
8725
        size_t i = start_index;
N
Niels 已提交
8726 8727 8728
        return from_msgpack_internal(v, i);
    }

N
Niels Lohmann 已提交
8729
    /*!
8730 8731 8732 8733 8734 8735 8736
    @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 已提交
8737
    @param[in] j  JSON value to serialize
8738 8739 8740 8741 8742 8743 8744 8745
    @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
8746 8747
    @sa @ref from_cbor(const std::vector<uint8_t>&, const size_t) for the
        analogous deserialization
8748
    @sa @ref to_msgpack(const basic_json& for the related MessagePack format
8749 8750

    @since version 2.0.9
N
Niels Lohmann 已提交
8751 8752 8753 8754 8755 8756 8757 8758
    */
    static std::vector<uint8_t> to_cbor(const basic_json& j)
    {
        std::vector<uint8_t> result;
        to_cbor_internal(j, result);
        return result;
    }

8759 8760 8761 8762 8763 8764 8765
    /*!
    @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
8766
    @param[in] start_index the index to start reading from @a v (0 by default)
8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779
    @return deserialized JSON value

    @throw std::invalid_argument if unsupported features from CBOR were used in
    the given vector @a v or if the input is not valid MessagePack
    @throw std::out_of_range if the given vector ends prematurely

    @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
8780 8781 8782
    @sa @ref from_msgpack(const std::vector<uint8_t>&, const size_t) for the
        related MessagePack format

N
Niels Lohmann 已提交
8783
    @since version 2.0.9, parameter @a start_index since 2.1.1
8784
    */
8785 8786
    static basic_json from_cbor(const std::vector<uint8_t>& v,
                                const size_t start_index = 0)
N
Niels Lohmann 已提交
8787
    {
8788
        size_t i = start_index;
N
Niels Lohmann 已提交
8789 8790 8791
        return from_cbor_internal(v, i);
    }

N
Niels 已提交
8792
    /// @}
N
Niels 已提交
8793 8794 8795 8796 8797

    ///////////////////////////
    // convenience functions //
    ///////////////////////////

N
Niels 已提交
8798 8799 8800 8801 8802 8803
    /*!
    @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 已提交
8804
    @return basically a string representation of a the @a m_type member
N
Niels 已提交
8805 8806 8807

    @complexity Constant.

8808
    @liveexample{The following code exemplifies `type_name()` for all JSON
8809
    types.,type_name}
8810

8811
    @since version 1.0.0, public since 2.1.0
N
Niels 已提交
8812
    */
T
Théo DELRIEU 已提交
8813 8814
    std::string type_name() const
    {
T
Théo DELRIEU 已提交
8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833
        {
            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 已提交
8834
    }
N
Niels 已提交
8835 8836 8837 8838 8839 8840 8841 8842


  private:
    //////////////////////
    // member variables //
    //////////////////////

    /// the type of the current element
N
Niels 已提交
8843
    value_t m_type = value_t::null;
N
Niels 已提交
8844 8845 8846 8847

    /// the value of the current element
    json_value m_value = {};

N
Niels 已提交
8848

N
Niels 已提交
8849
  private:
N
Niels 已提交
8850 8851 8852 8853
    ///////////////
    // iterators //
    ///////////////

8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864
    /*!
    @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 已提交
8865
      public:
T
Théo Delrieu 已提交
8866 8867

        difference_type get_value() const noexcept
T
Théo DELRIEU 已提交
8868 8869 8870 8871 8872 8873 8874 8875
        {
            return m_it;
        }
        /// set iterator to a defined beginning
        void set_begin() noexcept
        {
            m_it = begin_value;
        }
8876

T
Théo DELRIEU 已提交
8877 8878 8879 8880 8881
        /// set iterator to a defined past the end
        void set_end() noexcept
        {
            m_it = end_value;
        }
8882

T
Théo DELRIEU 已提交
8883 8884 8885 8886 8887
        /// return whether the iterator can be dereferenced
        constexpr bool is_begin() const noexcept
        {
            return (m_it == begin_value);
        }
8888

T
Théo DELRIEU 已提交
8889 8890 8891 8892 8893
        /// return whether the iterator is at end
        constexpr bool is_end() const noexcept
        {
            return (m_it == end_value);
        }
8894

T
Théo DELRIEU 已提交
8895 8896 8897 8898
        friend constexpr bool operator==(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it == rhs.m_it;
        }
T
Théo Delrieu 已提交
8899

T
Théo DELRIEU 已提交
8900 8901 8902 8903
        friend constexpr bool operator!=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return !(lhs == rhs);
        }
T
Théo Delrieu 已提交
8904

T
Théo DELRIEU 已提交
8905 8906 8907 8908
        friend constexpr bool operator<(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it < rhs.m_it;
        }
T
Théo Delrieu 已提交
8909

T
Théo DELRIEU 已提交
8910 8911 8912 8913
        friend constexpr bool operator<=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it <= rhs.m_it;
        }
T
Théo Delrieu 已提交
8914

T
Théo DELRIEU 已提交
8915 8916 8917 8918
        friend constexpr bool operator>(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it > rhs.m_it;
        }
T
Théo Delrieu 已提交
8919

T
Théo DELRIEU 已提交
8920 8921 8922 8923
        friend constexpr bool operator>=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it >= rhs.m_it;
        }
T
Théo Delrieu 已提交
8924

T
Théo DELRIEU 已提交
8925 8926 8927 8928 8929 8930
        primitive_iterator_t operator+(difference_type i)
        {
            auto result = *this;
            result += i;
            return result;
        }
T
Théo Delrieu 已提交
8931

T
Théo DELRIEU 已提交
8932 8933 8934 8935
        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 已提交
8936

T
Théo DELRIEU 已提交
8937 8938 8939 8940
        friend std::ostream& operator<<(std::ostream& os, primitive_iterator_t it)
        {
            return os << it.m_it;
        }
T
Théo Delrieu 已提交
8941

T
Théo DELRIEU 已提交
8942 8943 8944 8945 8946
        primitive_iterator_t& operator++()
        {
            ++m_it;
            return *this;
        }
T
Théo Delrieu 已提交
8947

N
Niels Lohmann 已提交
8948
        primitive_iterator_t operator++(int)
T
Théo DELRIEU 已提交
8949
        {
N
Niels Lohmann 已提交
8950
            auto result = *this;
T
Théo DELRIEU 已提交
8951
            m_it++;
N
Niels Lohmann 已提交
8952
            return result;
T
Théo DELRIEU 已提交
8953
        }
T
Théo Delrieu 已提交
8954

T
Théo DELRIEU 已提交
8955 8956 8957 8958 8959
        primitive_iterator_t& operator--()
        {
            --m_it;
            return *this;
        }
T
Théo Delrieu 已提交
8960

N
Niels Lohmann 已提交
8961
        primitive_iterator_t operator--(int)
T
Théo DELRIEU 已提交
8962
        {
N
Niels Lohmann 已提交
8963
            auto result = *this;
T
Théo DELRIEU 已提交
8964
            m_it--;
N
Niels Lohmann 已提交
8965
            return result;
T
Théo DELRIEU 已提交
8966
        }
T
Théo Delrieu 已提交
8967

T
Théo DELRIEU 已提交
8968 8969 8970 8971 8972
        primitive_iterator_t& operator+=(difference_type n)
        {
            m_it += n;
            return *this;
        }
8973

T
Théo DELRIEU 已提交
8974 8975 8976 8977 8978
        primitive_iterator_t& operator-=(difference_type n)
        {
            m_it -= n;
            return *this;
        }
8979

T
Théo DELRIEU 已提交
8980 8981 8982
      private:
        static constexpr difference_type begin_value = 0;
        static constexpr difference_type end_value = begin_value + 1;
8983

T
Théo DELRIEU 已提交
8984 8985 8986
        /// iterator as signed integer type
        difference_type m_it = std::numeric_limits<std::ptrdiff_t>::denorm_min();
    };
8987

N
Niels 已提交
8988 8989 8990 8991 8992 8993 8994 8995
    /*!
    @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 已提交
8996 8997
    {
        /// iterator for JSON objects
N
Niels 已提交
8998
        typename object_t::iterator object_iterator;
N
Niels 已提交
8999
        /// iterator for JSON arrays
N
Niels 已提交
9000
        typename array_t::iterator array_iterator;
N
Niels 已提交
9001
        /// generic iterator for all other types
N
Niels 已提交
9002 9003 9004
        primitive_iterator_t primitive_iterator;

        /// create an uninitialized internal_iterator
N
Niels 已提交
9005
        internal_iterator() noexcept
T
Théo DELRIEU 已提交
9006 9007
            : object_iterator(), array_iterator(), primitive_iterator()
        {}
N
Niels 已提交
9008 9009
    };

N
cleanup  
Niels 已提交
9010 9011 9012 9013
    /// proxy class for the iterator_wrapper functions
    template<typename IteratorType>
    class iteration_proxy
    {
T
Théo DELRIEU 已提交
9014
      private:
N
cleanup  
Niels 已提交
9015 9016 9017
        /// helper class for iteration
        class iteration_proxy_internal
        {
T
Théo DELRIEU 已提交
9018
          private:
N
cleanup  
Niels 已提交
9019 9020 9021 9022 9023
            /// the iterator
            IteratorType anchor;
            /// an index for arrays (used to create key names)
            size_t array_index = 0;

T
Théo DELRIEU 已提交
9024
          public:
N
Niels 已提交
9025
            explicit iteration_proxy_internal(IteratorType it) noexcept
T
Théo DELRIEU 已提交
9026 9027
                : anchor(it)
            {}
N
cleanup  
Niels 已提交
9028

T
Théo DELRIEU 已提交
9029 9030 9031 9032 9033
            /// dereference operator (needed for range-based for)
            iteration_proxy_internal& operator*()
            {
                return *this;
            }
9034

T
Théo DELRIEU 已提交
9035 9036 9037 9038 9039
            /// increment operator (needed for range-based for)
            iteration_proxy_internal& operator++()
            {
                ++anchor;
                ++array_index;
9040

T
Théo DELRIEU 已提交
9041 9042
                return *this;
            }
N
cleanup  
Niels 已提交
9043

T
Théo DELRIEU 已提交
9044 9045
            /// inequality operator (needed for range-based for)
            bool operator!= (const iteration_proxy_internal& o) const
N
cleanup  
Niels 已提交
9046
            {
T
Théo DELRIEU 已提交
9047
                return anchor != o.anchor;
N
cleanup  
Niels 已提交
9048 9049
            }

T
Théo DELRIEU 已提交
9050 9051
            /// return key of the iterator
            typename basic_json::string_t key() const
N
cleanup  
Niels 已提交
9052
            {
T
Théo DELRIEU 已提交
9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074
                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 已提交
9075 9076
            }

T
Théo DELRIEU 已提交
9077 9078
            /// return value of the iterator
            typename IteratorType::reference value() const
N
cleanup  
Niels 已提交
9079
            {
T
Théo DELRIEU 已提交
9080
                return anchor.value();
N
cleanup  
Niels 已提交
9081 9082 9083
            }
        };

T
Théo DELRIEU 已提交
9084 9085
        /// the container to iterate
        typename IteratorType::reference container;
N
cleanup  
Niels 已提交
9086

T
Théo DELRIEU 已提交
9087 9088 9089 9090 9091
      public:
        /// construct iteration proxy from a container
        explicit iteration_proxy(typename IteratorType::reference cont)
            : container(cont)
        {}
N
cleanup  
Niels 已提交
9092

T
Théo DELRIEU 已提交
9093 9094 9095 9096 9097
        /// return iterator begin (needed for range-based for)
        iteration_proxy_internal begin() noexcept
        {
            return iteration_proxy_internal(container.begin());
        }
N
cleanup  
Niels 已提交
9098

T
Théo DELRIEU 已提交
9099 9100 9101 9102 9103 9104
        /// return iterator end (needed for range-based for)
        iteration_proxy_internal end() noexcept
        {
            return iteration_proxy_internal(container.end());
        }
    };
N
cleanup  
Niels 已提交
9105

N
Niels 已提交
9106
  public:
N
Niels 已提交
9107
    /*!
9108
    @brief a template for a random access iterator for the @ref basic_json class
N
Niels 已提交
9109

N
Niels Lohmann 已提交
9110 9111
    This class implements a both iterators (iterator and const_iterator) for the
    @ref basic_json class.
N
Niels 已提交
9112

N
Niels 已提交
9113 9114 9115
    @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 已提交
9116 9117
          methods are undefined. **The library uses assertions to detect calls
          on uninitialized iterators.**
N
Niels 已提交
9118

N
Niels 已提交
9119 9120 9121 9122
    @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 已提交
9123

N
Niels Lohmann 已提交
9124
    @since version 1.0.0, simplified in version 2.0.9
N
Niels 已提交
9125
    */
N
Niels Lohmann 已提交
9126
    template<typename U>
T
Théo DELRIEU 已提交
9127
    class iter_impl : public std::iterator<std::random_access_iterator_tag, U>
N
Niels 已提交
9128
    {
N
Niels 已提交
9129
        /// allow basic_json to access private members
9130 9131
        friend class basic_json;

9132 9133 9134 9135 9136
        // 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 已提交
9137
      public:
N
Niels 已提交
9138
        /// the type of the values when the iterator is dereferenced
N
Niels 已提交
9139
        using value_type = typename basic_json::value_type;
N
Niels 已提交
9140
        /// a type to represent differences between iterators
N
Niels 已提交
9141
        using difference_type = typename basic_json::difference_type;
N
Niels 已提交
9142
        /// defines a pointer to the type iterated over (value_type)
9143
        using pointer = typename std::conditional<std::is_const<U>::value,
T
Théo DELRIEU 已提交
9144 9145
              typename basic_json::const_pointer,
              typename basic_json::pointer>::type;
N
Niels 已提交
9146
        /// defines a reference to the type iterated over (value_type)
9147
        using reference = typename std::conditional<std::is_const<U>::value,
T
Théo DELRIEU 已提交
9148 9149
              typename basic_json::const_reference,
              typename basic_json::reference>::type;
N
Niels 已提交
9150
        /// the category of the iterator
N
Niels 已提交
9151
        using iterator_category = std::bidirectional_iterator_tag;
N
Niels 已提交
9152

9153
        /// default constructor
9154
        iter_impl() = default;
9155

N
Niels 已提交
9156 9157 9158 9159 9160 9161
        /*!
        @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`.
        */
9162
        explicit iter_impl(pointer object) noexcept
T
Théo DELRIEU 已提交
9163
            : m_object(object)
9164
        {
T
Théo DELRIEU 已提交
9165
            assert(m_object != nullptr);
9166

T
Théo DELRIEU 已提交
9167
            switch (m_object->m_type)
9168
            {
T
Théo DELRIEU 已提交
9169 9170 9171 9172 9173
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = typename object_t::iterator();
                    break;
                }
9174

T
Théo DELRIEU 已提交
9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185
                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 已提交
9186 9187
            }
        }
N
Niels 已提交
9188

T
Théo DELRIEU 已提交
9189 9190 9191 9192
        /*
        Use operator `const_iterator` instead of `const_iterator(const iterator&
        other) noexcept` to avoid two class definitions for @ref iterator and
        @ref const_iterator.
9193

T
Théo DELRIEU 已提交
9194 9195 9196 9197
        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 已提交
9198
        {
T
Théo DELRIEU 已提交
9199
            const_iterator ret;
N
Niels 已提交
9200

T
Théo DELRIEU 已提交
9201 9202 9203 9204 9205
            if (m_object)
            {
                ret.m_object = m_object;
                ret.m_it = m_it;
            }
9206

T
Théo DELRIEU 已提交
9207 9208
            return ret;
        }
N
Niels 已提交
9209

T
Théo DELRIEU 已提交
9210 9211 9212 9213 9214 9215 9216 9217
        /*!
        @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 已提交
9218

T
Théo DELRIEU 已提交
9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234
        /*!
        @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 已提交
9235

T
Théo DELRIEU 已提交
9236 9237 9238 9239 9240 9241
      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 已提交
9242
        {
T
Théo DELRIEU 已提交
9243
            assert(m_object != nullptr);
N
Niels 已提交
9244

T
Théo DELRIEU 已提交
9245
            switch (m_object->m_type)
N
Niels 已提交
9246
            {
T
Théo DELRIEU 已提交
9247 9248 9249 9250 9251
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = m_object->m_value.object->begin();
                    break;
                }
N
Niels 已提交
9252

T
Théo DELRIEU 已提交
9253 9254 9255 9256 9257
                case basic_json::value_t::array:
                {
                    m_it.array_iterator = m_object->m_value.array->begin();
                    break;
                }
N
Niels 已提交
9258

T
Théo DELRIEU 已提交
9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270
                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 已提交
9271 9272 9273
            }
        }

T
Théo DELRIEU 已提交
9274 9275 9276 9277 9278
        /*!
        @brief set the iterator past the last value
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        void set_end() noexcept
9279
        {
T
Théo DELRIEU 已提交
9280
            assert(m_object != nullptr);
N
Niels 已提交
9281

T
Théo DELRIEU 已提交
9282
            switch (m_object->m_type)
9283
            {
T
Théo DELRIEU 已提交
9284 9285 9286 9287 9288
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = m_object->m_value.object->end();
                    break;
                }
N
Niels 已提交
9289

T
Théo DELRIEU 已提交
9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300
                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 已提交
9301 9302
            }
        }
N
Niels 已提交
9303

T
Théo DELRIEU 已提交
9304 9305 9306 9307 9308 9309
      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
9310
        {
T
Théo DELRIEU 已提交
9311
            assert(m_object != nullptr);
N
Niels 已提交
9312

T
Théo DELRIEU 已提交
9313
            switch (m_object->m_type)
9314
            {
T
Théo DELRIEU 已提交
9315 9316 9317 9318 9319
                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 已提交
9320

T
Théo DELRIEU 已提交
9321 9322 9323 9324 9325
                case basic_json::value_t::array:
                {
                    assert(m_it.array_iterator != m_object->m_value.array->end());
                    return *m_it.array_iterator;
                }
N
Niels 已提交
9326

T
Théo DELRIEU 已提交
9327
                case basic_json::value_t::null:
N
Niels 已提交
9328
                {
9329
                    JSON_THROW(invalid_iterator(214, "cannot get value"));
N
Niels 已提交
9330 9331
                }

T
Théo DELRIEU 已提交
9332 9333 9334 9335 9336 9337 9338
                default:
                {
                    if (m_it.primitive_iterator.is_begin())
                    {
                        return *m_object;
                    }

9339
                    JSON_THROW(invalid_iterator(214, "cannot get value"));
T
Théo DELRIEU 已提交
9340
                }
N
Niels 已提交
9341 9342 9343
            }
        }

T
Théo DELRIEU 已提交
9344 9345 9346 9347 9348
        /*!
        @brief dereference the iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        pointer operator->() const
N
Niels 已提交
9349
        {
T
Théo DELRIEU 已提交
9350
            assert(m_object != nullptr);
N
Niels 已提交
9351

T
Théo DELRIEU 已提交
9352
            switch (m_object->m_type)
N
Niels 已提交
9353
            {
T
Théo DELRIEU 已提交
9354 9355 9356 9357 9358
                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 已提交
9359

T
Théo DELRIEU 已提交
9360
                case basic_json::value_t::array:
N
Niels 已提交
9361
                {
T
Théo DELRIEU 已提交
9362 9363
                    assert(m_it.array_iterator != m_object->m_value.array->end());
                    return &*m_it.array_iterator;
N
Niels 已提交
9364 9365
                }

T
Théo DELRIEU 已提交
9366 9367 9368 9369 9370 9371 9372
                default:
                {
                    if (m_it.primitive_iterator.is_begin())
                    {
                        return m_object;
                    }

9373
                    JSON_THROW(invalid_iterator(214, "cannot get value"));
T
Théo DELRIEU 已提交
9374
                }
N
Niels 已提交
9375 9376 9377
            }
        }

T
Théo DELRIEU 已提交
9378 9379 9380 9381 9382 9383 9384 9385 9386 9387
        /*!
        @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 已提交
9388

T
Théo DELRIEU 已提交
9389 9390 9391 9392 9393
        /*!
        @brief pre-increment (++it)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator++()
9394
        {
T
Théo DELRIEU 已提交
9395
            assert(m_object != nullptr);
N
Niels 已提交
9396

T
Théo DELRIEU 已提交
9397
            switch (m_object->m_type)
9398
            {
T
Théo DELRIEU 已提交
9399 9400 9401 9402 9403
                case basic_json::value_t::object:
                {
                    std::advance(m_it.object_iterator, 1);
                    break;
                }
N
Niels 已提交
9404

T
Théo DELRIEU 已提交
9405 9406 9407 9408 9409
                case basic_json::value_t::array:
                {
                    std::advance(m_it.array_iterator, 1);
                    break;
                }
N
Niels 已提交
9410

T
Théo DELRIEU 已提交
9411 9412 9413 9414 9415 9416
                default:
                {
                    ++m_it.primitive_iterator;
                    break;
                }
            }
9417

T
Théo DELRIEU 已提交
9418 9419
            return *this;
        }
9420

T
Théo DELRIEU 已提交
9421 9422 9423 9424 9425 9426 9427 9428 9429 9430
        /*!
        @brief post-decrement (it--)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl operator--(int)
        {
            auto result = *this;
            --(*this);
            return result;
        }
9431

T
Théo DELRIEU 已提交
9432 9433 9434 9435 9436
        /*!
        @brief pre-decrement (--it)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator--()
N
Niels 已提交
9437
        {
T
Théo DELRIEU 已提交
9438 9439 9440
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
9441
            {
T
Théo DELRIEU 已提交
9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458
                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 已提交
9459 9460
            }

T
Théo DELRIEU 已提交
9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471
            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 已提交
9472
            {
9473
                JSON_THROW(invalid_iterator(212, "cannot compare iterators of different containers"));
9474
            }
N
Niels 已提交
9475

T
Théo DELRIEU 已提交
9476 9477 9478
            assert(m_object != nullptr);

            switch (m_object->m_type)
9479
            {
T
Théo DELRIEU 已提交
9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493
                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 已提交
9494 9495 9496
            }
        }

T
Théo DELRIEU 已提交
9497 9498 9499 9500 9501
        /*!
        @brief  comparison: not equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator!=(const iter_impl& other) const
N
Niels 已提交
9502
        {
T
Théo DELRIEU 已提交
9503
            return not operator==(other);
N
Niels 已提交
9504 9505
        }

T
Théo DELRIEU 已提交
9506 9507 9508 9509 9510
        /*!
        @brief  comparison: smaller
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator<(const iter_impl& other) const
N
Niels 已提交
9511
        {
T
Théo DELRIEU 已提交
9512 9513
            // if objects are not the same, the comparison is undefined
            if (m_object != other.m_object)
N
Niels 已提交
9514
            {
9515
                JSON_THROW(invalid_iterator(212, "cannot compare iterators of different containers"));
N
Niels 已提交
9516 9517
            }

T
Théo DELRIEU 已提交
9518
            assert(m_object != nullptr);
N
Niels 已提交
9519

T
Théo DELRIEU 已提交
9520
            switch (m_object->m_type)
9521
            {
T
Théo DELRIEU 已提交
9522 9523
                case basic_json::value_t::object:
                {
9524
                    JSON_THROW(invalid_iterator(213, "cannot compare order of object iterators"));
T
Théo DELRIEU 已提交
9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535
                }

                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 已提交
9536 9537 9538
            }
        }

T
Théo DELRIEU 已提交
9539 9540 9541 9542 9543
        /*!
        @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 已提交
9544
        {
T
Théo DELRIEU 已提交
9545
            return not other.operator < (*this);
N
Niels 已提交
9546 9547
        }

T
Théo DELRIEU 已提交
9548 9549 9550 9551 9552
        /*!
        @brief  comparison: greater than
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator>(const iter_impl& other) const
N
Niels 已提交
9553
        {
T
Théo DELRIEU 已提交
9554
            return not operator<=(other);
N
Niels 已提交
9555
        }
9556

T
Théo DELRIEU 已提交
9557 9558 9559 9560 9561 9562 9563 9564
        /*!
        @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);
        }
9565

T
Théo DELRIEU 已提交
9566 9567 9568 9569 9570
        /*!
        @brief  add to iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator+=(difference_type i)
N
Niels 已提交
9571
        {
T
Théo DELRIEU 已提交
9572 9573 9574
            assert(m_object != nullptr);

            switch (m_object->m_type)
9575
            {
T
Théo DELRIEU 已提交
9576 9577
                case basic_json::value_t::object:
                {
9578
                    JSON_THROW(invalid_iterator(209, "cannot use offsets with object iterators"));
T
Théo DELRIEU 已提交
9579
                }
9580

T
Théo DELRIEU 已提交
9581 9582 9583 9584 9585
                case basic_json::value_t::array:
                {
                    std::advance(m_it.array_iterator, i);
                    break;
                }
9586

T
Théo DELRIEU 已提交
9587 9588 9589 9590 9591
                default:
                {
                    m_it.primitive_iterator += i;
                    break;
                }
9592 9593
            }

T
Théo DELRIEU 已提交
9594 9595
            return *this;
        }
9596

T
Théo DELRIEU 已提交
9597 9598 9599 9600 9601 9602 9603 9604
        /*!
        @brief  subtract from iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator-=(difference_type i)
        {
            return operator+=(-i);
        }
9605

T
Théo DELRIEU 已提交
9606 9607 9608 9609 9610 9611 9612 9613 9614 9615
        /*!
        @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;
        }
9616

T
Théo DELRIEU 已提交
9617 9618 9619 9620 9621 9622 9623 9624 9625 9626
        /*!
        @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 已提交
9627

T
Théo DELRIEU 已提交
9628 9629 9630 9631 9632
        /*!
        @brief  return difference
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        difference_type operator-(const iter_impl& other) const
9633
        {
T
Théo DELRIEU 已提交
9634 9635 9636
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
9637
            {
T
Théo DELRIEU 已提交
9638 9639
                case basic_json::value_t::object:
                {
9640
                    JSON_THROW(invalid_iterator(209, "cannot use offsets with object iterators"));
T
Théo DELRIEU 已提交
9641
                }
N
Niels 已提交
9642

T
Théo DELRIEU 已提交
9643 9644 9645 9646
                case basic_json::value_t::array:
                {
                    return m_it.array_iterator - other.m_it.array_iterator;
                }
N
Niels 已提交
9647

T
Théo DELRIEU 已提交
9648 9649 9650 9651
                default:
                {
                    return m_it.primitive_iterator - other.m_it.primitive_iterator;
                }
N
Niels 已提交
9652 9653
            }
        }
N
Niels 已提交
9654

T
Théo DELRIEU 已提交
9655 9656 9657 9658 9659
        /*!
        @brief  access to successor
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        reference operator[](difference_type n) const
9660
        {
T
Théo DELRIEU 已提交
9661 9662 9663
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
9664
            {
T
Théo DELRIEU 已提交
9665 9666
                case basic_json::value_t::object:
                {
9667
                    JSON_THROW(invalid_iterator(208, "cannot use operator[] for object iterators"));
T
Théo DELRIEU 已提交
9668
                }
N
Niels 已提交
9669

T
Théo DELRIEU 已提交
9670 9671 9672 9673
                case basic_json::value_t::array:
                {
                    return *std::next(m_it.array_iterator, n);
                }
N
Niels 已提交
9674

T
Théo DELRIEU 已提交
9675 9676
                case basic_json::value_t::null:
                {
9677
                    JSON_THROW(invalid_iterator(214, "cannot get value"));
T
Théo DELRIEU 已提交
9678
                }
N
Niels 已提交
9679

T
Théo DELRIEU 已提交
9680
                default:
N
Niels 已提交
9681
                {
T
Théo DELRIEU 已提交
9682 9683 9684 9685
                    if (m_it.primitive_iterator.get_value() == -n)
                    {
                        return *m_object;
                    }
N
Niels Lohmann 已提交
9686

9687
                    JSON_THROW(invalid_iterator(214, "cannot get value"));
T
Théo DELRIEU 已提交
9688
                }
N
Niels 已提交
9689 9690
            }
        }
N
Niels 已提交
9691

T
Théo DELRIEU 已提交
9692 9693 9694 9695 9696
        /*!
        @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
9697
        {
T
Théo DELRIEU 已提交
9698 9699 9700 9701 9702 9703
            assert(m_object != nullptr);

            if (m_object->is_object())
            {
                return m_it.object_iterator->first;
            }
N
Niels Lohmann 已提交
9704

9705
            JSON_THROW(invalid_iterator(207, "cannot use key() for non-object iterators"));
T
Théo DELRIEU 已提交
9706
        }
N
Niels 已提交
9707

T
Théo DELRIEU 已提交
9708 9709 9710 9711 9712 9713 9714 9715
        /*!
        @brief  return the value of an iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        reference value() const
        {
            return operator*();
        }
N
Niels 已提交
9716

T
Théo DELRIEU 已提交
9717 9718 9719 9720 9721 9722
      private:
        /// associated JSON instance
        pointer m_object = nullptr;
        /// the actual iterator of the associated instance
        internal_iterator m_it = internal_iterator();
    };
N
Niels 已提交
9723

N
Niels 已提交
9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737
    /*!
    @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 已提交
9738

N
Niels 已提交
9739
    @since version 1.0.0
N
Niels 已提交
9740
    */
N
Niels 已提交
9741
    template<typename Base>
T
Théo DELRIEU 已提交
9742
    class json_reverse_iterator : public std::reverse_iterator<Base>
9743
    {
T
Théo DELRIEU 已提交
9744
      public:
9745
        /// shortcut to the reverse iterator adaptor
N
Niels 已提交
9746
        using base_iterator = std::reverse_iterator<Base>;
N
Niels 已提交
9747
        /// the reference type for the pointed-to element
N
Niels 已提交
9748
        using reference = typename Base::reference;
9749

9750
        /// create reverse iterator from iterator
N
Niels 已提交
9751
        json_reverse_iterator(const typename base_iterator::iterator_type& it) noexcept
T
Théo DELRIEU 已提交
9752 9753
            : base_iterator(it)
        {}
9754

T
Théo DELRIEU 已提交
9755 9756 9757 9758
        /// create reverse iterator from base class
        json_reverse_iterator(const base_iterator& it) noexcept
            : base_iterator(it)
        {}
9759

T
Théo DELRIEU 已提交
9760 9761 9762 9763 9764
        /// post-increment (it++)
        json_reverse_iterator operator++(int)
        {
            return base_iterator::operator++(1);
        }
9765

T
Théo DELRIEU 已提交
9766 9767 9768 9769 9770 9771
        /// pre-increment (++it)
        json_reverse_iterator& operator++()
        {
            base_iterator::operator++();
            return *this;
        }
9772

T
Théo DELRIEU 已提交
9773 9774 9775 9776 9777
        /// post-decrement (it--)
        json_reverse_iterator operator--(int)
        {
            return base_iterator::operator--(1);
        }
9778

T
Théo DELRIEU 已提交
9779 9780 9781 9782 9783 9784
        /// pre-decrement (--it)
        json_reverse_iterator& operator--()
        {
            base_iterator::operator--();
            return *this;
        }
9785

T
Théo DELRIEU 已提交
9786 9787 9788 9789 9790 9791
        /// add to iterator
        json_reverse_iterator& operator+=(difference_type i)
        {
            base_iterator::operator+=(i);
            return *this;
        }
9792

T
Théo DELRIEU 已提交
9793 9794 9795 9796 9797 9798 9799
        /// add to iterator
        json_reverse_iterator operator+(difference_type i) const
        {
            auto result = *this;
            result += i;
            return result;
        }
9800

T
Théo DELRIEU 已提交
9801 9802 9803 9804 9805 9806 9807
        /// subtract from iterator
        json_reverse_iterator operator-(difference_type i) const
        {
            auto result = *this;
            result -= i;
            return result;
        }
9808

T
Théo DELRIEU 已提交
9809 9810 9811 9812 9813
        /// return difference
        difference_type operator-(const json_reverse_iterator& other) const
        {
            return this->base() - other.base();
        }
9814

T
Théo DELRIEU 已提交
9815 9816 9817 9818 9819
        /// access to successor
        reference operator[](difference_type n) const
        {
            return *(this->operator+(n));
        }
N
Niels 已提交
9820

T
Théo DELRIEU 已提交
9821 9822 9823 9824 9825 9826
        /// return the key of an object iterator
        typename object_t::key_type key() const
        {
            auto it = --this->base();
            return it.key();
        }
9827

T
Théo DELRIEU 已提交
9828 9829 9830 9831 9832 9833 9834
        /// return the value of an iterator
        reference value() const
        {
            auto it = --this->base();
            return it.operator * ();
        }
    };
9835

N
Niels 已提交
9836

N
Niels 已提交
9837
  private:
N
Niels 已提交
9838 9839 9840
    //////////////////////
    // lexer and parser //
    //////////////////////
N
Niels 已提交
9841

N
Niels 已提交
9842 9843 9844 9845
    /*!
    @brief lexical analysis

    This class organizes the lexical analysis during JSON deserialization. The
N
Niels 已提交
9846 9847
    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 已提交
9848
    */
N
Niels 已提交
9849
    class lexer
N
Niels 已提交
9850
    {
T
Théo DELRIEU 已提交
9851
      public:
N
Niels 已提交
9852 9853
        /// token types for the parser
        enum class token_type
T
Théo DELRIEU 已提交
9854 9855 9856 9857 9858 9859
        {
            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 已提交
9860 9861
            value_unsigned,  ///< an unsigned integer -- use get_number() for actual value
            value_integer,   ///< a signed integer -- use get_number() for actual value
9862
            value_float,     ///< an floating point number -- use get_number() for actual value
T
Théo DELRIEU 已提交
9863 9864 9865 9866 9867 9868 9869 9870 9871
            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 已提交
9872

T
Théo DELRIEU 已提交
9873 9874
        /// the char type to use in the lexer
        using lexer_char_t = unsigned char;
N
Niels 已提交
9875

T
Théo DELRIEU 已提交
9876 9877 9878 9879 9880 9881 9882 9883
        /// 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 已提交
9884

T
Théo DELRIEU 已提交
9885 9886 9887
        /// a lexer from an input stream
        explicit lexer(std::istream& s)
            : m_stream(&s), m_line_buffer()
N
Niels 已提交
9888
        {
T
Théo DELRIEU 已提交
9889 9890 9891
            // immediately abort if stream is erroneous
            if (s.fail())
            {
9892
                JSON_THROW(parse_error(111, 0, "bad input stream"));
T
Théo DELRIEU 已提交
9893
            }
N
Niels 已提交
9894

T
Théo DELRIEU 已提交
9895 9896
            // fill buffer
            fill_line_buffer();
N
Niels 已提交
9897

T
Théo DELRIEU 已提交
9898 9899 9900 9901 9902 9903 9904
            // 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] = ' ';
            }
9905
        }
N
Niels 已提交
9906

T
Théo DELRIEU 已提交
9907 9908 9909 9910
        // switch off unwanted functions (due to pointer members)
        lexer() = delete;
        lexer(const lexer&) = delete;
        lexer operator=(const lexer&) = delete;
N
Niels 已提交
9911

T
Théo DELRIEU 已提交
9912 9913
        /*!
        @brief create a string from one or two Unicode code points
N
Niels 已提交
9914

T
Théo DELRIEU 已提交
9915 9916 9917 9918
        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 已提交
9919

T
Théo DELRIEU 已提交
9920 9921
        @param[in] codepoint1  the code point (can be high surrogate)
        @param[in] codepoint2  the code point (can be low surrogate or 0)
N
Niels 已提交
9922

T
Théo DELRIEU 已提交
9923 9924
        @return string representation of the code point; the length of the
        result string is between 1 and 4 characters.
N
Niels 已提交
9925

9926
        @throw parse_error.102 if the low surrogate is invalid; example:
T
Théo DELRIEU 已提交
9927
        `""missing or wrong low surrogate""`
9928 9929
        @throw parse_error.103 if code point is > 0x10ffff; example: `"code
        points above 0x10FFFF are invalid"`
N
Niels 已提交
9930

T
Théo DELRIEU 已提交
9931
        @complexity Constant.
N
Niels 已提交
9932

T
Théo DELRIEU 已提交
9933 9934
        @see <http://en.wikipedia.org/wiki/UTF-8#Sample_code>
        */
9935 9936
        string_t to_unicode(const std::size_t codepoint1,
                            const std::size_t codepoint2 = 0) const
9937
        {
T
Théo DELRIEU 已提交
9938 9939 9940 9941 9942
            // 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 已提交
9943
            {
T
Théo DELRIEU 已提交
9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958
                // 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
                {
9959
                    JSON_THROW(parse_error(102, get_position(), "missing or wrong low surrogate"));
T
Théo DELRIEU 已提交
9960
                }
N
Niels 已提交
9961 9962
            }

T
Théo DELRIEU 已提交
9963
            string_t result;
9964

T
Théo DELRIEU 已提交
9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992
            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
            {
9993
                JSON_THROW(parse_error(103, get_position(), "code points above 0x10FFFF are invalid"));
T
Théo DELRIEU 已提交
9994
            }
9995

T
Théo DELRIEU 已提交
9996 9997
            return result;
        }
9998

T
Théo DELRIEU 已提交
9999 10000 10001 10002
        /// 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 已提交
10003
            {
T
Théo DELRIEU 已提交
10004 10005 10006 10007 10008 10009 10010 10011 10012 10013
                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 已提交
10014 10015
                case lexer::token_type::value_unsigned:
                case lexer::token_type::value_integer:
10016
                case lexer::token_type::value_float:
T
Théo DELRIEU 已提交
10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038
                    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 已提交
10039 10040 10041
            }
        }

T
Théo DELRIEU 已提交
10042 10043 10044 10045 10046 10047 10048
        /*!
        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 已提交
10049

T
Théo DELRIEU 已提交
10050
        @return the class of the next token read from the buffer
N
Niels 已提交
10051

T
Théo DELRIEU 已提交
10052
        @complexity Linear in the length of the input.\n
N
Niels 已提交
10053

T
Théo DELRIEU 已提交
10054
        Proposition: The loop below will always terminate for finite input.\n
N
Niels 已提交
10055

T
Théo DELRIEU 已提交
10056 10057 10058 10059 10060 10061 10062 10063
        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 已提交
10064
        {
T
Théo DELRIEU 已提交
10065 10066 10067 10068
            while (true)
            {
                // pointer for backtracking information
                m_marker = nullptr;
N
Niels 已提交
10069

T
Théo DELRIEU 已提交
10070 10071 10072
                // remember the begin of the token
                m_start = m_cursor;
                assert(m_start != nullptr);
N
Niels 已提交
10073

10074 10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192 10193 10194 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

                {
                    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;
                            }
                        }
                    }
10228
basic_json_parser_2:
10229 10230 10231 10232 10233
                    ++m_cursor;
                    {
                        last_token_type = token_type::end_of_input;
                        break;
                    }
N
Niels 已提交
10234
basic_json_parser_4:
10235
                    ++m_cursor;
N
Niels 已提交
10236
basic_json_parser_5:
10237 10238 10239 10240
                    {
                        last_token_type = token_type::parse_error;
                        break;
                    }
N
Niels 已提交
10241
basic_json_parser_6:
10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252
                    ++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;
                    }
                    {
10253
                        position += static_cast<size_t>((m_cursor - m_start));
10254 10255
                        continue;
                    }
N
Niels 已提交
10256
basic_json_parser_9:
10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275
                    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;
10276
basic_json_parser_10:
10277 10278 10279 10280 10281
                    ++m_cursor;
                    {
                        last_token_type = token_type::value_separator;
                        break;
                    }
10282
basic_json_parser_12:
10283 10284 10285 10286 10287 10288 10289
                    yych = *++m_cursor;
                    if (yych <= '/')
                    {
                        goto basic_json_parser_5;
                    }
                    if (yych <= '0')
                    {
10290
                        goto basic_json_parser_43;
10291 10292 10293
                    }
                    if (yych <= '9')
                    {
10294
                        goto basic_json_parser_45;
10295 10296
                    }
                    goto basic_json_parser_5;
10297
basic_json_parser_13:
10298 10299
                    yyaccept = 1;
                    yych = *(m_marker = ++m_cursor);
N
Niels Lohmann 已提交
10300
                    if (yych <= '9')
10301 10302 10303
                    {
                        if (yych == '.')
                        {
10304
                            goto basic_json_parser_47;
10305
                        }
N
Niels Lohmann 已提交
10306 10307 10308 10309
                        if (yych >= '0')
                        {
                            goto basic_json_parser_48;
                        }
10310 10311 10312 10313 10314
                    }
                    else
                    {
                        if (yych <= 'E')
                        {
N
Niels Lohmann 已提交
10315 10316 10317 10318
                            if (yych >= 'E')
                            {
                                goto basic_json_parser_51;
                            }
10319
                        }
N
Niels Lohmann 已提交
10320
                        else
10321
                        {
N
Niels Lohmann 已提交
10322 10323 10324 10325
                            if (yych == 'e')
                            {
                                goto basic_json_parser_51;
                            }
10326 10327
                        }
                    }
10328
basic_json_parser_14:
10329
                    {
N
Niels Lohmann 已提交
10330
                        last_token_type = token_type::value_unsigned;
10331 10332
                        break;
                    }
10333
basic_json_parser_15:
10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348
                    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 == '.')
                        {
10349
                            goto basic_json_parser_47;
10350 10351 10352 10353 10354 10355 10356
                        }
                        goto basic_json_parser_14;
                    }
                    else
                    {
                        if (yych <= 'E')
                        {
N
Niels Lohmann 已提交
10357
                            goto basic_json_parser_51;
10358 10359 10360
                        }
                        if (yych == 'e')
                        {
N
Niels Lohmann 已提交
10361
                            goto basic_json_parser_51;
10362 10363 10364
                        }
                        goto basic_json_parser_14;
                    }
10365
basic_json_parser_17:
10366 10367 10368 10369 10370
                    ++m_cursor;
                    {
                        last_token_type = token_type::name_separator;
                        break;
                    }
10371
basic_json_parser_19:
10372 10373 10374 10375 10376
                    ++m_cursor;
                    {
                        last_token_type = token_type::begin_array;
                        break;
                    }
10377
basic_json_parser_21:
10378 10379 10380 10381 10382
                    ++m_cursor;
                    {
                        last_token_type = token_type::end_array;
                        break;
                    }
10383
basic_json_parser_23:
10384 10385 10386 10387
                    yyaccept = 0;
                    yych = *(m_marker = ++m_cursor);
                    if (yych == 'a')
                    {
N
Niels Lohmann 已提交
10388
                        goto basic_json_parser_52;
10389 10390
                    }
                    goto basic_json_parser_5;
10391
basic_json_parser_24:
10392 10393 10394 10395
                    yyaccept = 0;
                    yych = *(m_marker = ++m_cursor);
                    if (yych == 'u')
                    {
N
Niels Lohmann 已提交
10396
                        goto basic_json_parser_53;
10397 10398
                    }
                    goto basic_json_parser_5;
10399
basic_json_parser_25:
10400 10401 10402 10403
                    yyaccept = 0;
                    yych = *(m_marker = ++m_cursor);
                    if (yych == 'r')
                    {
N
Niels Lohmann 已提交
10404
                        goto basic_json_parser_54;
10405 10406
                    }
                    goto basic_json_parser_5;
10407
basic_json_parser_26:
10408 10409 10410 10411 10412
                    ++m_cursor;
                    {
                        last_token_type = token_type::begin_object;
                        break;
                    }
10413
basic_json_parser_28:
10414 10415 10416 10417 10418
                    ++m_cursor;
                    {
                        last_token_type = token_type::end_object;
                        break;
                    }
10419
basic_json_parser_30:
10420 10421 10422 10423 10424 10425
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
10426
basic_json_parser_31:
10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483
                    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;
                            }
                        }
                    }
10484
basic_json_parser_32:
10485
                    m_cursor = m_marker;
10486
                    if (yyaccept <= 1)
10487
                    {
10488 10489 10490 10491 10492 10493 10494 10495
                        if (yyaccept == 0)
                        {
                            goto basic_json_parser_5;
                        }
                        else
                        {
                            goto basic_json_parser_14;
                        }
10496 10497 10498
                    }
                    else
                    {
10499 10500 10501 10502 10503 10504
                        if (yyaccept == 2)
                        {
                            goto basic_json_parser_44;
                        }
                        else
                        {
N
Niels Lohmann 已提交
10505
                            goto basic_json_parser_58;
10506
                        }
10507
                    }
10508
basic_json_parser_33:
10509 10510 10511 10512 10513
                    ++m_cursor;
                    {
                        last_token_type = token_type::value_string;
                        break;
                    }
10514
basic_json_parser_35:
10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 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
                    ++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 已提交
10587
                                    goto basic_json_parser_55;
10588 10589 10590 10591 10592
                                }
                                goto basic_json_parser_32;
                            }
                        }
                    }
10593
basic_json_parser_36:
10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608
                    ++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;
10609
basic_json_parser_37:
10610 10611 10612 10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624
                    ++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;
10625
basic_json_parser_38:
10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640
                    ++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 已提交
10641
basic_json_parser_39:
10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656
                    ++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 已提交
10657
basic_json_parser_40:
10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672
                    ++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 已提交
10673
basic_json_parser_41:
10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688
                    ++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 已提交
10689
basic_json_parser_42:
10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704
                    ++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 已提交
10705
basic_json_parser_43:
10706 10707
                    yyaccept = 2;
                    yych = *(m_marker = ++m_cursor);
N
Niels Lohmann 已提交
10708
                    if (yych <= '9')
10709 10710 10711 10712 10713
                    {
                        if (yych == '.')
                        {
                            goto basic_json_parser_47;
                        }
N
Niels Lohmann 已提交
10714 10715 10716 10717
                        if (yych >= '0')
                        {
                            goto basic_json_parser_48;
                        }
10718 10719 10720 10721 10722
                    }
                    else
                    {
                        if (yych <= 'E')
                        {
N
Niels Lohmann 已提交
10723 10724 10725 10726
                            if (yych >= 'E')
                            {
                                goto basic_json_parser_51;
                            }
10727
                        }
N
Niels Lohmann 已提交
10728
                        else
10729
                        {
N
Niels Lohmann 已提交
10730 10731 10732 10733
                            if (yych == 'e')
                            {
                                goto basic_json_parser_51;
                            }
10734 10735 10736 10737
                        }
                    }
basic_json_parser_44:
                    {
N
Niels Lohmann 已提交
10738
                        last_token_type = token_type::value_integer;
10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764 10765 10766 10767 10768
                        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 已提交
10769
                            goto basic_json_parser_51;
10770 10771 10772 10773 10774
                        }
                        else
                        {
                            if (yych == 'e')
                            {
N
Niels Lohmann 已提交
10775
                                goto basic_json_parser_51;
10776 10777 10778 10779 10780
                            }
                            goto basic_json_parser_44;
                        }
                    }
basic_json_parser_47:
10781 10782 10783 10784 10785 10786 10787
                    yych = *++m_cursor;
                    if (yych <= '/')
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= '9')
                    {
N
Niels Lohmann 已提交
10788
                        goto basic_json_parser_56;
10789 10790
                    }
                    goto basic_json_parser_32;
10791
basic_json_parser_48:
N
Niels Lohmann 已提交
10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811
                    ++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:
10812 10813 10814 10815 10816
                    yych = *++m_cursor;
                    if (yych <= ',')
                    {
                        if (yych == '+')
                        {
N
Niels Lohmann 已提交
10817
                            goto basic_json_parser_59;
10818 10819 10820 10821 10822 10823 10824
                        }
                        goto basic_json_parser_32;
                    }
                    else
                    {
                        if (yych <= '-')
                        {
N
Niels Lohmann 已提交
10825
                            goto basic_json_parser_59;
10826 10827 10828 10829 10830 10831 10832
                        }
                        if (yych <= '/')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= '9')
                        {
N
Niels Lohmann 已提交
10833
                            goto basic_json_parser_60;
10834 10835 10836
                        }
                        goto basic_json_parser_32;
                    }
N
Niels Lohmann 已提交
10837
basic_json_parser_52:
10838 10839 10840
                    yych = *++m_cursor;
                    if (yych == 'l')
                    {
N
Niels Lohmann 已提交
10841
                        goto basic_json_parser_62;
10842 10843
                    }
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10844
basic_json_parser_53:
10845 10846 10847
                    yych = *++m_cursor;
                    if (yych == 'l')
                    {
N
Niels Lohmann 已提交
10848
                        goto basic_json_parser_63;
10849 10850
                    }
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10851
basic_json_parser_54:
10852 10853 10854
                    yych = *++m_cursor;
                    if (yych == 'u')
                    {
N
Niels Lohmann 已提交
10855
                        goto basic_json_parser_64;
10856 10857
                    }
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10858
basic_json_parser_55:
10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872
                    ++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 已提交
10873
                            goto basic_json_parser_65;
10874 10875 10876 10877 10878 10879 10880
                        }
                        goto basic_json_parser_32;
                    }
                    else
                    {
                        if (yych <= 'F')
                        {
N
Niels Lohmann 已提交
10881
                            goto basic_json_parser_65;
10882 10883 10884 10885 10886 10887 10888
                        }
                        if (yych <= '`')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= 'f')
                        {
N
Niels Lohmann 已提交
10889
                            goto basic_json_parser_65;
10890 10891 10892
                        }
                        goto basic_json_parser_32;
                    }
N
Niels Lohmann 已提交
10893
basic_json_parser_56:
10894
                    yyaccept = 3;
10895 10896 10897 10898 10899 10900 10901 10902 10903 10904
                    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 已提交
10905
                            goto basic_json_parser_58;
10906 10907 10908
                        }
                        if (yych <= '9')
                        {
N
Niels Lohmann 已提交
10909
                            goto basic_json_parser_56;
10910 10911 10912 10913 10914 10915
                        }
                    }
                    else
                    {
                        if (yych <= 'E')
                        {
N
Niels Lohmann 已提交
10916
                            goto basic_json_parser_51;
10917 10918 10919
                        }
                        if (yych == 'e')
                        {
N
Niels Lohmann 已提交
10920
                            goto basic_json_parser_51;
10921 10922
                        }
                    }
N
Niels Lohmann 已提交
10923
basic_json_parser_58:
10924 10925 10926 10927
                    {
                        last_token_type = token_type::value_float;
                        break;
                    }
N
Niels Lohmann 已提交
10928
basic_json_parser_59:
10929 10930 10931 10932 10933 10934 10935 10936 10937
                    yych = *++m_cursor;
                    if (yych <= '/')
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych >= ':')
                    {
                        goto basic_json_parser_32;
                    }
N
Niels Lohmann 已提交
10938
basic_json_parser_60:
10939 10940 10941 10942 10943 10944 10945 10946
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= '/')
                    {
N
Niels Lohmann 已提交
10947
                        goto basic_json_parser_58;
10948 10949 10950
                    }
                    if (yych <= '9')
                    {
N
Niels Lohmann 已提交
10951
                        goto basic_json_parser_60;
10952
                    }
N
Niels Lohmann 已提交
10953 10954
                    goto basic_json_parser_58;
basic_json_parser_62:
10955 10956 10957
                    yych = *++m_cursor;
                    if (yych == 's')
                    {
N
Niels Lohmann 已提交
10958
                        goto basic_json_parser_66;
10959 10960
                    }
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10961
basic_json_parser_63:
10962 10963 10964
                    yych = *++m_cursor;
                    if (yych == 'l')
                    {
N
Niels Lohmann 已提交
10965
                        goto basic_json_parser_67;
10966 10967
                    }
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10968
basic_json_parser_64:
10969 10970 10971
                    yych = *++m_cursor;
                    if (yych == 'e')
                    {
N
Niels Lohmann 已提交
10972
                        goto basic_json_parser_69;
10973 10974
                    }
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10975
basic_json_parser_65:
10976 10977 10978 10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989
                    ++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 已提交
10990
                            goto basic_json_parser_71;
10991 10992 10993 10994 10995 10996 10997
                        }
                        goto basic_json_parser_32;
                    }
                    else
                    {
                        if (yych <= 'F')
                        {
N
Niels Lohmann 已提交
10998
                            goto basic_json_parser_71;
10999 11000 11001 11002 11003 11004 11005
                        }
                        if (yych <= '`')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= 'f')
                        {
N
Niels Lohmann 已提交
11006
                            goto basic_json_parser_71;
11007 11008 11009
                        }
                        goto basic_json_parser_32;
                    }
N
Niels Lohmann 已提交
11010
basic_json_parser_66:
11011 11012 11013
                    yych = *++m_cursor;
                    if (yych == 'e')
                    {
N
Niels Lohmann 已提交
11014
                        goto basic_json_parser_72;
11015 11016
                    }
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
11017
basic_json_parser_67:
11018 11019 11020 11021 11022
                    ++m_cursor;
                    {
                        last_token_type = token_type::literal_null;
                        break;
                    }
N
Niels Lohmann 已提交
11023
basic_json_parser_69:
11024 11025 11026 11027 11028
                    ++m_cursor;
                    {
                        last_token_type = token_type::literal_true;
                        break;
                    }
N
Niels Lohmann 已提交
11029
basic_json_parser_71:
11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043
                    ++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 已提交
11044
                            goto basic_json_parser_74;
11045 11046 11047 11048 11049 11050 11051
                        }
                        goto basic_json_parser_32;
                    }
                    else
                    {
                        if (yych <= 'F')
                        {
N
Niels Lohmann 已提交
11052
                            goto basic_json_parser_74;
11053 11054 11055 11056 11057 11058 11059
                        }
                        if (yych <= '`')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= 'f')
                        {
N
Niels Lohmann 已提交
11060
                            goto basic_json_parser_74;
11061 11062 11063
                        }
                        goto basic_json_parser_32;
                    }
N
Niels Lohmann 已提交
11064
basic_json_parser_72:
11065 11066 11067 11068 11069
                    ++m_cursor;
                    {
                        last_token_type = token_type::literal_false;
                        break;
                    }
N
Niels Lohmann 已提交
11070
basic_json_parser_74:
11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105
                    ++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;
                    }
                }
11106

T
Théo DELRIEU 已提交
11107
            }
11108

11109
            position += static_cast<size_t>((m_cursor - m_start));
T
Théo DELRIEU 已提交
11110 11111
            return last_token_type;
        }
11112

T
Théo DELRIEU 已提交
11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145
        /*!
        @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 已提交
11146

T
Théo DELRIEU 已提交
11147 11148 11149
            // 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 已提交
11150

T
Théo DELRIEU 已提交
11151 11152 11153 11154 11155
            // 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 已提交
11156

T
Théo DELRIEU 已提交
11157
            // number of processed characters (p)
N
Niels Lohmann 已提交
11158
            const auto num_processed_chars = static_cast<size_t>(m_start - m_content);
T
Théo DELRIEU 已提交
11159 11160 11161 11162
            // 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 已提交
11163

T
Théo DELRIEU 已提交
11164 11165 11166 11167
            // 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 已提交
11168
                // this point. We trust the standard library to do the right
T
Théo DELRIEU 已提交
11169 11170
                // thing. See http://stackoverflow.com/q/28142011/266378
                m_line_buffer.assign(m_start, m_limit);
11171

T
Théo DELRIEU 已提交
11172 11173 11174 11175 11176 11177 11178 11179 11180
                // 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
11181
            {
T
Théo DELRIEU 已提交
11182 11183 11184 11185 11186 11187 11188 11189 11190
                // 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');
11191
            }
11192

T
Théo DELRIEU 已提交
11193 11194 11195 11196 11197 11198 11199
            // 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 已提交
11200 11201
        }

T
Théo DELRIEU 已提交
11202 11203 11204 11205 11206 11207 11208
        /// 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));
        }
11209

T
Théo DELRIEU 已提交
11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 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
        /*!
        @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 已提交
11256
        indefinitely if i is always decreased. However, observe that the value
T
Théo DELRIEU 已提交
11257 11258 11259 11260 11261 11262 11263 11264
        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
11265 11266
        @throw parse_error.102 if to_unicode fails
        @throw parse_error.103 if to_unicode fails
T
Théo DELRIEU 已提交
11267 11268 11269 11270
        */
        string_t get_string() const
        {
            assert(m_cursor - m_start >= 2);
11271

T
Théo DELRIEU 已提交
11272 11273
            string_t result;
            result.reserve(static_cast<size_t>(m_cursor - m_start - 2));
11274

T
Théo DELRIEU 已提交
11275 11276
            // iterate the result between the quotes
            for (const lexer_char_t* i = m_start + 1; i < m_cursor - 1; ++i)
N
Niels 已提交
11277
            {
T
Théo DELRIEU 已提交
11278 11279 11280
                // find next escape character
                auto e = std::find(i, m_cursor - 1, '\\');
                if (e != i)
N
Niels 已提交
11281
                {
T
Théo DELRIEU 已提交
11282 11283
                    // see https://github.com/nlohmann/json/issues/365#issuecomment-262874705
                    for (auto k = i; k < e; k++)
11284
                    {
T
Théo DELRIEU 已提交
11285
                        result.push_back(static_cast<typename string_t::value_type>(*k));
11286
                    }
T
Théo DELRIEU 已提交
11287 11288 11289 11290 11291 11292 11293
                    i = e - 1; // -1 because of ++i
                }
                else
                {
                    // processing escaped character
                    // read next character
                    ++i;
N
Niels 已提交
11294

T
Théo DELRIEU 已提交
11295
                    switch (*i)
N
Niels 已提交
11296
                    {
T
Théo DELRIEU 已提交
11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337
                        // 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 已提交
11338

T
Théo DELRIEU 已提交
11339 11340
                        // unicode
                        case 'u':
N
Niels 已提交
11341
                        {
T
Théo DELRIEU 已提交
11342 11343 11344 11345 11346 11347
                            // 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 已提交
11348
                            {
T
Théo DELRIEU 已提交
11349 11350 11351
                                // make sure there is a subsequent unicode
                                if ((i + 6 >= m_limit) or * (i + 5) != '\\' or * (i + 6) != 'u')
                                {
11352
                                    JSON_THROW(parse_error(102, get_position(), "missing low surrogate"));
T
Théo DELRIEU 已提交
11353 11354 11355 11356 11357 11358 11359 11360
                                }

                                // 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 已提交
11361
                            }
T
Théo DELRIEU 已提交
11362 11363 11364
                            else if (codepoint >= 0xDC00 and codepoint <= 0xDFFF)
                            {
                                // we found a lone low surrogate
11365
                                JSON_THROW(parse_error(102, get_position(), "missing high surrogate"));
T
Théo DELRIEU 已提交
11366 11367 11368 11369 11370 11371 11372 11373 11374
                            }
                            else
                            {
                                // add unicode character(s)
                                result += to_unicode(codepoint);
                                // skip the next four characters (xxxx)
                                i += 4;
                            }
                            break;
N
Niels 已提交
11375 11376 11377 11378
                        }
                    }
                }
            }
T
Théo DELRIEU 已提交
11379 11380

            return result;
N
Niels 已提交
11381 11382
        }

11383

T
Théo DELRIEU 已提交
11384
        /*!
N
Niels Lohmann 已提交
11385 11386
        @brief parse string into a built-in arithmetic type as if the current
               locale is POSIX.
11387

N
Niels Lohmann 已提交
11388 11389
        @note in floating-point case strtod may parse past the token's end -
              this is not an error
11390

N
Niels Lohmann 已提交
11391
        @note any leading blanks are not handled
T
Théo DELRIEU 已提交
11392
        */
11393
        struct strtonum
T
Théo DELRIEU 已提交
11394
        {
11395
          public:
11396
            strtonum(const char* start, const char* end)
11397 11398
                : m_start(start), m_end(end)
            {}
11399

N
Niels Lohmann 已提交
11400 11401 11402 11403 11404 11405 11406
            /*!
            @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>
11407 11408 11409 11410
            bool to(T& val) const
            {
                return parse(val, std::is_integral<T>());
            }
N
Niels 已提交
11411

11412
          private:
11413
            const char* const m_start = nullptr;
N
Niels Lohmann 已提交
11414
            const char* const m_end = nullptr;
N
Niels 已提交
11415

11416 11417
            // floating-point conversion

A
Alex Astashyn 已提交
11418 11419
            // overloaded wrappers for strtod/strtof/strtold
            // that will be called from parse<floating_point_t>
N
Niels Lohmann 已提交
11420
            static void strtof(float& f, const char* str, char** endptr)
11421
            {
11422
                f = std::strtof(str, endptr);
N
Niels 已提交
11423 11424
            }

N
Niels Lohmann 已提交
11425
            static void strtof(double& f, const char* str, char** endptr)
T
Théo DELRIEU 已提交
11426
            {
11427
                f = std::strtod(str, endptr);
T
Théo DELRIEU 已提交
11428
            }
N
Niels 已提交
11429

N
Niels Lohmann 已提交
11430
            static void strtof(long double& f, const char* str, char** endptr)
T
Théo DELRIEU 已提交
11431
            {
11432
                f = std::strtold(str, endptr);
T
Théo DELRIEU 已提交
11433
            }
11434

11435 11436
            template<typename T>
            bool parse(T& value, /*is_integral=*/std::false_type) const
T
Théo DELRIEU 已提交
11437
            {
N
Niels Lohmann 已提交
11438 11439 11440
                // 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.
11441 11442
                std::string tempstr;
                std::array<char, 64> buf;
11443 11444
                const size_t len = static_cast<size_t>(m_end - m_start);

11445 11446 11447
                // lexer will reject empty numbers
                assert(len > 0);

N
Niels Lohmann 已提交
11448 11449 11450
                // 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
11451 11452
                const auto loc = localeconv();
                assert(loc != nullptr);
N
Niels Lohmann 已提交
11453
                const char decimal_point_char = (loc->decimal_point == nullptr) ? '.' : loc->decimal_point[0];
11454 11455 11456

                const char* data = m_start;

11457
                if (decimal_point_char != '.')
T
Théo DELRIEU 已提交
11458
                {
N
Niels Lohmann 已提交
11459
                    const size_t ds_pos = static_cast<size_t>(std::find(m_start, m_end, '.') - m_start);
11460

11461
                    if (ds_pos != len)
T
Théo DELRIEU 已提交
11462
                    {
N
Niels Lohmann 已提交
11463 11464 11465 11466
                        // 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())
11467
                        {
11468
                            std::copy(m_start, m_end, buf.begin());
11469 11470 11471 11472 11473 11474 11475 11476 11477 11478
                            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 已提交
11479 11480
                    }
                }
11481

11482 11483
                char* endptr = nullptr;
                value = 0;
11484
                // this calls appropriate overload depending on T
11485
                strtof(value, data, &endptr);
T
Théo DELRIEU 已提交
11486

11487 11488 11489
                // parsing was successful iff strtof parsed exactly the number
                // of characters determined by the lexer (len)
                const bool ok = (endptr == (data + len));
11490

11491
                if (ok and (value == static_cast<T>(0.0)) and (*data == '-'))
A
Alex Astashyn 已提交
11492
                {
11493 11494
                    // some implementations forget to negate the zero
                    value = -0.0;
N
Niels 已提交
11495
                }
N
Niels 已提交
11496

11497
                return ok;
N
Niels 已提交
11498
            }
11499

11500 11501
            // integral conversion

N
Niels Lohmann 已提交
11502
            signed long long parse_integral(char** endptr, /*is_signed*/std::true_type) const
11503 11504
            {
                return std::strtoll(m_start, endptr, 10);
11505
            }
N
Niels 已提交
11506

N
Niels Lohmann 已提交
11507
            unsigned long long parse_integral(char** endptr, /*is_signed*/std::false_type) const
T
Théo DELRIEU 已提交
11508
            {
11509
                return std::strtoull(m_start, endptr, 10);
T
Théo DELRIEU 已提交
11510
            }
11511 11512 11513

            template<typename T>
            bool parse(T& value, /*is_integral=*/std::true_type) const
N
Niels 已提交
11514
            {
11515
                char* endptr = nullptr;
N
Niels Lohmann 已提交
11516
                errno = 0; // these are thread-local
11517
                const auto x = parse_integral(&endptr, std::is_signed<T>());
N
Niels Lohmann 已提交
11518

N
Niels Lohmann 已提交
11519 11520
                // called right overload?
                static_assert(std::is_signed<T>() == std::is_signed<decltype(x)>(), "");
11521 11522 11523

                value = static_cast<T>(x);

N
Niels Lohmann 已提交
11524 11525
                return (x == static_cast<decltype(x)>(value)) // x fits into destination T
                       and (x < 0) == (value < 0)             // preserved sign
11526
                       //and ((x != 0) or is_integral())        // strto[u]ll did nto fail
N
Niels Lohmann 已提交
11527 11528 11529
                       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
11530
            }
11531 11532 11533 11534 11535 11536 11537 11538
        };

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

11540 11541
        integral numbers that don't fit into the the range of the respective
        type are parsed as number_float_t
N
Niels 已提交
11542

11543 11544
        floating-point values do not satisfy std::isfinite predicate
        are converted to value_t::null
11545 11546

        throws if the entire string [m_start .. m_cursor) cannot be
11547 11548 11549
        interpreted as a number

        @param[out] result  @ref basic_json object to receive the number.
11550
        @param[in]  token   the type of the number token
11551
        */
11552
        bool get_number(basic_json& result, const token_type token) const
11553 11554 11555
        {
            assert(m_start != nullptr);
            assert(m_start < m_cursor);
N
Niels Lohmann 已提交
11556 11557
            assert((token == token_type::value_unsigned) or
                   (token == token_type::value_integer) or
11558
                   (token == token_type::value_float));
11559

N
Niels Lohmann 已提交
11560 11561
            strtonum num_converter(reinterpret_cast<const char*>(m_start),
                                   reinterpret_cast<const char*>(m_cursor));
11562

11563
            switch (token)
11564
            {
N
Niels Lohmann 已提交
11565
                case lexer::token_type::value_unsigned:
N
Niels Lohmann 已提交
11566
                {
N
Niels Lohmann 已提交
11567 11568
                    number_unsigned_t val;
                    if (num_converter.to(val))
11569
                    {
11570
                        // parsing successful
11571 11572
                        result.m_type = value_t::number_unsigned;
                        result.m_value = val;
11573
                        return true;
11574 11575
                    }
                    break;
N
Niels Lohmann 已提交
11576
                }
11577

N
Niels Lohmann 已提交
11578
                case lexer::token_type::value_integer:
11579
                {
N
Niels Lohmann 已提交
11580 11581
                    number_integer_t val;
                    if (num_converter.to(val))
11582
                    {
11583
                        // parsing successful
11584 11585
                        result.m_type = value_t::number_integer;
                        result.m_value = val;
11586
                        return true;
11587 11588 11589 11590 11591
                    }
                    break;
                }

                default:
T
Théo DELRIEU 已提交
11592
                {
11593
                    break;
T
Théo DELRIEU 已提交
11594 11595 11596
                }
            }

N
Niels Lohmann 已提交
11597 11598 11599
            // parse float (either explicitly or because a previous conversion
            // failed)
            number_float_t val;
11600
            if (num_converter.to(val))
A
Alex Astashyn 已提交
11601
            {
11602 11603 11604
                // parsing successful
                result.m_type = value_t::number_float;
                result.m_value = val;
N
Niels 已提交
11605

11606 11607 11608 11609 11610 11611
                // replace infinity and NAN by null
                if (not std::isfinite(result.m_value.number_float))
                {
                    result.m_type  = value_t::null;
                    result.m_value = basic_json::json_value();
                }
11612

11613
                return true;
11614
            }
11615 11616 11617

            // couldn't parse number in any format
            return false;
T
Théo DELRIEU 已提交
11618 11619
        }

11620 11621 11622 11623 11624
        constexpr size_t get_position() const
        {
            return position;
        }

T
Théo DELRIEU 已提交
11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643
      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;
11644 11645
        /// current position in the input (read bytes)
        size_t position = 0;
T
Théo DELRIEU 已提交
11646
    };
N
Niels 已提交
11647

N
Niels 已提交
11648 11649
    /*!
    @brief syntax analysis
N
Niels 已提交
11650 11651

    This class implements a recursive decent parser.
N
Niels 已提交
11652
    */
N
Niels 已提交
11653 11654
    class parser
    {
T
Théo DELRIEU 已提交
11655
      public:
11656
        /// a parser reading from a string literal
N
Niels 已提交
11657
        parser(const char* buff, const parser_callback_t cb = nullptr)
T
Théo DELRIEU 已提交
11658 11659 11660
            : callback(cb),
              m_lexer(reinterpret_cast<const typename lexer::lexer_char_t*>(buff), std::strlen(buff))
        {}
11661

T
Théo DELRIEU 已提交
11662 11663 11664 11665
        /// a parser reading from an input stream
        parser(std::istream& is, const parser_callback_t cb = nullptr)
            : callback(cb), m_lexer(is)
        {}
11666

T
Théo DELRIEU 已提交
11667 11668 11669 11670 11671 11672 11673 11674 11675 11676
        /// 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 已提交
11677

T
Théo DELRIEU 已提交
11678 11679 11680 11681 11682
        /// public parser interface
        basic_json parse()
        {
            // read first token
            get_token();
N
Niels 已提交
11683

T
Théo DELRIEU 已提交
11684 11685
            basic_json result = parse_internal(true);
            result.assert_invariant();
N
Niels 已提交
11686

T
Théo DELRIEU 已提交
11687
            expect(lexer::token_type::end_of_input);
N
Niels 已提交
11688

T
Théo DELRIEU 已提交
11689 11690 11691 11692
            // 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 已提交
11693

T
Théo DELRIEU 已提交
11694 11695 11696
      private:
        /// the actual parser
        basic_json parse_internal(bool keep)
11697
        {
T
Théo DELRIEU 已提交
11698 11699 11700
            auto result = basic_json(value_t::discarded);

            switch (last_token)
N
Niels 已提交
11701
            {
T
Théo DELRIEU 已提交
11702
                case lexer::token_type::begin_object:
N
Niels 已提交
11703
                {
T
Théo DELRIEU 已提交
11704 11705 11706 11707 11708 11709 11710
                    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 已提交
11711

T
Théo DELRIEU 已提交
11712 11713
                    // read next token
                    get_token();
N
Niels 已提交
11714

T
Théo DELRIEU 已提交
11715 11716 11717 11718 11719 11720 11721 11722 11723 11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735 11736 11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771
                    // 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 已提交
11772
                    get_token();
N
Niels 已提交
11773
                    if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
N
Niels 已提交
11774 11775 11776
                    {
                        result = basic_json(value_t::discarded);
                    }
T
Théo DELRIEU 已提交
11777

N
Niels 已提交
11778
                    return result;
N
Niels 已提交
11779 11780
                }

T
Théo DELRIEU 已提交
11781
                case lexer::token_type::begin_array:
11782
                {
T
Théo DELRIEU 已提交
11783 11784 11785 11786 11787 11788 11789 11790 11791 11792 11793 11794 11795
                    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 已提交
11796
                    {
N
Niels 已提交
11797
                        get_token();
T
Théo DELRIEU 已提交
11798 11799 11800 11801 11802
                        if (callback and not callback(--depth, parse_event_t::array_end, result))
                        {
                            result = basic_json(value_t::discarded);
                        }
                        return result;
N
Niels 已提交
11803 11804
                    }

T
Théo DELRIEU 已提交
11805 11806
                    // no comma is expected here
                    unexpect(lexer::token_type::value_separator);
N
Niels 已提交
11807

T
Théo DELRIEU 已提交
11808 11809
                    // otherwise: parse values
                    do
N
Niels 已提交
11810
                    {
T
Théo DELRIEU 已提交
11811 11812
                        // ugly, but could be fixed with loop reorganization
                        if (last_token == lexer::token_type::value_separator)
N
Niels 已提交
11813
                        {
T
Théo DELRIEU 已提交
11814
                            get_token();
N
Niels 已提交
11815
                        }
T
Théo DELRIEU 已提交
11816 11817 11818 11819

                        // parse value
                        auto value = parse_internal(keep);
                        if (keep and not value.is_discarded())
N
Niels 已提交
11820
                        {
T
Théo DELRIEU 已提交
11821
                            result.push_back(std::move(value));
N
Niels 已提交
11822
                        }
N
Niels 已提交
11823
                    }
T
Théo DELRIEU 已提交
11824
                    while (last_token == lexer::token_type::value_separator);
N
Niels 已提交
11825

T
Théo DELRIEU 已提交
11826 11827
                    // closing ]
                    expect(lexer::token_type::end_array);
11828
                    get_token();
T
Théo DELRIEU 已提交
11829
                    if (keep and callback and not callback(--depth, parse_event_t::array_end, result))
N
Niels 已提交
11830
                    {
T
Théo DELRIEU 已提交
11831
                        result = basic_json(value_t::discarded);
N
Niels 已提交
11832
                    }
T
Théo DELRIEU 已提交
11833 11834

                    return result;
N
Niels 已提交
11835 11836
                }

T
Théo DELRIEU 已提交
11837
                case lexer::token_type::literal_null:
N
Niels 已提交
11838
                {
T
Théo DELRIEU 已提交
11839 11840 11841
                    get_token();
                    result.m_type = value_t::null;
                    break;
N
Niels 已提交
11842 11843
                }

T
Théo DELRIEU 已提交
11844
                case lexer::token_type::value_string:
N
Niels 已提交
11845
                {
T
Théo DELRIEU 已提交
11846 11847 11848 11849
                    const auto s = m_lexer.get_string();
                    get_token();
                    result = basic_json(s);
                    break;
N
Niels 已提交
11850 11851
                }

T
Théo DELRIEU 已提交
11852
                case lexer::token_type::literal_true:
N
Niels 已提交
11853
                {
N
Niels 已提交
11854
                    get_token();
T
Théo DELRIEU 已提交
11855 11856 11857
                    result.m_type = value_t::boolean;
                    result.m_value = true;
                    break;
N
Niels 已提交
11858 11859
                }

T
Théo DELRIEU 已提交
11860
                case lexer::token_type::literal_false:
N
Niels 已提交
11861
                {
T
Théo DELRIEU 已提交
11862 11863 11864 11865
                    get_token();
                    result.m_type = value_t::boolean;
                    result.m_value = false;
                    break;
N
Niels 已提交
11866 11867
                }

N
Niels Lohmann 已提交
11868 11869
                case lexer::token_type::value_unsigned:
                case lexer::token_type::value_integer:
11870
                case lexer::token_type::value_float:
N
Niels 已提交
11871
                {
N
Niels Lohmann 已提交
11872
                    m_lexer.get_number(result, last_token);
T
Théo DELRIEU 已提交
11873 11874
                    get_token();
                    break;
N
Niels 已提交
11875
                }
11876

T
Théo DELRIEU 已提交
11877 11878 11879 11880 11881
                default:
                {
                    // the last token was unexpected
                    unexpect(last_token);
                }
11882 11883
            }

T
Théo DELRIEU 已提交
11884
            if (keep and callback and not callback(depth, parse_event_t::value, result))
11885
            {
T
Théo DELRIEU 已提交
11886
                result = basic_json(value_t::discarded);
N
Niels 已提交
11887
            }
T
Théo DELRIEU 已提交
11888
            return result;
N
Niels 已提交
11889 11890
        }

T
Théo DELRIEU 已提交
11891 11892
        /// get next token from lexer
        typename lexer::token_type get_token()
N
Niels 已提交
11893
        {
T
Théo DELRIEU 已提交
11894 11895
            last_token = m_lexer.scan();
            return last_token;
N
Niels 已提交
11896 11897
        }

T
Théo DELRIEU 已提交
11898
        void expect(typename lexer::token_type t) const
N
Niels 已提交
11899
        {
T
Théo DELRIEU 已提交
11900 11901 11902 11903 11904 11905 11906
            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);
11907
                JSON_THROW(parse_error(101, m_lexer.get_position(), error_msg));
T
Théo DELRIEU 已提交
11908
            }
N
Niels 已提交
11909 11910
        }

T
Théo DELRIEU 已提交
11911
        void unexpect(typename lexer::token_type t) const
N
Niels 已提交
11912
        {
T
Théo DELRIEU 已提交
11913 11914 11915 11916 11917 11918
            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));
11919
                JSON_THROW(parse_error(101, m_lexer.get_position(), error_msg));
T
Théo DELRIEU 已提交
11920
            }
N
Niels 已提交
11921 11922
        }

T
Théo DELRIEU 已提交
11923 11924 11925 11926 11927 11928 11929 11930 11931 11932
      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 已提交
11933 11934

  public:
N
Niels 已提交
11935 11936 11937
    /*!
    @brief JSON Pointer

N
Niels 已提交
11938 11939 11940 11941
    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 已提交
11942
    @sa [RFC 6901](https://tools.ietf.org/html/rfc6901)
N
Niels 已提交
11943 11944

    @since version 2.0.0
N
Niels 已提交
11945
    */
N
Niels 已提交
11946 11947
    class json_pointer
    {
N
Niels 已提交
11948 11949 11950
        /// allow basic_json to access private members
        friend class basic_json;

T
Théo DELRIEU 已提交
11951
      public:
N
Niels 已提交
11952 11953 11954 11955 11956 11957 11958 11959 11960 11961
        /*!
        @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

11962
        @throw parse_error.107 if reference token is nonempty and does not
N
Niels 已提交
11963
        begin with a slash (`/`); example: `"JSON pointer must be empty or
11964 11965 11966 11967
        begin with / - was: 'foo'"`
        @throw parse_error.108 if a tilde (`~`) is not followed by `0`
        (representing `~`) or `1` (representing `/`); example: `"escape
        character '~' must be followed with '0' or '1'"`
N
Niels 已提交
11968 11969 11970

        @liveexample{The example shows the construction several valid JSON
        pointers as well as the exceptional behavior.,json_pointer}
N
Niels 已提交
11971

N
Niels 已提交
11972 11973 11974
        @since version 2.0.0
        */
        explicit json_pointer(const std::string& s = "")
T
Théo DELRIEU 已提交
11975 11976
            : reference_tokens(split(s))
        {}
N
Niels 已提交
11977

T
Théo DELRIEU 已提交
11978 11979
        /*!
        @brief return a string representation of the JSON pointer
N
Niels 已提交
11980

T
Théo DELRIEU 已提交
11981 11982 11983 11984
        @invariant For each JSON pointer `ptr`, it holds:
        @code {.cpp}
        ptr == json_pointer(ptr.to_string());
        @endcode
N
Niels 已提交
11985

T
Théo DELRIEU 已提交
11986
        @return a string representation of the JSON pointer
N
Niels 已提交
11987

T
Théo DELRIEU 已提交
11988 11989
        @liveexample{The example shows the result of `to_string`.,
        json_pointer__to_string}
N
Niels 已提交
11990

T
Théo DELRIEU 已提交
11991 11992 11993
        @since version 2.0.0
        */
        std::string to_string() const noexcept
N
Niels 已提交
11994
        {
T
Théo DELRIEU 已提交
11995 11996 11997 11998 11999 12000 12001
            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 已提交
12002

T
Théo DELRIEU 已提交
12003 12004
        /// @copydoc to_string()
        operator std::string() const
N
Niels 已提交
12005
        {
T
Théo DELRIEU 已提交
12006
            return to_string();
N
Niels 已提交
12007 12008
        }

T
Théo DELRIEU 已提交
12009 12010 12011 12012 12013 12014
      private:
        /// remove and return last reference pointer
        std::string pop_back()
        {
            if (is_root())
            {
12015
                JSON_THROW(out_of_range(405, "JSON pointer has no parent"));
T
Théo DELRIEU 已提交
12016
            }
12017

T
Théo DELRIEU 已提交
12018 12019 12020 12021
            auto last = reference_tokens.back();
            reference_tokens.pop_back();
            return last;
        }
N
Niels 已提交
12022

T
Théo DELRIEU 已提交
12023 12024
        /// return whether pointer points to the root document
        bool is_root() const
N
Niels 已提交
12025
        {
T
Théo DELRIEU 已提交
12026
            return reference_tokens.empty();
N
Niels 已提交
12027 12028
        }

T
Théo DELRIEU 已提交
12029 12030 12031 12032
        json_pointer top() const
        {
            if (is_root())
            {
12033
                JSON_THROW(out_of_range(405, "JSON pointer has no parent"));
T
Théo DELRIEU 已提交
12034
            }
N
Niels 已提交
12035

T
Théo DELRIEU 已提交
12036 12037 12038 12039
            json_pointer result = *this;
            result.reference_tokens = {reference_tokens[0]};
            return result;
        }
N
Niels 已提交
12040

T
Théo DELRIEU 已提交
12041 12042
        /*!
        @brief create and return a reference to the pointed to value
12043

T
Théo DELRIEU 已提交
12044 12045 12046
        @complexity Linear in the number of reference tokens.
        */
        reference get_and_create(reference j) const
12047
        {
T
Théo DELRIEU 已提交
12048 12049 12050 12051 12052
            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 已提交
12053
            {
T
Théo DELRIEU 已提交
12054
                switch (result->m_type)
N
Niels 已提交
12055
                {
T
Théo DELRIEU 已提交
12056
                    case value_t::null:
N
Niels 已提交
12057
                    {
T
Théo DELRIEU 已提交
12058 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068
                        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 已提交
12069
                    }
T
Théo DELRIEU 已提交
12070 12071

                    case value_t::object:
N
Niels 已提交
12072
                    {
T
Théo DELRIEU 已提交
12073
                        // create an entry in the object
N
Niels 已提交
12074
                        result = &result->operator[](reference_token);
T
Théo DELRIEU 已提交
12075
                        break;
N
Niels 已提交
12076
                    }
N
Niels 已提交
12077

T
Théo DELRIEU 已提交
12078 12079 12080
                    case value_t::array:
                    {
                        // create an entry in the array
12081 12082 12083 12084 12085 12086 12087 12088
                        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 已提交
12089 12090
                        break;
                    }
12091

T
Théo DELRIEU 已提交
12092 12093 12094 12095 12096 12097 12098 12099 12100
                    /*
                    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:
                    {
12101
                        JSON_THROW(type_error(313, "invalid value to unflatten"));
T
Théo DELRIEU 已提交
12102
                    }
N
Niels 已提交
12103 12104
                }
            }
12105

T
Théo DELRIEU 已提交
12106 12107
            return *result;
        }
12108

T
Théo DELRIEU 已提交
12109 12110
        /*!
        @brief return a reference to the pointed to value
12111

T
Théo DELRIEU 已提交
12112 12113 12114 12115 12116
        @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 已提交
12117

T
Théo DELRIEU 已提交
12118
        @param[in] ptr  a JSON value
N
Niels 已提交
12119

T
Théo DELRIEU 已提交
12120
        @return reference to the JSON value pointed to by the JSON pointer
N
Niels 已提交
12121

T
Théo DELRIEU 已提交
12122
        @complexity Linear in the length of the JSON pointer.
12123

12124
        @throw out_of_range.404       if the JSON pointer can not be resolved
12125
        @throw parse_error.106        if an array index begins with '0'
T
Théo DELRIEU 已提交
12126 12127 12128
        @throw std::invalid_argument  if an array index was not a number
        */
        reference get_unchecked(pointer ptr) const
12129
        {
T
Théo DELRIEU 已提交
12130
            for (const auto& reference_token : reference_tokens)
12131
            {
T
Théo DELRIEU 已提交
12132 12133
                // convert null values to arrays or objects before continuing
                if (ptr->m_type == value_t::null)
12134
                {
T
Théo DELRIEU 已提交
12135 12136 12137 12138
                    // check if reference token is a number
                    const bool nums = std::all_of(reference_token.begin(),
                                                  reference_token.end(),
                                                  [](const char x)
N
Niels 已提交
12139
                    {
T
Théo DELRIEU 已提交
12140 12141
                        return std::isdigit(x);
                    });
N
Niels 已提交
12142

T
Théo DELRIEU 已提交
12143 12144 12145
                    // change value to array for numbers or "-" or to object
                    // otherwise
                    if (nums or reference_token == "-")
N
Niels 已提交
12146
                    {
T
Théo DELRIEU 已提交
12147
                        *ptr = value_t::array;
N
Niels 已提交
12148 12149 12150
                    }
                    else
                    {
T
Théo DELRIEU 已提交
12151
                        *ptr = value_t::object;
N
Niels 已提交
12152
                    }
N
Niels 已提交
12153 12154
                }

T
Théo DELRIEU 已提交
12155
                switch (ptr->m_type)
N
Niels 已提交
12156
                {
T
Théo DELRIEU 已提交
12157 12158 12159 12160 12161 12162 12163 12164 12165 12166 12167 12168
                    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')
                        {
12169
                            JSON_THROW(parse_error(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
12170 12171 12172 12173
                        }

                        if (reference_token == "-")
                        {
N
Niels Lohmann 已提交
12174
                            // explicitly treat "-" as index beyond the end
T
Théo DELRIEU 已提交
12175 12176 12177 12178 12179
                            ptr = &ptr->operator[](ptr->m_value.array->size());
                        }
                        else
                        {
                            // convert array index to number; unchecked access
12180 12181 12182 12183 12184 12185 12186 12187
                            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 已提交
12188 12189 12190 12191 12192 12193
                        }
                        break;
                    }

                    default:
                    {
12194
                        JSON_THROW(out_of_range(404, "unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
12195
                    }
N
Niels 已提交
12196 12197
                }
            }
N
Niels 已提交
12198

T
Théo DELRIEU 已提交
12199 12200
            return *ptr;
        }
12201

T
Théo DELRIEU 已提交
12202
        reference get_checked(pointer ptr) const
N
Niels 已提交
12203
        {
T
Théo DELRIEU 已提交
12204
            for (const auto& reference_token : reference_tokens)
N
Niels 已提交
12205
            {
T
Théo DELRIEU 已提交
12206
                switch (ptr->m_type)
12207
                {
T
Théo DELRIEU 已提交
12208
                    case value_t::object:
N
Niels 已提交
12209
                    {
T
Théo DELRIEU 已提交
12210 12211 12212
                        // note: at performs range check
                        ptr = &ptr->at(reference_token);
                        break;
N
Niels 已提交
12213 12214
                    }

T
Théo DELRIEU 已提交
12215
                    case value_t::array:
N
Niels 已提交
12216
                    {
T
Théo DELRIEU 已提交
12217 12218 12219
                        if (reference_token == "-")
                        {
                            // "-" always fails the range check
12220 12221 12222
                            JSON_THROW(out_of_range(402, "array index '-' (" +
                                                    std::to_string(ptr->m_value.array->size()) +
                                                    ") is out of range"));
T
Théo DELRIEU 已提交
12223 12224 12225 12226 12227
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
12228
                            JSON_THROW(parse_error(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
12229
                        }
N
Niels 已提交
12230

T
Théo DELRIEU 已提交
12231
                        // note: at performs range check
12232 12233 12234 12235 12236 12237 12238 12239
                        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 已提交
12240 12241
                        break;
                    }
12242

T
Théo DELRIEU 已提交
12243 12244
                    default:
                    {
12245
                        JSON_THROW(out_of_range(404, "unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
12246
                    }
N
Niels 已提交
12247 12248 12249
                }
            }

T
Théo DELRIEU 已提交
12250 12251
            return *ptr;
        }
N
Niels 已提交
12252

T
Théo DELRIEU 已提交
12253 12254
        /*!
        @brief return a const reference to the pointed to value
N
Niels 已提交
12255

T
Théo DELRIEU 已提交
12256
        @param[in] ptr  a JSON value
12257

T
Théo DELRIEU 已提交
12258 12259 12260 12261
        @return const reference to the JSON value pointed to by the JSON
                pointer
        */
        const_reference get_unchecked(const_pointer ptr) const
N
Niels 已提交
12262
        {
T
Théo DELRIEU 已提交
12263
            for (const auto& reference_token : reference_tokens)
N
Niels 已提交
12264
            {
T
Théo DELRIEU 已提交
12265
                switch (ptr->m_type)
12266
                {
T
Théo DELRIEU 已提交
12267
                    case value_t::object:
N
Niels 已提交
12268
                    {
T
Théo DELRIEU 已提交
12269 12270 12271
                        // use unchecked object access
                        ptr = &ptr->operator[](reference_token);
                        break;
N
Niels 已提交
12272 12273
                    }

T
Théo DELRIEU 已提交
12274
                    case value_t::array:
N
Niels 已提交
12275
                    {
T
Théo DELRIEU 已提交
12276 12277 12278
                        if (reference_token == "-")
                        {
                            // "-" cannot be used for const access
12279 12280 12281
                            JSON_THROW(out_of_range(402, "array index '-' (" +
                                                    std::to_string(ptr->m_value.array->size()) +
                                                    ") is out of range"));
T
Théo DELRIEU 已提交
12282 12283 12284 12285 12286
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
12287
                            JSON_THROW(parse_error(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
12288
                        }
N
Niels 已提交
12289

T
Théo DELRIEU 已提交
12290
                        // use unchecked array access
12291 12292 12293 12294 12295 12296 12297 12298
                        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 已提交
12299 12300
                        break;
                    }
12301

T
Théo DELRIEU 已提交
12302 12303
                    default:
                    {
12304
                        JSON_THROW(out_of_range(404, "unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
12305
                    }
N
Niels 已提交
12306 12307 12308
                }
            }

T
Théo DELRIEU 已提交
12309 12310
            return *ptr;
        }
12311

T
Théo DELRIEU 已提交
12312
        const_reference get_checked(const_pointer ptr) const
12313
        {
T
Théo DELRIEU 已提交
12314
            for (const auto& reference_token : reference_tokens)
12315
            {
T
Théo DELRIEU 已提交
12316
                switch (ptr->m_type)
12317
                {
T
Théo DELRIEU 已提交
12318
                    case value_t::object:
N
Niels 已提交
12319
                    {
T
Théo DELRIEU 已提交
12320 12321 12322
                        // note: at performs range check
                        ptr = &ptr->at(reference_token);
                        break;
N
Niels 已提交
12323
                    }
12324

T
Théo DELRIEU 已提交
12325
                    case value_t::array:
N
Niels 已提交
12326
                    {
T
Théo DELRIEU 已提交
12327 12328 12329
                        if (reference_token == "-")
                        {
                            // "-" always fails the range check
12330 12331 12332
                            JSON_THROW(out_of_range(402, "array index '-' (" +
                                                    std::to_string(ptr->m_value.array->size()) +
                                                    ") is out of range"));
T
Théo DELRIEU 已提交
12333 12334 12335 12336 12337
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
12338
                            JSON_THROW(parse_error(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
12339
                        }
12340

T
Théo DELRIEU 已提交
12341
                        // note: at performs range check
12342 12343 12344 12345 12346 12347 12348 12349
                        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 已提交
12350 12351
                        break;
                    }
12352

T
Théo DELRIEU 已提交
12353 12354
                    default:
                    {
12355
                        JSON_THROW(out_of_range(404, "unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
12356
                    }
12357 12358
                }
            }
N
Niels 已提交
12359

T
Théo DELRIEU 已提交
12360
            return *ptr;
12361 12362
        }

T
Théo DELRIEU 已提交
12363 12364
        /// split the string input to reference tokens
        static std::vector<std::string> split(const std::string& reference_string)
12365
        {
T
Théo DELRIEU 已提交
12366 12367 12368 12369 12370 12371 12372 12373 12374 12375 12376
            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] != '/')
            {
12377
                JSON_THROW(parse_error(107, 1, "JSON pointer must be empty or begin with '/' - was: '" + reference_string + "'"));
T
Théo DELRIEU 已提交
12378
            }
N
Niels 已提交
12379

T
Théo DELRIEU 已提交
12380 12381 12382 12383 12384
            // 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 已提交
12385
                size_t slash = reference_string.find_first_of('/', 1),
T
Théo DELRIEU 已提交
12386 12387 12388 12389 12390 12391 12392 12393
                // 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 已提交
12394
                slash = reference_string.find_first_of('/', start))
T
Théo DELRIEU 已提交
12395 12396 12397 12398
            {
                // 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 已提交
12399

T
Théo DELRIEU 已提交
12400
                // check reference tokens are properly escaped
N
Niels Lohmann 已提交
12401
                for (size_t pos = reference_token.find_first_of('~');
T
Théo DELRIEU 已提交
12402
                        pos != std::string::npos;
N
Niels Lohmann 已提交
12403
                        pos = reference_token.find_first_of('~', pos + 1))
12404
                {
T
Théo DELRIEU 已提交
12405 12406 12407 12408 12409 12410 12411
                    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'))
                    {
12412
                        JSON_THROW(parse_error(108, 0, "escape character '~' must be followed with '0' or '1'"));
T
Théo DELRIEU 已提交
12413
                    }
N
Niels 已提交
12414
                }
T
Théo DELRIEU 已提交
12415 12416 12417 12418

                // finally, store the reference token
                unescape(reference_token);
                result.push_back(reference_token);
12419
            }
N
Niels 已提交
12420

T
Théo DELRIEU 已提交
12421
            return result;
N
Niels 已提交
12422
        }
N
Niels 已提交
12423

T
Théo DELRIEU 已提交
12424 12425 12426
      private:
        /*!
        @brief replace all occurrences of a substring by another string
N
Niels 已提交
12427

T
Théo DELRIEU 已提交
12428 12429 12430 12431
        @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 已提交
12432

T
Théo DELRIEU 已提交
12433
        @pre The search string @a f must not be empty.
N
Niels 已提交
12434

T
Théo DELRIEU 已提交
12435 12436 12437 12438 12439 12440 12441
        @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 已提交
12442

T
Théo DELRIEU 已提交
12443 12444 12445 12446 12447 12448 12449
            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 已提交
12450

T
Théo DELRIEU 已提交
12451 12452 12453 12454 12455 12456 12457 12458
        /// 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 已提交
12459

T
Théo DELRIEU 已提交
12460 12461 12462 12463 12464 12465 12466 12467
        /// 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 已提交
12468

T
Théo DELRIEU 已提交
12469 12470 12471 12472
        /*!
        @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
12473

T
Théo DELRIEU 已提交
12474 12475 12476 12477 12478
        @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 已提交
12479
        {
T
Théo DELRIEU 已提交
12480
            switch (value.m_type)
N
Niels 已提交
12481
            {
T
Théo DELRIEU 已提交
12482
                case value_t::array:
12483
                {
T
Théo DELRIEU 已提交
12484 12485 12486 12487 12488 12489
                    if (value.m_value.array->empty())
                    {
                        // flatten empty array as null
                        result[reference_string] = nullptr;
                    }
                    else
N
Niels 已提交
12490
                    {
T
Théo DELRIEU 已提交
12491 12492 12493 12494 12495 12496
                        // 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 已提交
12497
                    }
T
Théo DELRIEU 已提交
12498
                    break;
N
Niels 已提交
12499 12500
                }

T
Théo DELRIEU 已提交
12501
                case value_t::object:
12502
                {
T
Théo DELRIEU 已提交
12503 12504 12505 12506 12507 12508
                    if (value.m_value.object->empty())
                    {
                        // flatten empty object as null
                        result[reference_string] = nullptr;
                    }
                    else
N
Niels 已提交
12509
                    {
T
Théo DELRIEU 已提交
12510 12511 12512 12513 12514 12515
                        // 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 已提交
12516
                    }
T
Théo DELRIEU 已提交
12517
                    break;
N
Niels 已提交
12518 12519
                }

T
Théo DELRIEU 已提交
12520 12521 12522 12523 12524 12525
                default:
                {
                    // add primitive value with its reference string
                    result[reference_string] = value;
                    break;
                }
N
Niels 已提交
12526 12527
            }
        }
N
Niels 已提交
12528

T
Théo DELRIEU 已提交
12529 12530
        /*!
        @param[in] value  flattened JSON
N
Niels 已提交
12531

T
Théo DELRIEU 已提交
12532 12533 12534
        @return unflattened JSON
        */
        static basic_json unflatten(const basic_json& value)
N
Niels 已提交
12535
        {
T
Théo DELRIEU 已提交
12536 12537
            if (not value.is_object())
            {
12538
                JSON_THROW(type_error(314, "only objects can be unflattened"));
T
Théo DELRIEU 已提交
12539
            }
N
Niels 已提交
12540

T
Théo DELRIEU 已提交
12541
            basic_json result;
N
Niels 已提交
12542

T
Théo DELRIEU 已提交
12543 12544
            // iterate the JSON object values
            for (const auto& element : *value.m_value.object)
N
Niels 已提交
12545
            {
T
Théo DELRIEU 已提交
12546 12547
                if (not element.second.is_primitive())
                {
12548
                    JSON_THROW(type_error(315, "values in object must be primitive"));
T
Théo DELRIEU 已提交
12549 12550 12551 12552 12553 12554 12555 12556
                }

                // 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 已提交
12557 12558
            }

T
Théo DELRIEU 已提交
12559
            return result;
N
Niels 已提交
12560
        }
N
Niels 已提交
12561

T
Théo DELRIEU 已提交
12562 12563 12564 12565 12566 12567
      private:
        friend bool operator==(json_pointer const& lhs,
                               json_pointer const& rhs) noexcept
        {
            return lhs.reference_tokens == rhs.reference_tokens;
        }
12568

T
Théo DELRIEU 已提交
12569 12570 12571 12572 12573
        friend bool operator!=(json_pointer const& lhs,
                               json_pointer const& rhs) noexcept
        {
            return !(lhs == rhs);
        }
12574

T
Théo DELRIEU 已提交
12575 12576
        /// the reference tokens
        std::vector<std::string> reference_tokens {};
12577
    };
N
Niels 已提交
12578

N
Niels 已提交
12579 12580 12581
    //////////////////////////
    // JSON Pointer support //
    //////////////////////////
N
Niels 已提交
12582 12583 12584 12585

    /// @name JSON Pointer functions
    /// @{

N
Niels 已提交
12586 12587 12588 12589
    /*!
    @brief access specified element via JSON Pointer

    Uses a JSON pointer to retrieve a reference to the respective JSON value.
N
Niels 已提交
12590 12591 12592
    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 已提交
12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605 12606 12607 12608 12609 12610 12611 12612 12613 12614 12615 12616 12617 12618 12619 12620 12621 12622 12623 12624 12625 12626 12627 12628 12629 12630 12631 12632 12633 12634 12635 12636 12637 12638 12639 12640 12641 12642 12643 12644 12645 12646 12647 12648 12649 12650 12651 12652 12653 12654 12655 12656 12657 12658 12659 12660 12661 12662 12663 12664 12665 12666 12667 12668 12669 12670 12671 12672 12673 12674 12675 12676 12677 12678

    In particular:
    - If the JSON pointer points to an object key that does not exist, it
      is created an filled with a `null` value before a reference to it
      is returned.
    - If the JSON pointer points to an array index that does not exist, it
      is created an filled with a `null` value before a reference to it
      is returned. All indices between the current maximum and the given
      index are also filled with `null`.
    - The special value `-` is treated as a synonym for the index past the
      end.

    @param[in] ptr  a JSON pointer

    @return reference to the element pointed to by @a ptr

    @complexity Constant.

    @throw std::out_of_range      if the JSON pointer can not be resolved
    @throw std::domain_error      if an array index begins with '0'
    @throw std::invalid_argument  if an array index was not a number

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

    @since version 2.0.0
    */
    reference operator[](const json_pointer& ptr)
    {
        return ptr.get_unchecked(this);
    }

    /*!
    @brief access specified element via JSON Pointer

    Uses a JSON pointer to retrieve a reference to the respective JSON value.
    No bound checking is performed. The function does not change the JSON
    value; no `null` values are created. In particular, the the special value
    `-` yields an exception.

    @param[in] ptr  JSON pointer to the desired element

    @return const reference to the element pointed to by @a ptr

    @complexity Constant.

    @throw std::out_of_range      if the JSON pointer can not be resolved
    @throw std::domain_error      if an array index begins with '0'
    @throw std::invalid_argument  if an array index was not a number

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

    @since version 2.0.0
    */
    const_reference operator[](const json_pointer& ptr) const
    {
        return ptr.get_unchecked(this);
    }

    /*!
    @brief access specified element via JSON Pointer

    Returns a reference to the element at with specified JSON pointer @a ptr,
    with bounds checking.

    @param[in] ptr  JSON pointer to the desired element

    @return reference to the element pointed to by @a ptr

    @complexity Constant.

    @throw std::out_of_range      if the JSON pointer can not be resolved
    @throw std::domain_error      if an array index begins with '0'
    @throw std::invalid_argument  if an array index was not a number

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

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

    /*!
    @brief access specified element via JSON Pointer

N
Niels 已提交
12679 12680
    Returns a const reference to the element at with specified JSON pointer @a
    ptr, with bounds checking.
N
Niels 已提交
12681 12682 12683 12684 12685 12686 12687 12688 12689 12690 12691 12692 12693 12694 12695 12696 12697 12698 12699 12700

    @param[in] ptr  JSON pointer to the desired element

    @return reference to the element pointed to by @a ptr

    @complexity Constant.

    @throw std::out_of_range      if the JSON pointer can not be resolved
    @throw std::domain_error      if an array index begins with '0'
    @throw std::invalid_argument  if an array index was not a number

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

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

N
Niels 已提交
12701
    /*!
N
Niels 已提交
12702 12703
    @brief return flattened JSON value

N
Niels 已提交
12704 12705 12706 12707
    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 已提交
12708

N
Niels Lohmann 已提交
12709
    @return an object that maps JSON pointers to primitive values
N
Niels 已提交
12710

N
Niels 已提交
12711 12712
    @note Empty objects and arrays are flattened to `null` and will not be
          reconstructed correctly by the @ref unflatten() function.
N
Niels 已提交
12713 12714 12715 12716 12717 12718 12719 12720 12721

    @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 已提交
12722 12723 12724 12725 12726 12727 12728
    */
    basic_json flatten() const
    {
        basic_json result(value_t::object);
        json_pointer::flatten("", *this, result);
        return result;
    }
N
Niels 已提交
12729 12730

    /*!
N
Niels 已提交
12731 12732 12733 12734 12735 12736 12737 12738 12739 12740
    @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 已提交
12741
    @return the original JSON from a flattened version
N
Niels 已提交
12742 12743 12744 12745 12746 12747 12748 12749 12750 12751 12752 12753 12754 12755

    @note Empty objects and arrays are flattened by @ref flatten() to `null`
          values and can not unflattened to their original type. Apart from
          this example, for a JSON value `j`, the following is always true:
          `j == j.flatten().unflatten()`.

    @complexity Linear in the size the JSON value.

    @liveexample{The following code shows how a flattened JSON object is
    unflattened into the original nested JSON object.,unflatten}

    @sa @ref flatten() for the reverse function

    @since version 2.0.0
N
Niels 已提交
12756
    */
N
Niels 已提交
12757
    basic_json unflatten() const
N
Niels 已提交
12758
    {
N
Niels 已提交
12759
        return json_pointer::unflatten(*this);
N
Niels 已提交
12760
    }
N
Niels 已提交
12761 12762

    /// @}
12763

N
Niels 已提交
12764 12765 12766 12767 12768 12769 12770
    //////////////////////////
    // JSON Patch functions //
    //////////////////////////

    /// @name JSON Patch functions
    /// @{

12771 12772 12773
    /*!
    @brief applies a JSON patch

N
Niels 已提交
12774 12775
    [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 已提交
12776
    this function, a JSON Patch is applied to the current JSON value by
N
Niels 已提交
12777 12778
    executing all operations from the patch.

N
Niels 已提交
12779
    @param[in] json_patch  JSON patch document
12780 12781
    @return patched document

N
Niels 已提交
12782 12783 12784 12785 12786
    @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.

12787 12788 12789
    @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 已提交
12790 12791
    @throw invalid_argument if the JSON patch is malformed (e.g., mandatory
    attributes are missing); example: `"operation add must have member path"`
12792 12793
    @throw parse_error.104 if the JSON patch does not consist of an array of
    objects
N
Niels 已提交
12794 12795 12796 12797

    @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.
12798

N
Niels 已提交
12799 12800 12801 12802 12803 12804 12805 12806 12807
    @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
12808
    */
N
Niels 已提交
12809
    basic_json patch(const basic_json& json_patch) const
12810
    {
N
Niels 已提交
12811
        // make a working copy to apply the patch to
12812 12813
        basic_json result = *this;

N
Niels 已提交
12814 12815 12816
        // the valid JSON Patch operations
        enum class patch_operations {add, remove, replace, move, copy, test, invalid};

N
Niels Lohmann 已提交
12817
        const auto get_op = [](const std::string & op)
N
Niels 已提交
12818 12819 12820 12821 12822 12823 12824 12825 12826 12827 12828 12829 12830 12831 12832 12833 12834 12835 12836 12837 12838 12839 12840 12841 12842 12843 12844 12845 12846
        {
            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 已提交
12847
        // wrapper for "add" operation; add value at ptr
N
Niels 已提交
12848
        const auto operation_add = [&result](json_pointer & ptr, basic_json val)
N
Niels 已提交
12849
        {
N
Niels 已提交
12850 12851
            // adding to the root of the target document means replacing it
            if (ptr.is_root())
N
Niels 已提交
12852
            {
N
Niels 已提交
12853
                result = val;
N
Niels 已提交
12854
            }
N
Niels 已提交
12855
            else
N
Niels 已提交
12856
            {
N
Niels 已提交
12857 12858 12859
                // make sure the top element of the pointer exists
                json_pointer top_pointer = ptr.top();
                if (top_pointer != ptr)
N
Niels 已提交
12860
                {
N
Niels 已提交
12861
                    result.at(top_pointer);
N
Niels 已提交
12862
                }
N
Niels 已提交
12863 12864 12865 12866 12867 12868

                // 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 已提交
12869
                {
N
Niels 已提交
12870 12871 12872 12873 12874 12875 12876 12877 12878 12879 12880 12881 12882 12883 12884 12885 12886 12887 12888 12889 12890
                    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
12891
                                JSON_THROW(out_of_range(401, "array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
12892 12893 12894 12895 12896 12897 12898 12899 12900 12901 12902 12903
                            }
                            else
                            {
                                // default case: insert add offset
                                parent.insert(parent.begin() + static_cast<difference_type>(idx), val);
                            }
                        }
                        break;
                    }

                    default:
                    {
N
Niels 已提交
12904 12905
                        // if there exists a parent it cannot be primitive
                        assert(false);  // LCOV_EXCL_LINE
N
Niels 已提交
12906
                    }
N
Niels 已提交
12907 12908 12909 12910
                }
            }
        };

N
Niels 已提交
12911
        // wrapper for "remove" operation; remove value at ptr
N
Niels 已提交
12912 12913
        const auto operation_remove = [&result](json_pointer & ptr)
        {
N
Niels 已提交
12914
            // get reference to parent of JSON pointer ptr
N
Niels 已提交
12915 12916
            const auto last_path = ptr.pop_back();
            basic_json& parent = result.at(ptr);
N
Niels 已提交
12917 12918

            // remove child
N
Niels 已提交
12919 12920
            if (parent.is_object())
            {
N
Niels 已提交
12921 12922 12923 12924 12925 12926 12927 12928
                // perform range check
                auto it = parent.find(last_path);
                if (it != parent.end())
                {
                    parent.erase(it);
                }
                else
                {
12929
                    JSON_THROW(out_of_range(403, "key '" + last_path + "' not found"));
N
Niels 已提交
12930
                }
N
Niels 已提交
12931 12932 12933
            }
            else if (parent.is_array())
            {
N
Niels 已提交
12934 12935
                // note erase performs range check
                parent.erase(static_cast<size_type>(std::stoi(last_path)));
N
Niels 已提交
12936 12937 12938
            }
        };

12939
        // type check: top level value must be an array
N
Niels 已提交
12940
        if (not json_patch.is_array())
N
Niels 已提交
12941
        {
12942
            JSON_THROW(parse_error(104, 0, "JSON patch must be an array of objects"));
N
Niels 已提交
12943 12944
        }

N
Niels Lohmann 已提交
12945
        // iterate and apply the operations
N
Niels 已提交
12946
        for (const auto& val : json_patch)
12947
        {
N
Niels 已提交
12948 12949 12950
            // wrapper to get a value for an operation
            const auto get_value = [&val](const std::string & op,
                                          const std::string & member,
N
Niels 已提交
12951
                                          bool string_type) -> basic_json&
12952
            {
N
Niels 已提交
12953 12954
                // find value
                auto it = val.m_value.object->find(member);
12955

N
Niels 已提交
12956 12957
                // context-sensitive error message
                const auto error_msg = (op == "op") ? "operation" : "operation '" + op + "'";
12958

N
Niels 已提交
12959 12960 12961
                // check if desired value is present
                if (it == val.m_value.object->end())
                {
12962
                    JSON_THROW(parse_error(105, 0, error_msg + " must have member '" + member + "'"));
N
Niels 已提交
12963
                }
12964

N
Niels 已提交
12965 12966 12967
                // check if result is of type string
                if (string_type and not it->second.is_string())
                {
12968
                    JSON_THROW(parse_error(105, 0, error_msg + " must have string member '" + member + "'"));
N
Niels 已提交
12969 12970 12971 12972 12973 12974
                }

                // no error: return value
                return it->second;
            };

12975
            // type check: every element of the array must be an object
N
Niels 已提交
12976
            if (not val.is_object())
12977
            {
12978
                JSON_THROW(parse_error(104, 0, "JSON patch must be an array of objects"));
12979 12980
            }

N
Niels 已提交
12981 12982 12983
            // collect mandatory members
            const std::string op = get_value("op", "op", true);
            const std::string path = get_value(op, "path", true);
N
oops  
Niels 已提交
12984
            json_pointer ptr(path);
12985

N
Niels 已提交
12986
            switch (get_op(op))
12987
            {
N
Niels 已提交
12988 12989 12990 12991 12992 12993 12994 12995 12996 12997 12998 12999 13000 13001 13002 13003 13004 13005 13006 13007 13008 13009 13010 13011 13012 13013 13014 13015 13016 13017 13018 13019 13020 13021 13022 13023 13024 13025 13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036
                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;
13037
                    JSON_TRY
N
Niels 已提交
13038 13039 13040 13041 13042
                    {
                        // check if "value" matches the one at "path"
                        // the "path" location must exist - use at()
                        success = (result.at(ptr) == get_value("test", "value", false));
                    }
13043
                    JSON_CATCH (out_of_range&)
N
Niels 已提交
13044 13045 13046 13047 13048 13049 13050
                    {
                        // ignore out of range errors: success remains false
                    }

                    // throw an exception if test fails
                    if (not success)
                    {
13051
                        JSON_THROW(std::domain_error("unsuccessful: " + val.dump()));
N
Niels 已提交
13052 13053 13054 13055 13056 13057 13058 13059 13060
                    }

                    break;
                }

                case patch_operations::invalid:
                {
                    // op must be "add", "remove", "replace", "move", "copy", or
                    // "test"
13061
                    JSON_THROW(parse_error(105, 0, "operation value '" + op + "' is invalid"));
N
Niels 已提交
13062
                }
13063
            }
N
Niels 已提交
13064 13065 13066 13067 13068 13069 13070 13071 13072 13073 13074 13075 13076 13077 13078 13079 13080 13081 13082 13083
        }

        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 已提交
13084 13085
    @param[in] source  JSON value to compare from
    @param[in] target  JSON value to compare against
N
Niels 已提交
13086 13087 13088 13089 13090 13091 13092 13093 13094 13095 13096 13097 13098 13099 13100 13101 13102
    @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,
13103
                           const std::string& path = "")
N
Niels 已提交
13104 13105 13106 13107 13108 13109 13110 13111 13112 13113 13114 13115 13116 13117
    {
        // 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(
13118
            {
N
Niels 已提交
13119 13120 13121 13122 13123 13124 13125 13126
                {"op", "replace"},
                {"path", path},
                {"value", target}
            });
        }
        else
        {
            switch (source.type())
13127
            {
N
Niels 已提交
13128 13129 13130 13131 13132 13133 13134 13135 13136 13137 13138
                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 已提交
13139

N
Niels 已提交
13140 13141
                    // i now reached the end of at least one array
                    // in a second pass, traverse the remaining elements
N
Niels 已提交
13142

N
Niels 已提交
13143
                    // remove my remaining elements
N
Niels 已提交
13144
                    const auto end_index = static_cast<difference_type>(result.size());
N
Niels 已提交
13145 13146
                    while (i < source.size())
                    {
N
Niels 已提交
13147 13148
                        // add operations in reverse order to avoid invalid
                        // indices
N
Niels 已提交
13149
                        result.insert(result.begin() + end_index, object(
N
Niels 已提交
13150 13151 13152 13153 13154 13155 13156 13157 13158 13159 13160 13161 13162 13163 13164 13165 13166 13167 13168 13169 13170 13171 13172
                        {
                            {"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:
13173
                {
N
Niels 已提交
13174 13175 13176 13177 13178 13179 13180 13181 13182 13183 13184 13185 13186 13187 13188 13189 13190 13191 13192 13193 13194 13195 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
                    // 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;
13226 13227 13228 13229 13230 13231
                }
            }
        }

        return result;
    }
N
Niels 已提交
13232 13233

    /// @}
N
Niels 已提交
13234 13235 13236 13237 13238 13239
};

/////////////
// presets //
/////////////

N
Niels 已提交
13240 13241 13242
/*!
@brief default JSON class

N
Niels 已提交
13243 13244
This type is the default specialization of the @ref basic_json class which
uses the standard template types.
N
Niels 已提交
13245

N
Niels 已提交
13246
@since version 1.0.0
N
Niels 已提交
13247
*/
N
Niels 已提交
13248
using json = basic_json<>;
N
Niels Lohmann 已提交
13249
} // namespace nlohmann
N
Niels 已提交
13250 13251


N
Niels 已提交
13252 13253 13254
///////////////////////
// nonmember support //
///////////////////////
N
Niels 已提交
13255 13256 13257

// specialization of std::swap, and std::hash
namespace std
T
Théo DELRIEU 已提交
13258 13259 13260 13261 13262 13263 13264 13265 13266 13267 13268 13269 13270 13271 13272 13273 13274 13275 13276
{
/*!
@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 已提交
13277
{
N
Niels 已提交
13278
    /*!
T
Théo DELRIEU 已提交
13279
    @brief return a hash value for a JSON object
N
Niels 已提交
13280

N
Niels 已提交
13281
    @since version 1.0.0
N
Niels 已提交
13282
    */
T
Théo DELRIEU 已提交
13283
    std::size_t operator()(const nlohmann::json& j) const
N
Niels 已提交
13284 13285
    {
        // a naive hashing via the string representation
N
Niels 已提交
13286 13287
        const auto& h = hash<nlohmann::json::string_t>();
        return h(j.dump());
N
Niels 已提交
13288
    }
T
Théo DELRIEU 已提交
13289
};
N
Niels Lohmann 已提交
13290
} // namespace std
N
Niels 已提交
13291 13292

/*!
N
Niels 已提交
13293 13294
@brief user-defined string literal for JSON values

N
Niels 已提交
13295
This operator implements a user-defined string literal for JSON objects. It
N
Niels 已提交
13296
can be used by adding `"_json"` to a string literal and returns a JSON object
N
Niels 已提交
13297
if no parse error occurred.
N
Niels 已提交
13298

N
Niels 已提交
13299
@param[in] s  a string representation of a JSON object
13300
@param[in] n  the length of string @a s
N
Niels 已提交
13301
@return a JSON object
N
Niels 已提交
13302

N
Niels 已提交
13303
@since version 1.0.0
N
Niels 已提交
13304
*/
13305
inline nlohmann::json operator "" _json(const char* s, std::size_t n)
N
Niels 已提交
13306
{
13307
    return nlohmann::json::parse(s, s + n);
N
Niels 已提交
13308 13309
}

N
Niels 已提交
13310 13311 13312
/*!
@brief user-defined string literal for JSON pointer

N
Niels 已提交
13313
This operator implements a user-defined string literal for JSON Pointers. It
N
Niels 已提交
13314
can be used by adding `"_json_pointer"` to a string literal and returns a JSON pointer
N
Niels 已提交
13315 13316 13317
object if no parse error occurred.

@param[in] s  a string representation of a JSON Pointer
13318
@param[in] n  the length of string @a s
N
Niels 已提交
13319 13320
@return a JSON pointer object

N
Niels 已提交
13321 13322
@since version 2.0.0
*/
13323
inline nlohmann::json::json_pointer operator "" _json_pointer(const char* s, std::size_t n)
N
Niels 已提交
13324
{
13325
    return nlohmann::json::json_pointer(std::string(s, n));
N
Niels 已提交
13326 13327
}

13328 13329 13330 13331 13332
// restore GCC/clang diagnostic settings
#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
    #pragma GCC diagnostic pop
#endif

13333 13334
// clean up
#undef JSON_CATCH
N
Niels Lohmann 已提交
13335 13336
#undef JSON_THROW
#undef JSON_TRY
13337

N
Niels 已提交
13338
#endif