json.hpp.re2c 423.8 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
cleanup  
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
cleanup  
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
cleanup  
Niels 已提交
95
/*!
N
Niels 已提交
96
@brief namespace for Niels Lohmann
N
cleanup  
Niels 已提交
97
@see https://github.com/nlohmann
N
Niels 已提交
98
@since version 1.0.0
N
cleanup  
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
///////////////////////////
// JSON type enumeration //
///////////////////////////

/*!
@brief the JSON type enumeration

120 121 122 123 124 125 126
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 已提交
127
@ref basic_json::is_structured() rely on it.
128

129 130 131 132 133 134
@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.
135

136 137
@sa @ref basic_json::basic_json(const value_t value_type) -- create a JSON
value with the default value for a given type
138 139 140 141 142

@since version 1.0.0
*/
enum class value_t : uint8_t
{
T
Théo DELRIEU 已提交
143 144 145 146 147 148 149 150 151
    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
152 153
};

154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
/*!
@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)];
}

187 188 189 190 191

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

192
// alias templates to reduce boilerplate
193
template<bool B, typename T = void>
194
using enable_if_t = typename std::enable_if<B, T>::type;
N
cleanup  
Niels 已提交
195

196
template<typename T>
T
Théo DELRIEU 已提交
197
using uncvref_t = typename std::remove_cv<typename std::remove_reference<T>::type>::type;
198

N
Niels Lohmann 已提交
199
// taken from http://stackoverflow.com/a/26936864/266378
200
template<typename T>
201 202 203 204
using is_unscoped_enum =
    std::integral_constant<bool, std::is_convertible<T, int>::value and
    std::is_enum<T>::value>;

205
/*
N
Niels Lohmann 已提交
206
Implementation of two C++17 constructs: conjunction, negation. This is needed
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
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 {};
222

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

T
Théo DELRIEU 已提交
225
// dispatch utility (taken from ranges-v3)
226 227
template<unsigned N> struct priority_tag : priority_tag < N - 1 > {};
template<> struct priority_tag<0> {};
T
Théo DELRIEU 已提交
228

229 230 231 232

//////////////////
// constructors //
//////////////////
T
Théo DELRIEU 已提交
233

234
template<value_t> struct external_constructor;
235

236
template<>
237 238
struct external_constructor<value_t::boolean>
{
239
    template<typename BasicJsonType>
240
    static void construct(BasicJsonType& j, typename BasicJsonType::boolean_t b) noexcept
T
Théo DELRIEU 已提交
241 242 243 244 245
    {
        j.m_type = value_t::boolean;
        j.m_value = b;
        j.assert_invariant();
    }
246
};
247

248
template<>
249 250
struct external_constructor<value_t::string>
{
251
    template<typename BasicJsonType>
252
    static void construct(BasicJsonType& j, const typename BasicJsonType::string_t& s)
T
Théo DELRIEU 已提交
253 254 255 256 257
    {
        j.m_type = value_t::string;
        j.m_value = s;
        j.assert_invariant();
    }
258
};
259

260
template<>
261 262
struct external_constructor<value_t::number_float>
{
263
    template<typename BasicJsonType>
264
    static void construct(BasicJsonType& j, typename BasicJsonType::number_float_t val) noexcept
265
    {
T
Théo DELRIEU 已提交
266 267
        // replace infinity and NAN by null
        if (not std::isfinite(val))
268
        {
269
            j = BasicJsonType{};
270
        }
T
Théo DELRIEU 已提交
271 272 273 274 275 276
        else
        {
            j.m_type = value_t::number_float;
            j.m_value = val;
        }
        j.assert_invariant();
277 278 279
    }
};

280
template<>
281 282
struct external_constructor<value_t::number_unsigned>
{
283
    template<typename BasicJsonType>
284
    static void construct(BasicJsonType& j, typename BasicJsonType::number_unsigned_t val) noexcept
T
Théo DELRIEU 已提交
285 286 287 288 289
    {
        j.m_type = value_t::number_unsigned;
        j.m_value = val;
        j.assert_invariant();
    }
290 291
};

292
template<>
293 294
struct external_constructor<value_t::number_integer>
{
295
    template<typename BasicJsonType>
296
    static void construct(BasicJsonType& j, typename BasicJsonType::number_integer_t val) noexcept
T
Théo DELRIEU 已提交
297 298 299 300 301
    {
        j.m_type = value_t::number_integer;
        j.m_value = val;
        j.assert_invariant();
    }
302 303
};

304
template<>
305 306
struct external_constructor<value_t::array>
{
307
    template<typename BasicJsonType>
308
    static void construct(BasicJsonType& j, const typename BasicJsonType::array_t& arr)
T
Théo DELRIEU 已提交
309 310 311 312 313 314
    {
        j.m_type = value_t::array;
        j.m_value = arr;
        j.assert_invariant();
    }

315 316 317 318
    template<typename BasicJsonType, typename CompatibleArrayType,
             enable_if_t<not std::is_same<CompatibleArrayType,
                                          typename BasicJsonType::array_t>::value,
                         int> = 0>
319
    static void construct(BasicJsonType& j, const CompatibleArrayType& arr)
T
Théo DELRIEU 已提交
320 321 322 323
    {
        using std::begin;
        using std::end;
        j.m_type = value_t::array;
324
        j.m_value.array = j.template create<typename BasicJsonType::array_t>(begin(arr), end(arr));
T
Théo DELRIEU 已提交
325 326
        j.assert_invariant();
    }
327 328
};

329
template<>
330 331
struct external_constructor<value_t::object>
{
332
    template<typename BasicJsonType>
333
    static void construct(BasicJsonType& j, const typename BasicJsonType::object_t& obj)
T
Théo DELRIEU 已提交
334 335 336 337 338 339
    {
        j.m_type = value_t::object;
        j.m_value = obj;
        j.assert_invariant();
    }

340 341 342 343
    template<typename BasicJsonType, typename CompatibleObjectType,
             enable_if_t<not std::is_same<CompatibleObjectType,
                                          typename BasicJsonType::object_t>::value,
                         int> = 0>
344
    static void construct(BasicJsonType& j, const CompatibleObjectType& obj)
T
Théo DELRIEU 已提交
345 346 347
    {
        using std::begin;
        using std::end;
348

T
Théo DELRIEU 已提交
349
        j.m_type = value_t::object;
350
        j.m_value.object = j.template create<typename BasicJsonType::object_t>(begin(obj), end(obj));
T
Théo DELRIEU 已提交
351 352
        j.assert_invariant();
    }
353 354
};

355 356 357 358 359

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

360 361
/*!
@brief Helper to determine whether there's a key_type for T.
N
Niels Lohmann 已提交
362 363

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

367
@sa http://stackoverflow.com/a/7728728/266378
N
Niels 已提交
368
@since version 1.0.0, overworked in version 2.0.6
369
*/
N
Niels Lohmann 已提交
370
#define NLOHMANN_JSON_HAS_HELPER(type)                                        \
371
    template<typename T> struct has_##type {                                  \
N
Niels Lohmann 已提交
372
    private:                                                                  \
373
        template<typename U, typename = typename U::type>                     \
N
Niels Lohmann 已提交
374 375 376 377 378
        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 已提交
379
    }
380

N
Niels Lohmann 已提交
381 382 383 384
NLOHMANN_JSON_HAS_HELPER(mapped_type);
NLOHMANN_JSON_HAS_HELPER(key_type);
NLOHMANN_JSON_HAS_HELPER(value_type);
NLOHMANN_JSON_HAS_HELPER(iterator);
385 386 387

#undef NLOHMANN_JSON_HAS_HELPER

N
Niels Lohmann 已提交
388

389
template<bool B, class RealType, class CompatibleObjectType>
390 391
struct is_compatible_object_type_impl : std::false_type {};

392
template<class RealType, class CompatibleObjectType>
393 394 395 396 397 398 399 400 401
struct is_compatible_object_type_impl<true, RealType, CompatibleObjectType>
{
    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;
};

402
template<class BasicJsonType, class CompatibleObjectType>
403 404
struct is_compatible_object_type
{
T
Théo DELRIEU 已提交
405 406 407 408
    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,
409
                                  typename BasicJsonType::object_t, CompatibleObjectType >::value;
410 411
};

412
template<typename BasicJsonType, typename T>
413
struct is_basic_json_nested_type
414
{
415 416 417 418 419
    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;
420 421
};

422
template<class BasicJsonType, class CompatibleArrayType>
423 424
struct is_compatible_array_type
{
T
Théo DELRIEU 已提交
425
    static auto constexpr value =
426
        conjunction<negation<std::is_same<void, CompatibleArrayType>>,
T
Théo DELRIEU 已提交
427
        negation<is_compatible_object_type<
428 429
        BasicJsonType, CompatibleArrayType>>,
        negation<std::is_constructible<typename BasicJsonType::string_t,
T
Théo DELRIEU 已提交
430
        CompatibleArrayType>>,
431
        negation<is_basic_json_nested_type<BasicJsonType, CompatibleArrayType>>,
T
Théo DELRIEU 已提交
432 433
        has_value_type<CompatibleArrayType>,
        has_iterator<CompatibleArrayType>>::value;
434 435
};

436
template<bool, typename, typename>
437 438
struct is_compatible_integer_type_impl : std::false_type {};

439
template<typename RealIntegerType, typename CompatibleNumberIntegerType>
440 441
struct is_compatible_integer_type_impl<true, RealIntegerType, CompatibleNumberIntegerType>
{
T
Théo DELRIEU 已提交
442
    // is there an assert somewhere on overflows?
443 444 445 446 447 448 449 450 451 452
    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;
};

453
template<typename RealIntegerType, typename CompatibleNumberIntegerType>
454 455
struct is_compatible_integer_type
{
456 457 458 459 460
    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;
461 462
};

463

N
Niels Lohmann 已提交
464
// trait checking if JSONSerializer<T>::from_json(json const&, udt&) exists
465
template<typename BasicJsonType, typename T>
466 467 468 469
struct has_from_json
{
  private:
    // also check the return type of from_json
470 471
    template<typename U, typename = enable_if_t<std::is_same<void, decltype(uncvref_t<U>::from_json(
                 std::declval<BasicJsonType>(), std::declval<T&>()))>::value>>
472 473 474 475 476
    static int detect(U&&);
    static void detect(...);

  public:
    static constexpr bool value = std::is_integral<decltype(
477
                                      detect(std::declval<typename BasicJsonType::template json_serializer<T, void>>()))>::value;
478 479 480 481
};

// This trait checks if JSONSerializer<T>::from_json(json const&) exists
// this overload is used for non-default-constructible user-defined-types
482
template<typename BasicJsonType, typename T>
483 484
struct has_non_default_from_json
{
T
Théo DELRIEU 已提交
485 486 487 488
  private:
    template <
        typename U,
        typename = enable_if_t<std::is_same<
489
                                   T, decltype(uncvref_t<U>::from_json(std::declval<BasicJsonType>()))>::value >>
T
Théo DELRIEU 已提交
490 491 492 493 494
    static int detect(U&&);
    static void detect(...);

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

498
// This trait checks if BasicJsonType::json_serializer<T>::to_json exists
499
template<typename BasicJsonType, typename T>
500
struct has_to_json
N
Niels 已提交
501
{
T
Théo DELRIEU 已提交
502
  private:
503 504
    template<typename U, typename = decltype(uncvref_t<U>::to_json(
                 std::declval<BasicJsonType&>(), std::declval<T>()))>
T
Théo DELRIEU 已提交
505 506 507 508 509
    static int detect(U&&);
    static void detect(...);

  public:
    static constexpr bool value = std::is_integral<decltype(detect(
510
                                      std::declval<typename BasicJsonType::template json_serializer<T, void>>()))>::value;
N
Niels 已提交
511
};
512

513

514 515 516
/////////////
// to_json //
/////////////
517

N
Niels Lohmann 已提交
518
template<typename BasicJsonType, typename T, enable_if_t<
519
             std::is_same<T, typename BasicJsonType::boolean_t>::value, int> = 0>
N
Niels Lohmann 已提交
520
void to_json(BasicJsonType& j, T b) noexcept
521
{
T
Théo DELRIEU 已提交
522
    external_constructor<value_t::boolean>::construct(j, b);
523 524
}

525 526
template<typename BasicJsonType, typename CompatibleString,
         enable_if_t<std::is_constructible<typename BasicJsonType::string_t,
N
Niels Lohmann 已提交
527
                     CompatibleString>::value, int> = 0>
528
void to_json(BasicJsonType& j, const CompatibleString& s)
529
{
T
Théo DELRIEU 已提交
530
    external_constructor<value_t::string>::construct(j, s);
531 532
}

533 534
template<typename BasicJsonType, typename FloatType,
         enable_if_t<std::is_floating_point<FloatType>::value, int> = 0>
535
void to_json(BasicJsonType& j, FloatType val) noexcept
536
{
537
    external_constructor<value_t::number_float>::construct(j, static_cast<typename BasicJsonType::number_float_t>(val));
538 539
}

540
template <
541 542
    typename BasicJsonType, typename CompatibleNumberUnsignedType,
    enable_if_t<is_compatible_integer_type<typename BasicJsonType::number_unsigned_t,
N
Niels Lohmann 已提交
543
                CompatibleNumberUnsignedType>::value, int> = 0 >
544
void to_json(BasicJsonType& j, CompatibleNumberUnsignedType val) noexcept
545
{
546
    external_constructor<value_t::number_unsigned>::construct(j, static_cast<typename BasicJsonType::number_unsigned_t>(val));
547 548
}

549
template <
550 551
    typename BasicJsonType, typename CompatibleNumberIntegerType,
    enable_if_t<is_compatible_integer_type<typename BasicJsonType::number_integer_t,
N
Niels Lohmann 已提交
552
                CompatibleNumberIntegerType>::value, int> = 0 >
553
void to_json(BasicJsonType& j, CompatibleNumberIntegerType val) noexcept
554
{
555
    external_constructor<value_t::number_integer>::construct(j, static_cast<typename BasicJsonType::number_integer_t>(val));
556 557
}

558 559
template<typename BasicJsonType, typename UnscopedEnumType,
         enable_if_t<is_unscoped_enum<UnscopedEnumType>::value, int> = 0>
560
void to_json(BasicJsonType& j, UnscopedEnumType e) noexcept
561
{
T
Théo DELRIEU 已提交
562
    external_constructor<value_t::number_integer>::construct(j, e);
563 564
}

565
template <
566
    typename BasicJsonType, typename CompatibleArrayType,
T
Théo DELRIEU 已提交
567
    enable_if_t <
568 569
        is_compatible_array_type<BasicJsonType, CompatibleArrayType>::value or
        std::is_same<typename BasicJsonType::array_t, CompatibleArrayType>::value,
T
Théo DELRIEU 已提交
570
        int > = 0 >
571
void to_json(BasicJsonType& j, const  CompatibleArrayType& arr)
572
{
T
Théo DELRIEU 已提交
573
    external_constructor<value_t::array>::construct(j, arr);
574 575
}

576
template <
577 578
    typename BasicJsonType, typename CompatibleObjectType,
    enable_if_t<is_compatible_object_type<BasicJsonType, CompatibleObjectType>::value,
T
Théo DELRIEU 已提交
579
                int> = 0 >
580
void to_json(BasicJsonType& j, const  CompatibleObjectType& arr)
581
{
T
Théo DELRIEU 已提交
582
    external_constructor<value_t::object>::construct(j, arr);
583 584
}

585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626

///////////////
// 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:
        {
            JSON_THROW(
                std::domain_error("type must be number, but is " + j.type_name()));
        }
    }
}

template<typename BasicJsonType>
627
void from_json(const BasicJsonType& j, typename BasicJsonType::boolean_t& b)
628
{
N
Niels Lohmann 已提交
629
    if (not j.is_boolean())
T
Théo DELRIEU 已提交
630
    {
T
Théo DELRIEU 已提交
631
        JSON_THROW(std::domain_error("type must be boolean, but is " + j.type_name()));
T
Théo DELRIEU 已提交
632
    }
633
    b = *j.template get_ptr<const typename BasicJsonType::boolean_t*>();
634 635
}

636
template<typename BasicJsonType>
637
void from_json(const BasicJsonType& j, typename BasicJsonType::string_t& s)
638
{
N
Niels Lohmann 已提交
639
    if (not j.is_string())
T
Théo DELRIEU 已提交
640
    {
T
Théo DELRIEU 已提交
641
        JSON_THROW(std::domain_error("type must be string, but is " + j.type_name()));
T
Théo DELRIEU 已提交
642
    }
643
    s = *j.template get_ptr<const typename BasicJsonType::string_t*>();
644 645
}

646
template<typename BasicJsonType>
647
void from_json(const BasicJsonType& j, typename BasicJsonType::number_float_t& val)
648
{
T
Théo DELRIEU 已提交
649
    get_arithmetic_value(j, val);
650 651
}

652
template<typename BasicJsonType>
653
void from_json(const BasicJsonType& j, typename BasicJsonType::number_unsigned_t& val)
654
{
T
Théo DELRIEU 已提交
655
    get_arithmetic_value(j, val);
656 657
}

658
template<typename BasicJsonType>
659
void from_json(const BasicJsonType& j, typename BasicJsonType::number_integer_t& val)
660
{
T
Théo DELRIEU 已提交
661
    get_arithmetic_value(j, val);
662 663
}

664 665 666
template<typename BasicJsonType, typename UnscopedEnumType,
         enable_if_t<is_unscoped_enum<UnscopedEnumType>::value, int> = 0>
void from_json(const BasicJsonType& j, UnscopedEnumType& e)
667
{
668
    typename std::underlying_type<UnscopedEnumType>::type val;
T
Théo DELRIEU 已提交
669 670
    get_arithmetic_value(j, val);
    e = static_cast<UnscopedEnumType>(val);
671 672
}

673 674
template<typename BasicJsonType>
void from_json(const BasicJsonType& j, typename BasicJsonType::array_t& arr)
675
{
N
Niels Lohmann 已提交
676
    if (not j.is_array())
T
Théo DELRIEU 已提交
677
    {
T
Théo DELRIEU 已提交
678
        JSON_THROW(std::domain_error("type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
679
    }
680
    arr = *j.template get_ptr<const typename BasicJsonType::array_t*>();
681 682
}

683 684
// forward_list doesn't have an insert method
template<typename BasicJsonType, typename T, typename Allocator>
685
void from_json(const BasicJsonType& j, std::forward_list<T, Allocator>& l)
686
{
T
Théo DELRIEU 已提交
687 688 689 690
    // do not perform the check when user wants to retrieve jsons
    // (except when it's null.. ?)
    if (j.is_null())
    {
T
Théo DELRIEU 已提交
691
        JSON_THROW(std::domain_error("type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
692
    }
693
    if (not std::is_same<T, BasicJsonType>::value)
T
Théo DELRIEU 已提交
694
    {
N
Niels Lohmann 已提交
695
        if (not j.is_array())
T
Théo DELRIEU 已提交
696
        {
T
Théo DELRIEU 已提交
697
            JSON_THROW(std::domain_error("type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
698 699 700 701 702 703
        }
    }
    for (auto it = j.rbegin(), end = j.rend(); it != end; ++it)
    {
        l.push_front(it->template get<T>());
    }
704 705
}

706 707
template<typename BasicJsonType, typename CompatibleArrayType>
void from_json_array_impl(const BasicJsonType& j, CompatibleArrayType& arr, priority_tag<0>)
T
Théo DELRIEU 已提交
708
{
T
Théo DELRIEU 已提交
709 710
    using std::begin;
    using std::end;
T
Théo DELRIEU 已提交
711

712 713
    std::transform(j.begin(), j.end(),
                   std::inserter(arr, end(arr)), [](const BasicJsonType & i)
T
Théo DELRIEU 已提交
714
    {
715 716
        // get<BasicJsonType>() returns *this, this won't call a from_json
        // method when value_type is BasicJsonType
T
Théo DELRIEU 已提交
717
        return i.template get<typename CompatibleArrayType::value_type>();
T
Théo DELRIEU 已提交
718
    });
T
Théo DELRIEU 已提交
719 720
}

721 722
template<typename BasicJsonType, typename CompatibleArrayType>
auto from_json_array_impl(const BasicJsonType& j, CompatibleArrayType& arr, priority_tag<1>)
T
Théo DELRIEU 已提交
723 724 725
-> decltype(
    arr.reserve(std::declval<typename CompatibleArrayType::size_type>()),
    void())
T
Théo DELRIEU 已提交
726
{
T
Théo DELRIEU 已提交
727 728
    using std::begin;
    using std::end;
T
Théo DELRIEU 已提交
729

T
Théo DELRIEU 已提交
730 731
    arr.reserve(j.size());
    std::transform(
732
        j.begin(), j.end(), std::inserter(arr, end(arr)), [](const BasicJsonType & i)
T
Théo DELRIEU 已提交
733
    {
734 735
        // get<BasicJsonType>() returns *this, this won't call a from_json
        // method when value_type is BasicJsonType
T
Théo DELRIEU 已提交
736
        return i.template get<typename CompatibleArrayType::value_type>();
T
Théo DELRIEU 已提交
737
    });
T
Théo DELRIEU 已提交
738 739
}

740 741 742 743
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)
744
{
T
Théo DELRIEU 已提交
745 746
    if (j.is_null())
    {
T
Théo DELRIEU 已提交
747
        JSON_THROW(std::domain_error("type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
748
    }
749

750 751
    // 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 已提交
752
    {
N
Niels Lohmann 已提交
753
        if (not j.is_array())
T
Théo DELRIEU 已提交
754
        {
T
Théo DELRIEU 已提交
755
            JSON_THROW(std::domain_error("type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
756 757 758
        }
    }
    from_json_array_impl(j, arr, priority_tag<1> {});
759 760
}

761 762 763
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)
764
{
N
Niels Lohmann 已提交
765
    if (not j.is_object())
T
Théo DELRIEU 已提交
766
    {
T
Théo DELRIEU 已提交
767
        JSON_THROW(std::domain_error("type must be object, but is " + j.type_name()));
T
Théo DELRIEU 已提交
768 769
    }

770
    auto inner_object = j.template get_ptr<const typename BasicJsonType::object_t*>();
T
Théo DELRIEU 已提交
771 772 773
    using std::begin;
    using std::end;
    // we could avoid the assignment, but this might require a for loop, which
N
Niels Lohmann 已提交
774 775
    // might be less efficient than the container constructor for some
    // containers (would it?)
T
Théo DELRIEU 已提交
776
    obj = CompatibleObjectType(begin(*inner_object), end(*inner_object));
777 778
}

N
Niels Lohmann 已提交
779 780 781 782
// 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?
783 784 785 786 787 788 789 790
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>
791
void from_json(const BasicJsonType& j, ArithmeticType& val)
792
{
T
Théo DELRIEU 已提交
793
    switch (static_cast<value_t>(j))
T
Théo DELRIEU 已提交
794
    {
T
Théo DELRIEU 已提交
795
        case value_t::number_unsigned:
N
Niels Lohmann 已提交
796
        {
797
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_unsigned_t*>());
T
Théo DELRIEU 已提交
798
            break;
N
Niels Lohmann 已提交
799
        }
T
Théo DELRIEU 已提交
800
        case value_t::number_integer:
N
Niels Lohmann 已提交
801
        {
802
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_integer_t*>());
T
Théo DELRIEU 已提交
803
            break;
N
Niels Lohmann 已提交
804
        }
T
Théo DELRIEU 已提交
805
        case value_t::number_float:
N
Niels Lohmann 已提交
806
        {
807
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_float_t*>());
T
Théo DELRIEU 已提交
808
            break;
N
Niels Lohmann 已提交
809
        }
T
Théo DELRIEU 已提交
810
        case value_t::boolean:
N
Niels Lohmann 已提交
811
        {
812
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::boolean_t*>());
T
Théo DELRIEU 已提交
813
            break;
N
Niels Lohmann 已提交
814
        }
T
Théo DELRIEU 已提交
815
        default:
N
Niels Lohmann 已提交
816
        {
817
            JSON_THROW(std::domain_error("type must be number, but is " + j.type_name()));
N
Niels Lohmann 已提交
818
        }
T
Théo DELRIEU 已提交
819
    }
820 821
}

822 823
struct to_json_fn
{
N
Niels Lohmann 已提交
824
  private:
825 826 827
    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())
828
    {
T
Théo DELRIEU 已提交
829
        return to_json(j, std::forward<T>(val));
830 831
    }

832
    template<typename BasicJsonType, typename T>
833
    void call(BasicJsonType&, T&&, priority_tag<0>) const noexcept
834
    {
835 836
        static_assert(sizeof(BasicJsonType) == 0,
                      "could not find to_json() method in T's namespace");
837
    }
T
Théo DELRIEU 已提交
838

T
Théo DELRIEU 已提交
839
  public:
840
    template<typename BasicJsonType, typename T>
841
    void operator()(BasicJsonType& j, T&& val) const
T
Théo DELRIEU 已提交
842 843 844 845
    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> {});
    }
T
Théo DELRIEU 已提交
846 847 848 849
};

struct from_json_fn
{
T
Théo DELRIEU 已提交
850
  private:
851 852
    template<typename BasicJsonType, typename T>
    auto call(const BasicJsonType& j, T& val, priority_tag<1>) const
T
Théo DELRIEU 已提交
853 854 855 856 857 858
    noexcept(noexcept(from_json(j, val)))
    -> decltype(from_json(j, val), void())
    {
        return from_json(j, val);
    }

859
    template<typename BasicJsonType, typename T>
860
    void call(const BasicJsonType&, T&, priority_tag<0>) const noexcept
T
Théo DELRIEU 已提交
861
    {
862 863
        static_assert(sizeof(BasicJsonType) == 0,
                      "could not find from_json() method in T's namespace");
T
Théo DELRIEU 已提交
864 865 866
    }

  public:
867 868
    template<typename BasicJsonType, typename T>
    void operator()(const BasicJsonType& j, T& val) const
T
Théo DELRIEU 已提交
869 870 871 872
    noexcept(noexcept(std::declval<from_json_fn>().call(j, val, priority_tag<1> {})))
    {
        return call(j, val, priority_tag<1> {});
    }
873 874
};

875
// taken from ranges-v3
876
template<typename T>
877 878 879 880 881
struct static_const
{
    static constexpr T value{};
};

882
template<typename T>
883
constexpr T static_const<T>::value;
884 885
} // namespace detail

886

N
Niels Lohmann 已提交
887
/// namespace to hold default `to_json` / `from_json` functions
888
namespace
889
{
T
Théo DELRIEU 已提交
890 891
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;
892 893
}

N
Niels Lohmann 已提交
894 895 896 897 898 899 900 901

/*!
@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.
*/
902
template<typename = void, typename = void>
903 904
struct adl_serializer
{
N
Niels Lohmann 已提交
905 906 907 908 909 910 911
    /*!
    @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
912
    @param[in,out] val  value to write to
N
Niels Lohmann 已提交
913 914 915 916
    */
    template<typename BasicJsonType, typename ValueType>
    static void from_json(BasicJsonType&& j, ValueType& val) noexcept(
        noexcept(::nlohmann::from_json(std::forward<BasicJsonType>(j), val)))
917
    {
918
        ::nlohmann::from_json(std::forward<BasicJsonType>(j), val);
919 920
    }

N
Niels Lohmann 已提交
921 922 923 924 925 926
    /*!
    @brief convert any value type to a JSON value

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

927
    @param[in,out] j  JSON value to write to
N
Niels Lohmann 已提交
928 929 930 931 932
    @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))))
933
    {
N
Niels Lohmann 已提交
934
        ::nlohmann::to_json(j, std::forward<ValueType>(val));
935 936
    }
};
N
Niels 已提交
937

938

N
cleanup  
Niels 已提交
939
/*!
N
Niels 已提交
940
@brief a class to store JSON values
N
cleanup  
Niels 已提交
941

N
Niels 已提交
942
@tparam ObjectType type for JSON objects (`std::map` by default; will be used
N
Niels 已提交
943
in @ref object_t)
N
Niels 已提交
944
@tparam ArrayType type for JSON arrays (`std::vector` by default; will be used
N
Niels 已提交
945
in @ref array_t)
N
Niels 已提交
946
@tparam StringType type for JSON strings and object keys (`std::string` by
N
Niels 已提交
947
default; will be used in @ref string_t)
N
Niels 已提交
948
@tparam BooleanType type for JSON booleans (`bool` by default; will be used
N
Niels 已提交
949
in @ref boolean_t)
N
Niels 已提交
950
@tparam NumberIntegerType type for JSON integer numbers (`int64_t` by
N
Niels 已提交
951
default; will be used in @ref number_integer_t)
N
Niels 已提交
952 953
@tparam NumberUnsignedType type for JSON unsigned integer numbers (@c
`uint64_t` by default; will be used in @ref number_unsigned_t)
N
Niels 已提交
954
@tparam NumberFloatType type for JSON floating-point numbers (`double` by
N
Niels 已提交
955
default; will be used in @ref number_float_t)
N
Niels 已提交
956
@tparam AllocatorType type of the allocator to use (`std::allocator` by
N
Niels 已提交
957
default)
N
Niels Lohmann 已提交
958
@tparam JSONSerializer the serializer to resolve internal calls to `to_json()`
N
Niels Lohmann 已提交
959
and `from_json()` (@ref adl_serializer by default)
N
Niels 已提交
960

N
Niels 已提交
961 962
@requirement The class satisfies the following concept requirements:
- Basic
N
Niels 已提交
963
 - [DefaultConstructible](http://en.cppreference.com/w/cpp/concept/DefaultConstructible):
N
Niels Lohmann 已提交
964 965
   JSON values can be default constructed. The result will be a JSON null
   value.
N
Niels 已提交
966 967 968
 - [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 已提交
969
   A JSON value can be copy-constructed from an lvalue expression.
N
Niels 已提交
970 971 972 973 974 975
 - [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 已提交
976
- Layout
N
Niels 已提交
977 978 979
 - [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 已提交
980 981
   All non-static data members are private and standard layout types, the
   class has no virtual functions or (virtual) base classes.
N
Niels 已提交
982
- Library-wide
N
Niels 已提交
983 984 985 986 987 988 989 990 991 992 993 994
 - [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 已提交
995
- Container
N
Niels 已提交
996 997 998 999 1000
 - [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 已提交
1001

1002 1003 1004 1005 1006 1007 1008
@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 已提交
1009
@internal
N
Niels 已提交
1010
@note ObjectType trick from http://stackoverflow.com/a/9860911
N
Niels 已提交
1011
@endinternal
N
Niels 已提交
1012

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

N
Niels 已提交
1016
@since version 1.0.0
N
Niels 已提交
1017 1018

@nosubgrouping
N
cleanup  
Niels 已提交
1019 1020 1021 1022 1023 1024
*/
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,
1025 1026
    class NumberIntegerType = std::int64_t,
    class NumberUnsignedType = std::uint64_t,
N
Niels 已提交
1027
    class NumberFloatType = double,
1028 1029
    template<typename U> class AllocatorType = std::allocator,
    template<typename T, typename SFINAE = void> class JSONSerializer = adl_serializer
N
cleanup  
Niels 已提交
1030 1031 1032
    >
class basic_json
{
1033
  private:
1034
    template<detail::value_t> friend struct detail::external_constructor;
1035
    /// workaround type for MSVC
N
Niels 已提交
1036 1037
    using basic_json_t = basic_json<ObjectType, ArrayType, StringType,
          BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType,
1038
          AllocatorType, JSONSerializer>;
1039 1040

  public:
1041
    using value_t = detail::value_t;
N
Niels 已提交
1042
    // forward declarations
N
Niels Lohmann 已提交
1043
    template<typename U> class iter_impl;
N
Niels 已提交
1044 1045
    template<typename Base> class json_reverse_iterator;
    class json_pointer;
1046
    template<typename T, typename SFINAE>
1047
    using json_serializer = JSONSerializer<T, SFINAE>;
1048

N
cleanup  
Niels 已提交
1049 1050 1051 1052
    /////////////////////
    // container types //
    /////////////////////

N
Niels 已提交
1053
    /// @name container types
N
Niels 已提交
1054 1055
    /// The canonic container types to use @ref basic_json like any other STL
    /// container.
N
Niels 已提交
1056 1057
    /// @{

N
Niels 已提交
1058
    /// the type of elements in a basic_json container
N
cleanup  
Niels 已提交
1059
    using value_type = basic_json;
N
Niels 已提交
1060

N
Niels 已提交
1061
    /// the type of an element reference
N
Niels 已提交
1062
    using reference = value_type&;
N
Niels 已提交
1063
    /// the type of an element const reference
N
Niels 已提交
1064
    using const_reference = const value_type&;
N
Niels 已提交
1065

N
Niels 已提交
1066
    /// a type to represent differences between iterators
N
Niels 已提交
1067
    using difference_type = std::ptrdiff_t;
N
Niels 已提交
1068
    /// a type to represent container sizes
N
Niels 已提交
1069 1070 1071
    using size_type = std::size_t;

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

N
cleanup  
Niels 已提交
1074
    /// the type of an element pointer
N
Niels 已提交
1075
    using pointer = typename std::allocator_traits<allocator_type>::pointer;
N
cleanup  
Niels 已提交
1076
    /// the type of an element const pointer
N
Niels 已提交
1077
    using const_pointer = typename std::allocator_traits<allocator_type>::const_pointer;
N
Niels 已提交
1078

N
Niels 已提交
1079
    /// an iterator for a basic_json container
N
Niels Lohmann 已提交
1080
    using iterator = iter_impl<basic_json>;
N
Niels 已提交
1081
    /// a const iterator for a basic_json container
N
Niels Lohmann 已提交
1082
    using const_iterator = iter_impl<const basic_json>;
N
Niels 已提交
1083
    /// a reverse iterator for a basic_json container
N
Niels 已提交
1084
    using reverse_iterator = json_reverse_iterator<typename basic_json::iterator>;
N
Niels 已提交
1085
    /// a const reverse iterator for a basic_json container
N
Niels 已提交
1086
    using const_reverse_iterator = json_reverse_iterator<typename basic_json::const_iterator>;
N
Niels 已提交
1087

N
Niels 已提交
1088 1089 1090
    /// @}


1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
  public:
    ////////////////
    // exceptions //
    ////////////////

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

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

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

    name / id                      | example massage | description
    ------------------------------ | --------------- | -------------------------
1107 1108 1109 1110 1111 1112 1113 1114
    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.
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 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 1260 1261 1262
    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.
    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().
    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).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.
    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.
    json.exception.other.500 | "unsuccessful" | A JSON Patch operation 'test' failed.

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

    Exceptions have ids 1xx.

    @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
              file.
        */
        const size_t byte;
    };

    /*!
    @brief exception indicating errors with iterators

    Exceptions have ids 2xx.

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

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

    @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_)
        {}
    };

    /// @}


N
Niels 已提交
1263 1264 1265
    /*!
    @brief returns the allocator associated with the container
    */
1266
    static allocator_type get_allocator()
N
Niels 已提交
1267 1268 1269 1270
    {
        return allocator_type();
    }

1271 1272
    /*!
    @brief returns version information on the library
1273

N
Niels Lohmann 已提交
1274
    This function returns a JSON object with information about the library,
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292
    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
1293
    */
1294
    static basic_json meta()
