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

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

Permission is hereby  granted, free of charge, to any  person obtaining a copy
of this software and associated  documentation files (the "Software"), to deal
in the Software  without restriction, including without  limitation the rights
to  use, copy,  modify, merge,  publish, distribute,  sublicense, and/or  sell
copies  of  the Software,  and  to  permit persons  to  whom  the Software  is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE  IS PROVIDED "AS  IS", WITHOUT WARRANTY  OF ANY KIND,  EXPRESS OR
IMPLIED,  INCLUDING BUT  NOT  LIMITED TO  THE  WARRANTIES OF  MERCHANTABILITY,
FITNESS FOR  A PARTICULAR PURPOSE AND  NONINFRINGEMENT. IN NO EVENT  SHALL THE
AUTHORS  OR COPYRIGHT  HOLDERS  BE  LIABLE FOR  ANY  CLAIM,  DAMAGES OR  OTHER
LIABILITY, WHETHER IN AN ACTION OF  CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE  OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
N
Niels 已提交
27 28
*/

N
Niels 已提交
29 30
#ifndef NLOHMANN_JSON_HPP
#define NLOHMANN_JSON_HPP
N
Niels 已提交
31

N
Niels 已提交
32 33 34 35 36
#include <algorithm> // all_of, for_each, transform
#include <array> // array
#include <cassert> // assert
#include <cctype> // isdigit
#include <ciso646> // and, not, or
37
#include <cmath> // isfinite, ldexp, signbit
N
Niels 已提交
38 39 40
#include <cstddef> // nullptr_t, ptrdiff_t, size_t
#include <cstdint> // int64_t, uint64_t
#include <cstdlib> // strtod, strtof, strtold, strtoul
N
Niels 已提交
41
#include <cstring> // strlen
42
#include <forward_list> // forward_list
N
Niels 已提交
43 44 45 46 47 48
#include <functional> // function, hash, less
#include <initializer_list> // initializer_list
#include <iomanip> // setw
#include <iostream> // istream, ostream
#include <iterator> // advance, begin, bidirectional_iterator_tag, distance, end, inserter, iterator, iterator_traits, next, random_access_iterator_tag, reverse_iterator
#include <limits> // numeric_limits
N
Niels 已提交
49
#include <locale> // locale
N
Niels 已提交
50 51 52 53 54 55 56 57 58
#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
#include <type_traits> // add_pointer, enable_if, is_arithmetic, is_base_of, is_const, is_constructible, is_convertible, is_floating_point, is_integral, is_nothrow_move_assignable, std::is_nothrow_move_constructible, std::is_pointer, std::is_reference, std::is_same, remove_const, remove_pointer, remove_reference
#include <utility> // declval, forward, make_pair, move, pair, swap
#include <vector> // vector
N
Niels 已提交
59

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

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

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

N
Niels 已提交
83 84 85 86 87 88 89 90 91
// allow for portable deprecation warnings
#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
    #define JSON_DEPRECATED __attribute__((deprecated))
#elif defined(_MSC_VER)
    #define JSON_DEPRECATED __declspec(deprecated)
#else
    #define JSON_DEPRECATED
#endif

92
// allow to disable exceptions
N
Niels Lohmann 已提交
93
#if not defined(JSON_NOEXCEPTION) || defined(__EXCEPTIONS)
94 95 96
    #define JSON_THROW(exception) throw exception
    #define JSON_TRY try
    #define JSON_CATCH(exception) catch(exception)
N
Niels Lohmann 已提交
97 98 99 100
#else
    #define JSON_THROW(exception) std::abort()
    #define JSON_TRY if(true)
    #define JSON_CATCH(exception) if(false)
101 102
#endif

N
Niels 已提交
103
/*!
N
Niels 已提交
104
@brief namespace for Niels Lohmann
N
Niels 已提交
105
@see https://github.com/nlohmann
N
Niels 已提交
106
@since version 1.0.0
N
Niels 已提交
107 108 109
*/
namespace nlohmann
{
110

111 112
/*!
@brief unnamed namespace with internal helper functions
113

114 115 116 117 118
This namespace collects some functions that could not be defined inside the
@ref basic_json class.

@since version 2.1.0
*/
119 120
namespace detail
{
121 122 123 124 125 126 127
///////////////////////////
// JSON type enumeration //
///////////////////////////

/*!
@brief the JSON type enumeration

128 129 130 131 132 133 134
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 已提交
135
@ref basic_json::is_structured() rely on it.
136

137 138 139 140 141 142
@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.
143

144 145
@sa @ref basic_json::basic_json(const value_t value_type) -- create a JSON
value with the default value for a given type
146 147 148 149 150

@since version 1.0.0
*/
enum class value_t : uint8_t
{
T
Théo DELRIEU 已提交
151 152 153 154 155 156 157 158 159
    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
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 187 188 189 190 191 192 193 194
/*!
@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)];
}

195 196 197 198 199

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

200
// alias templates to reduce boilerplate
201
template<bool B, typename T = void>
202 203
using enable_if_t = typename std::enable_if<B, T>::type;

204
template<typename T>
T
Théo DELRIEU 已提交
205
using uncvref_t = typename std::remove_cv<typename std::remove_reference<T>::type>::type;
206

N
Niels Lohmann 已提交
207
// taken from http://stackoverflow.com/a/26936864/266378
208
template<typename T>
T
Théo DELRIEU 已提交
209 210
using is_unscoped_enum =
    std::integral_constant<bool, std::is_convertible<T, int>::value and
211
    std::is_enum<T>::value>;
T
Théo DELRIEU 已提交
212

213
/*
N
Niels Lohmann 已提交
214
Implementation of two C++17 constructs: conjunction, negation. This is needed
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
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 {};
230

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

233
// dispatch utility (taken from ranges-v3)
234 235
template<unsigned N> struct priority_tag : priority_tag < N - 1 > {};
template<> struct priority_tag<0> {};
236

237 238 239 240

//////////////////
// constructors //
//////////////////
241

242
template<value_t> struct external_constructor;
243

244
template<>
245 246
struct external_constructor<value_t::boolean>
{
247
    template<typename BasicJsonType>
248
    static void construct(BasicJsonType& j, typename BasicJsonType::boolean_t b) noexcept
T
Théo DELRIEU 已提交
249 250 251 252 253
    {
        j.m_type = value_t::boolean;
        j.m_value = b;
        j.assert_invariant();
    }
254
};
255

256
template<>
257 258
struct external_constructor<value_t::string>
{
259
    template<typename BasicJsonType>
260
    static void construct(BasicJsonType& j, const typename BasicJsonType::string_t& s)
T
Théo DELRIEU 已提交
261 262 263 264 265
    {
        j.m_type = value_t::string;
        j.m_value = s;
        j.assert_invariant();
    }
266
};
267

268
template<>
269 270
struct external_constructor<value_t::number_float>
{
271
    template<typename BasicJsonType>
272
    static void construct(BasicJsonType& j, typename BasicJsonType::number_float_t val) noexcept
273
    {
T
Théo DELRIEU 已提交
274 275
        // replace infinity and NAN by null
        if (not std::isfinite(val))
276
        {
277
            j = BasicJsonType{};
278
        }
T
Théo DELRIEU 已提交
279 280 281 282 283 284
        else
        {
            j.m_type = value_t::number_float;
            j.m_value = val;
        }
        j.assert_invariant();
285 286 287
    }
};

288
template<>
289 290
struct external_constructor<value_t::number_unsigned>
{
291
    template<typename BasicJsonType>
292
    static void construct(BasicJsonType& j, typename BasicJsonType::number_unsigned_t val) noexcept
T
Théo DELRIEU 已提交
293 294 295 296 297
    {
        j.m_type = value_t::number_unsigned;
        j.m_value = val;
        j.assert_invariant();
    }
298 299
};

300
template<>
301 302
struct external_constructor<value_t::number_integer>
{
303
    template<typename BasicJsonType>
304
    static void construct(BasicJsonType& j, typename BasicJsonType::number_integer_t val) noexcept
T
Théo DELRIEU 已提交
305 306 307 308 309
    {
        j.m_type = value_t::number_integer;
        j.m_value = val;
        j.assert_invariant();
    }
310 311
};

312
template<>
313 314
struct external_constructor<value_t::array>
{
315
    template<typename BasicJsonType>
316
    static void construct(BasicJsonType& j, const typename BasicJsonType::array_t& arr)
T
Théo DELRIEU 已提交
317 318 319 320 321 322
    {
        j.m_type = value_t::array;
        j.m_value = arr;
        j.assert_invariant();
    }

323 324 325 326
    template<typename BasicJsonType, typename CompatibleArrayType,
             enable_if_t<not std::is_same<CompatibleArrayType,
                                          typename BasicJsonType::array_t>::value,
                         int> = 0>
327
    static void construct(BasicJsonType& j, const CompatibleArrayType& arr)
T
Théo DELRIEU 已提交
328 329 330 331
    {
        using std::begin;
        using std::end;
        j.m_type = value_t::array;
332
        j.m_value.array = j.template create<typename BasicJsonType::array_t>(begin(arr), end(arr));
T
Théo DELRIEU 已提交
333 334
        j.assert_invariant();
    }
335 336
};

337
template<>
338 339
struct external_constructor<value_t::object>
{
340
    template<typename BasicJsonType>
341
    static void construct(BasicJsonType& j, const typename BasicJsonType::object_t& obj)
T
Théo DELRIEU 已提交
342 343 344 345 346 347
    {
        j.m_type = value_t::object;
        j.m_value = obj;
        j.assert_invariant();
    }

348 349 350 351
    template<typename BasicJsonType, typename CompatibleObjectType,
             enable_if_t<not std::is_same<CompatibleObjectType,
                                          typename BasicJsonType::object_t>::value,
                         int> = 0>
352
    static void construct(BasicJsonType& j, const CompatibleObjectType& obj)
T
Théo DELRIEU 已提交
353 354 355
    {
        using std::begin;
        using std::end;
356

T
Théo DELRIEU 已提交
357
        j.m_type = value_t::object;
358
        j.m_value.object = j.template create<typename BasicJsonType::object_t>(begin(obj), end(obj));
T
Théo DELRIEU 已提交
359 360
        j.assert_invariant();
    }
361 362
};

363 364 365 366 367

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

368 369
/*!
@brief Helper to determine whether there's a key_type for T.
N
Niels Lohmann 已提交
370 371

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

375
@sa http://stackoverflow.com/a/7728728/266378
N
Niels 已提交
376
@since version 1.0.0, overworked in version 2.0.6
377
*/
N
Niels Lohmann 已提交
378
#define NLOHMANN_JSON_HAS_HELPER(type)                                        \
379
    template<typename T> struct has_##type {                                  \
N
Niels Lohmann 已提交
380
    private:                                                                  \
381
        template<typename U, typename = typename U::type>                     \
N
Niels Lohmann 已提交
382 383 384 385 386
        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 已提交
387
    }
T
Théo Delrieu 已提交
388

N
Niels Lohmann 已提交
389 390 391 392
NLOHMANN_JSON_HAS_HELPER(mapped_type);
NLOHMANN_JSON_HAS_HELPER(key_type);
NLOHMANN_JSON_HAS_HELPER(value_type);
NLOHMANN_JSON_HAS_HELPER(iterator);
T
Théo Delrieu 已提交
393 394

#undef NLOHMANN_JSON_HAS_HELPER
395

N
Niels Lohmann 已提交
396

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

400
template<class RealType, class CompatibleObjectType>
T
Théo DELRIEU 已提交
401 402
struct is_compatible_object_type_impl<true, RealType, CompatibleObjectType>
{
403 404 405 406 407
    static constexpr auto value =
        std::is_constructible<typename RealType::key_type,
        typename CompatibleObjectType::key_type>::value and
        std::is_constructible<typename RealType::mapped_type,
        typename CompatibleObjectType::mapped_type>::value;
T
Théo DELRIEU 已提交
408 409
};

410
template<class BasicJsonType, class CompatibleObjectType>
T
Théo DELRIEU 已提交
411 412
struct is_compatible_object_type
{
T
Théo DELRIEU 已提交
413 414 415 416
    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,
417
                                  typename BasicJsonType::object_t, CompatibleObjectType >::value;
T
Théo DELRIEU 已提交
418 419
};

420
template<typename BasicJsonType, typename T>
421
struct is_basic_json_nested_type
T
Théo DELRIEU 已提交
422
{
423 424 425 426 427
    static auto constexpr value = std::is_same<T, typename BasicJsonType::iterator>::value or
                                  std::is_same<T, typename BasicJsonType::const_iterator>::value or
                                  std::is_same<T, typename BasicJsonType::reverse_iterator>::value or
                                  std::is_same<T, typename BasicJsonType::const_reverse_iterator>::value or
                                  std::is_same<T, typename BasicJsonType::json_pointer>::value;
T
Théo DELRIEU 已提交
428 429
};

430
template<class BasicJsonType, class CompatibleArrayType>
T
Théo DELRIEU 已提交
431 432
struct is_compatible_array_type
{
T
Théo DELRIEU 已提交
433
    static auto constexpr value =
434
        conjunction<negation<std::is_same<void, CompatibleArrayType>>,
T
Théo DELRIEU 已提交
435
        negation<is_compatible_object_type<
436 437
        BasicJsonType, CompatibleArrayType>>,
        negation<std::is_constructible<typename BasicJsonType::string_t,
T
Théo DELRIEU 已提交
438
        CompatibleArrayType>>,
439
        negation<is_basic_json_nested_type<BasicJsonType, CompatibleArrayType>>,
T
Théo DELRIEU 已提交
440 441
        has_value_type<CompatibleArrayType>,
        has_iterator<CompatibleArrayType>>::value;
T
Théo DELRIEU 已提交
442 443
};

444
template<bool, typename, typename>
445
struct is_compatible_integer_type_impl : std::false_type {};
446

447
template<typename RealIntegerType, typename CompatibleNumberIntegerType>
448
struct is_compatible_integer_type_impl<true, RealIntegerType, CompatibleNumberIntegerType>
T
Théo DELRIEU 已提交
449
{
T
Théo DELRIEU 已提交
450
    // is there an assert somewhere on overflows?
451 452 453 454 455 456 457 458
    using RealLimits = std::numeric_limits<RealIntegerType>;
    using CompatibleLimits = std::numeric_limits<CompatibleNumberIntegerType>;

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

461
template<typename RealIntegerType, typename CompatibleNumberIntegerType>
462 463
struct is_compatible_integer_type
{
464 465 466 467 468
    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;
469 470
};

471

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

483 484
  public:
    static constexpr bool value = std::is_integral<decltype(
485
                                      detect(std::declval<typename BasicJsonType::template json_serializer<T, void>>()))>::value;
486 487 488 489
};

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

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

506
// This trait checks if BasicJsonType::json_serializer<T>::to_json exists
507
template<typename BasicJsonType, typename T>
508 509
struct has_to_json
{
T
Théo DELRIEU 已提交
510
  private:
511 512
    template<typename U, typename = decltype(uncvref_t<U>::to_json(
                 std::declval<BasicJsonType&>(), std::declval<T>()))>
T
Théo DELRIEU 已提交
513 514 515 516 517
    static int detect(U&&);
    static void detect(...);

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

521

522 523 524
/////////////
// to_json //
/////////////
525

526
template<typename BasicJsonType>
527
void to_json(BasicJsonType& j, typename BasicJsonType::boolean_t b) noexcept
528
{
T
Théo DELRIEU 已提交
529
    external_constructor<value_t::boolean>::construct(j, b);
530 531
}

532 533
template<typename BasicJsonType, typename CompatibleString,
         enable_if_t<std::is_constructible<typename BasicJsonType::string_t,
N
Niels Lohmann 已提交
534
                     CompatibleString>::value, int> = 0>
535
void to_json(BasicJsonType& j, const CompatibleString& s)
536
{
T
Théo DELRIEU 已提交
537
    external_constructor<value_t::string>::construct(j, s);
538 539
}

540 541
template<typename BasicJsonType, typename FloatType,
         enable_if_t<std::is_floating_point<FloatType>::value, int> = 0>
542
void to_json(BasicJsonType& j, FloatType val) noexcept
543
{
544
    external_constructor<value_t::number_float>::construct(j, static_cast<typename BasicJsonType::number_float_t>(val));
545 546
}

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

556
template <
557 558
    typename BasicJsonType, typename CompatibleNumberIntegerType,
    enable_if_t<is_compatible_integer_type<typename BasicJsonType::number_integer_t,
N
Niels Lohmann 已提交
559
                CompatibleNumberIntegerType>::value, int> = 0 >
560
void to_json(BasicJsonType& j, CompatibleNumberIntegerType val) noexcept
561
{
562
    external_constructor<value_t::number_integer>::construct(j, static_cast<typename BasicJsonType::number_integer_t>(val));
563 564
}

565 566
template<typename BasicJsonType, typename UnscopedEnumType,
         enable_if_t<is_unscoped_enum<UnscopedEnumType>::value, int> = 0>
567
void to_json(BasicJsonType& j, UnscopedEnumType e) noexcept
568
{
T
Théo DELRIEU 已提交
569
    external_constructor<value_t::number_integer>::construct(j, e);
570 571
}

572
template <
573
    typename BasicJsonType, typename CompatibleArrayType,
T
Théo DELRIEU 已提交
574
    enable_if_t <
575 576
        is_compatible_array_type<BasicJsonType, CompatibleArrayType>::value or
        std::is_same<typename BasicJsonType::array_t, CompatibleArrayType>::value,
T
Théo DELRIEU 已提交
577
        int > = 0 >
578
void to_json(BasicJsonType& j, const  CompatibleArrayType& arr)
579
{
T
Théo DELRIEU 已提交
580
    external_constructor<value_t::array>::construct(j, arr);
581 582
}

583
template <
584 585
    typename BasicJsonType, typename CompatibleObjectType,
    enable_if_t<is_compatible_object_type<BasicJsonType, CompatibleObjectType>::value,
T
Théo DELRIEU 已提交
586
                int> = 0 >
587
void to_json(BasicJsonType& j, const  CompatibleObjectType& arr)
588
{
T
Théo DELRIEU 已提交
589
    external_constructor<value_t::object>::construct(j, arr);
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 627 628 629 630 631 632 633

///////////////
// 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>
634
void from_json(const BasicJsonType& j, typename BasicJsonType::boolean_t& b)
635
{
N
Niels Lohmann 已提交
636
    if (not j.is_boolean())
T
Théo DELRIEU 已提交
637
    {
T
Théo DELRIEU 已提交
638
        JSON_THROW(std::domain_error("type must be boolean, but is " + j.type_name()));
T
Théo DELRIEU 已提交
639
    }
640
    b = *j.template get_ptr<const typename BasicJsonType::boolean_t*>();
641 642
}

643
template<typename BasicJsonType>
644
void from_json(const BasicJsonType& j, typename BasicJsonType::string_t& s)
645
{
N
Niels Lohmann 已提交
646
    if (not j.is_string())
T
Théo DELRIEU 已提交
647
    {
T
Théo DELRIEU 已提交
648
        JSON_THROW(std::domain_error("type must be string, but is " + j.type_name()));
T
Théo DELRIEU 已提交
649
    }
650
    s = *j.template get_ptr<const typename BasicJsonType::string_t*>();
651 652
}

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

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

665
template<typename BasicJsonType>
666
void from_json(const BasicJsonType& j, typename BasicJsonType::number_integer_t& val)
667
{
T
Théo DELRIEU 已提交
668
    get_arithmetic_value(j, val);
669 670
}

671 672 673
template<typename BasicJsonType, typename UnscopedEnumType,
         enable_if_t<is_unscoped_enum<UnscopedEnumType>::value, int> = 0>
void from_json(const BasicJsonType& j, UnscopedEnumType& e)
674
{
T
Théo DELRIEU 已提交
675 676 677
    typename std::underlying_type<UnscopedEnumType>::type val = e;
    get_arithmetic_value(j, val);
    e = static_cast<UnscopedEnumType>(val);
678 679
}

680 681
template<typename BasicJsonType>
void from_json(const BasicJsonType& j, typename BasicJsonType::array_t& arr)
682
{
N
Niels Lohmann 已提交
683
    if (not j.is_array())
T
Théo DELRIEU 已提交
684
    {
T
Théo DELRIEU 已提交
685
        JSON_THROW(std::domain_error("type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
686
    }
687
    arr = *j.template get_ptr<const typename BasicJsonType::array_t*>();
688 689
}

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

713 714
template<typename BasicJsonType, typename CompatibleArrayType>
void from_json_array_impl(const BasicJsonType& j, CompatibleArrayType& arr, priority_tag<0>)
715
{
T
Théo DELRIEU 已提交
716 717
    using std::begin;
    using std::end;
718

719 720
    std::transform(j.begin(), j.end(),
                   std::inserter(arr, end(arr)), [](const BasicJsonType & i)
T
Théo DELRIEU 已提交
721
    {
722 723
        // get<BasicJsonType>() returns *this, this won't call a from_json
        // method when value_type is BasicJsonType
724
        return i.template get<typename CompatibleArrayType::value_type>();
T
Théo DELRIEU 已提交
725
    });
726 727
}

728 729
template<typename BasicJsonType, typename CompatibleArrayType>
auto from_json_array_impl(const BasicJsonType& j, CompatibleArrayType& arr, priority_tag<1>)
T
Théo DELRIEU 已提交
730 731 732
-> decltype(
    arr.reserve(std::declval<typename CompatibleArrayType::size_type>()),
    void())
733
{
T
Théo DELRIEU 已提交
734 735
    using std::begin;
    using std::end;
736

T
Théo DELRIEU 已提交
737 738
    arr.reserve(j.size());
    std::transform(
739
        j.begin(), j.end(), std::inserter(arr, end(arr)), [](const BasicJsonType & i)
T
Théo DELRIEU 已提交
740
    {
741 742
        // get<BasicJsonType>() returns *this, this won't call a from_json
        // method when value_type is BasicJsonType
743
        return i.template get<typename CompatibleArrayType::value_type>();
T
Théo DELRIEU 已提交
744
    });
745 746
}

747 748 749 750
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)
751
{
T
Théo DELRIEU 已提交
752 753
    if (j.is_null())
    {
T
Théo DELRIEU 已提交
754
        JSON_THROW(std::domain_error("type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
755
    }
756

757 758
    // 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 已提交
759
    {
N
Niels Lohmann 已提交
760
        if (not j.is_array())
T
Théo DELRIEU 已提交
761
        {
T
Théo DELRIEU 已提交
762
            JSON_THROW(std::domain_error("type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
763 764 765
        }
    }
    from_json_array_impl(j, arr, priority_tag<1> {});
766 767
}

768 769 770
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)
771
{
N
Niels Lohmann 已提交
772
    if (not j.is_object())
T
Théo DELRIEU 已提交
773
    {
T
Théo DELRIEU 已提交
774
        JSON_THROW(std::domain_error("type must be object, but is " + j.type_name()));
T
Théo DELRIEU 已提交
775 776
    }

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

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

829 830
struct to_json_fn
{
N
Niels Lohmann 已提交
831
  private:
832 833 834
    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())
835
    {
836
        return to_json(j, std::forward<T>(val));
837
    }
T
Théo DELRIEU 已提交
838

839
    template<typename BasicJsonType, typename T>
840
    void call(BasicJsonType&, T&&, priority_tag<0>) const noexcept
T
Théo DELRIEU 已提交
841
    {
842 843
        static_assert(sizeof(BasicJsonType) == 0,
                      "could not find to_json() method in T's namespace");
T
Théo DELRIEU 已提交
844 845
    }

T
Théo DELRIEU 已提交
846
  public:
847
    template<typename BasicJsonType, typename T>
848
    void operator()(BasicJsonType& j, T&& val) const
T
Théo DELRIEU 已提交
849 850 851 852
    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> {});
    }
853 854 855 856
};

struct from_json_fn
{
T
Théo DELRIEU 已提交
857
  private:
858 859
    template<typename BasicJsonType, typename T>
    auto call(const BasicJsonType& j, T& val, priority_tag<1>) const
T
Théo DELRIEU 已提交
860 861 862 863 864 865
    noexcept(noexcept(from_json(j, val)))
    -> decltype(from_json(j, val), void())
    {
        return from_json(j, val);
    }

866
    template<typename BasicJsonType, typename T>
867
    void call(const BasicJsonType&, T&, priority_tag<0>) const noexcept
T
Théo DELRIEU 已提交
868
    {
869 870
        static_assert(sizeof(BasicJsonType) == 0,
                      "could not find from_json() method in T's namespace");
T
Théo DELRIEU 已提交
871 872 873
    }

  public:
874 875
    template<typename BasicJsonType, typename T>
    void operator()(const BasicJsonType& j, T& val) const
T
Théo DELRIEU 已提交
876 877 878 879
    noexcept(noexcept(std::declval<from_json_fn>().call(j, val, priority_tag<1> {})))
    {
        return call(j, val, priority_tag<1> {});
    }
880
};
881

882
// taken from ranges-v3
883
template<typename T>
884 885 886 887 888
struct static_const
{
    static constexpr T value{};
};

889
template<typename T>
890
constexpr T static_const<T>::value;
891 892
} // namespace detail

N
Niels 已提交
893

N
Niels Lohmann 已提交
894
/// namespace to hold default `to_json` / `from_json` functions
895
namespace
896
{
T
Théo DELRIEU 已提交
897 898
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;
899 900
}

N
Niels Lohmann 已提交
901 902 903 904 905 906 907 908

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

N
Niels Lohmann 已提交
928 929 930 931 932 933 934 935 936 937 938 939
    /*!
    @brief convert any value type to a JSON value

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

    @param[in, out] j  JSON value to write to
    @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))))
940
    {
N
Niels Lohmann 已提交
941
        ::nlohmann::to_json(j, std::forward<ValueType>(val));
942
    }
943 944
};

945

N
Niels 已提交
946
/*!
N
Niels 已提交
947
@brief a class to store JSON values
N
Niels 已提交
948

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

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

1009 1010 1011 1012 1013 1014 1015
@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 已提交
1016
@internal
N
Niels 已提交
1017
@note ObjectType trick from http://stackoverflow.com/a/9860911
N
Niels 已提交
1018
@endinternal
N
Niels 已提交
1019

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

N
Niels 已提交
1023
@since version 1.0.0
N
Niels 已提交
1024 1025

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

  public:
1048
    using value_t = detail::value_t;
N
Niels 已提交
1049
    // forward declarations
N
Niels Lohmann 已提交
1050
    template<typename U> class iter_impl;
N
Niels 已提交
1051 1052
    template<typename Base> class json_reverse_iterator;
    class json_pointer;
1053
    template<typename T, typename SFINAE>
1054
    using json_serializer = JSONSerializer<T, SFINAE>;
1055

N
Niels 已提交
1056 1057 1058 1059
    /////////////////////
    // container types //
    /////////////////////

N
Niels 已提交
1060
    /// @name container types
N
Niels 已提交
1061 1062
    /// The canonic container types to use @ref basic_json like any other STL
    /// container.
N
Niels 已提交
1063 1064
    /// @{

N
Niels 已提交
1065
    /// the type of elements in a basic_json container
N
Niels 已提交
1066
    using value_type = basic_json;
N
Niels 已提交
1067

N
Niels 已提交
1068
    /// the type of an element reference
N
Niels 已提交
1069
    using reference = value_type&;
N
Niels 已提交
1070
    /// the type of an element const reference
N
Niels 已提交
1071
    using const_reference = const value_type&;
N
Niels 已提交
1072

N
Niels 已提交
1073
    /// a type to represent differences between iterators
N
Niels 已提交
1074
    using difference_type = std::ptrdiff_t;
N
Niels 已提交
1075
    /// a type to represent container sizes
N
Niels 已提交
1076 1077 1078
    using size_type = std::size_t;

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

N
Niels 已提交
1081
    /// the type of an element pointer
N
Niels 已提交
1082
    using pointer = typename std::allocator_traits<allocator_type>::pointer;
N
Niels 已提交
1083
    /// the type of an element const pointer
N
Niels 已提交
1084
    using const_pointer = typename std::allocator_traits<allocator_type>::const_pointer;
N
Niels 已提交
1085

N
Niels 已提交
1086
    /// an iterator for a basic_json container
1087
    using iterator = iter_impl<basic_json>;
N
Niels 已提交
1088
    /// a const iterator for a basic_json container
1089
    using const_iterator = iter_impl<const basic_json>;
N
Niels 已提交
1090
    /// a reverse iterator for a basic_json container
N
Niels 已提交
1091
    using reverse_iterator = json_reverse_iterator<typename basic_json::iterator>;
N
Niels 已提交
1092
    /// a const reverse iterator for a basic_json container
N
Niels 已提交
1093
    using const_reverse_iterator = json_reverse_iterator<typename basic_json::const_iterator>;
N
Niels 已提交
1094

N
Niels 已提交
1095 1096 1097
    /// @}


N
Niels 已提交
1098 1099 1100
    /*!
    @brief returns the allocator associated with the container
    */
N
Niels 已提交
1101
    static allocator_type get_allocator()
N
Niels 已提交
1102 1103 1104 1105
    {
        return allocator_type();
    }

1106 1107
    /*!
    @brief returns version information on the library
1108

N
Niels Lohmann 已提交
1109
    This function returns a JSON object with information about the library,
1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127
    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
1128
    */
1129
    static basic_json meta()
1130 1131 1132
    {
        basic_json result;

1133
        result["copyright"] = "(C) 2013-2017 Niels Lohmann";
1134 1135 1136 1137
        result["name"] = "JSON for Modern C++";
        result["url"] = "https://github.com/nlohmann/json";
        result["version"] =
        {
N
Niels Lohmann 已提交
1138
            {"string", "2.1.0"},
1139
            {"major", 2},
N
Niels Lohmann 已提交
1140 1141
            {"minor", 1},
            {"patch", 0},
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
        };

#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__)
1157
        result["compiler"] = {{"family", "clang"}, {"version", __clang_version__}};
1158 1159 1160
#elif defined(__ICC) || defined(__INTEL_COMPILER)
        result["compiler"] = {{"family", "icc"}, {"version", __INTEL_COMPILER}};
#elif defined(__GNUC__) || defined(__GNUG__)
1161
        result["compiler"] = {{"family", "gcc"}, {"version", std::to_string(__GNUC__) + "." + std::to_string(__GNUC_MINOR__) + "." + std::to_string(__GNUC_PATCHLEVEL__)}};
1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183
#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 已提交
1184

N
Niels 已提交
1185 1186 1187 1188
    ///////////////////////////
    // JSON value data types //
    ///////////////////////////

N
Niels 已提交
1189
    /// @name JSON value data types
N
Niels 已提交
1190 1191
    /// The data types to store a JSON value. These types are derived from
    /// the template arguments passed to class @ref basic_json.
N
Niels 已提交
1192 1193
    /// @{

N
Niels 已提交
1194 1195 1196 1197 1198 1199 1200 1201
    /*!
    @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 已提交
1202 1203 1204 1205 1206
    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 已提交
1207 1208
    @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 已提交
1209 1210 1211
    inside the container.
    @tparam AllocatorType the allocator to use for objects (e.g.,
    `std::allocator`)
N
Niels 已提交
1212 1213 1214 1215

    #### Default type

    With the default values for @a ObjectType (`std::map`), @a StringType
N
Niels 已提交
1216 1217
    (`std::string`), and @a AllocatorType (`std::allocator`), the default
    value for @a object_t is:
N
Niels 已提交
1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233

    @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 已提交
1234 1235
      that all software implementations receiving that object will agree on
      the name-value mappings.
N
Niels 已提交
1236 1237 1238 1239 1240
    - 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 已提交
1241 1242 1243
      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 已提交
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255
    - 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 已提交
1256 1257
    runtime environment. A theoretical limit can be queried by calling the
    @ref max_size function of a JSON object.
N
Niels 已提交
1258 1259 1260

    #### Storage

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

1265 1266
    @sa @ref array_t -- type for an array value

N
Niels 已提交
1267
    @since version 1.0.0
N
Niels 已提交
1268

N
Niels 已提交
1269 1270 1271 1272 1273
    @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 已提交
1274 1275
    7159](http://rfc7159.net/rfc7159), because any order implements the
    specified "unordered" nature of JSON objects.
N
Niels 已提交
1276
    */
N
Niels 已提交
1277 1278 1279 1280 1281
    using object_t = ObjectType<StringType,
          basic_json,
          std::less<StringType>,
          AllocatorType<std::pair<const StringType,
          basic_json>>>;
N
Niels 已提交
1282 1283 1284 1285 1286 1287 1288

    /*!
    @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 已提交
1289 1290 1291 1292 1293
    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 已提交
1294
    @tparam AllocatorType allocator to use for arrays (e.g., `std::allocator`)
N
Niels 已提交
1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314

    #### 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 已提交
1315 1316
    runtime environment. A theoretical limit can be queried by calling the
    @ref max_size function of a JSON array.
N
Niels 已提交
1317 1318 1319

    #### Storage

1320
    Arrays are stored as pointers in a @ref basic_json type. That is, for any
N
Niels 已提交
1321
    access to array values, a pointer of type `array_t*` must be dereferenced.
1322 1323 1324

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

N
Niels 已提交
1325
    @since version 1.0.0
N
Niels 已提交
1326
    */
N
Niels 已提交
1327
    using array_t = ArrayType<basic_json, AllocatorType<basic_json>>;
N
Niels 已提交
1328 1329 1330 1331 1332 1333 1334

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

N
Niels 已提交
1339 1340
    @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 已提交
1341 1342 1343 1344 1345 1346 1347 1348 1349 1350

    #### Default type

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

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

1351 1352 1353 1354 1355 1356
    #### 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 已提交
1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373
    #### 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

1374 1375
    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 已提交
1376
    dereferenced.
1377

N
Niels 已提交
1378
    @since version 1.0.0
N
Niels 已提交
1379
    */
N
Niels 已提交
1380
    using string_t = StringType;
N
Niels 已提交
1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401

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

1402 1403
    Boolean values are stored directly inside a @ref basic_json type.

N
Niels 已提交
1404
    @since version 1.0.0
N
Niels 已提交
1405
    */
N
Niels 已提交
1406
    using boolean_t = BooleanType;
N
Niels 已提交
1407 1408 1409 1410 1411

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

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424
    > 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 已提交
1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442

    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 已提交
1443 1444
      instance, the C++ integer literal `010` will be serialized to `8`.
      During deserialization, leading zeros yield an error.
N
Niels 已提交
1445 1446 1447 1448 1449 1450 1451 1452 1453 1454
    - 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 已提交
1455 1456 1457 1458
    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 已提交
1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469

    [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

1470 1471 1472 1473
    Integer number values are stored directly inside a @ref basic_json type.

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

1474 1475
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
1476
    @since version 1.0.0
N
Niels 已提交
1477
    */
N
Niels 已提交
1478
    using number_integer_t = NumberIntegerType;
N
Niels 已提交
1479

1480 1481 1482 1483
    /*!
    @brief a type for a number (unsigned)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499
    > 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.
1500 1501 1502

    #### Default type

N
Niels 已提交
1503 1504
    With the default values for @a NumberUnsignedType (`uint64_t`), the
    default value for @a number_unsigned_t is:
1505 1506 1507 1508 1509 1510 1511 1512 1513 1514

    @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 已提交
1515 1516
      instance, the C++ integer literal `010` will be serialized to `8`.
      During deserialization, leading zeros yield an error.
1517 1518 1519 1520 1521 1522 1523 1524
    - 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 已提交
1525 1526 1527 1528 1529
    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.
1530 1531 1532 1533 1534 1535 1536

    [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 已提交
1537 1538
    number_integer_t type) of the exactly supported range [0, UINT64_MAX],
    this class's integer type is interoperable.
1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549

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

N
Niels 已提交
1551 1552 1553 1554
    /*!
    @brief a type for a number (floating-point)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567
    > 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 已提交
1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583

    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 已提交
1584 1585
      leading zeros in floating-point literals will be ignored. Internally,
      the value will be stored as decimal number. For instance, the C++
N
Niels 已提交
1586 1587 1588 1589 1590 1591 1592 1593 1594 1595
      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 已提交
1596 1597 1598
    > 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 已提交
1599 1600 1601 1602
    > precision.

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

    #### Storage

1608 1609 1610 1611 1612
    Floating-point number values are stored directly inside a @ref basic_json
    type.

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

1613 1614
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
1615
    @since version 1.0.0
N
Niels 已提交
1616
    */
N
Niels 已提交
1617 1618
    using number_float_t = NumberFloatType;

N
Niels 已提交
1619 1620
    /// @}

N
Niels 已提交
1621
  private:
N
Niels 已提交
1622

N
Cleanup  
Niels 已提交
1623 1624
    /// helper for exception-safe object creation
    template<typename T, typename... Args>
N
cleanup  
Niels 已提交
1625
    static T* create(Args&& ... args)
N
Cleanup  
Niels 已提交
1626 1627 1628 1629 1630 1631 1632 1633
    {
        AllocatorType<T> alloc;
        auto deleter = [&](T * object)
        {
            alloc.deallocate(object, 1);
        };
        std::unique_ptr<T, decltype(deleter)> object(alloc.allocate(1), deleter);
        alloc.construct(object.get(), std::forward<Args>(args)...);
N
Niels Lohmann 已提交
1634
        assert(object != nullptr);
N
Cleanup  
Niels 已提交
1635 1636 1637
        return object.release();
    }

N
Niels 已提交
1638 1639 1640 1641
    ////////////////////////
    // JSON value storage //
    ////////////////////////

1642 1643 1644
    /*!
    @brief a JSON value

N
Niels 已提交
1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662
    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.
1663

N
Niels 已提交
1664
    @since version 1.0.0
1665
    */
N
Niels 已提交
1666 1667 1668 1669 1670 1671 1672 1673
    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 已提交
1674
        /// boolean
N
Niels 已提交
1675 1676 1677
        boolean_t boolean;
        /// number (integer)
        number_integer_t number_integer;
1678 1679
        /// number (unsigned integer)
        number_unsigned_t number_unsigned;
N
Niels 已提交
1680
        /// number (floating-point)
N
Niels 已提交
1681 1682 1683
        number_float_t number_float;

        /// default constructor (for null values)
N
Niels 已提交
1684
        json_value() = default;
N
Niels 已提交
1685
        /// constructor for booleans
N
Niels 已提交
1686
        json_value(boolean_t v) noexcept : boolean(v) {}
N
Niels 已提交
1687
        /// constructor for numbers (integer)
N
Niels 已提交
1688
        json_value(number_integer_t v) noexcept : number_integer(v) {}
1689 1690
        /// constructor for numbers (unsigned)
        json_value(number_unsigned_t v) noexcept : number_unsigned(v) {}
N
Niels 已提交
1691
        /// constructor for numbers (floating-point)
N
Niels 已提交
1692
        json_value(number_float_t v) noexcept : number_float(v) {}
N
Niels 已提交
1693
        /// constructor for empty values of a given type
N
Niels 已提交
1694
        json_value(value_t t)
N
Niels 已提交
1695 1696 1697
        {
            switch (t)
            {
1698
                case value_t::object:
N
Niels 已提交
1699
                {
N
Cleanup  
Niels 已提交
1700
                    object = create<object_t>();
N
Niels 已提交
1701 1702
                    break;
                }
N
Niels 已提交
1703

1704
                case value_t::array:
N
Niels 已提交
1705
                {
N
Cleanup  
Niels 已提交
1706
                    array = create<array_t>();
N
Niels 已提交
1707 1708
                    break;
                }
N
Niels 已提交
1709

1710
                case value_t::string:
N
Niels 已提交
1711
                {
N
Cleanup  
Niels 已提交
1712
                    string = create<string_t>("");
N
Niels 已提交
1713 1714
                    break;
                }
N
Niels 已提交
1715

1716
                case value_t::boolean:
N
Niels 已提交
1717 1718 1719 1720 1721
                {
                    boolean = boolean_t(false);
                    break;
                }

1722
                case value_t::number_integer:
N
Niels 已提交
1723 1724 1725 1726
                {
                    number_integer = number_integer_t(0);
                    break;
                }
N
Niels 已提交
1727

1728 1729 1730 1731 1732
                case value_t::number_unsigned:
                {
                    number_unsigned = number_unsigned_t(0);
                    break;
                }
N
Niels 已提交
1733

1734
                case value_t::number_float:
N
Niels 已提交
1735 1736 1737 1738
                {
                    number_float = number_float_t(0.0);
                    break;
                }
1739

1740 1741 1742 1743 1744
                case value_t::null:
                {
                    break;
                }

1745 1746
                default:
                {
1747 1748
                    if (t == value_t::null)
                    {
N
Niels Lohmann 已提交
1749
                        JSON_THROW(std::domain_error("961c151d2e87f2686a955a9be24d316f1362bf21 2.1.0")); // LCOV_EXCL_LINE
1750
                    }
1751 1752
                    break;
                }
N
Niels 已提交
1753 1754
            }
        }
N
Niels 已提交
1755 1756

        /// constructor for strings
N
Niels 已提交
1757
        json_value(const string_t& value)
N
Niels 已提交
1758
        {
N
Cleanup  
Niels 已提交
1759
            string = create<string_t>(value);
N
Niels 已提交
1760 1761 1762
        }

        /// constructor for objects
N
Niels 已提交
1763
        json_value(const object_t& value)
N
Niels 已提交
1764
        {
N
Cleanup  
Niels 已提交
1765
            object = create<object_t>(value);
N
Niels 已提交
1766 1767 1768
        }

        /// constructor for arrays
N
Niels 已提交
1769
        json_value(const array_t& value)
N
Niels 已提交
1770
        {
N
Cleanup  
Niels 已提交
1771
            array = create<array_t>(value);
N
Niels 已提交
1772
        }
N
Niels 已提交
1773 1774
    };

1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789
    /*!
    @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 已提交
1790 1791

  public:
N
Niels 已提交
1792 1793 1794 1795
    //////////////////////////
    // JSON parser callback //
    //////////////////////////

N
Niels 已提交
1796 1797 1798 1799 1800
    /*!
    @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.
1801

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

N
Niels 已提交
1804
    @since version 1.0.0
N
Niels 已提交
1805
    */
N
Niels 已提交
1806 1807
    enum class parse_event_t : uint8_t
    {
N
Niels 已提交
1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819
        /// 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 已提交
1820 1821
    };

N
Niels 已提交
1822 1823 1824 1825
    /*!
    @brief per-element parser callback type

    With a parser callback function, the result of parsing a JSON text can be
N
Niels 已提交
1826
    influenced. When passed to @ref parse(std::istream&, const
1827
    parser_callback_t) or @ref parse(const CharT, const parser_callback_t),
N
Niels 已提交
1828 1829 1830 1831 1832
    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 已提交
1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846

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

N
Niels 已提交
1849 1850
    Discarding a value (i.e., returning `false`) has different effects
    depending on the context in which function was called:
N
Niels 已提交
1851 1852 1853

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

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

N
Niels 已提交
1859
    @param[in] event  an event of type parse_event_t indicating the context in
N
Niels 已提交
1860 1861 1862 1863 1864 1865 1866 1867 1868 1869
    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
1870
    @ref parse(const CharT, const parser_callback_t) for examples
1871

N
Niels 已提交
1872
    @since version 1.0.0
N
Niels 已提交
1873
    */
N
Niels 已提交
1874 1875 1876
    using parser_callback_t = std::function<bool(int depth,
                              parse_event_t event,
                              basic_json& parsed)>;
N
Niels 已提交
1877

N
Niels 已提交
1878 1879 1880 1881 1882

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

N
Niels 已提交
1883
    /// @name constructors and destructors
N
Niels 已提交
1884 1885
    /// Constructors of class @ref basic_json, copy/move constructor, copy
    /// assignment, static functions creating objects, and the destructor.
N
Niels 已提交
1886 1887
    /// @{

N
Niels 已提交
1888 1889 1890
    /*!
    @brief create an empty value with a given type

N
Niels 已提交
1891 1892 1893 1894 1895
    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 已提交
1896 1897 1898 1899 1900 1901
    null        | `null`
    boolean     | `false`
    string      | `""`
    number      | `0`
    object      | `{}`
    array       | `[]`
N
Niels 已提交
1902

1903
    @param[in] value_type  the type of the value to create
N
Niels 已提交
1904 1905 1906

    @complexity Constant.

N
Niels 已提交
1907
    @throw std::bad_alloc if allocation for object, array, or string value
N
Niels 已提交
1908
    fails
N
Niels 已提交
1909 1910 1911

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

N
Niels 已提交
1913
    @since version 1.0.0
N
Niels 已提交
1914
    */
1915 1916
    basic_json(const value_t value_type)
        : m_type(value_type), m_value(value_type)
1917 1918 1919
    {
        assert_invariant();
    }
N
Niels 已提交
1920

N
Niels 已提交
1921
    /*!
N
Niels 已提交
1922
    @brief create a null object
N
Niels 已提交
1923

N
Niels 已提交
1924 1925
    Create a `null` JSON value. It either takes a null pointer as parameter
    (explicitly creating `null`) or no parameter (implicitly creating `null`).
N
Niels 已提交
1926 1927
    The passed null pointer itself is not read -- it is only used to choose
    the right constructor.
N
Niels 已提交
1928 1929 1930

    @complexity Constant.

N
Niels 已提交
1931 1932 1933
    @exceptionsafety No-throw guarantee: this constructor never throws
    exceptions.

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

N
Niels 已提交
1937
    @since version 1.0.0
N
Niels 已提交
1938
    */
N
Niels 已提交
1939
    basic_json(std::nullptr_t = nullptr) noexcept
N
Niels 已提交
1940
        : basic_json(value_t::null)
1941 1942 1943
    {
        assert_invariant();
    }
N
Niels 已提交
1944

T
Théo DELRIEU 已提交
1945
    /*!
1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983
    @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 已提交
1984 1985 1986

    @param[in] val the value to be forwarded

1987 1988 1989 1990 1991 1992 1993 1994
    @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 已提交
1995 1996 1997

    @since version 2.1.0
    */
1998
    template<typename CompatibleType, typename U = detail::uncvref_t<CompatibleType>,
1999 2000 2001 2002 2003 2004
             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>
2005 2006
    basic_json(CompatibleType && val) noexcept(noexcept(JSONSerializer<U>::to_json(
                std::declval<basic_json_t&>(), std::forward<CompatibleType>(val))))
2007
    {
2008 2009
        JSONSerializer<U>::to_json(*this, std::forward<CompatibleType>(val));
        assert_invariant();
2010
    }
2011

N
Niels 已提交
2012 2013 2014 2015 2016 2017 2018 2019 2020 2021
    /*!
    @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 已提交
2022 2023
       object value is created where the first elements of the pairs are
       treated as keys and the second elements are as values.
N
Niels 已提交
2024 2025 2026
    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 已提交
2027
    JSON values. The rationale is as follows:
N
Niels 已提交
2028 2029

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

N
Niels 已提交
2038 2039
    With the rules described above, the following JSON values cannot be
    expressed by an initializer list:
N
Niels 已提交
2040

N
Niels 已提交
2041 2042 2043 2044 2045
    - 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 已提交
2046 2047 2048 2049 2050

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

N
Niels 已提交
2053 2054 2055
    @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 已提交
2056 2057
    used by the functions @ref array(std::initializer_list<basic_json>) and
    @ref object(std::initializer_list<basic_json>).
N
Niels 已提交
2058

N
Niels 已提交
2059 2060
    @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 已提交
2061 2062 2063
    value_t::array and @ref value_t::object are valid); when @a type_deduction
    is set to `true`, this parameter has no effect

N
Niels 已提交
2064 2065
    @throw std::domain_error if @a type_deduction is `false`, @a manual_type
    is `value_t::object`, but @a init contains an element which is not a pair
N
Niels 已提交
2066 2067
    whose first element is a string; example: `"cannot create object from
    initializer list"`
N
Niels 已提交
2068 2069 2070 2071

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

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

N
Niels 已提交
2074
    @sa @ref array(std::initializer_list<basic_json>) -- create a JSON array
2075
    value from an initializer list
N
Niels 已提交
2076
    @sa @ref object(std::initializer_list<basic_json>) -- create a JSON object
2077 2078
    value from an initializer list

N
Niels 已提交
2079
    @since version 1.0.0
N
Niels 已提交
2080
    */
N
Niels 已提交
2081 2082
    basic_json(std::initializer_list<basic_json> init,
               bool type_deduction = true,
N
Niels 已提交
2083
               value_t manual_type = value_t::array)
N
Niels 已提交
2084
    {
N
Niels 已提交
2085 2086
        // check if each element is an array with two elements whose first
        // element is a string
N
Niels 已提交
2087 2088
        bool is_an_object = std::all_of(init.begin(), init.end(),
                                        [](const basic_json & element)
N
Niels 已提交
2089
        {
N
Niels 已提交
2090 2091
            return element.is_array() and element.size() == 2 and element[0].is_string();
        });
N
Niels 已提交
2092 2093 2094 2095 2096 2097 2098

        // 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)
            {
2099
                is_an_object = false;
N
Niels 已提交
2100 2101 2102
            }

            // if object is wanted but impossible, throw an exception
2103
            if (manual_type == value_t::object and not is_an_object)
N
Niels 已提交
2104
            {
2105
                JSON_THROW(std::domain_error("cannot create object from initializer list"));
N
Niels 已提交
2106 2107 2108
            }
        }

2109
        if (is_an_object)
N
Niels 已提交
2110 2111 2112
        {
            // the initializer list is a list of pairs -> create object
            m_type = value_t::object;
N
Niels 已提交
2113
            m_value = value_t::object;
N
Niels 已提交
2114

N
Niels 已提交
2115
            std::for_each(init.begin(), init.end(), [this](const basic_json & element)
N
Niels 已提交
2116
            {
N
Niels 已提交
2117
                m_value.object->emplace(*(element[0].m_value.string), element[1]);
N
Niels 已提交
2118
            });
N
Niels 已提交
2119 2120 2121 2122 2123
        }
        else
        {
            // the initializer list describes an array -> create array
            m_type = value_t::array;
N
Niels 已提交
2124
            m_value.array = create<array_t>(init);
N
Niels 已提交
2125
        }
2126 2127

        assert_invariant();
N
Niels 已提交
2128 2129
    }

N
Niels 已提交
2130 2131 2132 2133 2134 2135 2136
    /*!
    @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 已提交
2137 2138
    @note This function is only needed to express two edge cases that cannot
    be realized with the initializer list constructor (@ref
N
Niels 已提交
2139 2140
    basic_json(std::initializer_list<basic_json>, bool, value_t)). These cases
    are:
N
Niels 已提交
2141
    1. creating an array whose elements are all pairs whose first element is a
N
Niels 已提交
2142
    string -- in this case, the initializer list constructor would create an
N
Niels 已提交
2143
    object, taking the first elements as keys
N
Niels 已提交
2144
    2. creating an empty array -- passing the empty initializer list to the
N
Niels 已提交
2145 2146
    initializer list constructor yields an empty object

N
Niels 已提交
2147
    @param[in] init  initializer list with JSON values to create an array from
N
Niels 已提交
2148 2149 2150 2151 2152 2153
    (optional)

    @return JSON array value

    @complexity Linear in the size of @a init.

N
Niels 已提交
2154
    @liveexample{The following code shows an example for the `array`
N
Niels 已提交
2155 2156
    function.,array}

2157 2158 2159 2160 2161
    @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 已提交
2162
    @since version 1.0.0
N
Niels 已提交
2163
    */
N
Niels 已提交
2164
    static basic_json array(std::initializer_list<basic_json> init =
T
Théo DELRIEU 已提交
2165
                                std::initializer_list<basic_json>())
N
Niels 已提交
2166
    {
N
Niels 已提交
2167
        return basic_json(init, false, value_t::array);
N
Niels 已提交
2168 2169
    }

N
Niels 已提交
2170 2171 2172 2173
    /*!
    @brief explicitly create an object from an initializer list

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

    @note This function is only added for symmetry reasons. In contrast to the
2178 2179 2180
    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 已提交
2181 2182
    constructor @ref basic_json(std::initializer_list<basic_json>, bool,
    value_t).
N
Niels 已提交
2183

N
Niels 已提交
2184
    @param[in] init  initializer list to create an object from (optional)
N
Niels 已提交
2185 2186 2187 2188

    @return JSON object value

    @throw std::domain_error if @a init is not a pair whose first elements are
2189 2190
    strings; thrown by
    @ref basic_json(std::initializer_list<basic_json>, bool, value_t)
N
Niels 已提交
2191 2192 2193

    @complexity Linear in the size of @a init.

N
Niels 已提交
2194
    @liveexample{The following code shows an example for the `object`
N
Niels 已提交
2195 2196
    function.,object}

2197 2198 2199 2200 2201
    @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 已提交
2202
    @since version 1.0.0
N
Niels 已提交
2203
    */
N
Niels 已提交
2204
    static basic_json object(std::initializer_list<basic_json> init =
T
Théo DELRIEU 已提交
2205
                                 std::initializer_list<basic_json>())
N
Niels 已提交
2206
    {
N
Niels 已提交
2207
        return basic_json(init, false, value_t::object);
N
Niels 已提交
2208 2209
    }

N
Niels 已提交
2210 2211 2212
    /*!
    @brief construct an array with count copies of given value

N
Niels 已提交
2213 2214
    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,
2215
    `std::distance(begin(),end()) == cnt` holds.
N
Niels 已提交
2216

2217 2218
    @param[in] cnt  the number of JSON copies of @a val to create
    @param[in] val  the JSON value to copy
N
Niels 已提交
2219

2220
    @complexity Linear in @a cnt.
N
Niels 已提交
2221 2222 2223 2224

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

N
Niels 已提交
2226
    @since version 1.0.0
N
Niels 已提交
2227
    */
2228
    basic_json(size_type cnt, const basic_json& val)
N
Niels 已提交
2229 2230
        : m_type(value_t::array)
    {
2231
        m_value.array = create<array_t>(cnt, val);
2232
        assert_invariant();
N
Niels 已提交
2233
    }
N
Niels 已提交
2234

N
Niels 已提交
2235 2236 2237 2238 2239
    /*!
    @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 已提交
2240
    - In case of primitive types (number, boolean, or string), @a first must
N
Niels 已提交
2241 2242
      be `begin()` and @a last must be `end()`. In this case, the value is
      copied. Otherwise, std::out_of_range is thrown.
N
Niels 已提交
2243 2244
    - In case of structured types (array, object), the constructor behaves as
      similar versions for `std::vector`.
N
Niels 已提交
2245
    - In case of a null type, std::domain_error is thrown.
N
Niels 已提交
2246 2247 2248 2249 2250 2251 2252

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

N
Niels 已提交
2256
    @throw std::domain_error if iterators are not compatible; that is, do not
N
Niels 已提交
2257
    belong to the same JSON value; example: `"iterators are not compatible"`
N
Niels 已提交
2258
    @throw std::out_of_range if iterators are for a primitive type (number,
N
Niels 已提交
2259 2260
    boolean, or string) where an out of range error can be detected easily;
    example: `"iterators out of range"`
N
Niels 已提交
2261
    @throw std::bad_alloc if allocation for object, array, or string fails
N
Niels 已提交
2262 2263
    @throw std::domain_error if called with a null value; example: `"cannot
    use construct with iterators from null"`
N
Niels 已提交
2264 2265 2266 2267 2268

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

N
Niels 已提交
2270
    @since version 1.0.0
N
Niels 已提交
2271
    */
N
Niels 已提交
2272 2273 2274
    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 已提交
2275
    basic_json(InputIT first, InputIT last)
N
Niels 已提交
2276
    {
N
Niels 已提交
2277 2278 2279
        assert(first.m_object != nullptr);
        assert(last.m_object != nullptr);

N
Niels 已提交
2280
        // make sure iterator fits the current value
N
Niels 已提交
2281
        if (first.m_object != last.m_object)
N
Niels 已提交
2282
        {
2283
            JSON_THROW(std::domain_error("iterators are not compatible"));
N
Niels 已提交
2284 2285
        }

N
Niels 已提交
2286 2287 2288
        // copy type from first iterator
        m_type = first.m_object->m_type;

N
Niels 已提交
2289
        // check if iterator range is complete for primitive values
N
Niels 已提交
2290 2291 2292
        switch (m_type)
        {
            case value_t::boolean:
2293 2294
            case value_t::number_float:
            case value_t::number_integer:
2295
            case value_t::number_unsigned:
N
Niels 已提交
2296 2297
            case value_t::string:
            {
2298
                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
N
Niels 已提交
2299
                {
2300
                    JSON_THROW(std::out_of_range("iterators out of range"));
N
Niels 已提交
2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317
                }
                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 已提交
2318

2319 2320 2321 2322 2323
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = first.m_object->m_value.number_unsigned;
                break;
            }
N
Niels 已提交
2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338

            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 已提交
2339
                m_value = *first.m_object->m_value.string;
N
Niels 已提交
2340 2341 2342 2343 2344
                break;
            }

            case value_t::object:
            {
N
Niels Lohmann 已提交
2345 2346
                m_value.object = create<object_t>(first.m_it.object_iterator,
                                                  last.m_it.object_iterator);
N
Niels 已提交
2347 2348 2349 2350 2351
                break;
            }

            case value_t::array:
            {
N
Niels Lohmann 已提交
2352 2353
                m_value.array = create<array_t>(first.m_it.array_iterator,
                                                last.m_it.array_iterator);
N
Niels 已提交
2354 2355 2356 2357 2358
                break;
            }

            default:
            {
2359
                JSON_THROW(std::domain_error("cannot use construct with iterators from " + first.m_object->type_name()));
N
Niels 已提交
2360 2361
            }
        }
2362 2363

        assert_invariant();
N
Niels 已提交
2364 2365
    }

N
Niels 已提交
2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379
    /*!
    @brief construct a JSON value given an input stream

    @param[in,out] i  stream to read a serialized JSON value from
    @param[in] cb a parser callback function of type @ref parser_callback_t
    which is used to control the deserialization by filtering unwanted values
    (optional)

    @complexity Linear in the length of the input. The parser is a predictive
    LL(1) parser. The complexity can be higher if the parser callback function
    @a cb has a super-linear complexity.

    @note A UTF-8 byte order mark is silently ignored.

N
Niels 已提交
2380 2381 2382 2383 2384 2385 2386
    @deprecated This constructor is deprecated and will be removed in version
      3.0.0 to unify the interface of the library. Deserialization will be
      done by stream operators or by calling one of the `parse` functions,
      e.g. @ref parse(std::istream&, const parser_callback_t). That is, calls
      like `json j(i);` for an input stream @a i need to be replaced by
      `json j = json::parse(i);`. See the example below.

N
Niels 已提交
2387 2388 2389 2390
    @liveexample{The example below demonstrates constructing a JSON value from
    a `std::stringstream` with and without callback
    function.,basic_json__istream}

N
Niels 已提交
2391 2392
    @since version 2.0.0, deprecated in version 2.0.3, to be removed in
           version 3.0.0
N
Niels 已提交
2393
    */
N
Niels 已提交
2394
    JSON_DEPRECATED
N
Niels 已提交
2395
    explicit basic_json(std::istream& i, const parser_callback_t cb = nullptr)
N
Niels 已提交
2396 2397
    {
        *this = parser(i, cb).parse();
2398
        assert_invariant();
N
Niels 已提交
2399 2400
    }

N
Niels 已提交
2401 2402 2403 2404
    ///////////////////////////////////////
    // other constructors and destructor //
    ///////////////////////////////////////

N
Niels 已提交
2405 2406
    /*!
    @brief copy constructor
N
Niels 已提交
2407

N
Niels 已提交
2408 2409
    Creates a copy of a given JSON value.

N
Niels 已提交
2410
    @param[in] other  the JSON value to copy
N
Niels 已提交
2411 2412 2413

    @complexity Linear in the size of @a other.

N
Niels 已提交
2414 2415 2416
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2417 2418 2419
    - The complexity is linear.
    - As postcondition, it holds: `other == basic_json(other)`.

N
Niels 已提交
2420
    @throw std::bad_alloc if allocation for object, array, or string fails.
N
Niels 已提交
2421 2422

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

N
Niels 已提交
2425
    @since version 1.0.0
N
Niels 已提交
2426
    */
N
Niels 已提交
2427
    basic_json(const basic_json& other)
N
Niels 已提交
2428 2429
        : m_type(other.m_type)
    {
2430 2431 2432
        // check of passed value is valid
        other.assert_invariant();

N
Niels 已提交
2433 2434
        switch (m_type)
        {
2435
            case value_t::object:
N
Niels 已提交
2436
            {
N
Niels 已提交
2437
                m_value = *other.m_value.object;
N
Niels 已提交
2438 2439
                break;
            }
N
Niels 已提交
2440

2441
            case value_t::array:
N
Niels 已提交
2442
            {
N
Niels 已提交
2443
                m_value = *other.m_value.array;
N
Niels 已提交
2444 2445
                break;
            }
N
Niels 已提交
2446

2447
            case value_t::string:
N
Niels 已提交
2448
            {
N
Niels 已提交
2449
                m_value = *other.m_value.string;
N
Niels 已提交
2450 2451
                break;
            }
N
Niels 已提交
2452

2453
            case value_t::boolean:
N
Niels 已提交
2454
            {
N
Niels 已提交
2455
                m_value = other.m_value.boolean;
N
Niels 已提交
2456 2457
                break;
            }
N
Niels 已提交
2458

2459
            case value_t::number_integer:
N
Niels 已提交
2460
            {
N
Niels 已提交
2461
                m_value = other.m_value.number_integer;
N
Niels 已提交
2462 2463
                break;
            }
N
Niels 已提交
2464

2465 2466 2467 2468 2469
            case value_t::number_unsigned:
            {
                m_value = other.m_value.number_unsigned;
                break;
            }
N
Niels 已提交
2470

2471
            case value_t::number_float:
N
Niels 已提交
2472
            {
N
Niels 已提交
2473
                m_value = other.m_value.number_float;
N
Niels 已提交
2474 2475
                break;
            }
2476 2477 2478 2479 2480

            default:
            {
                break;
            }
N
Niels 已提交
2481
        }
2482 2483

        assert_invariant();
N
Niels 已提交
2484 2485
    }

N
Niels 已提交
2486 2487 2488 2489 2490 2491 2492
    /*!
    @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 已提交
2493
    @param[in,out] other  value to move to this object
N
Niels 已提交
2494 2495 2496 2497 2498 2499 2500

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

N
Niels 已提交
2502
    @since version 1.0.0
N
Niels 已提交
2503
    */
N
Niels 已提交
2504
    basic_json(basic_json&& other) noexcept
N
Niels 已提交
2505 2506
        : m_type(std::move(other.m_type)),
          m_value(std::move(other.m_value))
N
Niels 已提交
2507
    {
2508 2509 2510
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2511
        // invalidate payload
N
Niels 已提交
2512 2513
        other.m_type = value_t::null;
        other.m_value = {};
2514 2515

        assert_invariant();
N
Niels 已提交
2516 2517
    }

N
Niels 已提交
2518 2519
    /*!
    @brief copy assignment
N
Niels 已提交
2520

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

N
Niels 已提交
2525
    @param[in] other  value to copy from
N
Niels 已提交
2526 2527 2528

    @complexity Linear.

N
Niels 已提交
2529 2530 2531
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2532 2533
    - The complexity is linear.

N
Niels 已提交
2534 2535 2536 2537
    @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 已提交
2538

N
Niels 已提交
2539
    @since version 1.0.0
N
Niels 已提交
2540
    */
N
Niels 已提交
2541
    reference& operator=(basic_json other) noexcept (
N
Niels 已提交
2542 2543 2544 2545
        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 已提交
2546
    )
N
Niels 已提交
2547
    {
2548 2549 2550
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2551
        using std::swap;
N
Cleanup  
Niels 已提交
2552 2553
        swap(m_type, other.m_type);
        swap(m_value, other.m_value);
2554 2555

        assert_invariant();
N
Niels 已提交
2556 2557 2558
        return *this;
    }

2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576
    /*!
    @brief destructor

    Destroys the JSON value and frees all allocated memory.

    @complexity Linear.

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

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

2578 2579 2580 2581 2582 2583 2584 2585 2586
        switch (m_type)
        {
            case value_t::object:
            {
                AllocatorType<object_t> alloc;
                alloc.destroy(m_value.object);
                alloc.deallocate(m_value.object, 1);
                break;
            }
N
Niels 已提交
2587

2588 2589 2590 2591 2592 2593 2594
            case value_t::array:
            {
                AllocatorType<array_t> alloc;
                alloc.destroy(m_value.array);
                alloc.deallocate(m_value.array, 1);
                break;
            }
2595

2596 2597 2598 2599 2600 2601 2602
            case value_t::string:
            {
                AllocatorType<string_t> alloc;
                alloc.destroy(m_value.string);
                alloc.deallocate(m_value.string, 1);
                break;
            }
2603

2604 2605 2606 2607 2608 2609
            default:
            {
                // all other types need no specific destructor
                break;
            }
        }
N
Niels 已提交
2610 2611
    }

N
Niels 已提交
2612
    /// @}
N
Niels 已提交
2613 2614 2615 2616 2617 2618

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

N
Niels 已提交
2619
    /// @name object inspection
N
Niels 已提交
2620
    /// Functions to inspect the type of a JSON value.
N
Niels 已提交
2621 2622
    /// @{

N
Niels 已提交
2623
    /*!
N
Niels 已提交
2624 2625
    @brief serialization

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

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

N
Niels 已提交
2635 2636 2637 2638 2639
    @return string containing the serialization of the JSON value

    @complexity Linear.

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

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

N
Niels 已提交
2644
    @since version 1.0.0
N
Niels 已提交
2645
    */
N
Niels 已提交
2646
    string_t dump(const int indent = -1) const
N
Niels 已提交
2647
    {
N
Niels 已提交
2648
        std::stringstream ss;
2649

N
Niels 已提交
2650 2651
        if (indent >= 0)
        {
N
Niels 已提交
2652
            dump(ss, true, static_cast<unsigned int>(indent));
N
Niels 已提交
2653 2654 2655
        }
        else
        {
N
Niels 已提交
2656
            dump(ss, false, 0);
N
Niels 已提交
2657
        }
N
Niels 已提交
2658 2659

        return ss.str();
N
Niels 已提交
2660 2661
    }

N
Niels 已提交
2662 2663 2664 2665 2666 2667 2668
    /*!
    @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 已提交
2669 2670 2671

    @complexity Constant.

N
Niels 已提交
2672 2673 2674
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2675
    @liveexample{The following code exemplifies `type()` for all JSON
N
Niels 已提交
2676
    types.,type}
N
Niels 已提交
2677

N
Niels 已提交
2678
    @since version 1.0.0
N
Niels 已提交
2679
    */
N
Niels 已提交
2680
    constexpr value_t type() const noexcept
N
Niels 已提交
2681 2682 2683 2684
    {
        return m_type;
    }

N
Niels 已提交
2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695
    /*!
    @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 已提交
2696 2697 2698
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2699
    @liveexample{The following code exemplifies `is_primitive()` for all JSON
N
Niels 已提交
2700
    types.,is_primitive}
N
Niels 已提交
2701

N
Niels 已提交
2702 2703 2704 2705 2706 2707
    @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 已提交
2708
    @since version 1.0.0
N
Niels 已提交
2709
    */
N
Niels 已提交
2710
    constexpr bool is_primitive() const noexcept
N
Niels 已提交
2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724
    {
        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 已提交
2725 2726 2727
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2728
    @liveexample{The following code exemplifies `is_structured()` for all JSON
N
Niels 已提交
2729
    types.,is_structured}
N
Niels 已提交
2730

N
Niels 已提交
2731 2732 2733 2734
    @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 已提交
2735
    @since version 1.0.0
N
Niels 已提交
2736
    */
N
Niels 已提交
2737
    constexpr bool is_structured() const noexcept
N
Niels 已提交
2738 2739 2740 2741
    {
        return is_array() or is_object();
    }

N
Niels 已提交
2742 2743 2744 2745 2746
    /*!
    @brief return whether value is null

    This function returns true iff the JSON value is null.

N
Niels 已提交
2747
    @return `true` if type is null, `false` otherwise.
N
Niels 已提交
2748 2749 2750

    @complexity Constant.

N
Niels 已提交
2751 2752 2753
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2754
    @liveexample{The following code exemplifies `is_null()` for all JSON
N
Niels 已提交
2755
    types.,is_null}
N
Niels 已提交
2756

N
Niels 已提交
2757
    @since version 1.0.0
N
Niels 已提交
2758
    */
N
Niels 已提交
2759
    constexpr bool is_null() const noexcept
N
Niels 已提交
2760 2761 2762 2763
    {
        return m_type == value_t::null;
    }

N
Niels 已提交
2764 2765 2766 2767 2768
    /*!
    @brief return whether value is a boolean

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

N
Niels 已提交
2769
    @return `true` if type is boolean, `false` otherwise.
N
Niels 已提交
2770 2771 2772

    @complexity Constant.

N
Niels 已提交
2773 2774 2775
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2776
    @liveexample{The following code exemplifies `is_boolean()` for all JSON
N
Niels 已提交
2777
    types.,is_boolean}
N
Niels 已提交
2778

N
Niels 已提交
2779
    @since version 1.0.0
N
Niels 已提交
2780
    */
N
Niels 已提交
2781
    constexpr bool is_boolean() const noexcept
N
Niels 已提交
2782 2783 2784 2785
    {
        return m_type == value_t::boolean;
    }

N
Niels 已提交
2786 2787 2788 2789 2790 2791
    /*!
    @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.

2792 2793
    @return `true` if type is number (regardless whether integer, unsigned
    integer or floating-type), `false` otherwise.
N
Niels 已提交
2794 2795 2796

    @complexity Constant.

N
Niels 已提交
2797 2798 2799
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2800
    @liveexample{The following code exemplifies `is_number()` for all JSON
N
Niels 已提交
2801
    types.,is_number}
N
Niels 已提交
2802

N
Niels 已提交
2803
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
2804
    integer number
N
Niels 已提交
2805 2806
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2807 2808
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
2809
    @since version 1.0.0
N
Niels 已提交
2810
    */
N
Niels 已提交
2811
    constexpr bool is_number() const noexcept
N
Niels 已提交
2812
    {
N
Niels 已提交
2813
        return is_number_integer() or is_number_float();
N
Niels 已提交
2814 2815
    }

N
Niels 已提交
2816 2817 2818
    /*!
    @brief return whether value is an integer number

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

N
Niels 已提交
2822
    @return `true` if type is an integer or unsigned integer number, `false`
2823
    otherwise.
N
Niels 已提交
2824 2825 2826

    @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_number_integer()` for all
N
Niels 已提交
2831
    JSON types.,is_number_integer}
N
Niels 已提交
2832 2833

    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
2834 2835
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2836 2837
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
2838
    @since version 1.0.0
N
Niels 已提交
2839
    */
N
Niels 已提交
2840
    constexpr bool is_number_integer() const noexcept
N
Niels 已提交
2841
    {
2842 2843
        return m_type == value_t::number_integer or m_type == value_t::number_unsigned;
    }
N
Niels 已提交
2844

2845 2846 2847
    /*!
    @brief return whether value is an unsigned integer number

N
Niels 已提交
2848 2849
    This function returns true iff the JSON value is an unsigned integer
    number. This excludes floating-point and (signed) integer values.
2850 2851 2852 2853 2854

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

    @complexity Constant.

N
Niels 已提交
2855 2856 2857
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

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

2861
    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
2862
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
2863 2864 2865 2866 2867
    integer number
    @sa @ref is_number_float() -- check if value is a floating-point number

    @since version 2.0.0
    */
N
Niels 已提交
2868
    constexpr bool is_number_unsigned() const noexcept
2869 2870
    {
        return m_type == value_t::number_unsigned;
N
Niels 已提交
2871 2872
    }

N
Niels 已提交
2873 2874 2875 2876
    /*!
    @brief return whether value is a floating-point number

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

N
Niels 已提交
2879
    @return `true` if type is a floating-point number, `false` otherwise.
N
Niels 已提交
2880 2881 2882

    @complexity Constant.

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

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

    @sa @ref is_number() -- check if value is number
    @sa @ref is_number_integer() -- check if value is an integer number
N
Niels 已提交
2891 2892
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2893

N
Niels 已提交
2894
    @since version 1.0.0
N
Niels 已提交
2895
    */
N
Niels 已提交
2896
    constexpr bool is_number_float() const noexcept
N
Niels 已提交
2897 2898 2899 2900
    {
        return m_type == value_t::number_float;
    }

N
Niels 已提交
2901 2902 2903 2904 2905
    /*!
    @brief return whether value is an object

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

N
Niels 已提交
2906
    @return `true` if type is object, `false` otherwise.
N
Niels 已提交
2907 2908 2909

    @complexity Constant.

N
Niels 已提交
2910 2911 2912
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

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

N
Niels 已提交
2916
    @since version 1.0.0
N
Niels 已提交
2917
    */
N
Niels 已提交
2918
    constexpr bool is_object() const noexcept
N
Niels 已提交
2919 2920 2921 2922
    {
        return m_type == value_t::object;
    }

N
Niels 已提交
2923 2924 2925 2926 2927
    /*!
    @brief return whether value is an array

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

N
Niels 已提交
2928
    @return `true` if type is array, `false` otherwise.
N
Niels 已提交
2929 2930 2931

    @complexity Constant.

N
Niels 已提交
2932 2933 2934
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2935
    @liveexample{The following code exemplifies `is_array()` for all JSON
N
Niels 已提交
2936
    types.,is_array}
N
Niels 已提交
2937

N
Niels 已提交
2938
    @since version 1.0.0
N
Niels 已提交
2939
    */
N
Niels 已提交
2940
    constexpr bool is_array() const noexcept
N
Niels 已提交
2941 2942 2943 2944
    {
        return m_type == value_t::array;
    }

N
Niels 已提交
2945 2946 2947 2948 2949
    /*!
    @brief return whether value is a string

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

N
Niels 已提交
2950
    @return `true` if type is string, `false` otherwise.
N
Niels 已提交
2951 2952 2953

    @complexity Constant.

N
Niels 已提交
2954 2955 2956
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2957
    @liveexample{The following code exemplifies `is_string()` for all JSON
N
Niels 已提交
2958
    types.,is_string}
N
Niels 已提交
2959

N
Niels 已提交
2960
    @since version 1.0.0
N
Niels 已提交
2961
    */
N
Niels 已提交
2962
    constexpr bool is_string() const noexcept
N
Niels 已提交
2963 2964 2965 2966
    {
        return m_type == value_t::string;
    }

N
Niels 已提交
2967 2968 2969 2970 2971 2972
    /*!
    @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 已提交
2973 2974 2975 2976
    @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 已提交
2977 2978 2979 2980
    @return `true` if type is discarded, `false` otherwise.

    @complexity Constant.

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

N
Niels 已提交
2984
    @liveexample{The following code exemplifies `is_discarded()` for all JSON
N
Niels 已提交
2985
    types.,is_discarded}
N
Niels 已提交
2986

N
Niels 已提交
2987
    @since version 1.0.0
N
Niels 已提交
2988
    */
N
Niels 已提交
2989
    constexpr bool is_discarded() const noexcept
N
Niels 已提交
2990 2991 2992 2993
    {
        return m_type == value_t::discarded;
    }

N
Niels 已提交
2994 2995 2996 2997 2998 2999 3000 3001 3002 3003
    /*!
    @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 已提交
3004 3005 3006
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

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

N
Niels 已提交
3010
    @since version 1.0.0
N
Niels 已提交
3011
    */
N
Niels 已提交
3012
    constexpr operator value_t() const noexcept
N
Niels 已提交
3013 3014 3015 3016
    {
        return m_type;
    }

N
Niels 已提交
3017 3018
    /// @}

N
Niels 已提交
3019
  private:
N
Niels Lohmann 已提交
3020 3021 3022 3023
    //////////////////
    // value access //
    //////////////////

N
Niels 已提交
3024
    /// get a boolean (explicit)
3025
    boolean_t get_impl(boolean_t* /*unused*/) const
N
Niels 已提交
3026
    {
3027 3028 3029 3030
        if (is_boolean())
        {
            return m_value.boolean;
        }
N
Niels Lohmann 已提交
3031 3032

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

N
Niels 已提交
3035
    /// get a pointer to the value (object)
N
Niels Lohmann 已提交
3036
    object_t* get_impl_ptr(object_t* /*unused*/) noexcept
N
Niels 已提交
3037 3038 3039 3040
    {
        return is_object() ? m_value.object : nullptr;
    }

N
Niels 已提交
3041
    /// get a pointer to the value (object)
N
Niels Lohmann 已提交
3042
    constexpr const object_t* get_impl_ptr(const object_t* /*unused*/) const noexcept
N
Niels 已提交
3043 3044 3045 3046 3047
    {
        return is_object() ? m_value.object : nullptr;
    }

    /// get a pointer to the value (array)
N
Niels Lohmann 已提交
3048
    array_t* get_impl_ptr(array_t* /*unused*/) noexcept
N
Niels 已提交
3049 3050 3051 3052
    {
        return is_array() ? m_value.array : nullptr;
    }

N
Niels 已提交
3053
    /// get a pointer to the value (array)
N
Niels Lohmann 已提交
3054
    constexpr const array_t* get_impl_ptr(const array_t* /*unused*/) const noexcept
N
Niels 已提交
3055 3056 3057 3058 3059
    {
        return is_array() ? m_value.array : nullptr;
    }

    /// get a pointer to the value (string)
N
Niels Lohmann 已提交
3060
    string_t* get_impl_ptr(string_t* /*unused*/) noexcept
N
Niels 已提交
3061 3062 3063 3064 3065
    {
        return is_string() ? m_value.string : nullptr;
    }

    /// get a pointer to the value (string)
N
Niels Lohmann 已提交
3066
    constexpr const string_t* get_impl_ptr(const string_t* /*unused*/) const noexcept
N
Niels 已提交
3067 3068 3069 3070 3071
    {
        return is_string() ? m_value.string : nullptr;
    }

    /// get a pointer to the value (boolean)
N
Niels Lohmann 已提交
3072
    boolean_t* get_impl_ptr(boolean_t* /*unused*/) noexcept
N
Niels 已提交
3073 3074 3075 3076 3077
    {
        return is_boolean() ? &m_value.boolean : nullptr;
    }

    /// get a pointer to the value (boolean)
N
Niels Lohmann 已提交
3078
    constexpr const boolean_t* get_impl_ptr(const boolean_t* /*unused*/) const noexcept
N
Niels 已提交
3079 3080 3081 3082 3083
    {
        return is_boolean() ? &m_value.boolean : nullptr;
    }

    /// get a pointer to the value (integer number)
N
Niels Lohmann 已提交
3084
    number_integer_t* get_impl_ptr(number_integer_t* /*unused*/) noexcept
N
Niels 已提交
3085 3086 3087 3088 3089
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }

    /// get a pointer to the value (integer number)
N
Niels Lohmann 已提交
3090
    constexpr const number_integer_t* get_impl_ptr(const number_integer_t* /*unused*/) const noexcept
N
Niels 已提交
3091 3092 3093
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }
N
Niels 已提交
3094

3095
    /// get a pointer to the value (unsigned number)
N
Niels Lohmann 已提交
3096
    number_unsigned_t* get_impl_ptr(number_unsigned_t* /*unused*/) noexcept
3097 3098 3099
    {
        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
    }
N
Niels 已提交
3100

3101
    /// get a pointer to the value (unsigned number)
N
Niels Lohmann 已提交
3102
    constexpr const number_unsigned_t* get_impl_ptr(const number_unsigned_t* /*unused*/) const noexcept
3103 3104 3105
    {
        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
    }
N
Niels 已提交
3106

N
Niels 已提交
3107
    /// get a pointer to the value (floating-point number)
N
Niels Lohmann 已提交
3108
    number_float_t* get_impl_ptr(number_float_t* /*unused*/) noexcept
N
Niels 已提交
3109 3110 3111 3112 3113
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

    /// get a pointer to the value (floating-point number)
N
Niels Lohmann 已提交
3114
    constexpr const number_float_t* get_impl_ptr(const number_float_t* /*unused*/) const noexcept
N
Niels 已提交
3115 3116 3117 3118
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

N
Niels 已提交
3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130
    /*!
    @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>
3131
    static ReferenceType get_ref_impl(ThisType& obj)
D
dariomt 已提交
3132
    {
N
Niels 已提交
3133
        // helper type
N
Niels 已提交
3134 3135
        using PointerType = typename std::add_pointer<ReferenceType>::type;

N
Niels 已提交
3136
        // delegate the call to get_ptr<>()
3137 3138 3139 3140 3141 3142
        auto ptr = obj.template get_ptr<PointerType>();

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

3144 3145
        JSON_THROW(std::domain_error("incompatible ReferenceType for get_ref, actual type is " +
                                     obj.type_name()));
D
dariomt 已提交
3146 3147
    }

N
Niels 已提交
3148
  public:
N
Niels Lohmann 已提交
3149 3150 3151 3152
    /// @name value access
    /// Direct access to the stored value of a JSON value.
    /// @{

T
Théo DELRIEU 已提交
3153 3154 3155
    /*!
    @brief get special-case overload

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

N
Niels Lohmann 已提交
3159
    @tparam BasicJsonType == @ref basic_json
T
Théo DELRIEU 已提交
3160 3161 3162 3163 3164 3165 3166

    @return a copy of *this

    @complexity Constant.

    @since version 2.1.0
    */
3167
    template <
N
Niels Lohmann 已提交
3168 3169
        typename BasicJsonType,
        detail::enable_if_t<std::is_same<typename std::remove_const<BasicJsonType>::type,
3170 3171
                                         basic_json_t>::value,
                            int> = 0 >
3172 3173
    basic_json get() const
    {
T
Théo DELRIEU 已提交
3174
        return *this;
3175 3176
    }

T
Théo DELRIEU 已提交
3177
    /*!
N
Niels Lohmann 已提交
3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191
    @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 已提交
3192 3193

    This overloads is chosen if:
N
Niels Lohmann 已提交
3194 3195 3196 3197 3198 3199 3200 3201
    - @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 已提交
3202

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

N
Niels Lohmann 已提交
3205 3206 3207 3208 3209 3210 3211 3212
    @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 已提交
3213 3214 3215

    @since version 2.1.0
    */
T
Théo DELRIEU 已提交
3216
    template <
N
Niels Lohmann 已提交
3217 3218
        typename ValueTypeCV,
        typename ValueType = detail::uncvref_t<ValueTypeCV>,
3219
        detail::enable_if_t <
N
Niels Lohmann 已提交
3220 3221 3222
            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 已提交
3223
            int > = 0 >
N
Niels Lohmann 已提交
3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236
    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 已提交
3237
        return ret;
3238
    }
3239

T
Théo DELRIEU 已提交
3240
    /*!
N
Niels Lohmann 已提交
3241 3242 3243 3244 3245 3246 3247
    @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 已提交
3248

N
Niels Lohmann 已提交
3249 3250 3251 3252
    The function is equivalent to executing
    @code {.cpp}
    return JSONSerializer<ValueTypeCV>::from_json(*this);
    @endcode
T
Théo DELRIEU 已提交
3253 3254

    This overloads is chosen if:
N
Niels Lohmann 已提交
3255 3256 3257 3258 3259 3260 3261 3262 3263
    - @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 已提交
3264

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

N
Niels Lohmann 已提交
3267
    @throw what @ref json_serializer<ValueType> `from_json()` method throws
T
Théo DELRIEU 已提交
3268 3269 3270

    @since version 2.1.0
    */
3271
    template <
N
Niels Lohmann 已提交
3272 3273 3274
        typename ValueTypeCV,
        typename ValueType = detail::uncvref_t<ValueTypeCV>,
        detail::enable_if_t<not std::is_same<basic_json_t, ValueType>::value and
3275
                            detail::has_non_default_from_json<basic_json_t,
N
Niels Lohmann 已提交
3276 3277 3278
                                    ValueType>::value, int> = 0 >
    ValueType get() const noexcept(noexcept(
                                       JSONSerializer<ValueTypeCV>::from_json(std::declval<const basic_json_t&>())))
3279
    {
N
Niels Lohmann 已提交
3280 3281 3282
        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);
3283 3284
    }

N
Niels 已提交
3285 3286 3287 3288 3289 3290
    /*!
    @brief get a pointer value (explicit)

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

N
Niels 已提交
3291 3292
    @warning The pointer becomes invalid if the underlying JSON object
    changes.
N
Niels 已提交
3293 3294

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

N
Niels 已提交
3298 3299
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
3300 3301 3302 3303 3304 3305 3306 3307 3308

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

N
Niels 已提交
3310
    @since version 1.0.0
N
Niels 已提交
3311
    */
N
Niels 已提交
3312 3313
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3314 3315 3316 3317 3318 3319 3320 3321 3322 3323
    PointerType get() noexcept
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

    /*!
    @brief get a pointer value (explicit)
    @copydoc get()
    */
N
Niels 已提交
3324 3325
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3326
    constexpr const PointerType get() const noexcept
N
Niels 已提交
3327 3328 3329 3330 3331 3332 3333 3334
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

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

N
Niels 已提交
3335
    Implicit pointer access to the internally stored JSON value. No copies are
N
Niels 已提交
3336 3337 3338 3339 3340 3341
    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 已提交
3342
    object_t, @ref string_t, @ref boolean_t, @ref number_integer_t,
N
Niels 已提交
3343 3344
    @ref number_unsigned_t, or @ref number_float_t. Enforced by a static
    assertion.
N
Niels 已提交
3345

N
Niels 已提交
3346 3347
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
3348 3349 3350 3351 3352 3353 3354

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

N
Niels 已提交
3356
    @since version 1.0.0
N
Niels 已提交
3357
    */
N
Niels 已提交
3358 3359
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3360 3361
    PointerType get_ptr() noexcept
    {
N
Niels 已提交
3362 3363
        // get the type of the PointerType (remove pointer and const)
        using pointee_t = typename std::remove_const<typename
T
Théo DELRIEU 已提交
3364 3365
                          std::remove_pointer<typename
                          std::remove_const<PointerType>::type>::type>::type;
N
Niels 已提交
3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376
        // 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 已提交
3377 3378 3379 3380 3381 3382 3383 3384
        // 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 已提交
3385 3386 3387
    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 已提交
3388
    constexpr const PointerType get_ptr() const noexcept
N
Niels 已提交
3389
    {
N
Niels 已提交
3390 3391
        // get the type of the PointerType (remove pointer and const)
        using pointee_t = typename std::remove_const<typename
T
Théo DELRIEU 已提交
3392 3393
                          std::remove_pointer<typename
                          std::remove_const<PointerType>::type>::type>::type;
N
Niels 已提交
3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404
        // 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 已提交
3405
        // delegate the call to get_impl_ptr<>() const
D
dariomt 已提交
3406
        return get_impl_ptr(static_cast<const PointerType>(nullptr));
D
dariomt 已提交
3407 3408
    }

N
Niels 已提交
3409
    /*!
D
dariomt 已提交
3410 3411
    @brief get a reference value (implicit)

N
Niels Lohmann 已提交
3412
    Implicit reference access to the internally stored JSON value. No copies
N
Niels 已提交
3413
    are made.
D
dariomt 已提交
3414 3415 3416 3417

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

N
Niels 已提交
3418 3419
    @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 已提交
3420
    @ref number_float_t. Enforced by static assertion.
D
dariomt 已提交
3421

N
Niels 已提交
3422 3423 3424
    @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 已提交
3425

N
Niels 已提交
3426 3427
    @throw std::domain_error in case passed type @a ReferenceType is
    incompatible with the stored JSON value
D
dariomt 已提交
3428 3429

    @complexity Constant.
N
Niels 已提交
3430 3431 3432

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

N
Niels 已提交
3433
    @since version 1.1.0
D
dariomt 已提交
3434
    */
N
Niels 已提交
3435 3436
    template<typename ReferenceType, typename std::enable_if<
                 std::is_reference<ReferenceType>::value, int>::type = 0>
D
dariomt 已提交
3437 3438
    ReferenceType get_ref()
    {
N
Niels 已提交
3439 3440
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
D
dariomt 已提交
3441 3442 3443 3444 3445 3446
    }

    /*!
    @brief get a reference value (implicit)
    @copydoc get_ref()
    */
N
Niels 已提交
3447 3448 3449
    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>
3450
    ReferenceType get_ref() const
D
dariomt 已提交
3451
    {
N
Niels 已提交
3452 3453
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
N
Niels 已提交
3454 3455 3456 3457 3458
    }

    /*!
    @brief get a value (implicit)

N
Niels 已提交
3459 3460
    Implicit type conversion between the JSON value and a compatible value.
    The call is realized by calling @ref get() const.
N
Niels 已提交
3461 3462 3463

    @tparam ValueType non-pointer type compatible to the JSON value, for
    instance `int` for JSON integer numbers, `bool` for JSON booleans, or
N
Niels 已提交
3464 3465 3466
    `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 已提交
3467 3468 3469 3470 3471 3472 3473 3474

    @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 已提交
3475
    @liveexample{The example below shows several conversions from JSON values
N
Niels 已提交
3476 3477 3478
    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 已提交
3479
    associative containers such as `std::unordered_map<std::string\,
N
Niels 已提交
3480
    json>`.,operator__ValueType}
N
Niels 已提交
3481

N
Niels 已提交
3482
    @since version 1.0.0
N
Niels 已提交
3483
    */
N
Niels 已提交
3484 3485 3486
    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 已提交
3487
#ifndef _MSC_VER  // fix for issue #167 operator<< ambiguity under VS2015
N
Niels 已提交
3488
                   and not std::is_same<ValueType, std::initializer_list<typename string_t::value_type>>::value
3489
#endif
N
Niels 已提交
3490
                   , int >::type = 0 >
N
Niels 已提交
3491
    operator ValueType() const
N
Niels 已提交
3492
    {
N
Niels 已提交
3493 3494
        // delegate the call to get<>() const
        return get<ValueType>();
N
Niels 已提交
3495 3496
    }

N
Niels 已提交
3497 3498
    /// @}

N
Niels 已提交
3499 3500 3501 3502 3503

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

N
Niels 已提交
3504
    /// @name element access
N
Niels 已提交
3505
    /// Access to the JSON value.
N
Niels 已提交
3506 3507
    /// @{

N
Niels 已提交
3508 3509 3510 3511 3512 3513 3514 3515 3516 3517
    /*!
    @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 已提交
3518 3519
    @throw std::domain_error if the JSON value is not an array; example:
    `"cannot use at() with string"`
N
Niels 已提交
3520
    @throw std::out_of_range if the index @a idx is out of range of the array;
N
Niels 已提交
3521
    that is, `idx >= size()`; example: `"array index 7 is out of range"`
N
Niels 已提交
3522 3523 3524 3525

    @complexity Constant.

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

N
Niels 已提交
3528
    @since version 1.0.0
N
Niels 已提交
3529
    */
N
Niels 已提交
3530
    reference at(size_type idx)
N
Niels 已提交
3531 3532
    {
        // at only works for arrays
3533 3534
        if (is_array())
        {
3535
            JSON_TRY
N
Niels 已提交
3536 3537 3538
            {
                return m_value.array->at(idx);
            }
3539
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3540 3541
            {
                // create better exception explanation
3542
                JSON_THROW(std::out_of_range("array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
3543
            }
3544 3545
        }
        else
N
Niels 已提交
3546
        {
3547
            JSON_THROW(std::domain_error("cannot use at() with " + type_name()));
N
Niels 已提交
3548 3549 3550
        }
    }

N
Niels 已提交
3551 3552 3553
    /*!
    @brief access specified array element with bounds checking

N
Niels 已提交
3554 3555
    Returns a const reference to the element at specified location @a idx,
    with bounds checking.
N
Niels 已提交
3556 3557 3558 3559 3560

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

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

N
Niels 已提交
3561 3562
    @throw std::domain_error if the JSON value is not an array; example:
    `"cannot use at() with string"`
N
Niels 已提交
3563
    @throw std::out_of_range if the index @a idx is out of range of the array;
N
Niels 已提交
3564
    that is, `idx >= size()`; example: `"array index 7 is out of range"`
N
Niels 已提交
3565 3566 3567 3568

    @complexity Constant.

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

N
Niels 已提交
3571
    @since version 1.0.0
N
Niels 已提交
3572
    */
N
Niels 已提交
3573
    const_reference at(size_type idx) const
N
Niels 已提交
3574 3575
    {
        // at only works for arrays
3576 3577
        if (is_array())
        {
3578
            JSON_TRY
N
Niels 已提交
3579 3580 3581
            {
                return m_value.array->at(idx);
            }
3582
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3583 3584
            {
                // create better exception explanation
3585
                JSON_THROW(std::out_of_range("array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
3586
            }
3587 3588
        }
        else
N
Niels 已提交
3589
        {
3590
            JSON_THROW(std::domain_error("cannot use at() with " + type_name()));
N
Niels 已提交
3591
        }
3592 3593
    }

N
Niels 已提交
3594 3595 3596 3597 3598 3599 3600 3601 3602 3603
    /*!
    @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 已提交
3604 3605
    @throw std::domain_error if the JSON value is not an object; example:
    `"cannot use at() with boolean"`
N
Niels 已提交
3606
    @throw std::out_of_range if the key @a key is is not stored in the object;
N
Niels 已提交
3607
    that is, `find(key) == end()`; example: `"key "the fast" not found"`
N
Niels 已提交
3608 3609 3610 3611

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3612
    written using `at()`.,at__object_t_key_type}
N
Niels 已提交
3613 3614 3615 3616

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

N
Niels 已提交
3618
    @since version 1.0.0
N
Niels 已提交
3619
    */
N
Niels 已提交
3620
    reference at(const typename object_t::key_type& key)
3621 3622
    {
        // at only works for objects
3623 3624
        if (is_object())
        {
3625
            JSON_TRY
N
Niels 已提交
3626 3627 3628
            {
                return m_value.object->at(key);
            }
3629
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3630 3631
            {
                // create better exception explanation
3632
                JSON_THROW(std::out_of_range("key '" + key + "' not found"));
N
Niels 已提交
3633
            }
3634 3635
        }
        else
3636
        {
3637
            JSON_THROW(std::domain_error("cannot use at() with " + type_name()));
3638 3639 3640
        }
    }

N
Niels 已提交
3641 3642 3643
    /*!
    @brief access specified object element with bounds checking

N
Niels 已提交
3644 3645
    Returns a const reference to the element at with specified key @a key,
    with bounds checking.
N
Niels 已提交
3646 3647 3648 3649 3650

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

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

N
Niels 已提交
3651 3652
    @throw std::domain_error if the JSON value is not an object; example:
    `"cannot use at() with boolean"`
N
Niels 已提交
3653
    @throw std::out_of_range if the key @a key is is not stored in the object;
N
Niels 已提交
3654
    that is, `find(key) == end()`; example: `"key "the fast" not found"`
N
Niels 已提交
3655 3656 3657 3658

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3659
    `at()`.,at__object_t_key_type_const}
N
Niels 已提交
3660 3661 3662 3663

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

N
Niels 已提交
3665
    @since version 1.0.0
N
Niels 已提交
3666
    */
N
Niels 已提交
3667
    const_reference at(const typename object_t::key_type& key) const
3668 3669
    {
        // at only works for objects
3670 3671
        if (is_object())
        {
3672
            JSON_TRY
N
Niels 已提交
3673 3674 3675
            {
                return m_value.object->at(key);
            }
3676
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3677 3678
            {
                // create better exception explanation
3679
                JSON_THROW(std::out_of_range("key '" + key + "' not found"));
N
Niels 已提交
3680
            }
3681 3682
        }
        else
3683
        {
3684
            JSON_THROW(std::domain_error("cannot use at() with " + type_name()));
3685
        }
N
Niels 已提交
3686 3687
    }

N
Niels 已提交
3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700
    /*!
    @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 已提交
3701 3702
    @throw std::domain_error if JSON is not an array or null; example:
    `"cannot use operator[] with string"`
N
Niels 已提交
3703 3704 3705 3706 3707

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

N
Niels 已提交
3711
    @since version 1.0.0
N
Niels 已提交
3712
    */
N
Niels 已提交
3713
    reference operator[](size_type idx)
N
Niels 已提交
3714
    {
N
Niels 已提交
3715
        // implicitly convert null value to an empty array
N
cleanup  
Niels 已提交
3716
        if (is_null())
N
Niels 已提交
3717 3718
        {
            m_type = value_t::array;
N
Cleanup  
Niels 已提交
3719
            m_value.array = create<array_t>();
3720
            assert_invariant();
N
Niels 已提交
3721 3722
        }

N
Niels 已提交
3723
        // operator[] only works for arrays
N
cleanup  
Niels 已提交
3724
        if (is_array())
N
Niels 已提交
3725
        {
N
Niels 已提交
3726 3727
            // fill up array with null values if given idx is outside range
            if (idx >= m_value.array->size())
N
cleanup  
Niels 已提交
3728
            {
N
Niels 已提交
3729 3730 3731
                m_value.array->insert(m_value.array->end(),
                                      idx - m_value.array->size() + 1,
                                      basic_json());
N
cleanup  
Niels 已提交
3732
            }
N
Niels 已提交
3733

N
cleanup  
Niels 已提交
3734 3735
            return m_value.array->operator[](idx);
        }
N
Niels Lohmann 已提交
3736

3737
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
N
Niels 已提交
3738 3739
    }

N
Niels 已提交
3740 3741 3742 3743 3744 3745 3746 3747 3748
    /*!
    @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 已提交
3749 3750
    @throw std::domain_error if JSON is not an array; example: `"cannot use
    operator[] with null"`
N
Niels 已提交
3751 3752 3753 3754

    @complexity Constant.

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

N
Niels 已提交
3757
    @since version 1.0.0
N
Niels 已提交
3758
    */
N
Niels 已提交
3759
    const_reference operator[](size_type idx) const
N
Niels 已提交
3760
    {
N
Niels 已提交
3761
        // const operator[] only works for arrays
N
Niels 已提交
3762 3763 3764 3765
        if (is_array())
        {
            return m_value.array->operator[](idx);
        }
N
Niels Lohmann 已提交
3766

3767
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
N
Niels 已提交
3768 3769
    }

N
Niels 已提交
3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782
    /*!
    @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 已提交
3783
    @throw std::domain_error if JSON is not an object or null; example:
N
Niels 已提交
3784
    `"cannot use operator[] with string"`
N
Niels 已提交
3785 3786 3787 3788

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3789
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
3790 3791 3792 3793

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

N
Niels 已提交
3795
    @since version 1.0.0
N
Niels 已提交
3796
    */
N
Niels 已提交
3797
    reference operator[](const typename object_t::key_type& key)
N
Niels 已提交
3798
    {
N
Niels 已提交
3799
        // implicitly convert null value to an empty object
N
cleanup  
Niels 已提交
3800
        if (is_null())
N
Niels 已提交
3801 3802
        {
            m_type = value_t::object;
N
Cleanup  
Niels 已提交
3803
            m_value.object = create<object_t>();
3804
            assert_invariant();
N
Niels 已提交
3805 3806
        }

N
Niels 已提交
3807
        // operator[] only works for objects
N
Niels 已提交
3808 3809 3810 3811
        if (is_object())
        {
            return m_value.object->operator[](key);
        }
N
Niels Lohmann 已提交
3812

3813
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
N
Niels 已提交
3814 3815
    }

N
Niels 已提交
3816
    /*!
3817
    @brief read-only access specified object element
N
Niels 已提交
3818

3819 3820 3821 3822 3823
    Returns a const reference to the element at with specified key @a key. No
    bounds checking is performed.

    @warning If the element with key @a key does not exist, the behavior is
    undefined.
N
Niels 已提交
3824 3825 3826

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

3827
    @return const reference to the element at key @a key
N
Niels 已提交
3828

N
Niels 已提交
3829 3830 3831
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

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

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3838
    the `[]` operator.,operatorarray__key_type_const}
3839 3840 3841 3842 3843

    @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 已提交
3844
    @since version 1.0.0
N
Niels 已提交
3845
    */
N
Niels 已提交
3846
    const_reference operator[](const typename object_t::key_type& key) const
3847
    {
N
Niels 已提交
3848
        // const operator[] only works for objects
N
Niels 已提交
3849 3850 3851 3852 3853
        if (is_object())
        {
            assert(m_value.object->find(key) != m_value.object->end());
            return m_value.object->find(key)->second;
        }
N
Niels Lohmann 已提交
3854

3855
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
3856 3857
    }

N
Niels 已提交
3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870
    /*!
    @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 已提交
3871
    @throw std::domain_error if JSON is not an object or null; example:
N
Niels 已提交
3872
    `"cannot use operator[] with string"`
N
Niels 已提交
3873 3874 3875 3876

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3877
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
3878 3879 3880 3881

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

N
Niels 已提交
3883
    @since version 1.0.0
N
Niels 已提交
3884
    */
N
Niels 已提交
3885
    template<typename T, std::size_t n>
N
Niels 已提交
3886
    reference operator[](T * (&key)[n])
3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911
    {
        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 已提交
3912
    the `[]` operator.,operatorarray__key_type_const}
3913 3914 3915 3916 3917 3918 3919 3920

    @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 已提交
3921
    const_reference operator[](T * (&key)[n]) const
3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939
    {
        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 已提交
3940
    `"cannot use operator[] with string"`
3941 3942 3943 3944

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3945
    written using the `[]` operator.,operatorarray__key_type}
3946 3947 3948 3949 3950

    @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 已提交
3951
    @since version 1.1.0
3952 3953 3954
    */
    template<typename T>
    reference operator[](T* key)
N
Niels 已提交
3955
    {
N
Niels 已提交
3956
        // implicitly convert null to object
N
cleanup  
Niels 已提交
3957
        if (is_null())
N
Niels 已提交
3958 3959
        {
            m_type = value_t::object;
N
Niels 已提交
3960
            m_value = value_t::object;
3961
            assert_invariant();
N
Niels 已提交
3962 3963
        }

N
Niels 已提交
3964
        // at only works for objects
N
Niels 已提交
3965 3966 3967 3968
        if (is_object())
        {
            return m_value.object->operator[](key);
        }
N
Niels Lohmann 已提交
3969

3970
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
N
Niels 已提交
3971 3972
    }

N
Niels 已提交
3973
    /*!
3974
    @brief read-only access specified object element
N
Niels 已提交
3975

3976 3977 3978 3979 3980
    Returns a const reference to the element at with specified key @a key. No
    bounds checking is performed.

    @warning If the element with key @a key does not exist, the behavior is
    undefined.
N
Niels 已提交
3981 3982 3983

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

3984
    @return const reference to the element at key @a key
N
Niels 已提交
3985

N
Niels 已提交
3986 3987 3988
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

N
Niels 已提交
3989 3990
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    operator[] with null"`
N
Niels 已提交
3991 3992 3993 3994

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3995
    the `[]` operator.,operatorarray__key_type_const}
3996 3997 3998 3999 4000

    @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 已提交
4001
    @since version 1.1.0
N
Niels 已提交
4002
    */
4003 4004
    template<typename T>
    const_reference operator[](T* key) const
4005 4006
    {
        // at only works for objects
N
Niels 已提交
4007 4008 4009 4010 4011
        if (is_object())
        {
            assert(m_value.object->find(key) != m_value.object->end());
            return m_value.object->find(key)->second;
        }
N
Niels Lohmann 已提交
4012

4013
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
4014 4015
    }

N
Niels 已提交
4016 4017 4018
    /*!
    @brief access specified object element with default value

N
Niels 已提交
4019 4020
    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.
4021

N
Niels 已提交
4022
    The function is basically equivalent to executing
4023
    @code {.cpp}
N
Niels 已提交
4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048
    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 已提交
4049 4050
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    value() with null"`
N
Niels 已提交
4051 4052 4053 4054 4055 4056 4057 4058 4059 4060

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

N
Niels 已提交
4062
    @since version 1.0.0
N
Niels 已提交
4063
    */
N
Niels 已提交
4064 4065
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076
    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 已提交
4077 4078

            return default_value;
N
Niels 已提交
4079 4080 4081
        }
        else
        {
4082
            JSON_THROW(std::domain_error("cannot use value() with " + type_name()));
N
Niels 已提交
4083 4084 4085 4086
        }
    }

    /*!
N
Niels 已提交
4087
    @brief overload for a default value of type const char*
N
Niels 已提交
4088
    @copydoc basic_json::value(const typename object_t::key_type&, ValueType) const
N
Niels 已提交
4089 4090 4091 4092
    */
    string_t value(const typename object_t::key_type& key, const char* default_value) const
    {
        return value(key, string_t(default_value));
4093 4094
    }

N
Niels 已提交
4095 4096 4097
    /*!
    @brief access specified object element via JSON Pointer with default value

N
Niels 已提交
4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112
    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 已提交
4113 4114 4115 4116 4117 4118 4119 4120
    @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 已提交
4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131
    @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 已提交
4132
    @sa @ref operator[](const json_pointer&) for unchecked access by reference
N
Niels 已提交
4133

N
Niels 已提交
4134 4135
    @since version 2.0.2
    */
N
Niels 已提交
4136 4137
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
4138 4139 4140 4141 4142 4143
    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
4144
            JSON_TRY
N
Niels 已提交
4145 4146 4147
            {
                return ptr.get_checked(this);
            }
4148
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
4149 4150 4151 4152
            {
                return default_value;
            }
        }
N
Niels Lohmann 已提交
4153

4154
        JSON_THROW(std::domain_error("cannot use value() with " + type_name()));
N
Niels 已提交
4155 4156 4157 4158
    }

    /*!
    @brief overload for a default value of type const char*
N
Niels 已提交
4159
    @copydoc basic_json::value(const json_pointer&, ValueType) const
N
Niels 已提交
4160 4161 4162 4163 4164 4165
    */
    string_t value(const json_pointer& ptr, const char* default_value) const
    {
        return value(ptr, string_t(default_value));
    }

N
Niels 已提交
4166 4167 4168 4169 4170 4171
    /*!
    @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 已提交
4172
    @return In case of a structured type (array or object), a reference to the
4173
    first element is returned. In case of number, string, or boolean values, a
N
Niels 已提交
4174 4175 4176 4177
    reference to the value is returned.

    @complexity Constant.

N
Niels 已提交
4178
    @pre The JSON value must not be `null` (would throw `std::out_of_range`)
N
Niels 已提交
4179 4180
    or an empty array or object (undefined behavior, **guarded by
    assertions**).
N
Niels 已提交
4181 4182 4183
    @post The JSON value remains unchanged.

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

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

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

N
Niels 已提交
4189
    @since version 1.0.0
N
Niels 已提交
4190
    */
N
Niels 已提交
4191
    reference front()
N
Niels 已提交
4192 4193 4194 4195
    {
        return *begin();
    }

N
Niels 已提交
4196 4197 4198
    /*!
    @copydoc basic_json::front()
    */
N
Niels 已提交
4199
    const_reference front() const
N
Niels 已提交
4200 4201 4202 4203
    {
        return *cbegin();
    }

N
Niels 已提交
4204 4205 4206 4207
    /*!
    @brief access the last element

    Returns a reference to the last element in the container. For a JSON
N
Niels 已提交
4208 4209 4210 4211 4212 4213
    container `c`, the expression `c.back()` is equivalent to
    @code {.cpp}
    auto tmp = c.end();
    --tmp;
    return *tmp;
    @endcode
N
Niels 已提交
4214

N
Niels 已提交
4215
    @return In case of a structured type (array or object), a reference to the
4216
    last element is returned. In case of number, string, or boolean values, a
N
Niels 已提交
4217 4218 4219 4220
    reference to the value is returned.

    @complexity Constant.

N
Niels 已提交
4221
    @pre The JSON value must not be `null` (would throw `std::out_of_range`)
N
Niels 已提交
4222 4223
    or an empty array or object (undefined behavior, **guarded by
    assertions**).
N
Niels 已提交
4224
    @post The JSON value remains unchanged.
N
Niels 已提交
4225

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

N
Niels 已提交
4228 4229 4230
    @liveexample{The following code shows an example for `back()`.,back}

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

N
Niels 已提交
4232
    @since version 1.0.0
N
Niels 已提交
4233
    */
N
Niels 已提交
4234
    reference back()
N
Niels 已提交
4235 4236 4237 4238 4239 4240
    {
        auto tmp = end();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
4241 4242 4243
    /*!
    @copydoc basic_json::back()
    */
N
Niels 已提交
4244
    const_reference back() const
N
Niels 已提交
4245 4246 4247 4248 4249 4250
    {
        auto tmp = cend();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
4251 4252 4253
    /*!
    @brief remove element given an iterator

N
Niels 已提交
4254 4255 4256
    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 已提交
4257

N
Niels 已提交
4258
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
4259 4260 4261
    will be `null`.

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

4265
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
4266

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

N
Niels 已提交
4270 4271
    @throw std::domain_error if called on a `null` value; example: `"cannot
    use erase() with null"`
N
Niels 已提交
4272
    @throw std::domain_error if called on an iterator which does not belong to
N
Niels 已提交
4273
    the current JSON value; example: `"iterator does not fit current value"`
N
Niels 已提交
4274
    @throw std::out_of_range if called on a primitive type with invalid
N
Niels 已提交
4275 4276
    iterator (i.e., any iterator which is not `begin()`); example: `"iterator
    out of range"`
N
Niels 已提交
4277 4278 4279

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

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

4287
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4288
    the given range
N
Niels 已提交
4289
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4290
    from an object at the given key
N
Niels 已提交
4291 4292
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4293

N
Niels 已提交
4294
    @since version 1.0.0
N
Niels 已提交
4295
    */
N
Niels 已提交
4296 4297 4298 4299
    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>
4300
    IteratorType erase(IteratorType pos)
4301 4302
    {
        // make sure iterator fits the current value
N
Niels 已提交
4303
        if (this != pos.m_object)
4304
        {
4305
            JSON_THROW(std::domain_error("iterator does not fit current value"));
4306 4307
        }

4308
        IteratorType result = end();
4309 4310 4311 4312

        switch (m_type)
        {
            case value_t::boolean:
4313 4314
            case value_t::number_float:
            case value_t::number_integer:
4315
            case value_t::number_unsigned:
4316 4317
            case value_t::string:
            {
4318
                if (not pos.m_it.primitive_iterator.is_begin())
4319
                {
4320
                    JSON_THROW(std::out_of_range("iterator out of range"));
4321 4322
                }

N
cleanup  
Niels 已提交
4323
                if (is_string())
4324
                {
4325 4326 4327
                    AllocatorType<string_t> alloc;
                    alloc.destroy(m_value.string);
                    alloc.deallocate(m_value.string, 1);
4328 4329 4330 4331
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
4332
                assert_invariant();
4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349
                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:
            {
4350
                JSON_THROW(std::domain_error("cannot use erase() with " + type_name()));
4351 4352 4353 4354 4355 4356
            }
        }

        return result;
    }

N
Niels 已提交
4357 4358 4359
    /*!
    @brief remove elements given an iterator range

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

N
Niels 已提交
4364
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
4365 4366 4367 4368 4369
    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 已提交
4370
    second refers to the last element, the `end()` iterator is returned.
N
Niels 已提交
4371

4372
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
4373

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

N
Niels 已提交
4377 4378
    @throw std::domain_error if called on a `null` value; example: `"cannot
    use erase() with null"`
N
Niels 已提交
4379
    @throw std::domain_error if called on iterators which does not belong to
N
Niels 已提交
4380
    the current JSON value; example: `"iterators do not fit current value"`
N
Niels 已提交
4381
    @throw std::out_of_range if called on a primitive type with invalid
N
Niels 已提交
4382 4383
    iterators (i.e., if `first != begin()` and `last != end()`); example:
    `"iterators out of range"`
N
Niels 已提交
4384 4385 4386 4387 4388 4389 4390 4391

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

4395
    @sa @ref erase(IteratorType) -- removes the element at a given position
N
Niels 已提交
4396
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4397
    from an object at the given key
N
Niels 已提交
4398 4399
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4400

N
Niels 已提交
4401
    @since version 1.0.0
N
Niels 已提交
4402
    */
N
Niels 已提交
4403 4404 4405 4406
    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>
4407
    IteratorType erase(IteratorType first, IteratorType last)
4408 4409
    {
        // make sure iterator fits the current value
N
Niels 已提交
4410
        if (this != first.m_object or this != last.m_object)
4411
        {
4412
            JSON_THROW(std::domain_error("iterators do not fit current value"));
4413 4414
        }

4415
        IteratorType result = end();
4416 4417 4418 4419

        switch (m_type)
        {
            case value_t::boolean:
4420 4421
            case value_t::number_float:
            case value_t::number_integer:
4422
            case value_t::number_unsigned:
4423 4424
            case value_t::string:
            {
4425
                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
4426
                {
4427
                    JSON_THROW(std::out_of_range("iterators out of range"));
4428 4429
                }

N
cleanup  
Niels 已提交
4430
                if (is_string())
4431
                {
4432 4433 4434
                    AllocatorType<string_t> alloc;
                    alloc.destroy(m_value.string);
                    alloc.deallocate(m_value.string, 1);
4435 4436 4437 4438
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
4439
                assert_invariant();
4440 4441 4442 4443 4444 4445
                break;
            }

            case value_t::object:
            {
                result.m_it.object_iterator = m_value.object->erase(first.m_it.object_iterator,
T
Théo DELRIEU 已提交
4446
                                              last.m_it.object_iterator);
4447 4448 4449 4450 4451 4452
                break;
            }

            case value_t::array:
            {
                result.m_it.array_iterator = m_value.array->erase(first.m_it.array_iterator,
T
Théo DELRIEU 已提交
4453
                                             last.m_it.array_iterator);
4454 4455 4456 4457 4458
                break;
            }

            default:
            {
4459
                JSON_THROW(std::domain_error("cannot use erase() with " + type_name()));
4460 4461 4462 4463 4464 4465
            }
        }

        return result;
    }

N
Niels 已提交
4466 4467 4468 4469 4470 4471 4472
    /*!
    @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 已提交
4473
    @return Number of elements removed. If @a ObjectType is the default
N
Niels 已提交
4474 4475
    `std::map` type, the return value will always be `0` (@a key was not
    found) or `1` (@a key was found).
N
Niels 已提交
4476 4477 4478

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

N
Niels 已提交
4480 4481
    @throw std::domain_error when called on a type other than JSON object;
    example: `"cannot use erase() with null"`
N
Niels 已提交
4482 4483 4484

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

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

4487 4488
    @sa @ref erase(IteratorType) -- removes the element at a given position
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4489 4490 4491
    the given range
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4492

N
Niels 已提交
4493
    @since version 1.0.0
N
Niels 已提交
4494
    */
N
Niels 已提交
4495
    size_type erase(const typename object_t::key_type& key)
4496
    {
N
Niels 已提交
4497
        // this erase only works for objects
N
Niels 已提交
4498 4499 4500 4501
        if (is_object())
        {
            return m_value.object->erase(key);
        }
N
Niels Lohmann 已提交
4502

4503
        JSON_THROW(std::domain_error("cannot use erase() with " + type_name()));
4504 4505
    }

N
Niels 已提交
4506 4507 4508 4509 4510 4511 4512
    /*!
    @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 已提交
4513 4514
    @throw std::domain_error when called on a type other than JSON array;
    example: `"cannot use erase() with null"`
N
Niels 已提交
4515 4516
    @throw std::out_of_range when `idx >= size()`; example: `"array index 17
    is out of range"`
N
Niels 已提交
4517 4518 4519

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

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

4522 4523
    @sa @ref erase(IteratorType) -- removes the element at a given position
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4524
    the given range
N
Niels 已提交
4525
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4526 4527
    from an object at the given key

N
Niels 已提交
4528
    @since version 1.0.0
N
Niels 已提交
4529
    */
N
Niels 已提交
4530
    void erase(const size_type idx)
N
Niels 已提交
4531 4532
    {
        // this erase only works for arrays
N
cleanup  
Niels 已提交
4533
        if (is_array())
N
Niels 已提交
4534
        {
N
cleanup  
Niels 已提交
4535 4536
            if (idx >= size())
            {
4537
                JSON_THROW(std::out_of_range("array index " + std::to_string(idx) + " is out of range"));
N
cleanup  
Niels 已提交
4538
            }
N
Niels 已提交
4539

N
cleanup  
Niels 已提交
4540 4541 4542
            m_value.array->erase(m_value.array->begin() + static_cast<difference_type>(idx));
        }
        else
N
Niels 已提交
4543
        {
4544
            JSON_THROW(std::domain_error("cannot use erase() with " + type_name()));
N
Niels 已提交
4545 4546 4547
        }
    }

N
Niels 已提交
4548 4549 4550 4551 4552 4553 4554 4555 4556 4557
    /// @}


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

    /// @name lookup
    /// @{

N
Niels 已提交
4558 4559 4560 4561
    /*!
    @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 已提交
4562 4563
    element is not found or the JSON value is not an object, end() is
    returned.
N
Niels 已提交
4564

4565 4566 4567
    @note This method always returns @ref end() when executed on a JSON type
          that is not an object.

N
Niels 已提交
4568 4569 4570
    @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
4571 4572
    element is found or the JSON value is not an object, past-the-end (see
    @ref end()) iterator is returned.
N
Niels 已提交
4573 4574 4575

    @complexity Logarithmic in the size of the JSON object.

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

N
Niels 已提交
4578
    @since version 1.0.0
N
Niels 已提交
4579
    */
N
Niels 已提交
4580
    iterator find(typename object_t::key_type key)
N
Niels 已提交
4581 4582 4583
    {
        auto result = end();

N
cleanup  
Niels 已提交
4584
        if (is_object())
N
Niels 已提交
4585 4586 4587 4588 4589 4590 4591
        {
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4592 4593 4594 4595
    /*!
    @brief find an element in a JSON object
    @copydoc find(typename object_t::key_type)
    */
N
Niels 已提交
4596
    const_iterator find(typename object_t::key_type key) const
N
Niels 已提交
4597 4598 4599
    {
        auto result = cend();

N
cleanup  
Niels 已提交
4600
        if (is_object())
N
Niels 已提交
4601 4602 4603 4604 4605 4606 4607
        {
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4608 4609 4610 4611 4612 4613 4614
    /*!
    @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).

4615 4616 4617
    @note This method always returns `0` when executed on a JSON type that is
          not an object.

N
Niels 已提交
4618 4619 4620 4621 4622 4623 4624
    @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 已提交
4625
    @liveexample{The example shows how `count()` is used.,count}
N
Niels 已提交
4626

N
Niels 已提交
4627
    @since version 1.0.0
N
Niels 已提交
4628
    */
N
Niels 已提交
4629
    size_type count(typename object_t::key_type key) const
4630 4631
    {
        // return 0 for all nonobject types
N
Niels 已提交
4632
        return is_object() ? m_value.object->count(key) : 0;
4633 4634
    }

N
Niels 已提交
4635 4636
    /// @}

N
Niels 已提交
4637

N
Niels 已提交
4638 4639 4640 4641
    ///////////////
    // iterators //
    ///////////////

N
Niels 已提交
4642 4643 4644
    /// @name iterators
    /// @{

N
Niels 已提交
4645 4646
    /*!
    @brief returns an iterator to the first element
N
Niels 已提交
4647 4648 4649 4650 4651 4652 4653 4654 4655

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

N
Niels 已提交
4661 4662 4663 4664 4665
    @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 已提交
4666

N
Niels 已提交
4667
    @since version 1.0.0
N
Niels 已提交
4668
    */
N
Niels 已提交
4669
    iterator begin() noexcept
N
Niels 已提交
4670 4671 4672 4673 4674 4675
    {
        iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4676
    /*!
N
Niels 已提交
4677
    @copydoc basic_json::cbegin()
N
Niels 已提交
4678
    */
N
Niels 已提交
4679
    const_iterator begin() const noexcept
N
Niels 已提交
4680
    {
N
Niels 已提交
4681
        return cbegin();
N
Niels 已提交
4682 4683
    }

N
Niels 已提交
4684 4685
    /*!
    @brief returns a const iterator to the first element
N
Niels 已提交
4686 4687 4688 4689 4690 4691 4692 4693 4694

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

N
Niels 已提交
4701 4702 4703 4704 4705
    @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 已提交
4706

N
Niels 已提交
4707
    @since version 1.0.0
N
Niels 已提交
4708
    */
N
Niels 已提交
4709
    const_iterator cbegin() const noexcept
N
Niels 已提交
4710 4711 4712 4713 4714 4715
    {
        const_iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4716 4717
    /*!
    @brief returns an iterator to one past the last element
N
Niels 已提交
4718 4719 4720 4721 4722 4723 4724 4725 4726

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

N
Niels 已提交
4732 4733 4734 4735 4736
    @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 已提交
4737

N
Niels 已提交
4738
    @since version 1.0.0
N
Niels 已提交
4739
    */
N
Niels 已提交
4740
    iterator end() noexcept
N
Niels 已提交
4741 4742 4743 4744 4745 4746
    {
        iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
4747
    /*!
N
Niels 已提交
4748
    @copydoc basic_json::cend()
N
Niels 已提交
4749
    */
N
Niels 已提交
4750
    const_iterator end() const noexcept
N
Niels 已提交
4751
    {
N
Niels 已提交
4752
        return cend();
N
Niels 已提交
4753 4754
    }

N
Niels 已提交
4755 4756
    /*!
    @brief returns a const iterator to one past the last element
N
Niels 已提交
4757 4758 4759 4760 4761 4762 4763 4764 4765

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

N
Niels 已提交
4772 4773 4774 4775 4776
    @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 已提交
4777

N
Niels 已提交
4778
    @since version 1.0.0
N
Niels 已提交
4779
    */
N
Niels 已提交
4780
    const_iterator cend() const noexcept
N
Niels 已提交
4781 4782 4783 4784 4785 4786
    {
        const_iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
4787
    /*!
N
Niels 已提交
4788 4789 4790 4791 4792 4793 4794 4795
    @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 已提交
4796 4797 4798
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4799 4800 4801
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(end())`.

N
Niels 已提交
4802 4803 4804 4805 4806
    @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 已提交
4807

N
Niels 已提交
4808
    @since version 1.0.0
N
Niels 已提交
4809
    */
N
Niels 已提交
4810
    reverse_iterator rbegin() noexcept
N
Niels 已提交
4811 4812 4813 4814
    {
        return reverse_iterator(end());
    }

N
Niels 已提交
4815
    /*!
N
Niels 已提交
4816
    @copydoc basic_json::crbegin()
N
Niels 已提交
4817
    */
N
Niels 已提交
4818
    const_reverse_iterator rbegin() const noexcept
N
Niels 已提交
4819
    {
N
Niels 已提交
4820
        return crbegin();
N
Niels 已提交
4821 4822
    }

N
Niels 已提交
4823
    /*!
N
Niels 已提交
4824 4825 4826 4827 4828 4829 4830 4831 4832
    @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 已提交
4833 4834 4835
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4836 4837 4838
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(begin())`.

N
Niels 已提交
4839 4840 4841 4842 4843
    @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 已提交
4844

N
Niels 已提交
4845
    @since version 1.0.0
N
Niels 已提交
4846
    */
N
Niels 已提交
4847
    reverse_iterator rend() noexcept
N
Niels 已提交
4848 4849 4850 4851
    {
        return reverse_iterator(begin());
    }

N
Niels 已提交
4852
    /*!
N
Niels 已提交
4853
    @copydoc basic_json::crend()
N
Niels 已提交
4854
    */
N
Niels 已提交
4855
    const_reverse_iterator rend() const noexcept
N
Niels 已提交
4856
    {
N
Niels 已提交
4857
        return crend();
N
Niels 已提交
4858 4859
    }

N
Niels 已提交
4860
    /*!
N
Niels 已提交
4861 4862 4863 4864 4865 4866 4867 4868 4869
    @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 已提交
4870 4871 4872
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4873 4874 4875
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).rbegin()`.

N
Niels 已提交
4876 4877 4878 4879 4880
    @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 已提交
4881

N
Niels 已提交
4882
    @since version 1.0.0
N
Niels 已提交
4883
    */
N
Niels 已提交
4884
    const_reverse_iterator crbegin() const noexcept
N
Niels 已提交
4885 4886 4887 4888
    {
        return const_reverse_iterator(cend());
    }

N
Niels 已提交
4889
    /*!
N
Niels 已提交
4890 4891 4892 4893 4894 4895 4896 4897 4898
    @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 已提交
4899 4900 4901
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4902 4903 4904
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).rend()`.

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

N
Niels 已提交
4911
    @since version 1.0.0
N
Niels 已提交
4912
    */
N
Niels 已提交
4913
    const_reverse_iterator crend() const noexcept
N
Niels 已提交
4914 4915 4916 4917
    {
        return const_reverse_iterator(cbegin());
    }

N
cleanup  
Niels 已提交
4918 4919 4920 4921 4922 4923 4924 4925
  private:
    // forward declaration
    template<typename IteratorType> class iteration_proxy;

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

N
Niels 已提交
4926
    This function allows to access @ref iterator::key() and @ref
N
Niels 已提交
4927 4928 4929
    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 已提交
4930 4931 4932

    @note The name of this function is not yet final and may change in the
    future.
N
cleanup  
Niels 已提交
4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946
    */
    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 已提交
4947 4948
    /// @}

N
Niels 已提交
4949 4950 4951 4952 4953

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

N
Niels 已提交
4954 4955 4956
    /// @name capacity
    /// @{

N
Niels 已提交
4957 4958
    /*!
    @brief checks whether the container is empty
N
Niels 已提交
4959 4960 4961

    Checks if a JSON value has no elements.

N
Niels 已提交
4962
    @return The return value depends on the different types and is
N
Niels 已提交
4963 4964 4965
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
4966 4967 4968 4969 4970 4971
            null        | `true`
            boolean     | `false`
            string      | `false`
            number      | `false`
            object      | result of function `object_t::empty()`
            array       | result of function `array_t::empty()`
N
Niels 已提交
4972

N
Niels 已提交
4973 4974 4975 4976
    @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 已提交
4977 4978
    @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 已提交
4979
    complexity.
N
Niels 已提交
4980

N
Niels 已提交
4981 4982 4983
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
4984 4985 4986
    - The complexity is constant.
    - Has the semantics of `begin() == end()`.

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

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

N
Niels 已提交
4992
    @since version 1.0.0
N
Niels 已提交
4993
    */
N
Niels 已提交
4994
    bool empty() const noexcept
N
Niels 已提交
4995 4996 4997
    {
        switch (m_type)
        {
4998
            case value_t::null:
N
Niels 已提交
4999
            {
N
Niels 已提交
5000
                // null values are empty
N
Niels 已提交
5001 5002
                return true;
            }
N
Niels 已提交
5003

5004
            case value_t::array:
N
Niels 已提交
5005
            {
N
Niels 已提交
5006
                // delegate call to array_t::empty()
N
Niels 已提交
5007 5008
                return m_value.array->empty();
            }
N
Niels 已提交
5009

5010
            case value_t::object:
N
Niels 已提交
5011
            {
N
Niels 已提交
5012
                // delegate call to object_t::empty()
N
Niels 已提交
5013 5014
                return m_value.object->empty();
            }
N
Niels 已提交
5015

N
Niels 已提交
5016 5017 5018 5019 5020 5021
            default:
            {
                // all other types are nonempty
                return false;
            }
        }
N
Niels 已提交
5022 5023
    }

N
Niels 已提交
5024 5025
    /*!
    @brief returns the number of elements
N
Niels 已提交
5026 5027 5028

    Returns the number of elements in a JSON value.

N
Niels 已提交
5029
    @return The return value depends on the different types and is
N
Niels 已提交
5030 5031 5032
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
5033 5034 5035 5036
            null        | `0`
            boolean     | `1`
            string      | `1`
            number      | `1`
N
Niels 已提交
5037 5038 5039
            object      | result of function object_t::size()
            array       | result of function array_t::size()

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

N
Niels 已提交
5048 5049 5050
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
5051 5052 5053
    - The complexity is constant.
    - Has the semantics of `std::distance(begin(), end())`.

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

N
Niels 已提交
5057 5058 5059
    @sa @ref empty() -- checks whether the container is empty
    @sa @ref max_size() -- returns the maximal number of elements

N
Niels 已提交
5060
    @since version 1.0.0
N
Niels 已提交
5061
    */
N
Niels 已提交
5062
    size_type size() const noexcept
N
Niels 已提交
5063 5064 5065
    {
        switch (m_type)
        {
5066
            case value_t::null:
N
Niels 已提交
5067
            {
N
Niels 已提交
5068
                // null values are empty
N
Niels 已提交
5069 5070
                return 0;
            }
N
Niels 已提交
5071

5072
            case value_t::array:
N
Niels 已提交
5073
            {
N
Niels 已提交
5074
                // delegate call to array_t::size()
N
Niels 已提交
5075 5076
                return m_value.array->size();
            }
N
Niels 已提交
5077

5078
            case value_t::object:
N
Niels 已提交
5079
            {
N
Niels 已提交
5080
                // delegate call to object_t::size()
N
Niels 已提交
5081 5082
                return m_value.object->size();
            }
N
Niels 已提交
5083

N
Niels 已提交
5084 5085 5086 5087 5088 5089
            default:
            {
                // all other types have size 1
                return 1;
            }
        }
N
Niels 已提交
5090 5091
    }

N
Niels 已提交
5092 5093
    /*!
    @brief returns the maximum possible number of elements
N
Niels 已提交
5094 5095 5096 5097 5098

    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 已提交
5099
    @return The return value depends on the different types and is
N
Niels 已提交
5100 5101 5102
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
5103 5104 5105 5106 5107 5108
            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 已提交
5109

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

N
Niels 已提交
5114 5115 5116
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
5117 5118 5119 5120
    - The complexity is constant.
    - Has the semantics of returning `b.size()` where `b` is the largest
      possible JSON value.

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

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

N
Niels 已提交
5126
    @since version 1.0.0
N
Niels 已提交
5127
    */
N
Niels 已提交
5128
    size_type max_size() const noexcept
N
Niels 已提交
5129 5130 5131
    {
        switch (m_type)
        {
5132
            case value_t::array:
N
Niels 已提交
5133
            {
N
Niels 已提交
5134
                // delegate call to array_t::max_size()
N
Niels 已提交
5135 5136
                return m_value.array->max_size();
            }
N
Niels 已提交
5137

5138
            case value_t::object:
N
Niels 已提交
5139
            {
N
Niels 已提交
5140
                // delegate call to object_t::max_size()
N
Niels 已提交
5141 5142
                return m_value.object->max_size();
            }
N
Niels 已提交
5143

N
Niels 已提交
5144 5145
            default:
            {
5146 5147
                // all other types have max_size() == size()
                return size();
N
Niels 已提交
5148 5149
            }
        }
N
Niels 已提交
5150 5151
    }

N
Niels 已提交
5152 5153
    /// @}

N
Niels 已提交
5154 5155 5156 5157 5158

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

N
Niels 已提交
5159 5160 5161
    /// @name modifiers
    /// @{

N
Niels 已提交
5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178
    /*!
    @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 已提交
5179
    @liveexample{The example below shows the effect of `clear()` to different
N
Niels 已提交
5180
    JSON types.,clear}
N
Niels 已提交
5181

N
Niels 已提交
5182
    @since version 1.0.0
N
Niels 已提交
5183
    */
N
Niels 已提交
5184
    void clear() noexcept
N
Niels 已提交
5185 5186 5187
    {
        switch (m_type)
        {
5188
            case value_t::number_integer:
N
Niels 已提交
5189
            {
N
Niels 已提交
5190
                m_value.number_integer = 0;
N
Niels 已提交
5191 5192
                break;
            }
N
Niels 已提交
5193

5194 5195 5196 5197 5198 5199
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = 0;
                break;
            }

5200
            case value_t::number_float:
N
Niels 已提交
5201
            {
N
Niels 已提交
5202
                m_value.number_float = 0.0;
N
Niels 已提交
5203 5204
                break;
            }
N
Niels 已提交
5205

5206
            case value_t::boolean:
N
Niels 已提交
5207
            {
N
Niels 已提交
5208
                m_value.boolean = false;
N
Niels 已提交
5209 5210
                break;
            }
N
Niels 已提交
5211

5212
            case value_t::string:
N
Niels 已提交
5213 5214 5215 5216
            {
                m_value.string->clear();
                break;
            }
N
Niels 已提交
5217

5218
            case value_t::array:
N
Niels 已提交
5219 5220 5221 5222
            {
                m_value.array->clear();
                break;
            }
N
Niels 已提交
5223

5224
            case value_t::object:
N
Niels 已提交
5225 5226 5227 5228
            {
                m_value.object->clear();
                break;
            }
5229 5230 5231 5232 5233

            default:
            {
                break;
            }
N
Niels 已提交
5234 5235 5236
        }
    }

5237 5238 5239
    /*!
    @brief add an object to an array

5240
    Appends the given element @a val to the end of the JSON value. If the
5241
    function is called on a JSON null value, an empty array is created before
5242
    appending @a val.
5243

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

N
Niels 已提交
5246 5247
    @throw std::domain_error when called on a type other than JSON array or
    null; example: `"cannot use push_back() with number"`
5248 5249 5250

    @complexity Amortized constant.

N
Niels 已提交
5251 5252 5253
    @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 已提交
5254

N
Niels 已提交
5255
    @since version 1.0.0
5256
    */
5257
    void push_back(basic_json&& val)
N
Niels 已提交
5258 5259
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
5260
        if (not(is_null() or is_array()))
N
Niels 已提交
5261
        {
5262
            JSON_THROW(std::domain_error("cannot use push_back() with " + type_name()));
N
Niels 已提交
5263 5264 5265
        }

        // transform null object into an array
N
cleanup  
Niels 已提交
5266
        if (is_null())
N
Niels 已提交
5267 5268
        {
            m_type = value_t::array;
N
Niels 已提交
5269
            m_value = value_t::array;
5270
            assert_invariant();
N
Niels 已提交
5271 5272 5273
        }

        // add element to array (move semantics)
5274
        m_value.array->push_back(std::move(val));
N
Niels 已提交
5275
        // invalidate object
5276
        val.m_type = value_t::null;
N
Niels 已提交
5277 5278
    }

5279 5280 5281 5282
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5283
    reference operator+=(basic_json&& val)
N
Niels 已提交
5284
    {
5285
        push_back(std::move(val));
N
Niels 已提交
5286 5287 5288
        return *this;
    }

5289 5290 5291 5292
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5293
    void push_back(const basic_json& val)
N
Niels 已提交
5294 5295
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
5296
        if (not(is_null() or is_array()))
N
Niels 已提交
5297
        {
5298
            JSON_THROW(std::domain_error("cannot use push_back() with " + type_name()));
N
Niels 已提交
5299 5300 5301
        }

        // transform null object into an array
N
cleanup  
Niels 已提交
5302
        if (is_null())
N
Niels 已提交
5303 5304
        {
            m_type = value_t::array;
N
Niels 已提交
5305
            m_value = value_t::array;
5306
            assert_invariant();
N
Niels 已提交
5307 5308 5309
        }

        // add element to array
5310
        m_value.array->push_back(val);
N
Niels 已提交
5311 5312
    }

5313 5314 5315 5316
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5317
    reference operator+=(const basic_json& val)
N
Niels 已提交
5318
    {
5319
        push_back(val);
N
Niels 已提交
5320 5321 5322
        return *this;
    }

5323 5324 5325
    /*!
    @brief add an object to an object

5326
    Inserts the given element @a val to the JSON object. If the function is
N
Niels 已提交
5327 5328
    called on a JSON null value, an empty object is created before inserting
    @a val.
5329

5330
    @param[in] val the value to add to the JSON object
5331 5332

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

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

N
Niels 已提交
5337 5338 5339
    @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 已提交
5340

N
Niels 已提交
5341
    @since version 1.0.0
5342
    */
5343
    void push_back(const typename object_t::value_type& val)
N
Niels 已提交
5344 5345
    {
        // push_back only works for null objects or objects
N
cleanup  
Niels 已提交
5346
        if (not(is_null() or is_object()))
N
Niels 已提交
5347
        {
5348
            JSON_THROW(std::domain_error("cannot use push_back() with " + type_name()));
N
Niels 已提交
5349 5350 5351
        }

        // transform null object into an object
N
cleanup  
Niels 已提交
5352
        if (is_null())
N
Niels 已提交
5353 5354
        {
            m_type = value_t::object;
N
Niels 已提交
5355
            m_value = value_t::object;
5356
            assert_invariant();
N
Niels 已提交
5357 5358 5359
        }

        // add element to array
5360
        m_value.object->insert(val);
N
Niels 已提交
5361 5362
    }

5363 5364 5365 5366
    /*!
    @brief add an object to an object
    @copydoc push_back(const typename object_t::value_type&)
    */
5367
    reference operator+=(const typename object_t::value_type& val)
N
Niels 已提交
5368
    {
5369
        push_back(val);
N
Niels 已提交
5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418
        return *this;
    }

    /*!
    @brief add an object to an object

    This function allows to use `push_back` with an initializer list. In case

    1. the current value is an object,
    2. the initializer list @a init contains only two elements, and
    3. the first element of @a init is a string,

    @a init is converted into an object element and added using
    @ref push_back(const typename object_t::value_type&). Otherwise, @a init
    is converted to a JSON value and added using @ref push_back(basic_json&&).

    @param init  an initializer list

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

    @note This function is required to resolve an ambiguous overload error,
          because pairs like `{"key", "value"}` can be both interpreted as
          `object_t::value_type` or `std::initializer_list<basic_json>`, see
          https://github.com/nlohmann/json/issues/235 for more information.

    @liveexample{The example shows how initializer lists are treated as
    objects when possible.,push_back__initializer_list}
    */
    void push_back(std::initializer_list<basic_json> init)
    {
        if (is_object() and init.size() == 2 and init.begin()->is_string())
        {
            const string_t key = *init.begin();
            push_back(typename object_t::value_type(key, *(init.begin() + 1)));
        }
        else
        {
            push_back(basic_json(init));
        }
    }

    /*!
    @brief add an object to an object
    @copydoc push_back(std::initializer_list<basic_json>)
    */
    reference operator+=(std::initializer_list<basic_json> init)
    {
        push_back(init);
        return *this;
N
Niels 已提交
5419 5420
    }

N
Niels 已提交
5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447
    /*!
    @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()))
        {
5448
            JSON_THROW(std::domain_error("cannot use emplace_back() with " + type_name()));
N
Niels 已提交
5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463
        }

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

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

N
Niels Lohmann 已提交
5466 5467
    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
5468 5469
    function is called on a JSON null value, an empty object is created before
    appending the value created from @a args.
N
Niels 已提交
5470 5471 5472 5473

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

5474 5475 5476 5477
    @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 已提交
5478 5479 5480 5481 5482 5483 5484
    @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
5485 5486
    JSON object. Further note how no value is added if there was already one
    value stored with the same key.,emplace}
N
Niels 已提交
5487 5488 5489 5490

    @since version 2.0.8
    */
    template<class... Args>
5491
    std::pair<iterator, bool> emplace(Args&& ... args)
N
Niels 已提交
5492 5493 5494 5495
    {
        // emplace only works for null objects or arrays
        if (not(is_null() or is_object()))
        {
5496
            JSON_THROW(std::domain_error("cannot use emplace() with " + type_name()));
N
Niels 已提交
5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507
        }

        // 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)
5508 5509 5510 5511 5512 5513 5514
        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 已提交
5515 5516
    }

N
Niels 已提交
5517 5518 5519
    /*!
    @brief inserts element

5520
    Inserts element @a val before iterator @a pos.
N
Niels 已提交
5521 5522 5523

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

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

N
Niels Lohmann 已提交
5532
    @complexity Constant plus linear in the distance between @a pos and end of
N
Niels Lohmann 已提交
5533
    the container.
N
Niels 已提交
5534

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

N
Niels 已提交
5537
    @since version 1.0.0
N
Niels 已提交
5538
    */
5539
    iterator insert(const_iterator pos, const basic_json& val)
N
Niels 已提交
5540 5541
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5542
        if (is_array())
N
Niels 已提交
5543
        {
N
cleanup  
Niels 已提交
5544 5545 5546
            // check if iterator pos fits to this JSON value
            if (pos.m_object != this)
            {
5547
                JSON_THROW(std::domain_error("iterator does not fit current value"));
N
cleanup  
Niels 已提交
5548
            }
N
Niels 已提交
5549

N
cleanup  
Niels 已提交
5550 5551
            // insert to array and return iterator
            iterator result(this);
5552
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, val);
N
cleanup  
Niels 已提交
5553 5554
            return result;
        }
N
Niels Lohmann 已提交
5555

5556
        JSON_THROW(std::domain_error("cannot use insert() with " + type_name()));
N
Niels 已提交
5557 5558 5559 5560 5561 5562
    }

    /*!
    @brief inserts element
    @copydoc insert(const_iterator, const basic_json&)
    */
5563
    iterator insert(const_iterator pos, basic_json&& val)
N
Niels 已提交
5564
    {
5565
        return insert(pos, val);
N
Niels 已提交
5566 5567 5568 5569 5570
    }

    /*!
    @brief inserts elements

5571
    Inserts @a cnt copies of @a val before iterator @a pos.
N
Niels 已提交
5572 5573 5574

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

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

5585
    @complexity Linear in @a cnt plus linear in the distance between @a pos
N
Niels 已提交
5586 5587
    and end of the container.

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

N
Niels 已提交
5590
    @since version 1.0.0
N
Niels 已提交
5591
    */
5592
    iterator insert(const_iterator pos, size_type cnt, const basic_json& val)
N
Niels 已提交
5593 5594
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5595
        if (is_array())
N
Niels 已提交
5596
        {
N
cleanup  
Niels 已提交
5597 5598 5599
            // check if iterator pos fits to this JSON value
            if (pos.m_object != this)
            {
5600
                JSON_THROW(std::domain_error("iterator does not fit current value"));
N
cleanup  
Niels 已提交
5601
            }
N
Niels 已提交
5602

N
cleanup  
Niels 已提交
5603 5604
            // insert to array and return iterator
            iterator result(this);
5605
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, cnt, val);
N
cleanup  
Niels 已提交
5606 5607
            return result;
        }
N
Niels Lohmann 已提交
5608

5609
        JSON_THROW(std::domain_error("cannot use insert() with " + type_name()));
N
Niels 已提交
5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621
    }

    /*!
    @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 已提交
5622 5623
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
N
Niels 已提交
5624 5625
    @throw std::domain_error if @a pos is not an iterator of *this; example:
    `"iterator does not fit current value"`
N
Niels 已提交
5626
    @throw std::domain_error if @a first and @a last do not belong to the same
N
Niels 已提交
5627
    JSON value; example: `"iterators do not fit"`
N
Niels 已提交
5628
    @throw std::domain_error if @a first or @a last are iterators into
N
Niels 已提交
5629 5630 5631
    container for which insert is called; example: `"passed iterators may not
    belong to container"`

N
Niels 已提交
5632 5633 5634 5635 5636 5637
    @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 已提交
5638
    @liveexample{The example shows how `insert()` is used.,insert__range}
N
Niels 已提交
5639

N
Niels 已提交
5640
    @since version 1.0.0
N
Niels 已提交
5641 5642 5643 5644
    */
    iterator insert(const_iterator pos, const_iterator first, const_iterator last)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5645
        if (not is_array())
N
Niels 已提交
5646
        {
5647
            JSON_THROW(std::domain_error("cannot use insert() with " + type_name()));
N
Niels 已提交
5648 5649 5650 5651 5652
        }

        // check if iterator pos fits to this JSON value
        if (pos.m_object != this)
        {
5653
            JSON_THROW(std::domain_error("iterator does not fit current value"));
N
Niels 已提交
5654 5655
        }

N
Niels 已提交
5656
        // check if range iterators belong to the same JSON object
N
Niels 已提交
5657 5658
        if (first.m_object != last.m_object)
        {
5659
            JSON_THROW(std::domain_error("iterators do not fit"));
N
Niels 已提交
5660 5661 5662 5663
        }

        if (first.m_object == this or last.m_object == this)
        {
5664
            JSON_THROW(std::domain_error("passed iterators may not belong to container"));
N
Niels 已提交
5665 5666 5667 5668
        }

        // insert to array and return iterator
        iterator result(this);
N
Niels 已提交
5669
        result.m_it.array_iterator = m_value.array->insert(
T
Théo DELRIEU 已提交
5670 5671 5672
                                         pos.m_it.array_iterator,
                                         first.m_it.array_iterator,
                                         last.m_it.array_iterator);
N
Niels 已提交
5673 5674 5675
        return result;
    }

N
Niels 已提交
5676 5677 5678 5679 5680 5681 5682 5683 5684
    /*!
    @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 已提交
5685 5686
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
N
Niels 已提交
5687 5688
    @throw std::domain_error if @a pos is not an iterator of *this; example:
    `"iterator does not fit current value"`
N
Niels 已提交
5689

N
Niels 已提交
5690 5691 5692
    @return iterator pointing to the first element inserted, or @a pos if
    `ilist` is empty

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

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

N
Niels 已提交
5698
    @since version 1.0.0
N
Niels 已提交
5699 5700 5701 5702
    */
    iterator insert(const_iterator pos, std::initializer_list<basic_json> ilist)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5703
        if (not is_array())
N
Niels 已提交
5704
        {
5705
            JSON_THROW(std::domain_error("cannot use insert() with " + type_name()));
N
Niels 已提交
5706 5707 5708 5709 5710
        }

        // check if iterator pos fits to this JSON value
        if (pos.m_object != this)
        {
5711
            JSON_THROW(std::domain_error("iterator does not fit current value"));
N
Niels 已提交
5712 5713 5714 5715 5716 5717 5718 5719
        }

        // 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 已提交
5720 5721
    /*!
    @brief exchanges the values
N
Niels 已提交
5722 5723 5724 5725 5726 5727 5728 5729 5730 5731

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

N
Niels 已提交
5735
    @since version 1.0.0
N
Niels 已提交
5736
    */
N
Niels 已提交
5737
    void swap(reference other) noexcept (
N
Niels 已提交
5738 5739 5740 5741
        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 已提交
5742
    )
N
Niels 已提交
5743 5744 5745
    {
        std::swap(m_type, other.m_type);
        std::swap(m_value, other.m_value);
5746
        assert_invariant();
N
Niels 已提交
5747 5748
    }

N
Niels 已提交
5749 5750 5751 5752 5753 5754 5755 5756 5757 5758
    /*!
    @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 已提交
5759 5760
    @throw std::domain_error when JSON value is not an array; example:
    `"cannot use swap() with string"`
N
Niels 已提交
5761 5762 5763

    @complexity Constant.

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

N
Niels 已提交
5767
    @since version 1.0.0
N
Niels 已提交
5768
    */
N
Niels 已提交
5769
    void swap(array_t& other)
N
Niels 已提交
5770 5771
    {
        // swap only works for arrays
N
cleanup  
Niels 已提交
5772 5773 5774 5775 5776
        if (is_array())
        {
            std::swap(*(m_value.array), other);
        }
        else
N
Niels 已提交
5777
        {
5778
            JSON_THROW(std::domain_error("cannot use swap() with " + type_name()));
N
Niels 已提交
5779 5780 5781
        }
    }

5782 5783 5784 5785 5786 5787 5788 5789 5790 5791
    /*!
    @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 已提交
5792 5793
    @throw std::domain_error when JSON value is not an object; example:
    `"cannot use swap() with string"`
5794 5795 5796

    @complexity Constant.

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

N
Niels 已提交
5800
    @since version 1.0.0
5801
    */
N
Niels 已提交
5802
    void swap(object_t& other)
N
Niels 已提交
5803 5804
    {
        // swap only works for objects
N
cleanup  
Niels 已提交
5805 5806 5807 5808 5809
        if (is_object())
        {
            std::swap(*(m_value.object), other);
        }
        else
N
Niels 已提交
5810
        {
5811
            JSON_THROW(std::domain_error("cannot use swap() with " + type_name()));
N
Niels 已提交
5812 5813 5814
        }
    }

5815 5816 5817 5818 5819 5820 5821 5822 5823 5824
    /*!
    @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 已提交
5825 5826
    @throw std::domain_error when JSON value is not a string; example: `"cannot
    use swap() with boolean"`
5827 5828 5829

    @complexity Constant.

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

N
Niels 已提交
5833
    @since version 1.0.0
5834
    */
N
Niels 已提交
5835
    void swap(string_t& other)
N
Niels 已提交
5836 5837
    {
        // swap only works for strings
N
cleanup  
Niels 已提交
5838 5839 5840 5841 5842
        if (is_string())
        {
            std::swap(*(m_value.string), other);
        }
        else
N
Niels 已提交
5843
        {
5844
            JSON_THROW(std::domain_error("cannot use swap() with " + type_name()));
N
Niels 已提交
5845 5846 5847
        }
    }

N
Niels 已提交
5848 5849
    /// @}

N
Niels 已提交
5850
  public:
5851 5852 5853 5854 5855 5856 5857
    //////////////////////////////////////////
    // lexicographical comparison operators //
    //////////////////////////////////////////

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

N
Niels 已提交
5858 5859
    /*!
    @brief comparison: equal
N
Niels 已提交
5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875

    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.

5876 5877
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__equal}
N
Niels 已提交
5878

N
Niels 已提交
5879
    @since version 1.0.0
N
Niels 已提交
5880
    */
N
Niels 已提交
5881
    friend bool operator==(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
5882
    {
F
Florian Weber 已提交
5883 5884
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
5885

F
Florian Weber 已提交
5886
        if (lhs_type == rhs_type)
N
Niels 已提交
5887
        {
F
Florian Weber 已提交
5888
            switch (lhs_type)
N
Niels 已提交
5889
            {
5890
                case value_t::array:
N
Niels 已提交
5891
                {
N
Niels 已提交
5892
                    return *lhs.m_value.array == *rhs.m_value.array;
N
Niels 已提交
5893
                }
5894
                case value_t::object:
N
Niels 已提交
5895
                {
N
Niels 已提交
5896
                    return *lhs.m_value.object == *rhs.m_value.object;
N
Niels 已提交
5897
                }
5898
                case value_t::null:
N
Niels 已提交
5899
                {
N
Niels 已提交
5900
                    return true;
N
Niels 已提交
5901
                }
5902
                case value_t::string:
N
Niels 已提交
5903
                {
N
Niels 已提交
5904
                    return *lhs.m_value.string == *rhs.m_value.string;
N
Niels 已提交
5905
                }
5906
                case value_t::boolean:
N
Niels 已提交
5907
                {
N
Niels 已提交
5908
                    return lhs.m_value.boolean == rhs.m_value.boolean;
N
Niels 已提交
5909
                }
5910
                case value_t::number_integer:
N
Niels 已提交
5911
                {
N
Niels 已提交
5912
                    return lhs.m_value.number_integer == rhs.m_value.number_integer;
N
Niels 已提交
5913
                }
5914 5915 5916 5917
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned == rhs.m_value.number_unsigned;
                }
5918
                case value_t::number_float:
N
Niels 已提交
5919
                {
5920
                    return lhs.m_value.number_float == rhs.m_value.number_float;
N
Niels 已提交
5921
                }
5922
                default:
N
Niels 已提交
5923
                {
N
Niels 已提交
5924
                    return false;
N
Niels 已提交
5925
                }
N
Niels 已提交
5926 5927
            }
        }
F
Florian Weber 已提交
5928 5929
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
N
Niels 已提交
5930
            return static_cast<number_float_t>(lhs.m_value.number_integer) == rhs.m_value.number_float;
F
Florian Weber 已提交
5931 5932 5933
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
5934
            return lhs.m_value.number_float == static_cast<number_float_t>(rhs.m_value.number_integer);
F
Florian Weber 已提交
5935
        }
5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950
        else if (lhs_type == value_t::number_unsigned and rhs_type == value_t::number_float)
        {
            return static_cast<number_float_t>(lhs.m_value.number_unsigned) == rhs.m_value.number_float;
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_unsigned)
        {
            return lhs.m_value.number_float == static_cast<number_float_t>(rhs.m_value.number_unsigned);
        }
        else if (lhs_type == value_t::number_unsigned and rhs_type == value_t::number_integer)
        {
            return static_cast<number_integer_t>(lhs.m_value.number_unsigned) == rhs.m_value.number_integer;
        }
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_unsigned)
        {
            return lhs.m_value.number_integer == static_cast<number_integer_t>(rhs.m_value.number_unsigned);
F
Florian Weber 已提交
5951
        }
5952

N
Niels 已提交
5953 5954 5955
        return false;
    }

N
Niels 已提交
5956 5957
    /*!
    @brief comparison: equal
M
Mihai STAN 已提交
5958
    @copydoc operator==(const_reference, const_reference)
N
Niels 已提交
5959
    */
M
Mihai STAN 已提交
5960
    template<typename ScalarType, typename std::enable_if<
5961 5962
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator==(const_reference lhs, const ScalarType rhs) noexcept
N
Niels 已提交
5963
    {
M
Mihai STAN 已提交
5964
        return (lhs == basic_json(rhs));
N
Niels 已提交
5965 5966 5967 5968
    }

    /*!
    @brief comparison: equal
M
Mihai STAN 已提交
5969
    @copydoc operator==(const_reference, const_reference)
N
Niels 已提交
5970
    */
M
Mihai STAN 已提交
5971
    template<typename ScalarType, typename std::enable_if<
5972 5973
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator==(const ScalarType lhs, const_reference rhs) noexcept
N
Niels 已提交
5974
    {
M
Mihai STAN 已提交
5975
        return (basic_json(lhs) == rhs);
N
Niels 已提交
5976 5977
    }

N
Niels 已提交
5978 5979
    /*!
    @brief comparison: not equal
N
Niels 已提交
5980 5981 5982 5983 5984 5985 5986 5987 5988

    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.

5989 5990
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__notequal}
N
Niels 已提交
5991

N
Niels 已提交
5992
    @since version 1.0.0
N
Niels 已提交
5993
    */
N
Niels 已提交
5994
    friend bool operator!=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
5995 5996 5997 5998
    {
        return not (lhs == rhs);
    }

N
Niels 已提交
5999 6000
    /*!
    @brief comparison: not equal
M
Mihai STAN 已提交
6001
    @copydoc operator!=(const_reference, const_reference)
N
Niels 已提交
6002
    */
M
Mihai STAN 已提交
6003 6004 6005
    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 已提交
6006
    {
M
Mihai STAN 已提交
6007
        return (lhs != basic_json(rhs));
N
Niels 已提交
6008 6009 6010 6011
    }

    /*!
    @brief comparison: not equal
M
Mihai STAN 已提交
6012
    @copydoc operator!=(const_reference, const_reference)
N
Niels 已提交
6013
    */
M
Mihai STAN 已提交
6014 6015 6016
    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 已提交
6017
    {
M
Mihai STAN 已提交
6018
        return (basic_json(lhs) != rhs);
N
Niels 已提交
6019 6020
    }

N
Niels 已提交
6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039
    /*!
    @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.

6040 6041
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__less}
N
Niels 已提交
6042

N
Niels 已提交
6043
    @since version 1.0.0
N
Niels 已提交
6044
    */
N
Niels 已提交
6045
    friend bool operator<(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6046
    {
F
Florian Weber 已提交
6047 6048
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
6049

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

N
Niels 已提交
6117
        // We only reach this line if we cannot compare values. In that case,
N
Niels 已提交
6118 6119 6120
        // we compare types. Note we have to call the operator explicitly,
        // because MSVC has problems otherwise.
        return operator<(lhs_type, rhs_type);
N
Niels 已提交
6121 6122
    }

N
Niels 已提交
6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134
    /*!
    @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.

6135 6136
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greater}
N
Niels 已提交
6137

N
Niels 已提交
6138
    @since version 1.0.0
N
Niels 已提交
6139
    */
N
Niels 已提交
6140
    friend bool operator<=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6141 6142 6143 6144
    {
        return not (rhs < lhs);
    }

N
Niels 已提交
6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156
    /*!
    @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.

6157 6158
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__lessequal}
N
Niels 已提交
6159

N
Niels 已提交
6160
    @since version 1.0.0
N
Niels 已提交
6161
    */
N
Niels 已提交
6162
    friend bool operator>(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6163 6164 6165 6166
    {
        return not (lhs <= rhs);
    }

N
Niels 已提交
6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178
    /*!
    @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.

6179 6180
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greaterequal}
N
Niels 已提交
6181

N
Niels 已提交
6182
    @since version 1.0.0
N
Niels 已提交
6183
    */
N
Niels 已提交
6184
    friend bool operator>=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6185 6186 6187 6188
    {
        return not (lhs < rhs);
    }

N
Niels 已提交
6189 6190
    /// @}

N
Niels 已提交
6191 6192 6193 6194 6195

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

N
Niels 已提交
6196 6197 6198
    /// @name serialization
    /// @{

N
Niels 已提交
6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215
    /*!
    @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 已提交
6216 6217
    @liveexample{The example below shows the serialization with different
    parameters to `width` to adjust the indentation level.,operator_serialize}
N
Niels 已提交
6218

N
Niels 已提交
6219
    @since version 1.0.0
N
Niels 已提交
6220
    */
N
Niels 已提交
6221 6222
    friend std::ostream& operator<<(std::ostream& o, const basic_json& j)
    {
N
Niels 已提交
6223
        // read width member and use it as indentation parameter if nonzero
N
Niels 已提交
6224 6225
        const bool pretty_print = (o.width() > 0);
        const auto indentation = (pretty_print ? o.width() : 0);
N
Niels 已提交
6226

N
Niels 已提交
6227 6228
        // reset width to 0 for subsequent calls to this stream
        o.width(0);
6229

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

N
Niels 已提交
6233 6234 6235
        return o;
    }

N
Niels 已提交
6236 6237 6238 6239
    /*!
    @brief serialize to stream
    @copydoc operator<<(std::ostream&, const basic_json&)
    */
N
Niels 已提交
6240 6241
    friend std::ostream& operator>>(const basic_json& j, std::ostream& o)
    {
N
Niels 已提交
6242
        return o << j;
N
Niels 已提交
6243 6244
    }

N
Niels 已提交
6245 6246
    /// @}

N
Niels 已提交
6247 6248 6249 6250 6251

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

N
Niels 已提交
6252 6253 6254
    /// @name deserialization
    /// @{

N
Niels 已提交
6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316
    /*!
    @brief deserialize from an array

    This function reads from an array of 1-byte values.

    @pre Each element of the container has a size of 1 byte. Violating this
    precondition yields undefined behavior. **This precondition is enforced
    with a static assertion.**

    @param[in] array  array to read from
    @param[in] cb  a parser callback function of type @ref parser_callback_t
    which is used to control the deserialization by filtering unwanted values
    (optional)

    @return result of the deserialization

    @complexity Linear in the length of the input. The parser is a predictive
    LL(1) parser. The complexity can be higher if the parser callback function
    @a cb has a super-linear complexity.

    @note A UTF-8 byte order mark is silently ignored.

    @liveexample{The example below demonstrates the `parse()` function reading
    from an array.,parse__array__parser_callback_t}

    @since version 2.0.3
    */
    template<class T, std::size_t N>
    static basic_json parse(T (&array)[N],
                            const parser_callback_t cb = nullptr)
    {
        // delegate the call to the iterator-range parse overload
        return parse(std::begin(array), std::end(array), cb);
    }

    /*!
    @brief deserialize from string literal

    @tparam CharT character/literal type with size of 1 byte
    @param[in] s  string literal to read a serialized JSON value from
    @param[in] cb a parser callback function of type @ref parser_callback_t
    which is used to control the deserialization by filtering unwanted values
    (optional)

    @return result of the deserialization

    @complexity Linear in the length of the input. The parser is a predictive
    LL(1) parser. The complexity can be higher if the parser callback function
    @a cb has a super-linear complexity.

    @note A UTF-8 byte order mark is silently ignored.
    @note String containers like `std::string` or @ref string_t can be parsed
          with @ref parse(const ContiguousContainer&, const parser_callback_t)

    @liveexample{The example below demonstrates the `parse()` function with
    and without callback function.,parse__string__parser_callback_t}

    @sa @ref parse(std::istream&, const parser_callback_t) for a version that
    reads from an input stream

    @since version 1.0.0 (originally for @ref string_t)
    */
6317 6318 6319 6320 6321
    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 已提交
6322 6323 6324 6325 6326
                            const parser_callback_t cb = nullptr)
    {
        return parser(reinterpret_cast<const char*>(s), cb).parse();
    }

N
Niels 已提交
6327 6328 6329 6330
    /*!
    @brief deserialize from stream

    @param[in,out] i  stream to read a serialized JSON value from
N
Niels 已提交
6331 6332 6333
    @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 已提交
6334 6335 6336 6337 6338 6339 6340

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

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

6346
    @sa @ref parse(const CharT, const parser_callback_t) for a version
N
Niels 已提交
6347
    that reads from a string
N
Niels 已提交
6348

N
Niels 已提交
6349
    @since version 1.0.0
N
Niels 已提交
6350
    */
N
Niels 已提交
6351 6352
    static basic_json parse(std::istream& i,
                            const parser_callback_t cb = nullptr)
N
Niels 已提交
6353
    {
N
Niels 已提交
6354
        return parser(i, cb).parse();
N
Niels 已提交
6355 6356
    }

N
Niels 已提交
6357
    /*!
N
Niels 已提交
6358
    @copydoc parse(std::istream&, const parser_callback_t)
N
Niels 已提交
6359
    */
N
Niels 已提交
6360 6361
    static basic_json parse(std::istream&& i,
                            const parser_callback_t cb = nullptr)
N
Cleanup  
Niels 已提交
6362 6363 6364 6365
    {
        return parser(i, cb).parse();
    }

6366
    /*!
N
Niels 已提交
6367
    @brief deserialize from an iterator range with contiguous storage
6368

6369 6370
    This function reads from an iterator range of a container with contiguous
    storage of 1-byte values. Compatible container types include
6371 6372 6373 6374 6375 6376 6377 6378 6379
    `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
6380
    with a static assertion.**
6381

N
Niels 已提交
6382 6383 6384 6385
    @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.
6386

N
Niels 已提交
6387
    @tparam IteratorType iterator of container with contiguous storage
N
Niels 已提交
6388 6389 6390
    @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
6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401
    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 已提交
6402 6403
    @liveexample{The example below demonstrates the `parse()` function reading
    from an iterator range.,parse__iteratortype__parser_callback_t}
6404 6405 6406

    @since version 2.0.3
    */
N
Niels 已提交
6407 6408 6409 6410
    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>
6411 6412 6413 6414 6415
    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 已提交
6416
        assert(std::accumulate(first, last, std::pair<bool, int>(true, 0),
6417 6418 6419 6420 6421 6422 6423
                               [&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
6424 6425
        static_assert(sizeof(typename std::iterator_traits<IteratorType>::value_type) == 1,
                      "each element in the iterator range must have the size of 1 byte");
6426

6427 6428 6429 6430 6431 6432
        // 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();
        }
6433 6434 6435 6436

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

N
Niels 已提交
6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457
    /*!
    @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 已提交
6458
    @tparam ContiguousContainer container type with contiguous storage
N
Niels 已提交
6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476
    @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 已提交
6477
    template<class ContiguousContainer, typename std::enable_if<
N
Niels 已提交
6478
                 not std::is_pointer<ContiguousContainer>::value and
6479 6480
                 std::is_base_of<
                     std::random_access_iterator_tag,
N
Niels 已提交
6481
                     typename std::iterator_traits<decltype(std::begin(std::declval<ContiguousContainer const>()))>::iterator_category>::value
6482 6483 6484 6485 6486 6487 6488 6489
                 , 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 已提交
6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502
    /*!
    @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 已提交
6503 6504
    @note A UTF-8 byte order mark is silently ignored.

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

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

N
Niels 已提交
6511
    @since version 1.0.0
N
Niels 已提交
6512 6513
    */
    friend std::istream& operator<<(basic_json& j, std::istream& i)
N
Niels 已提交
6514 6515 6516 6517 6518
    {
        j = parser(i).parse();
        return i;
    }

N
Niels 已提交
6519 6520 6521 6522 6523
    /*!
    @brief deserialize from stream
    @copydoc operator<<(basic_json&, std::istream&)
    */
    friend std::istream& operator>>(std::istream& i, basic_json& j)
N
Niels 已提交
6524 6525 6526 6527 6528
    {
        j = parser(i).parse();
        return i;
    }

N
Niels 已提交
6529 6530
    /// @}

N
Niels Lohmann 已提交
6531 6532 6533
    //////////////////////////////////////////
    // binary serialization/deserialization //
    //////////////////////////////////////////
N
Niels 已提交
6534

N
Niels Lohmann 已提交
6535
    /// @name binary serialization/deserialization support
N
Niels 已提交
6536 6537 6538
    /// @{

  private:
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
    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:
            {
                vec.push_back(static_cast<uint8_t>((number >> 070) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 060) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 050) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 040) & 0xff));
                // intentional fall-through
            }

            case 4:
            {
                vec.push_back(static_cast<uint8_t>((number >> 030) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 020) & 0xff));
                // intentional fall-through
            }

            case 2:
            {
                vec.push_back(static_cast<uint8_t>((number >> 010) & 0xff));
                // intentional fall-through
            }

            case 1:
            {
                vec.push_back(static_cast<uint8_t>(number & 0xff));
                break;
            }
        }
    }

6576 6577 6578 6579 6580 6581 6582 6583
    /*!
    @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
6584
    @param[in] current_index  the position in the vector after which to read
6585 6586 6587 6588 6589 6590 6591 6592

    @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

6593 6594 6595 6596
    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.

6597 6598
    Precondition:

6599 6600 6601
    vec:   |   |   | a | b | c | d |      T: |   |   |   |   |
                 ^               ^             ^                ^
           current_index         i            ptr        sizeof(T)
6602 6603 6604

    Postcondition:

6605 6606 6607
    vec:   |   |   | a | b | c | d |      T: | d | c | b | a |
                 ^   ^                                     ^
                 |   i                                    ptr
6608 6609
           current_index

6610
    @sa Code adapted from <http://stackoverflow.com/a/41031865/266378>.
6611 6612 6613
    */
    template<typename T>
    static T get_from_vector(const std::vector<uint8_t>& vec, const size_t current_index)
6614
    {
6615 6616
        if (current_index + sizeof(T) + 1 > vec.size())
        {
6617
            JSON_THROW(std::out_of_range("cannot read " + std::to_string(sizeof(T)) + " bytes from vector"));
6618 6619
        }

6620
        T result;
N
Niels Lohmann 已提交
6621
        auto* ptr = reinterpret_cast<uint8_t*>(&result);
6622
        for (size_t i = 0; i < sizeof(T); ++i)
6623
        {
6624
            *ptr++ = vec[current_index + sizeof(T) - i];
6625 6626
        }
        return result;
6627 6628
    }

6629 6630 6631 6632 6633 6634 6635 6636 6637 6638
    /*!
    @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 已提交
6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658
    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:
            {
6659
                if (j.m_value.number_integer >= 0)
N
Niels 已提交
6660
                {
6661
                    // MessagePack does not differentiate between positive
N
Niels Lohmann 已提交
6662 6663 6664
                    // signed integers and unsigned integers. Therefore, we
                    // used the code from the value_t::number_unsigned case
                    // here.
6665 6666 6667 6668 6669
                    if (j.m_value.number_unsigned < 128)
                    {
                        // positive fixnum
                        add_to_vector(v, 1, j.m_value.number_unsigned);
                    }
6670
                    else if (j.m_value.number_unsigned <= std::numeric_limits<uint8_t>::max())
6671 6672 6673 6674 6675
                    {
                        // uint 8
                        v.push_back(0xcc);
                        add_to_vector(v, 1, j.m_value.number_unsigned);
                    }
6676
                    else if (j.m_value.number_unsigned <= std::numeric_limits<uint16_t>::max())
6677 6678 6679 6680 6681
                    {
                        // uint 16
                        v.push_back(0xcd);
                        add_to_vector(v, 2, j.m_value.number_unsigned);
                    }
6682
                    else if (j.m_value.number_unsigned <= std::numeric_limits<uint32_t>::max())
6683 6684 6685 6686 6687
                    {
                        // uint 32
                        v.push_back(0xce);
                        add_to_vector(v, 4, j.m_value.number_unsigned);
                    }
6688
                    else if (j.m_value.number_unsigned <= std::numeric_limits<uint64_t>::max())
6689 6690 6691 6692 6693
                    {
                        // uint 64
                        v.push_back(0xcf);
                        add_to_vector(v, 8, j.m_value.number_unsigned);
                    }
N
Niels 已提交
6694
                }
6695
                else
N
Niels 已提交
6696
                {
6697 6698 6699 6700 6701
                    if (j.m_value.number_integer >= -32)
                    {
                        // negative fixnum
                        add_to_vector(v, 1, j.m_value.number_integer);
                    }
6702
                    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())
6703 6704 6705 6706 6707
                    {
                        // int 8
                        v.push_back(0xd0);
                        add_to_vector(v, 1, j.m_value.number_integer);
                    }
6708
                    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())
6709 6710 6711 6712 6713
                    {
                        // int 16
                        v.push_back(0xd1);
                        add_to_vector(v, 2, j.m_value.number_integer);
                    }
6714
                    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())
6715 6716 6717 6718 6719
                    {
                        // int 32
                        v.push_back(0xd2);
                        add_to_vector(v, 4, j.m_value.number_integer);
                    }
6720
                    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())
6721 6722 6723 6724 6725
                    {
                        // int 64
                        v.push_back(0xd3);
                        add_to_vector(v, 8, j.m_value.number_integer);
                    }
N
Niels 已提交
6726 6727 6728 6729 6730 6731 6732 6733 6734
                }
                break;
            }

            case value_t::number_unsigned:
            {
                if (j.m_value.number_unsigned < 128)
                {
                    // positive fixnum
6735
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels 已提交
6736
                }
6737
                else if (j.m_value.number_unsigned <= std::numeric_limits<uint8_t>::max())
N
Niels 已提交
6738 6739 6740
                {
                    // uint 8
                    v.push_back(0xcc);
6741
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels 已提交
6742
                }
6743
                else if (j.m_value.number_unsigned <= std::numeric_limits<uint16_t>::max())
N
Niels 已提交
6744 6745 6746
                {
                    // uint 16
                    v.push_back(0xcd);
6747
                    add_to_vector(v, 2, j.m_value.number_unsigned);
N
Niels 已提交
6748
                }
6749
                else if (j.m_value.number_unsigned <= std::numeric_limits<uint32_t>::max())
N
Niels 已提交
6750 6751 6752
                {
                    // uint 32
                    v.push_back(0xce);
6753
                    add_to_vector(v, 4, j.m_value.number_unsigned);
N
Niels 已提交
6754
                }
6755
                else if (j.m_value.number_unsigned <= std::numeric_limits<uint64_t>::max())
N
Niels 已提交
6756 6757 6758
                {
                    // uint 64
                    v.push_back(0xcf);
6759
                    add_to_vector(v, 8, j.m_value.number_unsigned);
N
Niels 已提交
6760 6761 6762 6763 6764 6765 6766 6767
                }
                break;
            }

            case value_t::number_float:
            {
                // float 64
                v.push_back(0xcb);
N
Niels Lohmann 已提交
6768
                const auto* helper = reinterpret_cast<const uint8_t*>(&(j.m_value.number_float));
N
Niels 已提交
6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787
                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);
6788
                    add_to_vector(v, 1, N);
N
Niels 已提交
6789 6790 6791 6792 6793
                }
                else if (N <= 65535)
                {
                    // str 16
                    v.push_back(0xda);
6794
                    add_to_vector(v, 2, N);
N
Niels 已提交
6795 6796 6797 6798 6799
                }
                else if (N <= 4294967295)
                {
                    // str 32
                    v.push_back(0xdb);
6800
                    add_to_vector(v, 4, N);
N
Niels 已提交
6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820
                }

                // 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);
6821
                    add_to_vector(v, 2, N);
N
Niels 已提交
6822 6823 6824 6825 6826
                }
                else if (N <= 0xffffffff)
                {
                    // array 32
                    v.push_back(0xdd);
6827
                    add_to_vector(v, 4, N);
N
Niels 已提交
6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849
                }

                // 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);
6850
                    add_to_vector(v, 2, N);
N
Niels 已提交
6851 6852 6853 6854 6855
                }
                else if (N <= 4294967295)
                {
                    // map 32
                    v.push_back(0xdf);
6856
                    add_to_vector(v, 4, N);
N
Niels 已提交
6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874
                }

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

6875 6876 6877 6878 6879 6880 6881 6882 6883 6884
    /*!
    @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 已提交
6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907
    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.
6908
                    if (j.m_value.number_integer <= 0x17)
N
Niels Lohmann 已提交
6909
                    {
6910
                        add_to_vector(v, 1, j.m_value.number_integer);
N
Niels Lohmann 已提交
6911
                    }
6912
                    else if (j.m_value.number_integer <= std::numeric_limits<uint8_t>::max())
N
Niels Lohmann 已提交
6913 6914 6915
                    {
                        v.push_back(0x18);
                        // one-byte uint8_t
6916
                        add_to_vector(v, 1, j.m_value.number_integer);
N
Niels Lohmann 已提交
6917
                    }
6918
                    else if (j.m_value.number_integer <= std::numeric_limits<uint16_t>::max())
N
Niels Lohmann 已提交
6919 6920 6921
                    {
                        v.push_back(0x19);
                        // two-byte uint16_t
6922
                        add_to_vector(v, 2, j.m_value.number_integer);
N
Niels Lohmann 已提交
6923
                    }
6924
                    else if (j.m_value.number_integer <= std::numeric_limits<uint32_t>::max())
N
Niels Lohmann 已提交
6925 6926 6927
                    {
                        v.push_back(0x1a);
                        // four-byte uint32_t
6928
                        add_to_vector(v, 4, j.m_value.number_integer);
N
Niels Lohmann 已提交
6929
                    }
6930
                    else
N
Niels Lohmann 已提交
6931
                    {
N
Niels Lohmann 已提交
6932
                        v.push_back(0x1b);
N
Niels Lohmann 已提交
6933
                        // eight-byte uint64_t
6934
                        add_to_vector(v, 8, j.m_value.number_integer);
N
Niels Lohmann 已提交
6935 6936 6937 6938
                    }
                }
                else
                {
N
Niels Lohmann 已提交
6939 6940
                    // The conversions below encode the sign in the first
                    // byte, and the value is converted to a positive number.
N
Niels Lohmann 已提交
6941
                    const auto positive_number = -1 - j.m_value.number_integer;
6942
                    if (j.m_value.number_integer >= -24)
N
Niels Lohmann 已提交
6943 6944 6945
                    {
                        v.push_back(static_cast<uint8_t>(0x20 + positive_number));
                    }
6946
                    else if (positive_number <= std::numeric_limits<uint8_t>::max())
N
Niels Lohmann 已提交
6947 6948 6949
                    {
                        // int 8
                        v.push_back(0x38);
6950
                        add_to_vector(v, 1, positive_number);
N
Niels Lohmann 已提交
6951
                    }
6952
                    else if (positive_number <= std::numeric_limits<uint16_t>::max())
N
Niels Lohmann 已提交
6953 6954 6955
                    {
                        // int 16
                        v.push_back(0x39);
6956
                        add_to_vector(v, 2, positive_number);
N
Niels Lohmann 已提交
6957
                    }
6958
                    else if (positive_number <= std::numeric_limits<uint32_t>::max())
N
Niels Lohmann 已提交
6959 6960 6961
                    {
                        // int 32
                        v.push_back(0x3a);
6962
                        add_to_vector(v, 4, positive_number);
N
Niels Lohmann 已提交
6963
                    }
6964
                    else
N
Niels Lohmann 已提交
6965 6966 6967
                    {
                        // int 64
                        v.push_back(0x3b);
6968
                        add_to_vector(v, 8, positive_number);
N
Niels Lohmann 已提交
6969 6970
                    }
                }
6971
                break;
N
Niels Lohmann 已提交
6972 6973 6974 6975
            }

            case value_t::number_unsigned:
            {
6976
                if (j.m_value.number_unsigned <= 0x17)
N
Niels Lohmann 已提交
6977 6978 6979 6980 6981 6982 6983
                {
                    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
6984
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
6985 6986 6987 6988 6989
                }
                else if (j.m_value.number_unsigned <= 0xffff)
                {
                    v.push_back(0x19);
                    // two-byte uint16_t
6990
                    add_to_vector(v, 2, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
6991 6992 6993 6994 6995
                }
                else if (j.m_value.number_unsigned <= 0xffffffff)
                {
                    v.push_back(0x1a);
                    // four-byte uint32_t
6996
                    add_to_vector(v, 4, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
6997 6998 6999
                }
                else if (j.m_value.number_unsigned <= 0xffffffffffffffff)
                {
N
Niels Lohmann 已提交
7000
                    v.push_back(0x1b);
N
Niels Lohmann 已提交
7001
                    // eight-byte uint64_t
7002
                    add_to_vector(v, 8, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7003 7004 7005 7006 7007 7008 7009 7010
                }
                break;
            }

            case value_t::number_float:
            {
                // Double-Precision Float
                v.push_back(0xfb);
N
Niels Lohmann 已提交
7011
                const auto* helper = reinterpret_cast<const uint8_t*>(&(j.m_value.number_float));
N
Niels Lohmann 已提交
7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023
                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)
                {
7024
                    v.push_back(0x60 + N);  // 1 byte for string + size
N
Niels Lohmann 已提交
7025 7026 7027
                }
                else if (N <= 0xff)
                {
7028
                    v.push_back(0x78);  // one-byte uint8_t for N
7029
                    add_to_vector(v, 1, N);
N
Niels Lohmann 已提交
7030 7031 7032
                }
                else if (N <= 0xffff)
                {
7033
                    v.push_back(0x79);  // two-byte uint16_t for N
7034
                    add_to_vector(v, 2, N);
N
Niels Lohmann 已提交
7035 7036 7037
                }
                else if (N <= 0xffffffff)
                {
7038
                    v.push_back(0x7a); // four-byte uint32_t for N
7039
                    add_to_vector(v, 4, N);
N
Niels Lohmann 已提交
7040
                }
7041
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
7042 7043
                else if (N <= 0xffffffffffffffff)
                {
7044
                    v.push_back(0x7b);  // eight-byte uint64_t for N
7045
                    add_to_vector(v, 8, N);
N
Niels Lohmann 已提交
7046
                }
7047
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059

                // 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)
                {
7060
                    v.push_back(0x80 + N);  // 1 byte for array + size
N
Niels Lohmann 已提交
7061 7062 7063
                }
                else if (N <= 0xff)
                {
7064
                    v.push_back(0x98);  // one-byte uint8_t for N
7065
                    add_to_vector(v, 1, N);
N
Niels Lohmann 已提交
7066 7067 7068
                }
                else if (N <= 0xffff)
                {
7069
                    v.push_back(0x99);  // two-byte uint16_t for N
7070
                    add_to_vector(v, 2, N);
N
Niels Lohmann 已提交
7071 7072 7073
                }
                else if (N <= 0xffffffff)
                {
7074
                    v.push_back(0x9a);  // four-byte uint32_t for N
7075
                    add_to_vector(v, 4, N);
N
Niels Lohmann 已提交
7076
                }
7077
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
7078 7079
                else if (N <= 0xffffffffffffffff)
                {
7080
                    v.push_back(0x9b);  // eight-byte uint64_t for N
7081
                    add_to_vector(v, 8, N);
N
Niels Lohmann 已提交
7082
                }
7083
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097

                // 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)
                {
7098
                    v.push_back(0xa0 + N);  // 1 byte for object + size
N
Niels Lohmann 已提交
7099 7100 7101 7102
                }
                else if (N <= 0xff)
                {
                    v.push_back(0xb8);
7103
                    add_to_vector(v, 1, N);  // one-byte uint8_t for N
N
Niels Lohmann 已提交
7104 7105 7106 7107
                }
                else if (N <= 0xffff)
                {
                    v.push_back(0xb9);
7108
                    add_to_vector(v, 2, N);  // two-byte uint16_t for N
N
Niels Lohmann 已提交
7109 7110 7111 7112
                }
                else if (N <= 0xffffffff)
                {
                    v.push_back(0xba);
7113
                    add_to_vector(v, 4, N);  // four-byte uint32_t for N
N
Niels Lohmann 已提交
7114
                }
7115
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
7116 7117 7118
                else if (N <= 0xffffffffffffffff)
                {
                    v.push_back(0xbb);
7119
                    add_to_vector(v, 8, N);  // eight-byte uint64_t for N
N
Niels Lohmann 已提交
7120
                }
7121
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138

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

7139 7140 7141 7142 7143 7144

    /*
    @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 已提交
7145 7146 7147
    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.
7148

N
Niels Lohmann 已提交
7149 7150
    This function checks whether reading the bytes is safe; that is, offset is
    a valid index in the vector, offset+len
7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166

    @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)
        {
7167
            JSON_THROW(std::out_of_range("len out of range"));
7168 7169 7170 7171 7172
        }

        // second case: adding offset would result in overflow
        if ((size > (std::numeric_limits<size_t>::max() - offset)))
        {
7173
            JSON_THROW(std::out_of_range("len+offset out of range"));
7174
        }
N
Niels Lohmann 已提交
7175 7176 7177 7178

        // last case: reading past the end of the vector
        if (len + offset > size)
        {
7179
            JSON_THROW(std::out_of_range("len+offset out of range"));
N
Niels Lohmann 已提交
7180
        }
7181 7182
    }

N
Niels 已提交
7183
    /*!
7184 7185
    @brief create a JSON value from a given MessagePack vector

N
Niels 已提交
7186 7187
    @param[in] v  MessagePack serialization
    @param[in] idx  byte index to start reading from @a v
7188 7189 7190 7191 7192 7193 7194 7195

    @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 已提交
7196 7197 7198
    */
    static basic_json from_msgpack_internal(const std::vector<uint8_t>& v, size_t& idx)
    {
N
Niels Lohmann 已提交
7199 7200 7201
        // make sure reading 1 byte is safe
        check_length(v.size(), 1, idx);

N
Niels 已提交
7202 7203 7204
        // store and increment index
        const size_t current_idx = idx++;

N
Niels Lohmann 已提交
7205
        if (v[current_idx] <= 0xbf)
N
Niels 已提交
7206
        {
N
Niels Lohmann 已提交
7207
            if (v[current_idx] <= 0x7f) // positive fixint
N
Niels 已提交
7208
            {
N
Niels Lohmann 已提交
7209
                return v[current_idx];
N
Niels 已提交
7210
            }
N
Niels Lohmann 已提交
7211
            if (v[current_idx] <= 0x8f) // fixmap
N
Niels 已提交
7212
            {
N
Niels Lohmann 已提交
7213 7214 7215 7216 7217 7218 7219 7220
                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 已提交
7221
            }
N
Niels Lohmann 已提交
7222
            else if (v[current_idx] <= 0x9f) // fixarray
N
Niels 已提交
7223
            {
N
Niels Lohmann 已提交
7224 7225 7226 7227 7228 7229 7230
                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 已提交
7231
            }
N
Niels Lohmann 已提交
7232
            else // fixstr
N
Niels 已提交
7233
            {
N
Niels Lohmann 已提交
7234 7235 7236
                const size_t len = v[current_idx] & 0x1f;
                const size_t offset = current_idx + 1;
                idx += len; // skip content bytes
7237
                check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
7238
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels 已提交
7239 7240
            }
        }
N
Niels Lohmann 已提交
7241
        else if (v[current_idx] >= 0xe0) // negative fixint
N
Niels 已提交
7242
        {
N
Niels Lohmann 已提交
7243
            return static_cast<int8_t>(v[current_idx]);
N
Niels 已提交
7244
        }
N
Niels Lohmann 已提交
7245
        else
N
Niels 已提交
7246
        {
N
Niels Lohmann 已提交
7247
            switch (v[current_idx])
N
Niels 已提交
7248
            {
N
Niels Lohmann 已提交
7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269
                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 已提交
7270
                        reinterpret_cast<uint8_t*>(&res)[sizeof(float) - byte - 1] = v.at(current_idx + 1 + byte);
N
Niels Lohmann 已提交
7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281
                    }
                    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 已提交
7282
                        reinterpret_cast<uint8_t*>(&res)[sizeof(double) - byte - 1] = v.at(current_idx + 1 + byte);
N
Niels Lohmann 已提交
7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337
                    }
                    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
                {
7338
                    const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
N
Niels Lohmann 已提交
7339 7340
                    const size_t offset = current_idx + 2;
                    idx += len + 1; // skip size byte + content bytes
7341
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
7342 7343 7344 7345 7346
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xda: // str 16
                {
7347
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
7348 7349
                    const size_t offset = current_idx + 3;
                    idx += len + 2; // skip 2 size bytes + content bytes
7350
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
7351 7352 7353 7354 7355
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xdb: // str 32
                {
7356
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
7357 7358
                    const size_t offset = current_idx + 5;
                    idx += len + 4; // skip 4 size bytes + content bytes
7359
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
7360 7361 7362 7363 7364 7365
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xdc: // array 16
                {
                    basic_json result = value_t::array;
7366
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377
                    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;
7378
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389
                    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;
7390
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402
                    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;
7403
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414
                    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:
                {
7415
                    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 已提交
7416
                }
N
Niels 已提交
7417 7418 7419 7420
            }
        }
    }

7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434
    /*!
    @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 已提交
7435 7436 7437 7438 7439
    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++;

7440
        switch (v.at(current_idx))
7441
        {
N
Niels Lohmann 已提交
7442
            // Integer 0x00..0x17 (0..23)
7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466
            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:
7467
            {
7468
                return v[current_idx];
7469
            }
7470

N
Niels Lohmann 已提交
7471
            case 0x18: // Unsigned integer (one-byte uint8_t follows)
N
Niels Lohmann 已提交
7472
            {
7473 7474
                idx += 1; // skip content byte
                return get_from_vector<uint8_t>(v, current_idx);
N
Niels Lohmann 已提交
7475
            }
7476

N
Niels Lohmann 已提交
7477
            case 0x19: // Unsigned integer (two-byte uint16_t follows)
N
Niels Lohmann 已提交
7478
            {
7479 7480
                idx += 2; // skip 2 content bytes
                return get_from_vector<uint16_t>(v, current_idx);
N
Niels Lohmann 已提交
7481
            }
7482

N
Niels Lohmann 已提交
7483
            case 0x1a: // Unsigned integer (four-byte uint32_t follows)
N
Niels Lohmann 已提交
7484
            {
7485 7486
                idx += 4; // skip 4 content bytes
                return get_from_vector<uint32_t>(v, current_idx);
N
Niels Lohmann 已提交
7487
            }
7488

N
Niels Lohmann 已提交
7489
            case 0x1b: // Unsigned integer (eight-byte uint64_t follows)
N
Niels Lohmann 已提交
7490
            {
7491 7492
                idx += 8; // skip 8 content bytes
                return get_from_vector<uint64_t>(v, current_idx);
N
Niels Lohmann 已提交
7493
            }
7494

N
Niels Lohmann 已提交
7495
            // Negative integer -1-0x00..-1-0x17 (-1..-24)
7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519
            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 已提交
7520
            {
7521
                return static_cast<int8_t>(0x20 - 1 - v[current_idx]);
N
Niels Lohmann 已提交
7522
            }
7523

N
Niels Lohmann 已提交
7524
            case 0x38: // Negative integer (one-byte uint8_t follows)
7525
            {
7526 7527
                idx += 1; // skip content byte
                // must be uint8_t !
7528
                return static_cast<number_integer_t>(-1) - get_from_vector<uint8_t>(v, current_idx);
7529
            }
7530

N
Niels Lohmann 已提交
7531
            case 0x39: // Negative integer -1-n (two-byte uint16_t follows)
N
Niels Lohmann 已提交
7532
            {
7533
                idx += 2; // skip 2 content bytes
7534
                return static_cast<number_integer_t>(-1) - get_from_vector<uint16_t>(v, current_idx);
N
Niels Lohmann 已提交
7535
            }
7536

N
Niels Lohmann 已提交
7537
            case 0x3a: // Negative integer -1-n (four-byte uint32_t follows)
N
Niels Lohmann 已提交
7538
            {
7539
                idx += 4; // skip 4 content bytes
7540
                return static_cast<number_integer_t>(-1) - get_from_vector<uint32_t>(v, current_idx);
N
Niels Lohmann 已提交
7541
            }
7542

N
Niels Lohmann 已提交
7543
            case 0x3b: // Negative integer -1-n (eight-byte uint64_t follows)
N
Niels Lohmann 已提交
7544
            {
7545
                idx += 8; // skip 8 content bytes
7546
                return static_cast<number_integer_t>(-1) - static_cast<number_integer_t>(get_from_vector<uint64_t>(v, current_idx));
N
Niels Lohmann 已提交
7547
            }
7548

N
Niels Lohmann 已提交
7549
            // UTF-8 string (0x00..0x17 bytes follow)
7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573
            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 已提交
7574
            {
7575
                const auto len = static_cast<size_t>(v[current_idx] - 0x60);
7576 7577
                const size_t offset = current_idx + 1;
                idx += len; // skip content bytes
7578
                check_length(v.size(), len, offset);
7579
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels Lohmann 已提交
7580
            }
7581

N
Niels Lohmann 已提交
7582
            case 0x78: // UTF-8 string (one-byte uint8_t for n follows)
N
Niels Lohmann 已提交
7583
            {
7584
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
7585 7586
                const size_t offset = current_idx + 2;
                idx += len + 1; // skip size byte + content bytes
7587
                check_length(v.size(), len, offset);
7588
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels Lohmann 已提交
7589
            }
7590

N
Niels Lohmann 已提交
7591
            case 0x79: // UTF-8 string (two-byte uint16_t for n follow)
7592
            {
7593
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
7594 7595
                const size_t offset = current_idx + 3;
                idx += len + 2; // skip 2 size bytes + content bytes
7596
                check_length(v.size(), len, offset);
7597
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
7598
            }
7599

N
Niels Lohmann 已提交
7600
            case 0x7a: // UTF-8 string (four-byte uint32_t for n follow)
7601
            {
7602
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
7603 7604
                const size_t offset = current_idx + 5;
                idx += len + 4; // skip 4 size bytes + content bytes
7605
                check_length(v.size(), len, offset);
7606
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
7607
            }
7608

N
Niels Lohmann 已提交
7609
            case 0x7b: // UTF-8 string (eight-byte uint64_t for n follow)
7610
            {
7611
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
7612 7613
                const size_t offset = current_idx + 9;
                idx += len + 8; // skip 8 size bytes + content bytes
7614
                check_length(v.size(), len, offset);
7615
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
7616
            }
7617 7618

            case 0x7f: // UTF-8 string (indefinite length)
7619
            {
7620
                std::string result;
7621
                while (v.at(idx) != 0xff)
7622 7623 7624 7625 7626 7627 7628
                {
                    string_t s = from_cbor_internal(v, idx);
                    result += s;
                }
                // skip break byte (0xFF)
                idx += 1;
                return result;
7629
            }
7630

N
Niels Lohmann 已提交
7631
            // array (0x00..0x17 data items follow)
7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655
            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 已提交
7656
            {
7657
                basic_json result = value_t::array;
7658
                const auto len = static_cast<size_t>(v[current_idx] - 0x80);
7659 7660 7661 7662 7663
                for (size_t i = 0; i < len; ++i)
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                return result;
N
Niels Lohmann 已提交
7664
            }
7665

N
Niels Lohmann 已提交
7666
            case 0x98: // array (one-byte uint8_t for n follows)
N
Niels Lohmann 已提交
7667
            {
7668
                basic_json result = value_t::array;
7669
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
7670 7671 7672 7673 7674 7675
                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 已提交
7676 7677
            }

N
Niels Lohmann 已提交
7678
            case 0x99: // array (two-byte uint16_t for n follow)
7679 7680
            {
                basic_json result = value_t::array;
7681
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
7682 7683 7684 7685 7686 7687 7688 7689
                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 已提交
7690
            case 0x9a: // array (four-byte uint32_t for n follow)
7691 7692
            {
                basic_json result = value_t::array;
7693
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
7694 7695 7696 7697 7698 7699 7700 7701
                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 已提交
7702
            case 0x9b: // array (eight-byte uint64_t for n follow)
7703 7704
            {
                basic_json result = value_t::array;
7705
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716
                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;
7717
                while (v.at(idx) != 0xff)
7718 7719 7720 7721 7722 7723 7724 7725
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                // skip break byte (0xFF)
                idx += 1;
                return result;
            }

N
Niels Lohmann 已提交
7726
            // map (0x00..0x17 pairs of data items follow)
7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752
            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;
7753
                const auto len = static_cast<size_t>(v[current_idx] - 0xa0);
7754 7755 7756 7757 7758 7759 7760 7761
                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 已提交
7762
            case 0xb8: // map (one-byte uint8_t for n follows)
7763 7764
            {
                basic_json result = value_t::object;
7765
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
7766 7767 7768 7769 7770 7771 7772 7773 7774
                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 已提交
7775
            case 0xb9: // map (two-byte uint16_t for n follow)
7776 7777
            {
                basic_json result = value_t::object;
7778
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
7779 7780 7781 7782 7783 7784 7785 7786 7787
                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 已提交
7788
            case 0xba: // map (four-byte uint32_t for n follow)
7789 7790
            {
                basic_json result = value_t::object;
7791
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
7792 7793 7794 7795 7796 7797 7798 7799 7800
                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 已提交
7801
            case 0xbb: // map (eight-byte uint64_t for n follow)
7802 7803
            {
                basic_json result = value_t::object;
7804
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816
                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;
7817
                while (v.at(idx) != 0xff)
7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841
                {
                    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 已提交
7842
            case 0xf9: // Half-Precision Float (two-byte IEEE 754)
7843 7844 7845 7846
            {
                idx += 2; // skip two content bytes

                // code from RFC 7049, Appendix D, Figure 3:
N
Niels Lohmann 已提交
7847 7848 7849 7850 7851 7852
                // 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.
7853
                const int half = (v.at(current_idx + 1) << 8) + v.at(current_idx + 2);
7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868
                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
                {
                    val = mant == 0 ? INFINITY : NAN;
                }
N
Niels Lohmann 已提交
7869
                return (half & 0x8000) != 0 ? -val : val;
7870 7871
            }

N
Niels Lohmann 已提交
7872
            case 0xfa: // Single-Precision Float (four-byte IEEE 754)
7873 7874 7875 7876 7877
            {
                // copy bytes in reverse order into the float variable
                float res;
                for (size_t byte = 0; byte < sizeof(float); ++byte)
                {
N
Niels Lohmann 已提交
7878
                    reinterpret_cast<uint8_t*>(&res)[sizeof(float) - byte - 1] = v.at(current_idx + 1 + byte);
7879 7880 7881 7882 7883
                }
                idx += sizeof(float); // skip content bytes
                return res;
            }

N
Niels Lohmann 已提交
7884
            case 0xfb: // Double-Precision Float (eight-byte IEEE 754)
7885 7886 7887 7888 7889
            {
                // copy bytes in reverse order into the double variable
                double res;
                for (size_t byte = 0; byte < sizeof(double); ++byte)
                {
N
Niels Lohmann 已提交
7890
                    reinterpret_cast<uint8_t*>(&res)[sizeof(double) - byte - 1] = v.at(current_idx + 1 + byte);
7891 7892 7893 7894 7895
                }
                idx += sizeof(double); // skip content bytes
                return res;
            }

N
Niels Lohmann 已提交
7896
            default: // anything else (0xFF is handled inside the other types)
7897
            {
7898
                JSON_THROW(std::invalid_argument("error parsing a CBOR @ " + std::to_string(current_idx) + ": " + std::to_string(static_cast<int>(v[current_idx]))));
7899 7900
            }
        }
N
Niels Lohmann 已提交
7901 7902
    }

N
Niels 已提交
7903 7904
  public:
    /*!
7905 7906 7907 7908 7909 7910
    @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 已提交
7911
    @param[in] j  JSON value to serialize
7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922
    @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
    @sa @ref from_msgpack(const std::vector<uint8_t>&) for the analogous
        deserialization
    @sa @ref to_cbor(const basic_json& for the related CBOR format
N
Niels 已提交
7923 7924 7925 7926 7927 7928 7929 7930
    */
    static std::vector<uint8_t> to_msgpack(const basic_json& j)
    {
        std::vector<uint8_t> result;
        to_msgpack_internal(j, result);
        return result;
    }

7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952
    /*!
    @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
    @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
    @sa @ref from_cbor(const std::vector<uint8_t>&) for the related CBOR format
    */
N
Niels 已提交
7953 7954 7955 7956 7957 7958
    static basic_json from_msgpack(const std::vector<uint8_t>& v)
    {
        size_t i = 0;
        return from_msgpack_internal(v, i);
    }

N
Niels Lohmann 已提交
7959
    /*!
7960 7961 7962 7963 7964 7965 7966
    @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 已提交
7967
    @param[in] j  JSON value to serialize
7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978
    @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
    @sa @ref from_cbor(const std::vector<uint8_t>&) for the analogous
        deserialization
    @sa @ref to_msgpack(const basic_json& for the related MessagePack format
N
Niels Lohmann 已提交
7979 7980 7981 7982 7983 7984 7985 7986
    */
    static std::vector<uint8_t> to_cbor(const basic_json& j)
    {
        std::vector<uint8_t> result;
        to_cbor_internal(j, result);
        return result;
    }

7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009
    /*!
    @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
    @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
    @sa @ref from_msgpack(const std::vector<uint8_t>&) for the related
        MessagePack format
    */
N
Niels Lohmann 已提交
8010 8011 8012 8013 8014 8015
    static basic_json from_cbor(const std::vector<uint8_t>& v)
    {
        size_t i = 0;
        return from_cbor_internal(v, i);
    }

N
Niels 已提交
8016
    /// @}
N
Niels 已提交
8017 8018 8019 8020 8021

    ///////////////////////////
    // convenience functions //
    ///////////////////////////

N
Niels 已提交
8022 8023 8024 8025 8026 8027
    /*!
    @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 已提交
8028
    @return basically a string representation of a the @a m_type member
N
Niels 已提交
8029 8030 8031

    @complexity Constant.

8032
    @liveexample{The following code exemplifies `type_name()` for all JSON
8033
    types.,type_name}
8034

8035
    @since version 1.0.0, public since 2.1.0
N
Niels 已提交
8036
    */
T
Théo DELRIEU 已提交
8037 8038
    std::string type_name() const
    {
T
Théo DELRIEU 已提交
8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057
        {
            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 已提交
8058
    }
N
Niels 已提交
8059

8060
  private:
N
Niels 已提交
8061 8062 8063 8064 8065 8066 8067 8068 8069 8070
    /*!
    @brief calculates the extra space to escape a JSON string

    @param[in] s  the string to escape
    @return the number of characters required to escape string @a s

    @complexity Linear in the length of string @a s.
    */
    static std::size_t extra_space(const string_t& s) noexcept
    {
N
Niels 已提交
8071 8072
        return std::accumulate(s.begin(), s.end(), size_t{},
                               [](size_t res, typename string_t::value_type c)
N
Niels 已提交
8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084
        {
            switch (c)
            {
                case '"':
                case '\\':
                case '\b':
                case '\f':
                case '\n':
                case '\r':
                case '\t':
                {
                    // from c (1 byte) to \x (2 bytes)
N
Niels 已提交
8085
                    return res + 1;
N
Niels 已提交
8086 8087 8088 8089 8090 8091 8092
                }

                default:
                {
                    if (c >= 0x00 and c <= 0x1f)
                    {
                        // from c (1 byte) to \uxxxx (6 bytes)
N
Niels 已提交
8093 8094
                        return res + 5;
                    }
N
Niels Lohmann 已提交
8095 8096

                    return res;
N
Niels 已提交
8097 8098
                }
            }
N
Niels 已提交
8099
        });
N
Niels 已提交
8100 8101
    }

N
Niels 已提交
8102 8103
    /*!
    @brief escape a string
N
Niels 已提交
8104

N
Niels 已提交
8105 8106
    Escape a string by replacing certain special characters by a sequence of
    an escape character (backslash) and another character and other control
N
Niels 已提交
8107 8108 8109
    characters by a sequence of "\u" followed by a four-digit hex
    representation.

N
Niels 已提交
8110
    @param[in] s  the string to escape
N
Niels 已提交
8111 8112 8113
    @return  the escaped string

    @complexity Linear in the length of string @a s.
N
Niels 已提交
8114
    */
N
Niels 已提交
8115
    static string_t escape_string(const string_t& s)
N
Niels 已提交
8116
    {
N
Niels 已提交
8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127
        const auto space = extra_space(s);
        if (space == 0)
        {
            return s;
        }

        // create a result string of necessary size
        string_t result(s.size() + space, '\\');
        std::size_t pos = 0;

        for (const auto& c : s)
N
Niels 已提交
8128 8129 8130 8131 8132 8133
        {
            switch (c)
            {
                // quotation mark (0x22)
                case '"':
                {
N
Niels 已提交
8134 8135
                    result[pos + 1] = '"';
                    pos += 2;
N
Niels 已提交
8136 8137
                    break;
                }
N
Niels 已提交
8138

N
Niels 已提交
8139 8140 8141
                // reverse solidus (0x5c)
                case '\\':
                {
N
Niels 已提交
8142 8143
                    // nothing to change
                    pos += 2;
N
Niels 已提交
8144 8145
                    break;
                }
N
Niels 已提交
8146

N
Niels 已提交
8147 8148 8149
                // backspace (0x08)
                case '\b':
                {
N
Niels 已提交
8150 8151
                    result[pos + 1] = 'b';
                    pos += 2;
N
Niels 已提交
8152 8153
                    break;
                }
N
Niels 已提交
8154

N
Niels 已提交
8155 8156 8157
                // formfeed (0x0c)
                case '\f':
                {
N
Niels 已提交
8158 8159
                    result[pos + 1] = 'f';
                    pos += 2;
N
Niels 已提交
8160 8161
                    break;
                }
N
Niels 已提交
8162

N
Niels 已提交
8163 8164 8165
                // newline (0x0a)
                case '\n':
                {
N
Niels 已提交
8166 8167
                    result[pos + 1] = 'n';
                    pos += 2;
N
Niels 已提交
8168 8169
                    break;
                }
N
Niels 已提交
8170

N
Niels 已提交
8171 8172 8173
                // carriage return (0x0d)
                case '\r':
                {
N
Niels 已提交
8174 8175
                    result[pos + 1] = 'r';
                    pos += 2;
N
Niels 已提交
8176 8177
                    break;
                }
N
Niels 已提交
8178

N
Niels 已提交
8179 8180 8181
                // horizontal tab (0x09)
                case '\t':
                {
N
Niels 已提交
8182 8183
                    result[pos + 1] = 't';
                    pos += 2;
N
Niels 已提交
8184 8185 8186 8187 8188
                    break;
                }

                default:
                {
8189
                    if (c >= 0x00 and c <= 0x1f)
N
Niels 已提交
8190
                    {
N
Niels 已提交
8191 8192
                        // convert a number 0..15 to its hex representation
                        // (0..f)
N
Niels 已提交
8193
                        static const char hexify[16] =
8194
                        {
N
Niels 已提交
8195 8196
                            '0', '1', '2', '3', '4', '5', '6', '7',
                            '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'
8197 8198
                        };

N
Niels 已提交
8199
                        // print character c as \uxxxx
N
Niels 已提交
8200
                        for (const char m :
N
Niels 已提交
8201
                    { 'u', '0', '0', hexify[c >> 4], hexify[c & 0x0f]
N
Niels 已提交
8202
                        })
8203 8204 8205 8206 8207
                        {
                            result[++pos] = m;
                        }

                        ++pos;
N
Niels 已提交
8208 8209 8210 8211
                    }
                    else
                    {
                        // all other characters are added as-is
N
Niels 已提交
8212
                        result[pos++] = c;
N
Niels 已提交
8213 8214 8215 8216 8217
                    }
                    break;
                }
            }
        }
N
Niels 已提交
8218 8219

        return result;
N
Niels 已提交
8220 8221
    }

A
Alex Astashyn 已提交
8222 8223 8224 8225 8226 8227

    /*!
    @brief locale-independent serialization for built-in arithmetic types
    */
    struct numtostr
    {
8228
      public:
A
Alex Astashyn 已提交
8229
        template<typename T>
8230
        numtostr(T value)
A
Alex Astashyn 已提交
8231 8232 8233 8234
        {
            x_write(value, std::is_integral<T>());
        }

8235
        operator const char* () const
A
Alex Astashyn 已提交
8236 8237 8238 8239 8240 8241 8242 8243 8244
        {
            return m_buf.data();
        }

        const char* c_str() const
        {
            return m_buf.data();
        }

8245
      private:
A
Alex Astashyn 已提交
8246
        static constexpr size_t s_capacity = 30;
8247 8248
        std::array < char, s_capacity + 2 > m_buf{{}}; // +2 for leading '-'
        // and trailing '\0'
A
Alex Astashyn 已提交
8249 8250 8251
        template<typename T>
        void x_write(T x, std::true_type)
        {
8252 8253
            static_assert(std::numeric_limits<T>::digits10 <= s_capacity, "");

A
Alex Astashyn 已提交
8254 8255 8256
            const bool is_neg = x < 0;
            size_t i = 0;

8257
            while (x and i < s_capacity)
A
Alex Astashyn 已提交
8258
            {
A
Alex Astashyn 已提交
8259 8260
                const auto digit = std::labs(static_cast<long>(x % 10));
                m_buf[i++] = static_cast<char>('0' + digit);
A
Alex Astashyn 已提交
8261 8262 8263
                x /= 10;
            }

8264
            assert(i < s_capacity);
A
Alex Astashyn 已提交
8265

8266
            if (i == 0)
A
Alex Astashyn 已提交
8267 8268 8269 8270
            {
                m_buf[i++] = '0';
            }

8271
            if (is_neg)
A
Alex Astashyn 已提交
8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283
            {
                m_buf[i++] = '-';
            }

            std::reverse(m_buf.begin(), m_buf.begin() + i);
        }

        template<typename T>
        void x_write(T x, std::false_type)
        {
            if (x == 0)
            {
8284
                std::strcpy(m_buf.data(),
A
Alex Astashyn 已提交
8285 8286 8287 8288
                            std::signbit(x) ? "-0.0" : "0.0");
                return;
            }

8289 8290
            static constexpr auto d =
                std::numeric_limits<number_float_t>::digits10;
8291
            static_assert(d == 6 or d == 15 or d == 16 or d == 17, "");
A
Alex Astashyn 已提交
8292

8293
            static constexpr auto fmt = d == 6  ? "%.7g"
8294 8295 8296 8297
                                        : d == 15 ? "%.16g"
                                        : d == 16 ? "%.17g"
                                        : d == 17 ? "%.18g"
                                        :           "%.19g";
8298
            // I'm not sure why we need to +1 the precision,
A
Alex Astashyn 已提交
8299 8300 8301 8302 8303
            // but without it there's a unit-test that fails
            // that asserts precision of the output

            snprintf(m_buf.data(), m_buf.size(), fmt, x);

8304 8305 8306 8307
#if 0
            // C locales and C++ locales are similar but
            // different.
            //
8308
            // If working with C++ streams we'd've used
8309
            // these, but for C formatting functions we
8310
            // have to use C locales (setlocale / localeconv),
8311 8312
            // rather than C++ locales (std::locale installed
            // by std::locale::global()).
A
Alex Astashyn 已提交
8313 8314
            const std::locale loc;

8315
            const char thousands_sep =
8316 8317
                std::use_facet< std::numpunct<char>>(
                    loc).thousands_sep();
8318 8319

            const char decimal_point =
8320 8321
                std::use_facet< std::numpunct<char>>(
                    loc).decimal_point();
8322 8323 8324 8325
#else
            const auto loc = localeconv();
            assert(loc != nullptr);
            const char thousands_sep = !loc->thousands_sep ? '\0'
8326
                                       : loc->thousands_sep[0];
A
Alex Astashyn 已提交
8327

8328
            const char decimal_point = !loc->decimal_point ? '\0'
8329
                                       : loc->decimal_point[0];
8330 8331 8332
#endif

            // erase thousands separator
8333 8334 8335 8336
            if (thousands_sep)
            {
                auto end = std::remove(m_buf.begin(),
                                       m_buf.end(),
8337
                                       thousands_sep);
A
Alex Astashyn 已提交
8338 8339 8340 8341 8342

                std::fill(end, m_buf.end(), '\0');
            }

            // convert decimal point to '.'
8343
            if (decimal_point and decimal_point != '.')
A
Alex Astashyn 已提交
8344
            {
8345
                for (auto& c : m_buf)
A
Alex Astashyn 已提交
8346
                {
8347
                    if (c == decimal_point)
A
Alex Astashyn 已提交
8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359
                    {
                        c = '.';
                        break;
                    }
                }
            }

            // determine if need to apperd ".0"
            auto data_end = m_buf.begin() + strlen(m_buf.data());

            const bool value_is_int_like =
                std::find_if(m_buf.begin(), data_end,
8360 8361 8362 8363 8364 8365 8366 8367
                             [](const char c)
            {
                return c == '.'
                       or c == 'e'
                       or c == 'E';
            })
            == data_end;

A
Alex Astashyn 已提交
8368
            assert(data_end + 2 < m_buf.end());
8369
            if (value_is_int_like)
A
Alex Astashyn 已提交
8370 8371 8372 8373 8374 8375 8376 8377
            {
                strcat(m_buf.data(), ".0");
            }
        }
    };



N
Niels 已提交
8378 8379
    /*!
    @brief internal implementation of the serialization function
N
Niels 已提交
8380

N
Niels 已提交
8381
    This function is called by the public member function dump and organizes
N
Niels 已提交
8382
    the serialization internally. The indentation level is propagated as
N
Niels 已提交
8383 8384
    additional parameter. In case of arrays and objects, the function is
    called recursively. Note that
N
Niels 已提交
8385

N
Niels 已提交
8386 8387 8388
    - strings and object keys are escaped using `escape_string()`
    - integer numbers are converted implicitly via `operator<<`
    - floating-point numbers are converted to a string using `"%g"` format
N
Niels 已提交
8389

N
Niels 已提交
8390 8391 8392 8393
    @param[out] o              stream to write to
    @param[in] pretty_print    whether the output shall be pretty-printed
    @param[in] indent_step     the indent level
    @param[in] current_indent  the current indent level (only used internally)
N
Niels 已提交
8394
    */
N
Niels 已提交
8395 8396 8397
    void dump(std::ostream& o,
              const bool pretty_print,
              const unsigned int indent_step,
N
Niels 已提交
8398
              const unsigned int current_indent = 0) const
N
Niels 已提交
8399
    {
N
Niels 已提交
8400
        // variable to hold indentation for recursive calls
N
Niels 已提交
8401
        unsigned int new_indent = current_indent;
N
Niels 已提交
8402

N
Niels 已提交
8403 8404
        switch (m_type)
        {
8405
            case value_t::object:
N
Niels 已提交
8406 8407 8408
            {
                if (m_value.object->empty())
                {
N
Niels 已提交
8409 8410
                    o << "{}";
                    return;
N
Niels 已提交
8411 8412
                }

N
Niels 已提交
8413
                o << "{";
N
Niels 已提交
8414 8415

                // increase indentation
N
Niels 已提交
8416
                if (pretty_print)
N
Niels 已提交
8417
                {
N
Niels 已提交
8418
                    new_indent += indent_step;
N
Niels 已提交
8419
                    o << "\n";
N
Niels 已提交
8420 8421 8422 8423 8424 8425
                }

                for (auto i = m_value.object->cbegin(); i != m_value.object->cend(); ++i)
                {
                    if (i != m_value.object->cbegin())
                    {
N
Niels 已提交
8426
                        o << (pretty_print ? ",\n" : ",");
N
Niels 已提交
8427
                    }
N
Niels 已提交
8428
                    o << string_t(new_indent, ' ') << "\""
T
Théo DELRIEU 已提交
8429 8430 8431
                      << escape_string(i->first) << "\":"
                      << (pretty_print ? " " : "");
                    i->second.dump(o, pretty_print, indent_step, new_indent);
N
Niels 已提交
8432 8433
                }

T
Théo DELRIEU 已提交
8434 8435
                // decrease indentation
                if (pretty_print)
N
Niels 已提交
8436
                {
N
Niels 已提交
8437
                    new_indent -= indent_step;
N
Niels 已提交
8438
                    o << "\n";
N
Niels 已提交
8439 8440
                }

N
Niels 已提交
8441 8442
                o << string_t(new_indent, ' ') + "}";
                return;
N
Niels 已提交
8443 8444
            }

8445
            case value_t::array:
N
Niels 已提交
8446 8447 8448
            {
                if (m_value.array->empty())
                {
N
Niels 已提交
8449 8450
                    o << "[]";
                    return;
N
Niels 已提交
8451 8452
                }

N
Niels 已提交
8453
                o << "[";
N
Niels 已提交
8454 8455

                // increase indentation
N
Niels 已提交
8456
                if (pretty_print)
N
Niels 已提交
8457
                {
N
Niels 已提交
8458
                    new_indent += indent_step;
N
Niels 已提交
8459
                    o << "\n";
N
Niels 已提交
8460 8461 8462 8463 8464 8465
                }

                for (auto i = m_value.array->cbegin(); i != m_value.array->cend(); ++i)
                {
                    if (i != m_value.array->cbegin())
                    {
N
Niels 已提交
8466
                        o << (pretty_print ? ",\n" : ",");
N
Niels 已提交
8467
                    }
N
Niels 已提交
8468
                    o << string_t(new_indent, ' ');
N
Niels 已提交
8469
                    i->dump(o, pretty_print, indent_step, new_indent);
N
Niels 已提交
8470 8471 8472
                }

                // decrease indentation
N
Niels 已提交
8473
                if (pretty_print)
N
Niels 已提交
8474
                {
N
Niels 已提交
8475
                    new_indent -= indent_step;
N
Niels 已提交
8476
                    o << "\n";
N
Niels 已提交
8477 8478
                }

N
Niels 已提交
8479
                o << string_t(new_indent, ' ') << "]";
T
Théo DELRIEU 已提交
8480
                return;
N
Niels 已提交
8481 8482
            }

T
Théo DELRIEU 已提交
8483
            case value_t::string:
N
Niels 已提交
8484
            {
N
Niels 已提交
8485
                o << string_t("\"") << escape_string(*m_value.string) << "\"";
T
Théo DELRIEU 已提交
8486
                return;
N
Niels 已提交
8487 8488
            }

T
Théo DELRIEU 已提交
8489
            case value_t::boolean:
N
Niels 已提交
8490
            {
N
Niels 已提交
8491 8492
                o << (m_value.boolean ? "true" : "false");
                return;
N
Niels 已提交
8493 8494
            }

8495
            case value_t::number_integer:
N
Niels 已提交
8496
            {
A
Alex Astashyn 已提交
8497
                o << numtostr(m_value.number_integer).c_str();
N
Niels 已提交
8498
                return;
N
Niels 已提交
8499 8500
            }

8501 8502
            case value_t::number_unsigned:
            {
A
Alex Astashyn 已提交
8503
                o << numtostr(m_value.number_unsigned).c_str();
8504 8505 8506
                return;
            }

8507
            case value_t::number_float:
N
Niels 已提交
8508
            {
A
Alex Astashyn 已提交
8509
                o << numtostr(m_value.number_float).c_str();
N
Niels 已提交
8510
                return;
N
Niels 已提交
8511
            }
N
Niels 已提交
8512

8513
            case value_t::discarded:
N
Niels 已提交
8514
            {
N
Niels 已提交
8515 8516
                o << "<discarded>";
                return;
N
Niels 已提交
8517
            }
N
Niels 已提交
8518

8519
            case value_t::null:
N
Niels 已提交
8520
            {
N
Niels 已提交
8521 8522
                o << "null";
                return;
N
Niels 已提交
8523
            }
N
Niels 已提交
8524 8525 8526 8527 8528 8529 8530 8531 8532
        }
    }

  private:
    //////////////////////
    // member variables //
    //////////////////////

    /// the type of the current element
N
Niels 已提交
8533
    value_t m_type = value_t::null;
N
Niels 已提交
8534 8535 8536 8537

    /// the value of the current element
    json_value m_value = {};

N
Niels 已提交
8538

N
Niels 已提交
8539
  private:
N
Niels 已提交
8540 8541 8542 8543
    ///////////////
    // iterators //
    ///////////////

8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554
    /*!
    @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 已提交
8555
      public:
T
Théo Delrieu 已提交
8556 8557

        difference_type get_value() const noexcept
T
Théo DELRIEU 已提交
8558 8559 8560 8561 8562 8563 8564 8565
        {
            return m_it;
        }
        /// set iterator to a defined beginning
        void set_begin() noexcept
        {
            m_it = begin_value;
        }
8566

T
Théo DELRIEU 已提交
8567 8568 8569 8570 8571
        /// set iterator to a defined past the end
        void set_end() noexcept
        {
            m_it = end_value;
        }
8572

T
Théo DELRIEU 已提交
8573 8574 8575 8576 8577
        /// return whether the iterator can be dereferenced
        constexpr bool is_begin() const noexcept
        {
            return (m_it == begin_value);
        }
8578

T
Théo DELRIEU 已提交
8579 8580 8581 8582 8583
        /// return whether the iterator is at end
        constexpr bool is_end() const noexcept
        {
            return (m_it == end_value);
        }
8584

T
Théo DELRIEU 已提交
8585 8586 8587 8588
        friend constexpr bool operator==(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it == rhs.m_it;
        }
T
Théo Delrieu 已提交
8589

T
Théo DELRIEU 已提交
8590 8591 8592 8593
        friend constexpr bool operator!=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return !(lhs == rhs);
        }
T
Théo Delrieu 已提交
8594

T
Théo DELRIEU 已提交
8595 8596 8597 8598
        friend constexpr bool operator<(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it < rhs.m_it;
        }
T
Théo Delrieu 已提交
8599

T
Théo DELRIEU 已提交
8600 8601 8602 8603
        friend constexpr bool operator<=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it <= rhs.m_it;
        }
T
Théo Delrieu 已提交
8604

T
Théo DELRIEU 已提交
8605 8606 8607 8608
        friend constexpr bool operator>(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it > rhs.m_it;
        }
T
Théo Delrieu 已提交
8609

T
Théo DELRIEU 已提交
8610 8611 8612 8613
        friend constexpr bool operator>=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it >= rhs.m_it;
        }
T
Théo Delrieu 已提交
8614

T
Théo DELRIEU 已提交
8615 8616 8617 8618 8619 8620
        primitive_iterator_t operator+(difference_type i)
        {
            auto result = *this;
            result += i;
            return result;
        }
T
Théo Delrieu 已提交
8621

T
Théo DELRIEU 已提交
8622 8623 8624 8625
        friend constexpr difference_type operator-(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it - rhs.m_it;
        }
T
Théo Delrieu 已提交
8626

T
Théo DELRIEU 已提交
8627 8628 8629 8630
        friend std::ostream& operator<<(std::ostream& os, primitive_iterator_t it)
        {
            return os << it.m_it;
        }
T
Théo Delrieu 已提交
8631

T
Théo DELRIEU 已提交
8632 8633 8634 8635 8636
        primitive_iterator_t& operator++()
        {
            ++m_it;
            return *this;
        }
T
Théo Delrieu 已提交
8637

N
Niels Lohmann 已提交
8638
        primitive_iterator_t operator++(int)
T
Théo DELRIEU 已提交
8639
        {
N
Niels Lohmann 已提交
8640
            auto result = *this;
T
Théo DELRIEU 已提交
8641
            m_it++;
N
Niels Lohmann 已提交
8642
            return result;
T
Théo DELRIEU 已提交
8643
        }
T
Théo Delrieu 已提交
8644

T
Théo DELRIEU 已提交
8645 8646 8647 8648 8649
        primitive_iterator_t& operator--()
        {
            --m_it;
            return *this;
        }
T
Théo Delrieu 已提交
8650

N
Niels Lohmann 已提交
8651
        primitive_iterator_t operator--(int)
T
Théo DELRIEU 已提交
8652
        {
N
Niels Lohmann 已提交
8653
            auto result = *this;
T
Théo DELRIEU 已提交
8654
            m_it--;
N
Niels Lohmann 已提交
8655
            return result;
T
Théo DELRIEU 已提交
8656
        }
T
Théo Delrieu 已提交
8657

T
Théo DELRIEU 已提交
8658 8659 8660 8661 8662
        primitive_iterator_t& operator+=(difference_type n)
        {
            m_it += n;
            return *this;
        }
8663

T
Théo DELRIEU 已提交
8664 8665 8666 8667 8668
        primitive_iterator_t& operator-=(difference_type n)
        {
            m_it -= n;
            return *this;
        }
8669

T
Théo DELRIEU 已提交
8670 8671 8672
      private:
        static constexpr difference_type begin_value = 0;
        static constexpr difference_type end_value = begin_value + 1;
8673

T
Théo DELRIEU 已提交
8674 8675 8676
        /// iterator as signed integer type
        difference_type m_it = std::numeric_limits<std::ptrdiff_t>::denorm_min();
    };
8677

N
Niels 已提交
8678 8679 8680 8681 8682 8683 8684 8685
    /*!
    @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 已提交
8686 8687
    {
        /// iterator for JSON objects
N
Niels 已提交
8688
        typename object_t::iterator object_iterator;
N
Niels 已提交
8689
        /// iterator for JSON arrays
N
Niels 已提交
8690
        typename array_t::iterator array_iterator;
N
Niels 已提交
8691
        /// generic iterator for all other types
N
Niels 已提交
8692 8693 8694
        primitive_iterator_t primitive_iterator;

        /// create an uninitialized internal_iterator
N
Niels 已提交
8695
        internal_iterator() noexcept
T
Théo DELRIEU 已提交
8696 8697
            : object_iterator(), array_iterator(), primitive_iterator()
        {}
N
Niels 已提交
8698 8699
    };

N
cleanup  
Niels 已提交
8700 8701 8702 8703
    /// proxy class for the iterator_wrapper functions
    template<typename IteratorType>
    class iteration_proxy
    {
T
Théo DELRIEU 已提交
8704
      private:
N
cleanup  
Niels 已提交
8705 8706 8707
        /// helper class for iteration
        class iteration_proxy_internal
        {
T
Théo DELRIEU 已提交
8708
          private:
N
cleanup  
Niels 已提交
8709 8710 8711 8712 8713
            /// the iterator
            IteratorType anchor;
            /// an index for arrays (used to create key names)
            size_t array_index = 0;

T
Théo DELRIEU 已提交
8714
          public:
N
Niels 已提交
8715
            explicit iteration_proxy_internal(IteratorType it) noexcept
T
Théo DELRIEU 已提交
8716 8717
                : anchor(it)
            {}
N
cleanup  
Niels 已提交
8718

T
Théo DELRIEU 已提交
8719 8720 8721 8722 8723
            /// dereference operator (needed for range-based for)
            iteration_proxy_internal& operator*()
            {
                return *this;
            }
8724

T
Théo DELRIEU 已提交
8725 8726 8727 8728 8729
            /// increment operator (needed for range-based for)
            iteration_proxy_internal& operator++()
            {
                ++anchor;
                ++array_index;
8730

T
Théo DELRIEU 已提交
8731 8732
                return *this;
            }
N
cleanup  
Niels 已提交
8733

T
Théo DELRIEU 已提交
8734 8735
            /// inequality operator (needed for range-based for)
            bool operator!= (const iteration_proxy_internal& o) const
N
cleanup  
Niels 已提交
8736
            {
T
Théo DELRIEU 已提交
8737
                return anchor != o.anchor;
N
cleanup  
Niels 已提交
8738 8739
            }

T
Théo DELRIEU 已提交
8740 8741
            /// return key of the iterator
            typename basic_json::string_t key() const
N
cleanup  
Niels 已提交
8742
            {
T
Théo DELRIEU 已提交
8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764
                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 已提交
8765 8766
            }

T
Théo DELRIEU 已提交
8767 8768
            /// return value of the iterator
            typename IteratorType::reference value() const
N
cleanup  
Niels 已提交
8769
            {
T
Théo DELRIEU 已提交
8770
                return anchor.value();
N
cleanup  
Niels 已提交
8771 8772 8773
            }
        };

T
Théo DELRIEU 已提交
8774 8775
        /// the container to iterate
        typename IteratorType::reference container;
N
cleanup  
Niels 已提交
8776

T
Théo DELRIEU 已提交
8777 8778 8779 8780 8781
      public:
        /// construct iteration proxy from a container
        explicit iteration_proxy(typename IteratorType::reference cont)
            : container(cont)
        {}
N
cleanup  
Niels 已提交
8782

T
Théo DELRIEU 已提交
8783 8784 8785 8786 8787
        /// return iterator begin (needed for range-based for)
        iteration_proxy_internal begin() noexcept
        {
            return iteration_proxy_internal(container.begin());
        }
N
cleanup  
Niels 已提交
8788

T
Théo DELRIEU 已提交
8789 8790 8791 8792 8793 8794
        /// return iterator end (needed for range-based for)
        iteration_proxy_internal end() noexcept
        {
            return iteration_proxy_internal(container.end());
        }
    };
N
cleanup  
Niels 已提交
8795

N
Niels 已提交
8796
  public:
N
Niels 已提交
8797
    /*!
8798
    @brief a template for a random access iterator for the @ref basic_json class
N
Niels 已提交
8799

N
Niels Lohmann 已提交
8800 8801
    This class implements a both iterators (iterator and const_iterator) for the
    @ref basic_json class.
N
Niels 已提交
8802

N
Niels 已提交
8803 8804 8805
    @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 已提交
8806 8807
          methods are undefined. **The library uses assertions to detect calls
          on uninitialized iterators.**
N
Niels 已提交
8808

N
Niels 已提交
8809 8810 8811 8812
    @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 已提交
8813

N
Niels Lohmann 已提交
8814
    @since version 1.0.0, simplified in version 2.0.9
N
Niels 已提交
8815
    */
N
Niels Lohmann 已提交
8816
    template<typename U>
T
Théo DELRIEU 已提交
8817
    class iter_impl : public std::iterator<std::random_access_iterator_tag, U>
N
Niels 已提交
8818
    {
N
Niels 已提交
8819
        /// allow basic_json to access private members
8820 8821
        friend class basic_json;

8822 8823 8824 8825 8826
        // 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 已提交
8827
      public:
N
Niels 已提交
8828
        /// the type of the values when the iterator is dereferenced
N
Niels 已提交
8829
        using value_type = typename basic_json::value_type;
N
Niels 已提交
8830
        /// a type to represent differences between iterators
N
Niels 已提交
8831
        using difference_type = typename basic_json::difference_type;
N
Niels 已提交
8832
        /// defines a pointer to the type iterated over (value_type)
8833
        using pointer = typename std::conditional<std::is_const<U>::value,
T
Théo DELRIEU 已提交
8834 8835
              typename basic_json::const_pointer,
              typename basic_json::pointer>::type;
N
Niels 已提交
8836
        /// defines a reference to the type iterated over (value_type)
8837
        using reference = typename std::conditional<std::is_const<U>::value,
T
Théo DELRIEU 已提交
8838 8839
              typename basic_json::const_reference,
              typename basic_json::reference>::type;
N
Niels 已提交
8840
        /// the category of the iterator
N
Niels 已提交
8841
        using iterator_category = std::bidirectional_iterator_tag;
N
Niels 已提交
8842

8843
        /// default constructor
8844
        iter_impl() = default;
8845

N
Niels 已提交
8846 8847 8848 8849 8850 8851
        /*!
        @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`.
        */
8852
        explicit iter_impl(pointer object) noexcept
T
Théo DELRIEU 已提交
8853
            : m_object(object)
8854
        {
T
Théo DELRIEU 已提交
8855
            assert(m_object != nullptr);
8856

T
Théo DELRIEU 已提交
8857
            switch (m_object->m_type)
8858
            {
T
Théo DELRIEU 已提交
8859 8860 8861 8862 8863
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = typename object_t::iterator();
                    break;
                }
8864

T
Théo DELRIEU 已提交
8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875
                case basic_json::value_t::array:
                {
                    m_it.array_iterator = typename array_t::iterator();
                    break;
                }

                default:
                {
                    m_it.primitive_iterator = primitive_iterator_t();
                    break;
                }
N
Niels 已提交
8876 8877
            }
        }
N
Niels 已提交
8878

T
Théo DELRIEU 已提交
8879 8880 8881 8882
        /*
        Use operator `const_iterator` instead of `const_iterator(const iterator&
        other) noexcept` to avoid two class definitions for @ref iterator and
        @ref const_iterator.
8883

T
Théo DELRIEU 已提交
8884 8885 8886 8887
        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 已提交
8888
        {
T
Théo DELRIEU 已提交
8889
            const_iterator ret;
N
Niels 已提交
8890

T
Théo DELRIEU 已提交
8891 8892 8893 8894 8895
            if (m_object)
            {
                ret.m_object = m_object;
                ret.m_it = m_it;
            }
8896

T
Théo DELRIEU 已提交
8897 8898
            return ret;
        }
N
Niels 已提交
8899

T
Théo DELRIEU 已提交
8900 8901 8902 8903 8904 8905 8906 8907
        /*!
        @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 已提交
8908

T
Théo DELRIEU 已提交
8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924
        /*!
        @brief copy assignment
        @param[in,out] other  iterator to copy from
        @note It is not checked whether @a other is initialized.
        */
        iter_impl& operator=(iter_impl other) noexcept(
            std::is_nothrow_move_constructible<pointer>::value and
            std::is_nothrow_move_assignable<pointer>::value and
            std::is_nothrow_move_constructible<internal_iterator>::value and
            std::is_nothrow_move_assignable<internal_iterator>::value
        )
        {
            std::swap(m_object, other.m_object);
            std::swap(m_it, other.m_it);
            return *this;
        }
N
Niels 已提交
8925

T
Théo DELRIEU 已提交
8926 8927 8928 8929 8930 8931
      private:
        /*!
        @brief set the iterator to the first value
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        void set_begin() noexcept
N
Niels 已提交
8932
        {
T
Théo DELRIEU 已提交
8933
            assert(m_object != nullptr);
N
Niels 已提交
8934

T
Théo DELRIEU 已提交
8935
            switch (m_object->m_type)
N
Niels 已提交
8936
            {
T
Théo DELRIEU 已提交
8937 8938 8939 8940 8941
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = m_object->m_value.object->begin();
                    break;
                }
N
Niels 已提交
8942

T
Théo DELRIEU 已提交
8943 8944 8945 8946 8947
                case basic_json::value_t::array:
                {
                    m_it.array_iterator = m_object->m_value.array->begin();
                    break;
                }
N
Niels 已提交
8948

T
Théo DELRIEU 已提交
8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960
                case basic_json::value_t::null:
                {
                    // set to end so begin()==end() is true: null is empty
                    m_it.primitive_iterator.set_end();
                    break;
                }

                default:
                {
                    m_it.primitive_iterator.set_begin();
                    break;
                }
N
Niels 已提交
8961 8962 8963
            }
        }

T
Théo DELRIEU 已提交
8964 8965 8966 8967 8968
        /*!
        @brief set the iterator past the last value
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        void set_end() noexcept
8969
        {
T
Théo DELRIEU 已提交
8970
            assert(m_object != nullptr);
N
Niels 已提交
8971

T
Théo DELRIEU 已提交
8972
            switch (m_object->m_type)
8973
            {
T
Théo DELRIEU 已提交
8974 8975 8976 8977 8978
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = m_object->m_value.object->end();
                    break;
                }
N
Niels 已提交
8979

T
Théo DELRIEU 已提交
8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990
                case basic_json::value_t::array:
                {
                    m_it.array_iterator = m_object->m_value.array->end();
                    break;
                }

                default:
                {
                    m_it.primitive_iterator.set_end();
                    break;
                }
N
Niels 已提交
8991 8992
            }
        }
N
Niels 已提交
8993

T
Théo DELRIEU 已提交
8994 8995 8996 8997 8998 8999
      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
9000
        {
T
Théo DELRIEU 已提交
9001
            assert(m_object != nullptr);
N
Niels 已提交
9002

T
Théo DELRIEU 已提交
9003
            switch (m_object->m_type)
9004
            {
T
Théo DELRIEU 已提交
9005 9006 9007 9008 9009
                case basic_json::value_t::object:
                {
                    assert(m_it.object_iterator != m_object->m_value.object->end());
                    return m_it.object_iterator->second;
                }
N
Niels Lohmann 已提交
9010

T
Théo DELRIEU 已提交
9011 9012 9013 9014 9015
                case basic_json::value_t::array:
                {
                    assert(m_it.array_iterator != m_object->m_value.array->end());
                    return *m_it.array_iterator;
                }
N
Niels 已提交
9016

T
Théo DELRIEU 已提交
9017
                case basic_json::value_t::null:
N
Niels 已提交
9018
                {
T
Théo DELRIEU 已提交
9019
                    JSON_THROW(std::out_of_range("cannot get value"));
N
Niels 已提交
9020 9021
                }

T
Théo DELRIEU 已提交
9022 9023 9024 9025 9026 9027 9028
                default:
                {
                    if (m_it.primitive_iterator.is_begin())
                    {
                        return *m_object;
                    }

9029
                    JSON_THROW(std::out_of_range("cannot get value"));
T
Théo DELRIEU 已提交
9030
                }
N
Niels 已提交
9031 9032 9033
            }
        }

T
Théo DELRIEU 已提交
9034 9035 9036 9037 9038
        /*!
        @brief dereference the iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        pointer operator->() const
N
Niels 已提交
9039
        {
T
Théo DELRIEU 已提交
9040
            assert(m_object != nullptr);
N
Niels 已提交
9041

T
Théo DELRIEU 已提交
9042
            switch (m_object->m_type)
N
Niels 已提交
9043
            {
T
Théo DELRIEU 已提交
9044 9045 9046 9047 9048
                case basic_json::value_t::object:
                {
                    assert(m_it.object_iterator != m_object->m_value.object->end());
                    return &(m_it.object_iterator->second);
                }
N
Niels 已提交
9049

T
Théo DELRIEU 已提交
9050
                case basic_json::value_t::array:
N
Niels 已提交
9051
                {
T
Théo DELRIEU 已提交
9052 9053
                    assert(m_it.array_iterator != m_object->m_value.array->end());
                    return &*m_it.array_iterator;
N
Niels 已提交
9054 9055
                }

T
Théo DELRIEU 已提交
9056 9057 9058 9059 9060 9061 9062
                default:
                {
                    if (m_it.primitive_iterator.is_begin())
                    {
                        return m_object;
                    }

9063
                    JSON_THROW(std::out_of_range("cannot get value"));
T
Théo DELRIEU 已提交
9064
                }
N
Niels 已提交
9065 9066 9067
            }
        }

T
Théo DELRIEU 已提交
9068 9069 9070 9071 9072 9073 9074 9075 9076 9077
        /*!
        @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 已提交
9078

T
Théo DELRIEU 已提交
9079 9080 9081 9082 9083
        /*!
        @brief pre-increment (++it)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator++()
9084
        {
T
Théo DELRIEU 已提交
9085
            assert(m_object != nullptr);
N
Niels 已提交
9086

T
Théo DELRIEU 已提交
9087
            switch (m_object->m_type)
9088
            {
T
Théo DELRIEU 已提交
9089 9090 9091 9092 9093
                case basic_json::value_t::object:
                {
                    std::advance(m_it.object_iterator, 1);
                    break;
                }
N
Niels 已提交
9094

T
Théo DELRIEU 已提交
9095 9096 9097 9098 9099
                case basic_json::value_t::array:
                {
                    std::advance(m_it.array_iterator, 1);
                    break;
                }
N
Niels 已提交
9100

T
Théo DELRIEU 已提交
9101 9102 9103 9104 9105 9106
                default:
                {
                    ++m_it.primitive_iterator;
                    break;
                }
            }
9107

T
Théo DELRIEU 已提交
9108 9109
            return *this;
        }
9110

T
Théo DELRIEU 已提交
9111 9112 9113 9114 9115 9116 9117 9118 9119 9120
        /*!
        @brief post-decrement (it--)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl operator--(int)
        {
            auto result = *this;
            --(*this);
            return result;
        }
9121

T
Théo DELRIEU 已提交
9122 9123 9124 9125 9126
        /*!
        @brief pre-decrement (--it)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator--()
N
Niels 已提交
9127
        {
T
Théo DELRIEU 已提交
9128 9129 9130
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
9131
            {
T
Théo DELRIEU 已提交
9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148
                case basic_json::value_t::object:
                {
                    std::advance(m_it.object_iterator, -1);
                    break;
                }

                case basic_json::value_t::array:
                {
                    std::advance(m_it.array_iterator, -1);
                    break;
                }

                default:
                {
                    --m_it.primitive_iterator;
                    break;
                }
N
Niels 已提交
9149 9150
            }

T
Théo DELRIEU 已提交
9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161
            return *this;
        }

        /*!
        @brief  comparison: equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator==(const iter_impl& other) const
        {
            // if objects are not the same, the comparison is undefined
            if (m_object != other.m_object)
N
Niels 已提交
9162
            {
T
Théo DELRIEU 已提交
9163
                JSON_THROW(std::domain_error("cannot compare iterators of different containers"));
9164
            }
N
Niels 已提交
9165

T
Théo DELRIEU 已提交
9166 9167 9168
            assert(m_object != nullptr);

            switch (m_object->m_type)
9169
            {
T
Théo DELRIEU 已提交
9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183
                case basic_json::value_t::object:
                {
                    return (m_it.object_iterator == other.m_it.object_iterator);
                }

                case basic_json::value_t::array:
                {
                    return (m_it.array_iterator == other.m_it.array_iterator);
                }

                default:
                {
                    return (m_it.primitive_iterator == other.m_it.primitive_iterator);
                }
N
Niels 已提交
9184 9185 9186
            }
        }

T
Théo DELRIEU 已提交
9187 9188 9189 9190 9191
        /*!
        @brief  comparison: not equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator!=(const iter_impl& other) const
N
Niels 已提交
9192
        {
T
Théo DELRIEU 已提交
9193
            return not operator==(other);
N
Niels 已提交
9194 9195
        }

T
Théo DELRIEU 已提交
9196 9197 9198 9199 9200
        /*!
        @brief  comparison: smaller
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator<(const iter_impl& other) const
N
Niels 已提交
9201
        {
T
Théo DELRIEU 已提交
9202 9203
            // if objects are not the same, the comparison is undefined
            if (m_object != other.m_object)
N
Niels 已提交
9204
            {
T
Théo DELRIEU 已提交
9205
                JSON_THROW(std::domain_error("cannot compare iterators of different containers"));
N
Niels 已提交
9206 9207
            }

T
Théo DELRIEU 已提交
9208
            assert(m_object != nullptr);
N
Niels 已提交
9209

T
Théo DELRIEU 已提交
9210
            switch (m_object->m_type)
9211
            {
T
Théo DELRIEU 已提交
9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225
                case basic_json::value_t::object:
                {
                    JSON_THROW(std::domain_error("cannot compare order of object iterators"));
                }

                case basic_json::value_t::array:
                {
                    return (m_it.array_iterator < other.m_it.array_iterator);
                }

                default:
                {
                    return (m_it.primitive_iterator < other.m_it.primitive_iterator);
                }
N
Niels 已提交
9226 9227 9228
            }
        }

T
Théo DELRIEU 已提交
9229 9230 9231 9232 9233
        /*!
        @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 已提交
9234
        {
T
Théo DELRIEU 已提交
9235
            return not other.operator < (*this);
N
Niels 已提交
9236 9237
        }

T
Théo DELRIEU 已提交
9238 9239 9240 9241 9242
        /*!
        @brief  comparison: greater than
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator>(const iter_impl& other) const
N
Niels 已提交
9243
        {
T
Théo DELRIEU 已提交
9244
            return not operator<=(other);
N
Niels 已提交
9245
        }
9246

T
Théo DELRIEU 已提交
9247 9248 9249 9250 9251 9252 9253 9254
        /*!
        @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);
        }
9255

T
Théo DELRIEU 已提交
9256 9257 9258 9259 9260
        /*!
        @brief  add to iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator+=(difference_type i)
N
Niels 已提交
9261
        {
T
Théo DELRIEU 已提交
9262 9263 9264
            assert(m_object != nullptr);

            switch (m_object->m_type)
9265
            {
T
Théo DELRIEU 已提交
9266 9267
                case basic_json::value_t::object:
                {
9268
                    JSON_THROW(std::domain_error("cannot use offsets with object iterators"));
T
Théo DELRIEU 已提交
9269
                }
9270

T
Théo DELRIEU 已提交
9271 9272 9273 9274 9275
                case basic_json::value_t::array:
                {
                    std::advance(m_it.array_iterator, i);
                    break;
                }
9276

T
Théo DELRIEU 已提交
9277 9278 9279 9280 9281
                default:
                {
                    m_it.primitive_iterator += i;
                    break;
                }
9282 9283
            }

T
Théo DELRIEU 已提交
9284 9285
            return *this;
        }
9286

T
Théo DELRIEU 已提交
9287 9288 9289 9290 9291 9292 9293 9294
        /*!
        @brief  subtract from iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator-=(difference_type i)
        {
            return operator+=(-i);
        }
9295

T
Théo DELRIEU 已提交
9296 9297 9298 9299 9300 9301 9302 9303 9304 9305
        /*!
        @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;
        }
9306

T
Théo DELRIEU 已提交
9307 9308 9309 9310 9311 9312 9313 9314 9315 9316
        /*!
        @brief  subtract from iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl operator-(difference_type i)
        {
            auto result = *this;
            result -= i;
            return result;
        }
N
Niels 已提交
9317

T
Théo DELRIEU 已提交
9318 9319 9320 9321 9322
        /*!
        @brief  return difference
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        difference_type operator-(const iter_impl& other) const
9323
        {
T
Théo DELRIEU 已提交
9324 9325 9326
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
9327
            {
T
Théo DELRIEU 已提交
9328 9329
                case basic_json::value_t::object:
                {
9330
                    JSON_THROW(std::domain_error("cannot use offsets with object iterators"));
T
Théo DELRIEU 已提交
9331
                }
N
Niels 已提交
9332

T
Théo DELRIEU 已提交
9333 9334 9335 9336
                case basic_json::value_t::array:
                {
                    return m_it.array_iterator - other.m_it.array_iterator;
                }
N
Niels 已提交
9337

T
Théo DELRIEU 已提交
9338 9339 9340 9341
                default:
                {
                    return m_it.primitive_iterator - other.m_it.primitive_iterator;
                }
N
Niels 已提交
9342 9343
            }
        }
N
Niels 已提交
9344

T
Théo DELRIEU 已提交
9345 9346 9347 9348 9349
        /*!
        @brief  access to successor
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        reference operator[](difference_type n) const
9350
        {
T
Théo DELRIEU 已提交
9351 9352 9353
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
9354
            {
T
Théo DELRIEU 已提交
9355 9356
                case basic_json::value_t::object:
                {
9357
                    JSON_THROW(std::domain_error("cannot use operator[] for object iterators"));
T
Théo DELRIEU 已提交
9358
                }
N
Niels 已提交
9359

T
Théo DELRIEU 已提交
9360 9361 9362 9363
                case basic_json::value_t::array:
                {
                    return *std::next(m_it.array_iterator, n);
                }
N
Niels 已提交
9364

T
Théo DELRIEU 已提交
9365 9366
                case basic_json::value_t::null:
                {
9367
                    JSON_THROW(std::out_of_range("cannot get value"));
T
Théo DELRIEU 已提交
9368
                }
N
Niels 已提交
9369

T
Théo DELRIEU 已提交
9370
                default:
N
Niels 已提交
9371
                {
T
Théo DELRIEU 已提交
9372 9373 9374 9375
                    if (m_it.primitive_iterator.get_value() == -n)
                    {
                        return *m_object;
                    }
N
Niels Lohmann 已提交
9376

9377
                    JSON_THROW(std::out_of_range("cannot get value"));
T
Théo DELRIEU 已提交
9378
                }
N
Niels 已提交
9379 9380
            }
        }
N
Niels 已提交
9381

T
Théo DELRIEU 已提交
9382 9383 9384 9385 9386
        /*!
        @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
9387
        {
T
Théo DELRIEU 已提交
9388 9389 9390 9391 9392 9393
            assert(m_object != nullptr);

            if (m_object->is_object())
            {
                return m_it.object_iterator->first;
            }
N
Niels Lohmann 已提交
9394

9395
            JSON_THROW(std::domain_error("cannot use key() for non-object iterators"));
T
Théo DELRIEU 已提交
9396
        }
N
Niels 已提交
9397

T
Théo DELRIEU 已提交
9398 9399 9400 9401 9402 9403 9404 9405
        /*!
        @brief  return the value of an iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        reference value() const
        {
            return operator*();
        }
N
Niels 已提交
9406

T
Théo DELRIEU 已提交
9407 9408 9409 9410 9411 9412
      private:
        /// associated JSON instance
        pointer m_object = nullptr;
        /// the actual iterator of the associated instance
        internal_iterator m_it = internal_iterator();
    };
N
Niels 已提交
9413

N
Niels 已提交
9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427
    /*!
    @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 已提交
9428

N
Niels 已提交
9429
    @since version 1.0.0
N
Niels 已提交
9430
    */
N
Niels 已提交
9431
    template<typename Base>
T
Théo DELRIEU 已提交
9432
    class json_reverse_iterator : public std::reverse_iterator<Base>
9433
    {
T
Théo DELRIEU 已提交
9434
      public:
9435
        /// shortcut to the reverse iterator adaptor
N
Niels 已提交
9436
        using base_iterator = std::reverse_iterator<Base>;
N
Niels 已提交
9437
        /// the reference type for the pointed-to element
N
Niels 已提交
9438
        using reference = typename Base::reference;
9439

9440
        /// create reverse iterator from iterator
N
Niels 已提交
9441
        json_reverse_iterator(const typename base_iterator::iterator_type& it) noexcept
T
Théo DELRIEU 已提交
9442 9443
            : base_iterator(it)
        {}
9444

T
Théo DELRIEU 已提交
9445 9446 9447 9448
        /// create reverse iterator from base class
        json_reverse_iterator(const base_iterator& it) noexcept
            : base_iterator(it)
        {}
9449

T
Théo DELRIEU 已提交
9450 9451 9452 9453 9454
        /// post-increment (it++)
        json_reverse_iterator operator++(int)
        {
            return base_iterator::operator++(1);
        }
9455

T
Théo DELRIEU 已提交
9456 9457 9458 9459 9460 9461
        /// pre-increment (++it)
        json_reverse_iterator& operator++()
        {
            base_iterator::operator++();
            return *this;
        }
9462

T
Théo DELRIEU 已提交
9463 9464 9465 9466 9467
        /// post-decrement (it--)
        json_reverse_iterator operator--(int)
        {
            return base_iterator::operator--(1);
        }
9468

T
Théo DELRIEU 已提交
9469 9470 9471 9472 9473 9474
        /// pre-decrement (--it)
        json_reverse_iterator& operator--()
        {
            base_iterator::operator--();
            return *this;
        }
9475

T
Théo DELRIEU 已提交
9476 9477 9478 9479 9480 9481
        /// add to iterator
        json_reverse_iterator& operator+=(difference_type i)
        {
            base_iterator::operator+=(i);
            return *this;
        }
9482

T
Théo DELRIEU 已提交
9483 9484 9485 9486 9487 9488 9489
        /// add to iterator
        json_reverse_iterator operator+(difference_type i) const
        {
            auto result = *this;
            result += i;
            return result;
        }
9490

T
Théo DELRIEU 已提交
9491 9492 9493 9494 9495 9496 9497
        /// subtract from iterator
        json_reverse_iterator operator-(difference_type i) const
        {
            auto result = *this;
            result -= i;
            return result;
        }
9498

T
Théo DELRIEU 已提交
9499 9500 9501 9502 9503
        /// return difference
        difference_type operator-(const json_reverse_iterator& other) const
        {
            return this->base() - other.base();
        }
9504

T
Théo DELRIEU 已提交
9505 9506 9507 9508 9509
        /// access to successor
        reference operator[](difference_type n) const
        {
            return *(this->operator+(n));
        }
N
Niels 已提交
9510

T
Théo DELRIEU 已提交
9511 9512 9513 9514 9515 9516
        /// return the key of an object iterator
        typename object_t::key_type key() const
        {
            auto it = --this->base();
            return it.key();
        }
9517

T
Théo DELRIEU 已提交
9518 9519 9520 9521 9522 9523 9524
        /// return the value of an iterator
        reference value() const
        {
            auto it = --this->base();
            return it.operator * ();
        }
    };
9525

N
Niels 已提交
9526

N
Niels 已提交
9527
  private:
N
Niels 已提交
9528 9529 9530
    //////////////////////
    // lexer and parser //
    //////////////////////
N
Niels 已提交
9531

N
Niels 已提交
9532 9533 9534 9535
    /*!
    @brief lexical analysis

    This class organizes the lexical analysis during JSON deserialization. The
N
Niels 已提交
9536 9537
    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 已提交
9538
    */
N
Niels 已提交
9539
    class lexer
N
Niels 已提交
9540
    {
T
Théo DELRIEU 已提交
9541
      public:
N
Niels 已提交
9542 9543
        /// token types for the parser
        enum class token_type
T
Théo DELRIEU 已提交
9544 9545 9546 9547 9548 9549
        {
            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 已提交
9550 9551
            value_unsigned,  ///< an unsigned integer -- use get_number() for actual value
            value_integer,   ///< a signed integer -- use get_number() for actual value
9552
            value_float,     ///< an floating point number -- use get_number() for actual value
T
Théo DELRIEU 已提交
9553 9554 9555 9556 9557 9558 9559 9560 9561
            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 已提交
9562

T
Théo DELRIEU 已提交
9563 9564
        /// the char type to use in the lexer
        using lexer_char_t = unsigned char;
N
Niels 已提交
9565

T
Théo DELRIEU 已提交
9566 9567 9568 9569 9570 9571 9572 9573
        /// 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 已提交
9574

T
Théo DELRIEU 已提交
9575 9576 9577
        /// a lexer from an input stream
        explicit lexer(std::istream& s)
            : m_stream(&s), m_line_buffer()
N
Niels 已提交
9578
        {
T
Théo DELRIEU 已提交
9579 9580 9581
            // immediately abort if stream is erroneous
            if (s.fail())
            {
9582
                JSON_THROW(std::invalid_argument("stream error"));
T
Théo DELRIEU 已提交
9583
            }
N
Niels 已提交
9584

T
Théo DELRIEU 已提交
9585 9586
            // fill buffer
            fill_line_buffer();
N
Niels 已提交
9587

T
Théo DELRIEU 已提交
9588 9589 9590 9591 9592 9593 9594
            // 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] = ' ';
            }
9595
        }
N
Niels 已提交
9596

T
Théo DELRIEU 已提交
9597 9598 9599 9600
        // switch off unwanted functions (due to pointer members)
        lexer() = delete;
        lexer(const lexer&) = delete;
        lexer operator=(const lexer&) = delete;
N
Niels 已提交
9601

T
Théo DELRIEU 已提交
9602 9603
        /*!
        @brief create a string from one or two Unicode code points
N
Niels 已提交
9604

T
Théo DELRIEU 已提交
9605 9606 9607 9608
        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 已提交
9609

T
Théo DELRIEU 已提交
9610 9611
        @param[in] codepoint1  the code point (can be high surrogate)
        @param[in] codepoint2  the code point (can be low surrogate or 0)
N
Niels 已提交
9612

T
Théo DELRIEU 已提交
9613 9614
        @return string representation of the code point; the length of the
        result string is between 1 and 4 characters.
N
Niels 已提交
9615

T
Théo DELRIEU 已提交
9616 9617 9618 9619
        @throw std::out_of_range if code point is > 0x10ffff; example: `"code
        points above 0x10FFFF are invalid"`
        @throw std::invalid_argument if the low surrogate is invalid; example:
        `""missing or wrong low surrogate""`
N
Niels 已提交
9620

T
Théo DELRIEU 已提交
9621
        @complexity Constant.
N
Niels 已提交
9622

T
Théo DELRIEU 已提交
9623 9624 9625 9626
        @see <http://en.wikipedia.org/wiki/UTF-8#Sample_code>
        */
        static string_t to_unicode(const std::size_t codepoint1,
                                   const std::size_t codepoint2 = 0)
9627
        {
T
Théo DELRIEU 已提交
9628 9629 9630 9631 9632
            // 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 已提交
9633
            {
T
Théo DELRIEU 已提交
9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650
                // 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
                {
                    JSON_THROW(std::invalid_argument("missing or wrong low surrogate"));
                }
N
Niels 已提交
9651 9652
            }

T
Théo DELRIEU 已提交
9653
            string_t result;
9654

T
Théo DELRIEU 已提交
9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682
            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
            {
9683
                JSON_THROW(std::out_of_range("code points above 0x10FFFF are invalid"));
T
Théo DELRIEU 已提交
9684
            }
9685

T
Théo DELRIEU 已提交
9686 9687
            return result;
        }
9688

T
Théo DELRIEU 已提交
9689 9690 9691 9692
        /// 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 已提交
9693
            {
T
Théo DELRIEU 已提交
9694 9695 9696 9697 9698 9699 9700 9701 9702 9703
                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 已提交
9704 9705
                case lexer::token_type::value_unsigned:
                case lexer::token_type::value_integer:
9706
                case lexer::token_type::value_float:
T
Théo DELRIEU 已提交
9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728
                    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 已提交
9729 9730 9731
            }
        }

T
Théo DELRIEU 已提交
9732 9733 9734 9735 9736 9737 9738
        /*!
        This function implements a scanner for JSON. It is specified using
        regular expressions that try to follow RFC 7159 as close as possible.
        These regular expressions are then translated into a minimized
        deterministic finite automaton (DFA) by the tool
        [re2c](http://re2c.org). As a result, the translated code for this
        function consists of a large block of code with `goto` jumps.
N
fixes  
Niels 已提交
9739

T
Théo DELRIEU 已提交
9740
        @return the class of the next token read from the buffer
N
Niels 已提交
9741

T
Théo DELRIEU 已提交
9742
        @complexity Linear in the length of the input.\n
N
Niels 已提交
9743

T
Théo DELRIEU 已提交
9744
        Proposition: The loop below will always terminate for finite input.\n
N
Niels 已提交
9745

T
Théo DELRIEU 已提交
9746 9747 9748 9749 9750 9751 9752 9753
        Proof (by contradiction): Assume a finite input. To loop forever, the
        loop must never hit code with a `break` statement. The only code
        snippets without a `break` statement are the continue statements for
        whitespace and byte-order-marks. To loop forever, the input must be an
        infinite sequence of whitespace or byte-order-marks. This contradicts
        the assumption of finite input, q.e.d.
        */
        token_type scan()
N
Niels 已提交
9754
        {
T
Théo DELRIEU 已提交
9755 9756 9757 9758
            while (true)
            {
                // pointer for backtracking information
                m_marker = nullptr;
N
Niels 已提交
9759

T
Théo DELRIEU 已提交
9760 9761 9762
                // remember the begin of the token
                m_start = m_cursor;
                assert(m_start != nullptr);
N
Niels 已提交
9763

9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917

                {
                    lexer_char_t yych;
                    unsigned int yyaccept = 0;
                    static const unsigned char yybm[] =
                    {
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,  32,  32,   0,   0,  32,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        160, 128,   0, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        192, 192, 192, 192, 192, 192, 192, 192,
                        192, 192, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128,   0, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        128, 128, 128, 128, 128, 128, 128, 128,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                    };
                    if ((m_limit - m_cursor) < 5)
                    {
                        fill_line_buffer(5);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yybm[0 + yych] & 32)
                    {
                        goto basic_json_parser_6;
                    }
                    if (yych <= '[')
                    {
                        if (yych <= '-')
                        {
                            if (yych <= '"')
                            {
                                if (yych <= 0x00)
                                {
                                    goto basic_json_parser_2;
                                }
                                if (yych <= '!')
                                {
                                    goto basic_json_parser_4;
                                }
                                goto basic_json_parser_9;
                            }
                            else
                            {
                                if (yych <= '+')
                                {
                                    goto basic_json_parser_4;
                                }
                                if (yych <= ',')
                                {
                                    goto basic_json_parser_10;
                                }
                                goto basic_json_parser_12;
                            }
                        }
                        else
                        {
                            if (yych <= '9')
                            {
                                if (yych <= '/')
                                {
                                    goto basic_json_parser_4;
                                }
                                if (yych <= '0')
                                {
                                    goto basic_json_parser_13;
                                }
                                goto basic_json_parser_15;
                            }
                            else
                            {
                                if (yych <= ':')
                                {
                                    goto basic_json_parser_17;
                                }
                                if (yych <= 'Z')
                                {
                                    goto basic_json_parser_4;
                                }
                                goto basic_json_parser_19;
                            }
                        }
                    }
                    else
                    {
                        if (yych <= 'n')
                        {
                            if (yych <= 'e')
                            {
                                if (yych == ']')
                                {
                                    goto basic_json_parser_21;
                                }
                                goto basic_json_parser_4;
                            }
                            else
                            {
                                if (yych <= 'f')
                                {
                                    goto basic_json_parser_23;
                                }
                                if (yych <= 'm')
                                {
                                    goto basic_json_parser_4;
                                }
                                goto basic_json_parser_24;
                            }
                        }
                        else
                        {
                            if (yych <= 'z')
                            {
                                if (yych == 't')
                                {
                                    goto basic_json_parser_25;
                                }
                                goto basic_json_parser_4;
                            }
                            else
                            {
                                if (yych <= '{')
                                {
                                    goto basic_json_parser_26;
                                }
                                if (yych == '}')
                                {
                                    goto basic_json_parser_28;
                                }
                                goto basic_json_parser_4;
                            }
                        }
                    }
9918
basic_json_parser_2:
9919 9920 9921 9922 9923
                    ++m_cursor;
                    {
                        last_token_type = token_type::end_of_input;
                        break;
                    }
N
Niels 已提交
9924
basic_json_parser_4:
9925
                    ++m_cursor;
N
Niels 已提交
9926
basic_json_parser_5:
9927 9928 9929 9930
                    {
                        last_token_type = token_type::parse_error;
                        break;
                    }
N
Niels 已提交
9931
basic_json_parser_6:
9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yybm[0 + yych] & 32)
                    {
                        goto basic_json_parser_6;
                    }
                    {
                        continue;
                    }
N
Niels 已提交
9945
basic_json_parser_9:
9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964
                    yyaccept = 0;
                    yych = *(m_marker = ++m_cursor);
                    if (yych <= 0x1F)
                    {
                        goto basic_json_parser_5;
                    }
                    if (yych <= 0x7F)
                    {
                        goto basic_json_parser_31;
                    }
                    if (yych <= 0xC1)
                    {
                        goto basic_json_parser_5;
                    }
                    if (yych <= 0xF4)
                    {
                        goto basic_json_parser_31;
                    }
                    goto basic_json_parser_5;
9965
basic_json_parser_10:
9966 9967 9968 9969 9970
                    ++m_cursor;
                    {
                        last_token_type = token_type::value_separator;
                        break;
                    }
9971
basic_json_parser_12:
9972 9973 9974 9975 9976 9977 9978
                    yych = *++m_cursor;
                    if (yych <= '/')
                    {
                        goto basic_json_parser_5;
                    }
                    if (yych <= '0')
                    {
9979
                        goto basic_json_parser_43;
9980 9981 9982
                    }
                    if (yych <= '9')
                    {
9983
                        goto basic_json_parser_45;
9984 9985
                    }
                    goto basic_json_parser_5;
9986
basic_json_parser_13:
9987 9988
                    yyaccept = 1;
                    yych = *(m_marker = ++m_cursor);
N
Niels Lohmann 已提交
9989
                    if (yych <= '9')
9990 9991 9992
                    {
                        if (yych == '.')
                        {
9993
                            goto basic_json_parser_47;
9994
                        }
N
Niels Lohmann 已提交
9995 9996 9997 9998
                        if (yych >= '0')
                        {
                            goto basic_json_parser_48;
                        }
9999 10000 10001 10002 10003
                    }
                    else
                    {
                        if (yych <= 'E')
                        {
N
Niels Lohmann 已提交
10004 10005 10006 10007
                            if (yych >= 'E')
                            {
                                goto basic_json_parser_51;
                            }
10008
                        }
N
Niels Lohmann 已提交
10009
                        else
10010
                        {
N
Niels Lohmann 已提交
10011 10012 10013 10014
                            if (yych == 'e')
                            {
                                goto basic_json_parser_51;
                            }
10015 10016
                        }
                    }
10017
basic_json_parser_14:
10018
                    {
N
Niels Lohmann 已提交
10019
                        last_token_type = token_type::value_unsigned;
10020 10021
                        break;
                    }
10022
basic_json_parser_15:
10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037
                    yyaccept = 1;
                    m_marker = ++m_cursor;
                    if ((m_limit - m_cursor) < 3)
                    {
                        fill_line_buffer(3);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yybm[0 + yych] & 64)
                    {
                        goto basic_json_parser_15;
                    }
                    if (yych <= 'D')
                    {
                        if (yych == '.')
                        {
10038
                            goto basic_json_parser_47;
10039 10040 10041 10042 10043 10044 10045
                        }
                        goto basic_json_parser_14;
                    }
                    else
                    {
                        if (yych <= 'E')
                        {
N
Niels Lohmann 已提交
10046
                            goto basic_json_parser_51;
10047 10048 10049
                        }
                        if (yych == 'e')
                        {
N
Niels Lohmann 已提交
10050
                            goto basic_json_parser_51;
10051 10052 10053
                        }
                        goto basic_json_parser_14;
                    }
10054
basic_json_parser_17:
10055 10056 10057 10058 10059
                    ++m_cursor;
                    {
                        last_token_type = token_type::name_separator;
                        break;
                    }
10060
basic_json_parser_19:
10061 10062 10063 10064 10065
                    ++m_cursor;
                    {
                        last_token_type = token_type::begin_array;
                        break;
                    }
10066
basic_json_parser_21:
10067 10068 10069 10070 10071
                    ++m_cursor;
                    {
                        last_token_type = token_type::end_array;
                        break;
                    }
10072
basic_json_parser_23:
10073 10074 10075 10076
                    yyaccept = 0;
                    yych = *(m_marker = ++m_cursor);
                    if (yych == 'a')
                    {
N
Niels Lohmann 已提交
10077
                        goto basic_json_parser_52;
10078 10079
                    }
                    goto basic_json_parser_5;
10080
basic_json_parser_24:
10081 10082 10083 10084
                    yyaccept = 0;
                    yych = *(m_marker = ++m_cursor);
                    if (yych == 'u')
                    {
N
Niels Lohmann 已提交
10085
                        goto basic_json_parser_53;
10086 10087
                    }
                    goto basic_json_parser_5;
10088
basic_json_parser_25:
10089 10090 10091 10092
                    yyaccept = 0;
                    yych = *(m_marker = ++m_cursor);
                    if (yych == 'r')
                    {
N
Niels Lohmann 已提交
10093
                        goto basic_json_parser_54;
10094 10095
                    }
                    goto basic_json_parser_5;
10096
basic_json_parser_26:
10097 10098 10099 10100 10101
                    ++m_cursor;
                    {
                        last_token_type = token_type::begin_object;
                        break;
                    }
10102
basic_json_parser_28:
10103 10104 10105 10106 10107
                    ++m_cursor;
                    {
                        last_token_type = token_type::end_object;
                        break;
                    }
10108
basic_json_parser_30:
10109 10110 10111 10112 10113 10114
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
10115
basic_json_parser_31:
10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172
                    if (yybm[0 + yych] & 128)
                    {
                        goto basic_json_parser_30;
                    }
                    if (yych <= 0xE0)
                    {
                        if (yych <= '\\')
                        {
                            if (yych <= 0x1F)
                            {
                                goto basic_json_parser_32;
                            }
                            if (yych <= '"')
                            {
                                goto basic_json_parser_33;
                            }
                            goto basic_json_parser_35;
                        }
                        else
                        {
                            if (yych <= 0xC1)
                            {
                                goto basic_json_parser_32;
                            }
                            if (yych <= 0xDF)
                            {
                                goto basic_json_parser_36;
                            }
                            goto basic_json_parser_37;
                        }
                    }
                    else
                    {
                        if (yych <= 0xEF)
                        {
                            if (yych == 0xED)
                            {
                                goto basic_json_parser_39;
                            }
                            goto basic_json_parser_38;
                        }
                        else
                        {
                            if (yych <= 0xF0)
                            {
                                goto basic_json_parser_40;
                            }
                            if (yych <= 0xF3)
                            {
                                goto basic_json_parser_41;
                            }
                            if (yych <= 0xF4)
                            {
                                goto basic_json_parser_42;
                            }
                        }
                    }
10173
basic_json_parser_32:
10174
                    m_cursor = m_marker;
10175
                    if (yyaccept <= 1)
10176
                    {
10177 10178 10179 10180 10181 10182 10183 10184
                        if (yyaccept == 0)
                        {
                            goto basic_json_parser_5;
                        }
                        else
                        {
                            goto basic_json_parser_14;
                        }
10185 10186 10187
                    }
                    else
                    {
10188 10189 10190 10191 10192 10193
                        if (yyaccept == 2)
                        {
                            goto basic_json_parser_44;
                        }
                        else
                        {
N
Niels Lohmann 已提交
10194
                            goto basic_json_parser_58;
10195
                        }
10196
                    }
10197
basic_json_parser_33:
10198 10199 10200 10201 10202
                    ++m_cursor;
                    {
                        last_token_type = token_type::value_string;
                        break;
                    }
10203
basic_json_parser_35:
10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= 'e')
                    {
                        if (yych <= '/')
                        {
                            if (yych == '"')
                            {
                                goto basic_json_parser_30;
                            }
                            if (yych <= '.')
                            {
                                goto basic_json_parser_32;
                            }
                            goto basic_json_parser_30;
                        }
                        else
                        {
                            if (yych <= '\\')
                            {
                                if (yych <= '[')
                                {
                                    goto basic_json_parser_32;
                                }
                                goto basic_json_parser_30;
                            }
                            else
                            {
                                if (yych == 'b')
                                {
                                    goto basic_json_parser_30;
                                }
                                goto basic_json_parser_32;
                            }
                        }
                    }
                    else
                    {
                        if (yych <= 'q')
                        {
                            if (yych <= 'f')
                            {
                                goto basic_json_parser_30;
                            }
                            if (yych == 'n')
                            {
                                goto basic_json_parser_30;
                            }
                            goto basic_json_parser_32;
                        }
                        else
                        {
                            if (yych <= 's')
                            {
                                if (yych <= 'r')
                                {
                                    goto basic_json_parser_30;
                                }
                                goto basic_json_parser_32;
                            }
                            else
                            {
                                if (yych <= 't')
                                {
                                    goto basic_json_parser_30;
                                }
                                if (yych <= 'u')
                                {
N
Niels Lohmann 已提交
10276
                                    goto basic_json_parser_55;
10277 10278 10279 10280 10281
                                }
                                goto basic_json_parser_32;
                            }
                        }
                    }
10282
basic_json_parser_36:
10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= 0x7F)
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= 0xBF)
                    {
                        goto basic_json_parser_30;
                    }
                    goto basic_json_parser_32;
10298
basic_json_parser_37:
10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= 0x9F)
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= 0xBF)
                    {
                        goto basic_json_parser_36;
                    }
                    goto basic_json_parser_32;
10314
basic_json_parser_38:
10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= 0x7F)
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= 0xBF)
                    {
                        goto basic_json_parser_36;
                    }
                    goto basic_json_parser_32;
N
Niels 已提交
10330
basic_json_parser_39:
10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= 0x7F)
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= 0x9F)
                    {
                        goto basic_json_parser_36;
                    }
                    goto basic_json_parser_32;
N
Niels 已提交
10346
basic_json_parser_40:
10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= 0x8F)
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= 0xBF)
                    {
                        goto basic_json_parser_38;
                    }
                    goto basic_json_parser_32;
N
Niels 已提交
10362
basic_json_parser_41:
10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= 0x7F)
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= 0xBF)
                    {
                        goto basic_json_parser_38;
                    }
                    goto basic_json_parser_32;
N
Niels 已提交
10378
basic_json_parser_42:
10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= 0x7F)
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= 0x8F)
                    {
                        goto basic_json_parser_38;
                    }
                    goto basic_json_parser_32;
N
Niels 已提交
10394
basic_json_parser_43:
10395 10396
                    yyaccept = 2;
                    yych = *(m_marker = ++m_cursor);
N
Niels Lohmann 已提交
10397
                    if (yych <= '9')
10398 10399 10400 10401 10402
                    {
                        if (yych == '.')
                        {
                            goto basic_json_parser_47;
                        }
N
Niels Lohmann 已提交
10403 10404 10405 10406
                        if (yych >= '0')
                        {
                            goto basic_json_parser_48;
                        }
10407 10408 10409 10410 10411
                    }
                    else
                    {
                        if (yych <= 'E')
                        {
N
Niels Lohmann 已提交
10412 10413 10414 10415
                            if (yych >= 'E')
                            {
                                goto basic_json_parser_51;
                            }
10416
                        }
N
Niels Lohmann 已提交
10417
                        else
10418
                        {
N
Niels Lohmann 已提交
10419 10420 10421 10422
                            if (yych == 'e')
                            {
                                goto basic_json_parser_51;
                            }
10423 10424 10425 10426
                        }
                    }
basic_json_parser_44:
                    {
N
Niels Lohmann 已提交
10427
                        last_token_type = token_type::value_integer;
10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457
                        break;
                    }
basic_json_parser_45:
                    yyaccept = 2;
                    m_marker = ++m_cursor;
                    if ((m_limit - m_cursor) < 3)
                    {
                        fill_line_buffer(3);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= '9')
                    {
                        if (yych == '.')
                        {
                            goto basic_json_parser_47;
                        }
                        if (yych <= '/')
                        {
                            goto basic_json_parser_44;
                        }
                        goto basic_json_parser_45;
                    }
                    else
                    {
                        if (yych <= 'E')
                        {
                            if (yych <= 'D')
                            {
                                goto basic_json_parser_44;
                            }
N
Niels Lohmann 已提交
10458
                            goto basic_json_parser_51;
10459 10460 10461 10462 10463
                        }
                        else
                        {
                            if (yych == 'e')
                            {
N
Niels Lohmann 已提交
10464
                                goto basic_json_parser_51;
10465 10466 10467 10468 10469
                            }
                            goto basic_json_parser_44;
                        }
                    }
basic_json_parser_47:
10470 10471 10472 10473 10474 10475 10476
                    yych = *++m_cursor;
                    if (yych <= '/')
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= '9')
                    {
N
Niels Lohmann 已提交
10477
                        goto basic_json_parser_56;
10478 10479
                    }
                    goto basic_json_parser_32;
10480
basic_json_parser_48:
N
Niels Lohmann 已提交
10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= '/')
                    {
                        goto basic_json_parser_50;
                    }
                    if (yych <= '9')
                    {
                        goto basic_json_parser_48;
                    }
basic_json_parser_50:
                    {
                        last_token_type = token_type::parse_error;
                        break;
                    }
basic_json_parser_51:
10501 10502 10503 10504 10505
                    yych = *++m_cursor;
                    if (yych <= ',')
                    {
                        if (yych == '+')
                        {
N
Niels Lohmann 已提交
10506
                            goto basic_json_parser_59;
10507 10508 10509 10510 10511 10512 10513
                        }
                        goto basic_json_parser_32;
                    }
                    else
                    {
                        if (yych <= '-')
                        {
N
Niels Lohmann 已提交
10514
                            goto basic_json_parser_59;
10515 10516 10517 10518 10519 10520 10521
                        }
                        if (yych <= '/')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= '9')
                        {
N
Niels Lohmann 已提交
10522
                            goto basic_json_parser_60;
10523 10524 10525
                        }
                        goto basic_json_parser_32;
                    }
N
Niels Lohmann 已提交
10526
basic_json_parser_52:
10527 10528 10529
                    yych = *++m_cursor;
                    if (yych == 'l')
                    {
N
Niels Lohmann 已提交
10530
                        goto basic_json_parser_62;
10531 10532
                    }
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10533
basic_json_parser_53:
10534 10535 10536
                    yych = *++m_cursor;
                    if (yych == 'l')
                    {
N
Niels Lohmann 已提交
10537
                        goto basic_json_parser_63;
10538 10539
                    }
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10540
basic_json_parser_54:
10541 10542 10543
                    yych = *++m_cursor;
                    if (yych == 'u')
                    {
N
Niels Lohmann 已提交
10544
                        goto basic_json_parser_64;
10545 10546
                    }
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10547
basic_json_parser_55:
10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= '@')
                    {
                        if (yych <= '/')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= '9')
                        {
N
Niels Lohmann 已提交
10562
                            goto basic_json_parser_65;
10563 10564 10565 10566 10567 10568 10569
                        }
                        goto basic_json_parser_32;
                    }
                    else
                    {
                        if (yych <= 'F')
                        {
N
Niels Lohmann 已提交
10570
                            goto basic_json_parser_65;
10571 10572 10573 10574 10575 10576 10577
                        }
                        if (yych <= '`')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= 'f')
                        {
N
Niels Lohmann 已提交
10578
                            goto basic_json_parser_65;
10579 10580 10581
                        }
                        goto basic_json_parser_32;
                    }
N
Niels Lohmann 已提交
10582
basic_json_parser_56:
10583
                    yyaccept = 3;
10584 10585 10586 10587 10588 10589 10590 10591 10592 10593
                    m_marker = ++m_cursor;
                    if ((m_limit - m_cursor) < 3)
                    {
                        fill_line_buffer(3);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= 'D')
                    {
                        if (yych <= '/')
                        {
N
Niels Lohmann 已提交
10594
                            goto basic_json_parser_58;
10595 10596 10597
                        }
                        if (yych <= '9')
                        {
N
Niels Lohmann 已提交
10598
                            goto basic_json_parser_56;
10599 10600 10601 10602 10603 10604
                        }
                    }
                    else
                    {
                        if (yych <= 'E')
                        {
N
Niels Lohmann 已提交
10605
                            goto basic_json_parser_51;
10606 10607 10608
                        }
                        if (yych == 'e')
                        {
N
Niels Lohmann 已提交
10609
                            goto basic_json_parser_51;
10610 10611
                        }
                    }
N
Niels Lohmann 已提交
10612
basic_json_parser_58:
10613 10614 10615 10616
                    {
                        last_token_type = token_type::value_float;
                        break;
                    }
N
Niels Lohmann 已提交
10617
basic_json_parser_59:
10618 10619 10620 10621 10622 10623 10624 10625 10626
                    yych = *++m_cursor;
                    if (yych <= '/')
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych >= ':')
                    {
                        goto basic_json_parser_32;
                    }
N
Niels Lohmann 已提交
10627
basic_json_parser_60:
10628 10629 10630 10631 10632 10633 10634 10635
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= '/')
                    {
N
Niels Lohmann 已提交
10636
                        goto basic_json_parser_58;
10637 10638 10639
                    }
                    if (yych <= '9')
                    {
N
Niels Lohmann 已提交
10640
                        goto basic_json_parser_60;
10641
                    }
N
Niels Lohmann 已提交
10642 10643
                    goto basic_json_parser_58;
basic_json_parser_62:
10644 10645 10646
                    yych = *++m_cursor;
                    if (yych == 's')
                    {
N
Niels Lohmann 已提交
10647
                        goto basic_json_parser_66;
10648 10649
                    }
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10650
basic_json_parser_63:
10651 10652 10653
                    yych = *++m_cursor;
                    if (yych == 'l')
                    {
N
Niels Lohmann 已提交
10654
                        goto basic_json_parser_67;
10655 10656
                    }
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10657
basic_json_parser_64:
10658 10659 10660
                    yych = *++m_cursor;
                    if (yych == 'e')
                    {
N
Niels Lohmann 已提交
10661
                        goto basic_json_parser_69;
10662 10663
                    }
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10664
basic_json_parser_65:
10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= '@')
                    {
                        if (yych <= '/')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= '9')
                        {
N
Niels Lohmann 已提交
10679
                            goto basic_json_parser_71;
10680 10681 10682 10683 10684 10685 10686
                        }
                        goto basic_json_parser_32;
                    }
                    else
                    {
                        if (yych <= 'F')
                        {
N
Niels Lohmann 已提交
10687
                            goto basic_json_parser_71;
10688 10689 10690 10691 10692 10693 10694
                        }
                        if (yych <= '`')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= 'f')
                        {
N
Niels Lohmann 已提交
10695
                            goto basic_json_parser_71;
10696 10697 10698
                        }
                        goto basic_json_parser_32;
                    }
N
Niels Lohmann 已提交
10699
basic_json_parser_66:
10700 10701 10702
                    yych = *++m_cursor;
                    if (yych == 'e')
                    {
N
Niels Lohmann 已提交
10703
                        goto basic_json_parser_72;
10704 10705
                    }
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10706
basic_json_parser_67:
10707 10708 10709 10710 10711
                    ++m_cursor;
                    {
                        last_token_type = token_type::literal_null;
                        break;
                    }
N
Niels Lohmann 已提交
10712
basic_json_parser_69:
10713 10714 10715 10716 10717
                    ++m_cursor;
                    {
                        last_token_type = token_type::literal_true;
                        break;
                    }
N
Niels Lohmann 已提交
10718
basic_json_parser_71:
10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= '@')
                    {
                        if (yych <= '/')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= '9')
                        {
N
Niels Lohmann 已提交
10733
                            goto basic_json_parser_74;
10734 10735 10736 10737 10738 10739 10740
                        }
                        goto basic_json_parser_32;
                    }
                    else
                    {
                        if (yych <= 'F')
                        {
N
Niels Lohmann 已提交
10741
                            goto basic_json_parser_74;
10742 10743 10744 10745 10746 10747 10748
                        }
                        if (yych <= '`')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= 'f')
                        {
N
Niels Lohmann 已提交
10749
                            goto basic_json_parser_74;
10750 10751 10752
                        }
                        goto basic_json_parser_32;
                    }
N
Niels Lohmann 已提交
10753
basic_json_parser_72:
10754 10755 10756 10757 10758
                    ++m_cursor;
                    {
                        last_token_type = token_type::literal_false;
                        break;
                    }
N
Niels Lohmann 已提交
10759
basic_json_parser_74:
10760 10761 10762 10763 10764 10765 10766 10767 10768 10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794
                    ++m_cursor;
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
                    yych = *m_cursor;
                    if (yych <= '@')
                    {
                        if (yych <= '/')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= '9')
                        {
                            goto basic_json_parser_30;
                        }
                        goto basic_json_parser_32;
                    }
                    else
                    {
                        if (yych <= 'F')
                        {
                            goto basic_json_parser_30;
                        }
                        if (yych <= '`')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= 'f')
                        {
                            goto basic_json_parser_30;
                        }
                        goto basic_json_parser_32;
                    }
                }
10795

T
Théo DELRIEU 已提交
10796
            }
10797

T
Théo DELRIEU 已提交
10798 10799
            return last_token_type;
        }
10800

T
Théo DELRIEU 已提交
10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833
        /*!
        @brief append data from the stream to the line buffer

        This function is called by the scan() function when the end of the
        buffer (`m_limit`) is reached and the `m_cursor` pointer cannot be
        incremented without leaving the limits of the line buffer. Note re2c
        decides when to call this function.

        If the lexer reads from contiguous storage, there is no trailing null
        byte. Therefore, this function must make sure to add these padding
        null bytes.

        If the lexer reads from an input stream, this function reads the next
        line of the input.

        @pre
            p p p p p p u u u u u x . . . . . .
            ^           ^       ^   ^
            m_content   m_start |   m_limit
                                m_cursor

        @post
            u u u u u x x x x x x x . . . . . .
            ^       ^               ^
            |       m_cursor        m_limit
            m_start
            m_content
        */
        void fill_line_buffer(size_t n = 0)
        {
            // if line buffer is used, m_content points to its data
            assert(m_line_buffer.empty()
                   or m_content == reinterpret_cast<const lexer_char_t*>(m_line_buffer.data()));
N
Niels Lohmann 已提交
10834

T
Théo DELRIEU 已提交
10835 10836 10837
            // if line buffer is used, m_limit is set past the end of its data
            assert(m_line_buffer.empty()
                   or m_limit == m_content + m_line_buffer.size());
N
Niels Lohmann 已提交
10838

T
Théo DELRIEU 已提交
10839 10840 10841 10842 10843
            // pointer relationships
            assert(m_content <= m_start);
            assert(m_start <= m_cursor);
            assert(m_cursor <= m_limit);
            assert(m_marker == nullptr or m_marker  <= m_limit);
N
Niels Lohmann 已提交
10844

T
Théo DELRIEU 已提交
10845
            // number of processed characters (p)
N
Niels Lohmann 已提交
10846
            const auto num_processed_chars = static_cast<size_t>(m_start - m_content);
T
Théo DELRIEU 已提交
10847 10848 10849 10850
            // 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 已提交
10851

T
Théo DELRIEU 已提交
10852 10853 10854 10855
            // 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 已提交
10856
                // this point. We trust the standard library to do the right
T
Théo DELRIEU 已提交
10857 10858
                // thing. See http://stackoverflow.com/q/28142011/266378
                m_line_buffer.assign(m_start, m_limit);
10859

T
Théo DELRIEU 已提交
10860 10861 10862 10863 10864 10865 10866 10867 10868
                // 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
10869
            {
T
Théo DELRIEU 已提交
10870 10871 10872 10873 10874 10875 10876 10877 10878
                // delete processed characters from line buffer
                m_line_buffer.erase(0, num_processed_chars);
                // read next line from input stream
                m_line_buffer_tmp.clear();
                std::getline(*m_stream, m_line_buffer_tmp, '\n');

                // add line with newline symbol to the line buffer
                m_line_buffer += m_line_buffer_tmp;
                m_line_buffer.push_back('\n');
10879
            }
10880

T
Théo DELRIEU 已提交
10881 10882 10883 10884 10885 10886 10887
            // set pointers
            m_content = reinterpret_cast<const lexer_char_t*>(m_line_buffer.data());
            assert(m_content != nullptr);
            m_start  = m_content;
            m_marker = m_start + offset_marker;
            m_cursor = m_start + offset_cursor;
            m_limit  = m_start + m_line_buffer.size();
N
Niels 已提交
10888 10889
        }

T
Théo DELRIEU 已提交
10890 10891 10892 10893 10894 10895 10896
        /// 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));
        }
10897

T
Théo DELRIEU 已提交
10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943
        /*!
        @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 已提交
10944
        indefinitely if i is always decreased. However, observe that the value
T
Théo DELRIEU 已提交
10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957
        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
        @throw std::out_of_range if to_unicode fails
        */
        string_t get_string() const
        {
            assert(m_cursor - m_start >= 2);
10958

T
Théo DELRIEU 已提交
10959 10960
            string_t result;
            result.reserve(static_cast<size_t>(m_cursor - m_start - 2));
10961

T
Théo DELRIEU 已提交
10962 10963
            // iterate the result between the quotes
            for (const lexer_char_t* i = m_start + 1; i < m_cursor - 1; ++i)
N
Niels 已提交
10964
            {
T
Théo DELRIEU 已提交
10965 10966 10967
                // find next escape character
                auto e = std::find(i, m_cursor - 1, '\\');
                if (e != i)
N
Niels 已提交
10968
                {
T
Théo DELRIEU 已提交
10969 10970
                    // see https://github.com/nlohmann/json/issues/365#issuecomment-262874705
                    for (auto k = i; k < e; k++)
10971
                    {
T
Théo DELRIEU 已提交
10972
                        result.push_back(static_cast<typename string_t::value_type>(*k));
10973
                    }
T
Théo DELRIEU 已提交
10974 10975 10976 10977 10978 10979 10980
                    i = e - 1; // -1 because of ++i
                }
                else
                {
                    // processing escaped character
                    // read next character
                    ++i;
N
Niels 已提交
10981

T
Théo DELRIEU 已提交
10982
                    switch (*i)
N
Niels 已提交
10983
                    {
T
Théo DELRIEU 已提交
10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004 11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024
                        // 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 已提交
11025

T
Théo DELRIEU 已提交
11026 11027
                        // unicode
                        case 'u':
N
Niels 已提交
11028
                        {
T
Théo DELRIEU 已提交
11029 11030 11031 11032 11033 11034
                            // 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 已提交
11035
                            {
T
Théo DELRIEU 已提交
11036 11037 11038
                                // make sure there is a subsequent unicode
                                if ((i + 6 >= m_limit) or * (i + 5) != '\\' or * (i + 6) != 'u')
                                {
11039
                                    JSON_THROW(std::invalid_argument("missing low surrogate"));
T
Théo DELRIEU 已提交
11040 11041 11042 11043 11044 11045 11046 11047
                                }

                                // 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 已提交
11048
                            }
T
Théo DELRIEU 已提交
11049 11050 11051
                            else if (codepoint >= 0xDC00 and codepoint <= 0xDFFF)
                            {
                                // we found a lone low surrogate
11052
                                JSON_THROW(std::invalid_argument("missing high surrogate"));
T
Théo DELRIEU 已提交
11053 11054 11055 11056 11057 11058 11059 11060 11061
                            }
                            else
                            {
                                // add unicode character(s)
                                result += to_unicode(codepoint);
                                // skip the next four characters (xxxx)
                                i += 4;
                            }
                            break;
N
Niels 已提交
11062 11063 11064 11065
                        }
                    }
                }
            }
T
Théo DELRIEU 已提交
11066 11067

            return result;
N
Niels 已提交
11068 11069
        }

11070

T
Théo DELRIEU 已提交
11071
        /*!
N
Niels Lohmann 已提交
11072 11073
        @brief parse string into a built-in arithmetic type as if the current
               locale is POSIX.
11074

N
Niels Lohmann 已提交
11075 11076
        @note in floating-point case strtod may parse past the token's end -
              this is not an error
11077

N
Niels Lohmann 已提交
11078
        @note any leading blanks are not handled
T
Théo DELRIEU 已提交
11079
        */
11080
        struct strtonum
T
Théo DELRIEU 已提交
11081
        {
11082
          public:
11083
            strtonum(const char* start, const char* end)
11084 11085
                : m_start(start), m_end(end)
            {}
11086

N
Niels Lohmann 已提交
11087 11088 11089 11090 11091 11092 11093
            /*!
            @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>
11094 11095 11096 11097
            bool to(T& val) const
            {
                return parse(val, std::is_integral<T>());
            }
N
Niels 已提交
11098

11099
          private:
11100
            const char* const m_start = nullptr;
N
Niels Lohmann 已提交
11101
            const char* const m_end = nullptr;
N
Niels 已提交
11102

11103 11104
            // floating-point conversion

A
Alex Astashyn 已提交
11105 11106
            // overloaded wrappers for strtod/strtof/strtold
            // that will be called from parse<floating_point_t>
N
Niels Lohmann 已提交
11107
            static void strtof(float& f, const char* str, char** endptr)
11108
            {
11109
                f = std::strtof(str, endptr);
N
Niels 已提交
11110 11111
            }

N
Niels Lohmann 已提交
11112
            static void strtof(double& f, const char* str, char** endptr)
T
Théo DELRIEU 已提交
11113
            {
11114
                f = std::strtod(str, endptr);
T
Théo DELRIEU 已提交
11115
            }
N
Niels 已提交
11116

N
Niels Lohmann 已提交
11117
            static void strtof(long double& f, const char* str, char** endptr)
T
Théo DELRIEU 已提交
11118
            {
11119
                f = std::strtold(str, endptr);
T
Théo DELRIEU 已提交
11120
            }
11121

11122 11123
            template<typename T>
            bool parse(T& value, /*is_integral=*/std::false_type) const
T
Théo DELRIEU 已提交
11124
            {
N
Niels Lohmann 已提交
11125 11126 11127
                // 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.
11128 11129
                std::string tempstr;
                std::array<char, 64> buf;
11130 11131
                const size_t len = static_cast<size_t>(m_end - m_start);

11132 11133 11134
                // lexer will reject empty numbers
                assert(len > 0);

N
Niels Lohmann 已提交
11135 11136 11137
                // 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
11138 11139
                const auto loc = localeconv();
                assert(loc != nullptr);
N
Niels Lohmann 已提交
11140
                const char decimal_point_char = (loc->decimal_point == nullptr) ? '.' : loc->decimal_point[0];
11141 11142 11143

                const char* data = m_start;

11144
                if (decimal_point_char != '.')
T
Théo DELRIEU 已提交
11145
                {
N
Niels Lohmann 已提交
11146
                    const size_t ds_pos = static_cast<size_t>(std::find(m_start, m_end, '.') - m_start);
11147

11148
                    if (ds_pos != len)
T
Théo DELRIEU 已提交
11149
                    {
N
Niels Lohmann 已提交
11150 11151 11152 11153
                        // 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())
11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164 11165
                        {
                            std::copy(m_start, m_end, buf.data());
                            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 已提交
11166 11167
                    }
                }
11168

11169 11170
                char* endptr = nullptr;
                value = 0;
11171
                // this calls appropriate overload depending on T
11172
                strtof(value, data, &endptr);
T
Théo DELRIEU 已提交
11173

11174 11175 11176
                // parsing was successful iff strtof parsed exactly the number
                // of characters determined by the lexer (len)
                const bool ok = (endptr == (data + len));
11177

N
Niels Lohmann 已提交
11178
                if (ok and (value == 0.0) and (*data == '-'))
A
Alex Astashyn 已提交
11179
                {
11180 11181
                    // some implementations forget to negate the zero
                    value = -0.0;
N
Niels 已提交
11182
                }
N
Niels 已提交
11183

11184
                return ok;
N
Niels 已提交
11185
            }
11186

11187 11188
            // integral conversion

N
Niels Lohmann 已提交
11189
            signed long long parse_integral(char** endptr, /*is_signed*/std::true_type) const
11190 11191
            {
                return std::strtoll(m_start, endptr, 10);
11192
            }
N
Niels 已提交
11193

N
Niels Lohmann 已提交
11194
            unsigned long long parse_integral(char** endptr, /*is_signed*/std::false_type) const
T
Théo DELRIEU 已提交
11195
            {
11196
                return std::strtoull(m_start, endptr, 10);
T
Théo DELRIEU 已提交
11197
            }
11198 11199 11200

            template<typename T>
            bool parse(T& value, /*is_integral=*/std::true_type) const
N
Niels 已提交
11201
            {
11202
                char* endptr = nullptr;
N
Niels Lohmann 已提交
11203
                errno = 0; // these are thread-local
11204
                const auto x = parse_integral(&endptr, std::is_signed<T>());
N
Niels Lohmann 已提交
11205

N
Niels Lohmann 已提交
11206 11207
                // called right overload?
                static_assert(std::is_signed<T>() == std::is_signed<decltype(x)>(), "");
11208 11209 11210

                value = static_cast<T>(x);

N
Niels Lohmann 已提交
11211 11212
                return (x == static_cast<decltype(x)>(value)) // x fits into destination T
                       and (x < 0) == (value < 0)             // preserved sign
11213
                       //and ((x != 0) or is_integral())        // strto[u]ll did nto fail
N
Niels Lohmann 已提交
11214 11215 11216
                       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
11217
            }
11218 11219 11220 11221 11222 11223 11224 11225
        };

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

11227 11228
        integral numbers that don't fit into the the range of the respective
        type are parsed as number_float_t
N
Niels 已提交
11229

11230 11231
        floating-point values do not satisfy std::isfinite predicate
        are converted to value_t::null
11232 11233

        throws if the entire string [m_start .. m_cursor) cannot be
11234 11235 11236
        interpreted as a number

        @param[out] result  @ref basic_json object to receive the number.
11237
        @param[in]  token   the type of the number token
11238
        */
11239
        bool get_number(basic_json& result, const token_type token) const
11240 11241 11242
        {
            assert(m_start != nullptr);
            assert(m_start < m_cursor);
N
Niels Lohmann 已提交
11243 11244
            assert((token == token_type::value_unsigned) or
                   (token == token_type::value_integer) or
11245
                   (token == token_type::value_float));
11246

N
Niels Lohmann 已提交
11247 11248
            strtonum num_converter(reinterpret_cast<const char*>(m_start),
                                   reinterpret_cast<const char*>(m_cursor));
11249

11250
            switch (token)
11251
            {
N
Niels Lohmann 已提交
11252
                case lexer::token_type::value_unsigned:
N
Niels Lohmann 已提交
11253
                {
N
Niels Lohmann 已提交
11254 11255
                    number_unsigned_t val;
                    if (num_converter.to(val))
11256
                    {
11257
                        // parsing successful
11258 11259
                        result.m_type = value_t::number_unsigned;
                        result.m_value = val;
11260
                        return true;
11261 11262
                    }
                    break;
N
Niels Lohmann 已提交
11263
                }
11264

N
Niels Lohmann 已提交
11265
                case lexer::token_type::value_integer:
11266
                {
N
Niels Lohmann 已提交
11267 11268
                    number_integer_t val;
                    if (num_converter.to(val))
11269
                    {
11270
                        // parsing successful
11271 11272
                        result.m_type = value_t::number_integer;
                        result.m_value = val;
11273
                        return true;
11274 11275 11276 11277 11278
                    }
                    break;
                }

                default:
T
Théo DELRIEU 已提交
11279
                {
11280
                    break;
T
Théo DELRIEU 已提交
11281 11282 11283
                }
            }

N
Niels Lohmann 已提交
11284 11285 11286
            // parse float (either explicitly or because a previous conversion
            // failed)
            number_float_t val;
11287
            if (num_converter.to(val))
A
Alex Astashyn 已提交
11288
            {
11289 11290 11291
                // parsing successful
                result.m_type = value_t::number_float;
                result.m_value = val;
N
Niels 已提交
11292

11293 11294 11295 11296 11297 11298
                // 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();
                }
11299

11300
                return true;
11301
            }
11302 11303 11304

            // couldn't parse number in any format
            return false;
T
Théo DELRIEU 已提交
11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326
        }

      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;
    };
N
Niels 已提交
11327

N
Niels 已提交
11328 11329
    /*!
    @brief syntax analysis
N
Niels 已提交
11330 11331

    This class implements a recursive decent parser.
N
Niels 已提交
11332
    */
N
Niels 已提交
11333 11334
    class parser
    {
T
Théo DELRIEU 已提交
11335
      public:
11336
        /// a parser reading from a string literal
N
Niels 已提交
11337
        parser(const char* buff, const parser_callback_t cb = nullptr)
T
Théo DELRIEU 已提交
11338 11339 11340
            : callback(cb),
              m_lexer(reinterpret_cast<const typename lexer::lexer_char_t*>(buff), std::strlen(buff))
        {}
11341

T
Théo DELRIEU 已提交
11342 11343 11344 11345
        /// a parser reading from an input stream
        parser(std::istream& is, const parser_callback_t cb = nullptr)
            : callback(cb), m_lexer(is)
        {}
11346

T
Théo DELRIEU 已提交
11347 11348 11349 11350 11351 11352 11353 11354 11355 11356
        /// 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 已提交
11357

T
Théo DELRIEU 已提交
11358 11359 11360 11361 11362
        /// public parser interface
        basic_json parse()
        {
            // read first token
            get_token();
N
Niels 已提交
11363

T
Théo DELRIEU 已提交
11364 11365
            basic_json result = parse_internal(true);
            result.assert_invariant();
N
Niels 已提交
11366

T
Théo DELRIEU 已提交
11367
            expect(lexer::token_type::end_of_input);
N
Niels 已提交
11368

T
Théo DELRIEU 已提交
11369 11370 11371 11372
            // 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 已提交
11373

T
Théo DELRIEU 已提交
11374 11375 11376
      private:
        /// the actual parser
        basic_json parse_internal(bool keep)
11377
        {
T
Théo DELRIEU 已提交
11378 11379 11380
            auto result = basic_json(value_t::discarded);

            switch (last_token)
N
Niels 已提交
11381
            {
T
Théo DELRIEU 已提交
11382
                case lexer::token_type::begin_object:
N
Niels 已提交
11383
                {
T
Théo DELRIEU 已提交
11384 11385 11386 11387 11388 11389 11390
                    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 已提交
11391

T
Théo DELRIEU 已提交
11392 11393
                    // read next token
                    get_token();
N
Niels 已提交
11394

T
Théo DELRIEU 已提交
11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451
                    // 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 已提交
11452
                    get_token();
N
Niels 已提交
11453
                    if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
N
Niels 已提交
11454 11455 11456
                    {
                        result = basic_json(value_t::discarded);
                    }
T
Théo DELRIEU 已提交
11457

N
Niels 已提交
11458
                    return result;
N
Niels 已提交
11459 11460
                }

T
Théo DELRIEU 已提交
11461
                case lexer::token_type::begin_array:
11462
                {
T
Théo DELRIEU 已提交
11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475
                    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 已提交
11476
                    {
N
Niels 已提交
11477
                        get_token();
T
Théo DELRIEU 已提交
11478 11479 11480 11481 11482
                        if (callback and not callback(--depth, parse_event_t::array_end, result))
                        {
                            result = basic_json(value_t::discarded);
                        }
                        return result;
N
Niels 已提交
11483 11484
                    }

T
Théo DELRIEU 已提交
11485 11486
                    // no comma is expected here
                    unexpect(lexer::token_type::value_separator);
N
Niels 已提交
11487

T
Théo DELRIEU 已提交
11488 11489
                    // otherwise: parse values
                    do
N
Niels 已提交
11490
                    {
T
Théo DELRIEU 已提交
11491 11492
                        // ugly, but could be fixed with loop reorganization
                        if (last_token == lexer::token_type::value_separator)
N
Niels 已提交
11493
                        {
T
Théo DELRIEU 已提交
11494
                            get_token();
N
Niels 已提交
11495
                        }
T
Théo DELRIEU 已提交
11496 11497 11498 11499

                        // parse value
                        auto value = parse_internal(keep);
                        if (keep and not value.is_discarded())
N
Niels 已提交
11500
                        {
T
Théo DELRIEU 已提交
11501
                            result.push_back(std::move(value));
N
Niels 已提交
11502
                        }
N
Niels 已提交
11503
                    }
T
Théo DELRIEU 已提交
11504
                    while (last_token == lexer::token_type::value_separator);
N
Niels 已提交
11505

T
Théo DELRIEU 已提交
11506 11507
                    // closing ]
                    expect(lexer::token_type::end_array);
11508
                    get_token();
T
Théo DELRIEU 已提交
11509
                    if (keep and callback and not callback(--depth, parse_event_t::array_end, result))
N
Niels 已提交
11510
                    {
T
Théo DELRIEU 已提交
11511
                        result = basic_json(value_t::discarded);
N
Niels 已提交
11512
                    }
T
Théo DELRIEU 已提交
11513 11514

                    return result;
N
Niels 已提交
11515 11516
                }

T
Théo DELRIEU 已提交
11517
                case lexer::token_type::literal_null:
N
Niels 已提交
11518
                {
T
Théo DELRIEU 已提交
11519 11520 11521
                    get_token();
                    result.m_type = value_t::null;
                    break;
N
Niels 已提交
11522 11523
                }

T
Théo DELRIEU 已提交
11524
                case lexer::token_type::value_string:
N
Niels 已提交
11525
                {
T
Théo DELRIEU 已提交
11526 11527 11528 11529
                    const auto s = m_lexer.get_string();
                    get_token();
                    result = basic_json(s);
                    break;
N
Niels 已提交
11530 11531
                }

T
Théo DELRIEU 已提交
11532
                case lexer::token_type::literal_true:
N
Niels 已提交
11533
                {
N
Niels 已提交
11534
                    get_token();
T
Théo DELRIEU 已提交
11535 11536 11537
                    result.m_type = value_t::boolean;
                    result.m_value = true;
                    break;
N
Niels 已提交
11538 11539
                }

T
Théo DELRIEU 已提交
11540
                case lexer::token_type::literal_false:
N
Niels 已提交
11541
                {
T
Théo DELRIEU 已提交
11542 11543 11544 11545
                    get_token();
                    result.m_type = value_t::boolean;
                    result.m_value = false;
                    break;
N
Niels 已提交
11546 11547
                }

N
Niels Lohmann 已提交
11548 11549
                case lexer::token_type::value_unsigned:
                case lexer::token_type::value_integer:
11550
                case lexer::token_type::value_float:
N
Niels 已提交
11551
                {
N
Niels Lohmann 已提交
11552
                    m_lexer.get_number(result, last_token);
T
Théo DELRIEU 已提交
11553 11554
                    get_token();
                    break;
N
Niels 已提交
11555
                }
11556

T
Théo DELRIEU 已提交
11557 11558 11559 11560 11561
                default:
                {
                    // the last token was unexpected
                    unexpect(last_token);
                }
11562 11563
            }

T
Théo DELRIEU 已提交
11564
            if (keep and callback and not callback(depth, parse_event_t::value, result))
11565
            {
T
Théo DELRIEU 已提交
11566
                result = basic_json(value_t::discarded);
N
Niels 已提交
11567
            }
T
Théo DELRIEU 已提交
11568
            return result;
N
Niels 已提交
11569 11570
        }

T
Théo DELRIEU 已提交
11571 11572
        /// get next token from lexer
        typename lexer::token_type get_token()
N
Niels 已提交
11573
        {
T
Théo DELRIEU 已提交
11574 11575
            last_token = m_lexer.scan();
            return last_token;
N
Niels 已提交
11576 11577
        }

T
Théo DELRIEU 已提交
11578
        void expect(typename lexer::token_type t) const
N
Niels 已提交
11579
        {
T
Théo DELRIEU 已提交
11580 11581 11582 11583 11584 11585 11586
            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);
11587
                JSON_THROW(std::invalid_argument(error_msg));
T
Théo DELRIEU 已提交
11588
            }
N
Niels 已提交
11589 11590
        }

T
Théo DELRIEU 已提交
11591
        void unexpect(typename lexer::token_type t) const
N
Niels 已提交
11592
        {
T
Théo DELRIEU 已提交
11593 11594 11595 11596 11597 11598
            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));
11599
                JSON_THROW(std::invalid_argument(error_msg));
T
Théo DELRIEU 已提交
11600
            }
N
Niels 已提交
11601 11602
        }

T
Théo DELRIEU 已提交
11603 11604 11605 11606 11607 11608 11609 11610 11611 11612
      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 已提交
11613 11614

  public:
N
Niels 已提交
11615 11616 11617
    /*!
    @brief JSON Pointer

N
Niels 已提交
11618 11619 11620 11621
    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 已提交
11622
    @sa [RFC 6901](https://tools.ietf.org/html/rfc6901)
N
Niels 已提交
11623 11624

    @since version 2.0.0
N
Niels 已提交
11625
    */
N
Niels 已提交
11626 11627
    class json_pointer
    {
N
Niels 已提交
11628 11629 11630
        /// allow basic_json to access private members
        friend class basic_json;

T
Théo DELRIEU 已提交
11631
      public:
N
Niels 已提交
11632 11633 11634 11635 11636 11637 11638 11639 11640 11641
        /*!
        @brief create JSON pointer

        Create a JSON pointer according to the syntax described in
        [Section 3 of RFC6901](https://tools.ietf.org/html/rfc6901#section-3).

        @param[in] s  string representing the JSON pointer; if omitted, the
                      empty string is assumed which references the whole JSON
                      value

N
Niels 已提交
11642 11643 11644 11645 11646 11647
        @throw std::domain_error if reference token is nonempty and does not
        begin with a slash (`/`); example: `"JSON pointer must be empty or
        begin with /"`
        @throw std::domain_error if a tilde (`~`) is not followed by `0`
        (representing `~`) or `1` (representing `/`); example: `"escape error:
        ~ must be followed with 0 or 1"`
N
Niels 已提交
11648 11649 11650

        @liveexample{The example shows the construction several valid JSON
        pointers as well as the exceptional behavior.,json_pointer}
N
Niels 已提交
11651

N
Niels 已提交
11652 11653 11654
        @since version 2.0.0
        */
        explicit json_pointer(const std::string& s = "")
T
Théo DELRIEU 已提交
11655 11656
            : reference_tokens(split(s))
        {}
N
Niels 已提交
11657

T
Théo DELRIEU 已提交
11658 11659
        /*!
        @brief return a string representation of the JSON pointer
N
Niels 已提交
11660

T
Théo DELRIEU 已提交
11661 11662 11663 11664
        @invariant For each JSON pointer `ptr`, it holds:
        @code {.cpp}
        ptr == json_pointer(ptr.to_string());
        @endcode
N
Niels 已提交
11665

T
Théo DELRIEU 已提交
11666
        @return a string representation of the JSON pointer
N
Niels 已提交
11667

T
Théo DELRIEU 已提交
11668 11669
        @liveexample{The example shows the result of `to_string`.,
        json_pointer__to_string}
N
Niels 已提交
11670

T
Théo DELRIEU 已提交
11671 11672 11673
        @since version 2.0.0
        */
        std::string to_string() const noexcept
N
Niels 已提交
11674
        {
T
Théo DELRIEU 已提交
11675 11676 11677 11678 11679 11680 11681
            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 已提交
11682

T
Théo DELRIEU 已提交
11683 11684
        /// @copydoc to_string()
        operator std::string() const
N
Niels 已提交
11685
        {
T
Théo DELRIEU 已提交
11686
            return to_string();
N
Niels 已提交
11687 11688
        }

T
Théo DELRIEU 已提交
11689 11690 11691 11692 11693 11694 11695 11696
      private:
        /// remove and return last reference pointer
        std::string pop_back()
        {
            if (is_root())
            {
                JSON_THROW(std::domain_error("JSON pointer has no parent"));
            }
11697

T
Théo DELRIEU 已提交
11698 11699 11700 11701
            auto last = reference_tokens.back();
            reference_tokens.pop_back();
            return last;
        }
N
Niels 已提交
11702

T
Théo DELRIEU 已提交
11703 11704
        /// return whether pointer points to the root document
        bool is_root() const
N
Niels 已提交
11705
        {
T
Théo DELRIEU 已提交
11706
            return reference_tokens.empty();
N
Niels 已提交
11707 11708
        }

T
Théo DELRIEU 已提交
11709 11710 11711 11712 11713 11714
        json_pointer top() const
        {
            if (is_root())
            {
                JSON_THROW(std::domain_error("JSON pointer has no parent"));
            }
N
Niels 已提交
11715

T
Théo DELRIEU 已提交
11716 11717 11718 11719
            json_pointer result = *this;
            result.reference_tokens = {reference_tokens[0]};
            return result;
        }
N
Niels 已提交
11720

T
Théo DELRIEU 已提交
11721 11722
        /*!
        @brief create and return a reference to the pointed to value
11723

T
Théo DELRIEU 已提交
11724 11725 11726
        @complexity Linear in the number of reference tokens.
        */
        reference get_and_create(reference j) const
11727
        {
T
Théo DELRIEU 已提交
11728 11729 11730 11731 11732
            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 已提交
11733
            {
T
Théo DELRIEU 已提交
11734
                switch (result->m_type)
N
Niels 已提交
11735
                {
T
Théo DELRIEU 已提交
11736
                    case value_t::null:
N
Niels 已提交
11737
                    {
T
Théo DELRIEU 已提交
11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748
                        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 已提交
11749
                    }
T
Théo DELRIEU 已提交
11750 11751

                    case value_t::object:
N
Niels 已提交
11752
                    {
T
Théo DELRIEU 已提交
11753
                        // create an entry in the object
N
Niels 已提交
11754
                        result = &result->operator[](reference_token);
T
Théo DELRIEU 已提交
11755
                        break;
N
Niels 已提交
11756
                    }
N
Niels 已提交
11757

T
Théo DELRIEU 已提交
11758 11759 11760 11761 11762 11763
                    case value_t::array:
                    {
                        // create an entry in the array
                        result = &result->operator[](static_cast<size_type>(std::stoi(reference_token)));
                        break;
                    }
11764

T
Théo DELRIEU 已提交
11765 11766 11767 11768 11769 11770 11771 11772 11773
                    /*
                    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:
                    {
11774
                        JSON_THROW(std::domain_error("invalid value to unflatten"));
T
Théo DELRIEU 已提交
11775
                    }
N
Niels 已提交
11776 11777
                }
            }
11778

T
Théo DELRIEU 已提交
11779 11780
            return *result;
        }
11781

T
Théo DELRIEU 已提交
11782 11783
        /*!
        @brief return a reference to the pointed to value
11784

T
Théo DELRIEU 已提交
11785 11786 11787 11788 11789
        @note This version does not throw if a value is not present, but tries
        to create nested values instead. For instance, calling this function
        with pointer `"/this/that"` on a null value is equivalent to calling
        `operator[]("this").operator[]("that")` on that value, effectively
        changing the null value to an object.
N
Niels 已提交
11790

T
Théo DELRIEU 已提交
11791
        @param[in] ptr  a JSON value
N
Niels 已提交
11792

T
Théo DELRIEU 已提交
11793
        @return reference to the JSON value pointed to by the JSON pointer
N
Niels 已提交
11794

T
Théo DELRIEU 已提交
11795
        @complexity Linear in the length of the JSON pointer.
11796

T
Théo DELRIEU 已提交
11797 11798 11799 11800 11801
        @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
        */
        reference get_unchecked(pointer ptr) const
11802
        {
T
Théo DELRIEU 已提交
11803
            for (const auto& reference_token : reference_tokens)
11804
            {
T
Théo DELRIEU 已提交
11805 11806
                // convert null values to arrays or objects before continuing
                if (ptr->m_type == value_t::null)
11807
                {
T
Théo DELRIEU 已提交
11808 11809 11810 11811
                    // check if reference token is a number
                    const bool nums = std::all_of(reference_token.begin(),
                                                  reference_token.end(),
                                                  [](const char x)
N
Niels 已提交
11812
                    {
T
Théo DELRIEU 已提交
11813 11814
                        return std::isdigit(x);
                    });
N
Niels 已提交
11815

T
Théo DELRIEU 已提交
11816 11817 11818
                    // change value to array for numbers or "-" or to object
                    // otherwise
                    if (nums or reference_token == "-")
N
Niels 已提交
11819
                    {
T
Théo DELRIEU 已提交
11820
                        *ptr = value_t::array;
N
Niels 已提交
11821 11822 11823
                    }
                    else
                    {
T
Théo DELRIEU 已提交
11824
                        *ptr = value_t::object;
N
Niels 已提交
11825
                    }
N
Niels 已提交
11826 11827
                }

T
Théo DELRIEU 已提交
11828
                switch (ptr->m_type)
N
Niels 已提交
11829
                {
T
Théo DELRIEU 已提交
11830 11831 11832 11833 11834 11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845 11846
                    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')
                        {
                            JSON_THROW(std::domain_error("array index must not begin with '0'"));
                        }

                        if (reference_token == "-")
                        {
N
Niels Lohmann 已提交
11847
                            // explicitly treat "-" as index beyond the end
T
Théo DELRIEU 已提交
11848 11849 11850 11851 11852 11853 11854 11855 11856 11857 11858 11859
                            ptr = &ptr->operator[](ptr->m_value.array->size());
                        }
                        else
                        {
                            // convert array index to number; unchecked access
                            ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
                        }
                        break;
                    }

                    default:
                    {
11860
                        JSON_THROW(std::out_of_range("unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
11861
                    }
N
Niels 已提交
11862 11863
                }
            }
N
Niels 已提交
11864

T
Théo DELRIEU 已提交
11865 11866
            return *ptr;
        }
11867

T
Théo DELRIEU 已提交
11868
        reference get_checked(pointer ptr) const
N
Niels 已提交
11869
        {
T
Théo DELRIEU 已提交
11870
            for (const auto& reference_token : reference_tokens)
N
Niels 已提交
11871
            {
T
Théo DELRIEU 已提交
11872
                switch (ptr->m_type)
11873
                {
T
Théo DELRIEU 已提交
11874
                    case value_t::object:
N
Niels 已提交
11875
                    {
T
Théo DELRIEU 已提交
11876 11877 11878
                        // note: at performs range check
                        ptr = &ptr->at(reference_token);
                        break;
N
Niels 已提交
11879 11880
                    }

T
Théo DELRIEU 已提交
11881
                    case value_t::array:
N
Niels 已提交
11882
                    {
T
Théo DELRIEU 已提交
11883 11884 11885
                        if (reference_token == "-")
                        {
                            // "-" always fails the range check
11886 11887 11888
                            JSON_THROW(std::out_of_range("array index '-' (" +
                                                         std::to_string(ptr->m_value.array->size()) +
                                                         ") is out of range"));
T
Théo DELRIEU 已提交
11889 11890 11891 11892 11893
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
11894
                            JSON_THROW(std::domain_error("array index must not begin with '0'"));
T
Théo DELRIEU 已提交
11895
                        }
N
Niels 已提交
11896

T
Théo DELRIEU 已提交
11897 11898 11899 11900
                        // note: at performs range check
                        ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
                        break;
                    }
11901

T
Théo DELRIEU 已提交
11902 11903
                    default:
                    {
11904
                        JSON_THROW(std::out_of_range("unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
11905
                    }
N
Niels 已提交
11906 11907 11908
                }
            }

T
Théo DELRIEU 已提交
11909 11910
            return *ptr;
        }
N
Niels 已提交
11911

T
Théo DELRIEU 已提交
11912 11913
        /*!
        @brief return a const reference to the pointed to value
N
Niels 已提交
11914

T
Théo DELRIEU 已提交
11915
        @param[in] ptr  a JSON value
11916

T
Théo DELRIEU 已提交
11917 11918 11919 11920
        @return const reference to the JSON value pointed to by the JSON
                pointer
        */
        const_reference get_unchecked(const_pointer ptr) const
N
Niels 已提交
11921
        {
T
Théo DELRIEU 已提交
11922
            for (const auto& reference_token : reference_tokens)
N
Niels 已提交
11923
            {
T
Théo DELRIEU 已提交
11924
                switch (ptr->m_type)
11925
                {
T
Théo DELRIEU 已提交
11926
                    case value_t::object:
N
Niels 已提交
11927
                    {
T
Théo DELRIEU 已提交
11928 11929 11930
                        // use unchecked object access
                        ptr = &ptr->operator[](reference_token);
                        break;
N
Niels 已提交
11931 11932
                    }

T
Théo DELRIEU 已提交
11933
                    case value_t::array:
N
Niels 已提交
11934
                    {
T
Théo DELRIEU 已提交
11935 11936 11937
                        if (reference_token == "-")
                        {
                            // "-" cannot be used for const access
11938 11939 11940
                            JSON_THROW(std::out_of_range("array index '-' (" +
                                                         std::to_string(ptr->m_value.array->size()) +
                                                         ") is out of range"));
T
Théo DELRIEU 已提交
11941 11942 11943 11944 11945
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
11946
                            JSON_THROW(std::domain_error("array index must not begin with '0'"));
T
Théo DELRIEU 已提交
11947
                        }
N
Niels 已提交
11948

T
Théo DELRIEU 已提交
11949 11950 11951 11952
                        // use unchecked array access
                        ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
                        break;
                    }
11953

T
Théo DELRIEU 已提交
11954 11955
                    default:
                    {
11956
                        JSON_THROW(std::out_of_range("unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
11957
                    }
N
Niels 已提交
11958 11959 11960
                }
            }

T
Théo DELRIEU 已提交
11961 11962
            return *ptr;
        }
11963

T
Théo DELRIEU 已提交
11964
        const_reference get_checked(const_pointer ptr) const
11965
        {
T
Théo DELRIEU 已提交
11966
            for (const auto& reference_token : reference_tokens)
11967
            {
T
Théo DELRIEU 已提交
11968
                switch (ptr->m_type)
11969
                {
T
Théo DELRIEU 已提交
11970
                    case value_t::object:
N
Niels 已提交
11971
                    {
T
Théo DELRIEU 已提交
11972 11973 11974
                        // note: at performs range check
                        ptr = &ptr->at(reference_token);
                        break;
N
Niels 已提交
11975
                    }
11976

T
Théo DELRIEU 已提交
11977
                    case value_t::array:
N
Niels 已提交
11978
                    {
T
Théo DELRIEU 已提交
11979 11980 11981
                        if (reference_token == "-")
                        {
                            // "-" always fails the range check
11982 11983 11984
                            JSON_THROW(std::out_of_range("array index '-' (" +
                                                         std::to_string(ptr->m_value.array->size()) +
                                                         ") is out of range"));
T
Théo DELRIEU 已提交
11985 11986 11987 11988 11989
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
11990
                            JSON_THROW(std::domain_error("array index must not begin with '0'"));
T
Théo DELRIEU 已提交
11991
                        }
11992

T
Théo DELRIEU 已提交
11993 11994 11995 11996
                        // note: at performs range check
                        ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
                        break;
                    }
11997

T
Théo DELRIEU 已提交
11998 11999
                    default:
                    {
12000
                        JSON_THROW(std::out_of_range("unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
12001
                    }
12002 12003
                }
            }
N
Niels 已提交
12004

T
Théo DELRIEU 已提交
12005
            return *ptr;
12006 12007
        }

T
Théo DELRIEU 已提交
12008 12009
        /// split the string input to reference tokens
        static std::vector<std::string> split(const std::string& reference_string)
12010
        {
T
Théo DELRIEU 已提交
12011 12012 12013 12014 12015 12016 12017 12018 12019 12020 12021
            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] != '/')
            {
12022
                JSON_THROW(std::domain_error("JSON pointer must be empty or begin with '/'"));
T
Théo DELRIEU 已提交
12023
            }
N
Niels 已提交
12024

T
Théo DELRIEU 已提交
12025 12026 12027 12028 12029
            // 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 已提交
12030
                size_t slash = reference_string.find_first_of('/', 1),
T
Théo DELRIEU 已提交
12031 12032 12033 12034 12035 12036 12037 12038
                // 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 已提交
12039
                slash = reference_string.find_first_of('/', start))
T
Théo DELRIEU 已提交
12040 12041 12042 12043
            {
                // 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 已提交
12044

T
Théo DELRIEU 已提交
12045
                // check reference tokens are properly escaped
N
Niels Lohmann 已提交
12046
                for (size_t pos = reference_token.find_first_of('~');
T
Théo DELRIEU 已提交
12047
                        pos != std::string::npos;
N
Niels Lohmann 已提交
12048
                        pos = reference_token.find_first_of('~', pos + 1))
12049
                {
T
Théo DELRIEU 已提交
12050 12051 12052 12053 12054 12055 12056
                    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'))
                    {
12057
                        JSON_THROW(std::domain_error("escape error: '~' must be followed with '0' or '1'"));
T
Théo DELRIEU 已提交
12058
                    }
N
Niels 已提交
12059
                }
T
Théo DELRIEU 已提交
12060 12061 12062 12063

                // finally, store the reference token
                unescape(reference_token);
                result.push_back(reference_token);
12064
            }
N
Niels 已提交
12065

T
Théo DELRIEU 已提交
12066
            return result;
N
Niels 已提交
12067
        }
N
Niels 已提交
12068

T
Théo DELRIEU 已提交
12069 12070 12071
      private:
        /*!
        @brief replace all occurrences of a substring by another string
N
Niels 已提交
12072

T
Théo DELRIEU 已提交
12073 12074 12075 12076
        @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 已提交
12077

T
Théo DELRIEU 已提交
12078
        @pre The search string @a f must not be empty.
N
Niels 已提交
12079

T
Théo DELRIEU 已提交
12080 12081 12082 12083 12084 12085 12086
        @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 已提交
12087

T
Théo DELRIEU 已提交
12088 12089 12090 12091 12092 12093 12094
            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 已提交
12095

T
Théo DELRIEU 已提交
12096 12097 12098 12099 12100 12101 12102 12103
        /// 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 已提交
12104

T
Théo DELRIEU 已提交
12105 12106 12107 12108 12109 12110 12111 12112
        /// 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 已提交
12113

T
Théo DELRIEU 已提交
12114 12115 12116 12117
        /*!
        @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
12118

T
Théo DELRIEU 已提交
12119 12120 12121 12122 12123
        @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 已提交
12124
        {
T
Théo DELRIEU 已提交
12125
            switch (value.m_type)
N
Niels 已提交
12126
            {
T
Théo DELRIEU 已提交
12127
                case value_t::array:
12128
                {
T
Théo DELRIEU 已提交
12129 12130 12131 12132 12133 12134
                    if (value.m_value.array->empty())
                    {
                        // flatten empty array as null
                        result[reference_string] = nullptr;
                    }
                    else
N
Niels 已提交
12135
                    {
T
Théo DELRIEU 已提交
12136 12137 12138 12139 12140 12141
                        // 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 已提交
12142
                    }
T
Théo DELRIEU 已提交
12143
                    break;
N
Niels 已提交
12144 12145
                }

T
Théo DELRIEU 已提交
12146
                case value_t::object:
12147
                {
T
Théo DELRIEU 已提交
12148 12149 12150 12151 12152 12153
                    if (value.m_value.object->empty())
                    {
                        // flatten empty object as null
                        result[reference_string] = nullptr;
                    }
                    else
N
Niels 已提交
12154
                    {
T
Théo DELRIEU 已提交
12155 12156 12157 12158 12159 12160
                        // 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 已提交
12161
                    }
T
Théo DELRIEU 已提交
12162
                    break;
N
Niels 已提交
12163 12164
                }

T
Théo DELRIEU 已提交
12165 12166 12167 12168 12169 12170
                default:
                {
                    // add primitive value with its reference string
                    result[reference_string] = value;
                    break;
                }
N
Niels 已提交
12171 12172
            }
        }
N
Niels 已提交
12173

T
Théo DELRIEU 已提交
12174 12175
        /*!
        @param[in] value  flattened JSON
N
Niels 已提交
12176

T
Théo DELRIEU 已提交
12177 12178 12179
        @return unflattened JSON
        */
        static basic_json unflatten(const basic_json& value)
N
Niels 已提交
12180
        {
T
Théo DELRIEU 已提交
12181 12182
            if (not value.is_object())
            {
12183
                JSON_THROW(std::domain_error("only objects can be unflattened"));
T
Théo DELRIEU 已提交
12184
            }
N
Niels 已提交
12185

T
Théo DELRIEU 已提交
12186
            basic_json result;
N
Niels 已提交
12187

T
Théo DELRIEU 已提交
12188 12189
            // iterate the JSON object values
            for (const auto& element : *value.m_value.object)
N
Niels 已提交
12190
            {
T
Théo DELRIEU 已提交
12191 12192
                if (not element.second.is_primitive())
                {
12193
                    JSON_THROW(std::domain_error("values in object must be primitive"));
T
Théo DELRIEU 已提交
12194 12195 12196 12197 12198 12199 12200 12201
                }

                // 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 已提交
12202 12203
            }

T
Théo DELRIEU 已提交
12204
            return result;
N
Niels 已提交
12205
        }
N
Niels 已提交
12206

T
Théo DELRIEU 已提交
12207 12208 12209 12210 12211 12212
      private:
        friend bool operator==(json_pointer const& lhs,
                               json_pointer const& rhs) noexcept
        {
            return lhs.reference_tokens == rhs.reference_tokens;
        }
12213

T
Théo DELRIEU 已提交
12214 12215 12216 12217 12218
        friend bool operator!=(json_pointer const& lhs,
                               json_pointer const& rhs) noexcept
        {
            return !(lhs == rhs);
        }
12219

T
Théo DELRIEU 已提交
12220 12221
        /// the reference tokens
        std::vector<std::string> reference_tokens {};
12222
    };
N
Niels 已提交
12223

N
Niels 已提交
12224 12225 12226
    //////////////////////////
    // JSON Pointer support //
    //////////////////////////
N
Niels 已提交
12227 12228 12229 12230

    /// @name JSON Pointer functions
    /// @{

N
Niels 已提交
12231 12232 12233 12234
    /*!
    @brief access specified element via JSON Pointer

    Uses a JSON pointer to retrieve a reference to the respective JSON value.
N
Niels 已提交
12235 12236 12237
    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 已提交
12238 12239 12240 12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251 12252 12253 12254 12255 12256 12257 12258 12259 12260 12261 12262 12263 12264 12265 12266 12267 12268 12269 12270 12271 12272 12273 12274 12275 12276 12277 12278 12279 12280 12281 12282 12283 12284 12285 12286 12287 12288 12289 12290 12291 12292 12293 12294 12295 12296 12297 12298 12299 12300 12301 12302 12303 12304 12305 12306 12307 12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323

    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 已提交
12324 12325
    Returns a const reference to the element at with specified JSON pointer @a
    ptr, with bounds checking.
N
Niels 已提交
12326 12327 12328 12329 12330 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345

    @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 已提交
12346
    /*!
N
Niels 已提交
12347 12348
    @brief return flattened JSON value

N
Niels 已提交
12349 12350 12351 12352
    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 已提交
12353

N
Niels Lohmann 已提交
12354
    @return an object that maps JSON pointers to primitive values
N
Niels 已提交
12355

N
Niels 已提交
12356 12357
    @note Empty objects and arrays are flattened to `null` and will not be
          reconstructed correctly by the @ref unflatten() function.
N
Niels 已提交
12358 12359 12360 12361 12362 12363 12364 12365 12366

    @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 已提交
12367 12368 12369 12370 12371 12372 12373
    */
    basic_json flatten() const
    {
        basic_json result(value_t::object);
        json_pointer::flatten("", *this, result);
        return result;
    }
N
Niels 已提交
12374 12375

    /*!
N
Niels 已提交
12376 12377 12378 12379 12380 12381 12382 12383 12384 12385
    @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 已提交
12386
    @return the original JSON from a flattened version
N
Niels 已提交
12387 12388 12389 12390 12391 12392 12393 12394 12395 12396 12397 12398 12399 12400

    @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 已提交
12401
    */
N
Niels 已提交
12402
    basic_json unflatten() const
N
Niels 已提交
12403
    {
N
Niels 已提交
12404
        return json_pointer::unflatten(*this);
N
Niels 已提交
12405
    }
N
Niels 已提交
12406 12407

    /// @}
12408

N
Niels 已提交
12409 12410 12411 12412 12413 12414 12415
    //////////////////////////
    // JSON Patch functions //
    //////////////////////////

    /// @name JSON Patch functions
    /// @{

12416 12417 12418
    /*!
    @brief applies a JSON patch

N
Niels 已提交
12419 12420
    [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 已提交
12421
    this function, a JSON Patch is applied to the current JSON value by
N
Niels 已提交
12422 12423
    executing all operations from the patch.

N
Niels 已提交
12424
    @param[in] json_patch  JSON patch document
12425 12426
    @return patched document

N
Niels 已提交
12427 12428 12429 12430 12431 12432 12433 12434 12435 12436 12437 12438 12439 12440
    @note The application of a patch is atomic: Either all operations succeed
          and the patched document is returned or an exception is thrown. In
          any case, the original value is not changed: the patch is applied
          to a copy of the value.

    @throw std::out_of_range if a JSON pointer inside the patch could not
    be resolved successfully in the current JSON value; example: `"key baz
    not found"`
    @throw invalid_argument if the JSON patch is malformed (e.g., mandatory
    attributes are missing); example: `"operation add must have member path"`

    @complexity Linear in the size of the JSON value and the length of the
    JSON patch. As usually only a fraction of the JSON value is affected by
    the patch, the complexity can usually be neglected.
12441

N
Niels 已提交
12442 12443 12444 12445 12446 12447 12448 12449 12450
    @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
12451
    */
N
Niels 已提交
12452
    basic_json patch(const basic_json& json_patch) const
12453
    {
N
Niels 已提交
12454
        // make a working copy to apply the patch to
12455 12456
        basic_json result = *this;

N
Niels 已提交
12457 12458 12459 12460 12461 12462 12463 12464 12465 12466 12467 12468 12469 12470 12471 12472 12473 12474 12475 12476 12477 12478 12479 12480 12481 12482 12483 12484 12485 12486 12487 12488 12489
        // the valid JSON Patch operations
        enum class patch_operations {add, remove, replace, move, copy, test, invalid};

        const auto get_op = [](const std::string op)
        {
            if (op == "add")
            {
                return patch_operations::add;
            }
            if (op == "remove")
            {
                return patch_operations::remove;
            }
            if (op == "replace")
            {
                return patch_operations::replace;
            }
            if (op == "move")
            {
                return patch_operations::move;
            }
            if (op == "copy")
            {
                return patch_operations::copy;
            }
            if (op == "test")
            {
                return patch_operations::test;
            }

            return patch_operations::invalid;
        };

N
Niels 已提交
12490
        // wrapper for "add" operation; add value at ptr
N
Niels 已提交
12491
        const auto operation_add = [&result](json_pointer & ptr, basic_json val)
N
Niels 已提交
12492
        {
N
Niels 已提交
12493 12494
            // adding to the root of the target document means replacing it
            if (ptr.is_root())
N
Niels 已提交
12495
            {
N
Niels 已提交
12496
                result = val;
N
Niels 已提交
12497
            }
N
Niels 已提交
12498
            else
N
Niels 已提交
12499
            {
N
Niels 已提交
12500 12501 12502
                // make sure the top element of the pointer exists
                json_pointer top_pointer = ptr.top();
                if (top_pointer != ptr)
N
Niels 已提交
12503
                {
N
Niels 已提交
12504
                    result.at(top_pointer);
N
Niels 已提交
12505
                }
N
Niels 已提交
12506 12507 12508 12509 12510 12511

                // 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 已提交
12512
                {
N
Niels 已提交
12513 12514 12515 12516 12517 12518 12519 12520 12521 12522 12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533
                    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
12534
                                JSON_THROW(std::out_of_range("array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
12535 12536 12537 12538 12539 12540 12541 12542 12543 12544 12545 12546
                            }
                            else
                            {
                                // default case: insert add offset
                                parent.insert(parent.begin() + static_cast<difference_type>(idx), val);
                            }
                        }
                        break;
                    }

                    default:
                    {
N
Niels 已提交
12547 12548
                        // if there exists a parent it cannot be primitive
                        assert(false);  // LCOV_EXCL_LINE
N
Niels 已提交
12549
                    }
N
Niels 已提交
12550 12551 12552 12553
                }
            }
        };

N
Niels 已提交
12554
        // wrapper for "remove" operation; remove value at ptr
N
Niels 已提交
12555 12556
        const auto operation_remove = [&result](json_pointer & ptr)
        {
N
Niels 已提交
12557
            // get reference to parent of JSON pointer ptr
N
Niels 已提交
12558 12559
            const auto last_path = ptr.pop_back();
            basic_json& parent = result.at(ptr);
N
Niels 已提交
12560 12561

            // remove child
N
Niels 已提交
12562 12563
            if (parent.is_object())
            {
N
Niels 已提交
12564 12565 12566 12567 12568 12569 12570 12571
                // perform range check
                auto it = parent.find(last_path);
                if (it != parent.end())
                {
                    parent.erase(it);
                }
                else
                {
12572
                    JSON_THROW(std::out_of_range("key '" + last_path + "' not found"));
N
Niels 已提交
12573
                }
N
Niels 已提交
12574 12575 12576
            }
            else if (parent.is_array())
            {
N
Niels 已提交
12577 12578
                // note erase performs range check
                parent.erase(static_cast<size_type>(std::stoi(last_path)));
N
Niels 已提交
12579 12580 12581
            }
        };

N
Niels 已提交
12582
        // type check
N
Niels 已提交
12583
        if (not json_patch.is_array())
N
Niels 已提交
12584 12585
        {
            // a JSON patch must be an array of objects
12586
            JSON_THROW(std::invalid_argument("JSON patch must be an array of objects"));
N
Niels 已提交
12587 12588
        }

N
Niels Lohmann 已提交
12589
        // iterate and apply the operations
N
Niels 已提交
12590
        for (const auto& val : json_patch)
12591
        {
N
Niels 已提交
12592 12593 12594
            // wrapper to get a value for an operation
            const auto get_value = [&val](const std::string & op,
                                          const std::string & member,
N
Niels 已提交
12595
                                          bool string_type) -> basic_json&
12596
            {
N
Niels 已提交
12597 12598
                // find value
                auto it = val.m_value.object->find(member);
12599

N
Niels 已提交
12600 12601
                // context-sensitive error message
                const auto error_msg = (op == "op") ? "operation" : "operation '" + op + "'";
12602

N
Niels 已提交
12603 12604 12605
                // check if desired value is present
                if (it == val.m_value.object->end())
                {
12606
                    JSON_THROW(std::invalid_argument(error_msg + " must have member '" + member + "'"));
N
Niels 已提交
12607
                }
12608

N
Niels 已提交
12609 12610 12611
                // check if result is of type string
                if (string_type and not it->second.is_string())
                {
12612
                    JSON_THROW(std::invalid_argument(error_msg + " must have string member '" + member + "'"));
N
Niels 已提交
12613 12614 12615 12616 12617 12618 12619 12620
                }

                // no error: return value
                return it->second;
            };

            // type check
            if (not val.is_object())
12621
            {
12622
                JSON_THROW(std::invalid_argument("JSON patch must be an array of objects"));
12623 12624
            }

N
Niels 已提交
12625 12626 12627
            // collect mandatory members
            const std::string op = get_value("op", "op", true);
            const std::string path = get_value(op, "path", true);
N
oops  
Niels 已提交
12628
            json_pointer ptr(path);
12629

N
Niels 已提交
12630
            switch (get_op(op))
12631
            {
N
Niels 已提交
12632 12633 12634 12635 12636 12637 12638 12639 12640 12641 12642 12643 12644 12645 12646 12647 12648 12649 12650 12651 12652 12653 12654 12655 12656 12657 12658 12659 12660 12661 12662 12663 12664 12665 12666 12667 12668 12669 12670 12671 12672 12673 12674 12675 12676 12677 12678 12679 12680
                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;
12681
                    JSON_TRY
N
Niels 已提交
12682 12683 12684 12685 12686
                    {
                        // check if "value" matches the one at "path"
                        // the "path" location must exist - use at()
                        success = (result.at(ptr) == get_value("test", "value", false));
                    }
12687
                    JSON_CATCH (std::out_of_range&)
N
Niels 已提交
12688 12689 12690 12691 12692 12693 12694
                    {
                        // ignore out of range errors: success remains false
                    }

                    // throw an exception if test fails
                    if (not success)
                    {
12695
                        JSON_THROW(std::domain_error("unsuccessful: " + val.dump()));
N
Niels 已提交
12696 12697 12698 12699 12700 12701 12702 12703 12704
                    }

                    break;
                }

                case patch_operations::invalid:
                {
                    // op must be "add", "remove", "replace", "move", "copy", or
                    // "test"
12705
                    JSON_THROW(std::invalid_argument("operation value '" + op + "' is invalid"));
N
Niels 已提交
12706
                }
12707
            }
N
Niels 已提交
12708 12709 12710 12711 12712 12713 12714 12715 12716 12717 12718 12719 12720 12721 12722 12723 12724 12725 12726 12727
        }

        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 已提交
12728 12729
    @param[in] source  JSON value to compare from
    @param[in] target  JSON value to compare against
N
Niels 已提交
12730 12731 12732 12733 12734 12735 12736 12737 12738 12739 12740 12741 12742 12743 12744 12745 12746
    @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,
12747
                           const std::string& path = "")
N
Niels 已提交
12748 12749 12750 12751 12752 12753 12754 12755 12756 12757 12758 12759 12760 12761
    {
        // 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(
12762
            {
N
Niels 已提交
12763 12764 12765 12766 12767 12768 12769 12770
                {"op", "replace"},
                {"path", path},
                {"value", target}
            });
        }
        else
        {
            switch (source.type())
12771
            {
N
Niels 已提交
12772 12773 12774 12775 12776 12777 12778 12779 12780 12781 12782
                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 已提交
12783

N
Niels 已提交
12784 12785
                    // i now reached the end of at least one array
                    // in a second pass, traverse the remaining elements
N
Niels 已提交
12786

N
Niels 已提交
12787
                    // remove my remaining elements
N
Niels 已提交
12788
                    const auto end_index = static_cast<difference_type>(result.size());
N
Niels 已提交
12789 12790
                    while (i < source.size())
                    {
N
Niels 已提交
12791 12792
                        // add operations in reverse order to avoid invalid
                        // indices
N
Niels 已提交
12793
                        result.insert(result.begin() + end_index, object(
N
Niels 已提交
12794 12795 12796 12797 12798 12799 12800 12801 12802 12803 12804 12805 12806 12807 12808 12809 12810 12811 12812 12813 12814 12815 12816
                        {
                            {"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:
12817
                {
N
Niels 已提交
12818 12819 12820 12821 12822 12823 12824 12825 12826 12827 12828 12829 12830 12831 12832 12833 12834 12835 12836 12837 12838 12839 12840 12841 12842 12843 12844 12845 12846 12847 12848 12849 12850 12851 12852 12853 12854 12855 12856 12857 12858 12859 12860 12861 12862 12863 12864 12865 12866 12867 12868 12869
                    // 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;
12870 12871 12872 12873 12874 12875
                }
            }
        }

        return result;
    }
N
Niels 已提交
12876 12877

    /// @}
N
Niels 已提交
12878 12879 12880 12881 12882 12883
};

/////////////
// presets //
/////////////

N
Niels 已提交
12884 12885 12886
/*!
@brief default JSON class

N
Niels 已提交
12887 12888
This type is the default specialization of the @ref basic_json class which
uses the standard template types.
N
Niels 已提交
12889

N
Niels 已提交
12890
@since version 1.0.0
N
Niels 已提交
12891
*/
N
Niels 已提交
12892
using json = basic_json<>;
N
Niels Lohmann 已提交
12893
} // namespace nlohmann
N
Niels 已提交
12894 12895


N
Niels 已提交
12896 12897 12898
///////////////////////
// nonmember support //
///////////////////////
N
Niels 已提交
12899 12900 12901

// specialization of std::swap, and std::hash
namespace std
T
Théo DELRIEU 已提交
12902 12903 12904 12905 12906 12907 12908 12909 12910 12911 12912 12913 12914 12915 12916 12917 12918 12919 12920
{
/*!
@brief exchanges the values of two JSON objects

@since version 1.0.0
*/
template<>
inline void swap(nlohmann::json& j1,
                 nlohmann::json& j2) noexcept(
                     is_nothrow_move_constructible<nlohmann::json>::value and
                     is_nothrow_move_assignable<nlohmann::json>::value
                 )
{
    j1.swap(j2);
}

/// hash value for JSON objects
template<>
struct hash<nlohmann::json>
N
Niels 已提交
12921
{
N
Niels 已提交
12922
    /*!
T
Théo DELRIEU 已提交
12923
    @brief return a hash value for a JSON object
N
Niels 已提交
12924

N
Niels 已提交
12925
    @since version 1.0.0
N
Niels 已提交
12926
    */
T
Théo DELRIEU 已提交
12927
    std::size_t operator()(const nlohmann::json& j) const
N
Niels 已提交
12928 12929
    {
        // a naive hashing via the string representation
N
Niels 已提交
12930 12931
        const auto& h = hash<nlohmann::json::string_t>();
        return h(j.dump());
N
Niels 已提交
12932
    }
T
Théo DELRIEU 已提交
12933
};
N
Niels Lohmann 已提交
12934
} // namespace std
N
Niels 已提交
12935 12936

/*!
N
Niels 已提交
12937 12938
@brief user-defined string literal for JSON values

N
Niels 已提交
12939
This operator implements a user-defined string literal for JSON objects. It
N
Niels 已提交
12940
can be used by adding `"_json"` to a string literal and returns a JSON object
N
Niels 已提交
12941
if no parse error occurred.
N
Niels 已提交
12942

N
Niels 已提交
12943
@param[in] s  a string representation of a JSON object
12944
@param[in] n  the length of string @a s
N
Niels 已提交
12945
@return a JSON object
N
Niels 已提交
12946

N
Niels 已提交
12947
@since version 1.0.0
N
Niels 已提交
12948
*/
12949
inline nlohmann::json operator "" _json(const char* s, std::size_t n)
N
Niels 已提交
12950
{
12951
    return nlohmann::json::parse(s, s + n);
N
Niels 已提交
12952 12953
}

N
Niels 已提交
12954 12955 12956
/*!
@brief user-defined string literal for JSON pointer

N
Niels 已提交
12957
This operator implements a user-defined string literal for JSON Pointers. It
N
Niels 已提交
12958
can be used by adding `"_json_pointer"` to a string literal and returns a JSON pointer
N
Niels 已提交
12959 12960 12961
object if no parse error occurred.

@param[in] s  a string representation of a JSON Pointer
12962
@param[in] n  the length of string @a s
N
Niels 已提交
12963 12964
@return a JSON pointer object

N
Niels 已提交
12965 12966
@since version 2.0.0
*/
12967
inline nlohmann::json::json_pointer operator "" _json_pointer(const char* s, std::size_t n)
N
Niels 已提交
12968
{
12969
    return nlohmann::json::json_pointer(std::string(s, n));
N
Niels 已提交
12970 12971
}

12972 12973 12974 12975 12976
// restore GCC/clang diagnostic settings
#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
    #pragma GCC diagnostic pop
#endif

12977 12978 12979
// clean up
#undef JSON_CATCH
#undef JSON_DEPRECATED
N
Niels Lohmann 已提交
12980 12981
#undef JSON_THROW
#undef JSON_TRY
12982

N
Niels 已提交
12983
#endif