1295 1296 1297
    {
        basic_json result;

1298
        result["copyright"] = "(C) 2013-2017 Niels Lohmann";
1299 1300 1301 1302
        result["name"] = "JSON for Modern C++";
        result["url"] = "https://github.com/nlohmann/json";
        result["version"] =
        {
N
Niels Lohmann 已提交
1303
            {"string", "2.1.1"}, {"major", 2}, {"minor", 1}, {"patch", 1}
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
        };

#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__)
1319
        result["compiler"] = {{"family", "clang"}, {"version", __clang_version__}};
1320 1321 1322
#elif defined(__ICC) || defined(__INTEL_COMPILER)
        result["compiler"] = {{"family", "icc"}, {"version", __INTEL_COMPILER}};
#elif defined(__GNUC__) || defined(__GNUG__)
1323
        result["compiler"] = {{"family", "gcc"}, {"version", std::to_string(__GNUC__) + "." + std::to_string(__GNUC_MINOR__) + "." + std::to_string(__GNUC_PATCHLEVEL__)}};
1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345
#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 已提交
1346

N
cleanup  
Niels 已提交
1347 1348 1349 1350
    ///////////////////////////
    // JSON value data types //
    ///////////////////////////

N
Niels 已提交
1351
    /// @name JSON value data types
N
Niels 已提交
1352 1353
    /// The data types to store a JSON value. These types are derived from
    /// the template arguments passed to class @ref basic_json.
N
Niels 已提交
1354 1355
    /// @{

N
Niels 已提交
1356 1357 1358 1359 1360 1361 1362 1363
    /*!
    @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 已提交
1364 1365 1366 1367 1368
    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 已提交
1369 1370
    @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 已提交
1371 1372 1373
    inside the container.
    @tparam AllocatorType the allocator to use for objects (e.g.,
    `std::allocator`)
N
Niels 已提交
1374 1375 1376 1377

    #### Default type

    With the default values for @a ObjectType (`std::map`), @a StringType
N
Niels 已提交
1378 1379
    (`std::string`), and @a AllocatorType (`std::allocator`), the default
    value for @a object_t is:
N
Niels 已提交
1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395

    @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 已提交
1396 1397
      that all software implementations receiving that object will agree on
      the name-value mappings.
N
Niels 已提交
1398 1399 1400 1401 1402
    - 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 已提交
1403 1404 1405
      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 已提交
1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417
    - 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 已提交
1418 1419
    runtime environment. A theoretical limit can be queried by calling the
    @ref max_size function of a JSON object.
N
Niels 已提交
1420 1421 1422

    #### Storage

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

1427 1428
    @sa @ref array_t -- type for an array value

N
Niels 已提交
1429
    @since version 1.0.0
N
Niels 已提交
1430

N
Niels 已提交
1431 1432 1433 1434 1435
    @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 已提交
1436 1437
    7159](http://rfc7159.net/rfc7159), because any order implements the
    specified "unordered" nature of JSON objects.
N
Niels 已提交
1438
    */
N
Niels 已提交
1439 1440 1441 1442 1443
    using object_t = ObjectType<StringType,
          basic_json,
          std::less<StringType>,
          AllocatorType<std::pair<const StringType,
          basic_json>>>;
N
Niels 已提交
1444 1445 1446 1447 1448 1449 1450

    /*!
    @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 已提交
1451 1452 1453 1454 1455
    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 已提交
1456
    @tparam AllocatorType allocator to use for arrays (e.g., `std::allocator`)
N
Niels 已提交
1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476

    #### 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 已提交
1477 1478
    runtime environment. A theoretical limit can be queried by calling the
    @ref max_size function of a JSON array.
N
Niels 已提交
1479 1480 1481

    #### Storage

1482
    Arrays are stored as pointers in a @ref basic_json type. That is, for any
N
Niels 已提交
1483
    access to array values, a pointer of type `array_t*` must be dereferenced.
1484 1485 1486

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

N
Niels 已提交
1487
    @since version 1.0.0
N
Niels 已提交
1488
    */
N
Niels 已提交
1489
    using array_t = ArrayType<basic_json, AllocatorType<basic_json>>;
N
Niels 已提交
1490 1491 1492 1493 1494 1495 1496

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

N
Niels 已提交
1501 1502
    @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 已提交
1503 1504 1505 1506 1507 1508 1509 1510 1511 1512

    #### Default type

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

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

1513 1514 1515 1516 1517 1518
    #### 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 已提交
1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535
    #### 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

1536 1537
    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 已提交
1538
    dereferenced.
1539

N
Niels 已提交
1540
    @since version 1.0.0
N
Niels 已提交
1541
    */
N
cleanup  
Niels 已提交
1542
    using string_t = StringType;
N
Niels 已提交
1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563

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

1564 1565
    Boolean values are stored directly inside a @ref basic_json type.

N
Niels 已提交
1566
    @since version 1.0.0
N
Niels 已提交
1567
    */
N
cleanup  
Niels 已提交
1568
    using boolean_t = BooleanType;
N
Niels 已提交
1569 1570 1571 1572 1573

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

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586
    > 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 已提交
1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604

    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 已提交
1605 1606
      instance, the C++ integer literal `010` will be serialized to `8`.
      During deserialization, leading zeros yield an error.
N
Niels 已提交
1607 1608 1609 1610 1611 1612 1613 1614 1615 1616
    - 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 已提交
1617 1618 1619 1620
    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 已提交
1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631

    [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

1632 1633 1634 1635
    Integer number values are stored directly inside a @ref basic_json type.

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

1636 1637
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
1638
    @since version 1.0.0
N
Niels 已提交
1639
    */
N
cleanup  
Niels 已提交
1640
    using number_integer_t = NumberIntegerType;
N
Niels 已提交
1641

1642 1643 1644 1645
    /*!
    @brief a type for a number (unsigned)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661
    > 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.
1662 1663 1664

    #### Default type

N
Niels 已提交
1665 1666
    With the default values for @a NumberUnsignedType (`uint64_t`), the
    default value for @a number_unsigned_t is:
1667 1668 1669 1670 1671 1672 1673 1674 1675 1676

    @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 已提交
1677 1678
      instance, the C++ integer literal `010` will be serialized to `8`.
      During deserialization, leading zeros yield an error.
1679 1680 1681 1682 1683 1684 1685 1686
    - 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 已提交
1687 1688 1689 1690 1691
    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.
1692 1693 1694 1695 1696 1697 1698

    [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 已提交
1699 1700
    number_integer_t type) of the exactly supported range [0, UINT64_MAX],
    this class's integer type is interoperable.
1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711

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

N
Niels 已提交
1713 1714 1715 1716
    /*!
    @brief a type for a number (floating-point)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729
    > 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 已提交
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745

    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 已提交
1746 1747
      leading zeros in floating-point literals will be ignored. Internally,
      the value will be stored as decimal number. For instance, the C++
N
Niels 已提交
1748 1749 1750 1751 1752 1753 1754 1755 1756 1757
      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 已提交
1758 1759 1760
    > 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 已提交
1761 1762 1763 1764
    > precision.

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

    #### Storage

1770 1771 1772 1773 1774
    Floating-point number values are stored directly inside a @ref basic_json
    type.

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

1775 1776
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
1777
    @since version 1.0.0
N
Niels 已提交
1778
    */
N
cleanup  
Niels 已提交
1779 1780
    using number_float_t = NumberFloatType;

N
Niels 已提交
1781 1782
    /// @}

N
Niels 已提交
1783
  private:
N
Niels 已提交
1784

1785 1786
    /// helper for exception-safe object creation
    template<typename T, typename... Args>
N
Cleanup  
Niels 已提交
1787
    static T* create(Args&& ... args)
1788 1789
    {
        AllocatorType<T> alloc;
N
cleanup  
Niels 已提交
1790
        auto deleter = [&](T * object)
N
Cleanup  
Niels 已提交
1791 1792 1793
        {
            alloc.deallocate(object, 1);
        };
1794 1795
        std::unique_ptr<T, decltype(deleter)> object(alloc.allocate(1), deleter);
        alloc.construct(object.get(), std::forward<Args>(args)...);
N
Niels Lohmann 已提交
1796
        assert(object != nullptr);
1797 1798 1799
        return object.release();
    }

N
cleanup  
Niels 已提交
1800 1801 1802 1803
    ////////////////////////
    // JSON value storage //
    ////////////////////////

1804 1805 1806
    /*!
    @brief a JSON value

N
Niels 已提交
1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824
    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.
1825

N
Niels 已提交
1826
    @since version 1.0.0
1827
    */
N
cleanup  
Niels 已提交
1828 1829 1830 1831 1832 1833 1834 1835
    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 已提交
1836
        /// boolean
N
cleanup  
Niels 已提交
1837 1838 1839
        boolean_t boolean;
        /// number (integer)
        number_integer_t number_integer;
1840 1841
        /// number (unsigned integer)
        number_unsigned_t number_unsigned;
N
Niels 已提交
1842
        /// number (floating-point)
N
cleanup  
Niels 已提交
1843 1844 1845
        number_float_t number_float;

        /// default constructor (for null values)
N
Niels 已提交
1846
        json_value() = default;
N
cleanup  
Niels 已提交
1847
        /// constructor for booleans
1848
        json_value(boolean_t v) noexcept : boolean(v) {}
N
cleanup  
Niels 已提交
1849
        /// constructor for numbers (integer)
1850
        json_value(number_integer_t v) noexcept : number_integer(v) {}
1851 1852
        /// constructor for numbers (unsigned)
        json_value(number_unsigned_t v) noexcept : number_unsigned(v) {}
N
Niels 已提交
1853
        /// constructor for numbers (floating-point)
1854
        json_value(number_float_t v) noexcept : number_float(v) {}
N
Niels 已提交
1855
        /// constructor for empty values of a given type
1856
        json_value(value_t t)
N
Niels 已提交
1857 1858 1859
        {
            switch (t)
            {
1860
                case value_t::object:
N
Niels 已提交
1861
                {
1862
                    object = create<object_t>();
N
Niels 已提交
1863 1864
                    break;
                }
N
cleanup  
Niels 已提交
1865

1866
                case value_t::array:
N
Niels 已提交
1867
                {
1868
                    array = create<array_t>();
N
Niels 已提交
1869 1870
                    break;
                }
N
cleanup  
Niels 已提交
1871

1872
                case value_t::string:
N
Niels 已提交
1873
                {
1874
                    string = create<string_t>("");
N
Niels 已提交
1875 1876
                    break;
                }
N
cleanup  
Niels 已提交
1877

1878
                case value_t::boolean:
N
Niels 已提交
1879 1880 1881 1882 1883
                {
                    boolean = boolean_t(false);
                    break;
                }

1884
                case value_t::number_integer:
N
Niels 已提交
1885 1886 1887 1888
                {
                    number_integer = number_integer_t(0);
                    break;
                }
N
Niels 已提交
1889

1890 1891 1892 1893 1894
                case value_t::number_unsigned:
                {
                    number_unsigned = number_unsigned_t(0);
                    break;
                }
N
Niels 已提交
1895

1896
                case value_t::number_float:
N
Niels 已提交
1897 1898 1899 1900
                {
                    number_float = number_float_t(0.0);
                    break;
                }
1901

1902 1903 1904 1905 1906
                case value_t::null:
                {
                    break;
                }

1907 1908
                default:
                {
1909 1910
                    if (t == value_t::null)
                    {
N
Niels Lohmann 已提交
1911
                        JSON_THROW(std::domain_error("961c151d2e87f2686a955a9be24d316f1362bf21 2.1.1")); // LCOV_EXCL_LINE
1912
                    }
1913 1914
                    break;
                }
N
Niels 已提交
1915 1916
            }
        }
N
Niels 已提交
1917 1918

        /// constructor for strings
1919
        json_value(const string_t& value)
N
Niels 已提交
1920
        {
1921
            string = create<string_t>(value);
N
Niels 已提交
1922 1923 1924
        }

        /// constructor for objects
1925
        json_value(const object_t& value)
N
Niels 已提交
1926
        {
1927
            object = create<object_t>(value);
N
Niels 已提交
1928 1929 1930
        }

        /// constructor for arrays
1931
        json_value(const array_t& value)
N
Niels 已提交
1932
        {
1933
            array = create<array_t>(value);
N
Niels 已提交
1934
        }
N
cleanup  
Niels 已提交
1935 1936
    };

1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951
    /*!
    @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 已提交
1952 1953

  public:
N
Niels 已提交
1954 1955 1956 1957
    //////////////////////////
    // JSON parser callback //
    //////////////////////////

N
Niels 已提交
1958 1959 1960 1961 1962
    /*!
    @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.
1963

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

N
Niels 已提交
1966
    @since version 1.0.0
N
Niels 已提交
1967
    */
N
Niels 已提交
1968 1969
    enum class parse_event_t : uint8_t
    {
N
Niels 已提交
1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981
        /// 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 已提交
1982 1983
    };

N
Niels 已提交
1984 1985 1986 1987
    /*!
    @brief per-element parser callback type

    With a parser callback function, the result of parsing a JSON text can be
N
Niels 已提交
1988
    influenced. When passed to @ref parse(std::istream&, const
1989
    parser_callback_t) or @ref parse(const CharT, const parser_callback_t),
N
Niels 已提交
1990 1991 1992 1993 1994
    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 已提交
1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008

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

N
Niels 已提交
2011 2012
    Discarding a value (i.e., returning `false`) has different effects
    depending on the context in which function was called:
N
Niels 已提交
2013 2014 2015

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

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

N
Niels 已提交
2021
    @param[in] event  an event of type parse_event_t indicating the context in
N
Niels 已提交
2022 2023 2024 2025 2026 2027 2028 2029 2030 2031
    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
2032
    @ref parse(const CharT, const parser_callback_t) for examples
2033

N
Niels 已提交
2034
    @since version 1.0.0
N
Niels 已提交
2035
    */
N
Niels 已提交
2036 2037 2038
    using parser_callback_t = std::function<bool(int depth,
                              parse_event_t event,
                              basic_json& parsed)>;
N
Niels 已提交
2039

N
cleanup  
Niels 已提交
2040 2041 2042 2043 2044

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

N
Niels 已提交
2045
    /// @name constructors and destructors
N
Niels 已提交
2046 2047
    /// Constructors of class @ref basic_json, copy/move constructor, copy
    /// assignment, static functions creating objects, and the destructor.
N
Niels 已提交
2048 2049
    /// @{

N
Niels 已提交
2050 2051 2052
    /*!
    @brief create an empty value with a given type

N
Niels 已提交
2053 2054 2055 2056 2057
    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 已提交
2058 2059 2060 2061 2062 2063
    null        | `null`
    boolean     | `false`
    string      | `""`
    number      | `0`
    object      | `{}`
    array       | `[]`
N
Niels 已提交
2064

2065
    @param[in] value_type  the type of the value to create
N
Niels 已提交
2066 2067 2068

    @complexity Constant.

N
Niels 已提交
2069
    @throw std::bad_alloc if allocation for object, array, or string value
N
Niels 已提交
2070
    fails
N
Niels 已提交
2071 2072 2073

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

N
Niels 已提交
2075
    @since version 1.0.0
N
Niels 已提交
2076
    */
2077 2078
    basic_json(const value_t value_type)
        : m_type(value_type), m_value(value_type)
2079 2080 2081
    {
        assert_invariant();
    }
N
cleanup  
Niels 已提交
2082

N
Niels 已提交
2083
    /*!
N
Niels 已提交
2084
    @brief create a null object
N
Niels 已提交
2085

N
Niels 已提交
2086 2087
    Create a `null` JSON value. It either takes a null pointer as parameter
    (explicitly creating `null`) or no parameter (implicitly creating `null`).
N
Niels 已提交
2088 2089
    The passed null pointer itself is not read -- it is only used to choose
    the right constructor.
N
Niels 已提交
2090 2091 2092

    @complexity Constant.

N
Niels 已提交
2093 2094 2095
    @exceptionsafety No-throw guarantee: this constructor never throws
    exceptions.

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

N
Niels 已提交
2099
    @since version 1.0.0
N
Niels 已提交
2100
    */
N
Niels 已提交
2101
    basic_json(std::nullptr_t = nullptr) noexcept
N
Niels 已提交
2102
        : basic_json(value_t::null)
2103 2104 2105
    {
        assert_invariant();
    }
N
cleanup  
Niels 已提交
2106

T
Théo DELRIEU 已提交
2107
    /*!
2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145
    @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 已提交
2146 2147 2148

    @param[in] val the value to be forwarded

2149 2150 2151 2152 2153 2154 2155 2156
    @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 已提交
2157 2158 2159

    @since version 2.1.0
    */
2160
    template<typename CompatibleType, typename U = detail::uncvref_t<CompatibleType>,
2161 2162 2163 2164 2165 2166
             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>
2167 2168
    basic_json(CompatibleType && val) noexcept(noexcept(JSONSerializer<U>::to_json(
                std::declval<basic_json_t&>(), std::forward<CompatibleType>(val))))
2169
    {
2170 2171
        JSONSerializer<U>::to_json(*this, std::forward<CompatibleType>(val));
        assert_invariant();
2172 2173
    }

N
Niels 已提交
2174 2175 2176 2177 2178 2179 2180 2181 2182 2183
    /*!
    @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 已提交
2184 2185
       object value is created where the first elements of the pairs are
       treated as keys and the second elements are as values.
N
Niels 已提交
2186 2187 2188
    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 已提交
2189
    JSON values. The rationale is as follows:
N
Niels 已提交
2190 2191

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

N
Niels 已提交
2200 2201
    With the rules described above, the following JSON values cannot be
    expressed by an initializer list:
N
Niels 已提交
2202

N
Niels 已提交
2203 2204 2205 2206 2207
    - 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 已提交
2208 2209 2210 2211 2212

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

N
Niels 已提交
2215 2216 2217
    @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 已提交
2218 2219
    used by the functions @ref array(std::initializer_list<basic_json>) and
    @ref object(std::initializer_list<basic_json>).
N
Niels 已提交
2220

N
Niels 已提交
2221 2222
    @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 已提交
2223 2224 2225
    value_t::array and @ref value_t::object are valid); when @a type_deduction
    is set to `true`, this parameter has no effect

2226 2227
    @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 已提交
2228 2229
    whose first element is a string; example: `"cannot create object from
    initializer list"`
N
Niels 已提交
2230 2231 2232 2233

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

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

N
Niels 已提交
2236
    @sa @ref array(std::initializer_list<basic_json>) -- create a JSON array
2237
    value from an initializer list
N
Niels 已提交
2238
    @sa @ref object(std::initializer_list<basic_json>) -- create a JSON object
2239 2240
    value from an initializer list

N
Niels 已提交
2241
    @since version 1.0.0
N
Niels 已提交
2242
    */
N
Niels 已提交
2243 2244
    basic_json(std::initializer_list<basic_json> init,
               bool type_deduction = true,
N
Niels 已提交
2245
               value_t manual_type = value_t::array)
N
cleanup  
Niels 已提交
2246
    {
N
Niels 已提交
2247 2248
        // check if each element is an array with two elements whose first
        // element is a string
N
Niels 已提交
2249 2250
        bool is_an_object = std::all_of(init.begin(), init.end(),
                                        [](const basic_json & element)
N
cleanup  
Niels 已提交
2251
        {
N
Niels 已提交
2252 2253
            return element.is_array() and element.size() == 2 and element[0].is_string();
        });
N
cleanup  
Niels 已提交
2254 2255 2256 2257 2258 2259 2260

        // 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)
            {
2261
                is_an_object = false;
N
cleanup  
Niels 已提交
2262 2263 2264
            }

            // if object is wanted but impossible, throw an exception
2265
            if (manual_type == value_t::object and not is_an_object)
N
cleanup  
Niels 已提交
2266
            {
2267
                JSON_THROW(type_error(301, "cannot create object from initializer list"));
N
cleanup  
Niels 已提交
2268 2269 2270
            }
        }

2271
        if (is_an_object)
N
cleanup  
Niels 已提交
2272 2273 2274
        {
            // the initializer list is a list of pairs -> create object
            m_type = value_t::object;
N
Niels 已提交
2275
            m_value = value_t::object;
N
Niels 已提交
2276

N
Niels 已提交
2277
            std::for_each(init.begin(), init.end(), [this](const basic_json & element)
N
cleanup  
Niels 已提交
2278
            {
N
Niels 已提交
2279
                m_value.object->emplace(*(element[0].m_value.string), element[1]);
N
Niels 已提交
2280
            });
N
cleanup  
Niels 已提交
2281 2282 2283 2284 2285
        }
        else
        {
            // the initializer list describes an array -> create array
            m_type = value_t::array;
N
Niels 已提交
2286
            m_value.array = create<array_t>(init);
N
cleanup  
Niels 已提交
2287
        }
2288 2289

        assert_invariant();
N
cleanup  
Niels 已提交
2290 2291
    }

N
Niels 已提交
2292 2293 2294 2295 2296 2297 2298
    /*!
    @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 已提交
2299 2300
    @note This function is only needed to express two edge cases that cannot
    be realized with the initializer list constructor (@ref
N
Niels 已提交
2301 2302
    basic_json(std::initializer_list<basic_json>, bool, value_t)). These cases
    are:
N
Niels 已提交
2303
    1. creating an array whose elements are all pairs whose first element is a
N
Niels 已提交
2304
    string -- in this case, the initializer list constructor would create an
N
Niels 已提交
2305
    object, taking the first elements as keys
N
Niels 已提交
2306
    2. creating an empty array -- passing the empty initializer list to the
N
Niels 已提交
2307 2308
    initializer list constructor yields an empty object

N
Niels 已提交
2309
    @param[in] init  initializer list with JSON values to create an array from
N
Niels 已提交
2310 2311 2312 2313 2314 2315
    (optional)

    @return JSON array value

    @complexity Linear in the size of @a init.

N
Niels 已提交
2316
    @liveexample{The following code shows an example for the `array`
N
Niels 已提交
2317 2318
    function.,array}

2319 2320 2321 2322 2323
    @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 已提交
2324
    @since version 1.0.0
N
Niels 已提交
2325
    */
N
Niels 已提交
2326
    static basic_json array(std::initializer_list<basic_json> init =
T
Théo DELRIEU 已提交
2327
                                std::initializer_list<basic_json>())
N
cleanup  
Niels 已提交
2328
    {
N
Niels 已提交
2329
        return basic_json(init, false, value_t::array);
N
cleanup  
Niels 已提交
2330 2331
    }

N
Niels 已提交
2332 2333 2334 2335
    /*!
    @brief explicitly create an object from an initializer list

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

    @note This function is only added for symmetry reasons. In contrast to the
2340 2341 2342
    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 已提交
2343 2344
    constructor @ref basic_json(std::initializer_list<basic_json>, bool,
    value_t).
N
Niels 已提交
2345

N
Niels 已提交
2346
    @param[in] init  initializer list to create an object from (optional)
N
Niels 已提交
2347 2348 2349

    @return JSON object value

2350
    @throw type_error.301 if @a init is not a pair whose first elements are
2351 2352
    strings; thrown by
    @ref basic_json(std::initializer_list<basic_json>, bool, value_t)
N
Niels 已提交
2353 2354 2355

    @complexity Linear in the size of @a init.

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

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

N
Niels 已提交
2372 2373 2374
    /*!
    @brief construct an array with count copies of given value

N
Niels 已提交
2375 2376
    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,
2377
    `std::distance(begin(),end()) == cnt` holds.
N
Niels 已提交
2378

2379 2380
    @param[in] cnt  the number of JSON copies of @a val to create
    @param[in] val  the JSON value to copy
N
Niels 已提交
2381

2382
    @complexity Linear in @a cnt.
N
Niels 已提交
2383 2384 2385 2386

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

N
Niels 已提交
2388
    @since version 1.0.0
N
Niels 已提交
2389
    */
2390
    basic_json(size_type cnt, const basic_json& val)
N
Niels 已提交
2391 2392
        : m_type(value_t::array)
    {
2393
        m_value.array = create<array_t>(cnt, val);
2394
        assert_invariant();
N
Niels 已提交
2395
    }
N
Niels 已提交
2396

N
Niels 已提交
2397 2398 2399 2400 2401
    /*!
    @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 已提交
2402
    - In case of primitive types (number, boolean, or string), @a first must
N
Niels 已提交
2403 2404
      be `begin()` and @a last must be `end()`. In this case, the value is
      copied. Otherwise, std::out_of_range is thrown.
N
Niels 已提交
2405 2406
    - In case of structured types (array, object), the constructor behaves as
      similar versions for `std::vector`.
N
Niels 已提交
2407
    - In case of a null type, std::domain_error is thrown.
N
Niels 已提交
2408 2409 2410 2411 2412 2413 2414

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

2418 2419 2420
    @throw invalid_iterator.201 if iterators are not compatible; that is, do
    not belong to the same JSON value; example: `"iterators are not
    compatible"`
2421
    @throw invalid_iterator.204 if iterators are for a primitive type (number,
N
Niels 已提交
2422 2423
    boolean, or string) where an out of range error can be detected easily;
    example: `"iterators out of range"`
N
Niels 已提交
2424
    @throw std::bad_alloc if allocation for object, array, or string fails
2425 2426
    @throw invalid_iterator.206 if called with a null value; example: `"cannot
    construct with iterators from null"`
N
Niels 已提交
2427 2428 2429 2430 2431

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

N
Niels 已提交
2433
    @since version 1.0.0
N
Niels 已提交
2434
    */
N
Niels 已提交
2435 2436 2437
    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 已提交
2438
    basic_json(InputIT first, InputIT last)
N
Niels 已提交
2439
    {
N
Niels 已提交
2440 2441 2442
        assert(first.m_object != nullptr);
        assert(last.m_object != nullptr);

N
Niels 已提交
2443
        // make sure iterator fits the current value
N
Niels 已提交
2444
        if (first.m_object != last.m_object)
N
Niels 已提交
2445
        {
2446
            JSON_THROW(invalid_iterator(201, "iterators are not compatible"));
N
Niels 已提交
2447 2448
        }

N
Niels 已提交
2449 2450 2451
        // copy type from first iterator
        m_type = first.m_object->m_type;

N
Niels 已提交
2452
        // check if iterator range is complete for primitive values
N
Niels 已提交
2453 2454 2455
        switch (m_type)
        {
            case value_t::boolean:
2456 2457
            case value_t::number_float:
            case value_t::number_integer:
2458
            case value_t::number_unsigned:
N
Niels 已提交
2459 2460
            case value_t::string:
            {
2461
                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
N
Niels 已提交
2462
                {
2463
                    JSON_THROW(invalid_iterator(204, "iterators out of range"));
N
Niels 已提交
2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480
                }
                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 已提交
2481

2482 2483 2484 2485 2486
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = first.m_object->m_value.number_unsigned;
                break;
            }
N
Niels 已提交
2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501

            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 已提交
2502
                m_value = *first.m_object->m_value.string;
N
Niels 已提交
2503 2504 2505 2506 2507
                break;
            }

            case value_t::object:
            {
N
Niels Lohmann 已提交
2508 2509
                m_value.object = create<object_t>(first.m_it.object_iterator,
                                                  last.m_it.object_iterator);
N
Niels 已提交
2510 2511 2512 2513 2514
                break;
            }

            case value_t::array:
            {
N
Niels Lohmann 已提交
2515 2516
                m_value.array = create<array_t>(first.m_it.array_iterator,
                                                last.m_it.array_iterator);
N
Niels 已提交
2517 2518 2519 2520 2521
                break;
            }

            default:
            {
2522 2523
                JSON_THROW(invalid_iterator(206, "cannot construct with iterators from " +
                                            first.m_object->type_name()));
N
Niels 已提交
2524 2525
            }
        }
2526 2527

        assert_invariant();
N
Niels 已提交
2528 2529
    }

N
Niels 已提交
2530

N
cleanup  
Niels 已提交
2531 2532 2533 2534
    ///////////////////////////////////////
    // other constructors and destructor //
    ///////////////////////////////////////

N
Niels 已提交
2535 2536
    /*!
    @brief copy constructor
N
Niels 已提交
2537

N
Niels 已提交
2538 2539
    Creates a copy of a given JSON value.

N
Niels 已提交
2540
    @param[in] other  the JSON value to copy
N
Niels 已提交
2541 2542 2543

    @complexity Linear in the size of @a other.

N
Niels 已提交
2544 2545 2546
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2547 2548 2549
    - The complexity is linear.
    - As postcondition, it holds: `other == basic_json(other)`.

N
Niels 已提交
2550
    @throw std::bad_alloc if allocation for object, array, or string fails.
N
Niels 已提交
2551 2552

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

N
Niels 已提交
2555
    @since version 1.0.0
N
Niels 已提交
2556
    */
2557
    basic_json(const basic_json& other)
N
cleanup  
Niels 已提交
2558 2559
        : m_type(other.m_type)
    {
2560 2561 2562
        // check of passed value is valid
        other.assert_invariant();

N
cleanup  
Niels 已提交
2563 2564
        switch (m_type)
        {
2565
            case value_t::object:
N
cleanup  
Niels 已提交
2566
            {
N
Niels 已提交
2567
                m_value = *other.m_value.object;
N
cleanup  
Niels 已提交
2568 2569
                break;
            }
N
Niels 已提交
2570

2571
            case value_t::array:
N
cleanup  
Niels 已提交
2572
            {
N
Niels 已提交
2573
                m_value = *other.m_value.array;
N
cleanup  
Niels 已提交
2574 2575
                break;
            }
N
Niels 已提交
2576

2577
            case value_t::string:
N
cleanup  
Niels 已提交
2578
            {
N
Niels 已提交
2579
                m_value = *other.m_value.string;
N
cleanup  
Niels 已提交
2580 2581
                break;
            }
N
Niels 已提交
2582

2583
            case value_t::boolean:
N
cleanup  
Niels 已提交
2584
            {
N
Niels 已提交
2585
                m_value = other.m_value.boolean;
N
cleanup  
Niels 已提交
2586 2587
                break;
            }
N
Niels 已提交
2588

2589
            case value_t::number_integer:
N
cleanup  
Niels 已提交
2590
            {
N
Niels 已提交
2591
                m_value = other.m_value.number_integer;
N
cleanup  
Niels 已提交
2592 2593
                break;
            }
N
Niels 已提交
2594

2595 2596 2597 2598 2599
            case value_t::number_unsigned:
            {
                m_value = other.m_value.number_unsigned;
                break;
            }
N
Niels 已提交
2600

2601
            case value_t::number_float:
N
cleanup  
Niels 已提交
2602
            {
N
Niels 已提交
2603
                m_value = other.m_value.number_float;
N
cleanup  
Niels 已提交
2604 2605
                break;
            }
2606 2607 2608 2609 2610

            default:
            {
                break;
            }
N
cleanup  
Niels 已提交
2611
        }
2612 2613

        assert_invariant();
N
cleanup  
Niels 已提交
2614 2615
    }

N
Niels 已提交
2616 2617 2618 2619 2620 2621 2622
    /*!
    @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 已提交
2623
    @param[in,out] other  value to move to this object
N
Niels 已提交
2624 2625 2626 2627 2628 2629 2630

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

N
Niels 已提交
2632
    @since version 1.0.0
N
Niels 已提交
2633
    */
2634
    basic_json(basic_json&& other) noexcept
N
Niels 已提交
2635 2636
        : m_type(std::move(other.m_type)),
          m_value(std::move(other.m_value))
N
cleanup  
Niels 已提交
2637
    {
2638 2639 2640
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2641
        // invalidate payload
N
cleanup  
Niels 已提交
2642 2643
        other.m_type = value_t::null;
        other.m_value = {};
2644 2645

        assert_invariant();
N
cleanup  
Niels 已提交
2646 2647
    }

N
Niels 已提交
2648 2649
    /*!
    @brief copy assignment
N
Niels 已提交
2650

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

N
Niels 已提交
2655
    @param[in] other  value to copy from
N
Niels 已提交
2656 2657 2658

    @complexity Linear.

N
Niels 已提交
2659 2660 2661
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2662 2663
    - The complexity is linear.

N
Niels 已提交
2664 2665 2666 2667
    @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 已提交
2668

N
Niels 已提交
2669
    @since version 1.0.0
N
Niels 已提交
2670
    */
2671
    reference& operator=(basic_json other) noexcept (
N
Niels 已提交
2672 2673 2674 2675
        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 已提交
2676
    )
N
cleanup  
Niels 已提交
2677
    {
2678 2679 2680
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2681
        using std::swap;
C
Colin Hirsch 已提交
2682 2683
        swap(m_type, other.m_type);
        swap(m_value, other.m_value);
2684 2685

        assert_invariant();
N
cleanup  
Niels 已提交
2686 2687 2688
        return *this;
    }

N
Niels 已提交
2689 2690
    /*!
    @brief destructor
N
Niels 已提交
2691

N
Niels 已提交
2692
    Destroys the JSON value and frees all allocated memory.
N
Niels 已提交
2693 2694 2695

    @complexity Linear.

N
Niels 已提交
2696 2697 2698
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2699 2700
    - The complexity is linear.
    - All stored elements are destroyed and all memory is freed.
2701

N
Niels 已提交
2702
    @since version 1.0.0
N
Niels 已提交
2703
    */
N
Niels 已提交
2704
    ~basic_json()
N
cleanup  
Niels 已提交
2705
    {
2706 2707
        assert_invariant();

N
cleanup  
Niels 已提交
2708 2709
        switch (m_type)
        {
2710
            case value_t::object:
N
cleanup  
Niels 已提交
2711
            {
N
Niels 已提交
2712
                AllocatorType<object_t> alloc;
N
Niels 已提交
2713 2714
                alloc.destroy(m_value.object);
                alloc.deallocate(m_value.object, 1);
N
cleanup  
Niels 已提交
2715 2716
                break;
            }
N
Niels 已提交
2717

2718
            case value_t::array:
N
cleanup  
Niels 已提交
2719
            {
N
Niels 已提交
2720
                AllocatorType<array_t> alloc;
N
Niels 已提交
2721 2722
                alloc.destroy(m_value.array);
                alloc.deallocate(m_value.array, 1);
N
cleanup  
Niels 已提交
2723 2724
                break;
            }
N
Niels 已提交
2725

2726
            case value_t::string:
N
cleanup  
Niels 已提交
2727
            {
N
Niels 已提交
2728
                AllocatorType<string_t> alloc;
N
Niels 已提交
2729
                alloc.destroy(m_value.string);
N
Niels 已提交
2730
                alloc.deallocate(m_value.string, 1);
N
cleanup  
Niels 已提交
2731 2732
                break;
            }
N
Niels 已提交
2733 2734

            default:
N
cleanup  
Niels 已提交
2735
            {
N
Niels 已提交
2736
                // all other types need no specific destructor
N
cleanup  
Niels 已提交
2737 2738 2739 2740 2741
                break;
            }
        }
    }

N
Niels 已提交
2742
    /// @}
N
cleanup  
Niels 已提交
2743 2744 2745 2746 2747 2748

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

N
Niels 已提交
2749
    /// @name object inspection
N
Niels 已提交
2750
    /// Functions to inspect the type of a JSON value.
N
Niels 已提交
2751 2752
    /// @{

N
cleanup  
Niels 已提交
2753
    /*!
N
Niels 已提交
2754 2755
    @brief serialization

N
Niels 已提交
2756
    Serialization function for JSON values. The function tries to mimic
N
Niels 已提交
2757
    Python's `json.dumps()` function, and currently supports its @a indent
N
Niels 已提交
2758
    parameter.
N
cleanup  
Niels 已提交
2759

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

N
Niels 已提交
2765 2766 2767 2768 2769
    @return string containing the serialization of the JSON value

    @complexity Linear.

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

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

N
Niels 已提交
2774
    @since version 1.0.0
N
cleanup  
Niels 已提交
2775
    */
N
Niels 已提交
2776
    string_t dump(const int indent = -1) const
N
cleanup  
Niels 已提交
2777
    {
N
Niels 已提交
2778
        std::stringstream ss;
2779
        serializer s(ss);
2780

N
cleanup  
Niels 已提交
2781 2782
        if (indent >= 0)
        {
2783
            s.dump(*this, true, static_cast<unsigned int>(indent));
N
cleanup  
Niels 已提交
2784 2785 2786
        }
        else
        {
2787
            s.dump(*this, false, 0);
N
cleanup  
Niels 已提交
2788
        }
N
Niels 已提交
2789 2790

        return ss.str();
N
cleanup  
Niels 已提交
2791 2792
    }

N
Niels 已提交
2793 2794 2795 2796 2797 2798 2799
    /*!
    @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 已提交
2800 2801 2802

    @complexity Constant.

N
Niels 已提交
2803 2804 2805
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2806
    @liveexample{The following code exemplifies `type()` for all JSON
N
Niels 已提交
2807
    types.,type}
N
Niels 已提交
2808

N
Niels 已提交
2809
    @since version 1.0.0
N
Niels 已提交
2810
    */
N
Niels 已提交
2811
    constexpr value_t type() const noexcept
N
cleanup  
Niels 已提交
2812 2813 2814 2815
    {
        return m_type;
    }

N
Niels 已提交
2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826
    /*!
    @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 已提交
2827 2828 2829
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2830
    @liveexample{The following code exemplifies `is_primitive()` for all JSON
N
Niels 已提交
2831
    types.,is_primitive}
N
Niels 已提交
2832

N
Niels 已提交
2833 2834 2835 2836 2837 2838
    @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 已提交
2839
    @since version 1.0.0
N
Niels 已提交
2840
    */
N
Niels 已提交
2841
    constexpr bool is_primitive() const noexcept
N
Niels 已提交
2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855
    {
        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 已提交
2856 2857 2858
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2859
    @liveexample{The following code exemplifies `is_structured()` for all JSON
N
Niels 已提交
2860
    types.,is_structured}
N
Niels 已提交
2861

N
Niels 已提交
2862 2863 2864 2865
    @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 已提交
2866
    @since version 1.0.0
N
Niels 已提交
2867
    */
N
Niels 已提交
2868
    constexpr bool is_structured() const noexcept
N
Niels 已提交
2869 2870 2871 2872
    {
        return is_array() or is_object();
    }

N
Niels 已提交
2873 2874 2875 2876 2877
    /*!
    @brief return whether value is null

    This function returns true iff the JSON value is null.

N
Niels 已提交
2878
    @return `true` if type is null, `false` otherwise.
N
Niels 已提交
2879 2880 2881

    @complexity Constant.

N
Niels 已提交
2882 2883 2884
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

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

N
Niels 已提交
2888
    @since version 1.0.0
N
Niels 已提交
2889
    */
N
Niels 已提交
2890
    constexpr bool is_null() const noexcept
N
Niels 已提交
2891 2892 2893 2894
    {
        return m_type == value_t::null;
    }

N
Niels 已提交
2895 2896 2897 2898 2899
    /*!
    @brief return whether value is a boolean

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

N
Niels 已提交
2900
    @return `true` if type is boolean, `false` otherwise.
N
Niels 已提交
2901 2902 2903

    @complexity Constant.

N
Niels 已提交
2904 2905 2906
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2907
    @liveexample{The following code exemplifies `is_boolean()` for all JSON
N
Niels 已提交
2908
    types.,is_boolean}
N
Niels 已提交
2909

N
Niels 已提交
2910
    @since version 1.0.0
N
Niels 已提交
2911
    */
N
Niels 已提交
2912
    constexpr bool is_boolean() const noexcept
N
Niels 已提交
2913 2914 2915 2916
    {
        return m_type == value_t::boolean;
    }

N
Niels 已提交
2917 2918 2919 2920 2921 2922
    /*!
    @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.

2923 2924
    @return `true` if type is number (regardless whether integer, unsigned
    integer or floating-type), `false` otherwise.
N
Niels 已提交
2925 2926 2927

    @complexity Constant.

N
Niels 已提交
2928 2929 2930
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2931
    @liveexample{The following code exemplifies `is_number()` for all JSON
N
Niels 已提交
2932
    types.,is_number}
N
Niels 已提交
2933

N
Niels 已提交
2934
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
2935
    integer number
N
Niels 已提交
2936 2937
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2938 2939
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
2940
    @since version 1.0.0
N
Niels 已提交
2941
    */
N
Niels 已提交
2942
    constexpr bool is_number() const noexcept
N
Niels 已提交
2943
    {
N
Niels 已提交
2944
        return is_number_integer() or is_number_float();
N
Niels 已提交
2945 2946
    }

N
Niels 已提交
2947 2948 2949
    /*!
    @brief return whether value is an integer number

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

N
Niels 已提交
2953
    @return `true` if type is an integer or unsigned integer number, `false`
2954
    otherwise.
N
Niels 已提交
2955 2956 2957

    @complexity Constant.

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

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

    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
2965 2966
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2967 2968
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
2969
    @since version 1.0.0
N
Niels 已提交
2970
    */
N
Niels 已提交
2971
    constexpr bool is_number_integer() const noexcept
N
Niels 已提交
2972
    {
2973 2974
        return m_type == value_t::number_integer or m_type == value_t::number_unsigned;
    }
N
Niels 已提交
2975

2976 2977 2978
    /*!
    @brief return whether value is an unsigned integer number

N
Niels 已提交
2979 2980
    This function returns true iff the JSON value is an unsigned integer
    number. This excludes floating-point and (signed) integer values.
2981 2982 2983 2984 2985

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

    @complexity Constant.

N
Niels 已提交
2986 2987 2988
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2989
    @liveexample{The following code exemplifies `is_number_unsigned()` for all
N
Niels 已提交
2990 2991
    JSON types.,is_number_unsigned}

2992
    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
2993
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
2994 2995 2996 2997 2998
    integer number
    @sa @ref is_number_float() -- check if value is a floating-point number

    @since version 2.0.0
    */
N
Niels 已提交
2999
    constexpr bool is_number_unsigned() const noexcept
3000 3001
    {
        return m_type == value_t::number_unsigned;
N
Niels 已提交
3002 3003
    }

N
Niels 已提交
3004 3005 3006 3007
    /*!
    @brief return whether value is a floating-point number

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

N
Niels 已提交
3010
    @return `true` if type is a floating-point number, `false` otherwise.
N
Niels 已提交
3011 3012 3013

    @complexity Constant.

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

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

    @sa @ref is_number() -- check if value is number
    @sa @ref is_number_integer() -- check if value is an integer number
N
Niels 已提交
3022 3023
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
3024

N
Niels 已提交
3025
    @since version 1.0.0
N
Niels 已提交
3026
    */
N
Niels 已提交
3027
    constexpr bool is_number_float() const noexcept
N
Niels 已提交
3028 3029 3030 3031
    {
        return m_type == value_t::number_float;
    }

N
Niels 已提交
3032 3033 3034 3035 3036
    /*!
    @brief return whether value is an object

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

N
Niels 已提交
3037
    @return `true` if type is object, `false` otherwise.
N
Niels 已提交
3038 3039 3040

    @complexity Constant.

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

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

N
Niels 已提交
3047
    @since version 1.0.0
N
Niels 已提交
3048
    */
N
Niels 已提交
3049
    constexpr bool is_object() const noexcept
N
Niels 已提交
3050 3051 3052 3053
    {
        return m_type == value_t::object;
    }

N
Niels 已提交
3054 3055 3056 3057 3058
    /*!
    @brief return whether value is an array

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

N
Niels 已提交
3059
    @return `true` if type is array, `false` otherwise.
N
Niels 已提交
3060 3061 3062

    @complexity Constant.

N
Niels 已提交
3063 3064 3065
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3066
    @liveexample{The following code exemplifies `is_array()` for all JSON
N
Niels 已提交
3067
    types.,is_array}
N
Niels 已提交
3068

N
Niels 已提交
3069
    @since version 1.0.0
N
Niels 已提交
3070
    */
N
Niels 已提交
3071
    constexpr bool is_array() const noexcept
N
Niels 已提交
3072 3073 3074 3075
    {
        return m_type == value_t::array;
    }

N
Niels 已提交
3076 3077 3078 3079 3080
    /*!
    @brief return whether value is a string

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

N
Niels 已提交
3081
    @return `true` if type is string, `false` otherwise.
N
Niels 已提交
3082 3083 3084

    @complexity Constant.

N
Niels 已提交
3085 3086 3087
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3088
    @liveexample{The following code exemplifies `is_string()` for all JSON
N
Niels 已提交
3089
    types.,is_string}
N
Niels 已提交
3090

N
Niels 已提交
3091
    @since version 1.0.0
N
Niels 已提交
3092
    */
N
Niels 已提交
3093
    constexpr bool is_string() const noexcept
N
Niels 已提交
3094 3095 3096 3097
    {
        return m_type == value_t::string;
    }

N
Niels 已提交
3098 3099 3100 3101 3102 3103
    /*!
    @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 已提交
3104 3105 3106 3107
    @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 已提交
3108 3109 3110 3111
    @return `true` if type is discarded, `false` otherwise.

    @complexity Constant.

N
Niels 已提交
3112 3113 3114
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3115
    @liveexample{The following code exemplifies `is_discarded()` for all JSON
N
Niels 已提交
3116
    types.,is_discarded}
N
Niels 已提交
3117

N
Niels 已提交
3118
    @since version 1.0.0
N
Niels 已提交
3119
    */
N
Niels 已提交
3120
    constexpr bool is_discarded() const noexcept
N
Niels 已提交
3121 3122 3123 3124
    {
        return m_type == value_t::discarded;
    }

N
Niels 已提交
3125 3126 3127 3128 3129 3130 3131 3132 3133 3134
    /*!
    @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 已提交
3135 3136 3137
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

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

N
Niels 已提交
3141
    @since version 1.0.0
N
Niels 已提交
3142
    */
N
Niels 已提交
3143
    constexpr operator value_t() const noexcept
N
Niels 已提交
3144 3145 3146 3147
    {
        return m_type;
    }

N
Niels 已提交
3148 3149
    /// @}

N
Niels 已提交
3150
  private:
N
Niels Lohmann 已提交
3151 3152 3153 3154
    //////////////////
    // value access //
    //////////////////

N
Niels 已提交
3155
    /// get a boolean (explicit)
3156
    boolean_t get_impl(boolean_t* /*unused*/) const
N
Niels 已提交
3157
    {
3158 3159 3160 3161
        if (is_boolean())
        {
            return m_value.boolean;
        }
N
Niels Lohmann 已提交
3162 3163

        JSON_THROW(std::domain_error("type must be boolean, but is " + type_name()));
N
cleanup  
Niels 已提交
3164 3165
    }

N
Niels 已提交
3166
    /// get a pointer to the value (object)
N
Niels Lohmann 已提交
3167
    object_t* get_impl_ptr(object_t* /*unused*/) noexcept
N
Niels 已提交
3168 3169 3170 3171 3172
    {
        return is_object() ? m_value.object : nullptr;
    }

    /// get a pointer to the value (object)
N
Niels Lohmann 已提交
3173
    constexpr const object_t* get_impl_ptr(const object_t* /*unused*/) const noexcept
N
Niels 已提交
3174 3175 3176 3177 3178
    {
        return is_object() ? m_value.object : nullptr;
    }

    /// get a pointer to the value (array)
N
Niels Lohmann 已提交
3179
    array_t* get_impl_ptr(array_t* /*unused*/) noexcept
N
Niels 已提交
3180 3181 3182 3183
    {
        return is_array() ? m_value.array : nullptr;
    }

N
Niels 已提交
3184
    /// get a pointer to the value (array)
N
Niels Lohmann 已提交
3185
    constexpr const array_t* get_impl_ptr(const array_t* /*unused*/) const noexcept
N
Niels 已提交
3186 3187 3188 3189 3190
    {
        return is_array() ? m_value.array : nullptr;
    }

    /// get a pointer to the value (string)
N
Niels Lohmann 已提交
3191
    string_t* get_impl_ptr(string_t* /*unused*/) noexcept
N
Niels 已提交
3192 3193 3194 3195
    {
        return is_string() ? m_value.string : nullptr;
    }

N
Niels 已提交
3196
    /// get a pointer to the value (string)
N
Niels Lohmann 已提交
3197
    constexpr const string_t* get_impl_ptr(const string_t* /*unused*/) const noexcept
N
Niels 已提交
3198 3199 3200 3201 3202
    {
        return is_string() ? m_value.string : nullptr;
    }

    /// get a pointer to the value (boolean)
N
Niels Lohmann 已提交
3203
    boolean_t* get_impl_ptr(boolean_t* /*unused*/) noexcept
N
Niels 已提交
3204 3205 3206 3207 3208
    {
        return is_boolean() ? &m_value.boolean : nullptr;
    }

    /// get a pointer to the value (boolean)
N
Niels Lohmann 已提交
3209
    constexpr const boolean_t* get_impl_ptr(const boolean_t* /*unused*/) const noexcept
N
Niels 已提交
3210 3211 3212 3213 3214
    {
        return is_boolean() ? &m_value.boolean : nullptr;
    }

    /// get a pointer to the value (integer number)
N
Niels Lohmann 已提交
3215
    number_integer_t* get_impl_ptr(number_integer_t* /*unused*/) noexcept
N
Niels 已提交
3216 3217 3218 3219
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }

N
Niels 已提交
3220
    /// get a pointer to the value (integer number)
N
Niels Lohmann 已提交
3221
    constexpr const number_integer_t* get_impl_ptr(const number_integer_t* /*unused*/) const noexcept
N
Niels 已提交
3222 3223 3224
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }
N
Niels 已提交
3225

3226
    /// get a pointer to the value (unsigned number)
N
Niels Lohmann 已提交
3227
    number_unsigned_t* get_impl_ptr(number_unsigned_t* /*unused*/) noexcept
3228 3229 3230
    {
        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
    }
N
Niels 已提交
3231

3232
    /// get a pointer to the value (unsigned number)
N
Niels Lohmann 已提交
3233
    constexpr const number_unsigned_t* get_impl_ptr(const number_unsigned_t* /*unused*/) const noexcept
3234 3235 3236
    {
        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
    }
N
Niels 已提交
3237

N
Niels 已提交
3238
    /// get a pointer to the value (floating-point number)
N
Niels Lohmann 已提交
3239
    number_float_t* get_impl_ptr(number_float_t* /*unused*/) noexcept
N
Niels 已提交
3240 3241 3242 3243
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

N
Niels 已提交
3244
    /// get a pointer to the value (floating-point number)
N
Niels Lohmann 已提交
3245
    constexpr const number_float_t* get_impl_ptr(const number_float_t* /*unused*/) const noexcept
N
Niels 已提交
3246 3247 3248 3249
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

N
Niels 已提交
3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261
    /*!
    @brief helper function to implement get_ref()

    This funcion helps to implement get_ref() without code duplication for
    const and non-const overloads

    @tparam ThisType will be deduced as `basic_json` or `const basic_json`

    @throw std::domain_error if ReferenceType does not match underlying value
    type of the current JSON
    */
    template<typename ReferenceType, typename ThisType>
3262
    static ReferenceType get_ref_impl(ThisType& obj)
D
dariomt 已提交
3263
    {
N
Niels 已提交
3264
        // helper type
N
Niels 已提交
3265 3266
        using PointerType = typename std::add_pointer<ReferenceType>::type;

N
Niels 已提交
3267
        // delegate the call to get_ptr<>()
3268 3269 3270 3271 3272 3273
        auto ptr = obj.template get_ptr<PointerType>();

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

3275 3276
        JSON_THROW(std::domain_error("incompatible ReferenceType for get_ref, actual type is " +
                                     obj.type_name()));
D
dariomt 已提交
3277 3278
    }

N
Niels 已提交
3279
  public:
N
Niels Lohmann 已提交
3280 3281 3282 3283
    /// @name value access
    /// Direct access to the stored value of a JSON value.
    /// @{

T
Théo DELRIEU 已提交
3284 3285 3286
    /*!
    @brief get special-case overload

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

N
Niels Lohmann 已提交
3290
    @tparam BasicJsonType == @ref basic_json
T
Théo DELRIEU 已提交
3291 3292 3293 3294 3295 3296 3297

    @return a copy of *this

    @complexity Constant.

    @since version 2.1.0
    */
3298
    template <
N
Niels Lohmann 已提交
3299 3300
        typename BasicJsonType,
        detail::enable_if_t<std::is_same<typename std::remove_const<BasicJsonType>::type,
3301 3302
                                         basic_json_t>::value,
                            int> = 0 >
3303 3304
    basic_json get() const
    {
T
Théo DELRIEU 已提交
3305
        return *this;
3306 3307
    }

T
Théo DELRIEU 已提交
3308
    /*!
N
Niels Lohmann 已提交
3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322
    @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 已提交
3323 3324

    This overloads is chosen if:
N
Niels Lohmann 已提交
3325 3326 3327 3328 3329 3330 3331 3332
    - @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 已提交
3333

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

N
Niels Lohmann 已提交
3336 3337 3338 3339 3340 3341 3342 3343
    @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 已提交
3344 3345 3346

    @since version 2.1.0
    */
3347
    template <
N
Niels Lohmann 已提交
3348 3349
        typename ValueTypeCV,
        typename ValueType = detail::uncvref_t<ValueTypeCV>,
3350
        detail::enable_if_t <
N
Niels Lohmann 已提交
3351 3352 3353
            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 已提交
3354
            int > = 0 >
N
Niels Lohmann 已提交
3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367
    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 已提交
3368
        return ret;
3369 3370
    }

T
Théo DELRIEU 已提交
3371
    /*!
N
Niels Lohmann 已提交
3372 3373 3374 3375 3376 3377 3378
    @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 已提交
3379

N
Niels Lohmann 已提交
3380 3381 3382 3383
    The function is equivalent to executing
    @code {.cpp}
    return JSONSerializer<ValueTypeCV>::from_json(*this);
    @endcode
T
Théo DELRIEU 已提交
3384 3385

    This overloads is chosen if:
N
Niels Lohmann 已提交
3386 3387 3388 3389 3390 3391 3392 3393 3394
    - @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 已提交
3395

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

N
Niels Lohmann 已提交
3398
    @throw what @ref json_serializer<ValueType> `from_json()` method throws
T
Théo DELRIEU 已提交
3399 3400 3401

    @since version 2.1.0
    */
3402
    template <
N
Niels Lohmann 已提交
3403 3404 3405
        typename ValueTypeCV,
        typename ValueType = detail::uncvref_t<ValueTypeCV>,
        detail::enable_if_t<not std::is_same<basic_json_t, ValueType>::value and
3406
                            detail::has_non_default_from_json<basic_json_t,
N
Niels Lohmann 已提交
3407 3408 3409
                                    ValueType>::value, int> = 0 >
    ValueType get() const noexcept(noexcept(
                                       JSONSerializer<ValueTypeCV>::from_json(std::declval<const basic_json_t&>())))
3410
    {
N
Niels Lohmann 已提交
3411 3412 3413
        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);
3414 3415
    }

N
Niels 已提交
3416 3417 3418 3419 3420 3421
    /*!
    @brief get a pointer value (explicit)

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

N
Niels 已提交
3422 3423
    @warning The pointer becomes invalid if the underlying JSON object
    changes.
N
Niels 已提交
3424 3425

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

N
Niels 已提交
3429 3430
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
3431 3432 3433 3434 3435 3436 3437 3438 3439

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

N
Niels 已提交
3441
    @since version 1.0.0
N
Niels 已提交
3442
    */
N
Niels 已提交
3443 3444
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3445 3446 3447 3448 3449 3450 3451 3452 3453 3454
    PointerType get() noexcept
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

    /*!
    @brief get a pointer value (explicit)
    @copydoc get()
    */
N
Niels 已提交
3455 3456
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3457
    constexpr const PointerType get() const noexcept
N
Niels 已提交
3458 3459 3460 3461 3462 3463 3464 3465
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

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

N
Niels 已提交
3466
    Implicit pointer access to the internally stored JSON value. No copies are
N
Niels 已提交
3467 3468 3469 3470 3471 3472
    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 已提交
3473
    object_t, @ref string_t, @ref boolean_t, @ref number_integer_t,
N
Niels 已提交
3474 3475
    @ref number_unsigned_t, or @ref number_float_t. Enforced by a static
    assertion.
N
Niels 已提交
3476

N
Niels 已提交
3477 3478
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
3479 3480 3481 3482 3483 3484 3485

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

N
Niels 已提交
3487
    @since version 1.0.0
N
Niels 已提交
3488
    */
N
Niels 已提交
3489 3490
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3491 3492
    PointerType get_ptr() noexcept
    {
N
Niels 已提交
3493 3494
        // get the type of the PointerType (remove pointer and const)
        using pointee_t = typename std::remove_const<typename
T
Théo DELRIEU 已提交
3495 3496
                          std::remove_pointer<typename
                          std::remove_const<PointerType>::type>::type>::type;
N
Niels 已提交
3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507
        // 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 已提交
3508 3509 3510 3511 3512 3513 3514 3515
        // 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 已提交
3516 3517 3518
    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 已提交
3519
    constexpr const PointerType get_ptr() const noexcept
N
Niels 已提交
3520
    {
N
Niels 已提交
3521 3522
        // get the type of the PointerType (remove pointer and const)
        using pointee_t = typename std::remove_const<typename
T
Théo DELRIEU 已提交
3523 3524
                          std::remove_pointer<typename
                          std::remove_const<PointerType>::type>::type>::type;
N
Niels 已提交
3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535
        // 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 已提交
3536 3537
        // delegate the call to get_impl_ptr<>() const
        return get_impl_ptr(static_cast<const PointerType>(nullptr));
N
Niels 已提交
3538 3539
    }

N
Niels 已提交
3540
    /*!
D
dariomt 已提交
3541 3542
    @brief get a reference value (implicit)

N
Niels Lohmann 已提交
3543
    Implicit reference access to the internally stored JSON value. No copies
N
Niels 已提交
3544
    are made.
D
dariomt 已提交
3545 3546 3547 3548

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

N
Niels 已提交
3549 3550
    @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 已提交
3551
    @ref number_float_t. Enforced by static assertion.
D
dariomt 已提交
3552

N
Niels 已提交
3553 3554 3555
    @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 已提交
3556

N
Niels 已提交
3557 3558
    @throw std::domain_error in case passed type @a ReferenceType is
    incompatible with the stored JSON value
D
dariomt 已提交
3559 3560

    @complexity Constant.
N
Niels 已提交
3561 3562 3563

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

N
Niels 已提交
3564
    @since version 1.1.0
D
dariomt 已提交
3565
    */
N
Niels 已提交
3566 3567
    template<typename ReferenceType, typename std::enable_if<
                 std::is_reference<ReferenceType>::value, int>::type = 0>
D
dariomt 已提交
3568 3569
    ReferenceType get_ref()
    {
N
Niels 已提交
3570 3571
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
D
dariomt 已提交
3572 3573 3574 3575 3576 3577
    }

    /*!
    @brief get a reference value (implicit)
    @copydoc get_ref()
    */
N
Niels 已提交
3578 3579 3580
    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>
3581
    ReferenceType get_ref() const
D
dariomt 已提交
3582
    {
N
Niels 已提交
3583 3584
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
D
dariomt 已提交
3585 3586
    }

N
Niels 已提交
3587 3588 3589
    /*!
    @brief get a value (implicit)

N
Niels 已提交
3590 3591
    Implicit type conversion between the JSON value and a compatible value.
    The call is realized by calling @ref get() const.
N
Niels 已提交
3592 3593 3594

    @tparam ValueType non-pointer type compatible to the JSON value, for
    instance `int` for JSON integer numbers, `bool` for JSON booleans, or
N
Niels 已提交
3595 3596 3597
    `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 已提交
3598 3599 3600 3601 3602 3603 3604 3605

    @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 已提交
3606
    @liveexample{The example below shows several conversions from JSON values
N
Niels 已提交
3607 3608 3609
    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 已提交
3610
    associative containers such as `std::unordered_map<std::string\,
N
Niels 已提交
3611
    json>`.,operator__ValueType}
N
Niels 已提交
3612

N
Niels 已提交
3613
    @since version 1.0.0
N
Niels 已提交
3614
    */
N
Niels 已提交
3615 3616 3617
    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 已提交
3618
#ifndef _MSC_VER  // fix for issue #167 operator<< ambiguity under VS2015
N
Niels 已提交
3619
                   and not std::is_same<ValueType, std::initializer_list<typename string_t::value_type>>::value
3620
#endif
N
Niels 已提交
3621
                   , int >::type = 0 >
N
Niels 已提交
3622
    operator ValueType() const
N
cleanup  
Niels 已提交
3623
    {
N
Niels 已提交
3624 3625
        // delegate the call to get<>() const
        return get<ValueType>();
N
cleanup  
Niels 已提交
3626 3627
    }

N
Niels 已提交
3628 3629
    /// @}

N
cleanup  
Niels 已提交
3630 3631 3632 3633 3634

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

N
Niels 已提交
3635
    /// @name element access
N
Niels 已提交
3636
    /// Access to the JSON value.
N
Niels 已提交
3637 3638
    /// @{

N
Niels 已提交
3639 3640 3641 3642 3643 3644 3645 3646 3647 3648
    /*!
    @brief access specified array element with bounds checking

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

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

    @return reference to the element at index @a idx

N
Niels 已提交
3649 3650
    @throw std::domain_error if the JSON value is not an array; example:
    `"cannot use at() with string"`
N
Niels 已提交
3651
    @throw std::out_of_range if the index @a idx is out of range of the array;
N
Niels 已提交
3652
    that is, `idx >= size()`; example: `"array index 7 is out of range"`
N
Niels 已提交
3653 3654 3655 3656

    @complexity Constant.

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

N
Niels 已提交
3659
    @since version 1.0.0
N
Niels 已提交
3660
    */
3661
    reference at(size_type idx)
N
cleanup  
Niels 已提交
3662 3663
    {
        // at only works for arrays
3664 3665
        if (is_array())
        {
3666
            JSON_TRY
N
Niels 已提交
3667 3668 3669
            {
                return m_value.array->at(idx);
            }
3670
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3671 3672
            {
                // create better exception explanation
3673
                JSON_THROW(std::out_of_range("array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
3674
            }
3675 3676 3677
        }
        else
        {
3678
            JSON_THROW(std::domain_error("cannot use at() with " + type_name()));
3679
        }
N
cleanup  
Niels 已提交
3680 3681
    }

N
Niels 已提交
3682 3683 3684
    /*!
    @brief access specified array element with bounds checking

N
Niels 已提交
3685 3686
    Returns a const reference to the element at specified location @a idx,
    with bounds checking.
N
Niels 已提交
3687 3688 3689 3690 3691

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

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

N
Niels 已提交
3692 3693
    @throw std::domain_error if the JSON value is not an array; example:
    `"cannot use at() with string"`
N
Niels 已提交
3694
    @throw std::out_of_range if the index @a idx is out of range of the array;
N
Niels 已提交
3695
    that is, `idx >= size()`; example: `"array index 7 is out of range"`
N
Niels 已提交
3696 3697 3698 3699

    @complexity Constant.

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

N
Niels 已提交
3702
    @since version 1.0.0
N
Niels 已提交
3703
    */
3704
    const_reference at(size_type idx) const
N
cleanup  
Niels 已提交
3705 3706
    {
        // at only works for arrays
3707 3708
        if (is_array())
        {
3709
            JSON_TRY
N
Niels 已提交
3710 3711 3712
            {
                return m_value.array->at(idx);
            }
3713
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3714 3715
            {
                // create better exception explanation
3716
                JSON_THROW(std::out_of_range("array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
3717
            }
3718 3719 3720
        }
        else
        {
3721
            JSON_THROW(std::domain_error("cannot use at() with " + type_name()));
3722
        }
3723 3724
    }

N
Niels 已提交
3725 3726 3727 3728 3729 3730 3731 3732 3733 3734
    /*!
    @brief access specified object element with bounds checking

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

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

    @return reference to the element at key @a key

N
Niels 已提交
3735 3736
    @throw std::domain_error if the JSON value is not an object; example:
    `"cannot use at() with boolean"`
N
Niels 已提交
3737
    @throw std::out_of_range if the key @a key is is not stored in the object;
N
Niels 已提交
3738
    that is, `find(key) == end()`; example: `"key "the fast" not found"`
N
Niels 已提交
3739 3740 3741 3742

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3743
    written using `at()`.,at__object_t_key_type}
N
Niels 已提交
3744 3745 3746 3747

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

N
Niels 已提交
3749
    @since version 1.0.0
N
Niels 已提交
3750
    */
3751
    reference at(const typename object_t::key_type& key)
3752 3753
    {
        // at only works for objects
3754 3755
        if (is_object())
        {
3756
            JSON_TRY
N
Niels 已提交
3757 3758 3759
            {
                return m_value.object->at(key);
            }
3760
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3761 3762
            {
                // create better exception explanation
3763
                JSON_THROW(std::out_of_range("key '" + key + "' not found"));
N
Niels 已提交
3764
            }
3765 3766 3767
        }
        else
        {
3768
            JSON_THROW(std::domain_error("cannot use at() with " + type_name()));
3769
        }
3770 3771
    }

N
Niels 已提交
3772 3773 3774
    /*!
    @brief access specified object element with bounds checking

N
Niels 已提交
3775 3776
    Returns a const reference to the element at with specified key @a key,
    with bounds checking.
N
Niels 已提交
3777 3778 3779 3780 3781

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

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

N
Niels 已提交
3782 3783
    @throw std::domain_error if the JSON value is not an object; example:
    `"cannot use at() with boolean"`
N
Niels 已提交
3784
    @throw std::out_of_range if the key @a key is is not stored in the object;
N
Niels 已提交
3785
    that is, `find(key) == end()`; example: `"key "the fast" not found"`
N
Niels 已提交
3786 3787 3788 3789

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3790
    `at()`.,at__object_t_key_type_const}
N
Niels 已提交
3791 3792 3793 3794

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

N
Niels 已提交
3796
    @since version 1.0.0
N
Niels 已提交
3797
    */
3798
    const_reference at(const typename object_t::key_type& key) const
3799 3800
    {
        // at only works for objects
3801 3802
        if (is_object())
        {
3803
            JSON_TRY
N
Niels 已提交
3804 3805 3806
            {
                return m_value.object->at(key);
            }
3807
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3808 3809
            {
                // create better exception explanation
3810
                JSON_THROW(std::out_of_range("key '" + key + "' not found"));
N
Niels 已提交
3811
            }
3812 3813 3814
        }
        else
        {
3815
            JSON_THROW(std::domain_error("cannot use at() with " + type_name()));
3816
        }
N
cleanup  
Niels 已提交
3817 3818
    }

N
Niels 已提交
3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831
    /*!
    @brief access specified array element

    Returns a reference to the element at specified location @a idx.

    @note If @a idx is beyond the range of the array (i.e., `idx >= size()`),
    then the array is silently filled up with `null` values to make `idx` a
    valid reference to the last stored element.

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

    @return reference to the element at index @a idx

N
Niels 已提交
3832 3833
    @throw std::domain_error if JSON is not an array or null; example:
    `"cannot use operator[] with string"`
N
Niels 已提交
3834 3835 3836 3837 3838

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

N
Niels 已提交
3842
    @since version 1.0.0
N
Niels 已提交
3843
    */
3844
    reference operator[](size_type idx)
N
cleanup  
Niels 已提交
3845
    {
N
Niels 已提交
3846
        // implicitly convert null value to an empty array
N
cleanup  
Niels 已提交
3847
        if (is_null())
N
Niels 已提交
3848 3849
        {
            m_type = value_t::array;
3850
            m_value.array = create<array_t>();
3851
            assert_invariant();
N
Niels 已提交
3852 3853
        }

N
Niels 已提交
3854
        // operator[] only works for arrays
N
cleanup  
Niels 已提交
3855
        if (is_array())
N
cleanup  
Niels 已提交
3856
        {
N
Niels 已提交
3857 3858
            // fill up array with null values if given idx is outside range
            if (idx >= m_value.array->size())
N
cleanup  
Niels 已提交
3859
            {
N
Niels 已提交
3860 3861 3862
                m_value.array->insert(m_value.array->end(),
                                      idx - m_value.array->size() + 1,
                                      basic_json());
N
cleanup  
Niels 已提交
3863
            }
N
cleanup  
Niels 已提交
3864

N
cleanup  
Niels 已提交
3865 3866
            return m_value.array->operator[](idx);
        }
N
Niels Lohmann 已提交
3867

3868
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
N
cleanup  
Niels 已提交
3869 3870
    }

N
Niels 已提交
3871 3872 3873 3874 3875 3876 3877 3878 3879
    /*!
    @brief access specified array element

    Returns a const reference to the element at specified location @a idx.

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

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

N
Niels 已提交
3880 3881
    @throw std::domain_error if JSON is not an array; example: `"cannot use
    operator[] with null"`
N
Niels 已提交
3882 3883 3884 3885

    @complexity Constant.

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

N
Niels 已提交
3888
    @since version 1.0.0
N
Niels 已提交
3889
    */
3890
    const_reference operator[](size_type idx) const
N
cleanup  
Niels 已提交
3891
    {
N
Niels 已提交
3892
        // const operator[] only works for arrays
N
Niels 已提交
3893 3894 3895 3896
        if (is_array())
        {
            return m_value.array->operator[](idx);
        }
N
Niels Lohmann 已提交
3897

3898
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
N
cleanup  
Niels 已提交
3899 3900
    }

N
Niels 已提交
3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913
    /*!
    @brief access specified object element

    Returns a reference to the element at with specified key @a key.

    @note If @a key is not found in the object, then it is silently added to
    the object and filled with a `null` value to make `key` a valid reference.
    In case the value was `null` before, it is converted to an object.

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

    @return reference to the element at key @a key

N
Niels 已提交
3914
    @throw std::domain_error if JSON is not an object or null; example:
N
Niels 已提交
3915
    `"cannot use operator[] with string"`
N
Niels 已提交
3916 3917 3918 3919

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3920
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
3921 3922 3923 3924

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

N
Niels 已提交
3926
    @since version 1.0.0
N
Niels 已提交
3927
    */
3928
    reference operator[](const typename object_t::key_type& key)
N
cleanup  
Niels 已提交
3929
    {
N
Niels 已提交
3930
        // implicitly convert null value to an empty object
N
cleanup  
Niels 已提交
3931
        if (is_null())
N
Niels 已提交
3932 3933
        {
            m_type = value_t::object;
3934
            m_value.object = create<object_t>();
3935
            assert_invariant();
N
Niels 已提交
3936 3937
        }

N
Niels 已提交
3938
        // operator[] only works for objects
N
Niels 已提交
3939 3940 3941 3942
        if (is_object())
        {
            return m_value.object->operator[](key);
        }
N
Niels Lohmann 已提交
3943

3944
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
N
cleanup  
Niels 已提交
3945 3946
    }

3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959
    /*!
    @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.

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

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

N
Niels 已提交
3960 3961 3962
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

N
Niels 已提交
3963 3964
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    operator[] with null"`
3965 3966 3967 3968

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3969
    the `[]` operator.,operatorarray__key_type_const}
3970 3971 3972 3973 3974

    @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 已提交
3975
    @since version 1.0.0
3976 3977 3978
    */
    const_reference operator[](const typename object_t::key_type& key) const
    {
N
Niels 已提交
3979
        // const operator[] only works for objects
N
Niels 已提交
3980 3981 3982 3983 3984
        if (is_object())
        {
            assert(m_value.object->find(key) != m_value.object->end());
            return m_value.object->find(key)->second;
        }
N
Niels Lohmann 已提交
3985

3986
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
3987 3988
    }

N
Niels 已提交
3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001
    /*!
    @brief access specified object element

    Returns a reference to the element at with specified key @a key.

    @note If @a key is not found in the object, then it is silently added to
    the object and filled with a `null` value to make `key` a valid reference.
    In case the value was `null` before, it is converted to an object.

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

    @return reference to the element at key @a key

N
Niels 已提交
4002
    @throw std::domain_error if JSON is not an object or null; example:
N
Niels 已提交
4003
    `"cannot use operator[] with string"`
N
Niels 已提交
4004 4005 4006 4007

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
4008
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
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

N
Niels 已提交
4014
    @since version 1.0.0
N
Niels 已提交
4015
    */
N
Niels 已提交
4016
    template<typename T, std::size_t n>
N
Niels 已提交
4017
    reference operator[](T * (&key)[n])
4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042
    {
        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 已提交
4043
    the `[]` operator.,operatorarray__key_type_const}
4044 4045 4046 4047 4048 4049 4050 4051

    @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 已提交
4052
    const_reference operator[](T * (&key)[n]) const
4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070
    {
        return operator[](static_cast<const T>(key));
    }

    /*!
    @brief access specified object element

    Returns a reference to the element at with specified key @a key.

    @note If @a key is not found in the object, then it is silently added to
    the object and filled with a `null` value to make `key` a valid reference.
    In case the value was `null` before, it is converted to an object.

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

    @return reference to the element at key @a key

    @throw std::domain_error if JSON is not an object or null; example:
N
Niels 已提交
4071
    `"cannot use operator[] with string"`
4072 4073 4074 4075

    @complexity Logarithmic in the size of the container.

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

    @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 已提交
4082
    @since version 1.1.0
4083 4084 4085
    */
    template<typename T>
    reference operator[](T* key)
N
cleanup  
Niels 已提交
4086
    {
N
Niels 已提交
4087
        // implicitly convert null to object
N
cleanup  
Niels 已提交
4088
        if (is_null())
N
Niels 已提交
4089 4090
        {
            m_type = value_t::object;
N
Niels 已提交
4091
            m_value = value_t::object;
4092
            assert_invariant();
N
Niels 已提交
4093 4094
        }

N
cleanup  
Niels 已提交
4095
        // at only works for objects
N
Niels 已提交
4096 4097 4098 4099
        if (is_object())
        {
            return m_value.object->operator[](key);
        }
N
Niels Lohmann 已提交
4100

4101
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
N
cleanup  
Niels 已提交
4102 4103
    }

4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116
    /*!
    @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.

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

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

N
Niels 已提交
4117 4118 4119
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

N
Niels 已提交
4120 4121
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    operator[] with null"`
4122 4123 4124 4125

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
4126
    the `[]` operator.,operatorarray__key_type_const}
4127 4128 4129 4130 4131

    @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 已提交
4132
    @since version 1.1.0
4133
    */
4134 4135
    template<typename T>
    const_reference operator[](T* key) const
4136 4137
    {
        // at only works for objects
N
Niels 已提交
4138 4139 4140 4141 4142
        if (is_object())
        {
            assert(m_value.object->find(key) != m_value.object->end());
            return m_value.object->find(key)->second;
        }
N
Niels Lohmann 已提交
4143

4144
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
4145 4146
    }

N
Niels 已提交
4147 4148 4149
    /*!
    @brief access specified object element with default value

N
Niels 已提交
4150 4151
    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.
N
Niels 已提交
4152 4153

    The function is basically equivalent to executing
4154
    @code {.cpp}
N
Niels 已提交
4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179
    try {
        return at(key);
    } catch(std::out_of_range) {
        return default_value;
    }
    @endcode

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

    @note Unlike @ref operator[](const typename object_t::key_type& key), this
    function does not implicitly add an element to the position defined by @a
    key. This function is furthermore also applicable to const objects.

    @param[in] key  key of the element to access
    @param[in] default_value  the value to return if @a key is not found

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

    @return copy of the element at key @a key or @a default_value if @a key
    is not found

N
Niels 已提交
4180 4181
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    value() with null"`
N
Niels 已提交
4182 4183 4184 4185 4186 4187 4188 4189 4190 4191

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

N
Niels 已提交
4193
    @since version 1.0.0
N
Niels 已提交
4194
    */
N
Niels 已提交
4195 4196
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207
    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 已提交
4208 4209

            return default_value;
N
Niels 已提交
4210 4211 4212
        }
        else
        {
4213
            JSON_THROW(std::domain_error("cannot use value() with " + type_name()));
N
Niels 已提交
4214 4215 4216 4217
        }
    }

    /*!
N
Niels 已提交
4218
    @brief overload for a default value of type const char*
N
Niels 已提交
4219
    @copydoc basic_json::value(const typename object_t::key_type&, ValueType) const
N
Niels 已提交
4220 4221 4222 4223 4224 4225
    */
    string_t value(const typename object_t::key_type& key, const char* default_value) const
    {
        return value(key, string_t(default_value));
    }

N
Niels 已提交
4226 4227 4228
    /*!
    @brief access specified object element via JSON Pointer with default value

N
Niels 已提交
4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243
    Returns either a copy of an object's element at the specified key @a key
    or a given default value if no element with key @a key exists.

    The function is basically equivalent to executing
    @code {.cpp}
    try {
        return at(ptr);
    } catch(std::out_of_range) {
        return default_value;
    }
    @endcode

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

N
Niels 已提交
4244 4245 4246 4247 4248 4249 4250 4251
    @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 已提交
4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262
    @return copy of the element at key @a key or @a default_value if @a key
    is not found

    @throw std::domain_error if JSON is not an object; example: `"cannot use
    value() with null"`

    @complexity Logarithmic in the size of the container.

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

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

N
Niels 已提交
4265 4266
    @since version 2.0.2
    */
N
Niels 已提交
4267 4268
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
4269 4270 4271 4272 4273 4274
    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
4275
            JSON_TRY
N
Niels 已提交
4276 4277 4278
            {
                return ptr.get_checked(this);
            }
4279
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
4280 4281 4282 4283
            {
                return default_value;
            }
        }
N
Niels Lohmann 已提交
4284

4285
        JSON_THROW(std::domain_error("cannot use value() with " + type_name()));
N
Niels 已提交
4286 4287 4288 4289
    }

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

N
Niels 已提交
4297 4298 4299 4300 4301 4302
    /*!
    @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 已提交
4303
    @return In case of a structured type (array or object), a reference to the
4304
    first element is returned. In case of number, string, or boolean values, a
N
Niels 已提交
4305 4306 4307 4308
    reference to the value is returned.

    @complexity Constant.

N
Niels 已提交
4309
    @pre The JSON value must not be `null` (would throw `std::out_of_range`)
N
Niels 已提交
4310 4311
    or an empty array or object (undefined behavior, **guarded by
    assertions**).
N
Niels 已提交
4312 4313 4314
    @post The JSON value remains unchanged.

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

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

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

N
Niels 已提交
4320
    @since version 1.0.0
N
Niels 已提交
4321
    */
4322
    reference front()
N
Niels 已提交
4323 4324 4325 4326
    {
        return *begin();
    }

N
Niels 已提交
4327 4328 4329
    /*!
    @copydoc basic_json::front()
    */
4330
    const_reference front() const
N
Niels 已提交
4331 4332 4333 4334
    {
        return *cbegin();
    }

N
Niels 已提交
4335 4336 4337 4338
    /*!
    @brief access the last element

    Returns a reference to the last element in the container. For a JSON
N
Niels 已提交
4339 4340 4341 4342 4343 4344
    container `c`, the expression `c.back()` is equivalent to
    @code {.cpp}
    auto tmp = c.end();
    --tmp;
    return *tmp;
    @endcode
N
Niels 已提交
4345

N
Niels 已提交
4346
    @return In case of a structured type (array or object), a reference to the
4347
    last element is returned. In case of number, string, or boolean values, a
N
Niels 已提交
4348 4349 4350 4351
    reference to the value is returned.

    @complexity Constant.

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

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

N
Niels 已提交
4359 4360 4361
    @liveexample{The following code shows an example for `back()`.,back}

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

N
Niels 已提交
4363
    @since version 1.0.0
N
Niels 已提交
4364
    */
4365
    reference back()
N
Niels 已提交
4366 4367 4368 4369 4370 4371
    {
        auto tmp = end();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
4372 4373 4374
    /*!
    @copydoc basic_json::back()
    */
4375
    const_reference back() const
N
Niels 已提交
4376 4377 4378 4379 4380 4381
    {
        auto tmp = cend();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
4382 4383 4384
    /*!
    @brief remove element given an iterator

N
Niels 已提交
4385 4386 4387
    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 已提交
4388

N
Niels 已提交
4389
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
4390 4391 4392
    will be `null`.

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

4396
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
4397

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

N
Niels 已提交
4401 4402
    @throw std::domain_error if called on a `null` value; example: `"cannot
    use erase() with null"`
4403 4404 4405
    @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"`
4406
    @throw invalid_iterator.205 if called on a primitive type with invalid
N
Niels 已提交
4407 4408
    iterator (i.e., any iterator which is not `begin()`); example: `"iterator
    out of range"`
N
Niels 已提交
4409 4410 4411

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

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

4419
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4420
    the given range
N
Niels 已提交
4421
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4422
    from an object at the given key
N
Niels 已提交
4423 4424
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4425

N
Niels 已提交
4426
    @since version 1.0.0
N
Niels 已提交
4427
    */
N
Niels 已提交
4428 4429 4430 4431
    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>
4432
    IteratorType erase(IteratorType pos)
4433 4434
    {
        // make sure iterator fits the current value
N
Niels 已提交
4435
        if (this != pos.m_object)
4436
        {
4437
            JSON_THROW(invalid_iterator(202, "iterator does not fit current value"));
4438 4439
        }

4440
        IteratorType result = end();
4441 4442 4443 4444

        switch (m_type)
        {
            case value_t::boolean:
4445 4446
            case value_t::number_float:
            case value_t::number_integer:
4447
            case value_t::number_unsigned:
4448 4449
            case value_t::string:
            {
4450
                if (not pos.m_it.primitive_iterator.is_begin())
4451
                {
4452
                    JSON_THROW(invalid_iterator(205, "iterator out of range"));
4453 4454
                }

N
cleanup  
Niels 已提交
4455
                if (is_string())
4456
                {
4457 4458 4459
                    AllocatorType<string_t> alloc;
                    alloc.destroy(m_value.string);
                    alloc.deallocate(m_value.string, 1);
4460 4461 4462 4463
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
4464
                assert_invariant();
4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481
                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:
            {
4482
                JSON_THROW(std::domain_error("cannot use erase() with " + type_name()));
4483 4484 4485 4486 4487 4488
            }
        }

        return result;
    }

N
Niels 已提交
4489 4490 4491
    /*!
    @brief remove elements given an iterator range

N
Niels 已提交
4492 4493 4494
    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 已提交
4495

N
Niels 已提交
4496
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
4497 4498 4499 4500 4501
    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 已提交
4502
    second refers to the last element, the `end()` iterator is returned.
N
Niels 已提交
4503

4504
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
4505

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

N
Niels 已提交
4509 4510
    @throw std::domain_error if called on a `null` value; example: `"cannot
    use erase() with null"`
4511 4512 4513
    @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 已提交
4514 4515
    iterators (i.e., if `first != begin()` and `last != end()`); example:
    `"iterators out of range"`
N
Niels 已提交
4516 4517 4518 4519 4520 4521 4522 4523

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

4527
    @sa @ref erase(IteratorType) -- removes the element at a given position
N
Niels 已提交
4528
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4529
    from an object at the given key
N
Niels 已提交
4530 4531
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4532

N
Niels 已提交
4533
    @since version 1.0.0
N
Niels 已提交
4534
    */
N
Niels 已提交
4535 4536 4537 4538
    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>
4539
    IteratorType erase(IteratorType first, IteratorType last)
4540 4541
    {
        // make sure iterator fits the current value
N
Niels 已提交
4542
        if (this != first.m_object or this != last.m_object)
4543
        {
4544
            JSON_THROW(invalid_iterator(203, "iterators do not fit current value"));
4545 4546
        }

4547
        IteratorType result = end();
4548 4549 4550 4551

        switch (m_type)
        {
            case value_t::boolean:
4552 4553
            case value_t::number_float:
            case value_t::number_integer:
4554
            case value_t::number_unsigned:
4555 4556
            case value_t::string:
            {
4557
                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
4558
                {
4559
                    JSON_THROW(invalid_iterator(204, "iterators out of range"));
4560 4561
                }

N
cleanup  
Niels 已提交
4562
                if (is_string())
4563
                {
4564 4565 4566
                    AllocatorType<string_t> alloc;
                    alloc.destroy(m_value.string);
                    alloc.deallocate(m_value.string, 1);
4567 4568 4569 4570
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
4571
                assert_invariant();
4572 4573 4574 4575 4576 4577
                break;
            }

            case value_t::object:
            {
                result.m_it.object_iterator = m_value.object->erase(first.m_it.object_iterator,
T
Théo DELRIEU 已提交
4578
                                              last.m_it.object_iterator);
4579 4580 4581 4582 4583 4584
                break;
            }

            case value_t::array:
            {
                result.m_it.array_iterator = m_value.array->erase(first.m_it.array_iterator,
T
Théo DELRIEU 已提交
4585
                                             last.m_it.array_iterator);
4586 4587 4588 4589 4590
                break;
            }

            default:
            {
4591
                JSON_THROW(std::domain_error("cannot use erase() with " + type_name()));
4592 4593 4594 4595 4596 4597
            }
        }

        return result;
    }

N
Niels 已提交
4598 4599 4600 4601 4602 4603 4604
    /*!
    @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 已提交
4605
    @return Number of elements removed. If @a ObjectType is the default
N
Niels 已提交
4606 4607
    `std::map` type, the return value will always be `0` (@a key was not
    found) or `1` (@a key was found).
N
Niels 已提交
4608 4609 4610

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

N
Niels 已提交
4612 4613
    @throw std::domain_error when called on a type other than JSON object;
    example: `"cannot use erase() with null"`
N
Niels 已提交
4614 4615 4616

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

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

4619 4620
    @sa @ref erase(IteratorType) -- removes the element at a given position
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4621 4622 4623
    the given range
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4624

N
Niels 已提交
4625
    @since version 1.0.0
N
Niels 已提交
4626
    */
4627
    size_type erase(const typename object_t::key_type& key)
4628
    {
N
Niels 已提交
4629
        // this erase only works for objects
N
Niels 已提交
4630 4631 4632 4633
        if (is_object())
        {
            return m_value.object->erase(key);
        }
N
Niels Lohmann 已提交
4634

4635
        JSON_THROW(std::domain_error("cannot use erase() with " + type_name()));
4636 4637
    }

N
Niels 已提交
4638 4639 4640 4641 4642 4643 4644
    /*!
    @brief remove element from a JSON array given an index

    Removes element from a JSON array at the index @a idx.

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

N
Niels 已提交
4645 4646
    @throw std::domain_error when called on a type other than JSON array;
    example: `"cannot use erase() with null"`
N
Niels 已提交
4647 4648
    @throw std::out_of_range when `idx >= size()`; example: `"array index 17
    is out of range"`
N
Niels 已提交
4649 4650 4651

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

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

4654 4655
    @sa @ref erase(IteratorType) -- removes the element at a given position
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4656
    the given range
N
Niels 已提交
4657
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4658 4659
    from an object at the given key

N
Niels 已提交
4660
    @since version 1.0.0
N
Niels 已提交
4661
    */
4662
    void erase(const size_type idx)
N
Niels 已提交
4663 4664
    {
        // this erase only works for arrays
N
cleanup  
Niels 已提交
4665
        if (is_array())
N
Niels 已提交
4666
        {
N
cleanup  
Niels 已提交
4667 4668
            if (idx >= size())
            {
4669
                JSON_THROW(std::out_of_range("array index " + std::to_string(idx) + " is out of range"));
N
cleanup  
Niels 已提交
4670
            }
N
Niels 已提交
4671

N
cleanup  
Niels 已提交
4672 4673 4674
            m_value.array->erase(m_value.array->begin() + static_cast<difference_type>(idx));
        }
        else
N
Niels 已提交
4675
        {
4676
            JSON_THROW(std::domain_error("cannot use erase() with " + type_name()));
N
Niels 已提交
4677 4678 4679
        }
    }

N
Niels 已提交
4680 4681 4682 4683 4684 4685 4686 4687 4688 4689
    /// @}


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

    /// @name lookup
    /// @{

N
Niels 已提交
4690 4691 4692 4693
    /*!
    @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 已提交
4694 4695
    element is not found or the JSON value is not an object, end() is
    returned.
N
Niels 已提交
4696

4697 4698 4699
    @note This method always returns @ref end() when executed on a JSON type
          that is not an object.

N
Niels 已提交
4700 4701 4702
    @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
4703 4704
    element is found or the JSON value is not an object, past-the-end (see
    @ref end()) iterator is returned.
N
Niels 已提交
4705 4706 4707

    @complexity Logarithmic in the size of the JSON object.

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

N
Niels 已提交
4710
    @since version 1.0.0
N
Niels 已提交
4711
    */
4712
    iterator find(typename object_t::key_type key)
N
Niels 已提交
4713 4714 4715
    {
        auto result = end();

N
cleanup  
Niels 已提交
4716
        if (is_object())
N
Niels 已提交
4717 4718 4719 4720 4721 4722 4723
        {
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4724 4725 4726 4727
    /*!
    @brief find an element in a JSON object
    @copydoc find(typename object_t::key_type)
    */
4728
    const_iterator find(typename object_t::key_type key) const
N
Niels 已提交
4729 4730 4731
    {
        auto result = cend();

N
cleanup  
Niels 已提交
4732
        if (is_object())
N
Niels 已提交
4733 4734 4735 4736 4737 4738 4739
        {
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4740 4741 4742 4743 4744 4745 4746
    /*!
    @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).

4747 4748 4749
    @note This method always returns `0` when executed on a JSON type that is
          not an object.

N
Niels 已提交
4750 4751 4752 4753 4754 4755 4756
    @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 已提交
4757
    @liveexample{The example shows how `count()` is used.,count}
N
Niels 已提交
4758

N
Niels 已提交
4759
    @since version 1.0.0
N
Niels 已提交
4760
    */
4761
    size_type count(typename object_t::key_type key) const
4762 4763
    {
        // return 0 for all nonobject types
N
Niels 已提交
4764
        return is_object() ? m_value.object->count(key) : 0;
4765 4766
    }

N
Niels 已提交
4767 4768
    /// @}

N
Niels 已提交
4769

N
cleanup  
Niels 已提交
4770 4771 4772 4773
    ///////////////
    // iterators //
    ///////////////

N
Niels 已提交
4774 4775 4776
    /// @name iterators
    /// @{

N
Niels 已提交
4777 4778
    /*!
    @brief returns an iterator to the first element
N
Niels 已提交
4779 4780 4781 4782 4783 4784 4785 4786 4787

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

N
Niels 已提交
4793 4794 4795 4796 4797
    @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 已提交
4798

N
Niels 已提交
4799
    @since version 1.0.0
N
Niels 已提交
4800
    */
N
Niels 已提交
4801
    iterator begin() noexcept
N
cleanup  
Niels 已提交
4802 4803 4804 4805 4806 4807
    {
        iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4808
    /*!
N
Niels 已提交
4809
    @copydoc basic_json::cbegin()
N
Niels 已提交
4810
    */
N
Niels 已提交
4811
    const_iterator begin() const noexcept
N
cleanup  
Niels 已提交
4812
    {
N
Niels 已提交
4813
        return cbegin();
N
cleanup  
Niels 已提交
4814 4815
    }

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

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

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

N
Niels 已提交
4839
    @since version 1.0.0
N
Niels 已提交
4840
    */
N
Niels 已提交
4841
    const_iterator cbegin() const noexcept
N
cleanup  
Niels 已提交
4842 4843 4844 4845 4846 4847
    {
        const_iterator result(this);
        result.set_begin();
        return result;
    }

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

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

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

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

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

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

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

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

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

N
Niels 已提交
4919
    /*!
N
Niels 已提交
4920 4921 4922 4923 4924 4925 4926 4927
    @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 已提交
4928 4929 4930
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4931 4932 4933
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(end())`.

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

N
Niels 已提交
4940
    @since version 1.0.0
N
Niels 已提交
4941
    */
N
Niels 已提交
4942
    reverse_iterator rbegin() noexcept
N
Niels 已提交
4943 4944 4945 4946
    {
        return reverse_iterator(end());
    }

N
Niels 已提交
4947
    /*!
N
Niels 已提交
4948
    @copydoc basic_json::crbegin()
N
Niels 已提交
4949
    */
N
Niels 已提交
4950
    const_reverse_iterator rbegin() const noexcept
N
Niels 已提交
4951
    {
N
Niels 已提交
4952
        return crbegin();
N
Niels 已提交
4953 4954
    }

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

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

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

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

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

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

N
Niels 已提交
5014
    @since version 1.0.0
N
Niels 已提交
5015
    */
N
Niels 已提交
5016
    const_reverse_iterator crbegin() const noexcept
N
Niels 已提交
5017 5018 5019 5020
    {
        return const_reverse_iterator(cend());
    }

N
Niels 已提交
5021
    /*!
N
Niels 已提交
5022 5023 5024 5025 5026 5027 5028 5029 5030
    @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 已提交
5031 5032 5033
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
5034 5035 5036
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).rend()`.

N
Niels 已提交
5037 5038 5039 5040 5041
    @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 已提交
5042

N
Niels 已提交
5043
    @since version 1.0.0
N
Niels 已提交
5044
    */
N
Niels 已提交
5045
    const_reverse_iterator crend() const noexcept
N
Niels 已提交
5046 5047 5048 5049
    {
        return const_reverse_iterator(cbegin());
    }

N
cleanup  
Niels 已提交
5050 5051 5052 5053 5054 5055 5056 5057
  private:
    // forward declaration
    template<typename IteratorType> class iteration_proxy;

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

N
Niels 已提交
5058
    This function allows to access @ref iterator::key() and @ref
N
Niels 已提交
5059 5060 5061
    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 已提交
5062 5063 5064

    @note The name of this function is not yet final and may change in the
    future.
N
cleanup  
Niels 已提交
5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078
    */
    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 已提交
5079 5080
    /// @}

N
cleanup  
Niels 已提交
5081 5082 5083 5084 5085

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

N
Niels 已提交
5086 5087 5088
    /// @name capacity
    /// @{

N
Niels 已提交
5089 5090
    /*!
    @brief checks whether the container is empty
N
Niels 已提交
5091 5092 5093

    Checks if a JSON value has no elements.

N
Niels 已提交
5094
    @return The return value depends on the different types and is
N
Niels 已提交
5095 5096 5097
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
5098 5099 5100 5101 5102 5103
            null        | `true`
            boolean     | `false`
            string      | `false`
            number      | `false`
            object      | result of function `object_t::empty()`
            array       | result of function `array_t::empty()`
N
Niels 已提交
5104

N
Niels 已提交
5105 5106 5107 5108
    @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 已提交
5109 5110
    @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 已提交
5111
    complexity.
N
Niels 已提交
5112

N
Niels 已提交
5113 5114 5115
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
5116 5117 5118
    - The complexity is constant.
    - Has the semantics of `begin() == end()`.

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

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

N
Niels 已提交
5124
    @since version 1.0.0
N
Niels 已提交
5125
    */
5126
    bool empty() const noexcept
N
cleanup  
Niels 已提交
5127 5128 5129
    {
        switch (m_type)
        {
5130
            case value_t::null:
N
cleanup  
Niels 已提交
5131
            {
N
Niels 已提交
5132
                // null values are empty
N
cleanup  
Niels 已提交
5133 5134
                return true;
            }
N
Niels 已提交
5135

5136
            case value_t::array:
N
cleanup  
Niels 已提交
5137
            {
N
Niels 已提交
5138
                // delegate call to array_t::empty()
N
cleanup  
Niels 已提交
5139 5140
                return m_value.array->empty();
            }
N
Niels 已提交
5141

5142
            case value_t::object:
N
cleanup  
Niels 已提交
5143
            {
N
Niels 已提交
5144
                // delegate call to object_t::empty()
N
cleanup  
Niels 已提交
5145 5146
                return m_value.object->empty();
            }
N
Niels 已提交
5147

N
Niels 已提交
5148 5149 5150 5151 5152 5153
            default:
            {
                // all other types are nonempty
                return false;
            }
        }
N
cleanup  
Niels 已提交
5154 5155
    }

N
Niels 已提交
5156 5157
    /*!
    @brief returns the number of elements
N
Niels 已提交
5158 5159 5160

    Returns the number of elements in a JSON value.

N
Niels 已提交
5161
    @return The return value depends on the different types and is
N
Niels 已提交
5162 5163 5164
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
5165 5166 5167 5168
            null        | `0`
            boolean     | `1`
            string      | `1`
            number      | `1`
N
Niels 已提交
5169 5170 5171
            object      | result of function object_t::size()
            array       | result of function array_t::size()

N
Niels 已提交
5172 5173 5174 5175
    @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 已提交
5176 5177 5178
    @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 已提交
5179

N
Niels 已提交
5180 5181 5182
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
5183 5184 5185
    - The complexity is constant.
    - Has the semantics of `std::distance(begin(), end())`.

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

N
Niels 已提交
5189 5190 5191
    @sa @ref empty() -- checks whether the container is empty
    @sa @ref max_size() -- returns the maximal number of elements

N
Niels 已提交
5192
    @since version 1.0.0
N
Niels 已提交
5193
    */
5194
    size_type size() const noexcept
N
cleanup  
Niels 已提交
5195 5196 5197
    {
        switch (m_type)
        {
5198
            case value_t::null:
N
cleanup  
Niels 已提交
5199
            {
N
Niels 已提交
5200
                // null values are empty
N
cleanup  
Niels 已提交
5201 5202
                return 0;
            }
N
Niels 已提交
5203

5204
            case value_t::array:
N
cleanup  
Niels 已提交
5205
            {
N
Niels 已提交
5206
                // delegate call to array_t::size()
N
cleanup  
Niels 已提交
5207 5208
                return m_value.array->size();
            }
N
Niels 已提交
5209

5210
            case value_t::object:
N
cleanup  
Niels 已提交
5211
            {
N
Niels 已提交
5212
                // delegate call to object_t::size()
N
cleanup  
Niels 已提交
5213 5214
                return m_value.object->size();
            }
N
Niels 已提交
5215

N
Niels 已提交
5216 5217 5218 5219 5220 5221
            default:
            {
                // all other types have size 1
                return 1;
            }
        }
N
cleanup  
Niels 已提交
5222 5223
    }

N
Niels 已提交
5224 5225
    /*!
    @brief returns the maximum possible number of elements
N
Niels 已提交
5226 5227 5228 5229 5230

    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 已提交
5231
    @return The return value depends on the different types and is
N
Niels 已提交
5232 5233 5234
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
5235 5236 5237 5238 5239 5240
            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 已提交
5241

N
Niels 已提交
5242 5243
    @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 已提交
5244
    complexity.
N
Niels 已提交
5245

N
Niels 已提交
5246 5247 5248
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
5249 5250 5251 5252
    - The complexity is constant.
    - Has the semantics of returning `b.size()` where `b` is the largest
      possible JSON value.

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

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

N
Niels 已提交
5258
    @since version 1.0.0
N
Niels 已提交
5259
    */
5260
    size_type max_size() const noexcept
N
cleanup  
Niels 已提交
5261 5262 5263
    {
        switch (m_type)
        {
5264
            case value_t::array:
N
cleanup  
Niels 已提交
5265
            {
N
Niels 已提交
5266
                // delegate call to array_t::max_size()
N
cleanup  
Niels 已提交
5267 5268
                return m_value.array->max_size();
            }
N
Niels 已提交
5269

5270
            case value_t::object:
N
cleanup  
Niels 已提交
5271
            {
N
Niels 已提交
5272
                // delegate call to object_t::max_size()
N
cleanup  
Niels 已提交
5273 5274
                return m_value.object->max_size();
            }
N
Niels 已提交
5275

N
Niels 已提交
5276 5277
            default:
            {
5278 5279
                // all other types have max_size() == size()
                return size();
N
Niels 已提交
5280 5281
            }
        }
N
cleanup  
Niels 已提交
5282 5283
    }

N
Niels 已提交
5284 5285
    /// @}

N
cleanup  
Niels 已提交
5286 5287 5288 5289 5290

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

N
Niels 已提交
5291 5292 5293
    /// @name modifiers
    /// @{

N
Niels 已提交
5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310
    /*!
    @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 已提交
5311
    @liveexample{The example below shows the effect of `clear()` to different
N
Niels 已提交
5312
    JSON types.,clear}
N
Niels 已提交
5313

N
Niels 已提交
5314
    @since version 1.0.0
N
Niels 已提交
5315
    */
5316
    void clear() noexcept
N
cleanup  
Niels 已提交
5317 5318 5319
    {
        switch (m_type)
        {
5320
            case value_t::number_integer:
N
cleanup  
Niels 已提交
5321
            {
N
Niels 已提交
5322
                m_value.number_integer = 0;
N
cleanup  
Niels 已提交
5323 5324
                break;
            }
N
Niels 已提交
5325

5326 5327 5328 5329 5330 5331
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = 0;
                break;
            }

5332
            case value_t::number_float:
N
cleanup  
Niels 已提交
5333
            {
N
Niels 已提交
5334
                m_value.number_float = 0.0;
N
cleanup  
Niels 已提交
5335 5336
                break;
            }
N
Niels 已提交
5337

5338
            case value_t::boolean:
N
cleanup  
Niels 已提交
5339
            {
N
Niels 已提交
5340
                m_value.boolean = false;
N
cleanup  
Niels 已提交
5341 5342
                break;
            }
N
Niels 已提交
5343

5344
            case value_t::string:
N
cleanup  
Niels 已提交
5345 5346 5347 5348
            {
                m_value.string->clear();
                break;
            }
N
Niels 已提交
5349

5350
            case value_t::array:
N
cleanup  
Niels 已提交
5351 5352 5353 5354
            {
                m_value.array->clear();
                break;
            }
N
Niels 已提交
5355

5356
            case value_t::object:
N
cleanup  
Niels 已提交
5357 5358 5359 5360
            {
                m_value.object->clear();
                break;
            }
5361 5362 5363 5364 5365

            default:
            {
                break;
            }
N
cleanup  
Niels 已提交
5366 5367 5368
        }
    }

5369 5370 5371
    /*!
    @brief add an object to an array

5372
    Appends the given element @a val to the end of the JSON value. If the
5373
    function is called on a JSON null value, an empty array is created before
5374
    appending @a val.
5375

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

N
Niels 已提交
5378 5379
    @throw std::domain_error when called on a type other than JSON array or
    null; example: `"cannot use push_back() with number"`
5380 5381 5382

    @complexity Amortized constant.

N
Niels 已提交
5383 5384 5385
    @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 已提交
5386

N
Niels 已提交
5387
    @since version 1.0.0
5388
    */
5389
    void push_back(basic_json&& val)
N
cleanup  
Niels 已提交
5390 5391
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
5392
        if (not(is_null() or is_array()))
N
cleanup  
Niels 已提交
5393
        {
5394
            JSON_THROW(std::domain_error("cannot use push_back() with " + type_name()));
N
cleanup  
Niels 已提交
5395 5396 5397
        }

        // transform null object into an array
N
cleanup  
Niels 已提交
5398
        if (is_null())
N
cleanup  
Niels 已提交
5399 5400
        {
            m_type = value_t::array;
N
Niels 已提交
5401
            m_value = value_t::array;
5402
            assert_invariant();
N
cleanup  
Niels 已提交
5403 5404 5405
        }

        // add element to array (move semantics)
5406
        m_value.array->push_back(std::move(val));
N
cleanup  
Niels 已提交
5407
        // invalidate object
5408
        val.m_type = value_t::null;
N
cleanup  
Niels 已提交
5409 5410
    }

5411 5412 5413 5414
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5415
    reference operator+=(basic_json&& val)
N
Niels 已提交
5416
    {
5417
        push_back(std::move(val));
N
Niels 已提交
5418 5419 5420
        return *this;
    }

5421 5422 5423 5424
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5425
    void push_back(const basic_json& val)
N
cleanup  
Niels 已提交
5426 5427
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
5428
        if (not(is_null() or is_array()))
N
cleanup  
Niels 已提交
5429
        {
5430
            JSON_THROW(std::domain_error("cannot use push_back() with " + type_name()));
N
cleanup  
Niels 已提交
5431 5432 5433
        }

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

        // add element to array
5442
        m_value.array->push_back(val);
N
cleanup  
Niels 已提交
5443 5444
    }

5445 5446 5447 5448
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5449
    reference operator+=(const basic_json& val)
N
cleanup  
Niels 已提交
5450
    {
5451
        push_back(val);
N
cleanup  
Niels 已提交
5452 5453 5454
        return *this;
    }

5455 5456 5457
    /*!
    @brief add an object to an object

5458
    Inserts the given element @a val to the JSON object. If the function is
N
Niels 已提交
5459 5460
    called on a JSON null value, an empty object is created before inserting
    @a val.
5461

5462
    @param[in] val the value to add to the JSON object
5463 5464

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

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

N
Niels 已提交
5469 5470 5471
    @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 已提交
5472

N
Niels 已提交
5473
    @since version 1.0.0
5474
    */
5475
    void push_back(const typename object_t::value_type& val)
N
cleanup  
Niels 已提交
5476 5477
    {
        // push_back only works for null objects or objects
N
cleanup  
Niels 已提交
5478
        if (not(is_null() or is_object()))
N
cleanup  
Niels 已提交
5479
        {
5480
            JSON_THROW(std::domain_error("cannot use push_back() with " + type_name()));
N
cleanup  
Niels 已提交
5481 5482 5483
        }

        // transform null object into an object
N
cleanup  
Niels 已提交
5484
        if (is_null())
N
cleanup  
Niels 已提交
5485 5486
        {
            m_type = value_t::object;
N
Niels 已提交
5487
            m_value = value_t::object;
5488
            assert_invariant();
N
cleanup  
Niels 已提交
5489 5490 5491
        }

        // add element to array
5492
        m_value.object->insert(val);
N
cleanup  
Niels 已提交
5493 5494
    }

5495 5496 5497 5498
    /*!
    @brief add an object to an object
    @copydoc push_back(const typename object_t::value_type&)
    */
5499
    reference operator+=(const typename object_t::value_type& val)
N
cleanup  
Niels 已提交
5500
    {
5501
        push_back(val);
N
Niels 已提交
5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550
        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
cleanup  
Niels 已提交
5551 5552
    }

N
Niels 已提交
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
    /*!
    @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

    @throw std::domain_error when called on a type other than JSON array or
    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()))
        {
5580
            JSON_THROW(std::domain_error("cannot use emplace_back() with " + type_name()));
N
Niels 已提交
5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595
        }

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

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

N
Niels Lohmann 已提交
5598 5599
    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
5600 5601
    function is called on a JSON null value, an empty object is created before
    appending the value created from @a args.
N
Niels 已提交
5602 5603 5604 5605

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

5606 5607 5608 5609
    @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.

N
Niels 已提交
5610 5611 5612 5613 5614 5615 5616
    @throw std::domain_error when called on a type other than JSON object or
    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
5617 5618
    JSON object. Further note how no value is added if there was already one
    value stored with the same key.,emplace}
N
Niels 已提交
5619 5620 5621 5622

    @since version 2.0.8
    */
    template<class... Args>
5623
    std::pair<iterator, bool> emplace(Args&& ... args)
N
Niels 已提交
5624 5625 5626 5627
    {
        // emplace only works for null objects or arrays
        if (not(is_null() or is_object()))
        {
5628
            JSON_THROW(std::domain_error("cannot use emplace() with " + type_name()));
N
Niels 已提交
5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639
        }

        // 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)
5640 5641 5642 5643 5644 5645 5646
        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 已提交
5647 5648
    }

N
Niels 已提交
5649 5650 5651
    /*!
    @brief inserts element

5652
    Inserts element @a val before iterator @a pos.
N
Niels 已提交
5653 5654 5655

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

N
Niels 已提交
5659 5660
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
5661 5662
    @throw invalid_iterator.202 if @a pos is not an iterator of *this;
    example: `"iterator does not fit current value"`
N
Niels 已提交
5663

N
Niels Lohmann 已提交
5664
    @complexity Constant plus linear in the distance between @a pos and end of
N
Niels Lohmann 已提交
5665
    the container.
N
Niels 已提交
5666

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

N
Niels 已提交
5669
    @since version 1.0.0
N
Niels 已提交
5670
    */
5671
    iterator insert(const_iterator pos, const basic_json& val)
N
Niels 已提交
5672 5673
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5674
        if (is_array())
N
Niels 已提交
5675
        {
N
cleanup  
Niels 已提交
5676 5677 5678
            // check if iterator pos fits to this JSON value
            if (pos.m_object != this)
            {
5679
                JSON_THROW(invalid_iterator(202, "iterator does not fit current value"));
N
cleanup  
Niels 已提交
5680
            }
N
Niels 已提交
5681

N
cleanup  
Niels 已提交
5682 5683
            // insert to array and return iterator
            iterator result(this);
5684
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, val);
N
cleanup  
Niels 已提交
5685 5686
            return result;
        }
N
Niels Lohmann 已提交
5687

5688
        JSON_THROW(std::domain_error("cannot use insert() with " + type_name()));
N
Niels 已提交
5689 5690 5691 5692 5693 5694
    }

    /*!
    @brief inserts element
    @copydoc insert(const_iterator, const basic_json&)
    */
5695
    iterator insert(const_iterator pos, basic_json&& val)
N
Niels 已提交
5696
    {
5697
        return insert(pos, val);
N
Niels 已提交
5698 5699 5700 5701 5702
    }

    /*!
    @brief inserts elements

5703
    Inserts @a cnt copies of @a val before iterator @a pos.
N
Niels 已提交
5704 5705 5706

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

N
Niels 已提交
5712 5713
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
5714 5715
    @throw invalid_iterator.202 if @a pos is not an iterator of *this;
    example: `"iterator does not fit current value"`
N
Niels 已提交
5716

5717
    @complexity Linear in @a cnt plus linear in the distance between @a pos
N
Niels 已提交
5718 5719
    and end of the container.

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

N
Niels 已提交
5722
    @since version 1.0.0
N
Niels 已提交
5723
    */
5724
    iterator insert(const_iterator pos, size_type cnt, const basic_json& val)
N
Niels 已提交
5725 5726
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5727
        if (is_array())
N
Niels 已提交
5728
        {
N
cleanup  
Niels 已提交
5729 5730 5731
            // check if iterator pos fits to this JSON value
            if (pos.m_object != this)
            {
5732
                JSON_THROW(invalid_iterator(202, "iterator does not fit current value"));
N
cleanup  
Niels 已提交
5733
            }
N
Niels 已提交
5734

N
cleanup  
Niels 已提交
5735 5736
            // insert to array and return iterator
            iterator result(this);
5737
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, cnt, val);
N
cleanup  
Niels 已提交
5738 5739
            return result;
        }
N
Niels Lohmann 已提交
5740

5741
        JSON_THROW(std::domain_error("cannot use insert() with " + type_name()));
N
Niels 已提交
5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753
    }

    /*!
    @brief inserts elements

    Inserts elements from range `[first, last)` before iterator @a pos.

    @param[in] pos iterator before which the content will be inserted; may be
    the end() iterator
    @param[in] first begin of the range of elements to insert
    @param[in] last end of the range of elements to insert

N
Niels 已提交
5754 5755
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
5756 5757
    @throw invalid_iterator.202 if @a pos is not an iterator of *this;
    example: `"iterator does not fit current value"`
5758 5759 5760
    @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 已提交
5761 5762 5763
    container for which insert is called; example: `"passed iterators may not
    belong to container"`

N
Niels 已提交
5764 5765 5766 5767 5768 5769
    @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 已提交
5770
    @liveexample{The example shows how `insert()` is used.,insert__range}
N
Niels 已提交
5771

N
Niels 已提交
5772
    @since version 1.0.0
N
Niels 已提交
5773 5774 5775 5776
    */
    iterator insert(const_iterator pos, const_iterator first, const_iterator last)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5777
        if (not is_array())
N
Niels 已提交
5778
        {
5779
            JSON_THROW(std::domain_error("cannot use insert() with " + type_name()));
N
Niels 已提交
5780 5781 5782 5783 5784
        }

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

N
Niels 已提交
5788
        // check if range iterators belong to the same JSON object
N
Niels 已提交
5789 5790
        if (first.m_object != last.m_object)
        {
5791
            JSON_THROW(invalid_iterator(210, "iterators do not fit"));
N
Niels 已提交
5792 5793 5794 5795
        }

        if (first.m_object == this or last.m_object == this)
        {
5796
            JSON_THROW(invalid_iterator(211, "passed iterators may not belong to container"));
N
Niels 已提交
5797 5798 5799 5800
        }

        // insert to array and return iterator
        iterator result(this);
N
Niels 已提交
5801
        result.m_it.array_iterator = m_value.array->insert(
T
Théo DELRIEU 已提交
5802 5803 5804
                                         pos.m_it.array_iterator,
                                         first.m_it.array_iterator,
                                         last.m_it.array_iterator);
N
Niels 已提交
5805 5806 5807
        return result;
    }

N
Niels 已提交
5808 5809 5810 5811 5812 5813 5814 5815 5816
    /*!
    @brief inserts elements

    Inserts elements from initializer list @a ilist before iterator @a pos.

    @param[in] pos iterator before which the content will be inserted; may be
    the end() iterator
    @param[in] ilist initializer list to insert the values from

N
Niels 已提交
5817 5818
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
5819 5820
    @throw invalid_iterator.202 if @a pos is not an iterator of *this;
    example: `"iterator does not fit current value"`
N
Niels 已提交
5821

N
Niels 已提交
5822 5823 5824
    @return iterator pointing to the first element inserted, or @a pos if
    `ilist` is empty

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

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

N
Niels 已提交
5830
    @since version 1.0.0
N
Niels 已提交
5831 5832 5833 5834
    */
    iterator insert(const_iterator pos, std::initializer_list<basic_json> ilist)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5835
        if (not is_array())
N
Niels 已提交
5836
        {
5837
            JSON_THROW(std::domain_error("cannot use insert() with " + type_name()));
N
Niels 已提交
5838 5839 5840 5841 5842
        }

        // check if iterator pos fits to this JSON value
        if (pos.m_object != this)
        {
5843
            JSON_THROW(invalid_iterator(202, "iterator does not fit current value"));
N
Niels 已提交
5844 5845 5846 5847 5848 5849 5850 5851
        }

        // 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 已提交
5852 5853
    /*!
    @brief exchanges the values
N
Niels 已提交
5854 5855 5856 5857 5858 5859 5860 5861 5862 5863

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

N
Niels 已提交
5867
    @since version 1.0.0
N
Niels 已提交
5868
    */
5869
    void swap(reference other) noexcept (
N
Niels 已提交
5870 5871 5872 5873
        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 已提交
5874
    )
N
cleanup  
Niels 已提交
5875 5876 5877
    {
        std::swap(m_type, other.m_type);
        std::swap(m_value, other.m_value);
5878
        assert_invariant();
N
cleanup  
Niels 已提交
5879 5880
    }

N
Niels 已提交
5881 5882 5883 5884 5885 5886 5887 5888 5889 5890
    /*!
    @brief exchanges the values

    Exchanges the contents of a JSON array with those of @a other. Does not
    invoke any move, copy, or swap operations on individual elements. All
    iterators and references remain valid. The past-the-end iterator is
    invalidated.

    @param[in,out] other array to exchange the contents with

N
Niels Lohmann 已提交
5891 5892
    @throw std::domain_error when JSON value is not an array; example:
    `"cannot use swap() with string"`
N
Niels 已提交
5893 5894 5895

    @complexity Constant.

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

N
Niels 已提交
5899
    @since version 1.0.0
N
Niels 已提交
5900
    */
5901
    void swap(array_t& other)
N
cleanup  
Niels 已提交
5902 5903
    {
        // swap only works for arrays
N
cleanup  
Niels 已提交
5904 5905 5906 5907 5908
        if (is_array())
        {
            std::swap(*(m_value.array), other);
        }
        else
N
cleanup  
Niels 已提交
5909
        {
5910
            JSON_THROW(std::domain_error("cannot use swap() with " + type_name()));
N
cleanup  
Niels 已提交
5911 5912 5913
        }
    }

5914 5915 5916 5917 5918 5919 5920 5921 5922 5923
    /*!
    @brief exchanges the values

    Exchanges the contents of a JSON object with those of @a other. Does not
    invoke any move, copy, or swap operations on individual elements. All
    iterators and references remain valid. The past-the-end iterator is
    invalidated.

    @param[in,out] other object to exchange the contents with

N
Niels 已提交
5924 5925
    @throw std::domain_error when JSON value is not an object; example:
    `"cannot use swap() with string"`
5926 5927 5928

    @complexity Constant.

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

N
Niels 已提交
5932
    @since version 1.0.0
5933
    */
5934
    void swap(object_t& other)
N
cleanup  
Niels 已提交
5935 5936
    {
        // swap only works for objects
N
cleanup  
Niels 已提交
5937 5938 5939 5940 5941
        if (is_object())
        {
            std::swap(*(m_value.object), other);
        }
        else
N
cleanup  
Niels 已提交
5942
        {
5943
            JSON_THROW(std::domain_error("cannot use swap() with " + type_name()));
N
cleanup  
Niels 已提交
5944 5945 5946
        }
    }

5947 5948 5949 5950 5951 5952 5953 5954 5955 5956
    /*!
    @brief exchanges the values

    Exchanges the contents of a JSON string with those of @a other. Does not
    invoke any move, copy, or swap operations on individual elements. All
    iterators and references remain valid. The past-the-end iterator is
    invalidated.

    @param[in,out] other string to exchange the contents with

N
Niels 已提交
5957 5958
    @throw std::domain_error when JSON value is not a string; example: `"cannot
    use swap() with boolean"`
5959 5960 5961

    @complexity Constant.

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

N
Niels 已提交
5965
    @since version 1.0.0
5966
    */
5967
    void swap(string_t& other)
N
cleanup  
Niels 已提交
5968 5969
    {
        // swap only works for strings
N
cleanup  
Niels 已提交
5970 5971 5972 5973 5974
        if (is_string())
        {
            std::swap(*(m_value.string), other);
        }
        else
N
cleanup  
Niels 已提交
5975
        {
5976
            JSON_THROW(std::domain_error("cannot use swap() with " + type_name()));
N
cleanup  
Niels 已提交
5977 5978 5979
        }
    }

N
Niels 已提交
5980 5981
    /// @}

N
Niels 已提交
5982
  public:
5983 5984 5985 5986 5987 5988 5989
    //////////////////////////////////////////
    // lexicographical comparison operators //
    //////////////////////////////////////////

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

N
Niels 已提交
5990 5991
    /*!
    @brief comparison: equal
N
Niels 已提交
5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007

    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.

6008 6009
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__equal}
N
Niels 已提交
6010

N
Niels 已提交
6011
    @since version 1.0.0
N
Niels 已提交
6012
    */
N
Niels 已提交
6013
    friend bool operator==(const_reference lhs, const_reference rhs) noexcept
N
cleanup  
Niels 已提交
6014
    {
F
Florian Weber 已提交
6015 6016
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
6017

F
Florian Weber 已提交
6018
        if (lhs_type == rhs_type)
N
cleanup  
Niels 已提交
6019
        {
F
Florian Weber 已提交
6020
            switch (lhs_type)
N
cleanup  
Niels 已提交
6021
            {
6022
                case value_t::array:
N
Niels 已提交
6023
                {
N
cleanup  
Niels 已提交
6024
                    return *lhs.m_value.array == *rhs.m_value.array;
N
Niels 已提交
6025
                }
6026
                case value_t::object:
N
Niels 已提交
6027
                {
N
cleanup  
Niels 已提交
6028
                    return *lhs.m_value.object == *rhs.m_value.object;
N
Niels 已提交
6029
                }
6030
                case value_t::null:
N
Niels 已提交
6031
                {
N
cleanup  
Niels 已提交
6032
                    return true;
N
Niels 已提交
6033
                }
6034
                case value_t::string:
N
Niels 已提交
6035
                {
N
cleanup  
Niels 已提交
6036
                    return *lhs.m_value.string == *rhs.m_value.string;
N
Niels 已提交
6037
                }
6038
                case value_t::boolean:
N
Niels 已提交
6039
                {
N
cleanup  
Niels 已提交
6040
                    return lhs.m_value.boolean == rhs.m_value.boolean;
N
Niels 已提交
6041
                }
6042
                case value_t::number_integer:
N
Niels 已提交
6043
                {
N
cleanup  
Niels 已提交
6044
                    return lhs.m_value.number_integer == rhs.m_value.number_integer;
N
Niels 已提交
6045
                }
6046 6047 6048 6049
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned == rhs.m_value.number_unsigned;
                }
6050
                case value_t::number_float:
N
Niels 已提交
6051
                {
6052
                    return lhs.m_value.number_float == rhs.m_value.number_float;
N
Niels 已提交
6053
                }
6054
                default:
N
Niels 已提交
6055
                {
N
Niels 已提交
6056
                    return false;
N
Niels 已提交
6057
                }
N
cleanup  
Niels 已提交
6058 6059
            }
        }
F
Florian Weber 已提交
6060 6061
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
N
Niels 已提交
6062
            return static_cast<number_float_t>(lhs.m_value.number_integer) == rhs.m_value.number_float;
F
Florian Weber 已提交
6063 6064 6065
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
6066
            return lhs.m_value.number_float == static_cast<number_float_t>(rhs.m_value.number_integer);
F
Florian Weber 已提交
6067
        }
6068 6069 6070
        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;
F
Florian Weber 已提交
6071
        }
6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084
        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);
        }

N
cleanup  
Niels 已提交
6085 6086 6087
        return false;
    }

N
Niels 已提交
6088 6089
    /*!
    @brief comparison: equal
M
Mihai STAN 已提交
6090
    @copydoc operator==(const_reference, const_reference)
N
Niels 已提交
6091
    */
M
Mihai STAN 已提交
6092
    template<typename ScalarType, typename std::enable_if<
6093 6094
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator==(const_reference lhs, const ScalarType rhs) noexcept
N
Niels 已提交
6095
    {
M
Mihai STAN 已提交
6096
        return (lhs == basic_json(rhs));
N
Niels 已提交
6097 6098 6099 6100
    }

    /*!
    @brief comparison: equal
M
Mihai STAN 已提交
6101
    @copydoc operator==(const_reference, const_reference)
N
Niels 已提交
6102
    */
M
Mihai STAN 已提交
6103
    template<typename ScalarType, typename std::enable_if<
6104 6105
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator==(const ScalarType lhs, const_reference rhs) noexcept
N
Niels 已提交
6106
    {
M
Mihai STAN 已提交
6107
        return (basic_json(lhs) == rhs);
N
Niels 已提交
6108 6109
    }

N
Niels 已提交
6110 6111
    /*!
    @brief comparison: not equal
N
Niels 已提交
6112 6113 6114 6115 6116 6117 6118 6119 6120

    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.

6121 6122
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__notequal}
N
Niels 已提交
6123

N
Niels 已提交
6124
    @since version 1.0.0
N
Niels 已提交
6125
    */
N
Niels 已提交
6126
    friend bool operator!=(const_reference lhs, const_reference rhs) noexcept
N
cleanup  
Niels 已提交
6127 6128 6129 6130
    {
        return not (lhs == rhs);
    }

N
Niels 已提交
6131 6132
    /*!
    @brief comparison: not equal
M
Mihai STAN 已提交
6133
    @copydoc operator!=(const_reference, const_reference)
N
Niels 已提交
6134
    */
M
Mihai STAN 已提交
6135 6136 6137
    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 已提交
6138
    {
M
Mihai STAN 已提交
6139
        return (lhs != basic_json(rhs));
N
Niels 已提交
6140 6141 6142 6143
    }

    /*!
    @brief comparison: not equal
M
Mihai STAN 已提交
6144
    @copydoc operator!=(const_reference, const_reference)
N
Niels 已提交
6145
    */
M
Mihai STAN 已提交
6146 6147 6148
    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 已提交
6149
    {
M
Mihai STAN 已提交
6150
        return (basic_json(lhs) != rhs);
N
Niels 已提交
6151 6152
    }

N
Niels 已提交
6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171
    /*!
    @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.

6172 6173
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__less}
N
Niels 已提交
6174

N
Niels 已提交
6175
    @since version 1.0.0
N
Niels 已提交
6176
    */
N
Niels 已提交
6177
    friend bool operator<(const_reference lhs, const_reference rhs) noexcept
N
cleanup  
Niels 已提交
6178
    {
F
Florian Weber 已提交
6179 6180
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
6181

F
Florian Weber 已提交
6182
        if (lhs_type == rhs_type)
N
cleanup  
Niels 已提交
6183
        {
F
Florian Weber 已提交
6184
            switch (lhs_type)
N
cleanup  
Niels 已提交
6185
            {
6186
                case value_t::array:
N
Niels 已提交
6187
                {
N
cleanup  
Niels 已提交
6188
                    return *lhs.m_value.array < *rhs.m_value.array;
N
Niels 已提交
6189
                }
6190
                case value_t::object:
N
Niels 已提交
6191
                {
N
cleanup  
Niels 已提交
6192
                    return *lhs.m_value.object < *rhs.m_value.object;
N
Niels 已提交
6193
                }
6194
                case value_t::null:
N
Niels 已提交
6195
                {
N
cleanup  
Niels 已提交
6196
                    return false;
N
Niels 已提交
6197
                }
6198
                case value_t::string:
N
Niels 已提交
6199
                {
N
cleanup  
Niels 已提交
6200
                    return *lhs.m_value.string < *rhs.m_value.string;
N
Niels 已提交
6201
                }
6202
                case value_t::boolean:
N
Niels 已提交
6203
                {
N
cleanup  
Niels 已提交
6204
                    return lhs.m_value.boolean < rhs.m_value.boolean;
N
Niels 已提交
6205
                }
6206
                case value_t::number_integer:
N
Niels 已提交
6207
                {
N
cleanup  
Niels 已提交
6208
                    return lhs.m_value.number_integer < rhs.m_value.number_integer;
N
Niels 已提交
6209
                }
6210 6211 6212 6213
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned < rhs.m_value.number_unsigned;
                }
6214
                case value_t::number_float:
N
Niels 已提交
6215
                {
N
cleanup  
Niels 已提交
6216
                    return lhs.m_value.number_float < rhs.m_value.number_float;
N
Niels 已提交
6217
                }
6218
                default:
N
Niels 已提交
6219
                {
N
Niels 已提交
6220
                    return false;
N
Niels 已提交
6221
                }
N
cleanup  
Niels 已提交
6222 6223
            }
        }
F
Florian Weber 已提交
6224 6225
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
6226
            return static_cast<number_float_t>(lhs.m_value.number_integer) < rhs.m_value.number_float;
F
Florian Weber 已提交
6227 6228 6229
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246
            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 已提交
6247
        }
N
cleanup  
Niels 已提交
6248

N
Niels 已提交
6249
        // We only reach this line if we cannot compare values. In that case,
N
Niels 已提交
6250 6251 6252
        // we compare types. Note we have to call the operator explicitly,
        // because MSVC has problems otherwise.
        return operator<(lhs_type, rhs_type);
N
cleanup  
Niels 已提交
6253 6254
    }

N
Niels 已提交
6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266
    /*!
    @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.

6267 6268
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greater}
N
Niels 已提交
6269

N
Niels 已提交
6270
    @since version 1.0.0
N
Niels 已提交
6271
    */
N
Niels 已提交
6272
    friend bool operator<=(const_reference lhs, const_reference rhs) noexcept
N
cleanup  
Niels 已提交
6273 6274 6275 6276
    {
        return not (rhs < lhs);
    }

N
Niels 已提交
6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288
    /*!
    @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.

6289 6290
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__lessequal}
N
Niels 已提交
6291

N
Niels 已提交
6292
    @since version 1.0.0
N
Niels 已提交
6293
    */
N
Niels 已提交
6294
    friend bool operator>(const_reference lhs, const_reference rhs) noexcept
N
cleanup  
Niels 已提交
6295 6296 6297 6298
    {
        return not (lhs <= rhs);
    }

N
Niels 已提交
6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310
    /*!
    @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.

6311 6312
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greaterequal}
N
Niels 已提交
6313

N
Niels 已提交
6314
    @since version 1.0.0
N
Niels 已提交
6315
    */
N
Niels 已提交
6316
    friend bool operator>=(const_reference lhs, const_reference rhs) noexcept
N
cleanup  
Niels 已提交
6317 6318 6319 6320
    {
        return not (lhs < rhs);
    }

N
Niels 已提交
6321 6322
    /// @}

N
cleanup  
Niels 已提交
6323 6324 6325 6326 6327

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

N
Niels 已提交
6328 6329 6330
    /// @name serialization
    /// @{

6331 6332 6333 6334 6335 6336 6337
  private:
    /*!
    @brief wrapper around the serialization functions
    */
    class serializer
    {
      public:
N
Niels Lohmann 已提交
6338 6339 6340
        /*!
        @param[in] s  output stream to serialize to
        */
6341
        serializer(std::ostream& s)
6342 6343 6344
            : 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])
6345 6346 6347 6348 6349
        {}

        /*!
        @brief internal implementation of the serialization function

N
Niels Lohmann 已提交
6350 6351 6352 6353
        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.
6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366

        - 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,
6367
                  const unsigned int current_indent = 0)
6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384
        {
            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;
6385 6386 6387 6388
                        if (indent_string.size() < new_indent)
                        {
                            indent_string.resize(new_indent, ' ');
                        }
6389 6390 6391 6392 6393 6394 6395

                        // 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('\"');
6396
                            dump_escaped(i->first);
6397 6398 6399 6400 6401 6402 6403 6404 6405
                            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('\"');
6406
                        dump_escaped(i->first);
6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422
                        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('\"');
6423
                            dump_escaped(i->first);
6424 6425 6426 6427 6428 6429 6430 6431
                            o.write("\":", 2);
                            dump(i->second, false, indent_step, current_indent);
                            o.put(',');
                        }

                        // last element
                        assert(i != val.m_value.object->cend());
                        o.put('\"');
6432
                        dump_escaped(i->first);
6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455
                        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;
6456 6457 6458 6459
                        if (indent_string.size() < new_indent)
                        {
                            indent_string.resize(new_indent, ' ');
                        }
6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501

                        // 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('\"');
6502
                    dump_escaped(*val.m_value.string);
6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521
                    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:
                {
6522
                    dump_integer(val.m_value.number_integer);
6523 6524 6525 6526 6527
                    return;
                }

                case value_t::number_unsigned:
                {
6528
                    dump_integer(val.m_value.number_unsigned);
6529 6530 6531 6532 6533
                    return;
                }

                case value_t::number_float:
                {
6534
                    dump_float(val.m_value.number_float);
6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579
                    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;
                    }

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
                    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:
6607
                    {
6608 6609 6610
                        // from c (1 byte) to \uxxxx (6 bytes)
                        return res + 5;
                    }
6611

6612 6613
                    default:
                    {
6614 6615 6616 6617 6618 6619 6620
                        return res;
                    }
                }
            });
        }

        /*!
N
Niels Lohmann 已提交
6621
        @brief dump escaped string
6622

N
Niels Lohmann 已提交
6623 6624 6625 6626
        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.
6627 6628 6629 6630 6631

        @param[in] s  the string to escape

        @complexity Linear in the length of string @a s.
        */
6632
        void dump_escaped(const string_t& s) const
6633 6634 6635 6636
        {
            const auto space = extra_space(s);
            if (space == 0)
            {
6637 6638
                o.write(s.c_str(), static_cast<std::streamsize>(s.size()));
                return;
6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 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
            }

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

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
                    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:
6732
                    {
6733 6734 6735
                        // convert a number 0..15 to its hex representation
                        // (0..f)
                        static const char hexify[16] =
6736
                        {
6737 6738 6739 6740 6741 6742 6743 6744
                            '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]
                        })
6745
                        {
6746
                            result[++pos] = m;
6747
                        }
6748 6749 6750 6751 6752 6753 6754 6755 6756

                        ++pos;
                        break;
                    }

                    default:
                    {
                        // all other characters are added as-is
                        result[pos++] = c;
6757 6758 6759 6760 6761
                        break;
                    }
                }
            }

6762 6763
            assert(pos == s.size() + space);
            o.write(result.c_str(), static_cast<std::streamsize>(result.size()));
6764 6765
        }

N
Niels Lohmann 已提交
6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777
        /*!
        @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>
6778
        void dump_integer(NumberType x)
6779
        {
6780 6781
            // special case for "0"
            if (x == 0)
6782
            {
6783 6784
                o.put('0');
                return;
6785 6786
            }

6787 6788 6789 6790
            const bool is_negative = x < 0;
            size_t i = 0;

            // spare 1 byte for '\0'
N
Niels Lohmann 已提交
6791
            while (x != 0 and i < number_buffer.size() - 1)
6792
            {
6793
                const auto digit = std::labs(static_cast<long>(x % 10));
N
Niels Lohmann 已提交
6794
                number_buffer[i++] = static_cast<char>('0' + digit);
6795
                x /= 10;
6796 6797
            }

6798 6799
            // make sure the number has been processed completely
            assert(x == 0);
6800

6801
            if (is_negative)
6802
            {
6803
                // make sure there is capacity for the '-'
N
Niels Lohmann 已提交
6804 6805
                assert(i < number_buffer.size() - 2);
                number_buffer[i++] = '-';
6806
            }
6807

N
Niels Lohmann 已提交
6808 6809
            std::reverse(number_buffer.begin(), number_buffer.begin() + i);
            o.write(number_buffer.data(), static_cast<std::streamsize>(i));
6810
        }
6811

N
Niels Lohmann 已提交
6812 6813 6814 6815 6816 6817 6818 6819
        /*!
        @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
        */
6820
        void dump_float(number_float_t x)
6821 6822 6823 6824 6825
        {
            // special case for 0.0 and -0.0
            if (x == 0)
            {
                if (std::signbit(x))
6826
                {
6827
                    o.write("-0.0", 4);
6828
                }
6829
                else
6830
                {
6831
                    o.write("0.0", 3);
6832
                }
6833
                return;
6834 6835
            }

6836 6837
            // get number of digits for a text -> float -> text round-trip
            static constexpr auto d = std::numeric_limits<number_float_t>::digits10;
6838

6839
            // the actual conversion
N
Niels Lohmann 已提交
6840 6841
            long len = snprintf(number_buffer.data(), number_buffer.size(),
                                "%.*g", d, x);
6842

6843
            // negative value indicates an error
N
Niels Lohmann 已提交
6844
            assert(len > 0);
6845
            // check if buffer was large enough
N
Niels Lohmann 已提交
6846
            assert(static_cast<size_t>(len) < number_buffer.size());
6847

6848 6849 6850
            // erase thousands separator
            if (thousands_sep != '\0')
            {
N
Niels Lohmann 已提交
6851 6852 6853 6854 6855 6856
                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());
6857
            }
6858

6859 6860 6861
            // convert decimal point to '.'
            if (decimal_point != '\0' and decimal_point != '.')
            {
N
Niels Lohmann 已提交
6862
                for (auto& c : number_buffer)
6863
                {
6864
                    if (c == decimal_point)
6865
                    {
6866 6867
                        c = '.';
                        break;
6868 6869
                    }
                }
6870
            }
6871

N
Niels Lohmann 已提交
6872 6873
            o.write(number_buffer.data(), static_cast<std::streamsize>(len));

6874
            // determine if need to append ".0"
N
Niels Lohmann 已提交
6875 6876 6877
            const bool value_is_int_like = std::none_of(number_buffer.begin(),
                                           number_buffer.begin() + len + 1,
                                           [](char c)
6878
            {
N
Niels Lohmann 已提交
6879 6880
                return c == '.' or c == 'e';
            });
6881

6882 6883 6884
            if (value_is_int_like)
            {
                o.write(".0", 2);
6885
            }
6886
        }
6887 6888

      private:
N
Niels Lohmann 已提交
6889
        /// the output of the serializer
6890
        std::ostream& o;
6891 6892

        /// a (hopefully) large enough character buffer
N
Niels Lohmann 已提交
6893
        std::array<char, 64> number_buffer{{}};
6894

N
Niels Lohmann 已提交
6895
        /// the locale
6896
        const std::lconv* loc = nullptr;
N
Niels Lohmann 已提交
6897
        /// the locale's thousand separator character
6898
        const char thousands_sep = '\0';
N
Niels Lohmann 已提交
6899
        /// the locale's decimal point character
6900 6901
        const char decimal_point = '\0';

N
Niels Lohmann 已提交
6902
        /// the indentation string
6903
        string_t indent_string = string_t(512, ' ');
6904 6905 6906
    };

  public:
N
Niels 已提交
6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923
    /*!
    @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 已提交
6924 6925
    @liveexample{The example below shows the serialization with different
    parameters to `width` to adjust the indentation level.,operator_serialize}
N
Niels 已提交
6926

N
Niels 已提交
6927
    @since version 1.0.0
N
Niels 已提交
6928
    */
N
cleanup  
Niels 已提交
6929 6930
    friend std::ostream& operator<<(std::ostream& o, const basic_json& j)
    {
N
Niels 已提交
6931
        // read width member and use it as indentation parameter if nonzero
N
Niels 已提交
6932 6933
        const bool pretty_print = (o.width() > 0);
        const auto indentation = (pretty_print ? o.width() : 0);
N
Niels 已提交
6934

N
Niels 已提交
6935 6936
        // reset width to 0 for subsequent calls to this stream
        o.width(0);
6937

N
Niels 已提交
6938
        // do the actual serialization
6939 6940
        serializer s(o);
        s.dump(j, pretty_print, static_cast<unsigned int>(indentation));
N
cleanup  
Niels 已提交
6941 6942 6943
        return o;
    }

N
Niels 已提交
6944 6945 6946 6947
    /*!
    @brief serialize to stream
    @copydoc operator<<(std::ostream&, const basic_json&)
    */
N
cleanup  
Niels 已提交
6948 6949
    friend std::ostream& operator>>(const basic_json& j, std::ostream& o)
    {
A
Alexandre Hamez 已提交
6950
        return o << j;
N
cleanup  
Niels 已提交
6951 6952
    }

N
Niels 已提交
6953 6954
    /// @}

N
cleanup  
Niels 已提交
6955

N
Niels 已提交
6956 6957 6958 6959
    /////////////////////
    // deserialization //
    /////////////////////

N
Niels 已提交
6960 6961 6962
    /// @name deserialization
    /// @{

N
Niels 已提交
6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978
    /*!
    @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

6979 6980 6981
    @throw parse_error.101 if a parse error occurs; example: `""unexpected end
    of input; expected string literal""`

N
Niels 已提交
6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000
    @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);
    }

N
Niels 已提交
7001
    /*!
N
Niels 已提交
7002
    @brief deserialize from string literal
N
Niels 已提交
7003

N
Niels 已提交
7004
    @tparam CharT character/literal type with size of 1 byte
N
Niels 已提交
7005
    @param[in] s  string literal to read a serialized JSON value from
N
Niels 已提交
7006 7007 7008
    @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 已提交
7009 7010 7011 7012 7013 7014 7015

    @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 已提交
7016
    @note A UTF-8 byte order mark is silently ignored.
N
Niels 已提交
7017 7018
    @note String containers like `std::string` or @ref string_t can be parsed
          with @ref parse(const ContiguousContainer&, const parser_callback_t)
N
Niels 已提交
7019

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

N
Niels 已提交
7023 7024
    @sa @ref parse(std::istream&, const parser_callback_t) for a version that
    reads from an input stream
N
Niels 已提交
7025

N
Niels 已提交
7026
    @since version 1.0.0 (originally for @ref string_t)
N
Niels 已提交
7027
    */
7028 7029 7030 7031 7032
    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 已提交
7033
                            const parser_callback_t cb = nullptr)
N
Niels 已提交
7034
    {
N
Niels 已提交
7035
        return parser(reinterpret_cast<const char*>(s), cb).parse();
7036 7037
    }

N
Niels 已提交
7038 7039 7040 7041
    /*!
    @brief deserialize from stream

    @param[in,out] i  stream to read a serialized JSON value from
N
Niels 已提交
7042 7043 7044
    @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 已提交
7045 7046 7047 7048 7049 7050 7051

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

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

7057
    @sa @ref parse(const CharT, const parser_callback_t) for a version
N
Niels 已提交
7058
    that reads from a string
N
Niels 已提交
7059

N
Niels 已提交
7060
    @since version 1.0.0
N
Niels 已提交
7061
    */
N
Niels 已提交
7062 7063
    static basic_json parse(std::istream& i,
                            const parser_callback_t cb = nullptr)
A
Aaron Burghardt 已提交
7064
    {
N
Niels 已提交
7065
        return parser(i, cb).parse();
N
Niels 已提交
7066 7067
    }

N
Niels 已提交
7068
    /*!
N
Niels 已提交
7069
    @copydoc parse(std::istream&, const parser_callback_t)
N
Niels 已提交
7070
    */
N
Niels 已提交
7071 7072
    static basic_json parse(std::istream&& i,
                            const parser_callback_t cb = nullptr)
7073 7074 7075 7076
    {
        return parser(i, cb).parse();
    }

7077
    /*!
N
Niels 已提交
7078
    @brief deserialize from an iterator range with contiguous storage
7079

7080 7081
    This function reads from an iterator range of a container with contiguous
    storage of 1-byte values. Compatible container types include
7082 7083 7084 7085 7086 7087 7088 7089 7090
    `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
7091
    with a static assertion.**
7092

N
Niels 已提交
7093 7094 7095 7096
    @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.
7097

N
Niels 已提交
7098
    @tparam IteratorType iterator of container with contiguous storage
N
Niels 已提交
7099 7100 7101
    @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
7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112
    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 已提交
7113 7114
    @liveexample{The example below demonstrates the `parse()` function reading
    from an iterator range.,parse__iteratortype__parser_callback_t}
7115 7116 7117

    @since version 2.0.3
    */
N
Niels 已提交
7118 7119 7120 7121
    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>
7122 7123 7124 7125 7126
    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 已提交
7127
        assert(std::accumulate(first, last, std::pair<bool, int>(true, 0),
7128 7129 7130 7131 7132 7133 7134
                               [&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
7135 7136
        static_assert(sizeof(typename std::iterator_traits<IteratorType>::value_type) == 1,
                      "each element in the iterator range must have the size of 1 byte");
7137

7138 7139 7140 7141 7142 7143
        // 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();
        }
7144 7145 7146 7147

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

N
Niels 已提交
7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168
    /*!
    @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 已提交
7169
    @tparam ContiguousContainer container type with contiguous storage
N
Niels 已提交
7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187
    @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 已提交
7188
    template<class ContiguousContainer, typename std::enable_if<
N
Niels 已提交
7189
                 not std::is_pointer<ContiguousContainer>::value and
7190 7191
                 std::is_base_of<
                     std::random_access_iterator_tag,
N
Niels 已提交
7192
                     typename std::iterator_traits<decltype(std::begin(std::declval<ContiguousContainer const>()))>::iterator_category>::value
7193 7194 7195 7196 7197 7198 7199 7200
                 , 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 已提交
7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213
    /*!
    @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 已提交
7214 7215
    @note A UTF-8 byte order mark is silently ignored.

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

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

N
Niels 已提交
7222
    @since version 1.0.0
N
Niels 已提交
7223 7224
    */
    friend std::istream& operator<<(basic_json& j, std::istream& i)
N
Niels 已提交
7225 7226 7227 7228 7229
    {
        j = parser(i).parse();
        return i;
    }

N
Niels 已提交
7230 7231 7232 7233 7234
    /*!
    @brief deserialize from stream
    @copydoc operator<<(basic_json&, std::istream&)
    */
    friend std::istream& operator>>(std::istream& i, basic_json& j)
N
Niels 已提交
7235 7236 7237 7238 7239
    {
        j = parser(i).parse();
        return i;
    }

N
Niels 已提交
7240 7241
    /// @}

N
Niels Lohmann 已提交
7242 7243 7244
    //////////////////////////////////////////
    // binary serialization/deserialization //
    //////////////////////////////////////////
N
Niels 已提交
7245

N
Niels Lohmann 已提交
7246
    /// @name binary serialization/deserialization support
N
Niels 已提交
7247 7248 7249
    /// @{

  private:
7250 7251 7252 7253 7254
    /*!
    @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.
    */
7255 7256 7257 7258 7259 7260 7261 7262 7263
    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:
            {
7264 7265 7266 7267
                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));
7268 7269 7270 7271 7272
                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;
7273 7274 7275 7276 7277 7278
            }

            case 4:
            {
                vec.push_back(static_cast<uint8_t>((number >> 030) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 020) & 0xff));
7279 7280 7281
                vec.push_back(static_cast<uint8_t>((number >> 010) & 0xff));
                vec.push_back(static_cast<uint8_t>(number & 0xff));
                break;
7282 7283 7284 7285 7286
            }

            case 2:
            {
                vec.push_back(static_cast<uint8_t>((number >> 010) & 0xff));
7287 7288
                vec.push_back(static_cast<uint8_t>(number & 0xff));
                break;
7289 7290 7291 7292 7293 7294 7295 7296 7297 7298
            }

            case 1:
            {
                vec.push_back(static_cast<uint8_t>(number & 0xff));
                break;
            }
        }
    }

7299 7300 7301 7302 7303 7304 7305 7306
    /*!
    @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
7307
    @param[in] current_index  the position in the vector after which to read
7308 7309 7310 7311 7312 7313 7314 7315

    @return the next sizeof(T) bytes from @a vec, in reverse order as T

    @tparam T the integral return type

    @throw std::out_of_range if there are less than sizeof(T)+1 bytes in the
           vector @a vec to read

7316 7317 7318 7319
    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.

7320 7321
    Precondition:

7322 7323 7324
    vec:   |   |   | a | b | c | d |      T: |   |   |   |   |
                 ^               ^             ^                ^
           current_index         i            ptr        sizeof(T)
7325 7326 7327

    Postcondition:

7328 7329 7330
    vec:   |   |   | a | b | c | d |      T: | d | c | b | a |
                 ^   ^                                     ^
                 |   i                                    ptr
7331 7332
           current_index

7333
    @sa Code adapted from <http://stackoverflow.com/a/41031865/266378>.
7334 7335 7336
    */
    template<typename T>
    static T get_from_vector(const std::vector<uint8_t>& vec, const size_t current_index)
7337
    {
7338 7339
        if (current_index + sizeof(T) + 1 > vec.size())
        {
7340
            JSON_THROW(std::out_of_range("cannot read " + std::to_string(sizeof(T)) + " bytes from vector"));
7341 7342
        }

7343
        T result;
N
Niels Lohmann 已提交
7344
        auto* ptr = reinterpret_cast<uint8_t*>(&result);
7345
        for (size_t i = 0; i < sizeof(T); ++i)
7346
        {
7347
            *ptr++ = vec[current_index + sizeof(T) - i];
7348 7349
        }
        return result;
7350 7351
    }

7352 7353 7354 7355 7356 7357 7358 7359 7360 7361
    /*!
    @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 已提交
7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381
    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:
            {
7382
                if (j.m_value.number_integer >= 0)
N
Niels 已提交
7383
                {
7384
                    // MessagePack does not differentiate between positive
N
Niels Lohmann 已提交
7385 7386 7387
                    // signed integers and unsigned integers. Therefore, we
                    // used the code from the value_t::number_unsigned case
                    // here.
7388 7389 7390 7391 7392
                    if (j.m_value.number_unsigned < 128)
                    {
                        // positive fixnum
                        add_to_vector(v, 1, j.m_value.number_unsigned);
                    }
7393
                    else if (j.m_value.number_unsigned <= std::numeric_limits<uint8_t>::max())
7394 7395 7396 7397 7398
                    {
                        // uint 8
                        v.push_back(0xcc);
                        add_to_vector(v, 1, j.m_value.number_unsigned);
                    }
7399
                    else if (j.m_value.number_unsigned <= std::numeric_limits<uint16_t>::max())
7400 7401 7402 7403 7404
                    {
                        // uint 16
                        v.push_back(0xcd);
                        add_to_vector(v, 2, j.m_value.number_unsigned);
                    }
7405
                    else if (j.m_value.number_unsigned <= std::numeric_limits<uint32_t>::max())
7406 7407 7408 7409 7410
                    {
                        // uint 32
                        v.push_back(0xce);
                        add_to_vector(v, 4, j.m_value.number_unsigned);
                    }
7411
                    else if (j.m_value.number_unsigned <= std::numeric_limits<uint64_t>::max())
7412 7413 7414 7415 7416
                    {
                        // uint 64
                        v.push_back(0xcf);
                        add_to_vector(v, 8, j.m_value.number_unsigned);
                    }
N
Niels 已提交
7417
                }
7418
                else
N
Niels 已提交
7419
                {
7420 7421 7422 7423 7424
                    if (j.m_value.number_integer >= -32)
                    {
                        // negative fixnum
                        add_to_vector(v, 1, j.m_value.number_integer);
                    }
7425
                    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())
7426 7427 7428 7429 7430
                    {
                        // int 8
                        v.push_back(0xd0);
                        add_to_vector(v, 1, j.m_value.number_integer);
                    }
7431
                    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())
7432 7433 7434 7435 7436
                    {
                        // int 16
                        v.push_back(0xd1);
                        add_to_vector(v, 2, j.m_value.number_integer);
                    }
7437
                    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())
7438 7439 7440 7441 7442
                    {
                        // int 32
                        v.push_back(0xd2);
                        add_to_vector(v, 4, j.m_value.number_integer);
                    }
7443
                    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())
7444 7445 7446 7447 7448
                    {
                        // int 64
                        v.push_back(0xd3);
                        add_to_vector(v, 8, j.m_value.number_integer);
                    }
N
Niels 已提交
7449 7450 7451 7452 7453 7454 7455 7456 7457
                }
                break;
            }

            case value_t::number_unsigned:
            {
                if (j.m_value.number_unsigned < 128)
                {
                    // positive fixnum
7458
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels 已提交
7459
                }
7460
                else if (j.m_value.number_unsigned <= std::numeric_limits<uint8_t>::max())
N
Niels 已提交
7461 7462 7463
                {
                    // uint 8
                    v.push_back(0xcc);
7464
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels 已提交
7465
                }
7466
                else if (j.m_value.number_unsigned <= std::numeric_limits<uint16_t>::max())
N
Niels 已提交
7467 7468 7469
                {
                    // uint 16
                    v.push_back(0xcd);
7470
                    add_to_vector(v, 2, j.m_value.number_unsigned);
N
Niels 已提交
7471
                }
7472
                else if (j.m_value.number_unsigned <= std::numeric_limits<uint32_t>::max())
N
Niels 已提交
7473 7474 7475
                {
                    // uint 32
                    v.push_back(0xce);
7476
                    add_to_vector(v, 4, j.m_value.number_unsigned);
N
Niels 已提交
7477
                }
7478
                else if (j.m_value.number_unsigned <= std::numeric_limits<uint64_t>::max())
N
Niels 已提交
7479 7480 7481
                {
                    // uint 64
                    v.push_back(0xcf);
7482
                    add_to_vector(v, 8, j.m_value.number_unsigned);
N
Niels 已提交
7483 7484 7485 7486 7487 7488 7489 7490
                }
                break;
            }

            case value_t::number_float:
            {
                // float 64
                v.push_back(0xcb);
N
Niels Lohmann 已提交
7491
                const auto* helper = reinterpret_cast<const uint8_t*>(&(j.m_value.number_float));
N
Niels 已提交
7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510
                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);
7511
                    add_to_vector(v, 1, N);
N
Niels 已提交
7512 7513 7514 7515 7516
                }
                else if (N <= 65535)
                {
                    // str 16
                    v.push_back(0xda);
7517
                    add_to_vector(v, 2, N);
N
Niels 已提交
7518 7519 7520 7521 7522
                }
                else if (N <= 4294967295)
                {
                    // str 32
                    v.push_back(0xdb);
7523
                    add_to_vector(v, 4, N);
N
Niels 已提交
7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543
                }

                // 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);
7544
                    add_to_vector(v, 2, N);
N
Niels 已提交
7545 7546 7547 7548 7549
                }
                else if (N <= 0xffffffff)
                {
                    // array 32
                    v.push_back(0xdd);
7550
                    add_to_vector(v, 4, N);
N
Niels 已提交
7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572
                }

                // 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);
7573
                    add_to_vector(v, 2, N);
N
Niels 已提交
7574 7575 7576 7577 7578
                }
                else if (N <= 4294967295)
                {
                    // map 32
                    v.push_back(0xdf);
7579
                    add_to_vector(v, 4, N);
N
Niels 已提交
7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597
                }

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

7598 7599 7600 7601 7602 7603 7604 7605 7606 7607
    /*!
    @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 已提交
7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630
    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.
7631
                    if (j.m_value.number_integer <= 0x17)
N
Niels Lohmann 已提交
7632
                    {
7633
                        add_to_vector(v, 1, j.m_value.number_integer);
N
Niels Lohmann 已提交
7634
                    }
7635
                    else if (j.m_value.number_integer <= std::numeric_limits<uint8_t>::max())
N
Niels Lohmann 已提交
7636 7637 7638
                    {
                        v.push_back(0x18);
                        // one-byte uint8_t
7639
                        add_to_vector(v, 1, j.m_value.number_integer);
N
Niels Lohmann 已提交
7640
                    }
7641
                    else if (j.m_value.number_integer <= std::numeric_limits<uint16_t>::max())
N
Niels Lohmann 已提交
7642 7643 7644
                    {
                        v.push_back(0x19);
                        // two-byte uint16_t
7645
                        add_to_vector(v, 2, j.m_value.number_integer);
N
Niels Lohmann 已提交
7646
                    }
7647
                    else if (j.m_value.number_integer <= std::numeric_limits<uint32_t>::max())
N
Niels Lohmann 已提交
7648 7649 7650
                    {
                        v.push_back(0x1a);
                        // four-byte uint32_t
7651
                        add_to_vector(v, 4, j.m_value.number_integer);
N
Niels Lohmann 已提交
7652
                    }
7653
                    else
N
Niels Lohmann 已提交
7654
                    {
N
Niels Lohmann 已提交
7655
                        v.push_back(0x1b);
N
Niels Lohmann 已提交
7656
                        // eight-byte uint64_t
7657
                        add_to_vector(v, 8, j.m_value.number_integer);
N
Niels Lohmann 已提交
7658 7659 7660 7661
                    }
                }
                else
                {
N
Niels Lohmann 已提交
7662 7663
                    // The conversions below encode the sign in the first
                    // byte, and the value is converted to a positive number.
N
Niels Lohmann 已提交
7664
                    const auto positive_number = -1 - j.m_value.number_integer;
7665
                    if (j.m_value.number_integer >= -24)
N
Niels Lohmann 已提交
7666 7667 7668
                    {
                        v.push_back(static_cast<uint8_t>(0x20 + positive_number));
                    }
7669
                    else if (positive_number <= std::numeric_limits<uint8_t>::max())
N
Niels Lohmann 已提交
7670 7671 7672
                    {
                        // int 8
                        v.push_back(0x38);
7673
                        add_to_vector(v, 1, positive_number);
N
Niels Lohmann 已提交
7674
                    }
7675
                    else if (positive_number <= std::numeric_limits<uint16_t>::max())
N
Niels Lohmann 已提交
7676 7677 7678
                    {
                        // int 16
                        v.push_back(0x39);
7679
                        add_to_vector(v, 2, positive_number);
N
Niels Lohmann 已提交
7680
                    }
7681
                    else if (positive_number <= std::numeric_limits<uint32_t>::max())
N
Niels Lohmann 已提交
7682 7683 7684
                    {
                        // int 32
                        v.push_back(0x3a);
7685
                        add_to_vector(v, 4, positive_number);
N
Niels Lohmann 已提交
7686
                    }
7687
                    else
N
Niels Lohmann 已提交
7688 7689 7690
                    {
                        // int 64
                        v.push_back(0x3b);
7691
                        add_to_vector(v, 8, positive_number);
N
Niels Lohmann 已提交
7692 7693
                    }
                }
7694
                break;
N
Niels Lohmann 已提交
7695 7696 7697 7698
            }

            case value_t::number_unsigned:
            {
7699
                if (j.m_value.number_unsigned <= 0x17)
N
Niels Lohmann 已提交
7700 7701 7702 7703 7704 7705 7706
                {
                    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
7707
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7708 7709 7710 7711 7712
                }
                else if (j.m_value.number_unsigned <= 0xffff)
                {
                    v.push_back(0x19);
                    // two-byte uint16_t
7713
                    add_to_vector(v, 2, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7714 7715 7716 7717 7718
                }
                else if (j.m_value.number_unsigned <= 0xffffffff)
                {
                    v.push_back(0x1a);
                    // four-byte uint32_t
7719
                    add_to_vector(v, 4, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7720 7721 7722
                }
                else if (j.m_value.number_unsigned <= 0xffffffffffffffff)
                {
N
Niels Lohmann 已提交
7723
                    v.push_back(0x1b);
N
Niels Lohmann 已提交
7724
                    // eight-byte uint64_t
7725
                    add_to_vector(v, 8, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7726 7727 7728 7729 7730 7731 7732 7733
                }
                break;
            }

            case value_t::number_float:
            {
                // Double-Precision Float
                v.push_back(0xfb);
N
Niels Lohmann 已提交
7734
                const auto* helper = reinterpret_cast<const uint8_t*>(&(j.m_value.number_float));
N
Niels Lohmann 已提交
7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746
                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)
                {
7747
                    v.push_back(0x60 + static_cast<uint8_t>(N));  // 1 byte for string + size
N
Niels Lohmann 已提交
7748 7749 7750
                }
                else if (N <= 0xff)
                {
7751
                    v.push_back(0x78);  // one-byte uint8_t for N
7752
                    add_to_vector(v, 1, N);
N
Niels Lohmann 已提交
7753 7754 7755
                }
                else if (N <= 0xffff)
                {
7756
                    v.push_back(0x79);  // two-byte uint16_t for N
7757
                    add_to_vector(v, 2, N);
N
Niels Lohmann 已提交
7758 7759 7760
                }
                else if (N <= 0xffffffff)
                {
7761
                    v.push_back(0x7a); // four-byte uint32_t for N
7762
                    add_to_vector(v, 4, N);
N
Niels Lohmann 已提交
7763
                }
7764
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
7765 7766
                else if (N <= 0xffffffffffffffff)
                {
7767
                    v.push_back(0x7b);  // eight-byte uint64_t for N
7768
                    add_to_vector(v, 8, N);
N
Niels Lohmann 已提交
7769
                }
7770
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782

                // 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)
                {
7783
                    v.push_back(0x80 + static_cast<uint8_t>(N));  // 1 byte for array + size
N
Niels Lohmann 已提交
7784 7785 7786
                }
                else if (N <= 0xff)
                {
7787
                    v.push_back(0x98);  // one-byte uint8_t for N
7788
                    add_to_vector(v, 1, N);
N
Niels Lohmann 已提交
7789 7790 7791
                }
                else if (N <= 0xffff)
                {
7792
                    v.push_back(0x99);  // two-byte uint16_t for N
7793
                    add_to_vector(v, 2, N);
N
Niels Lohmann 已提交
7794 7795 7796
                }
                else if (N <= 0xffffffff)
                {
7797
                    v.push_back(0x9a);  // four-byte uint32_t for N
7798
                    add_to_vector(v, 4, N);
N
Niels Lohmann 已提交
7799
                }
7800
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
7801 7802
                else if (N <= 0xffffffffffffffff)
                {
7803
                    v.push_back(0x9b);  // eight-byte uint64_t for N
7804
                    add_to_vector(v, 8, N);
N
Niels Lohmann 已提交
7805
                }
7806
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820

                // 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)
                {
7821
                    v.push_back(0xa0 + static_cast<uint8_t>(N));  // 1 byte for object + size
N
Niels Lohmann 已提交
7822 7823 7824 7825
                }
                else if (N <= 0xff)
                {
                    v.push_back(0xb8);
7826
                    add_to_vector(v, 1, N);  // one-byte uint8_t for N
N
Niels Lohmann 已提交
7827 7828 7829 7830
                }
                else if (N <= 0xffff)
                {
                    v.push_back(0xb9);
7831
                    add_to_vector(v, 2, N);  // two-byte uint16_t for N
N
Niels Lohmann 已提交
7832 7833 7834 7835
                }
                else if (N <= 0xffffffff)
                {
                    v.push_back(0xba);
7836
                    add_to_vector(v, 4, N);  // four-byte uint32_t for N
N
Niels Lohmann 已提交
7837
                }
7838
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
7839 7840 7841
                else if (N <= 0xffffffffffffffff)
                {
                    v.push_back(0xbb);
7842
                    add_to_vector(v, 8, N);  // eight-byte uint64_t for 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 7859 7860 7861

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

7862 7863 7864 7865 7866 7867

    /*
    @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 已提交
7868 7869 7870
    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.
7871

N
Niels Lohmann 已提交
7872 7873
    This function checks whether reading the bytes is safe; that is, offset is
    a valid index in the vector, offset+len
7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889

    @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)
        {
7890
            JSON_THROW(std::out_of_range("len out of range"));
7891 7892 7893 7894 7895
        }

        // second case: adding offset would result in overflow
        if ((size > (std::numeric_limits<size_t>::max() - offset)))
        {
7896
            JSON_THROW(std::out_of_range("len+offset out of range"));
7897
        }
N
Niels Lohmann 已提交
7898 7899 7900 7901

        // last case: reading past the end of the vector
        if (len + offset > size)
        {
7902
            JSON_THROW(std::out_of_range("len+offset out of range"));
N
Niels Lohmann 已提交
7903
        }
7904 7905
    }

N
Niels 已提交
7906
    /*!
7907 7908
    @brief create a JSON value from a given MessagePack vector

N
Niels 已提交
7909 7910
    @param[in] v  MessagePack serialization
    @param[in] idx  byte index to start reading from @a v
7911 7912 7913 7914 7915 7916 7917 7918

    @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 已提交
7919 7920 7921
    */
    static basic_json from_msgpack_internal(const std::vector<uint8_t>& v, size_t& idx)
    {
N
Niels Lohmann 已提交
7922 7923 7924
        // make sure reading 1 byte is safe
        check_length(v.size(), 1, idx);

N
Niels 已提交
7925 7926 7927
        // store and increment index
        const size_t current_idx = idx++;

N
Niels Lohmann 已提交
7928
        if (v[current_idx] <= 0xbf)
N
Niels 已提交
7929
        {
N
Niels Lohmann 已提交
7930
            if (v[current_idx] <= 0x7f) // positive fixint
N
Niels 已提交
7931
            {
N
Niels Lohmann 已提交
7932
                return v[current_idx];
N
Niels 已提交
7933
            }
N
Niels Lohmann 已提交
7934
            if (v[current_idx] <= 0x8f) // fixmap
N
Niels 已提交
7935
            {
N
Niels Lohmann 已提交
7936 7937 7938 7939 7940 7941 7942 7943
                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 已提交
7944
            }
N
Niels Lohmann 已提交
7945
            else if (v[current_idx] <= 0x9f) // fixarray
N
Niels 已提交
7946
            {
N
Niels Lohmann 已提交
7947 7948 7949 7950 7951 7952 7953
                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 已提交
7954
            }
N
Niels Lohmann 已提交
7955
            else // fixstr
N
Niels 已提交
7956
            {
N
Niels Lohmann 已提交
7957 7958 7959
                const size_t len = v[current_idx] & 0x1f;
                const size_t offset = current_idx + 1;
                idx += len; // skip content bytes
7960
                check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
7961
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels 已提交
7962 7963
            }
        }
N
Niels Lohmann 已提交
7964
        else if (v[current_idx] >= 0xe0) // negative fixint
N
Niels 已提交
7965
        {
N
Niels Lohmann 已提交
7966
            return static_cast<int8_t>(v[current_idx]);
N
Niels 已提交
7967
        }
N
Niels Lohmann 已提交
7968
        else
N
Niels 已提交
7969
        {
N
Niels Lohmann 已提交
7970
            switch (v[current_idx])
N
Niels 已提交
7971
            {
N
Niels Lohmann 已提交
7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992
                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 已提交
7993
                        reinterpret_cast<uint8_t*>(&res)[sizeof(float) - byte - 1] = v.at(current_idx + 1 + byte);
N
Niels Lohmann 已提交
7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004
                    }
                    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 已提交
8005
                        reinterpret_cast<uint8_t*>(&res)[sizeof(double) - byte - 1] = v.at(current_idx + 1 + byte);
N
Niels Lohmann 已提交
8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060
                    }
                    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
                {
8061
                    const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
N
Niels Lohmann 已提交
8062 8063
                    const size_t offset = current_idx + 2;
                    idx += len + 1; // skip size byte + content bytes
8064
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
8065 8066 8067 8068 8069
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xda: // str 16
                {
8070
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
8071 8072
                    const size_t offset = current_idx + 3;
                    idx += len + 2; // skip 2 size bytes + content bytes
8073
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
8074 8075 8076 8077 8078
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xdb: // str 32
                {
8079
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
8080 8081
                    const size_t offset = current_idx + 5;
                    idx += len + 4; // skip 4 size bytes + content bytes
8082
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
8083 8084 8085 8086 8087 8088
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xdc: // array 16
                {
                    basic_json result = value_t::array;
8089
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100
                    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;
8101
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112
                    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;
8113
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125
                    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;
8126
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137
                    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:
                {
8138
                    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 已提交
8139
                }
N
Niels 已提交
8140 8141 8142 8143
            }
        }
    }

8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157
    /*!
    @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 已提交
8158 8159 8160 8161 8162
    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++;

8163
        switch (v.at(current_idx))
8164
        {
N
Niels Lohmann 已提交
8165
            // Integer 0x00..0x17 (0..23)
8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189
            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:
8190
            {
8191
                return v[current_idx];
8192
            }
8193

N
Niels Lohmann 已提交
8194
            case 0x18: // Unsigned integer (one-byte uint8_t follows)
N
Niels Lohmann 已提交
8195
            {
8196 8197
                idx += 1; // skip content byte
                return get_from_vector<uint8_t>(v, current_idx);
N
Niels Lohmann 已提交
8198
            }
8199

N
Niels Lohmann 已提交
8200
            case 0x19: // Unsigned integer (two-byte uint16_t follows)
N
Niels Lohmann 已提交
8201
            {
8202 8203
                idx += 2; // skip 2 content bytes
                return get_from_vector<uint16_t>(v, current_idx);
N
Niels Lohmann 已提交
8204
            }
8205

N
Niels Lohmann 已提交
8206
            case 0x1a: // Unsigned integer (four-byte uint32_t follows)
N
Niels Lohmann 已提交
8207
            {
8208 8209
                idx += 4; // skip 4 content bytes
                return get_from_vector<uint32_t>(v, current_idx);
N
Niels Lohmann 已提交
8210
            }
8211

N
Niels Lohmann 已提交
8212
            case 0x1b: // Unsigned integer (eight-byte uint64_t follows)
N
Niels Lohmann 已提交
8213
            {
8214 8215
                idx += 8; // skip 8 content bytes
                return get_from_vector<uint64_t>(v, current_idx);
N
Niels Lohmann 已提交
8216
            }
8217

N
Niels Lohmann 已提交
8218
            // Negative integer -1-0x00..-1-0x17 (-1..-24)
8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242
            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 已提交
8243
            {
8244
                return static_cast<int8_t>(0x20 - 1 - v[current_idx]);
N
Niels Lohmann 已提交
8245
            }
8246

N
Niels Lohmann 已提交
8247
            case 0x38: // Negative integer (one-byte uint8_t follows)
8248
            {
8249 8250
                idx += 1; // skip content byte
                // must be uint8_t !
8251
                return static_cast<number_integer_t>(-1) - get_from_vector<uint8_t>(v, current_idx);
8252
            }
8253

N
Niels Lohmann 已提交
8254
            case 0x39: // Negative integer -1-n (two-byte uint16_t follows)
N
Niels Lohmann 已提交
8255
            {
8256
                idx += 2; // skip 2 content bytes
8257
                return static_cast<number_integer_t>(-1) - get_from_vector<uint16_t>(v, current_idx);
N
Niels Lohmann 已提交
8258
            }
8259

N
Niels Lohmann 已提交
8260
            case 0x3a: // Negative integer -1-n (four-byte uint32_t follows)
N
Niels Lohmann 已提交
8261
            {
8262
                idx += 4; // skip 4 content bytes
8263
                return static_cast<number_integer_t>(-1) - get_from_vector<uint32_t>(v, current_idx);
N
Niels Lohmann 已提交
8264
            }
8265

N
Niels Lohmann 已提交
8266
            case 0x3b: // Negative integer -1-n (eight-byte uint64_t follows)
N
Niels Lohmann 已提交
8267
            {
8268
                idx += 8; // skip 8 content bytes
8269
                return static_cast<number_integer_t>(-1) - static_cast<number_integer_t>(get_from_vector<uint64_t>(v, current_idx));
N
Niels Lohmann 已提交
8270
            }
8271

N
Niels Lohmann 已提交
8272
            // UTF-8 string (0x00..0x17 bytes follow)
8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296
            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 已提交
8297
            {
8298
                const auto len = static_cast<size_t>(v[current_idx] - 0x60);
8299 8300
                const size_t offset = current_idx + 1;
                idx += len; // skip content bytes
8301
                check_length(v.size(), len, offset);
8302
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels Lohmann 已提交
8303
            }
8304

N
Niels Lohmann 已提交
8305
            case 0x78: // UTF-8 string (one-byte uint8_t for n follows)
N
Niels Lohmann 已提交
8306
            {
8307
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
8308 8309
                const size_t offset = current_idx + 2;
                idx += len + 1; // skip size byte + content bytes
8310
                check_length(v.size(), len, offset);
8311
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels Lohmann 已提交
8312
            }
8313

N
Niels Lohmann 已提交
8314
            case 0x79: // UTF-8 string (two-byte uint16_t for n follow)
8315
            {
8316
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
8317 8318
                const size_t offset = current_idx + 3;
                idx += len + 2; // skip 2 size bytes + content bytes
8319
                check_length(v.size(), len, offset);
8320
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
8321
            }
8322

N
Niels Lohmann 已提交
8323
            case 0x7a: // UTF-8 string (four-byte uint32_t for n follow)
8324
            {
8325
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
8326 8327
                const size_t offset = current_idx + 5;
                idx += len + 4; // skip 4 size bytes + content bytes
8328
                check_length(v.size(), len, offset);
8329
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
8330
            }
8331

N
Niels Lohmann 已提交
8332
            case 0x7b: // UTF-8 string (eight-byte uint64_t for n follow)
8333
            {
8334
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
8335 8336
                const size_t offset = current_idx + 9;
                idx += len + 8; // skip 8 size bytes + content bytes
8337
                check_length(v.size(), len, offset);
8338
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
8339
            }
8340 8341

            case 0x7f: // UTF-8 string (indefinite length)
8342
            {
8343
                std::string result;
8344
                while (v.at(idx) != 0xff)
8345 8346 8347 8348 8349 8350 8351
                {
                    string_t s = from_cbor_internal(v, idx);
                    result += s;
                }
                // skip break byte (0xFF)
                idx += 1;
                return result;
8352
            }
8353

N
Niels Lohmann 已提交
8354
            // array (0x00..0x17 data items follow)
8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378
            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 已提交
8379
            {
8380
                basic_json result = value_t::array;
8381
                const auto len = static_cast<size_t>(v[current_idx] - 0x80);
8382 8383 8384 8385 8386
                for (size_t i = 0; i < len; ++i)
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                return result;
N
Niels Lohmann 已提交
8387
            }
8388

N
Niels Lohmann 已提交
8389
            case 0x98: // array (one-byte uint8_t for n follows)
N
Niels Lohmann 已提交
8390
            {
8391
                basic_json result = value_t::array;
8392
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
8393 8394 8395 8396 8397 8398
                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 已提交
8399 8400
            }

N
Niels Lohmann 已提交
8401
            case 0x99: // array (two-byte uint16_t for n follow)
8402 8403
            {
                basic_json result = value_t::array;
8404
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
8405 8406 8407 8408 8409 8410 8411 8412
                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 已提交
8413
            case 0x9a: // array (four-byte uint32_t for n follow)
8414 8415
            {
                basic_json result = value_t::array;
8416
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
8417 8418 8419 8420 8421 8422 8423 8424
                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 已提交
8425
            case 0x9b: // array (eight-byte uint64_t for n follow)
8426 8427
            {
                basic_json result = value_t::array;
8428
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439
                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;
8440
                while (v.at(idx) != 0xff)
8441 8442 8443 8444 8445 8446 8447 8448
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                // skip break byte (0xFF)
                idx += 1;
                return result;
            }

N
Niels Lohmann 已提交
8449
            // map (0x00..0x17 pairs of data items follow)
8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475
            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;
8476
                const auto len = static_cast<size_t>(v[current_idx] - 0xa0);
8477 8478 8479 8480 8481 8482 8483 8484
                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 已提交
8485
            case 0xb8: // map (one-byte uint8_t for n follows)
8486 8487
            {
                basic_json result = value_t::object;
8488
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
8489 8490 8491 8492 8493 8494 8495 8496 8497
                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 已提交
8498
            case 0xb9: // map (two-byte uint16_t for n follow)
8499 8500
            {
                basic_json result = value_t::object;
8501
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
8502 8503 8504 8505 8506 8507 8508 8509 8510
                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 已提交
8511
            case 0xba: // map (four-byte uint32_t for n follow)
8512 8513
            {
                basic_json result = value_t::object;
8514
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
8515 8516 8517 8518 8519 8520 8521 8522 8523
                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 已提交
8524
            case 0xbb: // map (eight-byte uint64_t for n follow)
8525 8526
            {
                basic_json result = value_t::object;
8527
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539
                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;
8540
                while (v.at(idx) != 0xff)
8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564
                {
                    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 已提交
8565
            case 0xf9: // Half-Precision Float (two-byte IEEE 754)
8566 8567 8568 8569
            {
                idx += 2; // skip two content bytes

                // code from RFC 7049, Appendix D, Figure 3:
N
Niels Lohmann 已提交
8570 8571 8572 8573 8574 8575
                // 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.
N
Niels Lohmann 已提交
8576
                const int half = (v.at(current_idx + 1) << 8) + v.at(current_idx + 2);
8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589
                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
                {
8590 8591 8592
                    val = mant == 0
                          ? std::numeric_limits<double>::infinity()
                          : std::numeric_limits<double>::quiet_NaN();
8593
                }
N
Niels Lohmann 已提交
8594
                return (half & 0x8000) != 0 ? -val : val;
8595 8596
            }

N
Niels Lohmann 已提交
8597
            case 0xfa: // Single-Precision Float (four-byte IEEE 754)
8598 8599 8600 8601 8602
            {
                // copy bytes in reverse order into the float variable
                float res;
                for (size_t byte = 0; byte < sizeof(float); ++byte)
                {
N
Niels Lohmann 已提交
8603
                    reinterpret_cast<uint8_t*>(&res)[sizeof(float) - byte - 1] = v.at(current_idx + 1 + byte);
8604 8605 8606 8607 8608
                }
                idx += sizeof(float); // skip content bytes
                return res;
            }

N
Niels Lohmann 已提交
8609
            case 0xfb: // Double-Precision Float (eight-byte IEEE 754)
8610 8611 8612 8613 8614
            {
                // copy bytes in reverse order into the double variable
                double res;
                for (size_t byte = 0; byte < sizeof(double); ++byte)
                {
N
Niels Lohmann 已提交
8615
                    reinterpret_cast<uint8_t*>(&res)[sizeof(double) - byte - 1] = v.at(current_idx + 1 + byte);
8616 8617 8618 8619 8620
                }
                idx += sizeof(double); // skip content bytes
                return res;
            }

N
Niels Lohmann 已提交
8621
            default: // anything else (0xFF is handled inside the other types)
8622
            {
8623
                JSON_THROW(std::invalid_argument("error parsing a CBOR @ " + std::to_string(current_idx) + ": " + std::to_string(static_cast<int>(v[current_idx]))));
8624 8625
            }
        }
N
Niels Lohmann 已提交
8626 8627
    }

N
Niels 已提交
8628 8629
  public:
    /*!
8630 8631 8632 8633 8634 8635
    @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 已提交
8636
    @param[in] j  JSON value to serialize
8637 8638 8639 8640 8641 8642 8643 8644
    @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
8645 8646
    @sa @ref from_msgpack(const std::vector<uint8_t>&, const size_t) for the
        analogous deserialization
8647
    @sa @ref to_cbor(const basic_json& for the related CBOR format
8648 8649

    @since version 2.0.9
N
Niels 已提交
8650 8651 8652 8653 8654 8655 8656 8657
    */
    static std::vector<uint8_t> to_msgpack(const basic_json& j)
    {
        std::vector<uint8_t> result;
        to_msgpack_internal(j, result);
        return result;
    }

8658 8659 8660 8661 8662 8663 8664
    /*!
    @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
8665
    @param[in] start_index the index to start reading from @a v (0 by default)
8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678
    @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
8679 8680 8681
    @sa @ref from_cbor(const std::vector<uint8_t>&, const size_t) for the
        related CBOR format

N
Niels Lohmann 已提交
8682
    @since version 2.0.9, parameter @a start_index since 2.1.1
8683
    */
8684 8685
    static basic_json from_msgpack(const std::vector<uint8_t>& v,
                                   const size_t start_index = 0)
N
Niels 已提交
8686
    {
8687
        size_t i = start_index;
N
Niels 已提交
8688 8689 8690
        return from_msgpack_internal(v, i);
    }

N
Niels Lohmann 已提交
8691
    /*!
8692 8693 8694 8695 8696 8697 8698
    @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 已提交
8699
    @param[in] j  JSON value to serialize
8700 8701 8702 8703 8704 8705 8706 8707
    @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
8708 8709
    @sa @ref from_cbor(const std::vector<uint8_t>&, const size_t) for the
        analogous deserialization
8710
    @sa @ref to_msgpack(const basic_json& for the related MessagePack format
8711 8712

    @since version 2.0.9
N
Niels Lohmann 已提交
8713 8714 8715 8716 8717 8718 8719 8720
    */
    static std::vector<uint8_t> to_cbor(const basic_json& j)
    {
        std::vector<uint8_t> result;
        to_cbor_internal(j, result);
        return result;
    }

8721 8722 8723 8724 8725 8726 8727
    /*!
    @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
8728
    @param[in] start_index the index to start reading from @a v (0 by default)
8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741
    @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
8742 8743 8744
    @sa @ref from_msgpack(const std::vector<uint8_t>&, const size_t) for the
        related MessagePack format

N
Niels Lohmann 已提交
8745
    @since version 2.0.9, parameter @a start_index since 2.1.1
8746
    */
8747 8748
    static basic_json from_cbor(const std::vector<uint8_t>& v,
                                const size_t start_index = 0)
N
Niels Lohmann 已提交
8749
    {
8750
        size_t i = start_index;
N
Niels Lohmann 已提交
8751 8752 8753
        return from_cbor_internal(v, i);
    }

N
Niels 已提交
8754
    /// @}
N
Niels 已提交
8755

N
cleanup  
Niels 已提交
8756 8757 8758 8759
    ///////////////////////////
    // convenience functions //
    ///////////////////////////

N
Niels 已提交
8760 8761 8762 8763 8764 8765
    /*!
    @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 已提交
8766
    @return basically a string representation of a the @a m_type member
N
Niels 已提交
8767 8768 8769

    @complexity Constant.

8770
    @liveexample{The following code exemplifies `type_name()` for all JSON
8771
    types.,type_name}
8772

8773
    @since version 1.0.0, public since 2.1.0
N
Niels 已提交
8774
    */
T
Théo DELRIEU 已提交
8775 8776
    std::string type_name() const
    {
T
Théo DELRIEU 已提交
8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795
        {
            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 已提交
8796
    }
N
cleanup  
Niels 已提交
8797 8798 8799 8800 8801 8802 8803 8804


  private:
    //////////////////////
    // member variables //
    //////////////////////

    /// the type of the current element
N
Niels 已提交
8805
    value_t m_type = value_t::null;
N
cleanup  
Niels 已提交
8806 8807 8808 8809

    /// the value of the current element
    json_value m_value = {};

N
Niels 已提交
8810

N
Niels 已提交
8811
  private:
N
cleanup  
Niels 已提交
8812 8813 8814 8815
    ///////////////
    // iterators //
    ///////////////

8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826
    /*!
    @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 已提交
8827
      public:
8828

8829
        difference_type get_value() const noexcept
T
Théo DELRIEU 已提交
8830 8831 8832 8833 8834 8835 8836 8837
        {
            return m_it;
        }
        /// set iterator to a defined beginning
        void set_begin() noexcept
        {
            m_it = begin_value;
        }
8838

T
Théo DELRIEU 已提交
8839 8840 8841 8842 8843
        /// set iterator to a defined past the end
        void set_end() noexcept
        {
            m_it = end_value;
        }
8844

T
Théo DELRIEU 已提交
8845 8846 8847 8848 8849
        /// return whether the iterator can be dereferenced
        constexpr bool is_begin() const noexcept
        {
            return (m_it == begin_value);
        }
8850

T
Théo DELRIEU 已提交
8851 8852 8853 8854 8855
        /// return whether the iterator is at end
        constexpr bool is_end() const noexcept
        {
            return (m_it == end_value);
        }
8856

T
Théo DELRIEU 已提交
8857 8858 8859 8860
        friend constexpr bool operator==(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it == rhs.m_it;
        }
8861

T
Théo DELRIEU 已提交
8862 8863 8864 8865
        friend constexpr bool operator!=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return !(lhs == rhs);
        }
8866

T
Théo DELRIEU 已提交
8867 8868 8869 8870
        friend constexpr bool operator<(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it < rhs.m_it;
        }
8871

T
Théo DELRIEU 已提交
8872 8873 8874 8875
        friend constexpr bool operator<=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it <= rhs.m_it;
        }
8876

T
Théo DELRIEU 已提交
8877 8878 8879 8880
        friend constexpr bool operator>(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it > rhs.m_it;
        }
8881

T
Théo DELRIEU 已提交
8882 8883 8884 8885
        friend constexpr bool operator>=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it >= rhs.m_it;
        }
8886

T
Théo DELRIEU 已提交
8887 8888 8889 8890 8891 8892
        primitive_iterator_t operator+(difference_type i)
        {
            auto result = *this;
            result += i;
            return result;
        }
8893

T
Théo DELRIEU 已提交
8894 8895 8896 8897
        friend constexpr difference_type operator-(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it - rhs.m_it;
        }
8898

T
Théo DELRIEU 已提交
8899 8900 8901 8902
        friend std::ostream& operator<<(std::ostream& os, primitive_iterator_t it)
        {
            return os << it.m_it;
        }
8903

T
Théo DELRIEU 已提交
8904 8905 8906 8907 8908
        primitive_iterator_t& operator++()
        {
            ++m_it;
            return *this;
        }
8909

N
Niels Lohmann 已提交
8910
        primitive_iterator_t operator++(int)
T
Théo DELRIEU 已提交
8911
        {
N
Niels Lohmann 已提交
8912
            auto result = *this;
T
Théo DELRIEU 已提交
8913
            m_it++;
N
Niels Lohmann 已提交
8914
            return result;
T
Théo DELRIEU 已提交
8915
        }
8916

T
Théo DELRIEU 已提交
8917 8918 8919 8920 8921
        primitive_iterator_t& operator--()
        {
            --m_it;
            return *this;
        }
8922

N
Niels Lohmann 已提交
8923
        primitive_iterator_t operator--(int)
T
Théo DELRIEU 已提交
8924
        {
N
Niels Lohmann 已提交
8925
            auto result = *this;
T
Théo DELRIEU 已提交
8926
            m_it--;
N
Niels Lohmann 已提交
8927
            return result;
T
Théo DELRIEU 已提交
8928
        }
8929

T
Théo DELRIEU 已提交
8930 8931 8932 8933 8934
        primitive_iterator_t& operator+=(difference_type n)
        {
            m_it += n;
            return *this;
        }
8935

T
Théo DELRIEU 已提交
8936 8937 8938 8939 8940
        primitive_iterator_t& operator-=(difference_type n)
        {
            m_it -= n;
            return *this;
        }
8941

T
Théo DELRIEU 已提交
8942 8943 8944
      private:
        static constexpr difference_type begin_value = 0;
        static constexpr difference_type end_value = begin_value + 1;
8945

T
Théo DELRIEU 已提交
8946 8947 8948
        /// iterator as signed integer type
        difference_type m_it = std::numeric_limits<std::ptrdiff_t>::denorm_min();
    };
8949

N
Niels 已提交
8950 8951 8952 8953 8954 8955 8956 8957
    /*!
    @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 已提交
8958 8959
    {
        /// iterator for JSON objects
N
Niels 已提交
8960
        typename object_t::iterator object_iterator;
N
Niels 已提交
8961
        /// iterator for JSON arrays
N
Niels 已提交
8962
        typename array_t::iterator array_iterator;
N
Niels 已提交
8963
        /// generic iterator for all other types
N
Niels 已提交
8964 8965 8966
        primitive_iterator_t primitive_iterator;

        /// create an uninitialized internal_iterator
N
Niels 已提交
8967
        internal_iterator() noexcept
T
Théo DELRIEU 已提交
8968 8969
            : object_iterator(), array_iterator(), primitive_iterator()
        {}
N
Niels 已提交
8970 8971
    };

N
cleanup  
Niels 已提交
8972 8973 8974 8975
    /// proxy class for the iterator_wrapper functions
    template<typename IteratorType>
    class iteration_proxy
    {
T
Théo DELRIEU 已提交
8976
      private:
N
cleanup  
Niels 已提交
8977 8978 8979
        /// helper class for iteration
        class iteration_proxy_internal
        {
T
Théo DELRIEU 已提交
8980
          private:
N
cleanup  
Niels 已提交
8981 8982 8983 8984 8985
            /// the iterator
            IteratorType anchor;
            /// an index for arrays (used to create key names)
            size_t array_index = 0;

T
Théo DELRIEU 已提交
8986
          public:
N
Niels 已提交
8987
            explicit iteration_proxy_internal(IteratorType it) noexcept
T
Théo DELRIEU 已提交
8988 8989
                : anchor(it)
            {}
N
cleanup  
Niels 已提交
8990

T
Théo DELRIEU 已提交
8991 8992 8993 8994 8995
            /// dereference operator (needed for range-based for)
            iteration_proxy_internal& operator*()
            {
                return *this;
            }
8996

T
Théo DELRIEU 已提交
8997 8998 8999 9000 9001
            /// increment operator (needed for range-based for)
            iteration_proxy_internal& operator++()
            {
                ++anchor;
                ++array_index;
N
cleanup  
Niels 已提交
9002

T
Théo DELRIEU 已提交
9003 9004
                return *this;
            }
9005

T
Théo DELRIEU 已提交
9006 9007
            /// inequality operator (needed for range-based for)
            bool operator!= (const iteration_proxy_internal& o) const
N
cleanup  
Niels 已提交
9008
            {
T
Théo DELRIEU 已提交
9009
                return anchor != o.anchor;
N
cleanup  
Niels 已提交
9010 9011
            }

T
Théo DELRIEU 已提交
9012 9013
            /// return key of the iterator
            typename basic_json::string_t key() const
N
cleanup  
Niels 已提交
9014
            {
T
Théo DELRIEU 已提交
9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036
                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 已提交
9037 9038
            }

T
Théo DELRIEU 已提交
9039 9040
            /// return value of the iterator
            typename IteratorType::reference value() const
N
cleanup  
Niels 已提交
9041
            {
T
Théo DELRIEU 已提交
9042
                return anchor.value();
N
cleanup  
Niels 已提交
9043 9044 9045
            }
        };

T
Théo DELRIEU 已提交
9046 9047
        /// the container to iterate
        typename IteratorType::reference container;
N
cleanup  
Niels 已提交
9048

T
Théo DELRIEU 已提交
9049 9050 9051 9052 9053
      public:
        /// construct iteration proxy from a container
        explicit iteration_proxy(typename IteratorType::reference cont)
            : container(cont)
        {}
N
cleanup  
Niels 已提交
9054

T
Théo DELRIEU 已提交
9055 9056 9057 9058 9059
        /// return iterator begin (needed for range-based for)
        iteration_proxy_internal begin() noexcept
        {
            return iteration_proxy_internal(container.begin());
        }
N
cleanup  
Niels 已提交
9060

T
Théo DELRIEU 已提交
9061 9062 9063 9064 9065 9066
        /// return iterator end (needed for range-based for)
        iteration_proxy_internal end() noexcept
        {
            return iteration_proxy_internal(container.end());
        }
    };
N
cleanup  
Niels 已提交
9067

N
Niels 已提交
9068
  public:
N
Niels 已提交
9069
    /*!
9070
    @brief a template for a random access iterator for the @ref basic_json class
N
Niels 已提交
9071

N
Niels Lohmann 已提交
9072 9073
    This class implements a both iterators (iterator and const_iterator) for the
    @ref basic_json class.
N
Niels 已提交
9074

N
Niels 已提交
9075 9076 9077
    @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 已提交
9078 9079
          methods are undefined. **The library uses assertions to detect calls
          on uninitialized iterators.**
N
Niels 已提交
9080

N
Niels 已提交
9081 9082 9083 9084
    @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 已提交
9085

N
Niels Lohmann 已提交
9086
    @since version 1.0.0, simplified in version 2.0.9
N
Niels 已提交
9087
    */
N
Niels Lohmann 已提交
9088
    template<typename U>
T
Théo DELRIEU 已提交
9089
    class iter_impl : public std::iterator<std::random_access_iterator_tag, U>
N
cleanup  
Niels 已提交
9090
    {
N
Niels 已提交
9091
        /// allow basic_json to access private members
9092 9093
        friend class basic_json;

9094 9095 9096 9097 9098
        // 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 已提交
9099
      public:
N
cleanup  
Niels 已提交
9100
        /// the type of the values when the iterator is dereferenced
N
Niels 已提交
9101
        using value_type = typename basic_json::value_type;
N
cleanup  
Niels 已提交
9102
        /// a type to represent differences between iterators
N
Niels 已提交
9103
        using difference_type = typename basic_json::difference_type;
N
cleanup  
Niels 已提交
9104
        /// defines a pointer to the type iterated over (value_type)
9105
        using pointer = typename std::conditional<std::is_const<U>::value,
T
Théo DELRIEU 已提交
9106 9107
              typename basic_json::const_pointer,
              typename basic_json::pointer>::type;
N
cleanup  
Niels 已提交
9108
        /// defines a reference to the type iterated over (value_type)
9109
        using reference = typename std::conditional<std::is_const<U>::value,
T
Théo DELRIEU 已提交
9110 9111
              typename basic_json::const_reference,
              typename basic_json::reference>::type;
N
cleanup  
Niels 已提交
9112
        /// the category of the iterator
N
Niels 已提交
9113
        using iterator_category = std::bidirectional_iterator_tag;
N
cleanup  
Niels 已提交
9114

9115
        /// default constructor
9116
        iter_impl() = default;
9117

N
Niels 已提交
9118 9119 9120 9121 9122 9123
        /*!
        @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`.
        */
9124
        explicit iter_impl(pointer object) noexcept
T
Théo DELRIEU 已提交
9125
            : m_object(object)
N
cleanup  
Niels 已提交
9126
        {
T
Théo DELRIEU 已提交
9127
            assert(m_object != nullptr);
N
Niels 已提交
9128

T
Théo DELRIEU 已提交
9129
            switch (m_object->m_type)
N
cleanup  
Niels 已提交
9130
            {
T
Théo DELRIEU 已提交
9131 9132 9133 9134 9135
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = typename object_t::iterator();
                    break;
                }
9136

T
Théo DELRIEU 已提交
9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147
                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
cleanup  
Niels 已提交
9148 9149
            }
        }
N
Niels 已提交
9150

T
Théo DELRIEU 已提交
9151 9152 9153 9154
        /*
        Use operator `const_iterator` instead of `const_iterator(const iterator&
        other) noexcept` to avoid two class definitions for @ref iterator and
        @ref const_iterator.
9155

T
Théo DELRIEU 已提交
9156 9157 9158 9159
        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 已提交
9160
        {
T
Théo DELRIEU 已提交
9161
            const_iterator ret;
N
Niels 已提交
9162

T
Théo DELRIEU 已提交
9163 9164 9165 9166 9167
            if (m_object)
            {
                ret.m_object = m_object;
                ret.m_it = m_it;
            }
9168

T
Théo DELRIEU 已提交
9169 9170
            return ret;
        }
N
Niels 已提交
9171

T
Théo DELRIEU 已提交
9172 9173 9174 9175 9176 9177 9178 9179
        /*!
        @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 已提交
9180

T
Théo DELRIEU 已提交
9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196
        /*!
        @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
cleanup  
Niels 已提交
9197

T
Théo DELRIEU 已提交
9198 9199 9200 9201 9202 9203
      private:
        /*!
        @brief set the iterator to the first value
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        void set_begin() noexcept
N
cleanup  
Niels 已提交
9204
        {
T
Théo DELRIEU 已提交
9205
            assert(m_object != nullptr);
N
cleanup  
Niels 已提交
9206

T
Théo DELRIEU 已提交
9207
            switch (m_object->m_type)
9208
            {
T
Théo DELRIEU 已提交
9209 9210 9211 9212 9213
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = m_object->m_value.object->begin();
                    break;
                }
N
cleanup  
Niels 已提交
9214

T
Théo DELRIEU 已提交
9215 9216 9217 9218 9219
                case basic_json::value_t::array:
                {
                    m_it.array_iterator = m_object->m_value.array->begin();
                    break;
                }
N
cleanup  
Niels 已提交
9220

T
Théo DELRIEU 已提交
9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232
                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
cleanup  
Niels 已提交
9233 9234 9235
            }
        }

T
Théo DELRIEU 已提交
9236 9237 9238 9239 9240
        /*!
        @brief set the iterator past the last value
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        void set_end() noexcept
9241
        {
T
Théo DELRIEU 已提交
9242
            assert(m_object != nullptr);
N
cleanup  
Niels 已提交
9243

T
Théo DELRIEU 已提交
9244
            switch (m_object->m_type)
9245
            {
T
Théo DELRIEU 已提交
9246 9247 9248 9249 9250
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = m_object->m_value.object->end();
                    break;
                }
N
cleanup  
Niels 已提交
9251

T
Théo DELRIEU 已提交
9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262
                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
cleanup  
Niels 已提交
9263 9264
            }
        }
N
Niels 已提交
9265

T
Théo DELRIEU 已提交
9266 9267 9268 9269 9270 9271
      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
9272
        {
T
Théo DELRIEU 已提交
9273
            assert(m_object != nullptr);
N
cleanup  
Niels 已提交
9274

T
Théo DELRIEU 已提交
9275
            switch (m_object->m_type)
9276
            {
T
Théo DELRIEU 已提交
9277 9278 9279 9280 9281
                case basic_json::value_t::object:
                {
                    assert(m_it.object_iterator != m_object->m_value.object->end());
                    return m_it.object_iterator->second;
                }
N
cleanup  
Niels 已提交
9282

T
Théo DELRIEU 已提交
9283 9284 9285 9286 9287
                case basic_json::value_t::array:
                {
                    assert(m_it.array_iterator != m_object->m_value.array->end());
                    return *m_it.array_iterator;
                }
N
cleanup  
Niels 已提交
9288

T
Théo DELRIEU 已提交
9289
                case basic_json::value_t::null:
N
cleanup  
Niels 已提交
9290
                {
9291
                    JSON_THROW(invalid_iterator(214, "cannot get value"));
9292
                }
N
Niels Lohmann 已提交
9293

T
Théo DELRIEU 已提交
9294 9295 9296 9297 9298 9299 9300
                default:
                {
                    if (m_it.primitive_iterator.is_begin())
                    {
                        return *m_object;
                    }

9301
                    JSON_THROW(invalid_iterator(214, "cannot get value"));
T
Théo DELRIEU 已提交
9302
                }
N
cleanup  
Niels 已提交
9303 9304
            }
        }
9305

T
Théo DELRIEU 已提交
9306 9307 9308 9309 9310
        /*!
        @brief dereference the iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        pointer operator->() const
N
cleanup  
Niels 已提交
9311
        {
T
Théo DELRIEU 已提交
9312
            assert(m_object != nullptr);
N
Niels 已提交
9313

T
Théo DELRIEU 已提交
9314
            switch (m_object->m_type)
N
cleanup  
Niels 已提交
9315
            {
T
Théo DELRIEU 已提交
9316 9317 9318 9319 9320
                case basic_json::value_t::object:
                {
                    assert(m_it.object_iterator != m_object->m_value.object->end());
                    return &(m_it.object_iterator->second);
                }
N
cleanup  
Niels 已提交
9321

T
Théo DELRIEU 已提交
9322
                case basic_json::value_t::array:
N
cleanup  
Niels 已提交
9323
                {
T
Théo DELRIEU 已提交
9324 9325
                    assert(m_it.array_iterator != m_object->m_value.array->end());
                    return &*m_it.array_iterator;
N
cleanup  
Niels 已提交
9326 9327
                }

T
Théo DELRIEU 已提交
9328 9329 9330 9331 9332 9333 9334
                default:
                {
                    if (m_it.primitive_iterator.is_begin())
                    {
                        return m_object;
                    }

9335
                    JSON_THROW(invalid_iterator(214, "cannot get value"));
T
Théo DELRIEU 已提交
9336
                }
N
cleanup  
Niels 已提交
9337 9338 9339
            }
        }

T
Théo DELRIEU 已提交
9340 9341 9342 9343 9344 9345 9346 9347 9348 9349
        /*!
        @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 已提交
9350

T
Théo DELRIEU 已提交
9351 9352 9353 9354 9355
        /*!
        @brief pre-increment (++it)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator++()
9356
        {
T
Théo DELRIEU 已提交
9357
            assert(m_object != nullptr);
N
cleanup  
Niels 已提交
9358

T
Théo DELRIEU 已提交
9359
            switch (m_object->m_type)
9360
            {
T
Théo DELRIEU 已提交
9361 9362 9363 9364 9365
                case basic_json::value_t::object:
                {
                    std::advance(m_it.object_iterator, 1);
                    break;
                }
N
cleanup  
Niels 已提交
9366

T
Théo DELRIEU 已提交
9367 9368 9369 9370 9371
                case basic_json::value_t::array:
                {
                    std::advance(m_it.array_iterator, 1);
                    break;
                }
N
cleanup  
Niels 已提交
9372

T
Théo DELRIEU 已提交
9373 9374 9375 9376 9377 9378
                default:
                {
                    ++m_it.primitive_iterator;
                    break;
                }
            }
N
cleanup  
Niels 已提交
9379

T
Théo DELRIEU 已提交
9380 9381
            return *this;
        }
N
Niels 已提交
9382

T
Théo DELRIEU 已提交
9383 9384 9385 9386 9387 9388 9389 9390 9391 9392
        /*!
        @brief post-decrement (it--)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl operator--(int)
        {
            auto result = *this;
            --(*this);
            return result;
        }
N
cleanup  
Niels 已提交
9393

T
Théo DELRIEU 已提交
9394 9395 9396 9397 9398
        /*!
        @brief pre-decrement (--it)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator--()
9399
        {
T
Théo DELRIEU 已提交
9400 9401 9402
            assert(m_object != nullptr);

            switch (m_object->m_type)
9403
            {
T
Théo DELRIEU 已提交
9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420
                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;
                }
9421
            }
N
cleanup  
Niels 已提交
9422

T
Théo DELRIEU 已提交
9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433
            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)
9434
            {
9435
                JSON_THROW(invalid_iterator(212, "cannot compare iterators of different containers"));
N
cleanup  
Niels 已提交
9436 9437
            }

T
Théo DELRIEU 已提交
9438 9439 9440
            assert(m_object != nullptr);

            switch (m_object->m_type)
9441
            {
T
Théo DELRIEU 已提交
9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455
                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);
                }
9456
            }
N
cleanup  
Niels 已提交
9457 9458
        }

T
Théo DELRIEU 已提交
9459 9460 9461 9462 9463
        /*!
        @brief  comparison: not equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator!=(const iter_impl& other) const
N
cleanup  
Niels 已提交
9464
        {
T
Théo DELRIEU 已提交
9465
            return not operator==(other);
9466
        }
N
cleanup  
Niels 已提交
9467

T
Théo DELRIEU 已提交
9468 9469 9470 9471 9472
        /*!
        @brief  comparison: smaller
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator<(const iter_impl& other) const
9473
        {
T
Théo DELRIEU 已提交
9474 9475
            // if objects are not the same, the comparison is undefined
            if (m_object != other.m_object)
N
cleanup  
Niels 已提交
9476
            {
9477
                JSON_THROW(invalid_iterator(212, "cannot compare iterators of different containers"));
9478
            }
N
cleanup  
Niels 已提交
9479

T
Théo DELRIEU 已提交
9480
            assert(m_object != nullptr);
N
cleanup  
Niels 已提交
9481

T
Théo DELRIEU 已提交
9482
            switch (m_object->m_type)
9483
            {
T
Théo DELRIEU 已提交
9484 9485
                case basic_json::value_t::object:
                {
9486
                    JSON_THROW(invalid_iterator(213, "cannot compare order of object iterators"));
T
Théo DELRIEU 已提交
9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497
                }

                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
cleanup  
Niels 已提交
9498 9499 9500
            }
        }

T
Théo DELRIEU 已提交
9501 9502 9503 9504 9505
        /*!
        @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 已提交
9506
        {
T
Théo DELRIEU 已提交
9507
            return not other.operator < (*this);
9508
        }
N
Niels 已提交
9509

T
Théo DELRIEU 已提交
9510 9511 9512 9513 9514
        /*!
        @brief  comparison: greater than
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator>(const iter_impl& other) const
9515
        {
T
Théo DELRIEU 已提交
9516
            return not operator<=(other);
N
Niels 已提交
9517 9518
        }

T
Théo DELRIEU 已提交
9519 9520 9521 9522 9523 9524 9525 9526
        /*!
        @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);
        }
N
Niels 已提交
9527

T
Théo DELRIEU 已提交
9528 9529 9530 9531 9532
        /*!
        @brief  add to iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator+=(difference_type i)
9533
        {
T
Théo DELRIEU 已提交
9534 9535 9536
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
9537
            {
T
Théo DELRIEU 已提交
9538 9539
                case basic_json::value_t::object:
                {
9540
                    JSON_THROW(invalid_iterator(209, "cannot use offsets with object iterators"));
T
Théo DELRIEU 已提交
9541
                }
N
Niels 已提交
9542

T
Théo DELRIEU 已提交
9543 9544 9545 9546 9547
                case basic_json::value_t::array:
                {
                    std::advance(m_it.array_iterator, i);
                    break;
                }
N
Niels 已提交
9548

T
Théo DELRIEU 已提交
9549 9550 9551 9552 9553
                default:
                {
                    m_it.primitive_iterator += i;
                    break;
                }
9554
            }
N
Niels 已提交
9555

T
Théo DELRIEU 已提交
9556 9557
            return *this;
        }
N
Niels 已提交
9558

T
Théo DELRIEU 已提交
9559 9560 9561 9562 9563 9564 9565 9566
        /*!
        @brief  subtract from iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator-=(difference_type i)
        {
            return operator+=(-i);
        }
N
Niels 已提交
9567

T
Théo DELRIEU 已提交
9568 9569 9570 9571 9572 9573 9574 9575 9576 9577
        /*!
        @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;
        }
N
Niels 已提交
9578

T
Théo DELRIEU 已提交
9579 9580 9581 9582 9583 9584 9585 9586 9587 9588
        /*!
        @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;
        }
9589

T
Théo DELRIEU 已提交
9590 9591 9592 9593 9594
        /*!
        @brief  return difference
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        difference_type operator-(const iter_impl& other) const
9595
        {
T
Théo DELRIEU 已提交
9596 9597 9598
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
9599
            {
T
Théo DELRIEU 已提交
9600 9601
                case basic_json::value_t::object:
                {
9602
                    JSON_THROW(invalid_iterator(209, "cannot use offsets with object iterators"));
T
Théo DELRIEU 已提交
9603
                }
N
Niels 已提交
9604

T
Théo DELRIEU 已提交
9605 9606 9607 9608
                case basic_json::value_t::array:
                {
                    return m_it.array_iterator - other.m_it.array_iterator;
                }
N
Niels 已提交
9609

T
Théo DELRIEU 已提交
9610 9611 9612 9613
                default:
                {
                    return m_it.primitive_iterator - other.m_it.primitive_iterator;
                }
N
Niels 已提交
9614 9615 9616
            }
        }

T
Théo DELRIEU 已提交
9617 9618 9619 9620 9621
        /*!
        @brief  access to successor
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        reference operator[](difference_type n) const
9622
        {
T
Théo DELRIEU 已提交
9623 9624 9625
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
9626
            {
T
Théo DELRIEU 已提交
9627 9628
                case basic_json::value_t::object:
                {
9629
                    JSON_THROW(invalid_iterator(208, "cannot use operator[] for object iterators"));
T
Théo DELRIEU 已提交
9630
                }
N
Niels 已提交
9631

T
Théo DELRIEU 已提交
9632 9633 9634 9635
                case basic_json::value_t::array:
                {
                    return *std::next(m_it.array_iterator, n);
                }
N
Niels 已提交
9636

T
Théo DELRIEU 已提交
9637 9638
                case basic_json::value_t::null:
                {
9639
                    JSON_THROW(invalid_iterator(214, "cannot get value"));
T
Théo DELRIEU 已提交
9640
                }
N
Niels 已提交
9641

T
Théo DELRIEU 已提交
9642
                default:
N
Niels 已提交
9643
                {
T
Théo DELRIEU 已提交
9644 9645 9646 9647
                    if (m_it.primitive_iterator.get_value() == -n)
                    {
                        return *m_object;
                    }
N
Niels Lohmann 已提交
9648

9649
                    JSON_THROW(invalid_iterator(214, "cannot get value"));
T
Théo DELRIEU 已提交
9650
                }
N
Niels 已提交
9651 9652
            }
        }
N
Niels 已提交
9653

T
Théo DELRIEU 已提交
9654 9655 9656 9657 9658
        /*!
        @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
9659
        {
T
Théo DELRIEU 已提交
9660 9661 9662 9663 9664 9665
            assert(m_object != nullptr);

            if (m_object->is_object())
            {
                return m_it.object_iterator->first;
            }
N
Niels Lohmann 已提交
9666

9667
            JSON_THROW(invalid_iterator(207, "cannot use key() for non-object iterators"));
T
Théo DELRIEU 已提交
9668
        }
N
Niels 已提交
9669

T
Théo DELRIEU 已提交
9670 9671 9672 9673 9674 9675 9676 9677
        /*!
        @brief  return the value of an iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        reference value() const
        {
            return operator*();
        }
N
Niels 已提交
9678

T
Théo DELRIEU 已提交
9679 9680 9681 9682 9683 9684
      private:
        /// associated JSON instance
        pointer m_object = nullptr;
        /// the actual iterator of the associated instance
        internal_iterator m_it = internal_iterator();
    };
N
cleanup  
Niels 已提交
9685

N
Niels 已提交
9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699
    /*!
    @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 已提交
9700

N
Niels 已提交
9701
    @since version 1.0.0
N
Niels 已提交
9702
    */
N
Niels 已提交
9703
    template<typename Base>
T
Théo DELRIEU 已提交
9704
    class json_reverse_iterator : public std::reverse_iterator<Base>
9705
    {
T
Théo DELRIEU 已提交
9706
      public:
9707
        /// shortcut to the reverse iterator adaptor
N
Niels 已提交
9708
        using base_iterator = std::reverse_iterator<Base>;
N
Niels 已提交
9709
        /// the reference type for the pointed-to element
N
Niels 已提交
9710
        using reference = typename Base::reference;
9711

9712
        /// create reverse iterator from iterator
N
Niels 已提交
9713
        json_reverse_iterator(const typename base_iterator::iterator_type& it) noexcept
T
Théo DELRIEU 已提交
9714 9715
            : base_iterator(it)
        {}
9716

T
Théo DELRIEU 已提交
9717 9718 9719 9720
        /// create reverse iterator from base class
        json_reverse_iterator(const base_iterator& it) noexcept
            : base_iterator(it)
        {}
9721

T
Théo DELRIEU 已提交
9722 9723 9724 9725 9726
        /// post-increment (it++)
        json_reverse_iterator operator++(int)
        {
            return base_iterator::operator++(1);
        }
9727

T
Théo DELRIEU 已提交
9728 9729 9730 9731 9732 9733
        /// pre-increment (++it)
        json_reverse_iterator& operator++()
        {
            base_iterator::operator++();
            return *this;
        }
9734

T
Théo DELRIEU 已提交
9735 9736 9737 9738 9739
        /// post-decrement (it--)
        json_reverse_iterator operator--(int)
        {
            return base_iterator::operator--(1);
        }
9740

T
Théo DELRIEU 已提交
9741 9742 9743 9744 9745 9746
        /// pre-decrement (--it)
        json_reverse_iterator& operator--()
        {
            base_iterator::operator--();
            return *this;
        }
9747

T
Théo DELRIEU 已提交
9748 9749 9750 9751 9752 9753
        /// add to iterator
        json_reverse_iterator& operator+=(difference_type i)
        {
            base_iterator::operator+=(i);
            return *this;
        }
9754

T
Théo DELRIEU 已提交
9755 9756 9757 9758 9759 9760 9761
        /// add to iterator
        json_reverse_iterator operator+(difference_type i) const
        {
            auto result = *this;
            result += i;
            return result;
        }
9762

T
Théo DELRIEU 已提交
9763 9764 9765 9766 9767 9768 9769
        /// subtract from iterator
        json_reverse_iterator operator-(difference_type i) const
        {
            auto result = *this;
            result -= i;
            return result;
        }
9770

T
Théo DELRIEU 已提交
9771 9772 9773 9774 9775
        /// return difference
        difference_type operator-(const json_reverse_iterator& other) const
        {
            return this->base() - other.base();
        }
N
Niels 已提交
9776

T
Théo DELRIEU 已提交
9777 9778 9779 9780 9781
        /// access to successor
        reference operator[](difference_type n) const
        {
            return *(this->operator+(n));
        }
9782

T
Théo DELRIEU 已提交
9783 9784 9785 9786 9787 9788
        /// return the key of an object iterator
        typename object_t::key_type key() const
        {
            auto it = --this->base();
            return it.key();
        }
9789

T
Théo DELRIEU 已提交
9790 9791 9792 9793 9794 9795 9796
        /// return the value of an iterator
        reference value() const
        {
            auto it = --this->base();
            return it.operator * ();
        }
    };
9797

N
Niels 已提交
9798

N
Niels 已提交
9799
  private:
N
Niels 已提交
9800 9801 9802
    //////////////////////
    // lexer and parser //
    //////////////////////
N
Niels 已提交
9803

N
Niels 已提交
9804 9805 9806 9807
    /*!
    @brief lexical analysis

    This class organizes the lexical analysis during JSON deserialization. The
N
Niels 已提交
9808 9809
    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 已提交
9810
    */
N
Niels 已提交
9811
    class lexer
N
Niels 已提交
9812
    {
T
Théo DELRIEU 已提交
9813
      public:
N
Niels 已提交
9814 9815
        /// token types for the parser
        enum class token_type
T
Théo DELRIEU 已提交
9816 9817 9818 9819 9820 9821
        {
            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 已提交
9822 9823
            value_unsigned,  ///< an unsigned integer -- use get_number() for actual value
            value_integer,   ///< a signed integer -- use get_number() for actual value
9824
            value_float,     ///< an floating point number -- use get_number() for actual value
T
Théo DELRIEU 已提交
9825 9826 9827 9828 9829 9830 9831 9832 9833
            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 已提交
9834

T
Théo DELRIEU 已提交
9835 9836
        /// the char type to use in the lexer
        using lexer_char_t = unsigned char;
N
Niels 已提交
9837

T
Théo DELRIEU 已提交
9838 9839 9840 9841 9842 9843 9844 9845
        /// 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 已提交
9846

T
Théo DELRIEU 已提交
9847 9848 9849
        /// a lexer from an input stream
        explicit lexer(std::istream& s)
            : m_stream(&s), m_line_buffer()
9850
        {
T
Théo DELRIEU 已提交
9851 9852 9853
            // immediately abort if stream is erroneous
            if (s.fail())
            {
9854
                JSON_THROW(std::invalid_argument("stream error"));
T
Théo DELRIEU 已提交
9855
            }
N
Niels 已提交
9856

T
Théo DELRIEU 已提交
9857 9858
            // fill buffer
            fill_line_buffer();
N
Niels 已提交
9859

T
Théo DELRIEU 已提交
9860 9861 9862 9863 9864 9865 9866
            // 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] = ' ';
            }
9867
        }
N
Niels 已提交
9868

T
Théo DELRIEU 已提交
9869 9870 9871 9872
        // switch off unwanted functions (due to pointer members)
        lexer() = delete;
        lexer(const lexer&) = delete;
        lexer operator=(const lexer&) = delete;
N
Niels 已提交
9873

T
Théo DELRIEU 已提交
9874 9875
        /*!
        @brief create a string from one or two Unicode code points
N
Niels 已提交
9876

T
Théo DELRIEU 已提交
9877 9878 9879 9880
        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 已提交
9881

T
Théo DELRIEU 已提交
9882 9883
        @param[in] codepoint1  the code point (can be high surrogate)
        @param[in] codepoint2  the code point (can be low surrogate or 0)
N
Niels 已提交
9884

T
Théo DELRIEU 已提交
9885 9886
        @return string representation of the code point; the length of the
        result string is between 1 and 4 characters.
N
Niels 已提交
9887

9888
        @throw parse_error.102 if the low surrogate is invalid; example:
T
Théo DELRIEU 已提交
9889
        `""missing or wrong low surrogate""`
9890 9891
        @throw parse_error.103 if code point is > 0x10ffff; example: `"code
        points above 0x10FFFF are invalid"`
N
Niels 已提交
9892

T
Théo DELRIEU 已提交
9893
        @complexity Constant.
N
Niels 已提交
9894

T
Théo DELRIEU 已提交
9895 9896
        @see <http://en.wikipedia.org/wiki/UTF-8#Sample_code>
        */
9897 9898
        string_t to_unicode(const std::size_t codepoint1,
                            const std::size_t codepoint2 = 0) const
9899
        {
T
Théo DELRIEU 已提交
9900 9901 9902 9903 9904
            // 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 已提交
9905
            {
T
Théo DELRIEU 已提交
9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920
                // 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
                {
9921
                    JSON_THROW(parse_error(102, get_position(), "missing or wrong low surrogate"));
T
Théo DELRIEU 已提交
9922
                }
N
Niels 已提交
9923 9924
            }

T
Théo DELRIEU 已提交
9925
            string_t result;
9926

T
Théo DELRIEU 已提交
9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954
            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
            {
9955
                JSON_THROW(parse_error(103, get_position(), "code points above 0x10FFFF are invalid"));
T
Théo DELRIEU 已提交
9956
            }
9957

T
Théo DELRIEU 已提交
9958 9959
            return result;
        }
9960

T
Théo DELRIEU 已提交
9961 9962 9963 9964
        /// 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 已提交
9965
            {
T
Théo DELRIEU 已提交
9966 9967 9968 9969 9970 9971 9972 9973 9974 9975
                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 已提交
9976 9977
                case lexer::token_type::value_unsigned:
                case lexer::token_type::value_integer:
9978
                case lexer::token_type::value_float:
T
Théo DELRIEU 已提交
9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000
                    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 已提交
10001 10002
            }
        }
N
Niels 已提交
10003

T
Théo DELRIEU 已提交
10004 10005 10006 10007 10008 10009 10010
        /*!
        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.
10011

T
Théo DELRIEU 已提交
10012
        @return the class of the next token read from the buffer
10013

T
Théo DELRIEU 已提交
10014
        @complexity Linear in the length of the input.\n
10015

T
Théo DELRIEU 已提交
10016
        Proposition: The loop below will always terminate for finite input.\n
10017

T
Théo DELRIEU 已提交
10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048 10049
        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()
        {
            while (true)
            {
                // pointer for backtracking information
                m_marker = nullptr;

                // remember the begin of the token
                m_start = m_cursor;
                assert(m_start != nullptr);

                /*!re2c
                    re2c:define:YYCTYPE      = lexer_char_t;
                    re2c:define:YYCURSOR     = m_cursor;
                    re2c:define:YYLIMIT      = m_limit;
                    re2c:define:YYMARKER     = m_marker;
                    re2c:define:YYFILL       = "fill_line_buffer(@@); // LCOV_EXCL_LINE";
                    re2c:define:YYFILL:naked = 1;
                    re2c:yyfill:enable       = 1;
                    re2c:indent:string       = "    ";
                    re2c:indent:top          = 1;
                    re2c:labelprefix         = "basic_json_parser_";

                    // ignore whitespace
                    ws = [ \t\n\r]+;
10050
                    ws   { position += static_cast<size_t>((m_cursor - m_start)); continue; }
T
Théo DELRIEU 已提交
10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063 10064 10065

                    // structural characters
                    "[" { last_token_type = token_type::begin_array; break; }
                    "]" { last_token_type = token_type::end_array; break; }
                    "{" { last_token_type = token_type::begin_object; break; }
                    "}" { last_token_type = token_type::end_object; break; }
                    "," { last_token_type = token_type::value_separator; break; }
                    ":" { last_token_type = token_type::name_separator; break; }

                    // literal names
                    "null"  { last_token_type = token_type::literal_null; break; }
                    "true"  { last_token_type = token_type::literal_true; break; }
                    "false" { last_token_type = token_type::literal_false; break; }

                    // number
10066 10067 10068 10069 10070 10071 10072 10073 10074 10075
                    decimal_point   = ".";
                    digit           = [0-9];
                    digit_1_9       = [1-9];
                    e               = "e" | "E";
                    minus           = "-";
                    plus            = "+";
                    zero            = "0";
                    exp             = e (minus | plus)? digit+;
                    frac            = decimal_point digit+;
                    int             = (zero | digit_1_9 digit*);
N
Niels Lohmann 已提交
10076 10077
                    invalid_int     = minus? "0" digit+;
                    invalid_int     { last_token_type = token_type::parse_error; break; }
10078
                    number_unsigned = int;
N
Niels Lohmann 已提交
10079 10080 10081
                    number_unsigned { last_token_type = token_type::value_unsigned; break; }
                    number_integer  = minus int;
                    number_integer  { last_token_type = token_type::value_integer; break; }
10082 10083
                    number_float    = minus? int frac? exp?;
                    number_float    { last_token_type = token_type::value_float; break; }
T
Théo DELRIEU 已提交
10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101

                    // string
                    quotation_mark  = "\"";
                    escape          = "\\";
                    unescaped       = [^"\\\x00-\x1f];
                    single_escaped  = "\"" | "\\" | "/" | "b" | "f" | "n" | "r" | "t";
                    unicode_escaped = "u" [0-9a-fA-F]{4};
                    escaped         = escape (single_escaped | unicode_escaped);
                    char            = unescaped | escaped;
                    string          = quotation_mark char* quotation_mark;
                    string          { last_token_type = token_type::value_string; break; }

                    // end of file
                    "\x00"         { last_token_type = token_type::end_of_input; break; }

                    // anything else is an error
                    *              { last_token_type = token_type::parse_error; break; }
                */
N
Niels 已提交
10102
            }
N
Niels 已提交
10103

10104
            position += static_cast<size_t>((m_cursor - m_start));
T
Théo DELRIEU 已提交
10105
            return last_token_type;
N
Niels 已提交
10106 10107
        }

T
Théo DELRIEU 已提交
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
        /*!
        @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()));
10141

T
Théo DELRIEU 已提交
10142 10143 10144
            // 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 已提交
10145

T
Théo DELRIEU 已提交
10146 10147 10148 10149 10150
            // 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);
10151

T
Théo DELRIEU 已提交
10152 10153 10154 10155 10156 10157
            // number of processed characters (p)
            const auto num_processed_chars = static_cast<size_t>(m_start - m_content);
            // 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 已提交
10158

T
Théo DELRIEU 已提交
10159 10160 10161 10162
            // 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 已提交
10163
                // this point. We trust the standard library to do the right
T
Théo DELRIEU 已提交
10164 10165
                // thing. See http://stackoverflow.com/q/28142011/266378
                m_line_buffer.assign(m_start, m_limit);
N
Niels 已提交
10166

T
Théo DELRIEU 已提交
10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181
                // 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
            {
                // 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');
10182

T
Théo DELRIEU 已提交
10183 10184 10185 10186
                // add line with newline symbol to the line buffer
                m_line_buffer += m_line_buffer_tmp;
                m_line_buffer.push_back('\n');
            }
10187

T
Théo DELRIEU 已提交
10188 10189 10190 10191 10192 10193 10194 10195
            // 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();
        }
10196

T
Théo DELRIEU 已提交
10197 10198 10199 10200 10201 10202 10203
        /// 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));
        }
10204

T
Théo DELRIEU 已提交
10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250
        /*!
        @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 已提交
10251
        indefinitely if i is always decreased. However, observe that the value
T
Théo DELRIEU 已提交
10252 10253 10254 10255 10256 10257 10258 10259
        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
10260 10261
        @throw parse_error.102 if to_unicode fails
        @throw parse_error.103 if to_unicode fails
T
Théo DELRIEU 已提交
10262 10263 10264 10265
        */
        string_t get_string() const
        {
            assert(m_cursor - m_start >= 2);
N
Niels 已提交
10266

T
Théo DELRIEU 已提交
10267 10268
            string_t result;
            result.reserve(static_cast<size_t>(m_cursor - m_start - 2));
N
Niels 已提交
10269

T
Théo DELRIEU 已提交
10270 10271
            // iterate the result between the quotes
            for (const lexer_char_t* i = m_start + 1; i < m_cursor - 1; ++i)
N
Niels 已提交
10272
            {
T
Théo DELRIEU 已提交
10273 10274 10275
                // find next escape character
                auto e = std::find(i, m_cursor - 1, '\\');
                if (e != i)
N
Niels 已提交
10276
                {
T
Théo DELRIEU 已提交
10277 10278
                    // see https://github.com/nlohmann/json/issues/365#issuecomment-262874705
                    for (auto k = i; k < e; k++)
10279
                    {
T
Théo DELRIEU 已提交
10280
                        result.push_back(static_cast<typename string_t::value_type>(*k));
10281
                    }
T
Théo DELRIEU 已提交
10282 10283 10284 10285 10286 10287 10288
                    i = e - 1; // -1 because of ++i
                }
                else
                {
                    // processing escaped character
                    // read next character
                    ++i;
N
Niels 已提交
10289

T
Théo DELRIEU 已提交
10290
                    switch (*i)
N
Niels 已提交
10291
                    {
T
Théo DELRIEU 已提交
10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332
                        // 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 已提交
10333

T
Théo DELRIEU 已提交
10334 10335
                        // unicode
                        case 'u':
N
Niels 已提交
10336
                        {
T
Théo DELRIEU 已提交
10337 10338 10339 10340 10341 10342
                            // 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 已提交
10343
                            {
T
Théo DELRIEU 已提交
10344 10345 10346
                                // make sure there is a subsequent unicode
                                if ((i + 6 >= m_limit) or * (i + 5) != '\\' or * (i + 6) != 'u')
                                {
10347
                                    JSON_THROW(parse_error(102, get_position(), "missing low surrogate"));
T
Théo DELRIEU 已提交
10348 10349 10350 10351 10352 10353 10354 10355
                                }

                                // 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 已提交
10356
                            }
T
Théo DELRIEU 已提交
10357 10358 10359
                            else if (codepoint >= 0xDC00 and codepoint <= 0xDFFF)
                            {
                                // we found a lone low surrogate
10360
                                JSON_THROW(parse_error(102, get_position(), "missing high surrogate"));
T
Théo DELRIEU 已提交
10361 10362 10363 10364 10365 10366 10367 10368 10369
                            }
                            else
                            {
                                // add unicode character(s)
                                result += to_unicode(codepoint);
                                // skip the next four characters (xxxx)
                                i += 4;
                            }
                            break;
N
Niels 已提交
10370 10371 10372 10373
                        }
                    }
                }
            }
N
Niels 已提交
10374

T
Théo DELRIEU 已提交
10375 10376
            return result;
        }
10377

N
Niels 已提交
10378

T
Théo DELRIEU 已提交
10379
        /*!
N
Niels Lohmann 已提交
10380 10381
        @brief parse string into a built-in arithmetic type as if the current
               locale is POSIX.
10382

N
Niels Lohmann 已提交
10383 10384
        @note in floating-point case strtod may parse past the token's end -
              this is not an error
10385

N
Niels Lohmann 已提交
10386
        @note any leading blanks are not handled
T
Théo DELRIEU 已提交
10387
        */
10388
        struct strtonum
T
Théo DELRIEU 已提交
10389
        {
10390
          public:
10391
            strtonum(const char* start, const char* end)
10392 10393
                : m_start(start), m_end(end)
            {}
10394

N
Niels Lohmann 已提交
10395 10396 10397 10398 10399 10400 10401
            /*!
            @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>
10402 10403 10404 10405
            bool to(T& val) const
            {
                return parse(val, std::is_integral<T>());
            }
N
Niels 已提交
10406

10407
          private:
10408
            const char* const m_start = nullptr;
N
Niels Lohmann 已提交
10409
            const char* const m_end = nullptr;
N
Niels 已提交
10410

10411 10412
            // floating-point conversion

A
Alex Astashyn 已提交
10413 10414
            // overloaded wrappers for strtod/strtof/strtold
            // that will be called from parse<floating_point_t>
N
Niels Lohmann 已提交
10415
            static void strtof(float& f, const char* str, char** endptr)
10416
            {
10417
                f = std::strtof(str, endptr);
N
Niels 已提交
10418
            }
10419

N
Niels Lohmann 已提交
10420
            static void strtof(double& f, const char* str, char** endptr)
T
Théo DELRIEU 已提交
10421
            {
10422
                f = std::strtod(str, endptr);
T
Théo DELRIEU 已提交
10423
            }
N
Niels 已提交
10424

N
Niels Lohmann 已提交
10425
            static void strtof(long double& f, const char* str, char** endptr)
T
Théo DELRIEU 已提交
10426
            {
10427
                f = std::strtold(str, endptr);
T
Théo DELRIEU 已提交
10428
            }
10429

10430 10431
            template<typename T>
            bool parse(T& value, /*is_integral=*/std::false_type) const
10432
            {
N
Niels Lohmann 已提交
10433 10434 10435
                // 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.
10436 10437
                std::string tempstr;
                std::array<char, 64> buf;
10438 10439
                const size_t len = static_cast<size_t>(m_end - m_start);

10440 10441 10442
                // lexer will reject empty numbers
                assert(len > 0);

N
Niels Lohmann 已提交
10443 10444 10445
                // 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
10446 10447
                const auto loc = localeconv();
                assert(loc != nullptr);
N
Niels Lohmann 已提交
10448
                const char decimal_point_char = (loc->decimal_point == nullptr) ? '.' : loc->decimal_point[0];
10449 10450 10451

                const char* data = m_start;

10452
                if (decimal_point_char != '.')
T
Théo DELRIEU 已提交
10453
                {
N
Niels Lohmann 已提交
10454
                    const size_t ds_pos = static_cast<size_t>(std::find(m_start, m_end, '.') - m_start);
10455

10456
                    if (ds_pos != len)
T
Théo DELRIEU 已提交
10457
                    {
N
Niels Lohmann 已提交
10458 10459 10460 10461
                        // 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())
10462
                        {
10463
                            std::copy(m_start, m_end, buf.begin());
10464 10465 10466 10467 10468 10469 10470 10471 10472 10473
                            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 已提交
10474 10475 10476
                    }
                }

10477 10478
                char* endptr = nullptr;
                value = 0;
10479
                // this calls appropriate overload depending on T
10480
                strtof(value, data, &endptr);
T
Théo DELRIEU 已提交
10481

10482 10483 10484
                // parsing was successful iff strtof parsed exactly the number
                // of characters determined by the lexer (len)
                const bool ok = (endptr == (data + len));
10485

10486
                if (ok and (value == static_cast<T>(0.0)) and (*data == '-'))
A
Alex Astashyn 已提交
10487
                {
10488 10489
                    // some implementations forget to negate the zero
                    value = -0.0;
N
Niels 已提交
10490
                }
N
Niels 已提交
10491

10492
                return ok;
N
Niels 已提交
10493
            }
10494

10495 10496
            // integral conversion

N
Niels Lohmann 已提交
10497
            signed long long parse_integral(char** endptr, /*is_signed*/std::true_type) const
10498 10499
            {
                return std::strtoll(m_start, endptr, 10);
10500
            }
N
Niels 已提交
10501

N
Niels Lohmann 已提交
10502
            unsigned long long parse_integral(char** endptr, /*is_signed*/std::false_type) const
T
Théo DELRIEU 已提交
10503
            {
10504
                return std::strtoull(m_start, endptr, 10);
T
Théo DELRIEU 已提交
10505
            }
10506 10507 10508

            template<typename T>
            bool parse(T& value, /*is_integral=*/std::true_type) const
N
Niels 已提交
10509
            {
10510
                char* endptr = nullptr;
N
Niels Lohmann 已提交
10511
                errno = 0; // these are thread-local
10512
                const auto x = parse_integral(&endptr, std::is_signed<T>());
N
Niels Lohmann 已提交
10513

N
Niels Lohmann 已提交
10514 10515
                // called right overload?
                static_assert(std::is_signed<T>() == std::is_signed<decltype(x)>(), "");
10516 10517 10518

                value = static_cast<T>(x);

N
Niels Lohmann 已提交
10519 10520
                return (x == static_cast<decltype(x)>(value)) // x fits into destination T
                       and (x < 0) == (value < 0)             // preserved sign
10521
                       //and ((x != 0) or is_integral())        // strto[u]ll did nto fail
N
Niels Lohmann 已提交
10522 10523 10524
                       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
10525
            }
10526 10527 10528 10529 10530 10531 10532 10533
        };

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

10535 10536
        integral numbers that don't fit into the the range of the respective
        type are parsed as number_float_t
N
Niels 已提交
10537

10538 10539
        floating-point values do not satisfy std::isfinite predicate
        are converted to value_t::null
10540 10541

        throws if the entire string [m_start .. m_cursor) cannot be
10542 10543 10544
        interpreted as a number

        @param[out] result  @ref basic_json object to receive the number.
10545
        @param[in]  token   the type of the number token
10546
        */
10547
        bool get_number(basic_json& result, const token_type token) const
10548 10549 10550
        {
            assert(m_start != nullptr);
            assert(m_start < m_cursor);
N
Niels Lohmann 已提交
10551 10552
            assert((token == token_type::value_unsigned) or
                   (token == token_type::value_integer) or
10553
                   (token == token_type::value_float));
10554

N
Niels Lohmann 已提交
10555 10556
            strtonum num_converter(reinterpret_cast<const char*>(m_start),
                                   reinterpret_cast<const char*>(m_cursor));
10557

10558
            switch (token)
10559
            {
N
Niels Lohmann 已提交
10560
                case lexer::token_type::value_unsigned:
N
Niels Lohmann 已提交
10561
                {
N
Niels Lohmann 已提交
10562 10563
                    number_unsigned_t val;
                    if (num_converter.to(val))
10564
                    {
10565
                        // parsing successful
10566 10567
                        result.m_type = value_t::number_unsigned;
                        result.m_value = val;
10568
                        return true;
10569 10570
                    }
                    break;
N
Niels Lohmann 已提交
10571
                }
10572

N
Niels Lohmann 已提交
10573
                case lexer::token_type::value_integer:
T
Théo DELRIEU 已提交
10574
                {
N
Niels Lohmann 已提交
10575 10576
                    number_integer_t val;
                    if (num_converter.to(val))
10577
                    {
10578
                        // parsing successful
10579 10580
                        result.m_type = value_t::number_integer;
                        result.m_value = val;
10581
                        return true;
10582 10583 10584 10585 10586 10587 10588
                    }
                    break;
                }

                default:
                {
                    break;
T
Théo DELRIEU 已提交
10589 10590 10591
                }
            }

N
Niels Lohmann 已提交
10592 10593 10594
            // parse float (either explicitly or because a previous conversion
            // failed)
            number_float_t val;
10595
            if (num_converter.to(val))
A
Alex Astashyn 已提交
10596
            {
10597 10598 10599
                // parsing successful
                result.m_type = value_t::number_float;
                result.m_value = val;
N
Niels 已提交
10600

10601 10602 10603 10604 10605 10606
                // 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();
                }
10607

10608
                return true;
10609
            }
10610 10611 10612

            // couldn't parse number in any format
            return false;
T
Théo DELRIEU 已提交
10613 10614
        }

10615 10616 10617 10618 10619
        constexpr size_t get_position() const
        {
            return position;
        }

T
Théo DELRIEU 已提交
10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638
      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;
10639 10640
        /// current position in the input (read bytes)
        size_t position = 0;
T
Théo DELRIEU 已提交
10641
    };
N
Niels 已提交
10642

N
Niels 已提交
10643 10644
    /*!
    @brief syntax analysis
N
Niels 已提交
10645 10646

    This class implements a recursive decent parser.
N
Niels 已提交
10647
    */
N
Niels 已提交
10648 10649
    class parser
    {
T
Théo DELRIEU 已提交
10650
      public:
10651
        /// a parser reading from a string literal
N
Niels 已提交
10652
        parser(const char* buff, const parser_callback_t cb = nullptr)
T
Théo DELRIEU 已提交
10653 10654 10655
            : callback(cb),
              m_lexer(reinterpret_cast<const typename lexer::lexer_char_t*>(buff), std::strlen(buff))
        {}
10656

T
Théo DELRIEU 已提交
10657 10658 10659 10660
        /// a parser reading from an input stream
        parser(std::istream& is, const parser_callback_t cb = nullptr)
            : callback(cb), m_lexer(is)
        {}
N
Niels 已提交
10661

T
Théo DELRIEU 已提交
10662 10663 10664 10665 10666 10667 10668 10669 10670 10671
        /// 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 已提交
10672

T
Théo DELRIEU 已提交
10673 10674 10675 10676 10677
        /// public parser interface
        basic_json parse()
        {
            // read first token
            get_token();
N
Niels 已提交
10678

T
Théo DELRIEU 已提交
10679 10680
            basic_json result = parse_internal(true);
            result.assert_invariant();
N
Niels 已提交
10681

T
Théo DELRIEU 已提交
10682
            expect(lexer::token_type::end_of_input);
N
Niels 已提交
10683

T
Théo DELRIEU 已提交
10684 10685 10686 10687
            // 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 已提交
10688

T
Théo DELRIEU 已提交
10689 10690 10691
      private:
        /// the actual parser
        basic_json parse_internal(bool keep)
10692
        {
T
Théo DELRIEU 已提交
10693 10694 10695
            auto result = basic_json(value_t::discarded);

            switch (last_token)
N
Niels 已提交
10696
            {
T
Théo DELRIEU 已提交
10697
                case lexer::token_type::begin_object:
N
Niels 已提交
10698
                {
T
Théo DELRIEU 已提交
10699 10700 10701 10702 10703 10704 10705
                    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 已提交
10706

T
Théo DELRIEU 已提交
10707 10708
                    // read next token
                    get_token();
N
Niels 已提交
10709

T
Théo DELRIEU 已提交
10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 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
                    // 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 已提交
10767
                    get_token();
10768
                    if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
N
Niels 已提交
10769 10770 10771
                    {
                        result = basic_json(value_t::discarded);
                    }
T
Théo DELRIEU 已提交
10772

N
Niels 已提交
10773
                    return result;
N
Niels 已提交
10774 10775
                }

T
Théo DELRIEU 已提交
10776
                case lexer::token_type::begin_array:
10777
                {
T
Théo DELRIEU 已提交
10778 10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789 10790
                    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 已提交
10791
                    {
N
Niels 已提交
10792
                        get_token();
T
Théo DELRIEU 已提交
10793 10794 10795 10796 10797
                        if (callback and not callback(--depth, parse_event_t::array_end, result))
                        {
                            result = basic_json(value_t::discarded);
                        }
                        return result;
N
Niels 已提交
10798 10799
                    }

T
Théo DELRIEU 已提交
10800 10801
                    // no comma is expected here
                    unexpect(lexer::token_type::value_separator);
N
Niels 已提交
10802

T
Théo DELRIEU 已提交
10803 10804
                    // otherwise: parse values
                    do
N
Niels 已提交
10805
                    {
T
Théo DELRIEU 已提交
10806 10807
                        // ugly, but could be fixed with loop reorganization
                        if (last_token == lexer::token_type::value_separator)
N
Niels 已提交
10808
                        {
T
Théo DELRIEU 已提交
10809
                            get_token();
N
Niels 已提交
10810
                        }
T
Théo DELRIEU 已提交
10811 10812 10813 10814

                        // parse value
                        auto value = parse_internal(keep);
                        if (keep and not value.is_discarded())
N
Niels 已提交
10815
                        {
T
Théo DELRIEU 已提交
10816
                            result.push_back(std::move(value));
N
Niels 已提交
10817
                        }
N
Niels 已提交
10818
                    }
T
Théo DELRIEU 已提交
10819
                    while (last_token == lexer::token_type::value_separator);
N
Niels 已提交
10820

T
Théo DELRIEU 已提交
10821 10822
                    // closing ]
                    expect(lexer::token_type::end_array);
N
Niels 已提交
10823
                    get_token();
T
Théo DELRIEU 已提交
10824
                    if (keep and callback and not callback(--depth, parse_event_t::array_end, result))
N
Niels 已提交
10825
                    {
T
Théo DELRIEU 已提交
10826
                        result = basic_json(value_t::discarded);
N
Niels 已提交
10827
                    }
T
Théo DELRIEU 已提交
10828 10829

                    return result;
N
Niels 已提交
10830 10831
                }

T
Théo DELRIEU 已提交
10832
                case lexer::token_type::literal_null:
N
Niels 已提交
10833
                {
T
Théo DELRIEU 已提交
10834 10835 10836
                    get_token();
                    result.m_type = value_t::null;
                    break;
N
Niels 已提交
10837 10838
                }

T
Théo DELRIEU 已提交
10839
                case lexer::token_type::value_string:
N
Niels 已提交
10840
                {
T
Théo DELRIEU 已提交
10841 10842 10843 10844
                    const auto s = m_lexer.get_string();
                    get_token();
                    result = basic_json(s);
                    break;
N
Niels 已提交
10845 10846
                }

T
Théo DELRIEU 已提交
10847
                case lexer::token_type::literal_true:
N
Niels 已提交
10848
                {
N
Niels 已提交
10849
                    get_token();
T
Théo DELRIEU 已提交
10850 10851 10852
                    result.m_type = value_t::boolean;
                    result.m_value = true;
                    break;
N
Niels 已提交
10853 10854
                }

T
Théo DELRIEU 已提交
10855
                case lexer::token_type::literal_false:
N
Niels 已提交
10856
                {
T
Théo DELRIEU 已提交
10857 10858 10859 10860
                    get_token();
                    result.m_type = value_t::boolean;
                    result.m_value = false;
                    break;
N
Niels 已提交
10861 10862
                }

N
Niels Lohmann 已提交
10863 10864
                case lexer::token_type::value_unsigned:
                case lexer::token_type::value_integer:
10865
                case lexer::token_type::value_float:
N
Niels 已提交
10866
                {
N
Niels Lohmann 已提交
10867
                    m_lexer.get_number(result, last_token);
T
Théo DELRIEU 已提交
10868 10869
                    get_token();
                    break;
N
Niels 已提交
10870
                }
10871

T
Théo DELRIEU 已提交
10872 10873 10874 10875 10876
                default:
                {
                    // the last token was unexpected
                    unexpect(last_token);
                }
10877 10878
            }

T
Théo DELRIEU 已提交
10879
            if (keep and callback and not callback(depth, parse_event_t::value, result))
10880
            {
T
Théo DELRIEU 已提交
10881
                result = basic_json(value_t::discarded);
N
Niels 已提交
10882
            }
T
Théo DELRIEU 已提交
10883
            return result;
N
Niels 已提交
10884 10885
        }

T
Théo DELRIEU 已提交
10886 10887
        /// get next token from lexer
        typename lexer::token_type get_token()
N
Niels 已提交
10888
        {
T
Théo DELRIEU 已提交
10889 10890
            last_token = m_lexer.scan();
            return last_token;
N
Niels 已提交
10891 10892
        }

T
Théo DELRIEU 已提交
10893
        void expect(typename lexer::token_type t) const
N
Niels 已提交
10894
        {
T
Théo DELRIEU 已提交
10895 10896 10897 10898 10899 10900 10901
            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);
10902
                JSON_THROW(parse_error(101, m_lexer.get_position(), error_msg));
T
Théo DELRIEU 已提交
10903
            }
N
Niels 已提交
10904 10905
        }

T
Théo DELRIEU 已提交
10906
        void unexpect(typename lexer::token_type t) const
N
Niels 已提交
10907
        {
T
Théo DELRIEU 已提交
10908 10909 10910 10911 10912 10913
            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));
10914
                JSON_THROW(parse_error(101, m_lexer.get_position(), error_msg));
T
Théo DELRIEU 已提交
10915
            }
N
Niels 已提交
10916 10917
        }

T
Théo DELRIEU 已提交
10918 10919 10920 10921 10922 10923 10924 10925 10926 10927
      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 已提交
10928 10929

  public:
N
Niels 已提交
10930 10931 10932
    /*!
    @brief JSON Pointer

N
Niels 已提交
10933 10934 10935 10936
    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 已提交
10937
    @sa [RFC 6901](https://tools.ietf.org/html/rfc6901)
N
Niels 已提交
10938 10939

    @since version 2.0.0
N
Niels 已提交
10940
    */
N
Niels 已提交
10941 10942
    class json_pointer
    {
N
Niels 已提交
10943 10944 10945
        /// allow basic_json to access private members
        friend class basic_json;

T
Théo DELRIEU 已提交
10946
      public:
N
Niels 已提交
10947 10948 10949 10950 10951 10952 10953 10954 10955 10956
        /*!
        @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

10957
        @throw parse_error.107 if reference token is nonempty and does not
N
Niels 已提交
10958
        begin with a slash (`/`); example: `"JSON pointer must be empty or
10959 10960 10961 10962
        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 已提交
10963 10964 10965

        @liveexample{The example shows the construction several valid JSON
        pointers as well as the exceptional behavior.,json_pointer}
N
Niels 已提交
10966

N
Niels 已提交
10967 10968 10969
        @since version 2.0.0
        */
        explicit json_pointer(const std::string& s = "")
T
Théo DELRIEU 已提交
10970 10971
            : reference_tokens(split(s))
        {}
N
Niels 已提交
10972

T
Théo DELRIEU 已提交
10973 10974
        /*!
        @brief return a string representation of the JSON pointer
N
Niels 已提交
10975

T
Théo DELRIEU 已提交
10976 10977 10978 10979
        @invariant For each JSON pointer `ptr`, it holds:
        @code {.cpp}
        ptr == json_pointer(ptr.to_string());
        @endcode
N
Niels 已提交
10980

T
Théo DELRIEU 已提交
10981
        @return a string representation of the JSON pointer
N
Niels 已提交
10982

T
Théo DELRIEU 已提交
10983 10984
        @liveexample{The example shows the result of `to_string`.,
        json_pointer__to_string}
N
Niels 已提交
10985

T
Théo DELRIEU 已提交
10986 10987 10988
        @since version 2.0.0
        */
        std::string to_string() const noexcept
N
Niels 已提交
10989
        {
T
Théo DELRIEU 已提交
10990 10991 10992 10993 10994 10995 10996
            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 已提交
10997

T
Théo DELRIEU 已提交
10998 10999
        /// @copydoc to_string()
        operator std::string() const
N
Niels 已提交
11000
        {
T
Théo DELRIEU 已提交
11001
            return to_string();
N
Niels 已提交
11002 11003
        }

T
Théo DELRIEU 已提交
11004 11005 11006 11007 11008 11009 11010 11011
      private:
        /// remove and return last reference pointer
        std::string pop_back()
        {
            if (is_root())
            {
                JSON_THROW(std::domain_error("JSON pointer has no parent"));
            }
11012

T
Théo DELRIEU 已提交
11013 11014 11015 11016
            auto last = reference_tokens.back();
            reference_tokens.pop_back();
            return last;
        }
N
Niels 已提交
11017

T
Théo DELRIEU 已提交
11018 11019
        /// return whether pointer points to the root document
        bool is_root() const
N
Niels 已提交
11020
        {
T
Théo DELRIEU 已提交
11021
            return reference_tokens.empty();
N
Niels 已提交
11022 11023
        }

T
Théo DELRIEU 已提交
11024 11025 11026 11027 11028 11029
        json_pointer top() const
        {
            if (is_root())
            {
                JSON_THROW(std::domain_error("JSON pointer has no parent"));
            }
N
Niels 已提交
11030

T
Théo DELRIEU 已提交
11031 11032 11033 11034
            json_pointer result = *this;
            result.reference_tokens = {reference_tokens[0]};
            return result;
        }
N
Niels 已提交
11035

T
Théo DELRIEU 已提交
11036 11037
        /*!
        @brief create and return a reference to the pointed to value
11038

T
Théo DELRIEU 已提交
11039 11040 11041
        @complexity Linear in the number of reference tokens.
        */
        reference get_and_create(reference j) const
11042
        {
T
Théo DELRIEU 已提交
11043 11044 11045 11046 11047
            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 已提交
11048
            {
T
Théo DELRIEU 已提交
11049
                switch (result->m_type)
N
Niels 已提交
11050
                {
T
Théo DELRIEU 已提交
11051
                    case value_t::null:
N
Niels 已提交
11052
                    {
T
Théo DELRIEU 已提交
11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063
                        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 已提交
11064
                    }
T
Théo DELRIEU 已提交
11065 11066

                    case value_t::object:
N
Niels 已提交
11067
                    {
T
Théo DELRIEU 已提交
11068
                        // create an entry in the object
N
Niels 已提交
11069
                        result = &result->operator[](reference_token);
T
Théo DELRIEU 已提交
11070
                        break;
N
Niels 已提交
11071
                    }
N
Niels 已提交
11072

T
Théo DELRIEU 已提交
11073 11074 11075
                    case value_t::array:
                    {
                        // create an entry in the array
11076 11077 11078 11079 11080 11081 11082 11083
                        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 已提交
11084 11085
                        break;
                    }
11086

T
Théo DELRIEU 已提交
11087 11088 11089 11090 11091 11092 11093 11094 11095
                    /*
                    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:
                    {
11096
                        JSON_THROW(std::domain_error("invalid value to unflatten"));
T
Théo DELRIEU 已提交
11097
                    }
N
Niels 已提交
11098 11099
                }
            }
11100

T
Théo DELRIEU 已提交
11101 11102
            return *result;
        }
11103

T
Théo DELRIEU 已提交
11104 11105
        /*!
        @brief return a reference to the pointed to value
11106

T
Théo DELRIEU 已提交
11107 11108 11109 11110 11111
        @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.
11112

T
Théo DELRIEU 已提交
11113
        @param[in] ptr  a JSON value
N
Niels 已提交
11114

T
Théo DELRIEU 已提交
11115
        @return reference to the JSON value pointed to by the JSON pointer
N
Niels 已提交
11116

T
Théo DELRIEU 已提交
11117
        @complexity Linear in the length of the JSON pointer.
N
Niels 已提交
11118

T
Théo DELRIEU 已提交
11119
        @throw std::out_of_range      if the JSON pointer can not be resolved
11120
        @throw parse_error.106        if an array index begins with '0'
T
Théo DELRIEU 已提交
11121 11122 11123
        @throw std::invalid_argument  if an array index was not a number
        */
        reference get_unchecked(pointer ptr) const
11124
        {
T
Théo DELRIEU 已提交
11125
            for (const auto& reference_token : reference_tokens)
11126
            {
T
Théo DELRIEU 已提交
11127 11128
                // convert null values to arrays or objects before continuing
                if (ptr->m_type == value_t::null)
N
Niels 已提交
11129
                {
T
Théo DELRIEU 已提交
11130 11131 11132 11133
                    // check if reference token is a number
                    const bool nums = std::all_of(reference_token.begin(),
                                                  reference_token.end(),
                                                  [](const char x)
N
Niels 已提交
11134
                    {
T
Théo DELRIEU 已提交
11135 11136
                        return std::isdigit(x);
                    });
N
Niels 已提交
11137

T
Théo DELRIEU 已提交
11138 11139 11140
                    // change value to array for numbers or "-" or to object
                    // otherwise
                    if (nums or reference_token == "-")
N
Niels 已提交
11141
                    {
T
Théo DELRIEU 已提交
11142
                        *ptr = value_t::array;
N
Niels 已提交
11143 11144 11145
                    }
                    else
                    {
T
Théo DELRIEU 已提交
11146
                        *ptr = value_t::object;
N
Niels 已提交
11147
                    }
N
Niels 已提交
11148 11149
                }

T
Théo DELRIEU 已提交
11150
                switch (ptr->m_type)
N
Niels 已提交
11151
                {
T
Théo DELRIEU 已提交
11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163
                    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')
                        {
11164
                            JSON_THROW(parse_error(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
11165 11166 11167 11168
                        }

                        if (reference_token == "-")
                        {
N
Niels Lohmann 已提交
11169
                            // explicitly treat "-" as index beyond the end
T
Théo DELRIEU 已提交
11170 11171 11172 11173 11174
                            ptr = &ptr->operator[](ptr->m_value.array->size());
                        }
                        else
                        {
                            // convert array index to number; unchecked access
11175 11176 11177 11178 11179 11180 11181 11182
                            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 已提交
11183 11184 11185 11186 11187 11188
                        }
                        break;
                    }

                    default:
                    {
11189
                        JSON_THROW(std::out_of_range("unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
11190
                    }
N
Niels 已提交
11191 11192
                }
            }
N
Niels 已提交
11193

T
Théo DELRIEU 已提交
11194 11195
            return *ptr;
        }
11196

T
Théo DELRIEU 已提交
11197
        reference get_checked(pointer ptr) const
N
Niels 已提交
11198
        {
T
Théo DELRIEU 已提交
11199
            for (const auto& reference_token : reference_tokens)
N
Niels 已提交
11200
            {
T
Théo DELRIEU 已提交
11201
                switch (ptr->m_type)
11202
                {
T
Théo DELRIEU 已提交
11203
                    case value_t::object:
N
Niels 已提交
11204
                    {
T
Théo DELRIEU 已提交
11205 11206 11207
                        // note: at performs range check
                        ptr = &ptr->at(reference_token);
                        break;
N
Niels 已提交
11208 11209
                    }

T
Théo DELRIEU 已提交
11210
                    case value_t::array:
N
Niels 已提交
11211
                    {
T
Théo DELRIEU 已提交
11212 11213 11214
                        if (reference_token == "-")
                        {
                            // "-" always fails the range check
11215 11216 11217
                            JSON_THROW(std::out_of_range("array index '-' (" +
                                                         std::to_string(ptr->m_value.array->size()) +
                                                         ") is out of range"));
T
Théo DELRIEU 已提交
11218 11219 11220 11221 11222
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
11223
                            JSON_THROW(parse_error(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
11224
                        }
N
Niels 已提交
11225

T
Théo DELRIEU 已提交
11226
                        // note: at performs range check
11227 11228 11229 11230 11231 11232 11233 11234
                        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 已提交
11235 11236
                        break;
                    }
11237

T
Théo DELRIEU 已提交
11238 11239
                    default:
                    {
11240
                        JSON_THROW(std::out_of_range("unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
11241
                    }
N
Niels 已提交
11242 11243 11244
                }
            }

T
Théo DELRIEU 已提交
11245 11246
            return *ptr;
        }
11247

T
Théo DELRIEU 已提交
11248 11249
        /*!
        @brief return a const reference to the pointed to value
N
Niels 已提交
11250

T
Théo DELRIEU 已提交
11251
        @param[in] ptr  a JSON value
N
Niels 已提交
11252

T
Théo DELRIEU 已提交
11253 11254 11255 11256
        @return const reference to the JSON value pointed to by the JSON
                pointer
        */
        const_reference get_unchecked(const_pointer ptr) const
N
Niels 已提交
11257
        {
T
Théo DELRIEU 已提交
11258
            for (const auto& reference_token : reference_tokens)
N
Niels 已提交
11259
            {
T
Théo DELRIEU 已提交
11260
                switch (ptr->m_type)
11261
                {
T
Théo DELRIEU 已提交
11262
                    case value_t::object:
N
Niels 已提交
11263
                    {
T
Théo DELRIEU 已提交
11264 11265 11266
                        // use unchecked object access
                        ptr = &ptr->operator[](reference_token);
                        break;
N
Niels 已提交
11267 11268
                    }

T
Théo DELRIEU 已提交
11269
                    case value_t::array:
N
Niels 已提交
11270
                    {
T
Théo DELRIEU 已提交
11271 11272 11273
                        if (reference_token == "-")
                        {
                            // "-" cannot be used for const access
11274 11275 11276
                            JSON_THROW(std::out_of_range("array index '-' (" +
                                                         std::to_string(ptr->m_value.array->size()) +
                                                         ") is out of range"));
T
Théo DELRIEU 已提交
11277 11278 11279 11280 11281
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
11282
                            JSON_THROW(parse_error(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
11283
                        }
N
Niels 已提交
11284

T
Théo DELRIEU 已提交
11285
                        // use unchecked array access
11286 11287 11288 11289 11290 11291 11292 11293
                        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 已提交
11294 11295
                        break;
                    }
11296

T
Théo DELRIEU 已提交
11297 11298
                    default:
                    {
11299
                        JSON_THROW(std::out_of_range("unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
11300
                    }
N
Niels 已提交
11301 11302 11303
                }
            }

T
Théo DELRIEU 已提交
11304 11305
            return *ptr;
        }
11306

T
Théo DELRIEU 已提交
11307
        const_reference get_checked(const_pointer ptr) const
11308
        {
T
Théo DELRIEU 已提交
11309
            for (const auto& reference_token : reference_tokens)
11310
            {
T
Théo DELRIEU 已提交
11311
                switch (ptr->m_type)
11312
                {
T
Théo DELRIEU 已提交
11313
                    case value_t::object:
N
Niels 已提交
11314
                    {
T
Théo DELRIEU 已提交
11315 11316 11317
                        // note: at performs range check
                        ptr = &ptr->at(reference_token);
                        break;
N
Niels 已提交
11318
                    }
11319

T
Théo DELRIEU 已提交
11320
                    case value_t::array:
N
Niels 已提交
11321
                    {
T
Théo DELRIEU 已提交
11322 11323 11324
                        if (reference_token == "-")
                        {
                            // "-" always fails the range check
11325 11326 11327
                            JSON_THROW(std::out_of_range("array index '-' (" +
                                                         std::to_string(ptr->m_value.array->size()) +
                                                         ") is out of range"));
T
Théo DELRIEU 已提交
11328 11329 11330 11331 11332
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
11333
                            JSON_THROW(parse_error(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
11334
                        }
11335

T
Théo DELRIEU 已提交
11336
                        // note: at performs range check
11337 11338 11339 11340 11341 11342 11343 11344
                        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 已提交
11345 11346
                        break;
                    }
11347

T
Théo DELRIEU 已提交
11348 11349
                    default:
                    {
11350
                        JSON_THROW(std::out_of_range("unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
11351
                    }
11352 11353
                }
            }
N
Niels 已提交
11354

T
Théo DELRIEU 已提交
11355
            return *ptr;
11356 11357
        }

T
Théo DELRIEU 已提交
11358 11359
        /// split the string input to reference tokens
        static std::vector<std::string> split(const std::string& reference_string)
11360
        {
T
Théo DELRIEU 已提交
11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371
            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] != '/')
            {
11372
                JSON_THROW(parse_error(107, 1, "JSON pointer must be empty or begin with '/' - was: '" + reference_string + "'"));
T
Théo DELRIEU 已提交
11373
            }
N
Niels 已提交
11374

T
Théo DELRIEU 已提交
11375 11376 11377 11378 11379
            // 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 已提交
11380
                size_t slash = reference_string.find_first_of('/', 1),
T
Théo DELRIEU 已提交
11381 11382 11383 11384 11385 11386 11387 11388
                // 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 已提交
11389
                slash = reference_string.find_first_of('/', start))
T
Théo DELRIEU 已提交
11390 11391 11392 11393
            {
                // 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 已提交
11394

T
Théo DELRIEU 已提交
11395
                // check reference tokens are properly escaped
N
Niels Lohmann 已提交
11396
                for (size_t pos = reference_token.find_first_of('~');
T
Théo DELRIEU 已提交
11397
                        pos != std::string::npos;
N
Niels Lohmann 已提交
11398
                        pos = reference_token.find_first_of('~', pos + 1))
11399
                {
T
Théo DELRIEU 已提交
11400 11401 11402 11403 11404 11405 11406
                    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'))
                    {
11407
                        JSON_THROW(parse_error(108, 0, "escape character '~' must be followed with '0' or '1'"));
T
Théo DELRIEU 已提交
11408
                    }
N
Niels 已提交
11409
                }
T
Théo DELRIEU 已提交
11410 11411 11412 11413

                // finally, store the reference token
                unescape(reference_token);
                result.push_back(reference_token);
11414
            }
N
Niels 已提交
11415

T
Théo DELRIEU 已提交
11416
            return result;
N
Niels 已提交
11417
        }
N
Niels 已提交
11418

T
Théo DELRIEU 已提交
11419 11420 11421
      private:
        /*!
        @brief replace all occurrences of a substring by another string
N
Niels 已提交
11422

T
Théo DELRIEU 已提交
11423 11424 11425 11426
        @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 已提交
11427

T
Théo DELRIEU 已提交
11428
        @pre The search string @a f must not be empty.
N
Niels 已提交
11429

T
Théo DELRIEU 已提交
11430 11431 11432 11433 11434 11435 11436
        @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 已提交
11437

T
Théo DELRIEU 已提交
11438 11439 11440 11441 11442 11443 11444
            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 已提交
11445

T
Théo DELRIEU 已提交
11446 11447 11448 11449 11450 11451 11452 11453
        /// 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 已提交
11454

T
Théo DELRIEU 已提交
11455 11456 11457 11458 11459 11460 11461 11462
        /// 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 已提交
11463

T
Théo DELRIEU 已提交
11464 11465 11466 11467
        /*!
        @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
11468

T
Théo DELRIEU 已提交
11469 11470 11471 11472 11473
        @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 已提交
11474
        {
T
Théo DELRIEU 已提交
11475
            switch (value.m_type)
N
Niels 已提交
11476
            {
T
Théo DELRIEU 已提交
11477
                case value_t::array:
11478
                {
T
Théo DELRIEU 已提交
11479 11480 11481 11482 11483 11484
                    if (value.m_value.array->empty())
                    {
                        // flatten empty array as null
                        result[reference_string] = nullptr;
                    }
                    else
N
Niels 已提交
11485
                    {
T
Théo DELRIEU 已提交
11486 11487 11488 11489 11490 11491
                        // 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 已提交
11492
                    }
T
Théo DELRIEU 已提交
11493
                    break;
N
Niels 已提交
11494 11495
                }

T
Théo DELRIEU 已提交
11496
                case value_t::object:
11497
                {
T
Théo DELRIEU 已提交
11498 11499 11500 11501 11502 11503
                    if (value.m_value.object->empty())
                    {
                        // flatten empty object as null
                        result[reference_string] = nullptr;
                    }
                    else
N
Niels 已提交
11504
                    {
T
Théo DELRIEU 已提交
11505 11506 11507 11508 11509 11510
                        // 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 已提交
11511
                    }
T
Théo DELRIEU 已提交
11512
                    break;
N
Niels 已提交
11513 11514
                }

T
Théo DELRIEU 已提交
11515 11516 11517 11518 11519 11520
                default:
                {
                    // add primitive value with its reference string
                    result[reference_string] = value;
                    break;
                }
N
Niels 已提交
11521 11522
            }
        }
N
Niels 已提交
11523

T
Théo DELRIEU 已提交
11524 11525
        /*!
        @param[in] value  flattened JSON
N
Niels 已提交
11526

T
Théo DELRIEU 已提交
11527 11528 11529
        @return unflattened JSON
        */
        static basic_json unflatten(const basic_json& value)
N
Niels 已提交
11530
        {
T
Théo DELRIEU 已提交
11531 11532
            if (not value.is_object())
            {
11533
                JSON_THROW(std::domain_error("only objects can be unflattened"));
T
Théo DELRIEU 已提交
11534
            }
N
Niels 已提交
11535

T
Théo DELRIEU 已提交
11536
            basic_json result;
N
Niels 已提交
11537

T
Théo DELRIEU 已提交
11538 11539
            // iterate the JSON object values
            for (const auto& element : *value.m_value.object)
N
Niels 已提交
11540
            {
T
Théo DELRIEU 已提交
11541 11542
                if (not element.second.is_primitive())
                {
11543
                    JSON_THROW(std::domain_error("values in object must be primitive"));
T
Théo DELRIEU 已提交
11544 11545 11546 11547 11548 11549 11550 11551
                }

                // 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 已提交
11552 11553
            }

T
Théo DELRIEU 已提交
11554
            return result;
N
Niels 已提交
11555
        }
N
Niels 已提交
11556

T
Théo DELRIEU 已提交
11557 11558 11559 11560 11561 11562
      private:
        friend bool operator==(json_pointer const& lhs,
                               json_pointer const& rhs) noexcept
        {
            return lhs.reference_tokens == rhs.reference_tokens;
        }
11563

T
Théo DELRIEU 已提交
11564 11565 11566 11567 11568
        friend bool operator!=(json_pointer const& lhs,
                               json_pointer const& rhs) noexcept
        {
            return !(lhs == rhs);
        }
11569

T
Théo DELRIEU 已提交
11570 11571
        /// the reference tokens
        std::vector<std::string> reference_tokens {};
11572
    };
N
Niels 已提交
11573

N
Niels 已提交
11574 11575 11576
    //////////////////////////
    // JSON Pointer support //
    //////////////////////////
N
Niels 已提交
11577 11578 11579 11580

    /// @name JSON Pointer functions
    /// @{

N
Niels 已提交
11581 11582 11583 11584
    /*!
    @brief access specified element via JSON Pointer

    Uses a JSON pointer to retrieve a reference to the respective JSON value.
N
Niels 已提交
11585 11586 11587
    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 已提交
11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672 11673

    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 已提交
11674 11675
    Returns a const reference to the element at with specified JSON pointer @a
    ptr, with bounds checking.
N
Niels 已提交
11676 11677 11678 11679 11680 11681 11682 11683 11684 11685 11686 11687 11688 11689 11690 11691 11692 11693 11694 11695

    @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 已提交
11696
    /*!
N
Niels 已提交
11697 11698
    @brief return flattened JSON value

N
Niels 已提交
11699 11700 11701 11702
    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 已提交
11703

N
Niels Lohmann 已提交
11704
    @return an object that maps JSON pointers to primitive values
N
Niels 已提交
11705

N
Niels 已提交
11706 11707
    @note Empty objects and arrays are flattened to `null` and will not be
          reconstructed correctly by the @ref unflatten() function.
N
Niels 已提交
11708 11709 11710 11711 11712 11713 11714 11715 11716

    @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 已提交
11717 11718 11719 11720 11721 11722 11723
    */
    basic_json flatten() const
    {
        basic_json result(value_t::object);
        json_pointer::flatten("", *this, result);
        return result;
    }
N
Niels 已提交
11724 11725

    /*!
N
Niels 已提交
11726 11727 11728 11729 11730 11731 11732 11733 11734 11735
    @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 已提交
11736
    @return the original JSON from a flattened version
N
Niels 已提交
11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750

    @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 已提交
11751
    */
N
Niels 已提交
11752
    basic_json unflatten() const
N
Niels 已提交
11753
    {
N
Niels 已提交
11754
        return json_pointer::unflatten(*this);
N
Niels 已提交
11755
    }
N
Niels 已提交
11756 11757

    /// @}
11758

N
Niels 已提交
11759 11760 11761 11762 11763 11764 11765
    //////////////////////////
    // JSON Patch functions //
    //////////////////////////

    /// @name JSON Patch functions
    /// @{

11766 11767 11768
    /*!
    @brief applies a JSON patch

N
Niels 已提交
11769 11770
    [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 已提交
11771
    this function, a JSON Patch is applied to the current JSON value by
N
Niels 已提交
11772 11773
    executing all operations from the patch.

N
Niels 已提交
11774
    @param[in] json_patch  JSON patch document
11775 11776
    @return patched document

N
Niels 已提交
11777 11778 11779 11780 11781 11782 11783 11784 11785 11786
    @note The application of a patch is atomic: Either all operations succeed
          and the patched document is returned or an exception is thrown. In
          any case, the original value is not changed: the patch is applied
          to a copy of the value.

    @throw std::out_of_range if a JSON pointer inside the patch could not
    be resolved successfully in the current JSON value; example: `"key baz
    not found"`
    @throw invalid_argument if the JSON patch is malformed (e.g., mandatory
    attributes are missing); example: `"operation add must have member path"`
11787 11788
    @throw parse_error.104 if the JSON patch does not consist of an array of
    objects
11789

N
Niels 已提交
11790 11791 11792 11793 11794 11795 11796 11797 11798 11799 11800 11801 11802
    @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.

    @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
11803
    */
N
Niels 已提交
11804
    basic_json patch(const basic_json& json_patch) const
11805
    {
N
Niels 已提交
11806
        // make a working copy to apply the patch to
11807 11808
        basic_json result = *this;

N
Niels 已提交
11809 11810 11811
        // the valid JSON Patch operations
        enum class patch_operations {add, remove, replace, move, copy, test, invalid};

N
Niels Lohmann 已提交
11812
        const auto get_op = [](const std::string & op)
N
Niels 已提交
11813 11814 11815 11816 11817 11818 11819 11820 11821 11822 11823 11824 11825 11826 11827 11828 11829 11830 11831 11832 11833 11834 11835 11836 11837 11838 11839 11840 11841
        {
            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 已提交
11842
        // wrapper for "add" operation; add value at ptr
N
Niels 已提交
11843
        const auto operation_add = [&result](json_pointer & ptr, basic_json val)
N
Niels 已提交
11844
        {
N
Niels 已提交
11845 11846
            // adding to the root of the target document means replacing it
            if (ptr.is_root())
N
Niels 已提交
11847
            {
N
Niels 已提交
11848
                result = val;
N
Niels 已提交
11849
            }
N
Niels 已提交
11850
            else
N
Niels 已提交
11851
            {
N
Niels 已提交
11852 11853 11854
                // make sure the top element of the pointer exists
                json_pointer top_pointer = ptr.top();
                if (top_pointer != ptr)
N
Niels 已提交
11855
                {
N
Niels 已提交
11856
                    result.at(top_pointer);
N
Niels 已提交
11857
                }
N
Niels 已提交
11858 11859 11860 11861 11862 11863

                // 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 已提交
11864
                {
N
Niels 已提交
11865 11866 11867 11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884 11885
                    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
11886
                                JSON_THROW(std::out_of_range("array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898
                            }
                            else
                            {
                                // default case: insert add offset
                                parent.insert(parent.begin() + static_cast<difference_type>(idx), val);
                            }
                        }
                        break;
                    }

                    default:
                    {
N
Niels 已提交
11899 11900
                        // if there exists a parent it cannot be primitive
                        assert(false);  // LCOV_EXCL_LINE
N
Niels 已提交
11901
                    }
N
Niels 已提交
11902 11903 11904 11905
                }
            }
        };

N
Niels 已提交
11906
        // wrapper for "remove" operation; remove value at ptr
N
Niels 已提交
11907 11908
        const auto operation_remove = [&result](json_pointer & ptr)
        {
N
Niels 已提交
11909
            // get reference to parent of JSON pointer ptr
N
Niels 已提交
11910 11911
            const auto last_path = ptr.pop_back();
            basic_json& parent = result.at(ptr);
N
Niels 已提交
11912 11913

            // remove child
N
Niels 已提交
11914 11915
            if (parent.is_object())
            {
N
Niels 已提交
11916 11917 11918 11919 11920 11921 11922 11923
                // perform range check
                auto it = parent.find(last_path);
                if (it != parent.end())
                {
                    parent.erase(it);
                }
                else
                {
11924
                    JSON_THROW(std::out_of_range("key '" + last_path + "' not found"));
N
Niels 已提交
11925
                }
N
Niels 已提交
11926 11927 11928
            }
            else if (parent.is_array())
            {
N
Niels 已提交
11929 11930
                // note erase performs range check
                parent.erase(static_cast<size_type>(std::stoi(last_path)));
N
Niels 已提交
11931 11932 11933
            }
        };

11934
        // type check: top level value must be an array
N
Niels 已提交
11935
        if (not json_patch.is_array())
N
Niels 已提交
11936
        {
11937
            JSON_THROW(parse_error(104, 0, "JSON patch must be an array of objects"));
N
Niels 已提交
11938 11939
        }

N
Niels Lohmann 已提交
11940
        // iterate and apply the operations
N
Niels 已提交
11941
        for (const auto& val : json_patch)
11942
        {
N
Niels 已提交
11943 11944 11945
            // wrapper to get a value for an operation
            const auto get_value = [&val](const std::string & op,
                                          const std::string & member,
N
Niels 已提交
11946
                                          bool string_type) -> basic_json&
11947
            {
N
Niels 已提交
11948 11949
                // find value
                auto it = val.m_value.object->find(member);
11950

N
Niels 已提交
11951 11952
                // context-sensitive error message
                const auto error_msg = (op == "op") ? "operation" : "operation '" + op + "'";
11953

N
Niels 已提交
11954 11955 11956
                // check if desired value is present
                if (it == val.m_value.object->end())
                {
11957
                    JSON_THROW(parse_error(105, 0, error_msg + " must have member '" + member + "'"));
N
Niels 已提交
11958
                }
11959

N
Niels 已提交
11960 11961 11962
                // check if result is of type string
                if (string_type and not it->second.is_string())
                {
11963
                    JSON_THROW(parse_error(105, 0, error_msg + " must have string member '" + member + "'"));
N
Niels 已提交
11964 11965 11966 11967 11968 11969
                }

                // no error: return value
                return it->second;
            };

11970
            // type check: every element of the array must be an object
N
Niels 已提交
11971
            if (not val.is_object())
11972
            {
11973
                JSON_THROW(parse_error(104, 0, "JSON patch must be an array of objects"));
11974 11975
            }

N
Niels 已提交
11976 11977 11978
            // collect mandatory members
            const std::string op = get_value("op", "op", true);
            const std::string path = get_value(op, "path", true);
N
oops  
Niels 已提交
11979
            json_pointer ptr(path);
11980

N
Niels 已提交
11981
            switch (get_op(op))
11982
            {
N
Niels 已提交
11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031
                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;
12032
                    JSON_TRY
N
Niels 已提交
12033 12034 12035 12036 12037
                    {
                        // check if "value" matches the one at "path"
                        // the "path" location must exist - use at()
                        success = (result.at(ptr) == get_value("test", "value", false));
                    }
12038
                    JSON_CATCH (std::out_of_range&)
N
Niels 已提交
12039 12040 12041 12042 12043 12044 12045
                    {
                        // ignore out of range errors: success remains false
                    }

                    // throw an exception if test fails
                    if (not success)
                    {
12046
                        JSON_THROW(std::domain_error("unsuccessful: " + val.dump()));
N
Niels 已提交
12047 12048 12049 12050 12051 12052 12053 12054 12055
                    }

                    break;
                }

                case patch_operations::invalid:
                {
                    // op must be "add", "remove", "replace", "move", "copy", or
                    // "test"
12056
                    JSON_THROW(parse_error(105, 0, "operation value '" + op + "' is invalid"));
N
Niels 已提交
12057
                }
12058
            }
N
Niels 已提交
12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078
        }

        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 已提交
12079 12080
    @param[in] source  JSON value to compare from
    @param[in] target  JSON value to compare against
N
Niels 已提交
12081 12082 12083 12084 12085 12086 12087 12088 12089 12090 12091 12092 12093 12094 12095 12096 12097
    @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,
12098
                           const std::string& path = "")
N
Niels 已提交
12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112
    {
        // 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(
12113
            {
N
Niels 已提交
12114 12115 12116 12117 12118 12119 12120 12121
                {"op", "replace"},
                {"path", path},
                {"value", target}
            });
        }
        else
        {
            switch (source.type())
12122
            {
N
Niels 已提交
12123 12124 12125 12126 12127 12128 12129 12130 12131 12132 12133
                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 已提交
12134

N
Niels 已提交
12135 12136
                    // i now reached the end of at least one array
                    // in a second pass, traverse the remaining elements
N
Niels 已提交
12137

N
Niels 已提交
12138
                    // remove my remaining elements
N
Niels 已提交
12139
                    const auto end_index = static_cast<difference_type>(result.size());
N
Niels 已提交
12140 12141
                    while (i < source.size())
                    {
N
Niels 已提交
12142 12143
                        // add operations in reverse order to avoid invalid
                        // indices
N
Niels 已提交
12144
                        result.insert(result.begin() + end_index, object(
N
Niels 已提交
12145 12146 12147 12148 12149 12150 12151 12152 12153 12154 12155 12156 12157 12158 12159 12160 12161 12162 12163 12164 12165 12166 12167
                        {
                            {"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:
12168
                {
N
Niels 已提交
12169 12170 12171 12172 12173 12174 12175 12176 12177 12178 12179 12180 12181 12182 12183 12184 12185 12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214 12215 12216 12217 12218 12219 12220
                    // 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;
12221 12222 12223 12224 12225 12226
                }
            }
        }

        return result;
    }
N
Niels 已提交
12227 12228

    /// @}
N
cleanup  
Niels 已提交
12229 12230 12231 12232 12233 12234
};

/////////////
// presets //
/////////////

N
Niels 已提交
12235 12236 12237
/*!
@brief default JSON class

N
Niels 已提交
12238 12239
This type is the default specialization of the @ref basic_json class which
uses the standard template types.
N
Niels 已提交
12240

N
Niels 已提交
12241
@since version 1.0.0
N
Niels 已提交
12242
*/
N
cleanup  
Niels 已提交
12243
using json = basic_json<>;
N
Niels Lohmann 已提交
12244
} // namespace nlohmann
N
cleanup  
Niels 已提交
12245 12246


N
Niels 已提交
12247 12248 12249
///////////////////////
// nonmember support //
///////////////////////
N
cleanup  
Niels 已提交
12250 12251 12252

// specialization of std::swap, and std::hash
namespace std
T
Théo DELRIEU 已提交
12253 12254 12255 12256 12257 12258 12259 12260 12261 12262 12263 12264 12265 12266 12267 12268 12269 12270 12271
{
/*!
@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
cleanup  
Niels 已提交
12272
{
N
Niels 已提交
12273
    /*!
T
Théo DELRIEU 已提交
12274
    @brief return a hash value for a JSON object
N
Niels 已提交
12275

N
Niels 已提交
12276
    @since version 1.0.0
N
Niels 已提交
12277
    */
T
Théo DELRIEU 已提交
12278
    std::size_t operator()(const nlohmann::json& j) const
N
cleanup  
Niels 已提交
12279 12280
    {
        // a naive hashing via the string representation
N
Niels 已提交
12281 12282
        const auto& h = hash<nlohmann::json::string_t>();
        return h(j.dump());
N
cleanup  
Niels 已提交
12283
    }
T
Théo DELRIEU 已提交
12284
};
N
Niels Lohmann 已提交
12285
} // namespace std
N
cleanup  
Niels 已提交
12286

N
Niels 已提交
12287
/*!
N
Niels 已提交
12288 12289
@brief user-defined string literal for JSON values

N
Niels 已提交
12290
This operator implements a user-defined string literal for JSON objects. It
N
Niels 已提交
12291
can be used by adding `"_json"` to a string literal and returns a JSON object
N
Niels 已提交
12292
if no parse error occurred.
N
Niels 已提交
12293

N
Niels 已提交
12294
@param[in] s  a string representation of a JSON object
12295
@param[in] n  the length of string @a s
N
Niels 已提交
12296
@return a JSON object
N
Niels 已提交
12297

N
Niels 已提交
12298
@since version 1.0.0
N
Niels 已提交
12299
*/
12300
inline nlohmann::json operator "" _json(const char* s, std::size_t n)
N
Niels 已提交
12301
{
12302
    return nlohmann::json::parse(s, s + n);
N
Niels 已提交
12303 12304
}

N
Niels 已提交
12305 12306 12307
/*!
@brief user-defined string literal for JSON pointer

N
Niels 已提交
12308
This operator implements a user-defined string literal for JSON Pointers. It
S
Stefan Codrescu 已提交
12309
can be used by adding `"_json_pointer"` to a string literal and returns a JSON pointer
N
Niels 已提交
12310 12311 12312
object if no parse error occurred.

@param[in] s  a string representation of a JSON Pointer
12313
@param[in] n  the length of string @a s
N
Niels 已提交
12314 12315
@return a JSON pointer object

N
Niels 已提交
12316 12317
@since version 2.0.0
*/
12318
inline nlohmann::json::json_pointer operator "" _json_pointer(const char* s, std::size_t n)
N
Niels 已提交
12319
{
12320
    return nlohmann::json::json_pointer(std::string(s, n));
N
Niels 已提交
12321 12322
}

12323 12324 12325 12326 12327
// restore GCC/clang diagnostic settings
#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
    #pragma GCC diagnostic pop
#endif

12328 12329
// clean up
#undef JSON_CATCH
N
Niels Lohmann 已提交
12330 12331
#undef JSON_THROW
#undef JSON_TRY
12332

N
cleanup  
Niels 已提交
12333
#endif