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

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

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

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

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

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

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

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

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

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

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

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

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

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

@since version 2.1.0
*/
111 112
namespace detail
{
113 114 115 116 117 118 119
///////////////////////////
// JSON type enumeration //
///////////////////////////

/*!
@brief the JSON type enumeration

120 121 122 123 124 125 126
This enumeration collects the different JSON types. It is internally used to
distinguish the stored values, and the functions @ref basic_json::is_null(),
@ref basic_json::is_object(), @ref basic_json::is_array(),
@ref basic_json::is_string(), @ref basic_json::is_boolean(),
@ref basic_json::is_number() (with @ref basic_json::is_number_integer(),
@ref basic_json::is_number_unsigned(), and @ref basic_json::is_number_float()),
@ref basic_json::is_discarded(), @ref basic_json::is_primitive(), and
T
Théo DELRIEU 已提交
127
@ref basic_json::is_structured() rely on it.
128

129 130 131 132 133 134
@note There are three enumeration entries (number_integer, number_unsigned, and
number_float), because the library distinguishes these three types for numbers:
@ref basic_json::number_unsigned_t is used for unsigned integers,
@ref basic_json::number_integer_t is used for signed integers, and
@ref basic_json::number_float_t is used for floating-point numbers or to
approximate integers which do not fit in the limits of their respective type.
135

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

@since version 1.0.0
*/
enum class value_t : uint8_t
{
T
Théo DELRIEU 已提交
143 144 145 146 147 148 149 150 151
    null,            ///< null value
    object,          ///< object (unordered set of name/value pairs)
    array,           ///< array (ordered collection of values)
    string,          ///< string value
    boolean,         ///< boolean value
    number_integer,  ///< number value (signed integer)
    number_unsigned, ///< number value (unsigned integer)
    number_float,    ///< number value (floating-point)
    discarded        ///< discarded by the the parser callback function
152 153
};

154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
/*!
@brief comparison operator for JSON types

Returns an ordering that is similar to Python:
- order: null < boolean < number < object < array < string
- furthermore, each type is not smaller than itself

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

    // discarded values are not comparable
    if (lhs == value_t::discarded or rhs == value_t::discarded)
    {
        return false;
    }

    return order[static_cast<std::size_t>(lhs)] <
           order[static_cast<std::size_t>(rhs)];
}

187 188 189 190 191

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

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

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

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

205
/*
N
Niels Lohmann 已提交
206
Implementation of two C++17 constructs: conjunction, negation. This is needed
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
to avoid evaluating all the traits in a condition

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

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

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

225
// dispatch utility (taken from ranges-v3)
226 227
template<unsigned N> struct priority_tag : priority_tag < N - 1 > {};
template<> struct priority_tag<0> {};
228

229 230 231 232

//////////////////
// constructors //
//////////////////
233

234
template<value_t> struct external_constructor;
235

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

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

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

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

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

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

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

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

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

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

T
Théo DELRIEU 已提交
362
        j.m_type = value_t::object;
363
        j.m_value.object = j.template create<typename BasicJsonType::object_t>(begin(obj), end(obj));
T
Théo DELRIEU 已提交
364 365
        j.assert_invariant();
    }
366 367
};

368 369 370 371 372

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

373 374
/*!
@brief Helper to determine whether there's a key_type for T.
N
Niels Lohmann 已提交
375 376

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

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

N
Niels Lohmann 已提交
394 395 396 397
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 已提交
398 399

#undef NLOHMANN_JSON_HAS_HELPER
400

N
Niels Lohmann 已提交
401

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

405
template<class RealType, class CompatibleObjectType>
T
Théo DELRIEU 已提交
406 407
struct is_compatible_object_type_impl<true, RealType, CompatibleObjectType>
{
408 409 410 411 412
    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 已提交
413 414
};

415
template<class BasicJsonType, class CompatibleObjectType>
T
Théo DELRIEU 已提交
416 417
struct is_compatible_object_type
{
T
Théo DELRIEU 已提交
418 419 420 421
    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,
422
                                  typename BasicJsonType::object_t, CompatibleObjectType >::value;
T
Théo DELRIEU 已提交
423 424
};

425
template<typename BasicJsonType, typename T>
426
struct is_basic_json_nested_type
T
Théo DELRIEU 已提交
427
{
428 429 430 431 432
    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 已提交
433 434
};

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

449
template<bool, typename, typename>
450
struct is_compatible_integer_type_impl : std::false_type {};
451

452
template<typename RealIntegerType, typename CompatibleNumberIntegerType>
453
struct is_compatible_integer_type_impl<true, RealIntegerType, CompatibleNumberIntegerType>
T
Théo DELRIEU 已提交
454
{
T
Théo DELRIEU 已提交
455
    // is there an assert somewhere on overflows?
456 457 458 459 460 461 462 463
    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 已提交
464 465
};

466
template<typename RealIntegerType, typename CompatibleNumberIntegerType>
467 468
struct is_compatible_integer_type
{
469 470 471 472 473
    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;
474 475
};

476

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

488 489
  public:
    static constexpr bool value = std::is_integral<decltype(
490
                                      detect(std::declval<typename BasicJsonType::template json_serializer<T, void>>()))>::value;
491 492 493 494
};

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

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

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

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

526

527 528 529
/////////////
// to_json //
/////////////
530

N
Niels Lohmann 已提交
531
template<typename BasicJsonType, typename T, enable_if_t<
532
             std::is_same<T, typename BasicJsonType::boolean_t>::value, int> = 0>
N
Niels Lohmann 已提交
533
void to_json(BasicJsonType& j, T b) noexcept
534
{
T
Théo DELRIEU 已提交
535
    external_constructor<value_t::boolean>::construct(j, b);
536 537
}

538 539
template<typename BasicJsonType, typename CompatibleString,
         enable_if_t<std::is_constructible<typename BasicJsonType::string_t,
N
Niels Lohmann 已提交
540
                     CompatibleString>::value, int> = 0>
541
void to_json(BasicJsonType& j, const CompatibleString& s)
542
{
T
Théo DELRIEU 已提交
543
    external_constructor<value_t::string>::construct(j, s);
544 545
}

546 547
template<typename BasicJsonType, typename FloatType,
         enable_if_t<std::is_floating_point<FloatType>::value, int> = 0>
548
void to_json(BasicJsonType& j, FloatType val) noexcept
549
{
550
    external_constructor<value_t::number_float>::construct(j, static_cast<typename BasicJsonType::number_float_t>(val));
551 552
}

553
template <
554 555
    typename BasicJsonType, typename CompatibleNumberUnsignedType,
    enable_if_t<is_compatible_integer_type<typename BasicJsonType::number_unsigned_t,
N
Niels Lohmann 已提交
556
                CompatibleNumberUnsignedType>::value, int> = 0 >
557
void to_json(BasicJsonType& j, CompatibleNumberUnsignedType val) noexcept
558
{
559
    external_constructor<value_t::number_unsigned>::construct(j, static_cast<typename BasicJsonType::number_unsigned_t>(val));
560 561
}

562
template <
563 564
    typename BasicJsonType, typename CompatibleNumberIntegerType,
    enable_if_t<is_compatible_integer_type<typename BasicJsonType::number_integer_t,
N
Niels Lohmann 已提交
565
                CompatibleNumberIntegerType>::value, int> = 0 >
566
void to_json(BasicJsonType& j, CompatibleNumberIntegerType val) noexcept
567
{
568
    external_constructor<value_t::number_integer>::construct(j, static_cast<typename BasicJsonType::number_integer_t>(val));
569 570
}

571 572
template<typename BasicJsonType, typename UnscopedEnumType,
         enable_if_t<is_unscoped_enum<UnscopedEnumType>::value, int> = 0>
573
void to_json(BasicJsonType& j, UnscopedEnumType e) noexcept
574
{
T
Théo DELRIEU 已提交
575
    external_constructor<value_t::number_integer>::construct(j, e);
576 577
}

578
template<typename BasicJsonType>
579
void to_json(BasicJsonType& j, const std::vector<bool>& e)
580 581
{
    external_constructor<value_t::array>::construct(j, e);
582 583
}

584
template <
585
    typename BasicJsonType, typename CompatibleArrayType,
T
Théo DELRIEU 已提交
586
    enable_if_t <
587 588
        is_compatible_array_type<BasicJsonType, CompatibleArrayType>::value or
        std::is_same<typename BasicJsonType::array_t, CompatibleArrayType>::value,
T
Théo DELRIEU 已提交
589
        int > = 0 >
590
void to_json(BasicJsonType& j, const  CompatibleArrayType& arr)
591
{
T
Théo DELRIEU 已提交
592
    external_constructor<value_t::array>::construct(j, arr);
593 594
}

595
template <
596 597
    typename BasicJsonType, typename CompatibleObjectType,
    enable_if_t<is_compatible_object_type<BasicJsonType, CompatibleObjectType>::value,
T
Théo DELRIEU 已提交
598
                int> = 0 >
599
void to_json(BasicJsonType& j, const  CompatibleObjectType& arr)
600
{
T
Théo DELRIEU 已提交
601
    external_constructor<value_t::object>::construct(j, arr);
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 634 635 636 637 638 639 640 641 642 643 644 645

///////////////
// 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>
646
void from_json(const BasicJsonType& j, typename BasicJsonType::boolean_t& b)
647
{
N
Niels Lohmann 已提交
648
    if (not j.is_boolean())
T
Théo DELRIEU 已提交
649
    {
T
Théo DELRIEU 已提交
650
        JSON_THROW(std::domain_error("type must be boolean, but is " + j.type_name()));
T
Théo DELRIEU 已提交
651
    }
652
    b = *j.template get_ptr<const typename BasicJsonType::boolean_t*>();
653 654
}

655
template<typename BasicJsonType>
656
void from_json(const BasicJsonType& j, typename BasicJsonType::string_t& s)
657
{
N
Niels Lohmann 已提交
658
    if (not j.is_string())
T
Théo DELRIEU 已提交
659
    {
T
Théo DELRIEU 已提交
660
        JSON_THROW(std::domain_error("type must be string, but is " + j.type_name()));
T
Théo DELRIEU 已提交
661
    }
662
    s = *j.template get_ptr<const typename BasicJsonType::string_t*>();
663 664
}

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

671
template<typename BasicJsonType>
672
void from_json(const BasicJsonType& j, typename BasicJsonType::number_unsigned_t& val)
673
{
T
Théo DELRIEU 已提交
674
    get_arithmetic_value(j, val);
675 676
}

677
template<typename BasicJsonType>
678
void from_json(const BasicJsonType& j, typename BasicJsonType::number_integer_t& val)
679
{
T
Théo DELRIEU 已提交
680
    get_arithmetic_value(j, val);
681 682
}

683 684 685
template<typename BasicJsonType, typename UnscopedEnumType,
         enable_if_t<is_unscoped_enum<UnscopedEnumType>::value, int> = 0>
void from_json(const BasicJsonType& j, UnscopedEnumType& e)
686
{
687
    typename std::underlying_type<UnscopedEnumType>::type val;
T
Théo DELRIEU 已提交
688 689
    get_arithmetic_value(j, val);
    e = static_cast<UnscopedEnumType>(val);
690 691
}

692 693
template<typename BasicJsonType>
void from_json(const BasicJsonType& j, typename BasicJsonType::array_t& arr)
694
{
N
Niels Lohmann 已提交
695
    if (not j.is_array())
T
Théo DELRIEU 已提交
696
    {
T
Théo DELRIEU 已提交
697
        JSON_THROW(std::domain_error("type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
698
    }
699
    arr = *j.template get_ptr<const typename BasicJsonType::array_t*>();
700 701
}

702 703
// forward_list doesn't have an insert method
template<typename BasicJsonType, typename T, typename Allocator>
704
void from_json(const BasicJsonType& j, std::forward_list<T, Allocator>& l)
705
{
T
Théo DELRIEU 已提交
706 707 708 709
    // do not perform the check when user wants to retrieve jsons
    // (except when it's null.. ?)
    if (j.is_null())
    {
T
Théo DELRIEU 已提交
710
        JSON_THROW(std::domain_error("type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
711
    }
712
    if (not std::is_same<T, BasicJsonType>::value)
T
Théo DELRIEU 已提交
713
    {
N
Niels Lohmann 已提交
714
        if (not j.is_array())
T
Théo DELRIEU 已提交
715
        {
T
Théo DELRIEU 已提交
716
            JSON_THROW(std::domain_error("type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
717 718 719 720 721 722
        }
    }
    for (auto it = j.rbegin(), end = j.rend(); it != end; ++it)
    {
        l.push_front(it->template get<T>());
    }
723 724
}

725 726
template<typename BasicJsonType, typename CompatibleArrayType>
void from_json_array_impl(const BasicJsonType& j, CompatibleArrayType& arr, priority_tag<0>)
727
{
T
Théo DELRIEU 已提交
728 729
    using std::begin;
    using std::end;
730

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

740 741
template<typename BasicJsonType, typename CompatibleArrayType>
auto from_json_array_impl(const BasicJsonType& j, CompatibleArrayType& arr, priority_tag<1>)
T
Théo DELRIEU 已提交
742 743 744
-> decltype(
    arr.reserve(std::declval<typename CompatibleArrayType::size_type>()),
    void())
745
{
T
Théo DELRIEU 已提交
746 747
    using std::begin;
    using std::end;
748

T
Théo DELRIEU 已提交
749 750
    arr.reserve(j.size());
    std::transform(
751
        j.begin(), j.end(), std::inserter(arr, end(arr)), [](const BasicJsonType & i)
T
Théo DELRIEU 已提交
752
    {
753 754
        // get<BasicJsonType>() returns *this, this won't call a from_json
        // method when value_type is BasicJsonType
755
        return i.template get<typename CompatibleArrayType::value_type>();
T
Théo DELRIEU 已提交
756
    });
757 758
}

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

769 770
    // 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 已提交
771
    {
N
Niels Lohmann 已提交
772
        if (not j.is_array())
T
Théo DELRIEU 已提交
773
        {
T
Théo DELRIEU 已提交
774
            JSON_THROW(std::domain_error("type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
775 776 777
        }
    }
    from_json_array_impl(j, arr, priority_tag<1> {});
778 779
}

780 781 782
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)
783
{
N
Niels Lohmann 已提交
784
    if (not j.is_object())
T
Théo DELRIEU 已提交
785
    {
T
Théo DELRIEU 已提交
786
        JSON_THROW(std::domain_error("type must be object, but is " + j.type_name()));
T
Théo DELRIEU 已提交
787 788
    }

789
    auto inner_object = j.template get_ptr<const typename BasicJsonType::object_t*>();
T
Théo DELRIEU 已提交
790 791 792
    using std::begin;
    using std::end;
    // we could avoid the assignment, but this might require a for loop, which
N
Niels Lohmann 已提交
793 794
    // might be less efficient than the container constructor for some
    // containers (would it?)
T
Théo DELRIEU 已提交
795
    obj = CompatibleObjectType(begin(*inner_object), end(*inner_object));
796 797
}

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

841 842
struct to_json_fn
{
N
Niels Lohmann 已提交
843
  private:
844 845 846
    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())
847
    {
848
        return to_json(j, std::forward<T>(val));
849
    }
T
Théo DELRIEU 已提交
850

851
    template<typename BasicJsonType, typename T>
852
    void call(BasicJsonType&, T&&, priority_tag<0>) const noexcept
T
Théo DELRIEU 已提交
853
    {
854 855
        static_assert(sizeof(BasicJsonType) == 0,
                      "could not find to_json() method in T's namespace");
T
Théo DELRIEU 已提交
856 857
    }

T
Théo DELRIEU 已提交
858
  public:
859
    template<typename BasicJsonType, typename T>
860
    void operator()(BasicJsonType& j, T&& val) const
T
Théo DELRIEU 已提交
861 862 863 864
    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> {});
    }
865 866 867 868
};

struct from_json_fn
{
T
Théo DELRIEU 已提交
869
  private:
870 871
    template<typename BasicJsonType, typename T>
    auto call(const BasicJsonType& j, T& val, priority_tag<1>) const
T
Théo DELRIEU 已提交
872 873 874 875 876 877
    noexcept(noexcept(from_json(j, val)))
    -> decltype(from_json(j, val), void())
    {
        return from_json(j, val);
    }

878
    template<typename BasicJsonType, typename T>
879
    void call(const BasicJsonType&, T&, priority_tag<0>) const noexcept
T
Théo DELRIEU 已提交
880
    {
881 882
        static_assert(sizeof(BasicJsonType) == 0,
                      "could not find from_json() method in T's namespace");
T
Théo DELRIEU 已提交
883 884 885
    }

  public:
886 887
    template<typename BasicJsonType, typename T>
    void operator()(const BasicJsonType& j, T& val) const
T
Théo DELRIEU 已提交
888 889 890 891
    noexcept(noexcept(std::declval<from_json_fn>().call(j, val, priority_tag<1> {})))
    {
        return call(j, val, priority_tag<1> {});
    }
892
};
893

894
// taken from ranges-v3
895
template<typename T>
896 897 898 899 900
struct static_const
{
    static constexpr T value{};
};

901
template<typename T>
902
constexpr T static_const<T>::value;
903 904
} // namespace detail

N
Niels 已提交
905

N
Niels Lohmann 已提交
906
/// namespace to hold default `to_json` / `from_json` functions
907
namespace
908
{
T
Théo DELRIEU 已提交
909 910
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;
911 912
}

N
Niels Lohmann 已提交
913 914 915 916 917 918 919 920

/*!
@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.
*/
921
template<typename = void, typename = void>
922 923
struct adl_serializer
{
N
Niels Lohmann 已提交
924 925 926 927 928 929 930
    /*!
    @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
931
    @param[in,out] val  value to write to
N
Niels Lohmann 已提交
932 933 934 935
    */
    template<typename BasicJsonType, typename ValueType>
    static void from_json(BasicJsonType&& j, ValueType& val) noexcept(
        noexcept(::nlohmann::from_json(std::forward<BasicJsonType>(j), val)))
936
    {
937
        ::nlohmann::from_json(std::forward<BasicJsonType>(j), val);
938 939
    }

N
Niels Lohmann 已提交
940 941 942 943 944 945
    /*!
    @brief convert any value type to a JSON value

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

946
    @param[in,out] j  JSON value to write to
N
Niels Lohmann 已提交
947 948 949 950 951
    @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))))
952
    {
N
Niels Lohmann 已提交
953
        ::nlohmann::to_json(j, std::forward<ValueType>(val));
954
    }
955 956
};

957

N
Niels 已提交
958
/*!
N
Niels 已提交
959
@brief a class to store JSON values
N
Niels 已提交
960

N
Niels 已提交
961
@tparam ObjectType type for JSON objects (`std::map` by default; will be used
N
Niels 已提交
962
in @ref object_t)
N
Niels 已提交
963
@tparam ArrayType type for JSON arrays (`std::vector` by default; will be used
N
Niels 已提交
964
in @ref array_t)
N
Niels 已提交
965
@tparam StringType type for JSON strings and object keys (`std::string` by
N
Niels 已提交
966
default; will be used in @ref string_t)
N
Niels 已提交
967
@tparam BooleanType type for JSON booleans (`bool` by default; will be used
N
Niels 已提交
968
in @ref boolean_t)
N
Niels 已提交
969
@tparam NumberIntegerType type for JSON integer numbers (`int64_t` by
N
Niels 已提交
970
default; will be used in @ref number_integer_t)
N
Niels 已提交
971 972
@tparam NumberUnsignedType type for JSON unsigned integer numbers (@c
`uint64_t` by default; will be used in @ref number_unsigned_t)
N
Niels 已提交
973
@tparam NumberFloatType type for JSON floating-point numbers (`double` by
N
Niels 已提交
974
default; will be used in @ref number_float_t)
N
Niels 已提交
975
@tparam AllocatorType type of the allocator to use (`std::allocator` by
N
Niels 已提交
976
default)
N
Niels Lohmann 已提交
977
@tparam JSONSerializer the serializer to resolve internal calls to `to_json()`
N
Niels Lohmann 已提交
978
and `from_json()` (@ref adl_serializer by default)
N
Niels 已提交
979

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

1021 1022 1023 1024 1025 1026 1027
@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 已提交
1028
@internal
N
Niels 已提交
1029
@note ObjectType trick from http://stackoverflow.com/a/9860911
N
Niels 已提交
1030
@endinternal
N
Niels 已提交
1031

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

N
Niels 已提交
1035
@since version 1.0.0
N
Niels 已提交
1036 1037

@nosubgrouping
N
Niels 已提交
1038 1039 1040 1041 1042 1043
*/
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,
1044 1045
    class NumberIntegerType = std::int64_t,
    class NumberUnsignedType = std::uint64_t,
N
Niels 已提交
1046
    class NumberFloatType = double,
1047
    template<typename U> class AllocatorType = std::allocator,
1048
    template<typename T, typename SFINAE = void> class JSONSerializer = adl_serializer
N
Niels 已提交
1049 1050 1051
    >
class basic_json
{
1052
  private:
1053
    template<detail::value_t> friend struct detail::external_constructor;
1054
    /// workaround type for MSVC
N
Niels 已提交
1055 1056
    using basic_json_t = basic_json<ObjectType, ArrayType, StringType,
          BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType,
1057
          AllocatorType, JSONSerializer>;
1058 1059

  public:
1060
    using value_t = detail::value_t;
N
Niels 已提交
1061
    // forward declarations
N
Niels Lohmann 已提交
1062
    template<typename U> class iter_impl;
N
Niels 已提交
1063 1064
    template<typename Base> class json_reverse_iterator;
    class json_pointer;
1065
    template<typename T, typename SFINAE>
1066
    using json_serializer = JSONSerializer<T, SFINAE>;
1067

N
Niels 已提交
1068 1069 1070 1071
    /////////////////////
    // container types //
    /////////////////////

N
Niels 已提交
1072
    /// @name container types
N
Niels 已提交
1073 1074
    /// The canonic container types to use @ref basic_json like any other STL
    /// container.
N
Niels 已提交
1075 1076
    /// @{

N
Niels 已提交
1077
    /// the type of elements in a basic_json container
N
Niels 已提交
1078
    using value_type = basic_json;
N
Niels 已提交
1079

N
Niels 已提交
1080
    /// the type of an element reference
N
Niels 已提交
1081
    using reference = value_type&;
N
Niels 已提交
1082
    /// the type of an element const reference
N
Niels 已提交
1083
    using const_reference = const value_type&;
N
Niels 已提交
1084

N
Niels 已提交
1085
    /// a type to represent differences between iterators
N
Niels 已提交
1086
    using difference_type = std::ptrdiff_t;
N
Niels 已提交
1087
    /// a type to represent container sizes
N
Niels 已提交
1088 1089 1090
    using size_type = std::size_t;

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

N
Niels 已提交
1093
    /// the type of an element pointer
N
Niels 已提交
1094
    using pointer = typename std::allocator_traits<allocator_type>::pointer;
N
Niels 已提交
1095
    /// the type of an element const pointer
N
Niels 已提交
1096
    using const_pointer = typename std::allocator_traits<allocator_type>::const_pointer;
N
Niels 已提交
1097

N
Niels 已提交
1098
    /// an iterator for a basic_json container
1099
    using iterator = iter_impl<basic_json>;
N
Niels 已提交
1100
    /// a const iterator for a basic_json container
1101
    using const_iterator = iter_impl<const basic_json>;
N
Niels 已提交
1102
    /// a reverse iterator for a basic_json container
N
Niels 已提交
1103
    using reverse_iterator = json_reverse_iterator<typename basic_json::iterator>;
N
Niels 已提交
1104
    /// a const reverse iterator for a basic_json container
N
Niels 已提交
1105
    using const_reverse_iterator = json_reverse_iterator<typename basic_json::const_iterator>;
N
Niels 已提交
1106

N
Niels 已提交
1107 1108 1109
    /// @}


N
Niels 已提交
1110 1111 1112
    /*!
    @brief returns the allocator associated with the container
    */
N
Niels 已提交
1113
    static allocator_type get_allocator()
N
Niels 已提交
1114 1115 1116 1117
    {
        return allocator_type();
    }

1118 1119
    /*!
    @brief returns version information on the library
1120

N
Niels Lohmann 已提交
1121
    This function returns a JSON object with information about the library,
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139
    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
1140
    */
1141
    static basic_json meta()
1142 1143 1144
    {
        basic_json result;

1145
        result["copyright"] = "(C) 2013-2017 Niels Lohmann";
1146 1147 1148 1149
        result["name"] = "JSON for Modern C++";
        result["url"] = "https://github.com/nlohmann/json";
        result["version"] =
        {
N
Niels Lohmann 已提交
1150
            {"string", "2.1.1"}, {"major", 2}, {"minor", 1}, {"patch", 1}
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
        };

#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__)
1166
        result["compiler"] = {{"family", "clang"}, {"version", __clang_version__}};
1167 1168 1169
#elif defined(__ICC) || defined(__INTEL_COMPILER)
        result["compiler"] = {{"family", "icc"}, {"version", __INTEL_COMPILER}};
#elif defined(__GNUC__) || defined(__GNUG__)
1170
        result["compiler"] = {{"family", "gcc"}, {"version", std::to_string(__GNUC__) + "." + std::to_string(__GNUC_MINOR__) + "." + std::to_string(__GNUC_PATCHLEVEL__)}};
1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192
#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 已提交
1193

N
Niels 已提交
1194 1195 1196 1197
    ///////////////////////////
    // JSON value data types //
    ///////////////////////////

N
Niels 已提交
1198
    /// @name JSON value data types
N
Niels 已提交
1199 1200
    /// The data types to store a JSON value. These types are derived from
    /// the template arguments passed to class @ref basic_json.
N
Niels 已提交
1201 1202
    /// @{

N
Niels 已提交
1203 1204 1205 1206 1207 1208 1209 1210
    /*!
    @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 已提交
1211 1212 1213 1214 1215
    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 已提交
1216 1217
    @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 已提交
1218 1219 1220
    inside the container.
    @tparam AllocatorType the allocator to use for objects (e.g.,
    `std::allocator`)
N
Niels 已提交
1221 1222 1223 1224

    #### Default type

    With the default values for @a ObjectType (`std::map`), @a StringType
N
Niels 已提交
1225 1226
    (`std::string`), and @a AllocatorType (`std::allocator`), the default
    value for @a object_t is:
N
Niels 已提交
1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242

    @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 已提交
1243 1244
      that all software implementations receiving that object will agree on
      the name-value mappings.
N
Niels 已提交
1245 1246 1247 1248 1249
    - 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 已提交
1250 1251 1252
      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 已提交
1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264
    - 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 已提交
1265 1266
    runtime environment. A theoretical limit can be queried by calling the
    @ref max_size function of a JSON object.
N
Niels 已提交
1267 1268 1269

    #### Storage

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

1274 1275
    @sa @ref array_t -- type for an array value

N
Niels 已提交
1276
    @since version 1.0.0
N
Niels 已提交
1277

N
Niels 已提交
1278 1279 1280 1281 1282
    @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 已提交
1283 1284
    7159](http://rfc7159.net/rfc7159), because any order implements the
    specified "unordered" nature of JSON objects.
N
Niels 已提交
1285
    */
N
Niels 已提交
1286 1287 1288 1289 1290
    using object_t = ObjectType<StringType,
          basic_json,
          std::less<StringType>,
          AllocatorType<std::pair<const StringType,
          basic_json>>>;
N
Niels 已提交
1291 1292 1293 1294 1295 1296 1297

    /*!
    @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 已提交
1298 1299 1300 1301 1302
    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 已提交
1303
    @tparam AllocatorType allocator to use for arrays (e.g., `std::allocator`)
N
Niels 已提交
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323

    #### 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 已提交
1324 1325
    runtime environment. A theoretical limit can be queried by calling the
    @ref max_size function of a JSON array.
N
Niels 已提交
1326 1327 1328

    #### Storage

1329
    Arrays are stored as pointers in a @ref basic_json type. That is, for any
N
Niels 已提交
1330
    access to array values, a pointer of type `array_t*` must be dereferenced.
1331 1332 1333

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

N
Niels 已提交
1334
    @since version 1.0.0
N
Niels 已提交
1335
    */
N
Niels 已提交
1336
    using array_t = ArrayType<basic_json, AllocatorType<basic_json>>;
N
Niels 已提交
1337 1338 1339 1340 1341 1342 1343

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

N
Niels 已提交
1348 1349
    @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 已提交
1350 1351 1352 1353 1354 1355 1356 1357 1358 1359

    #### Default type

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

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

1360 1361 1362 1363 1364 1365
    #### 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 已提交
1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382
    #### 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

1383 1384
    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 已提交
1385
    dereferenced.
1386

N
Niels 已提交
1387
    @since version 1.0.0
N
Niels 已提交
1388
    */
N
Niels 已提交
1389
    using string_t = StringType;
N
Niels 已提交
1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410

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

1411 1412
    Boolean values are stored directly inside a @ref basic_json type.

N
Niels 已提交
1413
    @since version 1.0.0
N
Niels 已提交
1414
    */
N
Niels 已提交
1415
    using boolean_t = BooleanType;
N
Niels 已提交
1416 1417 1418 1419 1420

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

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433
    > 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 已提交
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451

    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 已提交
1452 1453
      instance, the C++ integer literal `010` will be serialized to `8`.
      During deserialization, leading zeros yield an error.
N
Niels 已提交
1454 1455 1456 1457 1458 1459 1460 1461 1462 1463
    - 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 已提交
1464 1465 1466 1467
    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 已提交
1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478

    [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

1479 1480 1481 1482
    Integer number values are stored directly inside a @ref basic_json type.

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

1483 1484
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
1485
    @since version 1.0.0
N
Niels 已提交
1486
    */
N
Niels 已提交
1487
    using number_integer_t = NumberIntegerType;
N
Niels 已提交
1488

1489 1490 1491 1492
    /*!
    @brief a type for a number (unsigned)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508
    > 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.
1509 1510 1511

    #### Default type

N
Niels 已提交
1512 1513
    With the default values for @a NumberUnsignedType (`uint64_t`), the
    default value for @a number_unsigned_t is:
1514 1515 1516 1517 1518 1519 1520 1521 1522 1523

    @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 已提交
1524 1525
      instance, the C++ integer literal `010` will be serialized to `8`.
      During deserialization, leading zeros yield an error.
1526 1527 1528 1529 1530 1531 1532 1533
    - 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 已提交
1534 1535 1536 1537 1538
    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.
1539 1540 1541 1542 1543 1544 1545

    [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 已提交
1546 1547
    number_integer_t type) of the exactly supported range [0, UINT64_MAX],
    this class's integer type is interoperable.
1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558

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

N
Niels 已提交
1560 1561 1562 1563
    /*!
    @brief a type for a number (floating-point)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576
    > 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 已提交
1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592

    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 已提交
1593 1594
      leading zeros in floating-point literals will be ignored. Internally,
      the value will be stored as decimal number. For instance, the C++
N
Niels 已提交
1595 1596 1597 1598 1599 1600 1601 1602 1603 1604
      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 已提交
1605 1606 1607
    > 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 已提交
1608 1609 1610 1611
    > precision.

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

    #### Storage

1617 1618 1619 1620 1621
    Floating-point number values are stored directly inside a @ref basic_json
    type.

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

1622 1623
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
1624
    @since version 1.0.0
N
Niels 已提交
1625
    */
N
Niels 已提交
1626 1627
    using number_float_t = NumberFloatType;

N
Niels 已提交
1628 1629
    /// @}

N
Niels 已提交
1630
  private:
N
Niels 已提交
1631

N
Cleanup  
Niels 已提交
1632 1633
    /// helper for exception-safe object creation
    template<typename T, typename... Args>
N
cleanup  
Niels 已提交
1634
    static T* create(Args&& ... args)
N
Cleanup  
Niels 已提交
1635 1636 1637 1638 1639 1640 1641 1642
    {
        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 已提交
1643
        assert(object != nullptr);
N
Cleanup  
Niels 已提交
1644 1645 1646
        return object.release();
    }

N
Niels 已提交
1647 1648 1649 1650
    ////////////////////////
    // JSON value storage //
    ////////////////////////

1651 1652 1653
    /*!
    @brief a JSON value

N
Niels 已提交
1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671
    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.
1672

N
Niels 已提交
1673
    @since version 1.0.0
1674
    */
N
Niels 已提交
1675 1676 1677 1678 1679 1680 1681 1682
    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 已提交
1683
        /// boolean
N
Niels 已提交
1684 1685 1686
        boolean_t boolean;
        /// number (integer)
        number_integer_t number_integer;
1687 1688
        /// number (unsigned integer)
        number_unsigned_t number_unsigned;
N
Niels 已提交
1689
        /// number (floating-point)
N
Niels 已提交
1690 1691 1692
        number_float_t number_float;

        /// default constructor (for null values)
N
Niels 已提交
1693
        json_value() = default;
N
Niels 已提交
1694
        /// constructor for booleans
N
Niels 已提交
1695
        json_value(boolean_t v) noexcept : boolean(v) {}
N
Niels 已提交
1696
        /// constructor for numbers (integer)
N
Niels 已提交
1697
        json_value(number_integer_t v) noexcept : number_integer(v) {}
1698 1699
        /// constructor for numbers (unsigned)
        json_value(number_unsigned_t v) noexcept : number_unsigned(v) {}
N
Niels 已提交
1700
        /// constructor for numbers (floating-point)
N
Niels 已提交
1701
        json_value(number_float_t v) noexcept : number_float(v) {}
N
Niels 已提交
1702
        /// constructor for empty values of a given type
N
Niels 已提交
1703
        json_value(value_t t)
N
Niels 已提交
1704 1705 1706
        {
            switch (t)
            {
1707
                case value_t::object:
N
Niels 已提交
1708
                {
N
Cleanup  
Niels 已提交
1709
                    object = create<object_t>();
N
Niels 已提交
1710 1711
                    break;
                }
N
Niels 已提交
1712

1713
                case value_t::array:
N
Niels 已提交
1714
                {
N
Cleanup  
Niels 已提交
1715
                    array = create<array_t>();
N
Niels 已提交
1716 1717
                    break;
                }
N
Niels 已提交
1718

1719
                case value_t::string:
N
Niels 已提交
1720
                {
N
Cleanup  
Niels 已提交
1721
                    string = create<string_t>("");
N
Niels 已提交
1722 1723
                    break;
                }
N
Niels 已提交
1724

1725
                case value_t::boolean:
N
Niels 已提交
1726 1727 1728 1729 1730
                {
                    boolean = boolean_t(false);
                    break;
                }

1731
                case value_t::number_integer:
N
Niels 已提交
1732 1733 1734 1735
                {
                    number_integer = number_integer_t(0);
                    break;
                }
N
Niels 已提交
1736

1737 1738 1739 1740 1741
                case value_t::number_unsigned:
                {
                    number_unsigned = number_unsigned_t(0);
                    break;
                }
N
Niels 已提交
1742

1743
                case value_t::number_float:
N
Niels 已提交
1744 1745 1746 1747
                {
                    number_float = number_float_t(0.0);
                    break;
                }
1748

1749 1750 1751 1752 1753
                case value_t::null:
                {
                    break;
                }

1754 1755
                default:
                {
1756 1757
                    if (t == value_t::null)
                    {
N
Niels Lohmann 已提交
1758
                        JSON_THROW(std::domain_error("961c151d2e87f2686a955a9be24d316f1362bf21 2.1.1")); // LCOV_EXCL_LINE
1759
                    }
1760 1761
                    break;
                }
N
Niels 已提交
1762 1763
            }
        }
N
Niels 已提交
1764 1765

        /// constructor for strings
N
Niels 已提交
1766
        json_value(const string_t& value)
N
Niels 已提交
1767
        {
N
Cleanup  
Niels 已提交
1768
            string = create<string_t>(value);
N
Niels 已提交
1769 1770 1771
        }

        /// constructor for objects
N
Niels 已提交
1772
        json_value(const object_t& value)
N
Niels 已提交
1773
        {
N
Cleanup  
Niels 已提交
1774
            object = create<object_t>(value);
N
Niels 已提交
1775 1776 1777
        }

        /// constructor for arrays
N
Niels 已提交
1778
        json_value(const array_t& value)
N
Niels 已提交
1779
        {
N
Cleanup  
Niels 已提交
1780
            array = create<array_t>(value);
N
Niels 已提交
1781
        }
N
Niels 已提交
1782 1783
    };

1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798
    /*!
    @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 已提交
1799 1800

  public:
N
Niels 已提交
1801 1802 1803 1804
    //////////////////////////
    // JSON parser callback //
    //////////////////////////

N
Niels 已提交
1805 1806 1807 1808 1809
    /*!
    @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.
1810

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

N
Niels 已提交
1813
    @since version 1.0.0
N
Niels 已提交
1814
    */
N
Niels 已提交
1815 1816
    enum class parse_event_t : uint8_t
    {
N
Niels 已提交
1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828
        /// 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 已提交
1829 1830
    };

N
Niels 已提交
1831 1832 1833 1834
    /*!
    @brief per-element parser callback type

    With a parser callback function, the result of parsing a JSON text can be
N
Niels 已提交
1835
    influenced. When passed to @ref parse(std::istream&, const
1836
    parser_callback_t) or @ref parse(const CharT, const parser_callback_t),
N
Niels 已提交
1837 1838 1839 1840 1841
    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 已提交
1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855

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

N
Niels 已提交
1858 1859
    Discarding a value (i.e., returning `false`) has different effects
    depending on the context in which function was called:
N
Niels 已提交
1860 1861 1862

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

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

N
Niels 已提交
1868
    @param[in] event  an event of type parse_event_t indicating the context in
N
Niels 已提交
1869 1870 1871 1872 1873 1874 1875 1876 1877 1878
    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
1879
    @ref parse(const CharT, const parser_callback_t) for examples
1880

N
Niels 已提交
1881
    @since version 1.0.0
N
Niels 已提交
1882
    */
N
Niels 已提交
1883 1884 1885
    using parser_callback_t = std::function<bool(int depth,
                              parse_event_t event,
                              basic_json& parsed)>;
N
Niels 已提交
1886

N
Niels 已提交
1887 1888 1889 1890 1891

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

N
Niels 已提交
1892
    /// @name constructors and destructors
N
Niels 已提交
1893 1894
    /// Constructors of class @ref basic_json, copy/move constructor, copy
    /// assignment, static functions creating objects, and the destructor.
N
Niels 已提交
1895 1896
    /// @{

N
Niels 已提交
1897 1898 1899
    /*!
    @brief create an empty value with a given type

N
Niels 已提交
1900 1901 1902 1903 1904
    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 已提交
1905 1906 1907 1908 1909 1910
    null        | `null`
    boolean     | `false`
    string      | `""`
    number      | `0`
    object      | `{}`
    array       | `[]`
N
Niels 已提交
1911

1912
    @param[in] value_type  the type of the value to create
N
Niels 已提交
1913 1914 1915

    @complexity Constant.

N
Niels 已提交
1916
    @throw std::bad_alloc if allocation for object, array, or string value
N
Niels 已提交
1917
    fails
N
Niels 已提交
1918 1919 1920

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

N
Niels 已提交
1922
    @since version 1.0.0
N
Niels 已提交
1923
    */
1924 1925
    basic_json(const value_t value_type)
        : m_type(value_type), m_value(value_type)
1926 1927 1928
    {
        assert_invariant();
    }
N
Niels 已提交
1929

N
Niels 已提交
1930
    /*!
N
Niels 已提交
1931
    @brief create a null object
N
Niels 已提交
1932

N
Niels 已提交
1933 1934
    Create a `null` JSON value. It either takes a null pointer as parameter
    (explicitly creating `null`) or no parameter (implicitly creating `null`).
N
Niels 已提交
1935 1936
    The passed null pointer itself is not read -- it is only used to choose
    the right constructor.
N
Niels 已提交
1937 1938 1939

    @complexity Constant.

N
Niels 已提交
1940 1941 1942
    @exceptionsafety No-throw guarantee: this constructor never throws
    exceptions.

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

N
Niels 已提交
1946
    @since version 1.0.0
N
Niels 已提交
1947
    */
N
Niels 已提交
1948
    basic_json(std::nullptr_t = nullptr) noexcept
N
Niels 已提交
1949
        : basic_json(value_t::null)
1950 1951 1952
    {
        assert_invariant();
    }
N
Niels 已提交
1953

T
Théo DELRIEU 已提交
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 1984 1985 1986 1987 1988 1989 1990 1991 1992
    @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 已提交
1993 1994 1995

    @param[in] val the value to be forwarded

1996 1997 1998 1999 2000 2001 2002 2003
    @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 已提交
2004 2005 2006

    @since version 2.1.0
    */
2007
    template<typename CompatibleType, typename U = detail::uncvref_t<CompatibleType>,
2008 2009 2010 2011 2012 2013
             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>
2014 2015
    basic_json(CompatibleType && val) noexcept(noexcept(JSONSerializer<U>::to_json(
                std::declval<basic_json_t&>(), std::forward<CompatibleType>(val))))
2016
    {
2017 2018
        JSONSerializer<U>::to_json(*this, std::forward<CompatibleType>(val));
        assert_invariant();
2019
    }
2020

N
Niels 已提交
2021 2022 2023 2024 2025 2026 2027 2028 2029 2030
    /*!
    @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 已提交
2031 2032
       object value is created where the first elements of the pairs are
       treated as keys and the second elements are as values.
N
Niels 已提交
2033 2034 2035
    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 已提交
2036
    JSON values. The rationale is as follows:
N
Niels 已提交
2037 2038

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

N
Niels 已提交
2047 2048
    With the rules described above, the following JSON values cannot be
    expressed by an initializer list:
N
Niels 已提交
2049

N
Niels 已提交
2050 2051 2052 2053 2054
    - 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 已提交
2055 2056 2057 2058 2059

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

N
Niels 已提交
2062 2063 2064
    @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 已提交
2065 2066
    used by the functions @ref array(std::initializer_list<basic_json>) and
    @ref object(std::initializer_list<basic_json>).
N
Niels 已提交
2067

N
Niels 已提交
2068 2069
    @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 已提交
2070 2071 2072
    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 已提交
2073 2074
    @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 已提交
2075 2076
    whose first element is a string; example: `"cannot create object from
    initializer list"`
N
Niels 已提交
2077 2078 2079 2080

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

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

N
Niels 已提交
2083
    @sa @ref array(std::initializer_list<basic_json>) -- create a JSON array
2084
    value from an initializer list
N
Niels 已提交
2085
    @sa @ref object(std::initializer_list<basic_json>) -- create a JSON object
2086 2087
    value from an initializer list

N
Niels 已提交
2088
    @since version 1.0.0
N
Niels 已提交
2089
    */
N
Niels 已提交
2090 2091
    basic_json(std::initializer_list<basic_json> init,
               bool type_deduction = true,
N
Niels 已提交
2092
               value_t manual_type = value_t::array)
N
Niels 已提交
2093
    {
N
Niels 已提交
2094 2095
        // check if each element is an array with two elements whose first
        // element is a string
N
Niels 已提交
2096 2097
        bool is_an_object = std::all_of(init.begin(), init.end(),
                                        [](const basic_json & element)
N
Niels 已提交
2098
        {
N
Niels 已提交
2099 2100
            return element.is_array() and element.size() == 2 and element[0].is_string();
        });
N
Niels 已提交
2101 2102 2103 2104 2105 2106 2107

        // 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)
            {
2108
                is_an_object = false;
N
Niels 已提交
2109 2110 2111
            }

            // if object is wanted but impossible, throw an exception
2112
            if (manual_type == value_t::object and not is_an_object)
N
Niels 已提交
2113
            {
2114
                JSON_THROW(std::domain_error("cannot create object from initializer list"));
N
Niels 已提交
2115 2116 2117
            }
        }

2118
        if (is_an_object)
N
Niels 已提交
2119 2120 2121
        {
            // the initializer list is a list of pairs -> create object
            m_type = value_t::object;
N
Niels 已提交
2122
            m_value = value_t::object;
N
Niels 已提交
2123

N
Niels 已提交
2124
            std::for_each(init.begin(), init.end(), [this](const basic_json & element)
N
Niels 已提交
2125
            {
N
Niels 已提交
2126
                m_value.object->emplace(*(element[0].m_value.string), element[1]);
N
Niels 已提交
2127
            });
N
Niels 已提交
2128 2129 2130 2131 2132
        }
        else
        {
            // the initializer list describes an array -> create array
            m_type = value_t::array;
N
Niels 已提交
2133
            m_value.array = create<array_t>(init);
N
Niels 已提交
2134
        }
2135 2136

        assert_invariant();
N
Niels 已提交
2137 2138
    }

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

N
Niels 已提交
2156
    @param[in] init  initializer list with JSON values to create an array from
N
Niels 已提交
2157 2158 2159 2160 2161 2162
    (optional)

    @return JSON array value

    @complexity Linear in the size of @a init.

N
Niels 已提交
2163
    @liveexample{The following code shows an example for the `array`
N
Niels 已提交
2164 2165
    function.,array}

2166 2167 2168 2169 2170
    @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 已提交
2171
    @since version 1.0.0
N
Niels 已提交
2172
    */
N
Niels 已提交
2173
    static basic_json array(std::initializer_list<basic_json> init =
T
Théo DELRIEU 已提交
2174
                                std::initializer_list<basic_json>())
N
Niels 已提交
2175
    {
N
Niels 已提交
2176
        return basic_json(init, false, value_t::array);
N
Niels 已提交
2177 2178
    }

N
Niels 已提交
2179 2180 2181 2182
    /*!
    @brief explicitly create an object from an initializer list

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

    @note This function is only added for symmetry reasons. In contrast to the
2187 2188 2189
    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 已提交
2190 2191
    constructor @ref basic_json(std::initializer_list<basic_json>, bool,
    value_t).
N
Niels 已提交
2192

N
Niels 已提交
2193
    @param[in] init  initializer list to create an object from (optional)
N
Niels 已提交
2194 2195 2196 2197

    @return JSON object value

    @throw std::domain_error if @a init is not a pair whose first elements are
2198 2199
    strings; thrown by
    @ref basic_json(std::initializer_list<basic_json>, bool, value_t)
N
Niels 已提交
2200 2201 2202

    @complexity Linear in the size of @a init.

N
Niels 已提交
2203
    @liveexample{The following code shows an example for the `object`
N
Niels 已提交
2204 2205
    function.,object}

2206 2207 2208 2209 2210
    @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 已提交
2211
    @since version 1.0.0
N
Niels 已提交
2212
    */
N
Niels 已提交
2213
    static basic_json object(std::initializer_list<basic_json> init =
T
Théo DELRIEU 已提交
2214
                                 std::initializer_list<basic_json>())
N
Niels 已提交
2215
    {
N
Niels 已提交
2216
        return basic_json(init, false, value_t::object);
N
Niels 已提交
2217 2218
    }

N
Niels 已提交
2219 2220 2221
    /*!
    @brief construct an array with count copies of given value

N
Niels 已提交
2222 2223
    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,
2224
    `std::distance(begin(),end()) == cnt` holds.
N
Niels 已提交
2225

2226 2227
    @param[in] cnt  the number of JSON copies of @a val to create
    @param[in] val  the JSON value to copy
N
Niels 已提交
2228

2229
    @complexity Linear in @a cnt.
N
Niels 已提交
2230 2231 2232 2233

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

N
Niels 已提交
2235
    @since version 1.0.0
N
Niels 已提交
2236
    */
2237
    basic_json(size_type cnt, const basic_json& val)
N
Niels 已提交
2238 2239
        : m_type(value_t::array)
    {
2240
        m_value.array = create<array_t>(cnt, val);
2241
        assert_invariant();
N
Niels 已提交
2242
    }
N
Niels 已提交
2243

N
Niels 已提交
2244 2245 2246 2247 2248
    /*!
    @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 已提交
2249
    - In case of primitive types (number, boolean, or string), @a first must
N
Niels 已提交
2250 2251
      be `begin()` and @a last must be `end()`. In this case, the value is
      copied. Otherwise, std::out_of_range is thrown.
N
Niels 已提交
2252 2253
    - In case of structured types (array, object), the constructor behaves as
      similar versions for `std::vector`.
N
Niels 已提交
2254
    - In case of a null type, std::domain_error is thrown.
N
Niels 已提交
2255 2256 2257 2258 2259 2260 2261

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

N
Niels 已提交
2265
    @throw std::domain_error if iterators are not compatible; that is, do not
N
Niels 已提交
2266
    belong to the same JSON value; example: `"iterators are not compatible"`
N
Niels 已提交
2267
    @throw std::out_of_range if iterators are for a primitive type (number,
N
Niels 已提交
2268 2269
    boolean, or string) where an out of range error can be detected easily;
    example: `"iterators out of range"`
N
Niels 已提交
2270
    @throw std::bad_alloc if allocation for object, array, or string fails
N
Niels 已提交
2271 2272
    @throw std::domain_error if called with a null value; example: `"cannot
    use construct with iterators from null"`
N
Niels 已提交
2273 2274 2275 2276 2277

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

N
Niels 已提交
2279
    @since version 1.0.0
N
Niels 已提交
2280
    */
N
Niels 已提交
2281 2282 2283
    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 已提交
2284
    basic_json(InputIT first, InputIT last)
N
Niels 已提交
2285
    {
N
Niels 已提交
2286 2287 2288
        assert(first.m_object != nullptr);
        assert(last.m_object != nullptr);

N
Niels 已提交
2289
        // make sure iterator fits the current value
N
Niels 已提交
2290
        if (first.m_object != last.m_object)
N
Niels 已提交
2291
        {
2292
            JSON_THROW(std::domain_error("iterators are not compatible"));
N
Niels 已提交
2293 2294
        }

N
Niels 已提交
2295 2296 2297
        // copy type from first iterator
        m_type = first.m_object->m_type;

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

2328 2329 2330 2331 2332
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = first.m_object->m_value.number_unsigned;
                break;
            }
N
Niels 已提交
2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347

            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 已提交
2348
                m_value = *first.m_object->m_value.string;
N
Niels 已提交
2349 2350 2351 2352 2353
                break;
            }

            case value_t::object:
            {
N
Niels Lohmann 已提交
2354 2355
                m_value.object = create<object_t>(first.m_it.object_iterator,
                                                  last.m_it.object_iterator);
N
Niels 已提交
2356 2357 2358 2359 2360
                break;
            }

            case value_t::array:
            {
N
Niels Lohmann 已提交
2361 2362
                m_value.array = create<array_t>(first.m_it.array_iterator,
                                                last.m_it.array_iterator);
N
Niels 已提交
2363 2364 2365 2366 2367
                break;
            }

            default:
            {
2368
                JSON_THROW(std::domain_error("cannot use construct with iterators from " + first.m_object->type_name()));
N
Niels 已提交
2369 2370
            }
        }
2371 2372

        assert_invariant();
N
Niels 已提交
2373 2374
    }

N
Niels 已提交
2375

N
Niels 已提交
2376 2377 2378 2379
    ///////////////////////////////////////
    // other constructors and destructor //
    ///////////////////////////////////////

N
Niels 已提交
2380 2381
    /*!
    @brief copy constructor
N
Niels 已提交
2382

N
Niels 已提交
2383 2384
    Creates a copy of a given JSON value.

N
Niels 已提交
2385
    @param[in] other  the JSON value to copy
N
Niels 已提交
2386 2387 2388

    @complexity Linear in the size of @a other.

N
Niels 已提交
2389 2390 2391
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2392 2393 2394
    - The complexity is linear.
    - As postcondition, it holds: `other == basic_json(other)`.

N
Niels 已提交
2395
    @throw std::bad_alloc if allocation for object, array, or string fails.
N
Niels 已提交
2396 2397

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

N
Niels 已提交
2400
    @since version 1.0.0
N
Niels 已提交
2401
    */
N
Niels 已提交
2402
    basic_json(const basic_json& other)
N
Niels 已提交
2403 2404
        : m_type(other.m_type)
    {
2405 2406 2407
        // check of passed value is valid
        other.assert_invariant();

N
Niels 已提交
2408 2409
        switch (m_type)
        {
2410
            case value_t::object:
N
Niels 已提交
2411
            {
N
Niels 已提交
2412
                m_value = *other.m_value.object;
N
Niels 已提交
2413 2414
                break;
            }
N
Niels 已提交
2415

2416
            case value_t::array:
N
Niels 已提交
2417
            {
N
Niels 已提交
2418
                m_value = *other.m_value.array;
N
Niels 已提交
2419 2420
                break;
            }
N
Niels 已提交
2421

2422
            case value_t::string:
N
Niels 已提交
2423
            {
N
Niels 已提交
2424
                m_value = *other.m_value.string;
N
Niels 已提交
2425 2426
                break;
            }
N
Niels 已提交
2427

2428
            case value_t::boolean:
N
Niels 已提交
2429
            {
N
Niels 已提交
2430
                m_value = other.m_value.boolean;
N
Niels 已提交
2431 2432
                break;
            }
N
Niels 已提交
2433

2434
            case value_t::number_integer:
N
Niels 已提交
2435
            {
N
Niels 已提交
2436
                m_value = other.m_value.number_integer;
N
Niels 已提交
2437 2438
                break;
            }
N
Niels 已提交
2439

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

2446
            case value_t::number_float:
N
Niels 已提交
2447
            {
N
Niels 已提交
2448
                m_value = other.m_value.number_float;
N
Niels 已提交
2449 2450
                break;
            }
2451 2452 2453 2454 2455

            default:
            {
                break;
            }
N
Niels 已提交
2456
        }
2457 2458

        assert_invariant();
N
Niels 已提交
2459 2460
    }

N
Niels 已提交
2461 2462 2463 2464 2465 2466 2467
    /*!
    @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 已提交
2468
    @param[in,out] other  value to move to this object
N
Niels 已提交
2469 2470 2471 2472 2473 2474 2475

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

N
Niels 已提交
2477
    @since version 1.0.0
N
Niels 已提交
2478
    */
N
Niels 已提交
2479
    basic_json(basic_json&& other) noexcept
N
Niels 已提交
2480 2481
        : m_type(std::move(other.m_type)),
          m_value(std::move(other.m_value))
N
Niels 已提交
2482
    {
2483 2484 2485
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2486
        // invalidate payload
N
Niels 已提交
2487 2488
        other.m_type = value_t::null;
        other.m_value = {};
2489 2490

        assert_invariant();
N
Niels 已提交
2491 2492
    }

N
Niels 已提交
2493 2494
    /*!
    @brief copy assignment
N
Niels 已提交
2495

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

N
Niels 已提交
2500
    @param[in] other  value to copy from
N
Niels 已提交
2501 2502 2503

    @complexity Linear.

N
Niels 已提交
2504 2505 2506
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2507 2508
    - The complexity is linear.

N
Niels 已提交
2509 2510 2511 2512
    @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 已提交
2513

N
Niels 已提交
2514
    @since version 1.0.0
N
Niels 已提交
2515
    */
N
Niels 已提交
2516
    reference& operator=(basic_json other) noexcept (
N
Niels 已提交
2517 2518 2519 2520
        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 已提交
2521
    )
N
Niels 已提交
2522
    {
2523 2524 2525
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2526
        using std::swap;
N
Cleanup  
Niels 已提交
2527 2528
        swap(m_type, other.m_type);
        swap(m_value, other.m_value);
2529 2530

        assert_invariant();
N
Niels 已提交
2531 2532 2533
        return *this;
    }

2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551
    /*!
    @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 已提交
2552

2553 2554 2555 2556 2557 2558 2559 2560 2561
        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 已提交
2562

2563 2564 2565 2566 2567 2568 2569
            case value_t::array:
            {
                AllocatorType<array_t> alloc;
                alloc.destroy(m_value.array);
                alloc.deallocate(m_value.array, 1);
                break;
            }
2570

2571 2572 2573 2574 2575 2576 2577
            case value_t::string:
            {
                AllocatorType<string_t> alloc;
                alloc.destroy(m_value.string);
                alloc.deallocate(m_value.string, 1);
                break;
            }
2578

2579 2580 2581 2582 2583 2584
            default:
            {
                // all other types need no specific destructor
                break;
            }
        }
N
Niels 已提交
2585 2586
    }

N
Niels 已提交
2587
    /// @}
N
Niels 已提交
2588 2589 2590 2591 2592 2593

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

N
Niels 已提交
2594
    /// @name object inspection
N
Niels 已提交
2595
    /// Functions to inspect the type of a JSON value.
N
Niels 已提交
2596 2597
    /// @{

N
Niels 已提交
2598
    /*!
N
Niels 已提交
2599 2600
    @brief serialization

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

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

N
Niels 已提交
2610 2611 2612 2613 2614
    @return string containing the serialization of the JSON value

    @complexity Linear.

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

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

N
Niels 已提交
2619
    @since version 1.0.0
N
Niels 已提交
2620
    */
N
Niels 已提交
2621
    string_t dump(const int indent = -1) const
N
Niels 已提交
2622
    {
N
Niels 已提交
2623
        std::stringstream ss;
2624
        serializer s(ss);
2625

N
Niels 已提交
2626 2627
        if (indent >= 0)
        {
2628
            s.dump(*this, true, static_cast<unsigned int>(indent));
N
Niels 已提交
2629 2630 2631
        }
        else
        {
2632
            s.dump(*this, false, 0);
N
Niels 已提交
2633
        }
N
Niels 已提交
2634 2635

        return ss.str();
N
Niels 已提交
2636 2637
    }

N
Niels 已提交
2638 2639 2640 2641 2642 2643 2644
    /*!
    @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 已提交
2645 2646 2647

    @complexity Constant.

N
Niels 已提交
2648 2649 2650
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2651
    @liveexample{The following code exemplifies `type()` for all JSON
N
Niels 已提交
2652
    types.,type}
N
Niels 已提交
2653

N
Niels 已提交
2654
    @since version 1.0.0
N
Niels 已提交
2655
    */
N
Niels 已提交
2656
    constexpr value_t type() const noexcept
N
Niels 已提交
2657 2658 2659 2660
    {
        return m_type;
    }

N
Niels 已提交
2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671
    /*!
    @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 已提交
2672 2673 2674
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

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

N
Niels 已提交
2678 2679 2680 2681 2682 2683
    @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 已提交
2684
    @since version 1.0.0
N
Niels 已提交
2685
    */
N
Niels 已提交
2686
    constexpr bool is_primitive() const noexcept
N
Niels 已提交
2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700
    {
        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 已提交
2701 2702 2703
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2704
    @liveexample{The following code exemplifies `is_structured()` for all JSON
N
Niels 已提交
2705
    types.,is_structured}
N
Niels 已提交
2706

N
Niels 已提交
2707 2708 2709 2710
    @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 已提交
2711
    @since version 1.0.0
N
Niels 已提交
2712
    */
N
Niels 已提交
2713
    constexpr bool is_structured() const noexcept
N
Niels 已提交
2714 2715 2716 2717
    {
        return is_array() or is_object();
    }

N
Niels 已提交
2718 2719 2720 2721 2722
    /*!
    @brief return whether value is null

    This function returns true iff the JSON value is null.

N
Niels 已提交
2723
    @return `true` if type is null, `false` otherwise.
N
Niels 已提交
2724 2725 2726

    @complexity Constant.

N
Niels 已提交
2727 2728 2729
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2730
    @liveexample{The following code exemplifies `is_null()` for all JSON
N
Niels 已提交
2731
    types.,is_null}
N
Niels 已提交
2732

N
Niels 已提交
2733
    @since version 1.0.0
N
Niels 已提交
2734
    */
N
Niels 已提交
2735
    constexpr bool is_null() const noexcept
N
Niels 已提交
2736 2737 2738 2739
    {
        return m_type == value_t::null;
    }

N
Niels 已提交
2740 2741 2742 2743 2744
    /*!
    @brief return whether value is a boolean

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

N
Niels 已提交
2745
    @return `true` if type is boolean, `false` otherwise.
N
Niels 已提交
2746 2747 2748

    @complexity Constant.

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

N
Niels 已提交
2752
    @liveexample{The following code exemplifies `is_boolean()` for all JSON
N
Niels 已提交
2753
    types.,is_boolean}
N
Niels 已提交
2754

N
Niels 已提交
2755
    @since version 1.0.0
N
Niels 已提交
2756
    */
N
Niels 已提交
2757
    constexpr bool is_boolean() const noexcept
N
Niels 已提交
2758 2759 2760 2761
    {
        return m_type == value_t::boolean;
    }

N
Niels 已提交
2762 2763 2764 2765 2766 2767
    /*!
    @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.

2768 2769
    @return `true` if type is number (regardless whether integer, unsigned
    integer or floating-type), `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_number()` for all JSON
N
Niels 已提交
2777
    types.,is_number}
N
Niels 已提交
2778

N
Niels 已提交
2779
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
2780
    integer number
N
Niels 已提交
2781 2782
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2783 2784
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
2785
    @since version 1.0.0
N
Niels 已提交
2786
    */
N
Niels 已提交
2787
    constexpr bool is_number() const noexcept
N
Niels 已提交
2788
    {
N
Niels 已提交
2789
        return is_number_integer() or is_number_float();
N
Niels 已提交
2790 2791
    }

N
Niels 已提交
2792 2793 2794
    /*!
    @brief return whether value is an integer number

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

N
Niels 已提交
2798
    @return `true` if type is an integer or unsigned integer number, `false`
2799
    otherwise.
N
Niels 已提交
2800 2801 2802

    @complexity Constant.

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

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

    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
2810 2811
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2812 2813
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
2814
    @since version 1.0.0
N
Niels 已提交
2815
    */
N
Niels 已提交
2816
    constexpr bool is_number_integer() const noexcept
N
Niels 已提交
2817
    {
2818 2819
        return m_type == value_t::number_integer or m_type == value_t::number_unsigned;
    }
N
Niels 已提交
2820

2821 2822 2823
    /*!
    @brief return whether value is an unsigned integer number

N
Niels 已提交
2824 2825
    This function returns true iff the JSON value is an unsigned integer
    number. This excludes floating-point and (signed) integer values.
2826 2827 2828 2829 2830

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

    @complexity Constant.

N
Niels 已提交
2831 2832 2833
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2834
    @liveexample{The following code exemplifies `is_number_unsigned()` for all
N
Niels 已提交
2835 2836
    JSON types.,is_number_unsigned}

2837
    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
2838
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
2839 2840 2841 2842 2843
    integer number
    @sa @ref is_number_float() -- check if value is a floating-point number

    @since version 2.0.0
    */
N
Niels 已提交
2844
    constexpr bool is_number_unsigned() const noexcept
2845 2846
    {
        return m_type == value_t::number_unsigned;
N
Niels 已提交
2847 2848
    }

N
Niels 已提交
2849 2850 2851 2852
    /*!
    @brief return whether value is a floating-point number

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

N
Niels 已提交
2855
    @return `true` if type is a floating-point number, `false` otherwise.
N
Niels 已提交
2856 2857 2858

    @complexity Constant.

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

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

    @sa @ref is_number() -- check if value is number
    @sa @ref is_number_integer() -- check if value is an integer number
N
Niels 已提交
2867 2868
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2869

N
Niels 已提交
2870
    @since version 1.0.0
N
Niels 已提交
2871
    */
N
Niels 已提交
2872
    constexpr bool is_number_float() const noexcept
N
Niels 已提交
2873 2874 2875 2876
    {
        return m_type == value_t::number_float;
    }

N
Niels 已提交
2877 2878 2879 2880 2881
    /*!
    @brief return whether value is an object

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

N
Niels 已提交
2882
    @return `true` if type is object, `false` otherwise.
N
Niels 已提交
2883 2884 2885

    @complexity Constant.

N
Niels 已提交
2886 2887 2888
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

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

N
Niels 已提交
2892
    @since version 1.0.0
N
Niels 已提交
2893
    */
N
Niels 已提交
2894
    constexpr bool is_object() const noexcept
N
Niels 已提交
2895 2896 2897 2898
    {
        return m_type == value_t::object;
    }

N
Niels 已提交
2899 2900 2901 2902 2903
    /*!
    @brief return whether value is an array

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

N
Niels 已提交
2904
    @return `true` if type is array, `false` otherwise.
N
Niels 已提交
2905 2906 2907

    @complexity Constant.

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

N
Niels 已提交
2911
    @liveexample{The following code exemplifies `is_array()` for all JSON
N
Niels 已提交
2912
    types.,is_array}
N
Niels 已提交
2913

N
Niels 已提交
2914
    @since version 1.0.0
N
Niels 已提交
2915
    */
N
Niels 已提交
2916
    constexpr bool is_array() const noexcept
N
Niels 已提交
2917 2918 2919 2920
    {
        return m_type == value_t::array;
    }

N
Niels 已提交
2921 2922 2923 2924 2925
    /*!
    @brief return whether value is a string

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

N
Niels 已提交
2926
    @return `true` if type is string, `false` otherwise.
N
Niels 已提交
2927 2928 2929

    @complexity Constant.

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

N
Niels 已提交
2933
    @liveexample{The following code exemplifies `is_string()` for all JSON
N
Niels 已提交
2934
    types.,is_string}
N
Niels 已提交
2935

N
Niels 已提交
2936
    @since version 1.0.0
N
Niels 已提交
2937
    */
N
Niels 已提交
2938
    constexpr bool is_string() const noexcept
N
Niels 已提交
2939 2940 2941 2942
    {
        return m_type == value_t::string;
    }

N
Niels 已提交
2943 2944 2945 2946 2947 2948
    /*!
    @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 已提交
2949 2950 2951 2952
    @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 已提交
2953 2954 2955 2956
    @return `true` if type is discarded, `false` otherwise.

    @complexity Constant.

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

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

N
Niels 已提交
2963
    @since version 1.0.0
N
Niels 已提交
2964
    */
N
Niels 已提交
2965
    constexpr bool is_discarded() const noexcept
N
Niels 已提交
2966 2967 2968 2969
    {
        return m_type == value_t::discarded;
    }

N
Niels 已提交
2970 2971 2972 2973 2974 2975 2976 2977 2978 2979
    /*!
    @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 已提交
2980 2981 2982
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

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

N
Niels 已提交
2986
    @since version 1.0.0
N
Niels 已提交
2987
    */
N
Niels 已提交
2988
    constexpr operator value_t() const noexcept
N
Niels 已提交
2989 2990 2991 2992
    {
        return m_type;
    }

N
Niels 已提交
2993 2994
    /// @}

N
Niels 已提交
2995
  private:
N
Niels Lohmann 已提交
2996 2997 2998 2999
    //////////////////
    // value access //
    //////////////////

N
Niels 已提交
3000
    /// get a boolean (explicit)
3001
    boolean_t get_impl(boolean_t* /*unused*/) const
N
Niels 已提交
3002
    {
3003 3004 3005 3006
        if (is_boolean())
        {
            return m_value.boolean;
        }
N
Niels Lohmann 已提交
3007 3008

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

N
Niels 已提交
3011
    /// get a pointer to the value (object)
N
Niels Lohmann 已提交
3012
    object_t* get_impl_ptr(object_t* /*unused*/) noexcept
N
Niels 已提交
3013 3014 3015 3016
    {
        return is_object() ? m_value.object : nullptr;
    }

N
Niels 已提交
3017
    /// get a pointer to the value (object)
N
Niels Lohmann 已提交
3018
    constexpr const object_t* get_impl_ptr(const object_t* /*unused*/) const noexcept
N
Niels 已提交
3019 3020 3021 3022 3023
    {
        return is_object() ? m_value.object : nullptr;
    }

    /// get a pointer to the value (array)
N
Niels Lohmann 已提交
3024
    array_t* get_impl_ptr(array_t* /*unused*/) noexcept
N
Niels 已提交
3025 3026 3027 3028
    {
        return is_array() ? m_value.array : nullptr;
    }

N
Niels 已提交
3029
    /// get a pointer to the value (array)
N
Niels Lohmann 已提交
3030
    constexpr const array_t* get_impl_ptr(const array_t* /*unused*/) const noexcept
N
Niels 已提交
3031 3032 3033 3034 3035
    {
        return is_array() ? m_value.array : nullptr;
    }

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

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

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

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

    /// get a pointer to the value (integer number)
N
Niels Lohmann 已提交
3060
    number_integer_t* get_impl_ptr(number_integer_t* /*unused*/) noexcept
N
Niels 已提交
3061 3062 3063 3064 3065
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }

    /// get a pointer to the value (integer number)
N
Niels Lohmann 已提交
3066
    constexpr const number_integer_t* get_impl_ptr(const number_integer_t* /*unused*/) const noexcept
N
Niels 已提交
3067 3068 3069
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }
N
Niels 已提交
3070

3071
    /// get a pointer to the value (unsigned number)
N
Niels Lohmann 已提交
3072
    number_unsigned_t* get_impl_ptr(number_unsigned_t* /*unused*/) noexcept
3073 3074 3075
    {
        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
    }
N
Niels 已提交
3076

3077
    /// get a pointer to the value (unsigned number)
N
Niels Lohmann 已提交
3078
    constexpr const number_unsigned_t* get_impl_ptr(const number_unsigned_t* /*unused*/) const noexcept
3079 3080 3081
    {
        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
    }
N
Niels 已提交
3082

N
Niels 已提交
3083
    /// get a pointer to the value (floating-point number)
N
Niels Lohmann 已提交
3084
    number_float_t* get_impl_ptr(number_float_t* /*unused*/) noexcept
N
Niels 已提交
3085 3086 3087 3088 3089
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

    /// get a pointer to the value (floating-point number)
N
Niels Lohmann 已提交
3090
    constexpr const number_float_t* get_impl_ptr(const number_float_t* /*unused*/) const noexcept
N
Niels 已提交
3091 3092 3093 3094
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

N
Niels 已提交
3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106
    /*!
    @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>
3107
    static ReferenceType get_ref_impl(ThisType& obj)
D
dariomt 已提交
3108
    {
N
Niels 已提交
3109
        // helper type
N
Niels 已提交
3110 3111
        using PointerType = typename std::add_pointer<ReferenceType>::type;

N
Niels 已提交
3112
        // delegate the call to get_ptr<>()
3113 3114 3115 3116 3117 3118
        auto ptr = obj.template get_ptr<PointerType>();

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

3120 3121
        JSON_THROW(std::domain_error("incompatible ReferenceType for get_ref, actual type is " +
                                     obj.type_name()));
D
dariomt 已提交
3122 3123
    }

N
Niels 已提交
3124
  public:
N
Niels Lohmann 已提交
3125 3126 3127 3128
    /// @name value access
    /// Direct access to the stored value of a JSON value.
    /// @{

T
Théo DELRIEU 已提交
3129 3130 3131
    /*!
    @brief get special-case overload

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

N
Niels Lohmann 已提交
3135
    @tparam BasicJsonType == @ref basic_json
T
Théo DELRIEU 已提交
3136 3137 3138 3139 3140 3141 3142

    @return a copy of *this

    @complexity Constant.

    @since version 2.1.0
    */
3143
    template <
N
Niels Lohmann 已提交
3144 3145
        typename BasicJsonType,
        detail::enable_if_t<std::is_same<typename std::remove_const<BasicJsonType>::type,
3146 3147
                                         basic_json_t>::value,
                            int> = 0 >
3148 3149
    basic_json get() const
    {
T
Théo DELRIEU 已提交
3150
        return *this;
3151 3152
    }

T
Théo DELRIEU 已提交
3153
    /*!
N
Niels Lohmann 已提交
3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167
    @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 已提交
3168 3169

    This overloads is chosen if:
N
Niels Lohmann 已提交
3170 3171 3172 3173 3174 3175 3176 3177
    - @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 已提交
3178

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

N
Niels Lohmann 已提交
3181 3182 3183 3184 3185 3186 3187 3188
    @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 已提交
3189 3190 3191

    @since version 2.1.0
    */
T
Théo DELRIEU 已提交
3192
    template <
N
Niels Lohmann 已提交
3193 3194
        typename ValueTypeCV,
        typename ValueType = detail::uncvref_t<ValueTypeCV>,
3195
        detail::enable_if_t <
N
Niels Lohmann 已提交
3196 3197 3198
            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 已提交
3199
            int > = 0 >
N
Niels Lohmann 已提交
3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212
    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 已提交
3213
        return ret;
3214
    }
3215

T
Théo DELRIEU 已提交
3216
    /*!
N
Niels Lohmann 已提交
3217 3218 3219 3220 3221 3222 3223
    @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 已提交
3224

N
Niels Lohmann 已提交
3225 3226 3227 3228
    The function is equivalent to executing
    @code {.cpp}
    return JSONSerializer<ValueTypeCV>::from_json(*this);
    @endcode
T
Théo DELRIEU 已提交
3229 3230

    This overloads is chosen if:
N
Niels Lohmann 已提交
3231 3232 3233 3234 3235 3236 3237 3238 3239
    - @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 已提交
3240

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

N
Niels Lohmann 已提交
3243
    @throw what @ref json_serializer<ValueType> `from_json()` method throws
T
Théo DELRIEU 已提交
3244 3245 3246

    @since version 2.1.0
    */
3247
    template <
N
Niels Lohmann 已提交
3248 3249 3250
        typename ValueTypeCV,
        typename ValueType = detail::uncvref_t<ValueTypeCV>,
        detail::enable_if_t<not std::is_same<basic_json_t, ValueType>::value and
3251
                            detail::has_non_default_from_json<basic_json_t,
N
Niels Lohmann 已提交
3252 3253 3254
                                    ValueType>::value, int> = 0 >
    ValueType get() const noexcept(noexcept(
                                       JSONSerializer<ValueTypeCV>::from_json(std::declval<const basic_json_t&>())))
3255
    {
N
Niels Lohmann 已提交
3256 3257 3258
        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);
3259 3260
    }

N
Niels 已提交
3261 3262 3263 3264 3265 3266
    /*!
    @brief get a pointer value (explicit)

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

N
Niels 已提交
3267 3268
    @warning The pointer becomes invalid if the underlying JSON object
    changes.
N
Niels 已提交
3269 3270

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

N
Niels 已提交
3274 3275
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
3276 3277 3278 3279 3280 3281 3282 3283 3284

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

N
Niels 已提交
3286
    @since version 1.0.0
N
Niels 已提交
3287
    */
N
Niels 已提交
3288 3289
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3290 3291 3292 3293 3294 3295 3296 3297 3298 3299
    PointerType get() noexcept
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

    /*!
    @brief get a pointer value (explicit)
    @copydoc get()
    */
N
Niels 已提交
3300 3301
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3302
    constexpr const PointerType get() const noexcept
N
Niels 已提交
3303 3304 3305 3306 3307 3308 3309 3310
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

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

N
Niels 已提交
3311
    Implicit pointer access to the internally stored JSON value. No copies are
N
Niels 已提交
3312 3313 3314 3315 3316 3317
    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 已提交
3318
    object_t, @ref string_t, @ref boolean_t, @ref number_integer_t,
N
Niels 已提交
3319 3320
    @ref number_unsigned_t, or @ref number_float_t. Enforced by a static
    assertion.
N
Niels 已提交
3321

N
Niels 已提交
3322 3323
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
3324 3325 3326 3327 3328 3329 3330

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

N
Niels 已提交
3332
    @since version 1.0.0
N
Niels 已提交
3333
    */
N
Niels 已提交
3334 3335
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3336 3337
    PointerType get_ptr() noexcept
    {
N
Niels 已提交
3338 3339
        // get the type of the PointerType (remove pointer and const)
        using pointee_t = typename std::remove_const<typename
T
Théo DELRIEU 已提交
3340 3341
                          std::remove_pointer<typename
                          std::remove_const<PointerType>::type>::type>::type;
N
Niels 已提交
3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352
        // 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 已提交
3353 3354 3355 3356 3357 3358 3359 3360
        // 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 已提交
3361 3362 3363
    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 已提交
3364
    constexpr const PointerType get_ptr() const noexcept
N
Niels 已提交
3365
    {
N
Niels 已提交
3366 3367
        // get the type of the PointerType (remove pointer and const)
        using pointee_t = typename std::remove_const<typename
T
Théo DELRIEU 已提交
3368 3369
                          std::remove_pointer<typename
                          std::remove_const<PointerType>::type>::type>::type;
N
Niels 已提交
3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380
        // 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 已提交
3381
        // delegate the call to get_impl_ptr<>() const
D
dariomt 已提交
3382
        return get_impl_ptr(static_cast<const PointerType>(nullptr));
D
dariomt 已提交
3383 3384
    }

N
Niels 已提交
3385
    /*!
D
dariomt 已提交
3386 3387
    @brief get a reference value (implicit)

N
Niels Lohmann 已提交
3388
    Implicit reference access to the internally stored JSON value. No copies
N
Niels 已提交
3389
    are made.
D
dariomt 已提交
3390 3391 3392 3393

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

N
Niels 已提交
3394 3395
    @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 已提交
3396
    @ref number_float_t. Enforced by static assertion.
D
dariomt 已提交
3397

N
Niels 已提交
3398 3399 3400
    @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 已提交
3401

N
Niels 已提交
3402 3403
    @throw std::domain_error in case passed type @a ReferenceType is
    incompatible with the stored JSON value
D
dariomt 已提交
3404 3405

    @complexity Constant.
N
Niels 已提交
3406 3407 3408

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

N
Niels 已提交
3409
    @since version 1.1.0
D
dariomt 已提交
3410
    */
N
Niels 已提交
3411 3412
    template<typename ReferenceType, typename std::enable_if<
                 std::is_reference<ReferenceType>::value, int>::type = 0>
D
dariomt 已提交
3413 3414
    ReferenceType get_ref()
    {
N
Niels 已提交
3415 3416
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
D
dariomt 已提交
3417 3418 3419 3420 3421 3422
    }

    /*!
    @brief get a reference value (implicit)
    @copydoc get_ref()
    */
N
Niels 已提交
3423 3424 3425
    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>
3426
    ReferenceType get_ref() const
D
dariomt 已提交
3427
    {
N
Niels 已提交
3428 3429
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
N
Niels 已提交
3430 3431 3432 3433 3434
    }

    /*!
    @brief get a value (implicit)

N
Niels 已提交
3435 3436
    Implicit type conversion between the JSON value and a compatible value.
    The call is realized by calling @ref get() const.
N
Niels 已提交
3437 3438 3439

    @tparam ValueType non-pointer type compatible to the JSON value, for
    instance `int` for JSON integer numbers, `bool` for JSON booleans, or
N
Niels 已提交
3440 3441 3442
    `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 已提交
3443 3444 3445 3446 3447 3448 3449 3450

    @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 已提交
3451
    @liveexample{The example below shows several conversions from JSON values
N
Niels 已提交
3452 3453 3454
    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 已提交
3455
    associative containers such as `std::unordered_map<std::string\,
N
Niels 已提交
3456
    json>`.,operator__ValueType}
N
Niels 已提交
3457

N
Niels 已提交
3458
    @since version 1.0.0
N
Niels 已提交
3459
    */
N
Niels 已提交
3460 3461 3462
    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 已提交
3463
#ifndef _MSC_VER  // fix for issue #167 operator<< ambiguity under VS2015
N
Niels 已提交
3464
                   and not std::is_same<ValueType, std::initializer_list<typename string_t::value_type>>::value
3465
#endif
N
Niels 已提交
3466
                   , int >::type = 0 >
N
Niels 已提交
3467
    operator ValueType() const
N
Niels 已提交
3468
    {
N
Niels 已提交
3469 3470
        // delegate the call to get<>() const
        return get<ValueType>();
N
Niels 已提交
3471 3472
    }

N
Niels 已提交
3473 3474
    /// @}

N
Niels 已提交
3475 3476 3477 3478 3479

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

N
Niels 已提交
3480
    /// @name element access
N
Niels 已提交
3481
    /// Access to the JSON value.
N
Niels 已提交
3482 3483
    /// @{

N
Niels 已提交
3484 3485 3486 3487 3488 3489 3490 3491 3492 3493
    /*!
    @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 已提交
3494 3495
    @throw std::domain_error if the JSON value is not an array; example:
    `"cannot use at() with string"`
N
Niels 已提交
3496
    @throw std::out_of_range if the index @a idx is out of range of the array;
N
Niels 已提交
3497
    that is, `idx >= size()`; example: `"array index 7 is out of range"`
N
Niels 已提交
3498 3499 3500 3501

    @complexity Constant.

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

N
Niels 已提交
3504
    @since version 1.0.0
N
Niels 已提交
3505
    */
N
Niels 已提交
3506
    reference at(size_type idx)
N
Niels 已提交
3507 3508
    {
        // at only works for arrays
3509 3510
        if (is_array())
        {
3511
            JSON_TRY
N
Niels 已提交
3512 3513 3514
            {
                return m_value.array->at(idx);
            }
3515
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3516 3517
            {
                // create better exception explanation
3518
                JSON_THROW(std::out_of_range("array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
3519
            }
3520 3521
        }
        else
N
Niels 已提交
3522
        {
3523
            JSON_THROW(std::domain_error("cannot use at() with " + type_name()));
N
Niels 已提交
3524 3525 3526
        }
    }

N
Niels 已提交
3527 3528 3529
    /*!
    @brief access specified array element with bounds checking

N
Niels 已提交
3530 3531
    Returns a const reference to the element at specified location @a idx,
    with bounds checking.
N
Niels 已提交
3532 3533 3534 3535 3536

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

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

N
Niels 已提交
3537 3538
    @throw std::domain_error if the JSON value is not an array; example:
    `"cannot use at() with string"`
N
Niels 已提交
3539
    @throw std::out_of_range if the index @a idx is out of range of the array;
N
Niels 已提交
3540
    that is, `idx >= size()`; example: `"array index 7 is out of range"`
N
Niels 已提交
3541 3542 3543 3544

    @complexity Constant.

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

N
Niels 已提交
3547
    @since version 1.0.0
N
Niels 已提交
3548
    */
N
Niels 已提交
3549
    const_reference at(size_type idx) const
N
Niels 已提交
3550 3551
    {
        // at only works for arrays
3552 3553
        if (is_array())
        {
3554
            JSON_TRY
N
Niels 已提交
3555 3556 3557
            {
                return m_value.array->at(idx);
            }
3558
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3559 3560
            {
                // create better exception explanation
3561
                JSON_THROW(std::out_of_range("array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
3562
            }
3563 3564
        }
        else
N
Niels 已提交
3565
        {
3566
            JSON_THROW(std::domain_error("cannot use at() with " + type_name()));
N
Niels 已提交
3567
        }
3568 3569
    }

N
Niels 已提交
3570 3571 3572 3573 3574 3575 3576 3577 3578 3579
    /*!
    @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 已提交
3580 3581
    @throw std::domain_error if the JSON value is not an object; example:
    `"cannot use at() with boolean"`
N
Niels 已提交
3582
    @throw std::out_of_range if the key @a key is is not stored in the object;
N
Niels 已提交
3583
    that is, `find(key) == end()`; example: `"key "the fast" not found"`
N
Niels 已提交
3584 3585 3586 3587

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3588
    written using `at()`.,at__object_t_key_type}
N
Niels 已提交
3589 3590 3591 3592

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

N
Niels 已提交
3594
    @since version 1.0.0
N
Niels 已提交
3595
    */
N
Niels 已提交
3596
    reference at(const typename object_t::key_type& key)
3597 3598
    {
        // at only works for objects
3599 3600
        if (is_object())
        {
3601
            JSON_TRY
N
Niels 已提交
3602 3603 3604
            {
                return m_value.object->at(key);
            }
3605
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3606 3607
            {
                // create better exception explanation
3608
                JSON_THROW(std::out_of_range("key '" + key + "' not found"));
N
Niels 已提交
3609
            }
3610 3611
        }
        else
3612
        {
3613
            JSON_THROW(std::domain_error("cannot use at() with " + type_name()));
3614 3615 3616
        }
    }

N
Niels 已提交
3617 3618 3619
    /*!
    @brief access specified object element with bounds checking

N
Niels 已提交
3620 3621
    Returns a const reference to the element at with specified key @a key,
    with bounds checking.
N
Niels 已提交
3622 3623 3624 3625 3626

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

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

N
Niels 已提交
3627 3628
    @throw std::domain_error if the JSON value is not an object; example:
    `"cannot use at() with boolean"`
N
Niels 已提交
3629
    @throw std::out_of_range if the key @a key is is not stored in the object;
N
Niels 已提交
3630
    that is, `find(key) == end()`; example: `"key "the fast" not found"`
N
Niels 已提交
3631 3632 3633 3634

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3635
    `at()`.,at__object_t_key_type_const}
N
Niels 已提交
3636 3637 3638 3639

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

N
Niels 已提交
3641
    @since version 1.0.0
N
Niels 已提交
3642
    */
N
Niels 已提交
3643
    const_reference at(const typename object_t::key_type& key) const
3644 3645
    {
        // at only works for objects
3646 3647
        if (is_object())
        {
3648
            JSON_TRY
N
Niels 已提交
3649 3650 3651
            {
                return m_value.object->at(key);
            }
3652
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3653 3654
            {
                // create better exception explanation
3655
                JSON_THROW(std::out_of_range("key '" + key + "' not found"));
N
Niels 已提交
3656
            }
3657 3658
        }
        else
3659
        {
3660
            JSON_THROW(std::domain_error("cannot use at() with " + type_name()));
3661
        }
N
Niels 已提交
3662 3663
    }

N
Niels 已提交
3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676
    /*!
    @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 已提交
3677 3678
    @throw std::domain_error if JSON is not an array or null; example:
    `"cannot use operator[] with string"`
N
Niels 已提交
3679 3680 3681 3682 3683

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

N
Niels 已提交
3687
    @since version 1.0.0
N
Niels 已提交
3688
    */
N
Niels 已提交
3689
    reference operator[](size_type idx)
N
Niels 已提交
3690
    {
N
Niels 已提交
3691
        // implicitly convert null value to an empty array
N
cleanup  
Niels 已提交
3692
        if (is_null())
N
Niels 已提交
3693 3694
        {
            m_type = value_t::array;
N
Cleanup  
Niels 已提交
3695
            m_value.array = create<array_t>();
3696
            assert_invariant();
N
Niels 已提交
3697 3698
        }

N
Niels 已提交
3699
        // operator[] only works for arrays
N
cleanup  
Niels 已提交
3700
        if (is_array())
N
Niels 已提交
3701
        {
N
Niels 已提交
3702 3703
            // fill up array with null values if given idx is outside range
            if (idx >= m_value.array->size())
N
cleanup  
Niels 已提交
3704
            {
N
Niels 已提交
3705 3706 3707
                m_value.array->insert(m_value.array->end(),
                                      idx - m_value.array->size() + 1,
                                      basic_json());
N
cleanup  
Niels 已提交
3708
            }
N
Niels 已提交
3709

N
cleanup  
Niels 已提交
3710 3711
            return m_value.array->operator[](idx);
        }
N
Niels Lohmann 已提交
3712

3713
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
N
Niels 已提交
3714 3715
    }

N
Niels 已提交
3716 3717 3718 3719 3720 3721 3722 3723 3724
    /*!
    @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 已提交
3725 3726
    @throw std::domain_error if JSON is not an array; example: `"cannot use
    operator[] with null"`
N
Niels 已提交
3727 3728 3729 3730

    @complexity Constant.

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

N
Niels 已提交
3733
    @since version 1.0.0
N
Niels 已提交
3734
    */
N
Niels 已提交
3735
    const_reference operator[](size_type idx) const
N
Niels 已提交
3736
    {
N
Niels 已提交
3737
        // const operator[] only works for arrays
N
Niels 已提交
3738 3739 3740 3741
        if (is_array())
        {
            return m_value.array->operator[](idx);
        }
N
Niels Lohmann 已提交
3742

3743
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
N
Niels 已提交
3744 3745
    }

N
Niels 已提交
3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758
    /*!
    @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 已提交
3759
    @throw std::domain_error if JSON is not an object or null; example:
N
Niels 已提交
3760
    `"cannot use operator[] with string"`
N
Niels 已提交
3761 3762 3763 3764

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3765
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
3766 3767 3768 3769

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

N
Niels 已提交
3771
    @since version 1.0.0
N
Niels 已提交
3772
    */
N
Niels 已提交
3773
    reference operator[](const typename object_t::key_type& key)
N
Niels 已提交
3774
    {
N
Niels 已提交
3775
        // implicitly convert null value to an empty object
N
cleanup  
Niels 已提交
3776
        if (is_null())
N
Niels 已提交
3777 3778
        {
            m_type = value_t::object;
N
Cleanup  
Niels 已提交
3779
            m_value.object = create<object_t>();
3780
            assert_invariant();
N
Niels 已提交
3781 3782
        }

N
Niels 已提交
3783
        // operator[] only works for objects
N
Niels 已提交
3784 3785 3786 3787
        if (is_object())
        {
            return m_value.object->operator[](key);
        }
N
Niels Lohmann 已提交
3788

3789
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
N
Niels 已提交
3790 3791
    }

N
Niels 已提交
3792
    /*!
3793
    @brief read-only access specified object element
N
Niels 已提交
3794

3795 3796 3797 3798 3799
    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 已提交
3800 3801 3802

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

3803
    @return const reference to the element at key @a key
N
Niels 已提交
3804

N
Niels 已提交
3805 3806 3807
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

N
Niels 已提交
3808 3809
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    operator[] with null"`
N
Niels 已提交
3810 3811 3812 3813

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3814
    the `[]` operator.,operatorarray__key_type_const}
3815 3816 3817 3818 3819

    @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 已提交
3820
    @since version 1.0.0
N
Niels 已提交
3821
    */
N
Niels 已提交
3822
    const_reference operator[](const typename object_t::key_type& key) const
3823
    {
N
Niels 已提交
3824
        // const operator[] only works for objects
N
Niels 已提交
3825 3826 3827 3828 3829
        if (is_object())
        {
            assert(m_value.object->find(key) != m_value.object->end());
            return m_value.object->find(key)->second;
        }
N
Niels Lohmann 已提交
3830

3831
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
3832 3833
    }

N
Niels 已提交
3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846
    /*!
    @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 已提交
3847
    @throw std::domain_error if JSON is not an object or null; example:
N
Niels 已提交
3848
    `"cannot use operator[] with string"`
N
Niels 已提交
3849 3850 3851 3852

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3853
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
3854 3855 3856 3857

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

N
Niels 已提交
3859
    @since version 1.0.0
N
Niels 已提交
3860
    */
N
Niels 已提交
3861
    template<typename T, std::size_t n>
N
Niels 已提交
3862
    reference operator[](T * (&key)[n])
3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887
    {
        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 已提交
3888
    the `[]` operator.,operatorarray__key_type_const}
3889 3890 3891 3892 3893 3894 3895 3896

    @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 已提交
3897
    const_reference operator[](T * (&key)[n]) const
3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915
    {
        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 已提交
3916
    `"cannot use operator[] with string"`
3917 3918 3919 3920

    @complexity Logarithmic in the size of the container.

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

    @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 已提交
3927
    @since version 1.1.0
3928 3929 3930
    */
    template<typename T>
    reference operator[](T* key)
N
Niels 已提交
3931
    {
N
Niels 已提交
3932
        // implicitly convert null to object
N
cleanup  
Niels 已提交
3933
        if (is_null())
N
Niels 已提交
3934 3935
        {
            m_type = value_t::object;
N
Niels 已提交
3936
            m_value = value_t::object;
3937
            assert_invariant();
N
Niels 已提交
3938 3939
        }

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

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

N
Niels 已提交
3949
    /*!
3950
    @brief read-only access specified object element
N
Niels 已提交
3951

3952 3953 3954 3955 3956
    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 已提交
3957 3958 3959

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

3960
    @return const reference to the element at key @a key
N
Niels 已提交
3961

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

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

    @complexity Logarithmic in the size of the container.

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

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

3989
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
3990 3991
    }

N
Niels 已提交
3992 3993 3994
    /*!
    @brief access specified object element with default value

N
Niels 已提交
3995 3996
    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.
3997

N
Niels 已提交
3998
    The function is basically equivalent to executing
3999
    @code {.cpp}
N
Niels 已提交
4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024
    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 已提交
4025 4026
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    value() with null"`
N
Niels 已提交
4027 4028 4029 4030 4031 4032 4033 4034 4035 4036

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

N
Niels 已提交
4038
    @since version 1.0.0
N
Niels 已提交
4039
    */
N
Niels 已提交
4040 4041
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052
    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 已提交
4053 4054

            return default_value;
N
Niels 已提交
4055 4056 4057
        }
        else
        {
4058
            JSON_THROW(std::domain_error("cannot use value() with " + type_name()));
N
Niels 已提交
4059 4060 4061 4062
        }
    }

    /*!
N
Niels 已提交
4063
    @brief overload for a default value of type const char*
N
Niels 已提交
4064
    @copydoc basic_json::value(const typename object_t::key_type&, ValueType) const
N
Niels 已提交
4065 4066 4067 4068
    */
    string_t value(const typename object_t::key_type& key, const char* default_value) const
    {
        return value(key, string_t(default_value));
4069 4070
    }

N
Niels 已提交
4071 4072 4073
    /*!
    @brief access specified object element via JSON Pointer with default value

N
Niels 已提交
4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088
    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 已提交
4089 4090 4091 4092 4093 4094 4095 4096
    @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 已提交
4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107
    @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 已提交
4108
    @sa @ref operator[](const json_pointer&) for unchecked access by reference
N
Niels 已提交
4109

N
Niels 已提交
4110 4111
    @since version 2.0.2
    */
N
Niels 已提交
4112 4113
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
4114 4115 4116 4117 4118 4119
    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
4120
            JSON_TRY
N
Niels 已提交
4121 4122 4123
            {
                return ptr.get_checked(this);
            }
4124
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
4125 4126 4127 4128
            {
                return default_value;
            }
        }
N
Niels Lohmann 已提交
4129

4130
        JSON_THROW(std::domain_error("cannot use value() with " + type_name()));
N
Niels 已提交
4131 4132 4133 4134
    }

    /*!
    @brief overload for a default value of type const char*
N
Niels 已提交
4135
    @copydoc basic_json::value(const json_pointer&, ValueType) const
N
Niels 已提交
4136 4137 4138 4139 4140 4141
    */
    string_t value(const json_pointer& ptr, const char* default_value) const
    {
        return value(ptr, string_t(default_value));
    }

N
Niels 已提交
4142 4143 4144 4145 4146 4147
    /*!
    @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 已提交
4148
    @return In case of a structured type (array or object), a reference to the
4149
    first element is returned. In case of number, string, or boolean values, a
N
Niels 已提交
4150 4151 4152 4153
    reference to the value is returned.

    @complexity Constant.

N
Niels 已提交
4154
    @pre The JSON value must not be `null` (would throw `std::out_of_range`)
N
Niels 已提交
4155 4156
    or an empty array or object (undefined behavior, **guarded by
    assertions**).
N
Niels 已提交
4157 4158 4159
    @post The JSON value remains unchanged.

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

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

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

N
Niels 已提交
4165
    @since version 1.0.0
N
Niels 已提交
4166
    */
N
Niels 已提交
4167
    reference front()
N
Niels 已提交
4168 4169 4170 4171
    {
        return *begin();
    }

N
Niels 已提交
4172 4173 4174
    /*!
    @copydoc basic_json::front()
    */
N
Niels 已提交
4175
    const_reference front() const
N
Niels 已提交
4176 4177 4178 4179
    {
        return *cbegin();
    }

N
Niels 已提交
4180 4181 4182 4183
    /*!
    @brief access the last element

    Returns a reference to the last element in the container. For a JSON
N
Niels 已提交
4184 4185 4186 4187 4188 4189
    container `c`, the expression `c.back()` is equivalent to
    @code {.cpp}
    auto tmp = c.end();
    --tmp;
    return *tmp;
    @endcode
N
Niels 已提交
4190

N
Niels 已提交
4191
    @return In case of a structured type (array or object), a reference to the
4192
    last element is returned. In case of number, string, or boolean values, a
N
Niels 已提交
4193 4194 4195 4196
    reference to the value is returned.

    @complexity Constant.

N
Niels 已提交
4197
    @pre The JSON value must not be `null` (would throw `std::out_of_range`)
N
Niels 已提交
4198 4199
    or an empty array or object (undefined behavior, **guarded by
    assertions**).
N
Niels 已提交
4200
    @post The JSON value remains unchanged.
N
Niels 已提交
4201

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

N
Niels 已提交
4204 4205 4206
    @liveexample{The following code shows an example for `back()`.,back}

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

N
Niels 已提交
4208
    @since version 1.0.0
N
Niels 已提交
4209
    */
N
Niels 已提交
4210
    reference back()
N
Niels 已提交
4211 4212 4213 4214 4215 4216
    {
        auto tmp = end();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
4217 4218 4219
    /*!
    @copydoc basic_json::back()
    */
N
Niels 已提交
4220
    const_reference back() const
N
Niels 已提交
4221 4222 4223 4224 4225 4226
    {
        auto tmp = cend();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
4227 4228 4229
    /*!
    @brief remove element given an iterator

N
Niels 已提交
4230 4231 4232
    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 已提交
4233

N
Niels 已提交
4234
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
4235 4236 4237
    will be `null`.

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

4241
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
4242

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

N
Niels 已提交
4246 4247
    @throw std::domain_error if called on a `null` value; example: `"cannot
    use erase() with null"`
N
Niels 已提交
4248
    @throw std::domain_error if called on an iterator which does not belong to
N
Niels 已提交
4249
    the current JSON value; example: `"iterator does not fit current value"`
N
Niels 已提交
4250
    @throw std::out_of_range if called on a primitive type with invalid
N
Niels 已提交
4251 4252
    iterator (i.e., any iterator which is not `begin()`); example: `"iterator
    out of range"`
N
Niels 已提交
4253 4254 4255

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

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

4263
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4264
    the given range
N
Niels 已提交
4265
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4266
    from an object at the given key
N
Niels 已提交
4267 4268
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4269

N
Niels 已提交
4270
    @since version 1.0.0
N
Niels 已提交
4271
    */
N
Niels 已提交
4272 4273 4274 4275
    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>
4276
    IteratorType erase(IteratorType pos)
4277 4278
    {
        // make sure iterator fits the current value
N
Niels 已提交
4279
        if (this != pos.m_object)
4280
        {
4281
            JSON_THROW(std::domain_error("iterator does not fit current value"));
4282 4283
        }

4284
        IteratorType result = end();
4285 4286 4287 4288

        switch (m_type)
        {
            case value_t::boolean:
4289 4290
            case value_t::number_float:
            case value_t::number_integer:
4291
            case value_t::number_unsigned:
4292 4293
            case value_t::string:
            {
4294
                if (not pos.m_it.primitive_iterator.is_begin())
4295
                {
4296
                    JSON_THROW(std::out_of_range("iterator out of range"));
4297 4298
                }

N
cleanup  
Niels 已提交
4299
                if (is_string())
4300
                {
4301 4302 4303
                    AllocatorType<string_t> alloc;
                    alloc.destroy(m_value.string);
                    alloc.deallocate(m_value.string, 1);
4304 4305 4306 4307
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
4308
                assert_invariant();
4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325
                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:
            {
4326
                JSON_THROW(std::domain_error("cannot use erase() with " + type_name()));
4327 4328 4329 4330 4331 4332
            }
        }

        return result;
    }

N
Niels 已提交
4333 4334 4335
    /*!
    @brief remove elements given an iterator range

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

N
Niels 已提交
4340
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
4341 4342 4343 4344 4345
    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 已提交
4346
    second refers to the last element, the `end()` iterator is returned.
N
Niels 已提交
4347

4348
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
4349

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

N
Niels 已提交
4353 4354
    @throw std::domain_error if called on a `null` value; example: `"cannot
    use erase() with null"`
N
Niels 已提交
4355
    @throw std::domain_error if called on iterators which does not belong to
N
Niels 已提交
4356
    the current JSON value; example: `"iterators do not fit current value"`
N
Niels 已提交
4357
    @throw std::out_of_range if called on a primitive type with invalid
N
Niels 已提交
4358 4359
    iterators (i.e., if `first != begin()` and `last != end()`); example:
    `"iterators out of range"`
N
Niels 已提交
4360 4361 4362 4363 4364 4365 4366 4367

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

4371
    @sa @ref erase(IteratorType) -- removes the element at a given position
N
Niels 已提交
4372
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4373
    from an object at the given key
N
Niels 已提交
4374 4375
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4376

N
Niels 已提交
4377
    @since version 1.0.0
N
Niels 已提交
4378
    */
N
Niels 已提交
4379 4380 4381 4382
    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>
4383
    IteratorType erase(IteratorType first, IteratorType last)
4384 4385
    {
        // make sure iterator fits the current value
N
Niels 已提交
4386
        if (this != first.m_object or this != last.m_object)
4387
        {
4388
            JSON_THROW(std::domain_error("iterators do not fit current value"));
4389 4390
        }

4391
        IteratorType result = end();
4392 4393 4394 4395

        switch (m_type)
        {
            case value_t::boolean:
4396 4397
            case value_t::number_float:
            case value_t::number_integer:
4398
            case value_t::number_unsigned:
4399 4400
            case value_t::string:
            {
4401
                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
4402
                {
4403
                    JSON_THROW(std::out_of_range("iterators out of range"));
4404 4405
                }

N
cleanup  
Niels 已提交
4406
                if (is_string())
4407
                {
4408 4409 4410
                    AllocatorType<string_t> alloc;
                    alloc.destroy(m_value.string);
                    alloc.deallocate(m_value.string, 1);
4411 4412 4413 4414
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
4415
                assert_invariant();
4416 4417 4418 4419 4420 4421
                break;
            }

            case value_t::object:
            {
                result.m_it.object_iterator = m_value.object->erase(first.m_it.object_iterator,
T
Théo DELRIEU 已提交
4422
                                              last.m_it.object_iterator);
4423 4424 4425 4426 4427 4428
                break;
            }

            case value_t::array:
            {
                result.m_it.array_iterator = m_value.array->erase(first.m_it.array_iterator,
T
Théo DELRIEU 已提交
4429
                                             last.m_it.array_iterator);
4430 4431 4432 4433 4434
                break;
            }

            default:
            {
4435
                JSON_THROW(std::domain_error("cannot use erase() with " + type_name()));
4436 4437 4438 4439 4440 4441
            }
        }

        return result;
    }

N
Niels 已提交
4442 4443 4444 4445 4446 4447 4448
    /*!
    @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 已提交
4449
    @return Number of elements removed. If @a ObjectType is the default
N
Niels 已提交
4450 4451
    `std::map` type, the return value will always be `0` (@a key was not
    found) or `1` (@a key was found).
N
Niels 已提交
4452 4453 4454

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

N
Niels 已提交
4456 4457
    @throw std::domain_error when called on a type other than JSON object;
    example: `"cannot use erase() with null"`
N
Niels 已提交
4458 4459 4460

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

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

4463 4464
    @sa @ref erase(IteratorType) -- removes the element at a given position
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4465 4466 4467
    the given range
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4468

N
Niels 已提交
4469
    @since version 1.0.0
N
Niels 已提交
4470
    */
N
Niels 已提交
4471
    size_type erase(const typename object_t::key_type& key)
4472
    {
N
Niels 已提交
4473
        // this erase only works for objects
N
Niels 已提交
4474 4475 4476 4477
        if (is_object())
        {
            return m_value.object->erase(key);
        }
N
Niels Lohmann 已提交
4478

4479
        JSON_THROW(std::domain_error("cannot use erase() with " + type_name()));
4480 4481
    }

N
Niels 已提交
4482 4483 4484 4485 4486 4487 4488
    /*!
    @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 已提交
4489 4490
    @throw std::domain_error when called on a type other than JSON array;
    example: `"cannot use erase() with null"`
N
Niels 已提交
4491 4492
    @throw std::out_of_range when `idx >= size()`; example: `"array index 17
    is out of range"`
N
Niels 已提交
4493 4494 4495

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

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

4498 4499
    @sa @ref erase(IteratorType) -- removes the element at a given position
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4500
    the given range
N
Niels 已提交
4501
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4502 4503
    from an object at the given key

N
Niels 已提交
4504
    @since version 1.0.0
N
Niels 已提交
4505
    */
N
Niels 已提交
4506
    void erase(const size_type idx)
N
Niels 已提交
4507 4508
    {
        // this erase only works for arrays
N
cleanup  
Niels 已提交
4509
        if (is_array())
N
Niels 已提交
4510
        {
N
cleanup  
Niels 已提交
4511 4512
            if (idx >= size())
            {
4513
                JSON_THROW(std::out_of_range("array index " + std::to_string(idx) + " is out of range"));
N
cleanup  
Niels 已提交
4514
            }
N
Niels 已提交
4515

N
cleanup  
Niels 已提交
4516 4517 4518
            m_value.array->erase(m_value.array->begin() + static_cast<difference_type>(idx));
        }
        else
N
Niels 已提交
4519
        {
4520
            JSON_THROW(std::domain_error("cannot use erase() with " + type_name()));
N
Niels 已提交
4521 4522 4523
        }
    }

N
Niels 已提交
4524 4525 4526 4527 4528 4529 4530 4531 4532 4533
    /// @}


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

    /// @name lookup
    /// @{

N
Niels 已提交
4534 4535 4536 4537
    /*!
    @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 已提交
4538 4539
    element is not found or the JSON value is not an object, end() is
    returned.
N
Niels 已提交
4540

4541 4542 4543
    @note This method always returns @ref end() when executed on a JSON type
          that is not an object.

N
Niels 已提交
4544 4545 4546
    @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
4547 4548
    element is found or the JSON value is not an object, past-the-end (see
    @ref end()) iterator is returned.
N
Niels 已提交
4549 4550 4551

    @complexity Logarithmic in the size of the JSON object.

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

N
Niels 已提交
4554
    @since version 1.0.0
N
Niels 已提交
4555
    */
N
Niels 已提交
4556
    iterator find(typename object_t::key_type key)
N
Niels 已提交
4557 4558 4559
    {
        auto result = end();

N
cleanup  
Niels 已提交
4560
        if (is_object())
N
Niels 已提交
4561 4562 4563 4564 4565 4566 4567
        {
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4568 4569 4570 4571
    /*!
    @brief find an element in a JSON object
    @copydoc find(typename object_t::key_type)
    */
N
Niels 已提交
4572
    const_iterator find(typename object_t::key_type key) const
N
Niels 已提交
4573 4574 4575
    {
        auto result = cend();

N
cleanup  
Niels 已提交
4576
        if (is_object())
N
Niels 已提交
4577 4578 4579 4580 4581 4582 4583
        {
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4584 4585 4586 4587 4588 4589 4590
    /*!
    @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).

4591 4592 4593
    @note This method always returns `0` when executed on a JSON type that is
          not an object.

N
Niels 已提交
4594 4595 4596 4597 4598 4599 4600
    @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 已提交
4601
    @liveexample{The example shows how `count()` is used.,count}
N
Niels 已提交
4602

N
Niels 已提交
4603
    @since version 1.0.0
N
Niels 已提交
4604
    */
N
Niels 已提交
4605
    size_type count(typename object_t::key_type key) const
4606 4607
    {
        // return 0 for all nonobject types
N
Niels 已提交
4608
        return is_object() ? m_value.object->count(key) : 0;
4609 4610
    }

N
Niels 已提交
4611 4612
    /// @}

N
Niels 已提交
4613

N
Niels 已提交
4614 4615 4616 4617
    ///////////////
    // iterators //
    ///////////////

N
Niels 已提交
4618 4619 4620
    /// @name iterators
    /// @{

N
Niels 已提交
4621 4622
    /*!
    @brief returns an iterator to the first element
N
Niels 已提交
4623 4624 4625 4626 4627 4628 4629 4630 4631

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

N
Niels 已提交
4637 4638 4639 4640 4641
    @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 已提交
4642

N
Niels 已提交
4643
    @since version 1.0.0
N
Niels 已提交
4644
    */
N
Niels 已提交
4645
    iterator begin() noexcept
N
Niels 已提交
4646 4647 4648 4649 4650 4651
    {
        iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4652
    /*!
N
Niels 已提交
4653
    @copydoc basic_json::cbegin()
N
Niels 已提交
4654
    */
N
Niels 已提交
4655
    const_iterator begin() const noexcept
N
Niels 已提交
4656
    {
N
Niels 已提交
4657
        return cbegin();
N
Niels 已提交
4658 4659
    }

N
Niels 已提交
4660 4661
    /*!
    @brief returns a const iterator to the first element
N
Niels 已提交
4662 4663 4664 4665 4666 4667 4668 4669 4670

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

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

N
Niels 已提交
4683
    @since version 1.0.0
N
Niels 已提交
4684
    */
N
Niels 已提交
4685
    const_iterator cbegin() const noexcept
N
Niels 已提交
4686 4687 4688 4689 4690 4691
    {
        const_iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4692 4693
    /*!
    @brief returns an iterator to one past the last element
N
Niels 已提交
4694 4695 4696 4697 4698 4699 4700 4701 4702

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

N
Niels 已提交
4708 4709 4710 4711 4712
    @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 已提交
4713

N
Niels 已提交
4714
    @since version 1.0.0
N
Niels 已提交
4715
    */
N
Niels 已提交
4716
    iterator end() noexcept
N
Niels 已提交
4717 4718 4719 4720 4721 4722
    {
        iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
4723
    /*!
N
Niels 已提交
4724
    @copydoc basic_json::cend()
N
Niels 已提交
4725
    */
N
Niels 已提交
4726
    const_iterator end() const noexcept
N
Niels 已提交
4727
    {
N
Niels 已提交
4728
        return cend();
N
Niels 已提交
4729 4730
    }

N
Niels 已提交
4731 4732
    /*!
    @brief returns a const iterator to one past the last element
N
Niels 已提交
4733 4734 4735 4736 4737 4738 4739 4740 4741

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

N
Niels 已提交
4748 4749 4750 4751 4752
    @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 已提交
4753

N
Niels 已提交
4754
    @since version 1.0.0
N
Niels 已提交
4755
    */
N
Niels 已提交
4756
    const_iterator cend() const noexcept
N
Niels 已提交
4757 4758 4759 4760 4761 4762
    {
        const_iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
4763
    /*!
N
Niels 已提交
4764 4765 4766 4767 4768 4769 4770 4771
    @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 已提交
4772 4773 4774
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4775 4776 4777
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(end())`.

N
Niels 已提交
4778 4779 4780 4781 4782
    @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 已提交
4783

N
Niels 已提交
4784
    @since version 1.0.0
N
Niels 已提交
4785
    */
N
Niels 已提交
4786
    reverse_iterator rbegin() noexcept
N
Niels 已提交
4787 4788 4789 4790
    {
        return reverse_iterator(end());
    }

N
Niels 已提交
4791
    /*!
N
Niels 已提交
4792
    @copydoc basic_json::crbegin()
N
Niels 已提交
4793
    */
N
Niels 已提交
4794
    const_reverse_iterator rbegin() const noexcept
N
Niels 已提交
4795
    {
N
Niels 已提交
4796
        return crbegin();
N
Niels 已提交
4797 4798
    }

N
Niels 已提交
4799
    /*!
N
Niels 已提交
4800 4801 4802 4803 4804 4805 4806 4807 4808
    @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 已提交
4809 4810 4811
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4812 4813 4814
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(begin())`.

N
Niels 已提交
4815 4816 4817 4818 4819
    @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 已提交
4820

N
Niels 已提交
4821
    @since version 1.0.0
N
Niels 已提交
4822
    */
N
Niels 已提交
4823
    reverse_iterator rend() noexcept
N
Niels 已提交
4824 4825 4826 4827
    {
        return reverse_iterator(begin());
    }

N
Niels 已提交
4828
    /*!
N
Niels 已提交
4829
    @copydoc basic_json::crend()
N
Niels 已提交
4830
    */
N
Niels 已提交
4831
    const_reverse_iterator rend() const noexcept
N
Niels 已提交
4832
    {
N
Niels 已提交
4833
        return crend();
N
Niels 已提交
4834 4835
    }

N
Niels 已提交
4836
    /*!
N
Niels 已提交
4837 4838 4839 4840 4841 4842 4843 4844 4845
    @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 已提交
4846 4847 4848
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4849 4850 4851
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).rbegin()`.

N
Niels 已提交
4852 4853 4854 4855 4856
    @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 已提交
4857

N
Niels 已提交
4858
    @since version 1.0.0
N
Niels 已提交
4859
    */
N
Niels 已提交
4860
    const_reverse_iterator crbegin() const noexcept
N
Niels 已提交
4861 4862 4863 4864
    {
        return const_reverse_iterator(cend());
    }

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

N
Niels 已提交
4881 4882 4883 4884 4885
    @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 已提交
4886

N
Niels 已提交
4887
    @since version 1.0.0
N
Niels 已提交
4888
    */
N
Niels 已提交
4889
    const_reverse_iterator crend() const noexcept
N
Niels 已提交
4890 4891 4892 4893
    {
        return const_reverse_iterator(cbegin());
    }

N
cleanup  
Niels 已提交
4894 4895 4896 4897 4898 4899 4900 4901
  private:
    // forward declaration
    template<typename IteratorType> class iteration_proxy;

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

N
Niels 已提交
4902
    This function allows to access @ref iterator::key() and @ref
N
Niels 已提交
4903 4904 4905
    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 已提交
4906 4907 4908

    @note The name of this function is not yet final and may change in the
    future.
N
cleanup  
Niels 已提交
4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922
    */
    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 已提交
4923 4924
    /// @}

N
Niels 已提交
4925 4926 4927 4928 4929

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

N
Niels 已提交
4930 4931 4932
    /// @name capacity
    /// @{

N
Niels 已提交
4933 4934
    /*!
    @brief checks whether the container is empty
N
Niels 已提交
4935 4936 4937

    Checks if a JSON value has no elements.

N
Niels 已提交
4938
    @return The return value depends on the different types and is
N
Niels 已提交
4939 4940 4941
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
4942 4943 4944 4945 4946 4947
            null        | `true`
            boolean     | `false`
            string      | `false`
            number      | `false`
            object      | result of function `object_t::empty()`
            array       | result of function `array_t::empty()`
N
Niels 已提交
4948

N
Niels 已提交
4949 4950 4951 4952
    @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 已提交
4953 4954
    @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 已提交
4955
    complexity.
N
Niels 已提交
4956

N
Niels 已提交
4957 4958 4959
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
4960 4961 4962
    - The complexity is constant.
    - Has the semantics of `begin() == end()`.

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

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

N
Niels 已提交
4968
    @since version 1.0.0
N
Niels 已提交
4969
    */
N
Niels 已提交
4970
    bool empty() const noexcept
N
Niels 已提交
4971 4972 4973
    {
        switch (m_type)
        {
4974
            case value_t::null:
N
Niels 已提交
4975
            {
N
Niels 已提交
4976
                // null values are empty
N
Niels 已提交
4977 4978
                return true;
            }
N
Niels 已提交
4979

4980
            case value_t::array:
N
Niels 已提交
4981
            {
N
Niels 已提交
4982
                // delegate call to array_t::empty()
N
Niels 已提交
4983 4984
                return m_value.array->empty();
            }
N
Niels 已提交
4985

4986
            case value_t::object:
N
Niels 已提交
4987
            {
N
Niels 已提交
4988
                // delegate call to object_t::empty()
N
Niels 已提交
4989 4990
                return m_value.object->empty();
            }
N
Niels 已提交
4991

N
Niels 已提交
4992 4993 4994 4995 4996 4997
            default:
            {
                // all other types are nonempty
                return false;
            }
        }
N
Niels 已提交
4998 4999
    }

N
Niels 已提交
5000 5001
    /*!
    @brief returns the number of elements
N
Niels 已提交
5002 5003 5004

    Returns the number of elements in a JSON value.

N
Niels 已提交
5005
    @return The return value depends on the different types and is
N
Niels 已提交
5006 5007 5008
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
5009 5010 5011 5012
            null        | `0`
            boolean     | `1`
            string      | `1`
            number      | `1`
N
Niels 已提交
5013 5014 5015
            object      | result of function object_t::size()
            array       | result of function array_t::size()

N
Niels 已提交
5016 5017 5018 5019
    @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 已提交
5020 5021 5022
    @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 已提交
5023

N
Niels 已提交
5024 5025 5026
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
5027 5028 5029
    - The complexity is constant.
    - Has the semantics of `std::distance(begin(), end())`.

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

N
Niels 已提交
5033 5034 5035
    @sa @ref empty() -- checks whether the container is empty
    @sa @ref max_size() -- returns the maximal number of elements

N
Niels 已提交
5036
    @since version 1.0.0
N
Niels 已提交
5037
    */
N
Niels 已提交
5038
    size_type size() const noexcept
N
Niels 已提交
5039 5040 5041
    {
        switch (m_type)
        {
5042
            case value_t::null:
N
Niels 已提交
5043
            {
N
Niels 已提交
5044
                // null values are empty
N
Niels 已提交
5045 5046
                return 0;
            }
N
Niels 已提交
5047

5048
            case value_t::array:
N
Niels 已提交
5049
            {
N
Niels 已提交
5050
                // delegate call to array_t::size()
N
Niels 已提交
5051 5052
                return m_value.array->size();
            }
N
Niels 已提交
5053

5054
            case value_t::object:
N
Niels 已提交
5055
            {
N
Niels 已提交
5056
                // delegate call to object_t::size()
N
Niels 已提交
5057 5058
                return m_value.object->size();
            }
N
Niels 已提交
5059

N
Niels 已提交
5060 5061 5062 5063 5064 5065
            default:
            {
                // all other types have size 1
                return 1;
            }
        }
N
Niels 已提交
5066 5067
    }

N
Niels 已提交
5068 5069
    /*!
    @brief returns the maximum possible number of elements
N
Niels 已提交
5070 5071 5072 5073 5074

    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 已提交
5075
    @return The return value depends on the different types and is
N
Niels 已提交
5076 5077 5078
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
5079 5080 5081 5082 5083 5084
            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 已提交
5085

N
Niels 已提交
5086 5087
    @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 已提交
5088
    complexity.
N
Niels 已提交
5089

N
Niels 已提交
5090 5091 5092
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
5093 5094 5095 5096
    - The complexity is constant.
    - Has the semantics of returning `b.size()` where `b` is the largest
      possible JSON value.

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

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

N
Niels 已提交
5102
    @since version 1.0.0
N
Niels 已提交
5103
    */
N
Niels 已提交
5104
    size_type max_size() const noexcept
N
Niels 已提交
5105 5106 5107
    {
        switch (m_type)
        {
5108
            case value_t::array:
N
Niels 已提交
5109
            {
N
Niels 已提交
5110
                // delegate call to array_t::max_size()
N
Niels 已提交
5111 5112
                return m_value.array->max_size();
            }
N
Niels 已提交
5113

5114
            case value_t::object:
N
Niels 已提交
5115
            {
N
Niels 已提交
5116
                // delegate call to object_t::max_size()
N
Niels 已提交
5117 5118
                return m_value.object->max_size();
            }
N
Niels 已提交
5119

N
Niels 已提交
5120 5121
            default:
            {
5122 5123
                // all other types have max_size() == size()
                return size();
N
Niels 已提交
5124 5125
            }
        }
N
Niels 已提交
5126 5127
    }

N
Niels 已提交
5128 5129
    /// @}

N
Niels 已提交
5130 5131 5132 5133 5134

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

N
Niels 已提交
5135 5136 5137
    /// @name modifiers
    /// @{

N
Niels 已提交
5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154
    /*!
    @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 已提交
5155
    @liveexample{The example below shows the effect of `clear()` to different
N
Niels 已提交
5156
    JSON types.,clear}
N
Niels 已提交
5157

N
Niels 已提交
5158
    @since version 1.0.0
N
Niels 已提交
5159
    */
N
Niels 已提交
5160
    void clear() noexcept
N
Niels 已提交
5161 5162 5163
    {
        switch (m_type)
        {
5164
            case value_t::number_integer:
N
Niels 已提交
5165
            {
N
Niels 已提交
5166
                m_value.number_integer = 0;
N
Niels 已提交
5167 5168
                break;
            }
N
Niels 已提交
5169

5170 5171 5172 5173 5174 5175
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = 0;
                break;
            }

5176
            case value_t::number_float:
N
Niels 已提交
5177
            {
N
Niels 已提交
5178
                m_value.number_float = 0.0;
N
Niels 已提交
5179 5180
                break;
            }
N
Niels 已提交
5181

5182
            case value_t::boolean:
N
Niels 已提交
5183
            {
N
Niels 已提交
5184
                m_value.boolean = false;
N
Niels 已提交
5185 5186
                break;
            }
N
Niels 已提交
5187

5188
            case value_t::string:
N
Niels 已提交
5189 5190 5191 5192
            {
                m_value.string->clear();
                break;
            }
N
Niels 已提交
5193

5194
            case value_t::array:
N
Niels 已提交
5195 5196 5197 5198
            {
                m_value.array->clear();
                break;
            }
N
Niels 已提交
5199

5200
            case value_t::object:
N
Niels 已提交
5201 5202 5203 5204
            {
                m_value.object->clear();
                break;
            }
5205 5206 5207 5208 5209

            default:
            {
                break;
            }
N
Niels 已提交
5210 5211 5212
        }
    }

5213 5214 5215
    /*!
    @brief add an object to an array

5216
    Appends the given element @a val to the end of the JSON value. If the
5217
    function is called on a JSON null value, an empty array is created before
5218
    appending @a val.
5219

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

N
Niels 已提交
5222 5223
    @throw std::domain_error when called on a type other than JSON array or
    null; example: `"cannot use push_back() with number"`
5224 5225 5226

    @complexity Amortized constant.

N
Niels 已提交
5227 5228 5229
    @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 已提交
5230

N
Niels 已提交
5231
    @since version 1.0.0
5232
    */
5233
    void push_back(basic_json&& val)
N
Niels 已提交
5234 5235
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
5236
        if (not(is_null() or is_array()))
N
Niels 已提交
5237
        {
5238
            JSON_THROW(std::domain_error("cannot use push_back() with " + type_name()));
N
Niels 已提交
5239 5240 5241
        }

        // transform null object into an array
N
cleanup  
Niels 已提交
5242
        if (is_null())
N
Niels 已提交
5243 5244
        {
            m_type = value_t::array;
N
Niels 已提交
5245
            m_value = value_t::array;
5246
            assert_invariant();
N
Niels 已提交
5247 5248 5249
        }

        // add element to array (move semantics)
5250
        m_value.array->push_back(std::move(val));
N
Niels 已提交
5251
        // invalidate object
5252
        val.m_type = value_t::null;
N
Niels 已提交
5253 5254
    }

5255 5256 5257 5258
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5259
    reference operator+=(basic_json&& val)
N
Niels 已提交
5260
    {
5261
        push_back(std::move(val));
N
Niels 已提交
5262 5263 5264
        return *this;
    }

5265 5266 5267 5268
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5269
    void push_back(const basic_json& val)
N
Niels 已提交
5270 5271
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
5272
        if (not(is_null() or is_array()))
N
Niels 已提交
5273
        {
5274
            JSON_THROW(std::domain_error("cannot use push_back() with " + type_name()));
N
Niels 已提交
5275 5276 5277
        }

        // transform null object into an array
N
cleanup  
Niels 已提交
5278
        if (is_null())
N
Niels 已提交
5279 5280
        {
            m_type = value_t::array;
N
Niels 已提交
5281
            m_value = value_t::array;
5282
            assert_invariant();
N
Niels 已提交
5283 5284 5285
        }

        // add element to array
5286
        m_value.array->push_back(val);
N
Niels 已提交
5287 5288
    }

5289 5290 5291 5292
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5293
    reference operator+=(const basic_json& val)
N
Niels 已提交
5294
    {
5295
        push_back(val);
N
Niels 已提交
5296 5297 5298
        return *this;
    }

5299 5300 5301
    /*!
    @brief add an object to an object

5302
    Inserts the given element @a val to the JSON object. If the function is
N
Niels 已提交
5303 5304
    called on a JSON null value, an empty object is created before inserting
    @a val.
5305

5306
    @param[in] val the value to add to the JSON object
5307 5308

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

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

N
Niels 已提交
5313 5314 5315
    @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 已提交
5316

N
Niels 已提交
5317
    @since version 1.0.0
5318
    */
5319
    void push_back(const typename object_t::value_type& val)
N
Niels 已提交
5320 5321
    {
        // push_back only works for null objects or objects
N
cleanup  
Niels 已提交
5322
        if (not(is_null() or is_object()))
N
Niels 已提交
5323
        {
5324
            JSON_THROW(std::domain_error("cannot use push_back() with " + type_name()));
N
Niels 已提交
5325 5326 5327
        }

        // transform null object into an object
N
cleanup  
Niels 已提交
5328
        if (is_null())
N
Niels 已提交
5329 5330
        {
            m_type = value_t::object;
N
Niels 已提交
5331
            m_value = value_t::object;
5332
            assert_invariant();
N
Niels 已提交
5333 5334 5335
        }

        // add element to array
5336
        m_value.object->insert(val);
N
Niels 已提交
5337 5338
    }

5339 5340 5341 5342
    /*!
    @brief add an object to an object
    @copydoc push_back(const typename object_t::value_type&)
    */
5343
    reference operator+=(const typename object_t::value_type& val)
N
Niels 已提交
5344
    {
5345
        push_back(val);
N
Niels 已提交
5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 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
        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 已提交
5395 5396
    }

N
Niels 已提交
5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423
    /*!
    @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()))
        {
5424
            JSON_THROW(std::domain_error("cannot use emplace_back() with " + type_name()));
N
Niels 已提交
5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439
        }

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

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

N
Niels Lohmann 已提交
5442 5443
    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
5444 5445
    function is called on a JSON null value, an empty object is created before
    appending the value created from @a args.
N
Niels 已提交
5446 5447 5448 5449

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

5450 5451 5452 5453
    @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 已提交
5454 5455 5456 5457 5458 5459 5460
    @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
5461 5462
    JSON object. Further note how no value is added if there was already one
    value stored with the same key.,emplace}
N
Niels 已提交
5463 5464 5465 5466

    @since version 2.0.8
    */
    template<class... Args>
5467
    std::pair<iterator, bool> emplace(Args&& ... args)
N
Niels 已提交
5468 5469 5470 5471
    {
        // emplace only works for null objects or arrays
        if (not(is_null() or is_object()))
        {
5472
            JSON_THROW(std::domain_error("cannot use emplace() with " + type_name()));
N
Niels 已提交
5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483
        }

        // 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)
5484 5485 5486 5487 5488 5489 5490
        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 已提交
5491 5492
    }

N
Niels 已提交
5493 5494 5495
    /*!
    @brief inserts element

5496
    Inserts element @a val before iterator @a pos.
N
Niels 已提交
5497 5498 5499

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

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

N
Niels Lohmann 已提交
5508
    @complexity Constant plus linear in the distance between @a pos and end of
N
Niels Lohmann 已提交
5509
    the container.
N
Niels 已提交
5510

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

N
Niels 已提交
5513
    @since version 1.0.0
N
Niels 已提交
5514
    */
5515
    iterator insert(const_iterator pos, const basic_json& val)
N
Niels 已提交
5516 5517
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5518
        if (is_array())
N
Niels 已提交
5519
        {
N
cleanup  
Niels 已提交
5520 5521 5522
            // check if iterator pos fits to this JSON value
            if (pos.m_object != this)
            {
5523
                JSON_THROW(std::domain_error("iterator does not fit current value"));
N
cleanup  
Niels 已提交
5524
            }
N
Niels 已提交
5525

N
cleanup  
Niels 已提交
5526 5527
            // insert to array and return iterator
            iterator result(this);
5528
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, val);
N
cleanup  
Niels 已提交
5529 5530
            return result;
        }
N
Niels Lohmann 已提交
5531

5532
        JSON_THROW(std::domain_error("cannot use insert() with " + type_name()));
N
Niels 已提交
5533 5534 5535 5536 5537 5538
    }

    /*!
    @brief inserts element
    @copydoc insert(const_iterator, const basic_json&)
    */
5539
    iterator insert(const_iterator pos, basic_json&& val)
N
Niels 已提交
5540
    {
5541
        return insert(pos, val);
N
Niels 已提交
5542 5543 5544 5545 5546
    }

    /*!
    @brief inserts elements

5547
    Inserts @a cnt copies of @a val before iterator @a pos.
N
Niels 已提交
5548 5549 5550

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

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

5561
    @complexity Linear in @a cnt plus linear in the distance between @a pos
N
Niels 已提交
5562 5563
    and end of the container.

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

N
Niels 已提交
5566
    @since version 1.0.0
N
Niels 已提交
5567
    */
5568
    iterator insert(const_iterator pos, size_type cnt, const basic_json& val)
N
Niels 已提交
5569 5570
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5571
        if (is_array())
N
Niels 已提交
5572
        {
N
cleanup  
Niels 已提交
5573 5574 5575
            // check if iterator pos fits to this JSON value
            if (pos.m_object != this)
            {
5576
                JSON_THROW(std::domain_error("iterator does not fit current value"));
N
cleanup  
Niels 已提交
5577
            }
N
Niels 已提交
5578

N
cleanup  
Niels 已提交
5579 5580
            // insert to array and return iterator
            iterator result(this);
5581
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, cnt, val);
N
cleanup  
Niels 已提交
5582 5583
            return result;
        }
N
Niels Lohmann 已提交
5584

5585
        JSON_THROW(std::domain_error("cannot use insert() with " + type_name()));
N
Niels 已提交
5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597
    }

    /*!
    @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 已提交
5598 5599
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
N
Niels 已提交
5600 5601
    @throw std::domain_error if @a pos is not an iterator of *this; example:
    `"iterator does not fit current value"`
N
Niels 已提交
5602
    @throw std::domain_error if @a first and @a last do not belong to the same
N
Niels 已提交
5603
    JSON value; example: `"iterators do not fit"`
N
Niels 已提交
5604
    @throw std::domain_error if @a first or @a last are iterators into
N
Niels 已提交
5605 5606 5607
    container for which insert is called; example: `"passed iterators may not
    belong to container"`

N
Niels 已提交
5608 5609 5610 5611 5612 5613
    @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 已提交
5614
    @liveexample{The example shows how `insert()` is used.,insert__range}
N
Niels 已提交
5615

N
Niels 已提交
5616
    @since version 1.0.0
N
Niels 已提交
5617 5618 5619 5620
    */
    iterator insert(const_iterator pos, const_iterator first, const_iterator last)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5621
        if (not is_array())
N
Niels 已提交
5622
        {
5623
            JSON_THROW(std::domain_error("cannot use insert() with " + type_name()));
N
Niels 已提交
5624 5625 5626 5627 5628
        }

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

N
Niels 已提交
5632
        // check if range iterators belong to the same JSON object
N
Niels 已提交
5633 5634
        if (first.m_object != last.m_object)
        {
5635
            JSON_THROW(std::domain_error("iterators do not fit"));
N
Niels 已提交
5636 5637 5638 5639
        }

        if (first.m_object == this or last.m_object == this)
        {
5640
            JSON_THROW(std::domain_error("passed iterators may not belong to container"));
N
Niels 已提交
5641 5642 5643 5644
        }

        // insert to array and return iterator
        iterator result(this);
N
Niels 已提交
5645
        result.m_it.array_iterator = m_value.array->insert(
T
Théo DELRIEU 已提交
5646 5647 5648
                                         pos.m_it.array_iterator,
                                         first.m_it.array_iterator,
                                         last.m_it.array_iterator);
N
Niels 已提交
5649 5650 5651
        return result;
    }

N
Niels 已提交
5652 5653 5654 5655 5656 5657 5658 5659 5660
    /*!
    @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 已提交
5661 5662
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
N
Niels 已提交
5663 5664
    @throw std::domain_error if @a pos is not an iterator of *this; example:
    `"iterator does not fit current value"`
N
Niels 已提交
5665

N
Niels 已提交
5666 5667 5668
    @return iterator pointing to the first element inserted, or @a pos if
    `ilist` is empty

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

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

N
Niels 已提交
5674
    @since version 1.0.0
N
Niels 已提交
5675 5676 5677 5678
    */
    iterator insert(const_iterator pos, std::initializer_list<basic_json> ilist)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5679
        if (not is_array())
N
Niels 已提交
5680
        {
5681
            JSON_THROW(std::domain_error("cannot use insert() with " + type_name()));
N
Niels 已提交
5682 5683 5684 5685 5686
        }

        // check if iterator pos fits to this JSON value
        if (pos.m_object != this)
        {
5687
            JSON_THROW(std::domain_error("iterator does not fit current value"));
N
Niels 已提交
5688 5689 5690 5691 5692 5693 5694 5695
        }

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

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

N
Niels 已提交
5711
    @since version 1.0.0
N
Niels 已提交
5712
    */
N
Niels 已提交
5713
    void swap(reference other) noexcept (
N
Niels 已提交
5714 5715 5716 5717
        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 已提交
5718
    )
N
Niels 已提交
5719 5720 5721
    {
        std::swap(m_type, other.m_type);
        std::swap(m_value, other.m_value);
5722
        assert_invariant();
N
Niels 已提交
5723 5724
    }

N
Niels 已提交
5725 5726 5727 5728 5729 5730 5731 5732 5733 5734
    /*!
    @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 已提交
5735 5736
    @throw std::domain_error when JSON value is not an array; example:
    `"cannot use swap() with string"`
N
Niels 已提交
5737 5738 5739

    @complexity Constant.

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

N
Niels 已提交
5743
    @since version 1.0.0
N
Niels 已提交
5744
    */
N
Niels 已提交
5745
    void swap(array_t& other)
N
Niels 已提交
5746 5747
    {
        // swap only works for arrays
N
cleanup  
Niels 已提交
5748 5749 5750 5751 5752
        if (is_array())
        {
            std::swap(*(m_value.array), other);
        }
        else
N
Niels 已提交
5753
        {
5754
            JSON_THROW(std::domain_error("cannot use swap() with " + type_name()));
N
Niels 已提交
5755 5756 5757
        }
    }

5758 5759 5760 5761 5762 5763 5764 5765 5766 5767
    /*!
    @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 已提交
5768 5769
    @throw std::domain_error when JSON value is not an object; example:
    `"cannot use swap() with string"`
5770 5771 5772

    @complexity Constant.

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

N
Niels 已提交
5776
    @since version 1.0.0
5777
    */
N
Niels 已提交
5778
    void swap(object_t& other)
N
Niels 已提交
5779 5780
    {
        // swap only works for objects
N
cleanup  
Niels 已提交
5781 5782 5783 5784 5785
        if (is_object())
        {
            std::swap(*(m_value.object), other);
        }
        else
N
Niels 已提交
5786
        {
5787
            JSON_THROW(std::domain_error("cannot use swap() with " + type_name()));
N
Niels 已提交
5788 5789 5790
        }
    }

5791 5792 5793 5794 5795 5796 5797 5798 5799 5800
    /*!
    @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 已提交
5801 5802
    @throw std::domain_error when JSON value is not a string; example: `"cannot
    use swap() with boolean"`
5803 5804 5805

    @complexity Constant.

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

N
Niels 已提交
5809
    @since version 1.0.0
5810
    */
N
Niels 已提交
5811
    void swap(string_t& other)
N
Niels 已提交
5812 5813
    {
        // swap only works for strings
N
cleanup  
Niels 已提交
5814 5815 5816 5817 5818
        if (is_string())
        {
            std::swap(*(m_value.string), other);
        }
        else
N
Niels 已提交
5819
        {
5820
            JSON_THROW(std::domain_error("cannot use swap() with " + type_name()));
N
Niels 已提交
5821 5822 5823
        }
    }

N
Niels 已提交
5824 5825
    /// @}

N
Niels 已提交
5826
  public:
5827 5828 5829 5830 5831 5832 5833
    //////////////////////////////////////////
    // lexicographical comparison operators //
    //////////////////////////////////////////

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

N
Niels 已提交
5834 5835
    /*!
    @brief comparison: equal
N
Niels 已提交
5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851

    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.

5852 5853
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__equal}
N
Niels 已提交
5854

N
Niels 已提交
5855
    @since version 1.0.0
N
Niels 已提交
5856
    */
N
Niels 已提交
5857
    friend bool operator==(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
5858
    {
F
Florian Weber 已提交
5859 5860
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
5861

F
Florian Weber 已提交
5862
        if (lhs_type == rhs_type)
N
Niels 已提交
5863
        {
F
Florian Weber 已提交
5864
            switch (lhs_type)
N
Niels 已提交
5865
            {
5866
                case value_t::array:
N
Niels 已提交
5867
                {
N
Niels 已提交
5868
                    return *lhs.m_value.array == *rhs.m_value.array;
N
Niels 已提交
5869
                }
5870
                case value_t::object:
N
Niels 已提交
5871
                {
N
Niels 已提交
5872
                    return *lhs.m_value.object == *rhs.m_value.object;
N
Niels 已提交
5873
                }
5874
                case value_t::null:
N
Niels 已提交
5875
                {
N
Niels 已提交
5876
                    return true;
N
Niels 已提交
5877
                }
5878
                case value_t::string:
N
Niels 已提交
5879
                {
N
Niels 已提交
5880
                    return *lhs.m_value.string == *rhs.m_value.string;
N
Niels 已提交
5881
                }
5882
                case value_t::boolean:
N
Niels 已提交
5883
                {
N
Niels 已提交
5884
                    return lhs.m_value.boolean == rhs.m_value.boolean;
N
Niels 已提交
5885
                }
5886
                case value_t::number_integer:
N
Niels 已提交
5887
                {
N
Niels 已提交
5888
                    return lhs.m_value.number_integer == rhs.m_value.number_integer;
N
Niels 已提交
5889
                }
5890 5891 5892 5893
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned == rhs.m_value.number_unsigned;
                }
5894
                case value_t::number_float:
N
Niels 已提交
5895
                {
5896
                    return lhs.m_value.number_float == rhs.m_value.number_float;
N
Niels 已提交
5897
                }
5898
                default:
N
Niels 已提交
5899
                {
N
Niels 已提交
5900
                    return false;
N
Niels 已提交
5901
                }
N
Niels 已提交
5902 5903
            }
        }
F
Florian Weber 已提交
5904 5905
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
N
Niels 已提交
5906
            return static_cast<number_float_t>(lhs.m_value.number_integer) == rhs.m_value.number_float;
F
Florian Weber 已提交
5907 5908 5909
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
5910
            return lhs.m_value.number_float == static_cast<number_float_t>(rhs.m_value.number_integer);
F
Florian Weber 已提交
5911
        }
5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926
        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 已提交
5927
        }
5928

N
Niels 已提交
5929 5930 5931
        return false;
    }

N
Niels 已提交
5932 5933
    /*!
    @brief comparison: equal
M
Mihai STAN 已提交
5934
    @copydoc operator==(const_reference, const_reference)
N
Niels 已提交
5935
    */
M
Mihai STAN 已提交
5936
    template<typename ScalarType, typename std::enable_if<
5937 5938
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator==(const_reference lhs, const ScalarType rhs) noexcept
N
Niels 已提交
5939
    {
M
Mihai STAN 已提交
5940
        return (lhs == basic_json(rhs));
N
Niels 已提交
5941 5942 5943 5944
    }

    /*!
    @brief comparison: equal
M
Mihai STAN 已提交
5945
    @copydoc operator==(const_reference, const_reference)
N
Niels 已提交
5946
    */
M
Mihai STAN 已提交
5947
    template<typename ScalarType, typename std::enable_if<
5948 5949
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator==(const ScalarType lhs, const_reference rhs) noexcept
N
Niels 已提交
5950
    {
M
Mihai STAN 已提交
5951
        return (basic_json(lhs) == rhs);
N
Niels 已提交
5952 5953
    }

N
Niels 已提交
5954 5955
    /*!
    @brief comparison: not equal
N
Niels 已提交
5956 5957 5958 5959 5960 5961 5962 5963 5964

    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.

5965 5966
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__notequal}
N
Niels 已提交
5967

N
Niels 已提交
5968
    @since version 1.0.0
N
Niels 已提交
5969
    */
N
Niels 已提交
5970
    friend bool operator!=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
5971 5972 5973 5974
    {
        return not (lhs == rhs);
    }

N
Niels 已提交
5975 5976
    /*!
    @brief comparison: not equal
M
Mihai STAN 已提交
5977
    @copydoc operator!=(const_reference, const_reference)
N
Niels 已提交
5978
    */
M
Mihai STAN 已提交
5979 5980 5981
    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 已提交
5982
    {
M
Mihai STAN 已提交
5983
        return (lhs != basic_json(rhs));
N
Niels 已提交
5984 5985 5986 5987
    }

    /*!
    @brief comparison: not equal
M
Mihai STAN 已提交
5988
    @copydoc operator!=(const_reference, const_reference)
N
Niels 已提交
5989
    */
M
Mihai STAN 已提交
5990 5991 5992
    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 已提交
5993
    {
M
Mihai STAN 已提交
5994
        return (basic_json(lhs) != rhs);
N
Niels 已提交
5995 5996
    }

N
Niels 已提交
5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015
    /*!
    @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.

6016 6017
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__less}
N
Niels 已提交
6018

N
Niels 已提交
6019
    @since version 1.0.0
N
Niels 已提交
6020
    */
N
Niels 已提交
6021
    friend bool operator<(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6022
    {
F
Florian Weber 已提交
6023 6024
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
6025

F
Florian Weber 已提交
6026
        if (lhs_type == rhs_type)
N
Niels 已提交
6027
        {
F
Florian Weber 已提交
6028
            switch (lhs_type)
N
Niels 已提交
6029
            {
6030
                case value_t::array:
N
Niels 已提交
6031
                {
N
Niels 已提交
6032
                    return *lhs.m_value.array < *rhs.m_value.array;
N
Niels 已提交
6033
                }
6034
                case value_t::object:
N
Niels 已提交
6035
                {
N
Niels 已提交
6036
                    return *lhs.m_value.object < *rhs.m_value.object;
N
Niels 已提交
6037
                }
6038
                case value_t::null:
N
Niels 已提交
6039
                {
N
Niels 已提交
6040
                    return false;
N
Niels 已提交
6041
                }
6042
                case value_t::string:
N
Niels 已提交
6043
                {
N
Niels 已提交
6044
                    return *lhs.m_value.string < *rhs.m_value.string;
N
Niels 已提交
6045
                }
6046
                case value_t::boolean:
N
Niels 已提交
6047
                {
N
Niels 已提交
6048
                    return lhs.m_value.boolean < rhs.m_value.boolean;
N
Niels 已提交
6049
                }
6050
                case value_t::number_integer:
N
Niels 已提交
6051
                {
N
Niels 已提交
6052
                    return lhs.m_value.number_integer < rhs.m_value.number_integer;
N
Niels 已提交
6053
                }
6054 6055 6056 6057
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned < rhs.m_value.number_unsigned;
                }
6058
                case value_t::number_float:
N
Niels 已提交
6059
                {
N
Niels 已提交
6060
                    return lhs.m_value.number_float < rhs.m_value.number_float;
N
Niels 已提交
6061
                }
6062
                default:
N
Niels 已提交
6063
                {
N
Niels 已提交
6064
                    return false;
N
Niels 已提交
6065
                }
N
Niels 已提交
6066 6067
            }
        }
F
Florian Weber 已提交
6068 6069
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
6070
            return static_cast<number_float_t>(lhs.m_value.number_integer) < rhs.m_value.number_float;
F
Florian Weber 已提交
6071 6072 6073
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090
            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 已提交
6091
        }
N
Niels 已提交
6092

N
Niels 已提交
6093
        // We only reach this line if we cannot compare values. In that case,
N
Niels 已提交
6094 6095 6096
        // we compare types. Note we have to call the operator explicitly,
        // because MSVC has problems otherwise.
        return operator<(lhs_type, rhs_type);
N
Niels 已提交
6097 6098
    }

N
Niels 已提交
6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110
    /*!
    @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.

6111 6112
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greater}
N
Niels 已提交
6113

N
Niels 已提交
6114
    @since version 1.0.0
N
Niels 已提交
6115
    */
N
Niels 已提交
6116
    friend bool operator<=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6117 6118 6119 6120
    {
        return not (rhs < lhs);
    }

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

6133 6134
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__lessequal}
N
Niels 已提交
6135

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

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

6155 6156
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greaterequal}
N
Niels 已提交
6157

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

N
Niels 已提交
6165 6166
    /// @}

N
Niels 已提交
6167 6168 6169 6170 6171

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

N
Niels 已提交
6172 6173 6174
    /// @name serialization
    /// @{

6175
  private:
6176 6177 6178
    /*!
    @brief wrapper around the serialization functions
    */
6179 6180
    class serializer
    {
T
Ted Lyngmo 已提交
6181 6182 6183 6184
      private:
        serializer(const serializer&) = delete;
        serializer& operator=(const serializer&) = delete;

6185
      public:
N
Niels Lohmann 已提交
6186 6187 6188
        /*!
        @param[in] s  output stream to serialize to
        */
6189
        serializer(std::ostream& s)
6190 6191 6192
            : o(s), loc(std::localeconv()),
              thousands_sep(!loc->thousands_sep ? '\0' : loc->thousands_sep[0]),
              decimal_point(!loc->decimal_point ? '\0' : loc->decimal_point[0])
6193 6194 6195 6196 6197
        {}

        /*!
        @brief internal implementation of the serialization function

N
Niels Lohmann 已提交
6198 6199 6200 6201
        This function is called by the public member function dump and
        organizes the serialization internally. The indentation level is
        propagated as additional parameter. In case of arrays and objects, the
        function is called recursively.
6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214

        - strings and object keys are escaped using `escape_string()`
        - integer numbers are converted implicitly via `operator<<`
        - floating-point numbers are converted to a string using `"%g"` format

        @param[in] val             value to serialize
        @param[in] pretty_print    whether the output shall be pretty-printed
        @param[in] indent_step     the indent level
        @param[in] current_indent  the current indent level (only used internally)
        */
        void dump(const basic_json& val,
                  const bool pretty_print,
                  const unsigned int indent_step,
6215
                  const unsigned int current_indent = 0)
6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232
        {
            switch (val.m_type)
            {
                case value_t::object:
                {
                    if (val.m_value.object->empty())
                    {
                        o.write("{}", 2);
                        return;
                    }

                    if (pretty_print)
                    {
                        o.write("{\n", 2);

                        // variable to hold indentation for recursive calls
                        const auto new_indent = current_indent + indent_step;
6233 6234 6235 6236
                        if (indent_string.size() < new_indent)
                        {
                            indent_string.resize(new_indent, ' ');
                        }
6237 6238 6239 6240 6241 6242 6243

                        // first n-1 elements
                        auto i = val.m_value.object->cbegin();
                        for (size_t cnt = 0; cnt < val.m_value.object->size() - 1; ++cnt, ++i)
                        {
                            o.write(indent_string.c_str(), new_indent);
                            o.put('\"');
6244
                            dump_escaped(i->first);
6245 6246 6247 6248 6249 6250 6251 6252 6253
                            o.write("\": ", 3);
                            dump(i->second, true, indent_step, new_indent);
                            o.write(",\n", 2);
                        }

                        // last element
                        assert(i != val.m_value.object->cend());
                        o.write(indent_string.c_str(), new_indent);
                        o.put('\"');
6254
                        dump_escaped(i->first);
6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270
                        o.write("\": ", 3);
                        dump(i->second, true, indent_step, new_indent);

                        o.put('\n');
                        o.write(indent_string.c_str(), current_indent);
                        o.put('}');
                    }
                    else
                    {
                        o.put('{');

                        // first n-1 elements
                        auto i = val.m_value.object->cbegin();
                        for (size_t cnt = 0; cnt < val.m_value.object->size() - 1; ++cnt, ++i)
                        {
                            o.put('\"');
6271
                            dump_escaped(i->first);
6272 6273 6274 6275 6276 6277 6278 6279
                            o.write("\":", 2);
                            dump(i->second, false, indent_step, current_indent);
                            o.put(',');
                        }

                        // last element
                        assert(i != val.m_value.object->cend());
                        o.put('\"');
6280
                        dump_escaped(i->first);
6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303
                        o.write("\":", 2);
                        dump(i->second, false, indent_step, current_indent);

                        o.put('}');
                    }

                    return;
                }

                case value_t::array:
                {
                    if (val.m_value.array->empty())
                    {
                        o.write("[]", 2);
                        return;
                    }

                    if (pretty_print)
                    {
                        o.write("[\n", 2);

                        // variable to hold indentation for recursive calls
                        const auto new_indent = current_indent + indent_step;
6304 6305 6306 6307
                        if (indent_string.size() < new_indent)
                        {
                            indent_string.resize(new_indent, ' ');
                        }
6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349

                        // first n-1 elements
                        for (auto i = val.m_value.array->cbegin(); i != val.m_value.array->cend() - 1; ++i)
                        {
                            o.write(indent_string.c_str(), new_indent);
                            dump(*i, true, indent_step, new_indent);
                            o.write(",\n", 2);
                        }

                        // last element
                        assert(not val.m_value.array->empty());
                        o.write(indent_string.c_str(), new_indent);
                        dump(val.m_value.array->back(), true, indent_step, new_indent);

                        o.put('\n');
                        o.write(indent_string.c_str(), current_indent);
                        o.put(']');
                    }
                    else
                    {
                        o.put('[');

                        // first n-1 elements
                        for (auto i = val.m_value.array->cbegin(); i != val.m_value.array->cend() - 1; ++i)
                        {
                            dump(*i, false, indent_step, current_indent);
                            o.put(',');
                        }

                        // last element
                        assert(not val.m_value.array->empty());
                        dump(val.m_value.array->back(), false, indent_step, current_indent);

                        o.put(']');
                    }

                    return;
                }

                case value_t::string:
                {
                    o.put('\"');
6350
                    dump_escaped(*val.m_value.string);
6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369
                    o.put('\"');
                    return;
                }

                case value_t::boolean:
                {
                    if (val.m_value.boolean)
                    {
                        o.write("true", 4);
                    }
                    else
                    {
                        o.write("false", 5);
                    }
                    return;
                }

                case value_t::number_integer:
                {
6370
                    dump_integer(val.m_value.number_integer);
6371 6372 6373 6374 6375
                    return;
                }

                case value_t::number_unsigned:
                {
6376
                    dump_integer(val.m_value.number_unsigned);
6377 6378 6379 6380 6381
                    return;
                }

                case value_t::number_float:
                {
6382
                    dump_float(val.m_value.number_float);
6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427
                    return;
                }

                case value_t::discarded:
                {
                    o.write("<discarded>", 11);
                    return;
                }

                case value_t::null:
                {
                    o.write("null", 4);
                    return;
                }
            }
        }

      private:
        /*!
        @brief calculates the extra space to escape a JSON string

        @param[in] s  the string to escape
        @return the number of characters required to escape string @a s

        @complexity Linear in the length of string @a s.
        */
        static std::size_t extra_space(const string_t& s) noexcept
        {
            return std::accumulate(s.begin(), s.end(), size_t{},
                                   [](size_t res, typename string_t::value_type c)
            {
                switch (c)
                {
                    case '"':
                    case '\\':
                    case '\b':
                    case '\f':
                    case '\n':
                    case '\r':
                    case '\t':
                    {
                        // from c (1 byte) to \x (2 bytes)
                        return res + 1;
                    }

6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454
                    case 0x00:
                    case 0x01:
                    case 0x02:
                    case 0x03:
                    case 0x04:
                    case 0x05:
                    case 0x06:
                    case 0x07:
                    case 0x0b:
                    case 0x0e:
                    case 0x0f:
                    case 0x10:
                    case 0x11:
                    case 0x12:
                    case 0x13:
                    case 0x14:
                    case 0x15:
                    case 0x16:
                    case 0x17:
                    case 0x18:
                    case 0x19:
                    case 0x1a:
                    case 0x1b:
                    case 0x1c:
                    case 0x1d:
                    case 0x1e:
                    case 0x1f:
6455
                    {
6456 6457 6458
                        // from c (1 byte) to \uxxxx (6 bytes)
                        return res + 5;
                    }
6459

6460 6461
                    default:
                    {
6462 6463 6464 6465 6466 6467 6468
                        return res;
                    }
                }
            });
        }

        /*!
N
Niels Lohmann 已提交
6469
        @brief dump escaped string
6470

N
Niels Lohmann 已提交
6471 6472 6473 6474
        Escape a string by replacing certain special characters by a sequence
        of an escape character (backslash) and another character and other
        control characters by a sequence of "\u" followed by a four-digit hex
        representation. The escaped string is written to output stream @a o.
6475 6476 6477 6478 6479

        @param[in] s  the string to escape

        @complexity Linear in the length of string @a s.
        */
6480
        void dump_escaped(const string_t& s) const
6481 6482 6483 6484
        {
            const auto space = extra_space(s);
            if (space == 0)
            {
6485 6486
                o.write(s.c_str(), static_cast<std::streamsize>(s.size()));
                return;
6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552
            }

            // create a result string of necessary size
            string_t result(s.size() + space, '\\');
            std::size_t pos = 0;

            for (const auto& c : s)
            {
                switch (c)
                {
                    // quotation mark (0x22)
                    case '"':
                    {
                        result[pos + 1] = '"';
                        pos += 2;
                        break;
                    }

                    // reverse solidus (0x5c)
                    case '\\':
                    {
                        // nothing to change
                        pos += 2;
                        break;
                    }

                    // backspace (0x08)
                    case '\b':
                    {
                        result[pos + 1] = 'b';
                        pos += 2;
                        break;
                    }

                    // formfeed (0x0c)
                    case '\f':
                    {
                        result[pos + 1] = 'f';
                        pos += 2;
                        break;
                    }

                    // newline (0x0a)
                    case '\n':
                    {
                        result[pos + 1] = 'n';
                        pos += 2;
                        break;
                    }

                    // carriage return (0x0d)
                    case '\r':
                    {
                        result[pos + 1] = 'r';
                        pos += 2;
                        break;
                    }

                    // horizontal tab (0x09)
                    case '\t':
                    {
                        result[pos + 1] = 't';
                        pos += 2;
                        break;
                    }

6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579
                    case 0x00:
                    case 0x01:
                    case 0x02:
                    case 0x03:
                    case 0x04:
                    case 0x05:
                    case 0x06:
                    case 0x07:
                    case 0x0b:
                    case 0x0e:
                    case 0x0f:
                    case 0x10:
                    case 0x11:
                    case 0x12:
                    case 0x13:
                    case 0x14:
                    case 0x15:
                    case 0x16:
                    case 0x17:
                    case 0x18:
                    case 0x19:
                    case 0x1a:
                    case 0x1b:
                    case 0x1c:
                    case 0x1d:
                    case 0x1e:
                    case 0x1f:
6580
                    {
6581 6582 6583
                        // convert a number 0..15 to its hex representation
                        // (0..f)
                        static const char hexify[16] =
6584
                        {
6585 6586 6587 6588 6589 6590 6591 6592
                            '0', '1', '2', '3', '4', '5', '6', '7',
                            '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'
                        };

                        // print character c as \uxxxx
                        for (const char m :
                    { 'u', '0', '0', hexify[c >> 4], hexify[c & 0x0f]
                        })
6593
                        {
6594
                            result[++pos] = m;
6595
                        }
6596 6597 6598 6599 6600 6601 6602 6603 6604

                        ++pos;
                        break;
                    }

                    default:
                    {
                        // all other characters are added as-is
                        result[pos++] = c;
6605 6606 6607 6608 6609
                        break;
                    }
                }
            }

6610 6611
            assert(pos == s.size() + space);
            o.write(result.c_str(), static_cast<std::streamsize>(result.size()));
6612 6613
        }

N
Niels Lohmann 已提交
6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625
        /*!
        @brief dump an integer

        Dump a given integer to output stream @a o. Works internally with
        @a number_buffer.

        @param[in] x  integer number (signed or unsigned) to dump
        @tparam NumberType either @a number_integer_t or @a number_unsigned_t
        */
        template<typename NumberType, detail::enable_if_t <
                     std::is_same<NumberType, number_unsigned_t>::value or
                     std::is_same<NumberType, number_integer_t>::value, int> = 0>
6626
        void dump_integer(NumberType x)
6627
        {
6628 6629
            // special case for "0"
            if (x == 0)
6630
            {
6631 6632
                o.put('0');
                return;
6633 6634
            }

6635 6636 6637 6638
            const bool is_negative = x < 0;
            size_t i = 0;

            // spare 1 byte for '\0'
N
Niels Lohmann 已提交
6639
            while (x != 0 and i < number_buffer.size() - 1)
6640
            {
6641
                const auto digit = std::labs(static_cast<long>(x % 10));
N
Niels Lohmann 已提交
6642
                number_buffer[i++] = static_cast<char>('0' + digit);
6643
                x /= 10;
6644 6645
            }

6646 6647
            // make sure the number has been processed completely
            assert(x == 0);
6648

6649
            if (is_negative)
6650
            {
6651
                // make sure there is capacity for the '-'
N
Niels Lohmann 已提交
6652 6653
                assert(i < number_buffer.size() - 2);
                number_buffer[i++] = '-';
6654
            }
6655

N
Niels Lohmann 已提交
6656 6657
            std::reverse(number_buffer.begin(), number_buffer.begin() + i);
            o.write(number_buffer.data(), static_cast<std::streamsize>(i));
6658
        }
6659

N
Niels Lohmann 已提交
6660 6661 6662 6663 6664 6665 6666 6667
        /*!
        @brief dump a floating-point number

        Dump a given floating-point number to output stream @a o. Works
        internally with @a number_buffer.

        @param[in] x  floating-point number to dump
        */
6668
        void dump_float(number_float_t x)
6669 6670 6671 6672 6673
        {
            // special case for 0.0 and -0.0
            if (x == 0)
            {
                if (std::signbit(x))
6674
                {
6675
                    o.write("-0.0", 4);
6676
                }
6677
                else
6678
                {
6679
                    o.write("0.0", 3);
6680
                }
6681
                return;
6682 6683
            }

6684 6685
            // get number of digits for a text -> float -> text round-trip
            static constexpr auto d = std::numeric_limits<number_float_t>::digits10;
6686

6687
            // the actual conversion
N
Niels Lohmann 已提交
6688 6689
            long len = snprintf(number_buffer.data(), number_buffer.size(),
                                "%.*g", d, x);
6690

6691
            // negative value indicates an error
N
Niels Lohmann 已提交
6692
            assert(len > 0);
6693
            // check if buffer was large enough
N
Niels Lohmann 已提交
6694
            assert(static_cast<size_t>(len) < number_buffer.size());
6695

6696 6697 6698
            // erase thousands separator
            if (thousands_sep != '\0')
            {
N
Niels Lohmann 已提交
6699 6700 6701 6702 6703 6704
                const auto end = std::remove(number_buffer.begin(),
                                             number_buffer.begin() + len,
                                             thousands_sep);
                std::fill(end, number_buffer.end(), '\0');
                assert((end - number_buffer.begin()) <= len);
                len = (end - number_buffer.begin());
6705
            }
6706

6707 6708 6709
            // convert decimal point to '.'
            if (decimal_point != '\0' and decimal_point != '.')
            {
N
Niels Lohmann 已提交
6710
                for (auto& c : number_buffer)
6711
                {
6712
                    if (c == decimal_point)
6713
                    {
6714 6715
                        c = '.';
                        break;
6716 6717
                    }
                }
6718
            }
6719

N
Niels Lohmann 已提交
6720 6721
            o.write(number_buffer.data(), static_cast<std::streamsize>(len));

6722
            // determine if need to append ".0"
N
Niels Lohmann 已提交
6723 6724 6725
            const bool value_is_int_like = std::none_of(number_buffer.begin(),
                                           number_buffer.begin() + len + 1,
                                           [](char c)
6726
            {
N
Niels Lohmann 已提交
6727 6728
                return c == '.' or c == 'e';
            });
6729

6730 6731 6732
            if (value_is_int_like)
            {
                o.write(".0", 2);
6733
            }
6734
        }
6735 6736

      private:
N
Niels Lohmann 已提交
6737
        /// the output of the serializer
6738
        std::ostream& o;
6739 6740

        /// a (hopefully) large enough character buffer
N
Niels Lohmann 已提交
6741
        std::array<char, 64> number_buffer{{}};
6742

N
Niels Lohmann 已提交
6743
        /// the locale
6744
        const std::lconv* loc = nullptr;
N
Niels Lohmann 已提交
6745
        /// the locale's thousand separator character
6746
        const char thousands_sep = '\0';
N
Niels Lohmann 已提交
6747
        /// the locale's decimal point character
6748 6749
        const char decimal_point = '\0';

N
Niels Lohmann 已提交
6750
        /// the indentation string
6751
        string_t indent_string = string_t(512, ' ');
6752 6753 6754
    };

  public:
N
Niels 已提交
6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771
    /*!
    @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 已提交
6772 6773
    @liveexample{The example below shows the serialization with different
    parameters to `width` to adjust the indentation level.,operator_serialize}
N
Niels 已提交
6774

N
Niels 已提交
6775
    @since version 1.0.0
N
Niels 已提交
6776
    */
N
Niels 已提交
6777 6778
    friend std::ostream& operator<<(std::ostream& o, const basic_json& j)
    {
N
Niels 已提交
6779
        // read width member and use it as indentation parameter if nonzero
N
Niels 已提交
6780 6781
        const bool pretty_print = (o.width() > 0);
        const auto indentation = (pretty_print ? o.width() : 0);
N
Niels 已提交
6782

N
Niels 已提交
6783 6784
        // reset width to 0 for subsequent calls to this stream
        o.width(0);
6785

N
Niels 已提交
6786
        // do the actual serialization
6787 6788
        serializer s(o);
        s.dump(j, pretty_print, static_cast<unsigned int>(indentation));
N
Niels 已提交
6789 6790 6791
        return o;
    }

N
Niels 已提交
6792 6793 6794 6795
    /*!
    @brief serialize to stream
    @copydoc operator<<(std::ostream&, const basic_json&)
    */
N
Niels 已提交
6796 6797
    friend std::ostream& operator>>(const basic_json& j, std::ostream& o)
    {
N
Niels 已提交
6798
        return o << j;
N
Niels 已提交
6799 6800
    }

N
Niels 已提交
6801 6802
    /// @}

N
Niels 已提交
6803 6804 6805 6806 6807

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

N
Niels 已提交
6808 6809 6810
    /// @name deserialization
    /// @{

N
Niels 已提交
6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872
    /*!
    @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)
    */
6873 6874 6875 6876 6877
    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 已提交
6878 6879 6880 6881 6882
                            const parser_callback_t cb = nullptr)
    {
        return parser(reinterpret_cast<const char*>(s), cb).parse();
    }

N
Niels 已提交
6883 6884 6885 6886
    /*!
    @brief deserialize from stream

    @param[in,out] i  stream to read a serialized JSON value from
N
Niels 已提交
6887 6888 6889
    @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 已提交
6890 6891 6892 6893 6894 6895 6896

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

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

6902
    @sa @ref parse(const CharT, const parser_callback_t) for a version
N
Niels 已提交
6903
    that reads from a string
N
Niels 已提交
6904

N
Niels 已提交
6905
    @since version 1.0.0
N
Niels 已提交
6906
    */
N
Niels 已提交
6907 6908
    static basic_json parse(std::istream& i,
                            const parser_callback_t cb = nullptr)
N
Niels 已提交
6909
    {
N
Niels 已提交
6910
        return parser(i, cb).parse();
N
Niels 已提交
6911 6912
    }

N
Niels 已提交
6913
    /*!
N
Niels 已提交
6914
    @copydoc parse(std::istream&, const parser_callback_t)
N
Niels 已提交
6915
    */
N
Niels 已提交
6916 6917
    static basic_json parse(std::istream&& i,
                            const parser_callback_t cb = nullptr)
N
Cleanup  
Niels 已提交
6918 6919 6920 6921
    {
        return parser(i, cb).parse();
    }

6922
    /*!
N
Niels 已提交
6923
    @brief deserialize from an iterator range with contiguous storage
6924

6925 6926
    This function reads from an iterator range of a container with contiguous
    storage of 1-byte values. Compatible container types include
6927 6928 6929 6930 6931 6932 6933 6934 6935
    `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
6936
    with a static assertion.**
6937

N
Niels 已提交
6938 6939 6940 6941
    @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.
6942

N
Niels 已提交
6943
    @tparam IteratorType iterator of container with contiguous storage
N
Niels 已提交
6944 6945 6946
    @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
6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957
    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 已提交
6958 6959
    @liveexample{The example below demonstrates the `parse()` function reading
    from an iterator range.,parse__iteratortype__parser_callback_t}
6960 6961 6962

    @since version 2.0.3
    */
N
Niels 已提交
6963 6964 6965 6966
    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>
6967 6968 6969 6970 6971
    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 已提交
6972
        assert(std::accumulate(first, last, std::pair<bool, int>(true, 0),
6973 6974 6975 6976 6977 6978 6979
                               [&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
6980 6981
        static_assert(sizeof(typename std::iterator_traits<IteratorType>::value_type) == 1,
                      "each element in the iterator range must have the size of 1 byte");
6982

6983 6984 6985 6986 6987 6988
        // 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();
        }
6989 6990 6991 6992

        return parser(first, last, cb).parse();
    }

N
Niels 已提交
6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013
    /*!
    @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 已提交
7014
    @tparam ContiguousContainer container type with contiguous storage
N
Niels 已提交
7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032
    @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 已提交
7033
    template<class ContiguousContainer, typename std::enable_if<
N
Niels 已提交
7034
                 not std::is_pointer<ContiguousContainer>::value and
7035 7036
                 std::is_base_of<
                     std::random_access_iterator_tag,
N
Niels 已提交
7037
                     typename std::iterator_traits<decltype(std::begin(std::declval<ContiguousContainer const>()))>::iterator_category>::value
7038 7039 7040 7041 7042 7043 7044 7045
                 , 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 已提交
7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058
    /*!
    @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 已提交
7059 7060
    @note A UTF-8 byte order mark is silently ignored.

N
Niels 已提交
7061 7062 7063
    @liveexample{The example below shows how a JSON value is constructed by
    reading a serialization from a stream.,operator_deserialize}

N
Niels 已提交
7064 7065
    @sa parse(std::istream&, const parser_callback_t) for a variant with a
    parser callback function to filter values while parsing
N
Niels 已提交
7066

N
Niels 已提交
7067
    @since version 1.0.0
N
Niels 已提交
7068 7069
    */
    friend std::istream& operator<<(basic_json& j, std::istream& i)
N
Niels 已提交
7070 7071 7072 7073 7074
    {
        j = parser(i).parse();
        return i;
    }

N
Niels 已提交
7075 7076 7077 7078 7079
    /*!
    @brief deserialize from stream
    @copydoc operator<<(basic_json&, std::istream&)
    */
    friend std::istream& operator>>(std::istream& i, basic_json& j)
N
Niels 已提交
7080 7081 7082 7083 7084
    {
        j = parser(i).parse();
        return i;
    }

N
Niels 已提交
7085 7086
    /// @}

N
Niels Lohmann 已提交
7087 7088 7089
    //////////////////////////////////////////
    // binary serialization/deserialization //
    //////////////////////////////////////////
N
Niels 已提交
7090

N
Niels Lohmann 已提交
7091
    /// @name binary serialization/deserialization support
N
Niels 已提交
7092 7093 7094
    /// @{

  private:
7095 7096 7097 7098 7099
    /*!
    @note Some code in the switch cases has been copied, because otherwise
          copilers would complain about implicit fallthrough and there is no
          portable attribute to mute such warnings.
    */
7100 7101 7102 7103 7104 7105 7106 7107 7108
    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:
            {
7109 7110 7111 7112
                vec.push_back(static_cast<uint8_t>((static_cast<uint64_t>(number) >> 070) & 0xff));
                vec.push_back(static_cast<uint8_t>((static_cast<uint64_t>(number) >> 060) & 0xff));
                vec.push_back(static_cast<uint8_t>((static_cast<uint64_t>(number) >> 050) & 0xff));
                vec.push_back(static_cast<uint8_t>((static_cast<uint64_t>(number) >> 040) & 0xff));
7113 7114 7115 7116 7117
                vec.push_back(static_cast<uint8_t>((number >> 030) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 020) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 010) & 0xff));
                vec.push_back(static_cast<uint8_t>(number & 0xff));
                break;
7118 7119 7120 7121 7122 7123
            }

            case 4:
            {
                vec.push_back(static_cast<uint8_t>((number >> 030) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 020) & 0xff));
7124 7125 7126
                vec.push_back(static_cast<uint8_t>((number >> 010) & 0xff));
                vec.push_back(static_cast<uint8_t>(number & 0xff));
                break;
7127 7128 7129 7130 7131
            }

            case 2:
            {
                vec.push_back(static_cast<uint8_t>((number >> 010) & 0xff));
7132 7133
                vec.push_back(static_cast<uint8_t>(number & 0xff));
                break;
7134 7135 7136 7137 7138 7139 7140 7141 7142 7143
            }

            case 1:
            {
                vec.push_back(static_cast<uint8_t>(number & 0xff));
                break;
            }
        }
    }

7144 7145 7146 7147 7148 7149 7150 7151
    /*!
    @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
7152
    @param[in] current_index  the position in the vector after which to read
7153 7154 7155 7156 7157 7158 7159 7160

    @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

7161 7162 7163 7164
    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.

7165 7166
    Precondition:

7167 7168 7169
    vec:   |   |   | a | b | c | d |      T: |   |   |   |   |
                 ^               ^             ^                ^
           current_index         i            ptr        sizeof(T)
7170 7171 7172

    Postcondition:

7173 7174 7175
    vec:   |   |   | a | b | c | d |      T: | d | c | b | a |
                 ^   ^                                     ^
                 |   i                                    ptr
7176 7177
           current_index

7178
    @sa Code adapted from <http://stackoverflow.com/a/41031865/266378>.
7179 7180 7181
    */
    template<typename T>
    static T get_from_vector(const std::vector<uint8_t>& vec, const size_t current_index)
7182
    {
7183 7184
        if (current_index + sizeof(T) + 1 > vec.size())
        {
7185
            JSON_THROW(std::out_of_range("cannot read " + std::to_string(sizeof(T)) + " bytes from vector"));
7186 7187
        }

7188
        T result;
N
Niels Lohmann 已提交
7189
        auto* ptr = reinterpret_cast<uint8_t*>(&result);
7190
        for (size_t i = 0; i < sizeof(T); ++i)
7191
        {
7192
            *ptr++ = vec[current_index + sizeof(T) - i];
7193 7194
        }
        return result;
7195 7196
    }

7197 7198 7199 7200 7201 7202 7203 7204 7205 7206
    /*!
    @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 已提交
7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226
    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:
            {
7227
                if (j.m_value.number_integer >= 0)
N
Niels 已提交
7228
                {
7229
                    // MessagePack does not differentiate between positive
N
Niels Lohmann 已提交
7230 7231 7232
                    // signed integers and unsigned integers. Therefore, we
                    // used the code from the value_t::number_unsigned case
                    // here.
7233 7234 7235 7236 7237
                    if (j.m_value.number_unsigned < 128)
                    {
                        // positive fixnum
                        add_to_vector(v, 1, j.m_value.number_unsigned);
                    }
7238
                    else if (j.m_value.number_unsigned <= std::numeric_limits<uint8_t>::max())
7239 7240 7241 7242 7243
                    {
                        // uint 8
                        v.push_back(0xcc);
                        add_to_vector(v, 1, j.m_value.number_unsigned);
                    }
7244
                    else if (j.m_value.number_unsigned <= std::numeric_limits<uint16_t>::max())
7245 7246 7247 7248 7249
                    {
                        // uint 16
                        v.push_back(0xcd);
                        add_to_vector(v, 2, j.m_value.number_unsigned);
                    }
7250
                    else if (j.m_value.number_unsigned <= std::numeric_limits<uint32_t>::max())
7251 7252 7253 7254 7255
                    {
                        // uint 32
                        v.push_back(0xce);
                        add_to_vector(v, 4, j.m_value.number_unsigned);
                    }
7256
                    else if (j.m_value.number_unsigned <= std::numeric_limits<uint64_t>::max())
7257 7258 7259 7260 7261
                    {
                        // uint 64
                        v.push_back(0xcf);
                        add_to_vector(v, 8, j.m_value.number_unsigned);
                    }
N
Niels 已提交
7262
                }
7263
                else
N
Niels 已提交
7264
                {
7265 7266 7267 7268 7269
                    if (j.m_value.number_integer >= -32)
                    {
                        // negative fixnum
                        add_to_vector(v, 1, j.m_value.number_integer);
                    }
7270
                    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())
7271 7272 7273 7274 7275
                    {
                        // int 8
                        v.push_back(0xd0);
                        add_to_vector(v, 1, j.m_value.number_integer);
                    }
7276
                    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())
7277 7278 7279 7280 7281
                    {
                        // int 16
                        v.push_back(0xd1);
                        add_to_vector(v, 2, j.m_value.number_integer);
                    }
7282
                    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())
7283 7284 7285 7286 7287
                    {
                        // int 32
                        v.push_back(0xd2);
                        add_to_vector(v, 4, j.m_value.number_integer);
                    }
7288
                    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())
7289 7290 7291 7292 7293
                    {
                        // int 64
                        v.push_back(0xd3);
                        add_to_vector(v, 8, j.m_value.number_integer);
                    }
N
Niels 已提交
7294 7295 7296 7297 7298 7299 7300 7301 7302
                }
                break;
            }

            case value_t::number_unsigned:
            {
                if (j.m_value.number_unsigned < 128)
                {
                    // positive fixnum
7303
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels 已提交
7304
                }
7305
                else if (j.m_value.number_unsigned <= std::numeric_limits<uint8_t>::max())
N
Niels 已提交
7306 7307 7308
                {
                    // uint 8
                    v.push_back(0xcc);
7309
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels 已提交
7310
                }
7311
                else if (j.m_value.number_unsigned <= std::numeric_limits<uint16_t>::max())
N
Niels 已提交
7312 7313 7314
                {
                    // uint 16
                    v.push_back(0xcd);
7315
                    add_to_vector(v, 2, j.m_value.number_unsigned);
N
Niels 已提交
7316
                }
7317
                else if (j.m_value.number_unsigned <= std::numeric_limits<uint32_t>::max())
N
Niels 已提交
7318 7319 7320
                {
                    // uint 32
                    v.push_back(0xce);
7321
                    add_to_vector(v, 4, j.m_value.number_unsigned);
N
Niels 已提交
7322
                }
7323
                else if (j.m_value.number_unsigned <= std::numeric_limits<uint64_t>::max())
N
Niels 已提交
7324 7325 7326
                {
                    // uint 64
                    v.push_back(0xcf);
7327
                    add_to_vector(v, 8, j.m_value.number_unsigned);
N
Niels 已提交
7328 7329 7330 7331 7332 7333 7334 7335
                }
                break;
            }

            case value_t::number_float:
            {
                // float 64
                v.push_back(0xcb);
N
Niels Lohmann 已提交
7336
                const auto* helper = reinterpret_cast<const uint8_t*>(&(j.m_value.number_float));
N
Niels 已提交
7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355
                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);
7356
                    add_to_vector(v, 1, N);
N
Niels 已提交
7357 7358 7359 7360 7361
                }
                else if (N <= 65535)
                {
                    // str 16
                    v.push_back(0xda);
7362
                    add_to_vector(v, 2, N);
N
Niels 已提交
7363 7364 7365 7366 7367
                }
                else if (N <= 4294967295)
                {
                    // str 32
                    v.push_back(0xdb);
7368
                    add_to_vector(v, 4, N);
N
Niels 已提交
7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388
                }

                // 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);
7389
                    add_to_vector(v, 2, N);
N
Niels 已提交
7390 7391 7392 7393 7394
                }
                else if (N <= 0xffffffff)
                {
                    // array 32
                    v.push_back(0xdd);
7395
                    add_to_vector(v, 4, N);
N
Niels 已提交
7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417
                }

                // 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);
7418
                    add_to_vector(v, 2, N);
N
Niels 已提交
7419 7420 7421 7422 7423
                }
                else if (N <= 4294967295)
                {
                    // map 32
                    v.push_back(0xdf);
7424
                    add_to_vector(v, 4, N);
N
Niels 已提交
7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442
                }

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

7443 7444 7445 7446 7447 7448 7449 7450 7451 7452
    /*!
    @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 已提交
7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475
    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.
7476
                    if (j.m_value.number_integer <= 0x17)
N
Niels Lohmann 已提交
7477
                    {
7478
                        add_to_vector(v, 1, j.m_value.number_integer);
N
Niels Lohmann 已提交
7479
                    }
7480
                    else if (j.m_value.number_integer <= std::numeric_limits<uint8_t>::max())
N
Niels Lohmann 已提交
7481 7482 7483
                    {
                        v.push_back(0x18);
                        // one-byte uint8_t
7484
                        add_to_vector(v, 1, j.m_value.number_integer);
N
Niels Lohmann 已提交
7485
                    }
7486
                    else if (j.m_value.number_integer <= std::numeric_limits<uint16_t>::max())
N
Niels Lohmann 已提交
7487 7488 7489
                    {
                        v.push_back(0x19);
                        // two-byte uint16_t
7490
                        add_to_vector(v, 2, j.m_value.number_integer);
N
Niels Lohmann 已提交
7491
                    }
7492
                    else if (j.m_value.number_integer <= std::numeric_limits<uint32_t>::max())
N
Niels Lohmann 已提交
7493 7494 7495
                    {
                        v.push_back(0x1a);
                        // four-byte uint32_t
7496
                        add_to_vector(v, 4, j.m_value.number_integer);
N
Niels Lohmann 已提交
7497
                    }
7498
                    else
N
Niels Lohmann 已提交
7499
                    {
N
Niels Lohmann 已提交
7500
                        v.push_back(0x1b);
N
Niels Lohmann 已提交
7501
                        // eight-byte uint64_t
7502
                        add_to_vector(v, 8, j.m_value.number_integer);
N
Niels Lohmann 已提交
7503 7504 7505 7506
                    }
                }
                else
                {
N
Niels Lohmann 已提交
7507 7508
                    // The conversions below encode the sign in the first
                    // byte, and the value is converted to a positive number.
N
Niels Lohmann 已提交
7509
                    const auto positive_number = -1 - j.m_value.number_integer;
7510
                    if (j.m_value.number_integer >= -24)
N
Niels Lohmann 已提交
7511 7512 7513
                    {
                        v.push_back(static_cast<uint8_t>(0x20 + positive_number));
                    }
7514
                    else if (positive_number <= std::numeric_limits<uint8_t>::max())
N
Niels Lohmann 已提交
7515 7516 7517
                    {
                        // int 8
                        v.push_back(0x38);
7518
                        add_to_vector(v, 1, positive_number);
N
Niels Lohmann 已提交
7519
                    }
7520
                    else if (positive_number <= std::numeric_limits<uint16_t>::max())
N
Niels Lohmann 已提交
7521 7522 7523
                    {
                        // int 16
                        v.push_back(0x39);
7524
                        add_to_vector(v, 2, positive_number);
N
Niels Lohmann 已提交
7525
                    }
7526
                    else if (positive_number <= std::numeric_limits<uint32_t>::max())
N
Niels Lohmann 已提交
7527 7528 7529
                    {
                        // int 32
                        v.push_back(0x3a);
7530
                        add_to_vector(v, 4, positive_number);
N
Niels Lohmann 已提交
7531
                    }
7532
                    else
N
Niels Lohmann 已提交
7533 7534 7535
                    {
                        // int 64
                        v.push_back(0x3b);
7536
                        add_to_vector(v, 8, positive_number);
N
Niels Lohmann 已提交
7537 7538
                    }
                }
7539
                break;
N
Niels Lohmann 已提交
7540 7541 7542 7543
            }

            case value_t::number_unsigned:
            {
7544
                if (j.m_value.number_unsigned <= 0x17)
N
Niels Lohmann 已提交
7545 7546 7547 7548 7549 7550 7551
                {
                    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
7552
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7553 7554 7555 7556 7557
                }
                else if (j.m_value.number_unsigned <= 0xffff)
                {
                    v.push_back(0x19);
                    // two-byte uint16_t
7558
                    add_to_vector(v, 2, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7559 7560 7561 7562 7563
                }
                else if (j.m_value.number_unsigned <= 0xffffffff)
                {
                    v.push_back(0x1a);
                    // four-byte uint32_t
7564
                    add_to_vector(v, 4, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7565 7566 7567
                }
                else if (j.m_value.number_unsigned <= 0xffffffffffffffff)
                {
N
Niels Lohmann 已提交
7568
                    v.push_back(0x1b);
N
Niels Lohmann 已提交
7569
                    // eight-byte uint64_t
7570
                    add_to_vector(v, 8, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7571 7572 7573 7574 7575 7576 7577 7578
                }
                break;
            }

            case value_t::number_float:
            {
                // Double-Precision Float
                v.push_back(0xfb);
N
Niels Lohmann 已提交
7579
                const auto* helper = reinterpret_cast<const uint8_t*>(&(j.m_value.number_float));
N
Niels Lohmann 已提交
7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591
                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)
                {
7592
                    v.push_back(0x60 + static_cast<uint8_t>(N));  // 1 byte for string + size
N
Niels Lohmann 已提交
7593 7594 7595
                }
                else if (N <= 0xff)
                {
7596
                    v.push_back(0x78);  // one-byte uint8_t for N
7597
                    add_to_vector(v, 1, N);
N
Niels Lohmann 已提交
7598 7599 7600
                }
                else if (N <= 0xffff)
                {
7601
                    v.push_back(0x79);  // two-byte uint16_t for N
7602
                    add_to_vector(v, 2, N);
N
Niels Lohmann 已提交
7603 7604 7605
                }
                else if (N <= 0xffffffff)
                {
7606
                    v.push_back(0x7a); // four-byte uint32_t for N
7607
                    add_to_vector(v, 4, N);
N
Niels Lohmann 已提交
7608
                }
7609
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
7610 7611
                else if (N <= 0xffffffffffffffff)
                {
7612
                    v.push_back(0x7b);  // eight-byte uint64_t for N
7613
                    add_to_vector(v, 8, N);
N
Niels Lohmann 已提交
7614
                }
7615
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627

                // 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)
                {
7628
                    v.push_back(0x80 + static_cast<uint8_t>(N));  // 1 byte for array + size
N
Niels Lohmann 已提交
7629 7630 7631
                }
                else if (N <= 0xff)
                {
7632
                    v.push_back(0x98);  // one-byte uint8_t for N
7633
                    add_to_vector(v, 1, N);
N
Niels Lohmann 已提交
7634 7635 7636
                }
                else if (N <= 0xffff)
                {
7637
                    v.push_back(0x99);  // two-byte uint16_t for N
7638
                    add_to_vector(v, 2, N);
N
Niels Lohmann 已提交
7639 7640 7641
                }
                else if (N <= 0xffffffff)
                {
7642
                    v.push_back(0x9a);  // four-byte uint32_t for N
7643
                    add_to_vector(v, 4, N);
N
Niels Lohmann 已提交
7644
                }
7645
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
7646 7647
                else if (N <= 0xffffffffffffffff)
                {
7648
                    v.push_back(0x9b);  // eight-byte uint64_t for N
7649
                    add_to_vector(v, 8, N);
N
Niels Lohmann 已提交
7650
                }
7651
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665

                // 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)
                {
7666
                    v.push_back(0xa0 + static_cast<uint8_t>(N));  // 1 byte for object + size
N
Niels Lohmann 已提交
7667 7668 7669 7670
                }
                else if (N <= 0xff)
                {
                    v.push_back(0xb8);
7671
                    add_to_vector(v, 1, N);  // one-byte uint8_t for N
N
Niels Lohmann 已提交
7672 7673 7674 7675
                }
                else if (N <= 0xffff)
                {
                    v.push_back(0xb9);
7676
                    add_to_vector(v, 2, N);  // two-byte uint16_t for N
N
Niels Lohmann 已提交
7677 7678 7679 7680
                }
                else if (N <= 0xffffffff)
                {
                    v.push_back(0xba);
7681
                    add_to_vector(v, 4, N);  // four-byte uint32_t for N
N
Niels Lohmann 已提交
7682
                }
7683
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
7684 7685 7686
                else if (N <= 0xffffffffffffffff)
                {
                    v.push_back(0xbb);
7687
                    add_to_vector(v, 8, N);  // eight-byte uint64_t for N
N
Niels Lohmann 已提交
7688
                }
7689
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706

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

7707 7708 7709 7710 7711 7712

    /*
    @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 已提交
7713 7714 7715
    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.
7716

N
Niels Lohmann 已提交
7717 7718
    This function checks whether reading the bytes is safe; that is, offset is
    a valid index in the vector, offset+len
7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734

    @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)
        {
7735
            JSON_THROW(std::out_of_range("len out of range"));
7736 7737 7738 7739 7740
        }

        // second case: adding offset would result in overflow
        if ((size > (std::numeric_limits<size_t>::max() - offset)))
        {
7741
            JSON_THROW(std::out_of_range("len+offset out of range"));
7742
        }
N
Niels Lohmann 已提交
7743 7744 7745 7746

        // last case: reading past the end of the vector
        if (len + offset > size)
        {
7747
            JSON_THROW(std::out_of_range("len+offset out of range"));
N
Niels Lohmann 已提交
7748
        }
7749 7750
    }

N
Niels 已提交
7751
    /*!
7752 7753
    @brief create a JSON value from a given MessagePack vector

N
Niels 已提交
7754 7755
    @param[in] v  MessagePack serialization
    @param[in] idx  byte index to start reading from @a v
7756 7757 7758 7759 7760 7761 7762 7763

    @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 已提交
7764 7765 7766
    */
    static basic_json from_msgpack_internal(const std::vector<uint8_t>& v, size_t& idx)
    {
N
Niels Lohmann 已提交
7767 7768 7769
        // make sure reading 1 byte is safe
        check_length(v.size(), 1, idx);

N
Niels 已提交
7770 7771 7772
        // store and increment index
        const size_t current_idx = idx++;

N
Niels Lohmann 已提交
7773
        if (v[current_idx] <= 0xbf)
N
Niels 已提交
7774
        {
N
Niels Lohmann 已提交
7775
            if (v[current_idx] <= 0x7f) // positive fixint
N
Niels 已提交
7776
            {
N
Niels Lohmann 已提交
7777
                return v[current_idx];
N
Niels 已提交
7778
            }
N
Niels Lohmann 已提交
7779
            if (v[current_idx] <= 0x8f) // fixmap
N
Niels 已提交
7780
            {
N
Niels Lohmann 已提交
7781 7782 7783 7784 7785 7786 7787 7788
                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 已提交
7789
            }
N
Niels Lohmann 已提交
7790
            else if (v[current_idx] <= 0x9f) // fixarray
N
Niels 已提交
7791
            {
N
Niels Lohmann 已提交
7792 7793 7794 7795 7796 7797 7798
                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 已提交
7799
            }
N
Niels Lohmann 已提交
7800
            else // fixstr
N
Niels 已提交
7801
            {
N
Niels Lohmann 已提交
7802 7803 7804
                const size_t len = v[current_idx] & 0x1f;
                const size_t offset = current_idx + 1;
                idx += len; // skip content bytes
7805
                check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
7806
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels 已提交
7807 7808
            }
        }
N
Niels Lohmann 已提交
7809
        else if (v[current_idx] >= 0xe0) // negative fixint
N
Niels 已提交
7810
        {
N
Niels Lohmann 已提交
7811
            return static_cast<int8_t>(v[current_idx]);
N
Niels 已提交
7812
        }
N
Niels Lohmann 已提交
7813
        else
N
Niels 已提交
7814
        {
N
Niels Lohmann 已提交
7815
            switch (v[current_idx])
N
Niels 已提交
7816
            {
N
Niels Lohmann 已提交
7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837
                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 已提交
7838
                        reinterpret_cast<uint8_t*>(&res)[sizeof(float) - byte - 1] = v.at(current_idx + 1 + byte);
N
Niels Lohmann 已提交
7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849
                    }
                    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 已提交
7850
                        reinterpret_cast<uint8_t*>(&res)[sizeof(double) - byte - 1] = v.at(current_idx + 1 + byte);
N
Niels Lohmann 已提交
7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905
                    }
                    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
                {
7906
                    const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
N
Niels Lohmann 已提交
7907 7908
                    const size_t offset = current_idx + 2;
                    idx += len + 1; // skip size byte + content bytes
7909
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
7910 7911 7912 7913 7914
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xda: // str 16
                {
7915
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
7916 7917
                    const size_t offset = current_idx + 3;
                    idx += len + 2; // skip 2 size bytes + content bytes
7918
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
7919 7920 7921 7922 7923
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xdb: // str 32
                {
7924
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
7925 7926
                    const size_t offset = current_idx + 5;
                    idx += len + 4; // skip 4 size bytes + content bytes
7927
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
7928 7929 7930 7931 7932 7933
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xdc: // array 16
                {
                    basic_json result = value_t::array;
7934
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945
                    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;
7946
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957
                    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;
7958
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970
                    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;
7971
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982
                    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:
                {
7983
                    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 已提交
7984
                }
N
Niels 已提交
7985 7986 7987 7988
            }
        }
    }

7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002
    /*!
    @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 已提交
8003 8004 8005 8006 8007
    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++;

8008
        switch (v.at(current_idx))
8009
        {
N
Niels Lohmann 已提交
8010
            // Integer 0x00..0x17 (0..23)
8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034
            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:
8035
            {
8036
                return v[current_idx];
8037
            }
8038

N
Niels Lohmann 已提交
8039
            case 0x18: // Unsigned integer (one-byte uint8_t follows)
N
Niels Lohmann 已提交
8040
            {
8041 8042
                idx += 1; // skip content byte
                return get_from_vector<uint8_t>(v, current_idx);
N
Niels Lohmann 已提交
8043
            }
8044

N
Niels Lohmann 已提交
8045
            case 0x19: // Unsigned integer (two-byte uint16_t follows)
N
Niels Lohmann 已提交
8046
            {
8047 8048
                idx += 2; // skip 2 content bytes
                return get_from_vector<uint16_t>(v, current_idx);
N
Niels Lohmann 已提交
8049
            }
8050

N
Niels Lohmann 已提交
8051
            case 0x1a: // Unsigned integer (four-byte uint32_t follows)
N
Niels Lohmann 已提交
8052
            {
8053 8054
                idx += 4; // skip 4 content bytes
                return get_from_vector<uint32_t>(v, current_idx);
N
Niels Lohmann 已提交
8055
            }
8056

N
Niels Lohmann 已提交
8057
            case 0x1b: // Unsigned integer (eight-byte uint64_t follows)
N
Niels Lohmann 已提交
8058
            {
8059 8060
                idx += 8; // skip 8 content bytes
                return get_from_vector<uint64_t>(v, current_idx);
N
Niels Lohmann 已提交
8061
            }
8062

N
Niels Lohmann 已提交
8063
            // Negative integer -1-0x00..-1-0x17 (-1..-24)
8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087
            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 已提交
8088
            {
8089
                return static_cast<int8_t>(0x20 - 1 - v[current_idx]);
N
Niels Lohmann 已提交
8090
            }
8091

N
Niels Lohmann 已提交
8092
            case 0x38: // Negative integer (one-byte uint8_t follows)
8093
            {
8094 8095
                idx += 1; // skip content byte
                // must be uint8_t !
8096
                return static_cast<number_integer_t>(-1) - get_from_vector<uint8_t>(v, current_idx);
8097
            }
8098

N
Niels Lohmann 已提交
8099
            case 0x39: // Negative integer -1-n (two-byte uint16_t follows)
N
Niels Lohmann 已提交
8100
            {
8101
                idx += 2; // skip 2 content bytes
8102
                return static_cast<number_integer_t>(-1) - get_from_vector<uint16_t>(v, current_idx);
N
Niels Lohmann 已提交
8103
            }
8104

N
Niels Lohmann 已提交
8105
            case 0x3a: // Negative integer -1-n (four-byte uint32_t follows)
N
Niels Lohmann 已提交
8106
            {
8107
                idx += 4; // skip 4 content bytes
8108
                return static_cast<number_integer_t>(-1) - get_from_vector<uint32_t>(v, current_idx);
N
Niels Lohmann 已提交
8109
            }
8110

N
Niels Lohmann 已提交
8111
            case 0x3b: // Negative integer -1-n (eight-byte uint64_t follows)
N
Niels Lohmann 已提交
8112
            {
8113
                idx += 8; // skip 8 content bytes
8114
                return static_cast<number_integer_t>(-1) - static_cast<number_integer_t>(get_from_vector<uint64_t>(v, current_idx));
N
Niels Lohmann 已提交
8115
            }
8116

N
Niels Lohmann 已提交
8117
            // UTF-8 string (0x00..0x17 bytes follow)
8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141
            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 已提交
8142
            {
8143
                const auto len = static_cast<size_t>(v[current_idx] - 0x60);
8144 8145
                const size_t offset = current_idx + 1;
                idx += len; // skip content bytes
8146
                check_length(v.size(), len, offset);
8147
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels Lohmann 已提交
8148
            }
8149

N
Niels Lohmann 已提交
8150
            case 0x78: // UTF-8 string (one-byte uint8_t for n follows)
N
Niels Lohmann 已提交
8151
            {
8152
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
8153 8154
                const size_t offset = current_idx + 2;
                idx += len + 1; // skip size byte + content bytes
8155
                check_length(v.size(), len, offset);
8156
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels Lohmann 已提交
8157
            }
8158

N
Niels Lohmann 已提交
8159
            case 0x79: // UTF-8 string (two-byte uint16_t for n follow)
8160
            {
8161
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
8162 8163
                const size_t offset = current_idx + 3;
                idx += len + 2; // skip 2 size bytes + content bytes
8164
                check_length(v.size(), len, offset);
8165
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
8166
            }
8167

N
Niels Lohmann 已提交
8168
            case 0x7a: // UTF-8 string (four-byte uint32_t for n follow)
8169
            {
8170
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
8171 8172
                const size_t offset = current_idx + 5;
                idx += len + 4; // skip 4 size bytes + content bytes
8173
                check_length(v.size(), len, offset);
8174
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
8175
            }
8176

N
Niels Lohmann 已提交
8177
            case 0x7b: // UTF-8 string (eight-byte uint64_t for n follow)
8178
            {
8179
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
8180 8181
                const size_t offset = current_idx + 9;
                idx += len + 8; // skip 8 size bytes + content bytes
8182
                check_length(v.size(), len, offset);
8183
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
8184
            }
8185 8186

            case 0x7f: // UTF-8 string (indefinite length)
8187
            {
8188
                std::string result;
8189
                while (v.at(idx) != 0xff)
8190 8191 8192 8193 8194 8195 8196
                {
                    string_t s = from_cbor_internal(v, idx);
                    result += s;
                }
                // skip break byte (0xFF)
                idx += 1;
                return result;
8197
            }
8198

N
Niels Lohmann 已提交
8199
            // array (0x00..0x17 data items follow)
8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223
            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 已提交
8224
            {
8225
                basic_json result = value_t::array;
8226
                const auto len = static_cast<size_t>(v[current_idx] - 0x80);
8227 8228 8229 8230 8231
                for (size_t i = 0; i < len; ++i)
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                return result;
N
Niels Lohmann 已提交
8232
            }
8233

N
Niels Lohmann 已提交
8234
            case 0x98: // array (one-byte uint8_t for n follows)
N
Niels Lohmann 已提交
8235
            {
8236
                basic_json result = value_t::array;
8237
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
8238 8239 8240 8241 8242 8243
                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 已提交
8244 8245
            }

N
Niels Lohmann 已提交
8246
            case 0x99: // array (two-byte uint16_t for n follow)
8247 8248
            {
                basic_json result = value_t::array;
8249
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
8250 8251 8252 8253 8254 8255 8256 8257
                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 已提交
8258
            case 0x9a: // array (four-byte uint32_t for n follow)
8259 8260
            {
                basic_json result = value_t::array;
8261
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
8262 8263 8264 8265 8266 8267 8268 8269
                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 已提交
8270
            case 0x9b: // array (eight-byte uint64_t for n follow)
8271 8272
            {
                basic_json result = value_t::array;
8273
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284
                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;
8285
                while (v.at(idx) != 0xff)
8286 8287 8288 8289 8290 8291 8292 8293
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                // skip break byte (0xFF)
                idx += 1;
                return result;
            }

N
Niels Lohmann 已提交
8294
            // map (0x00..0x17 pairs of data items follow)
8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320
            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;
8321
                const auto len = static_cast<size_t>(v[current_idx] - 0xa0);
8322 8323 8324 8325 8326 8327 8328 8329
                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 已提交
8330
            case 0xb8: // map (one-byte uint8_t for n follows)
8331 8332
            {
                basic_json result = value_t::object;
8333
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
8334 8335 8336 8337 8338 8339 8340 8341 8342
                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 已提交
8343
            case 0xb9: // map (two-byte uint16_t for n follow)
8344 8345
            {
                basic_json result = value_t::object;
8346
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
8347 8348 8349 8350 8351 8352 8353 8354 8355
                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 已提交
8356
            case 0xba: // map (four-byte uint32_t for n follow)
8357 8358
            {
                basic_json result = value_t::object;
8359
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
8360 8361 8362 8363 8364 8365 8366 8367 8368
                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 已提交
8369
            case 0xbb: // map (eight-byte uint64_t for n follow)
8370 8371
            {
                basic_json result = value_t::object;
8372
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384
                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;
8385
                while (v.at(idx) != 0xff)
8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409
                {
                    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 已提交
8410
            case 0xf9: // Half-Precision Float (two-byte IEEE 754)
8411 8412 8413 8414
            {
                idx += 2; // skip two content bytes

                // code from RFC 7049, Appendix D, Figure 3:
N
Niels Lohmann 已提交
8415 8416 8417 8418 8419 8420
                // 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.
8421
                const int half = (v.at(current_idx + 1) << 8) + v.at(current_idx + 2);
8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434
                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
                {
8435 8436 8437
                    val = mant == 0
                          ? std::numeric_limits<double>::infinity()
                          : std::numeric_limits<double>::quiet_NaN();
8438
                }
N
Niels Lohmann 已提交
8439
                return (half & 0x8000) != 0 ? -val : val;
8440 8441
            }

N
Niels Lohmann 已提交
8442
            case 0xfa: // Single-Precision Float (four-byte IEEE 754)
8443 8444 8445 8446 8447
            {
                // copy bytes in reverse order into the float variable
                float res;
                for (size_t byte = 0; byte < sizeof(float); ++byte)
                {
N
Niels Lohmann 已提交
8448
                    reinterpret_cast<uint8_t*>(&res)[sizeof(float) - byte - 1] = v.at(current_idx + 1 + byte);
8449 8450 8451 8452 8453
                }
                idx += sizeof(float); // skip content bytes
                return res;
            }

N
Niels Lohmann 已提交
8454
            case 0xfb: // Double-Precision Float (eight-byte IEEE 754)
8455 8456 8457 8458 8459
            {
                // copy bytes in reverse order into the double variable
                double res;
                for (size_t byte = 0; byte < sizeof(double); ++byte)
                {
N
Niels Lohmann 已提交
8460
                    reinterpret_cast<uint8_t*>(&res)[sizeof(double) - byte - 1] = v.at(current_idx + 1 + byte);
8461 8462 8463 8464 8465
                }
                idx += sizeof(double); // skip content bytes
                return res;
            }

N
Niels Lohmann 已提交
8466
            default: // anything else (0xFF is handled inside the other types)
8467
            {
8468
                JSON_THROW(std::invalid_argument("error parsing a CBOR @ " + std::to_string(current_idx) + ": " + std::to_string(static_cast<int>(v[current_idx]))));
8469 8470
            }
        }
N
Niels Lohmann 已提交
8471 8472
    }

N
Niels 已提交
8473 8474
  public:
    /*!
8475 8476 8477 8478 8479 8480
    @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 已提交
8481
    @param[in] j  JSON value to serialize
8482 8483 8484 8485 8486 8487 8488 8489
    @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
8490 8491
    @sa @ref from_msgpack(const std::vector<uint8_t>&, const size_t) for the
        analogous deserialization
8492
    @sa @ref to_cbor(const basic_json& for the related CBOR format
8493 8494

    @since version 2.0.9
N
Niels 已提交
8495 8496 8497 8498 8499 8500 8501 8502
    */
    static std::vector<uint8_t> to_msgpack(const basic_json& j)
    {
        std::vector<uint8_t> result;
        to_msgpack_internal(j, result);
        return result;
    }

8503 8504 8505 8506 8507 8508 8509
    /*!
    @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
8510
    @param[in] start_index the index to start reading from @a v (0 by default)
8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523
    @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
8524 8525 8526
    @sa @ref from_cbor(const std::vector<uint8_t>&, const size_t) for the
        related CBOR format

N
Niels Lohmann 已提交
8527
    @since version 2.0.9, parameter @a start_index since 2.1.1
8528
    */
8529 8530
    static basic_json from_msgpack(const std::vector<uint8_t>& v,
                                   const size_t start_index = 0)
N
Niels 已提交
8531
    {
8532
        size_t i = start_index;
N
Niels 已提交
8533 8534 8535
        return from_msgpack_internal(v, i);
    }

N
Niels Lohmann 已提交
8536
    /*!
8537 8538 8539 8540 8541 8542 8543
    @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 已提交
8544
    @param[in] j  JSON value to serialize
8545 8546 8547 8548 8549 8550 8551 8552
    @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
8553 8554
    @sa @ref from_cbor(const std::vector<uint8_t>&, const size_t) for the
        analogous deserialization
8555
    @sa @ref to_msgpack(const basic_json& for the related MessagePack format
8556 8557

    @since version 2.0.9
N
Niels Lohmann 已提交
8558 8559 8560 8561 8562 8563 8564 8565
    */
    static std::vector<uint8_t> to_cbor(const basic_json& j)
    {
        std::vector<uint8_t> result;
        to_cbor_internal(j, result);
        return result;
    }

8566 8567 8568 8569 8570 8571 8572
    /*!
    @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
8573
    @param[in] start_index the index to start reading from @a v (0 by default)
8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586
    @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
8587 8588 8589
    @sa @ref from_msgpack(const std::vector<uint8_t>&, const size_t) for the
        related MessagePack format

N
Niels Lohmann 已提交
8590
    @since version 2.0.9, parameter @a start_index since 2.1.1
8591
    */
8592 8593
    static basic_json from_cbor(const std::vector<uint8_t>& v,
                                const size_t start_index = 0)
N
Niels Lohmann 已提交
8594
    {
8595
        size_t i = start_index;
N
Niels Lohmann 已提交
8596 8597 8598
        return from_cbor_internal(v, i);
    }

N
Niels 已提交
8599
    /// @}
N
Niels 已提交
8600 8601 8602 8603 8604

    ///////////////////////////
    // convenience functions //
    ///////////////////////////

N
Niels 已提交
8605 8606 8607 8608 8609 8610
    /*!
    @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 已提交
8611
    @return basically a string representation of a the @a m_type member
N
Niels 已提交
8612 8613 8614

    @complexity Constant.

8615
    @liveexample{The following code exemplifies `type_name()` for all JSON
8616
    types.,type_name}
8617

8618
    @since version 1.0.0, public since 2.1.0
N
Niels 已提交
8619
    */
T
Théo DELRIEU 已提交
8620 8621
    std::string type_name() const
    {
T
Théo DELRIEU 已提交
8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640
        {
            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 已提交
8641
    }
N
Niels 已提交
8642 8643 8644 8645 8646 8647 8648 8649


  private:
    //////////////////////
    // member variables //
    //////////////////////

    /// the type of the current element
N
Niels 已提交
8650
    value_t m_type = value_t::null;
N
Niels 已提交
8651 8652 8653 8654

    /// the value of the current element
    json_value m_value = {};

N
Niels 已提交
8655

N
Niels 已提交
8656
  private:
N
Niels 已提交
8657 8658 8659 8660
    ///////////////
    // iterators //
    ///////////////

8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671
    /*!
    @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 已提交
8672
      public:
T
Théo Delrieu 已提交
8673 8674

        difference_type get_value() const noexcept
T
Théo DELRIEU 已提交
8675 8676 8677 8678 8679 8680 8681 8682
        {
            return m_it;
        }
        /// set iterator to a defined beginning
        void set_begin() noexcept
        {
            m_it = begin_value;
        }
8683

T
Théo DELRIEU 已提交
8684 8685 8686 8687 8688
        /// set iterator to a defined past the end
        void set_end() noexcept
        {
            m_it = end_value;
        }
8689

T
Théo DELRIEU 已提交
8690 8691 8692 8693 8694
        /// return whether the iterator can be dereferenced
        constexpr bool is_begin() const noexcept
        {
            return (m_it == begin_value);
        }
8695

T
Théo DELRIEU 已提交
8696 8697 8698 8699 8700
        /// return whether the iterator is at end
        constexpr bool is_end() const noexcept
        {
            return (m_it == end_value);
        }
8701

T
Théo DELRIEU 已提交
8702 8703 8704 8705
        friend constexpr bool operator==(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it == rhs.m_it;
        }
T
Théo Delrieu 已提交
8706

T
Théo DELRIEU 已提交
8707 8708 8709 8710
        friend constexpr bool operator!=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return !(lhs == rhs);
        }
T
Théo Delrieu 已提交
8711

T
Théo DELRIEU 已提交
8712 8713 8714 8715
        friend constexpr bool operator<(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it < rhs.m_it;
        }
T
Théo Delrieu 已提交
8716

T
Théo DELRIEU 已提交
8717 8718 8719 8720
        friend constexpr bool operator<=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it <= rhs.m_it;
        }
T
Théo Delrieu 已提交
8721

T
Théo DELRIEU 已提交
8722 8723 8724 8725
        friend constexpr bool operator>(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it > rhs.m_it;
        }
T
Théo Delrieu 已提交
8726

T
Théo DELRIEU 已提交
8727 8728 8729 8730
        friend constexpr bool operator>=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it >= rhs.m_it;
        }
T
Théo Delrieu 已提交
8731

T
Théo DELRIEU 已提交
8732 8733 8734 8735 8736 8737
        primitive_iterator_t operator+(difference_type i)
        {
            auto result = *this;
            result += i;
            return result;
        }
T
Théo Delrieu 已提交
8738

T
Théo DELRIEU 已提交
8739 8740 8741 8742
        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 已提交
8743

T
Théo DELRIEU 已提交
8744 8745 8746 8747
        friend std::ostream& operator<<(std::ostream& os, primitive_iterator_t it)
        {
            return os << it.m_it;
        }
T
Théo Delrieu 已提交
8748

T
Théo DELRIEU 已提交
8749 8750 8751 8752 8753
        primitive_iterator_t& operator++()
        {
            ++m_it;
            return *this;
        }
T
Théo Delrieu 已提交
8754

N
Niels Lohmann 已提交
8755
        primitive_iterator_t operator++(int)
T
Théo DELRIEU 已提交
8756
        {
N
Niels Lohmann 已提交
8757
            auto result = *this;
T
Théo DELRIEU 已提交
8758
            m_it++;
N
Niels Lohmann 已提交
8759
            return result;
T
Théo DELRIEU 已提交
8760
        }
T
Théo Delrieu 已提交
8761

T
Théo DELRIEU 已提交
8762 8763 8764 8765 8766
        primitive_iterator_t& operator--()
        {
            --m_it;
            return *this;
        }
T
Théo Delrieu 已提交
8767

N
Niels Lohmann 已提交
8768
        primitive_iterator_t operator--(int)
T
Théo DELRIEU 已提交
8769
        {
N
Niels Lohmann 已提交
8770
            auto result = *this;
T
Théo DELRIEU 已提交
8771
            m_it--;
N
Niels Lohmann 已提交
8772
            return result;
T
Théo DELRIEU 已提交
8773
        }
T
Théo Delrieu 已提交
8774

T
Théo DELRIEU 已提交
8775 8776 8777 8778 8779
        primitive_iterator_t& operator+=(difference_type n)
        {
            m_it += n;
            return *this;
        }
8780

T
Théo DELRIEU 已提交
8781 8782 8783 8784 8785
        primitive_iterator_t& operator-=(difference_type n)
        {
            m_it -= n;
            return *this;
        }
8786

T
Théo DELRIEU 已提交
8787 8788 8789
      private:
        static constexpr difference_type begin_value = 0;
        static constexpr difference_type end_value = begin_value + 1;
8790

T
Théo DELRIEU 已提交
8791 8792 8793
        /// iterator as signed integer type
        difference_type m_it = std::numeric_limits<std::ptrdiff_t>::denorm_min();
    };
8794

N
Niels 已提交
8795 8796 8797 8798 8799 8800 8801 8802
    /*!
    @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 已提交
8803 8804
    {
        /// iterator for JSON objects
N
Niels 已提交
8805
        typename object_t::iterator object_iterator;
N
Niels 已提交
8806
        /// iterator for JSON arrays
N
Niels 已提交
8807
        typename array_t::iterator array_iterator;
N
Niels 已提交
8808
        /// generic iterator for all other types
N
Niels 已提交
8809 8810 8811
        primitive_iterator_t primitive_iterator;

        /// create an uninitialized internal_iterator
N
Niels 已提交
8812
        internal_iterator() noexcept
T
Théo DELRIEU 已提交
8813 8814
            : object_iterator(), array_iterator(), primitive_iterator()
        {}
N
Niels 已提交
8815 8816
    };

N
cleanup  
Niels 已提交
8817 8818 8819 8820
    /// proxy class for the iterator_wrapper functions
    template<typename IteratorType>
    class iteration_proxy
    {
T
Théo DELRIEU 已提交
8821
      private:
N
cleanup  
Niels 已提交
8822 8823 8824
        /// helper class for iteration
        class iteration_proxy_internal
        {
T
Théo DELRIEU 已提交
8825
          private:
N
cleanup  
Niels 已提交
8826 8827 8828 8829 8830
            /// the iterator
            IteratorType anchor;
            /// an index for arrays (used to create key names)
            size_t array_index = 0;

T
Théo DELRIEU 已提交
8831
          public:
N
Niels 已提交
8832
            explicit iteration_proxy_internal(IteratorType it) noexcept
T
Théo DELRIEU 已提交
8833 8834
                : anchor(it)
            {}
N
cleanup  
Niels 已提交
8835

T
Théo DELRIEU 已提交
8836 8837 8838 8839 8840
            /// dereference operator (needed for range-based for)
            iteration_proxy_internal& operator*()
            {
                return *this;
            }
8841

T
Théo DELRIEU 已提交
8842 8843 8844 8845 8846
            /// increment operator (needed for range-based for)
            iteration_proxy_internal& operator++()
            {
                ++anchor;
                ++array_index;
8847

T
Théo DELRIEU 已提交
8848 8849
                return *this;
            }
N
cleanup  
Niels 已提交
8850

T
Théo DELRIEU 已提交
8851 8852
            /// inequality operator (needed for range-based for)
            bool operator!= (const iteration_proxy_internal& o) const
N
cleanup  
Niels 已提交
8853
            {
T
Théo DELRIEU 已提交
8854
                return anchor != o.anchor;
N
cleanup  
Niels 已提交
8855 8856
            }

T
Théo DELRIEU 已提交
8857 8858
            /// return key of the iterator
            typename basic_json::string_t key() const
N
cleanup  
Niels 已提交
8859
            {
T
Théo DELRIEU 已提交
8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881
                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 已提交
8882 8883
            }

T
Théo DELRIEU 已提交
8884 8885
            /// return value of the iterator
            typename IteratorType::reference value() const
N
cleanup  
Niels 已提交
8886
            {
T
Théo DELRIEU 已提交
8887
                return anchor.value();
N
cleanup  
Niels 已提交
8888 8889 8890
            }
        };

T
Théo DELRIEU 已提交
8891 8892
        /// the container to iterate
        typename IteratorType::reference container;
N
cleanup  
Niels 已提交
8893

T
Théo DELRIEU 已提交
8894 8895 8896 8897 8898
      public:
        /// construct iteration proxy from a container
        explicit iteration_proxy(typename IteratorType::reference cont)
            : container(cont)
        {}
N
cleanup  
Niels 已提交
8899

T
Théo DELRIEU 已提交
8900 8901 8902 8903 8904
        /// return iterator begin (needed for range-based for)
        iteration_proxy_internal begin() noexcept
        {
            return iteration_proxy_internal(container.begin());
        }
N
cleanup  
Niels 已提交
8905

T
Théo DELRIEU 已提交
8906 8907 8908 8909 8910 8911
        /// return iterator end (needed for range-based for)
        iteration_proxy_internal end() noexcept
        {
            return iteration_proxy_internal(container.end());
        }
    };
N
cleanup  
Niels 已提交
8912

N
Niels 已提交
8913
  public:
N
Niels 已提交
8914
    /*!
8915
    @brief a template for a random access iterator for the @ref basic_json class
N
Niels 已提交
8916

N
Niels Lohmann 已提交
8917 8918
    This class implements a both iterators (iterator and const_iterator) for the
    @ref basic_json class.
N
Niels 已提交
8919

N
Niels 已提交
8920 8921 8922
    @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 已提交
8923 8924
          methods are undefined. **The library uses assertions to detect calls
          on uninitialized iterators.**
N
Niels 已提交
8925

N
Niels 已提交
8926 8927 8928 8929
    @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 已提交
8930

N
Niels Lohmann 已提交
8931
    @since version 1.0.0, simplified in version 2.0.9
N
Niels 已提交
8932
    */
N
Niels Lohmann 已提交
8933
    template<typename U>
T
Théo DELRIEU 已提交
8934
    class iter_impl : public std::iterator<std::random_access_iterator_tag, U>
N
Niels 已提交
8935
    {
N
Niels 已提交
8936
        /// allow basic_json to access private members
8937 8938
        friend class basic_json;

8939 8940 8941 8942 8943
        // 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 已提交
8944
      public:
N
Niels 已提交
8945
        /// the type of the values when the iterator is dereferenced
N
Niels 已提交
8946
        using value_type = typename basic_json::value_type;
N
Niels 已提交
8947
        /// a type to represent differences between iterators
N
Niels 已提交
8948
        using difference_type = typename basic_json::difference_type;
N
Niels 已提交
8949
        /// defines a pointer to the type iterated over (value_type)
8950
        using pointer = typename std::conditional<std::is_const<U>::value,
T
Théo DELRIEU 已提交
8951 8952
              typename basic_json::const_pointer,
              typename basic_json::pointer>::type;
N
Niels 已提交
8953
        /// defines a reference to the type iterated over (value_type)
8954
        using reference = typename std::conditional<std::is_const<U>::value,
T
Théo DELRIEU 已提交
8955 8956
              typename basic_json::const_reference,
              typename basic_json::reference>::type;
N
Niels 已提交
8957
        /// the category of the iterator
N
Niels 已提交
8958
        using iterator_category = std::bidirectional_iterator_tag;
N
Niels 已提交
8959

8960
        /// default constructor
8961
        iter_impl() = default;
8962

N
Niels 已提交
8963 8964 8965 8966 8967 8968
        /*!
        @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`.
        */
8969
        explicit iter_impl(pointer object) noexcept
T
Théo DELRIEU 已提交
8970
            : m_object(object)
8971
        {
T
Théo DELRIEU 已提交
8972
            assert(m_object != nullptr);
8973

T
Théo DELRIEU 已提交
8974
            switch (m_object->m_type)
8975
            {
T
Théo DELRIEU 已提交
8976 8977 8978 8979 8980
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = typename object_t::iterator();
                    break;
                }
8981

T
Théo DELRIEU 已提交
8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992
                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 已提交
8993 8994
            }
        }
N
Niels 已提交
8995

T
Théo DELRIEU 已提交
8996 8997 8998 8999
        /*
        Use operator `const_iterator` instead of `const_iterator(const iterator&
        other) noexcept` to avoid two class definitions for @ref iterator and
        @ref const_iterator.
9000

T
Théo DELRIEU 已提交
9001 9002 9003 9004
        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 已提交
9005
        {
T
Théo DELRIEU 已提交
9006
            const_iterator ret;
N
Niels 已提交
9007

T
Théo DELRIEU 已提交
9008 9009 9010 9011 9012
            if (m_object)
            {
                ret.m_object = m_object;
                ret.m_it = m_it;
            }
9013

T
Théo DELRIEU 已提交
9014 9015
            return ret;
        }
N
Niels 已提交
9016

T
Théo DELRIEU 已提交
9017 9018 9019 9020 9021 9022 9023 9024
        /*!
        @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 已提交
9025

T
Théo DELRIEU 已提交
9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041
        /*!
        @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 已提交
9042

T
Théo DELRIEU 已提交
9043 9044 9045 9046 9047 9048
      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 已提交
9049
        {
T
Théo DELRIEU 已提交
9050
            assert(m_object != nullptr);
N
Niels 已提交
9051

T
Théo DELRIEU 已提交
9052
            switch (m_object->m_type)
N
Niels 已提交
9053
            {
T
Théo DELRIEU 已提交
9054 9055 9056 9057 9058
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = m_object->m_value.object->begin();
                    break;
                }
N
Niels 已提交
9059

T
Théo DELRIEU 已提交
9060 9061 9062 9063 9064
                case basic_json::value_t::array:
                {
                    m_it.array_iterator = m_object->m_value.array->begin();
                    break;
                }
N
Niels 已提交
9065

T
Théo DELRIEU 已提交
9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077
                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 已提交
9078 9079 9080
            }
        }

T
Théo DELRIEU 已提交
9081 9082 9083 9084 9085
        /*!
        @brief set the iterator past the last value
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        void set_end() noexcept
9086
        {
T
Théo DELRIEU 已提交
9087
            assert(m_object != nullptr);
N
Niels 已提交
9088

T
Théo DELRIEU 已提交
9089
            switch (m_object->m_type)
9090
            {
T
Théo DELRIEU 已提交
9091 9092 9093 9094 9095
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = m_object->m_value.object->end();
                    break;
                }
N
Niels 已提交
9096

T
Théo DELRIEU 已提交
9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107
                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 已提交
9108 9109
            }
        }
N
Niels 已提交
9110

T
Théo DELRIEU 已提交
9111 9112 9113 9114 9115 9116
      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
9117
        {
T
Théo DELRIEU 已提交
9118
            assert(m_object != nullptr);
N
Niels 已提交
9119

T
Théo DELRIEU 已提交
9120
            switch (m_object->m_type)
9121
            {
T
Théo DELRIEU 已提交
9122 9123 9124 9125 9126
                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 已提交
9127

T
Théo DELRIEU 已提交
9128 9129 9130 9131 9132
                case basic_json::value_t::array:
                {
                    assert(m_it.array_iterator != m_object->m_value.array->end());
                    return *m_it.array_iterator;
                }
N
Niels 已提交
9133

T
Théo DELRIEU 已提交
9134
                case basic_json::value_t::null:
N
Niels 已提交
9135
                {
T
Théo DELRIEU 已提交
9136
                    JSON_THROW(std::out_of_range("cannot get value"));
N
Niels 已提交
9137 9138
                }

T
Théo DELRIEU 已提交
9139 9140 9141 9142 9143 9144 9145
                default:
                {
                    if (m_it.primitive_iterator.is_begin())
                    {
                        return *m_object;
                    }

9146
                    JSON_THROW(std::out_of_range("cannot get value"));
T
Théo DELRIEU 已提交
9147
                }
N
Niels 已提交
9148 9149 9150
            }
        }

T
Théo DELRIEU 已提交
9151 9152 9153 9154 9155
        /*!
        @brief dereference the iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        pointer operator->() const
N
Niels 已提交
9156
        {
T
Théo DELRIEU 已提交
9157
            assert(m_object != nullptr);
N
Niels 已提交
9158

T
Théo DELRIEU 已提交
9159
            switch (m_object->m_type)
N
Niels 已提交
9160
            {
T
Théo DELRIEU 已提交
9161 9162 9163 9164 9165
                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 已提交
9166

T
Théo DELRIEU 已提交
9167
                case basic_json::value_t::array:
N
Niels 已提交
9168
                {
T
Théo DELRIEU 已提交
9169 9170
                    assert(m_it.array_iterator != m_object->m_value.array->end());
                    return &*m_it.array_iterator;
N
Niels 已提交
9171 9172
                }

T
Théo DELRIEU 已提交
9173 9174 9175 9176 9177 9178 9179
                default:
                {
                    if (m_it.primitive_iterator.is_begin())
                    {
                        return m_object;
                    }

9180
                    JSON_THROW(std::out_of_range("cannot get value"));
T
Théo DELRIEU 已提交
9181
                }
N
Niels 已提交
9182 9183 9184
            }
        }

T
Théo DELRIEU 已提交
9185 9186 9187 9188 9189 9190 9191 9192 9193 9194
        /*!
        @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 已提交
9195

T
Théo DELRIEU 已提交
9196 9197 9198 9199 9200
        /*!
        @brief pre-increment (++it)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator++()
9201
        {
T
Théo DELRIEU 已提交
9202
            assert(m_object != nullptr);
N
Niels 已提交
9203

T
Théo DELRIEU 已提交
9204
            switch (m_object->m_type)
9205
            {
T
Théo DELRIEU 已提交
9206 9207 9208 9209 9210
                case basic_json::value_t::object:
                {
                    std::advance(m_it.object_iterator, 1);
                    break;
                }
N
Niels 已提交
9211

T
Théo DELRIEU 已提交
9212 9213 9214 9215 9216
                case basic_json::value_t::array:
                {
                    std::advance(m_it.array_iterator, 1);
                    break;
                }
N
Niels 已提交
9217

T
Théo DELRIEU 已提交
9218 9219 9220 9221 9222 9223
                default:
                {
                    ++m_it.primitive_iterator;
                    break;
                }
            }
9224

T
Théo DELRIEU 已提交
9225 9226
            return *this;
        }
9227

T
Théo DELRIEU 已提交
9228 9229 9230 9231 9232 9233 9234 9235 9236 9237
        /*!
        @brief post-decrement (it--)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl operator--(int)
        {
            auto result = *this;
            --(*this);
            return result;
        }
9238

T
Théo DELRIEU 已提交
9239 9240 9241 9242 9243
        /*!
        @brief pre-decrement (--it)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator--()
N
Niels 已提交
9244
        {
T
Théo DELRIEU 已提交
9245 9246 9247
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
9248
            {
T
Théo DELRIEU 已提交
9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265
                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 已提交
9266 9267
            }

T
Théo DELRIEU 已提交
9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278
            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 已提交
9279
            {
T
Théo DELRIEU 已提交
9280
                JSON_THROW(std::domain_error("cannot compare iterators of different containers"));
9281
            }
N
Niels 已提交
9282

T
Théo DELRIEU 已提交
9283 9284 9285
            assert(m_object != nullptr);

            switch (m_object->m_type)
9286
            {
T
Théo DELRIEU 已提交
9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300
                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 已提交
9301 9302 9303
            }
        }

T
Théo DELRIEU 已提交
9304 9305 9306 9307 9308
        /*!
        @brief  comparison: not equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator!=(const iter_impl& other) const
N
Niels 已提交
9309
        {
T
Théo DELRIEU 已提交
9310
            return not operator==(other);
N
Niels 已提交
9311 9312
        }

T
Théo DELRIEU 已提交
9313 9314 9315 9316 9317
        /*!
        @brief  comparison: smaller
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator<(const iter_impl& other) const
N
Niels 已提交
9318
        {
T
Théo DELRIEU 已提交
9319 9320
            // if objects are not the same, the comparison is undefined
            if (m_object != other.m_object)
N
Niels 已提交
9321
            {
T
Théo DELRIEU 已提交
9322
                JSON_THROW(std::domain_error("cannot compare iterators of different containers"));
N
Niels 已提交
9323 9324
            }

T
Théo DELRIEU 已提交
9325
            assert(m_object != nullptr);
N
Niels 已提交
9326

T
Théo DELRIEU 已提交
9327
            switch (m_object->m_type)
9328
            {
T
Théo DELRIEU 已提交
9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342
                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 已提交
9343 9344 9345
            }
        }

T
Théo DELRIEU 已提交
9346 9347 9348 9349 9350
        /*!
        @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 已提交
9351
        {
T
Théo DELRIEU 已提交
9352
            return not other.operator < (*this);
N
Niels 已提交
9353 9354
        }

T
Théo DELRIEU 已提交
9355 9356 9357 9358 9359
        /*!
        @brief  comparison: greater than
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator>(const iter_impl& other) const
N
Niels 已提交
9360
        {
T
Théo DELRIEU 已提交
9361
            return not operator<=(other);
N
Niels 已提交
9362
        }
9363

T
Théo DELRIEU 已提交
9364 9365 9366 9367 9368 9369 9370 9371
        /*!
        @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);
        }
9372

T
Théo DELRIEU 已提交
9373 9374 9375 9376 9377
        /*!
        @brief  add to iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator+=(difference_type i)
N
Niels 已提交
9378
        {
T
Théo DELRIEU 已提交
9379 9380 9381
            assert(m_object != nullptr);

            switch (m_object->m_type)
9382
            {
T
Théo DELRIEU 已提交
9383 9384
                case basic_json::value_t::object:
                {
9385
                    JSON_THROW(std::domain_error("cannot use offsets with object iterators"));
T
Théo DELRIEU 已提交
9386
                }
9387

T
Théo DELRIEU 已提交
9388 9389 9390 9391 9392
                case basic_json::value_t::array:
                {
                    std::advance(m_it.array_iterator, i);
                    break;
                }
9393

T
Théo DELRIEU 已提交
9394 9395 9396 9397 9398
                default:
                {
                    m_it.primitive_iterator += i;
                    break;
                }
9399 9400
            }

T
Théo DELRIEU 已提交
9401 9402
            return *this;
        }
9403

T
Théo DELRIEU 已提交
9404 9405 9406 9407 9408 9409 9410 9411
        /*!
        @brief  subtract from iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator-=(difference_type i)
        {
            return operator+=(-i);
        }
9412

T
Théo DELRIEU 已提交
9413 9414 9415 9416 9417 9418 9419 9420 9421 9422
        /*!
        @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;
        }
9423

T
Théo DELRIEU 已提交
9424 9425 9426 9427 9428 9429 9430 9431 9432 9433
        /*!
        @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 已提交
9434

T
Théo DELRIEU 已提交
9435 9436 9437 9438 9439
        /*!
        @brief  return difference
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        difference_type operator-(const iter_impl& other) const
9440
        {
T
Théo DELRIEU 已提交
9441 9442 9443
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
9444
            {
T
Théo DELRIEU 已提交
9445 9446
                case basic_json::value_t::object:
                {
9447
                    JSON_THROW(std::domain_error("cannot use offsets with object iterators"));
T
Théo DELRIEU 已提交
9448
                }
N
Niels 已提交
9449

T
Théo DELRIEU 已提交
9450 9451 9452 9453
                case basic_json::value_t::array:
                {
                    return m_it.array_iterator - other.m_it.array_iterator;
                }
N
Niels 已提交
9454

T
Théo DELRIEU 已提交
9455 9456 9457 9458
                default:
                {
                    return m_it.primitive_iterator - other.m_it.primitive_iterator;
                }
N
Niels 已提交
9459 9460
            }
        }
N
Niels 已提交
9461

T
Théo DELRIEU 已提交
9462 9463 9464 9465 9466
        /*!
        @brief  access to successor
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        reference operator[](difference_type n) const
9467
        {
T
Théo DELRIEU 已提交
9468 9469 9470
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
9471
            {
T
Théo DELRIEU 已提交
9472 9473
                case basic_json::value_t::object:
                {
9474
                    JSON_THROW(std::domain_error("cannot use operator[] for object iterators"));
T
Théo DELRIEU 已提交
9475
                }
N
Niels 已提交
9476

T
Théo DELRIEU 已提交
9477 9478 9479 9480
                case basic_json::value_t::array:
                {
                    return *std::next(m_it.array_iterator, n);
                }
N
Niels 已提交
9481

T
Théo DELRIEU 已提交
9482 9483
                case basic_json::value_t::null:
                {
9484
                    JSON_THROW(std::out_of_range("cannot get value"));
T
Théo DELRIEU 已提交
9485
                }
N
Niels 已提交
9486

T
Théo DELRIEU 已提交
9487
                default:
N
Niels 已提交
9488
                {
T
Théo DELRIEU 已提交
9489 9490 9491 9492
                    if (m_it.primitive_iterator.get_value() == -n)
                    {
                        return *m_object;
                    }
N
Niels Lohmann 已提交
9493

9494
                    JSON_THROW(std::out_of_range("cannot get value"));
T
Théo DELRIEU 已提交
9495
                }
N
Niels 已提交
9496 9497
            }
        }
N
Niels 已提交
9498

T
Théo DELRIEU 已提交
9499 9500 9501 9502 9503
        /*!
        @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
9504
        {
T
Théo DELRIEU 已提交
9505 9506 9507 9508 9509 9510
            assert(m_object != nullptr);

            if (m_object->is_object())
            {
                return m_it.object_iterator->first;
            }
N
Niels Lohmann 已提交
9511

9512
            JSON_THROW(std::domain_error("cannot use key() for non-object iterators"));
T
Théo DELRIEU 已提交
9513
        }
N
Niels 已提交
9514

T
Théo DELRIEU 已提交
9515 9516 9517 9518 9519 9520 9521 9522
        /*!
        @brief  return the value of an iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        reference value() const
        {
            return operator*();
        }
N
Niels 已提交
9523

T
Théo DELRIEU 已提交
9524 9525 9526 9527 9528 9529
      private:
        /// associated JSON instance
        pointer m_object = nullptr;
        /// the actual iterator of the associated instance
        internal_iterator m_it = internal_iterator();
    };
N
Niels 已提交
9530

N
Niels 已提交
9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544
    /*!
    @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 已提交
9545

N
Niels 已提交
9546
    @since version 1.0.0
N
Niels 已提交
9547
    */
N
Niels 已提交
9548
    template<typename Base>
T
Théo DELRIEU 已提交
9549
    class json_reverse_iterator : public std::reverse_iterator<Base>
9550
    {
T
Théo DELRIEU 已提交
9551
      public:
9552
        /// shortcut to the reverse iterator adaptor
N
Niels 已提交
9553
        using base_iterator = std::reverse_iterator<Base>;
N
Niels 已提交
9554
        /// the reference type for the pointed-to element
N
Niels 已提交
9555
        using reference = typename Base::reference;
9556

9557
        /// create reverse iterator from iterator
N
Niels 已提交
9558
        json_reverse_iterator(const typename base_iterator::iterator_type& it) noexcept
T
Théo DELRIEU 已提交
9559 9560
            : base_iterator(it)
        {}
9561

T
Théo DELRIEU 已提交
9562 9563 9564 9565
        /// create reverse iterator from base class
        json_reverse_iterator(const base_iterator& it) noexcept
            : base_iterator(it)
        {}
9566

T
Théo DELRIEU 已提交
9567 9568 9569 9570 9571
        /// post-increment (it++)
        json_reverse_iterator operator++(int)
        {
            return base_iterator::operator++(1);
        }
9572

T
Théo DELRIEU 已提交
9573 9574 9575 9576 9577 9578
        /// pre-increment (++it)
        json_reverse_iterator& operator++()
        {
            base_iterator::operator++();
            return *this;
        }
9579

T
Théo DELRIEU 已提交
9580 9581 9582 9583 9584
        /// post-decrement (it--)
        json_reverse_iterator operator--(int)
        {
            return base_iterator::operator--(1);
        }
9585

T
Théo DELRIEU 已提交
9586 9587 9588 9589 9590 9591
        /// pre-decrement (--it)
        json_reverse_iterator& operator--()
        {
            base_iterator::operator--();
            return *this;
        }
9592

T
Théo DELRIEU 已提交
9593 9594 9595 9596 9597 9598
        /// add to iterator
        json_reverse_iterator& operator+=(difference_type i)
        {
            base_iterator::operator+=(i);
            return *this;
        }
9599

T
Théo DELRIEU 已提交
9600 9601 9602 9603 9604 9605 9606
        /// add to iterator
        json_reverse_iterator operator+(difference_type i) const
        {
            auto result = *this;
            result += i;
            return result;
        }
9607

T
Théo DELRIEU 已提交
9608 9609 9610 9611 9612 9613 9614
        /// subtract from iterator
        json_reverse_iterator operator-(difference_type i) const
        {
            auto result = *this;
            result -= i;
            return result;
        }
9615

T
Théo DELRIEU 已提交
9616 9617 9618 9619 9620
        /// return difference
        difference_type operator-(const json_reverse_iterator& other) const
        {
            return this->base() - other.base();
        }
9621

T
Théo DELRIEU 已提交
9622 9623 9624 9625 9626
        /// access to successor
        reference operator[](difference_type n) const
        {
            return *(this->operator+(n));
        }
N
Niels 已提交
9627

T
Théo DELRIEU 已提交
9628 9629 9630 9631 9632 9633
        /// return the key of an object iterator
        typename object_t::key_type key() const
        {
            auto it = --this->base();
            return it.key();
        }
9634

T
Théo DELRIEU 已提交
9635 9636 9637 9638 9639 9640 9641
        /// return the value of an iterator
        reference value() const
        {
            auto it = --this->base();
            return it.operator * ();
        }
    };
9642

N
Niels 已提交
9643

N
Niels 已提交
9644
  private:
N
Niels 已提交
9645 9646 9647
    //////////////////////
    // lexer and parser //
    //////////////////////
N
Niels 已提交
9648

N
Niels 已提交
9649 9650 9651 9652
    /*!
    @brief lexical analysis

    This class organizes the lexical analysis during JSON deserialization. The
N
Niels 已提交
9653 9654
    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 已提交
9655
    */
N
Niels 已提交
9656
    class lexer
N
Niels 已提交
9657
    {
T
Théo DELRIEU 已提交
9658
      public:
N
Niels 已提交
9659 9660
        /// token types for the parser
        enum class token_type
T
Théo DELRIEU 已提交
9661 9662 9663 9664 9665 9666
        {
            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 已提交
9667 9668
            value_unsigned,  ///< an unsigned integer -- use get_number() for actual value
            value_integer,   ///< a signed integer -- use get_number() for actual value
9669
            value_float,     ///< an floating point number -- use get_number() for actual value
T
Théo DELRIEU 已提交
9670 9671 9672 9673 9674 9675 9676 9677 9678
            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 已提交
9679

T
Théo DELRIEU 已提交
9680 9681
        /// the char type to use in the lexer
        using lexer_char_t = unsigned char;
N
Niels 已提交
9682

T
Théo DELRIEU 已提交
9683 9684 9685 9686 9687 9688 9689 9690
        /// 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 已提交
9691

T
Théo DELRIEU 已提交
9692 9693 9694
        /// a lexer from an input stream
        explicit lexer(std::istream& s)
            : m_stream(&s), m_line_buffer()
N
Niels 已提交
9695
        {
T
Théo DELRIEU 已提交
9696 9697 9698
            // immediately abort if stream is erroneous
            if (s.fail())
            {
9699
                JSON_THROW(std::invalid_argument("stream error"));
T
Théo DELRIEU 已提交
9700
            }
N
Niels 已提交
9701

T
Théo DELRIEU 已提交
9702 9703
            // fill buffer
            fill_line_buffer();
N
Niels 已提交
9704

T
Théo DELRIEU 已提交
9705 9706 9707 9708 9709 9710 9711
            // 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] = ' ';
            }
9712
        }
N
Niels 已提交
9713

T
Théo DELRIEU 已提交
9714 9715 9716 9717
        // switch off unwanted functions (due to pointer members)
        lexer() = delete;
        lexer(const lexer&) = delete;
        lexer operator=(const lexer&) = delete;
N
Niels 已提交
9718

T
Théo DELRIEU 已提交
9719 9720
        /*!
        @brief create a string from one or two Unicode code points
N
Niels 已提交
9721

T
Théo DELRIEU 已提交
9722 9723 9724 9725
        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 已提交
9726

T
Théo DELRIEU 已提交
9727 9728
        @param[in] codepoint1  the code point (can be high surrogate)
        @param[in] codepoint2  the code point (can be low surrogate or 0)
N
Niels 已提交
9729

T
Théo DELRIEU 已提交
9730 9731
        @return string representation of the code point; the length of the
        result string is between 1 and 4 characters.
N
Niels 已提交
9732

T
Théo DELRIEU 已提交
9733 9734 9735 9736
        @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 已提交
9737

T
Théo DELRIEU 已提交
9738
        @complexity Constant.
N
Niels 已提交
9739

T
Théo DELRIEU 已提交
9740 9741 9742 9743
        @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)
9744
        {
T
Théo DELRIEU 已提交
9745 9746 9747 9748 9749
            // 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 已提交
9750
            {
T
Théo DELRIEU 已提交
9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767
                // 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 已提交
9768 9769
            }

T
Théo DELRIEU 已提交
9770
            string_t result;
9771

T
Théo DELRIEU 已提交
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
            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
            {
9800
                JSON_THROW(std::out_of_range("code points above 0x10FFFF are invalid"));
T
Théo DELRIEU 已提交
9801
            }
9802

T
Théo DELRIEU 已提交
9803 9804
            return result;
        }
9805

T
Théo DELRIEU 已提交
9806 9807 9808 9809
        /// 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 已提交
9810
            {
T
Théo DELRIEU 已提交
9811 9812 9813 9814 9815 9816 9817 9818 9819 9820
                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 已提交
9821 9822
                case lexer::token_type::value_unsigned:
                case lexer::token_type::value_integer:
9823
                case lexer::token_type::value_float:
T
Théo DELRIEU 已提交
9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845
                    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 已提交
9846 9847 9848
            }
        }

T
Théo DELRIEU 已提交
9849 9850 9851 9852 9853 9854 9855
        /*!
        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 已提交
9856

T
Théo DELRIEU 已提交
9857
        @return the class of the next token read from the buffer
N
Niels 已提交
9858

T
Théo DELRIEU 已提交
9859
        @complexity Linear in the length of the input.\n
N
Niels 已提交
9860

T
Théo DELRIEU 已提交
9861
        Proposition: The loop below will always terminate for finite input.\n
N
Niels 已提交
9862

T
Théo DELRIEU 已提交
9863 9864 9865 9866 9867 9868 9869 9870
        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 已提交
9871
        {
T
Théo DELRIEU 已提交
9872 9873 9874 9875
            while (true)
            {
                // pointer for backtracking information
                m_marker = nullptr;
N
Niels 已提交
9876

T
Théo DELRIEU 已提交
9877 9878 9879
                // remember the begin of the token
                m_start = m_cursor;
                assert(m_start != nullptr);
N
Niels 已提交
9880

9881 9882 9883 9884

                {
                    lexer_char_t yych;
                    unsigned int yyaccept = 0;
N
Niels Lohmann 已提交
9885 9886 9887 9888 9889 9890
                    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,
9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902
                        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,
N
Niels Lohmann 已提交
9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
                        0,   0,   0,   0,   0,   0,   0,   0,
9919
                    };
N
Niels Lohmann 已提交
9920 9921 9922 9923
                    if ((m_limit - m_cursor) < 5)
                    {
                        fill_line_buffer(5);    // LCOV_EXCL_LINE
                    }
9924
                    yych = *m_cursor;
N
Niels Lohmann 已提交
9925 9926
                    if (yybm[0 + yych] & 32)
                    {
9927 9928
                        goto basic_json_parser_6;
                    }
N
Niels Lohmann 已提交
9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942
                    if (yych <= '[')
                    {
                        if (yych <= '-')
                        {
                            if (yych <= '"')
                            {
                                if (yych <= 0x00)
                                {
                                    goto basic_json_parser_2;
                                }
                                if (yych <= '!')
                                {
                                    goto basic_json_parser_4;
                                }
9943
                                goto basic_json_parser_9;
N
Niels Lohmann 已提交
9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954
                            }
                            else
                            {
                                if (yych <= '+')
                                {
                                    goto basic_json_parser_4;
                                }
                                if (yych <= ',')
                                {
                                    goto basic_json_parser_10;
                                }
9955 9956
                                goto basic_json_parser_12;
                            }
N
Niels Lohmann 已提交
9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969
                        }
                        else
                        {
                            if (yych <= '9')
                            {
                                if (yych <= '/')
                                {
                                    goto basic_json_parser_4;
                                }
                                if (yych <= '0')
                                {
                                    goto basic_json_parser_13;
                                }
9970
                                goto basic_json_parser_15;
N
Niels Lohmann 已提交
9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981
                            }
                            else
                            {
                                if (yych <= ':')
                                {
                                    goto basic_json_parser_17;
                                }
                                if (yych <= 'Z')
                                {
                                    goto basic_json_parser_4;
                                }
9982 9983 9984
                                goto basic_json_parser_19;
                            }
                        }
N
Niels Lohmann 已提交
9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995
                    }
                    else
                    {
                        if (yych <= 'n')
                        {
                            if (yych <= 'e')
                            {
                                if (yych == ']')
                                {
                                    goto basic_json_parser_21;
                                }
9996
                                goto basic_json_parser_4;
N
Niels Lohmann 已提交
9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007
                            }
                            else
                            {
                                if (yych <= 'f')
                                {
                                    goto basic_json_parser_23;
                                }
                                if (yych <= 'm')
                                {
                                    goto basic_json_parser_4;
                                }
10008 10009
                                goto basic_json_parser_24;
                            }
N
Niels Lohmann 已提交
10010 10011 10012 10013 10014 10015 10016 10017 10018
                        }
                        else
                        {
                            if (yych <= 'z')
                            {
                                if (yych == 't')
                                {
                                    goto basic_json_parser_25;
                                }
10019
                                goto basic_json_parser_4;
N
Niels Lohmann 已提交
10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030
                            }
                            else
                            {
                                if (yych <= '{')
                                {
                                    goto basic_json_parser_26;
                                }
                                if (yych == '}')
                                {
                                    goto basic_json_parser_28;
                                }
10031 10032 10033 10034
                                goto basic_json_parser_4;
                            }
                        }
                    }
N
Niels Lohmann 已提交
10035
basic_json_parser_2:
10036
                    ++m_cursor;
N
Niels Lohmann 已提交
10037 10038 10039 10040 10041
                    {
                        last_token_type = token_type::end_of_input;
                        break;
                    }
basic_json_parser_4:
10042
                    ++m_cursor;
N
Niels Lohmann 已提交
10043 10044 10045 10046 10047 10048
basic_json_parser_5:
                    {
                        last_token_type = token_type::parse_error;
                        break;
                    }
basic_json_parser_6:
10049
                    ++m_cursor;
N
Niels Lohmann 已提交
10050 10051 10052 10053
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
10054
                    yych = *m_cursor;
N
Niels Lohmann 已提交
10055 10056
                    if (yybm[0 + yych] & 32)
                    {
10057 10058
                        goto basic_json_parser_6;
                    }
N
Niels Lohmann 已提交
10059 10060 10061 10062
                    {
                        continue;
                    }
basic_json_parser_9:
10063 10064
                    yyaccept = 0;
                    yych = *(m_marker = ++m_cursor);
N
Niels Lohmann 已提交
10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077 10078 10079 10080
                    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;
                    }
10081
                    goto basic_json_parser_5;
N
Niels Lohmann 已提交
10082
basic_json_parser_10:
10083
                    ++m_cursor;
N
Niels Lohmann 已提交
10084 10085 10086 10087 10088
                    {
                        last_token_type = token_type::value_separator;
                        break;
                    }
basic_json_parser_12:
10089
                    yych = *++m_cursor;
N
Niels Lohmann 已提交
10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101
                    if (yych <= '/')
                    {
                        goto basic_json_parser_5;
                    }
                    if (yych <= '0')
                    {
                        goto basic_json_parser_43;
                    }
                    if (yych <= '9')
                    {
                        goto basic_json_parser_45;
                    }
10102
                    goto basic_json_parser_5;
N
Niels Lohmann 已提交
10103
basic_json_parser_13:
10104 10105
                    yyaccept = 1;
                    yych = *(m_marker = ++m_cursor);
N
Niels Lohmann 已提交
10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124
                    if (yych <= '9')
                    {
                        if (yych == '.')
                        {
                            goto basic_json_parser_47;
                        }
                        if (yych >= '0')
                        {
                            goto basic_json_parser_48;
                        }
                    }
                    else
                    {
                        if (yych <= 'E')
                        {
                            if (yych >= 'E')
                            {
                                goto basic_json_parser_51;
                            }
10125
                        }
N
Niels Lohmann 已提交
10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137
                        else
                        {
                            if (yych == 'e')
                            {
                                goto basic_json_parser_51;
                            }
                        }
                    }
basic_json_parser_14:
                    {
                        last_token_type = token_type::value_unsigned;
                        break;
10138
                    }
N
Niels Lohmann 已提交
10139
basic_json_parser_15:
10140 10141
                    yyaccept = 1;
                    m_marker = ++m_cursor;
N
Niels Lohmann 已提交
10142 10143 10144 10145
                    if ((m_limit - m_cursor) < 3)
                    {
                        fill_line_buffer(3);    // LCOV_EXCL_LINE
                    }
10146
                    yych = *m_cursor;
N
Niels Lohmann 已提交
10147 10148
                    if (yybm[0 + yych] & 64)
                    {
10149 10150
                        goto basic_json_parser_15;
                    }
N
Niels Lohmann 已提交
10151 10152 10153 10154 10155 10156
                    if (yych <= 'D')
                    {
                        if (yych == '.')
                        {
                            goto basic_json_parser_47;
                        }
10157
                        goto basic_json_parser_14;
N
Niels Lohmann 已提交
10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168
                    }
                    else
                    {
                        if (yych <= 'E')
                        {
                            goto basic_json_parser_51;
                        }
                        if (yych == 'e')
                        {
                            goto basic_json_parser_51;
                        }
10169 10170
                        goto basic_json_parser_14;
                    }
N
Niels Lohmann 已提交
10171
basic_json_parser_17:
10172
                    ++m_cursor;
N
Niels Lohmann 已提交
10173 10174 10175 10176 10177
                    {
                        last_token_type = token_type::name_separator;
                        break;
                    }
basic_json_parser_19:
10178
                    ++m_cursor;
N
Niels Lohmann 已提交
10179 10180 10181 10182 10183
                    {
                        last_token_type = token_type::begin_array;
                        break;
                    }
basic_json_parser_21:
10184
                    ++m_cursor;
N
Niels Lohmann 已提交
10185 10186 10187 10188 10189
                    {
                        last_token_type = token_type::end_array;
                        break;
                    }
basic_json_parser_23:
10190 10191
                    yyaccept = 0;
                    yych = *(m_marker = ++m_cursor);
N
Niels Lohmann 已提交
10192 10193 10194 10195
                    if (yych == 'a')
                    {
                        goto basic_json_parser_52;
                    }
10196
                    goto basic_json_parser_5;
N
Niels Lohmann 已提交
10197
basic_json_parser_24:
10198 10199
                    yyaccept = 0;
                    yych = *(m_marker = ++m_cursor);
N
Niels Lohmann 已提交
10200 10201 10202 10203
                    if (yych == 'u')
                    {
                        goto basic_json_parser_53;
                    }
10204
                    goto basic_json_parser_5;
N
Niels Lohmann 已提交
10205
basic_json_parser_25:
10206 10207
                    yyaccept = 0;
                    yych = *(m_marker = ++m_cursor);
N
Niels Lohmann 已提交
10208 10209 10210 10211
                    if (yych == 'r')
                    {
                        goto basic_json_parser_54;
                    }
10212
                    goto basic_json_parser_5;
N
Niels Lohmann 已提交
10213
basic_json_parser_26:
10214
                    ++m_cursor;
N
Niels Lohmann 已提交
10215 10216 10217 10218 10219
                    {
                        last_token_type = token_type::begin_object;
                        break;
                    }
basic_json_parser_28:
10220
                    ++m_cursor;
N
Niels Lohmann 已提交
10221 10222 10223 10224 10225
                    {
                        last_token_type = token_type::end_object;
                        break;
                    }
basic_json_parser_30:
10226
                    ++m_cursor;
N
Niels Lohmann 已提交
10227 10228 10229 10230
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
10231
                    yych = *m_cursor;
N
Niels Lohmann 已提交
10232 10233 10234
basic_json_parser_31:
                    if (yybm[0 + yych] & 128)
                    {
10235 10236
                        goto basic_json_parser_30;
                    }
N
Niels Lohmann 已提交
10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248
                    if (yych <= 0xE0)
                    {
                        if (yych <= '\\')
                        {
                            if (yych <= 0x1F)
                            {
                                goto basic_json_parser_32;
                            }
                            if (yych <= '"')
                            {
                                goto basic_json_parser_33;
                            }
10249
                            goto basic_json_parser_35;
N
Niels Lohmann 已提交
10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260
                        }
                        else
                        {
                            if (yych <= 0xC1)
                            {
                                goto basic_json_parser_32;
                            }
                            if (yych <= 0xDF)
                            {
                                goto basic_json_parser_36;
                            }
10261 10262
                            goto basic_json_parser_37;
                        }
N
Niels Lohmann 已提交
10263 10264 10265 10266 10267 10268 10269 10270 10271
                    }
                    else
                    {
                        if (yych <= 0xEF)
                        {
                            if (yych == 0xED)
                            {
                                goto basic_json_parser_39;
                            }
10272
                            goto basic_json_parser_38;
N
Niels Lohmann 已提交
10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287
                        }
                        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;
                            }
10288 10289
                        }
                    }
N
Niels Lohmann 已提交
10290
basic_json_parser_32:
10291
                    m_cursor = m_marker;
N
Niels Lohmann 已提交
10292 10293 10294 10295
                    if (yyaccept <= 1)
                    {
                        if (yyaccept == 0)
                        {
10296
                            goto basic_json_parser_5;
N
Niels Lohmann 已提交
10297 10298 10299
                        }
                        else
                        {
10300 10301
                            goto basic_json_parser_14;
                        }
N
Niels Lohmann 已提交
10302 10303 10304 10305 10306
                    }
                    else
                    {
                        if (yyaccept == 2)
                        {
10307
                            goto basic_json_parser_44;
N
Niels Lohmann 已提交
10308 10309 10310
                        }
                        else
                        {
N
Niels Lohmann 已提交
10311
                            goto basic_json_parser_58;
10312
                        }
10313
                    }
N
Niels Lohmann 已提交
10314
basic_json_parser_33:
10315
                    ++m_cursor;
N
Niels Lohmann 已提交
10316 10317 10318 10319 10320
                    {
                        last_token_type = token_type::value_string;
                        break;
                    }
basic_json_parser_35:
10321
                    ++m_cursor;
N
Niels Lohmann 已提交
10322 10323 10324 10325
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
10326
                    yych = *m_cursor;
N
Niels Lohmann 已提交
10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338
                    if (yych <= 'e')
                    {
                        if (yych <= '/')
                        {
                            if (yych == '"')
                            {
                                goto basic_json_parser_30;
                            }
                            if (yych <= '.')
                            {
                                goto basic_json_parser_32;
                            }
10339
                            goto basic_json_parser_30;
N
Niels Lohmann 已提交
10340 10341 10342 10343 10344 10345 10346 10347 10348
                        }
                        else
                        {
                            if (yych <= '\\')
                            {
                                if (yych <= '[')
                                {
                                    goto basic_json_parser_32;
                                }
10349
                                goto basic_json_parser_30;
N
Niels Lohmann 已提交
10350 10351 10352 10353 10354 10355 10356
                            }
                            else
                            {
                                if (yych == 'b')
                                {
                                    goto basic_json_parser_30;
                                }
10357 10358 10359
                                goto basic_json_parser_32;
                            }
                        }
N
Niels Lohmann 已提交
10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372
                    }
                    else
                    {
                        if (yych <= 'q')
                        {
                            if (yych <= 'f')
                            {
                                goto basic_json_parser_30;
                            }
                            if (yych == 'n')
                            {
                                goto basic_json_parser_30;
                            }
10373
                            goto basic_json_parser_32;
N
Niels Lohmann 已提交
10374 10375 10376 10377 10378 10379 10380 10381 10382
                        }
                        else
                        {
                            if (yych <= 's')
                            {
                                if (yych <= 'r')
                                {
                                    goto basic_json_parser_30;
                                }
10383
                                goto basic_json_parser_32;
N
Niels Lohmann 已提交
10384 10385 10386 10387 10388 10389 10390 10391 10392 10393 10394
                            }
                            else
                            {
                                if (yych <= 't')
                                {
                                    goto basic_json_parser_30;
                                }
                                if (yych <= 'u')
                                {
                                    goto basic_json_parser_55;
                                }
10395 10396 10397 10398
                                goto basic_json_parser_32;
                            }
                        }
                    }
N
Niels Lohmann 已提交
10399
basic_json_parser_36:
10400
                    ++m_cursor;
N
Niels Lohmann 已提交
10401 10402 10403 10404
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
10405
                    yych = *m_cursor;
N
Niels Lohmann 已提交
10406 10407 10408 10409 10410 10411 10412 10413
                    if (yych <= 0x7F)
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= 0xBF)
                    {
                        goto basic_json_parser_30;
                    }
10414
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10415
basic_json_parser_37:
10416
                    ++m_cursor;
N
Niels Lohmann 已提交
10417 10418 10419 10420
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
10421
                    yych = *m_cursor;
N
Niels Lohmann 已提交
10422 10423 10424 10425 10426 10427 10428 10429
                    if (yych <= 0x9F)
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= 0xBF)
                    {
                        goto basic_json_parser_36;
                    }
10430
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10431
basic_json_parser_38:
10432
                    ++m_cursor;
N
Niels Lohmann 已提交
10433 10434 10435 10436
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
10437
                    yych = *m_cursor;
N
Niels Lohmann 已提交
10438 10439 10440 10441 10442 10443 10444 10445
                    if (yych <= 0x7F)
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= 0xBF)
                    {
                        goto basic_json_parser_36;
                    }
10446
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10447
basic_json_parser_39:
10448
                    ++m_cursor;
N
Niels Lohmann 已提交
10449 10450 10451 10452
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
10453
                    yych = *m_cursor;
N
Niels Lohmann 已提交
10454 10455 10456 10457 10458 10459 10460 10461
                    if (yych <= 0x7F)
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= 0x9F)
                    {
                        goto basic_json_parser_36;
                    }
10462
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10463
basic_json_parser_40:
10464
                    ++m_cursor;
N
Niels Lohmann 已提交
10465 10466 10467 10468
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
10469
                    yych = *m_cursor;
N
Niels Lohmann 已提交
10470 10471 10472 10473 10474 10475 10476 10477
                    if (yych <= 0x8F)
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= 0xBF)
                    {
                        goto basic_json_parser_38;
                    }
10478
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10479
basic_json_parser_41:
10480
                    ++m_cursor;
N
Niels Lohmann 已提交
10481 10482 10483 10484
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
10485
                    yych = *m_cursor;
N
Niels Lohmann 已提交
10486 10487 10488 10489 10490 10491 10492 10493
                    if (yych <= 0x7F)
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= 0xBF)
                    {
                        goto basic_json_parser_38;
                    }
10494
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10495
basic_json_parser_42:
10496
                    ++m_cursor;
N
Niels Lohmann 已提交
10497 10498 10499 10500
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
10501
                    yych = *m_cursor;
N
Niels Lohmann 已提交
10502 10503 10504 10505 10506 10507 10508 10509
                    if (yych <= 0x7F)
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= 0x8F)
                    {
                        goto basic_json_parser_38;
                    }
10510
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10511
basic_json_parser_43:
10512 10513
                    yyaccept = 2;
                    yych = *(m_marker = ++m_cursor);
N
Niels Lohmann 已提交
10514 10515 10516 10517 10518 10519 10520 10521 10522
                    if (yych <= '9')
                    {
                        if (yych == '.')
                        {
                            goto basic_json_parser_47;
                        }
                        if (yych >= '0')
                        {
                            goto basic_json_parser_48;
10523 10524
                        }
                    }
N
Niels Lohmann 已提交
10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547
                    else
                    {
                        if (yych <= 'E')
                        {
                            if (yych >= 'E')
                            {
                                goto basic_json_parser_51;
                            }
                        }
                        else
                        {
                            if (yych == 'e')
                            {
                                goto basic_json_parser_51;
                            }
                        }
                    }
basic_json_parser_44:
                    {
                        last_token_type = token_type::value_integer;
                        break;
                    }
basic_json_parser_45:
10548 10549
                    yyaccept = 2;
                    m_marker = ++m_cursor;
N
Niels Lohmann 已提交
10550 10551 10552 10553
                    if ((m_limit - m_cursor) < 3)
                    {
                        fill_line_buffer(3);    // LCOV_EXCL_LINE
                    }
10554
                    yych = *m_cursor;
N
Niels Lohmann 已提交
10555 10556 10557 10558 10559 10560 10561 10562 10563 10564
                    if (yych <= '9')
                    {
                        if (yych == '.')
                        {
                            goto basic_json_parser_47;
                        }
                        if (yych <= '/')
                        {
                            goto basic_json_parser_44;
                        }
10565
                        goto basic_json_parser_45;
N
Niels Lohmann 已提交
10566 10567 10568 10569 10570 10571 10572 10573 10574
                    }
                    else
                    {
                        if (yych <= 'E')
                        {
                            if (yych <= 'D')
                            {
                                goto basic_json_parser_44;
                            }
N
Niels Lohmann 已提交
10575
                            goto basic_json_parser_51;
N
Niels Lohmann 已提交
10576 10577 10578 10579 10580 10581 10582
                        }
                        else
                        {
                            if (yych == 'e')
                            {
                                goto basic_json_parser_51;
                            }
10583 10584 10585
                            goto basic_json_parser_44;
                        }
                    }
N
Niels Lohmann 已提交
10586
basic_json_parser_47:
10587
                    yych = *++m_cursor;
N
Niels Lohmann 已提交
10588 10589 10590 10591 10592 10593 10594 10595
                    if (yych <= '/')
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych <= '9')
                    {
                        goto basic_json_parser_56;
                    }
10596
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10597
basic_json_parser_48:
N
Niels Lohmann 已提交
10598
                    ++m_cursor;
N
Niels Lohmann 已提交
10599 10600 10601 10602
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
N
Niels Lohmann 已提交
10603
                    yych = *m_cursor;
N
Niels Lohmann 已提交
10604 10605 10606 10607 10608 10609 10610 10611 10612 10613 10614 10615 10616 10617
                    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:
10618
                    yych = *++m_cursor;
N
Niels Lohmann 已提交
10619 10620 10621 10622 10623 10624
                    if (yych <= ',')
                    {
                        if (yych == '+')
                        {
                            goto basic_json_parser_59;
                        }
10625
                        goto basic_json_parser_32;
N
Niels Lohmann 已提交
10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640
                    }
                    else
                    {
                        if (yych <= '-')
                        {
                            goto basic_json_parser_59;
                        }
                        if (yych <= '/')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= '9')
                        {
                            goto basic_json_parser_60;
                        }
10641 10642
                        goto basic_json_parser_32;
                    }
N
Niels Lohmann 已提交
10643
basic_json_parser_52:
10644
                    yych = *++m_cursor;
N
Niels Lohmann 已提交
10645 10646 10647 10648
                    if (yych == 'l')
                    {
                        goto basic_json_parser_62;
                    }
10649
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10650
basic_json_parser_53:
10651
                    yych = *++m_cursor;
N
Niels Lohmann 已提交
10652 10653 10654 10655
                    if (yych == 'l')
                    {
                        goto basic_json_parser_63;
                    }
10656
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10657
basic_json_parser_54:
10658
                    yych = *++m_cursor;
N
Niels Lohmann 已提交
10659 10660 10661 10662
                    if (yych == 'u')
                    {
                        goto basic_json_parser_64;
                    }
10663
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10664
basic_json_parser_55:
10665
                    ++m_cursor;
N
Niels Lohmann 已提交
10666 10667 10668 10669
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
10670
                    yych = *m_cursor;
N
Niels Lohmann 已提交
10671 10672 10673 10674 10675 10676 10677 10678 10679 10680
                    if (yych <= '@')
                    {
                        if (yych <= '/')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= '9')
                        {
                            goto basic_json_parser_65;
                        }
10681
                        goto basic_json_parser_32;
N
Niels Lohmann 已提交
10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696
                    }
                    else
                    {
                        if (yych <= 'F')
                        {
                            goto basic_json_parser_65;
                        }
                        if (yych <= '`')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= 'f')
                        {
                            goto basic_json_parser_65;
                        }
10697 10698
                        goto basic_json_parser_32;
                    }
N
Niels Lohmann 已提交
10699
basic_json_parser_56:
10700
                    yyaccept = 3;
10701
                    m_marker = ++m_cursor;
N
Niels Lohmann 已提交
10702 10703 10704 10705
                    if ((m_limit - m_cursor) < 3)
                    {
                        fill_line_buffer(3);    // LCOV_EXCL_LINE
                    }
10706
                    yych = *m_cursor;
N
Niels Lohmann 已提交
10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734
                    if (yych <= 'D')
                    {
                        if (yych <= '/')
                        {
                            goto basic_json_parser_58;
                        }
                        if (yych <= '9')
                        {
                            goto basic_json_parser_56;
                        }
                    }
                    else
                    {
                        if (yych <= 'E')
                        {
                            goto basic_json_parser_51;
                        }
                        if (yych == 'e')
                        {
                            goto basic_json_parser_51;
                        }
                    }
basic_json_parser_58:
                    {
                        last_token_type = token_type::value_float;
                        break;
                    }
basic_json_parser_59:
10735
                    yych = *++m_cursor;
N
Niels Lohmann 已提交
10736 10737 10738 10739 10740 10741 10742 10743 10744
                    if (yych <= '/')
                    {
                        goto basic_json_parser_32;
                    }
                    if (yych >= ':')
                    {
                        goto basic_json_parser_32;
                    }
basic_json_parser_60:
10745
                    ++m_cursor;
N
Niels Lohmann 已提交
10746 10747 10748 10749
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
10750
                    yych = *m_cursor;
N
Niels Lohmann 已提交
10751 10752 10753 10754 10755 10756 10757 10758
                    if (yych <= '/')
                    {
                        goto basic_json_parser_58;
                    }
                    if (yych <= '9')
                    {
                        goto basic_json_parser_60;
                    }
N
Niels Lohmann 已提交
10759
                    goto basic_json_parser_58;
N
Niels Lohmann 已提交
10760
basic_json_parser_62:
10761
                    yych = *++m_cursor;
N
Niels Lohmann 已提交
10762 10763 10764 10765
                    if (yych == 's')
                    {
                        goto basic_json_parser_66;
                    }
10766
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10767
basic_json_parser_63:
10768
                    yych = *++m_cursor;
N
Niels Lohmann 已提交
10769 10770 10771 10772
                    if (yych == 'l')
                    {
                        goto basic_json_parser_67;
                    }
10773
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10774
basic_json_parser_64:
10775
                    yych = *++m_cursor;
N
Niels Lohmann 已提交
10776 10777 10778 10779
                    if (yych == 'e')
                    {
                        goto basic_json_parser_69;
                    }
10780
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10781
basic_json_parser_65:
10782
                    ++m_cursor;
N
Niels Lohmann 已提交
10783 10784 10785 10786
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
10787
                    yych = *m_cursor;
N
Niels Lohmann 已提交
10788 10789 10790 10791 10792 10793 10794 10795 10796 10797
                    if (yych <= '@')
                    {
                        if (yych <= '/')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= '9')
                        {
                            goto basic_json_parser_71;
                        }
10798
                        goto basic_json_parser_32;
N
Niels Lohmann 已提交
10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813
                    }
                    else
                    {
                        if (yych <= 'F')
                        {
                            goto basic_json_parser_71;
                        }
                        if (yych <= '`')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= 'f')
                        {
                            goto basic_json_parser_71;
                        }
10814 10815
                        goto basic_json_parser_32;
                    }
N
Niels Lohmann 已提交
10816
basic_json_parser_66:
10817
                    yych = *++m_cursor;
N
Niels Lohmann 已提交
10818 10819 10820 10821
                    if (yych == 'e')
                    {
                        goto basic_json_parser_72;
                    }
10822
                    goto basic_json_parser_32;
N
Niels Lohmann 已提交
10823
basic_json_parser_67:
10824
                    ++m_cursor;
N
Niels Lohmann 已提交
10825 10826 10827 10828 10829
                    {
                        last_token_type = token_type::literal_null;
                        break;
                    }
basic_json_parser_69:
10830
                    ++m_cursor;
N
Niels Lohmann 已提交
10831 10832 10833 10834 10835
                    {
                        last_token_type = token_type::literal_true;
                        break;
                    }
basic_json_parser_71:
10836
                    ++m_cursor;
N
Niels Lohmann 已提交
10837 10838 10839 10840
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
10841
                    yych = *m_cursor;
N
Niels Lohmann 已提交
10842 10843 10844 10845 10846 10847 10848 10849 10850 10851
                    if (yych <= '@')
                    {
                        if (yych <= '/')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= '9')
                        {
                            goto basic_json_parser_74;
                        }
10852
                        goto basic_json_parser_32;
N
Niels Lohmann 已提交
10853 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867
                    }
                    else
                    {
                        if (yych <= 'F')
                        {
                            goto basic_json_parser_74;
                        }
                        if (yych <= '`')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= 'f')
                        {
                            goto basic_json_parser_74;
                        }
10868 10869
                        goto basic_json_parser_32;
                    }
N
Niels Lohmann 已提交
10870
basic_json_parser_72:
10871
                    ++m_cursor;
N
Niels Lohmann 已提交
10872 10873 10874 10875 10876
                    {
                        last_token_type = token_type::literal_false;
                        break;
                    }
basic_json_parser_74:
10877
                    ++m_cursor;
N
Niels Lohmann 已提交
10878 10879 10880 10881
                    if (m_limit <= m_cursor)
                    {
                        fill_line_buffer(1);    // LCOV_EXCL_LINE
                    }
10882
                    yych = *m_cursor;
N
Niels Lohmann 已提交
10883 10884 10885 10886 10887 10888 10889 10890 10891 10892
                    if (yych <= '@')
                    {
                        if (yych <= '/')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= '9')
                        {
                            goto basic_json_parser_30;
                        }
10893
                        goto basic_json_parser_32;
N
Niels Lohmann 已提交
10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908
                    }
                    else
                    {
                        if (yych <= 'F')
                        {
                            goto basic_json_parser_30;
                        }
                        if (yych <= '`')
                        {
                            goto basic_json_parser_32;
                        }
                        if (yych <= 'f')
                        {
                            goto basic_json_parser_30;
                        }
10909 10910 10911
                        goto basic_json_parser_32;
                    }
                }
10912

T
Théo DELRIEU 已提交
10913
            }
10914

T
Théo DELRIEU 已提交
10915 10916
            return last_token_type;
        }
10917

T
Théo DELRIEU 已提交
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 10944 10945 10946 10947 10948 10949 10950
        /*!
        @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 已提交
10951

T
Théo DELRIEU 已提交
10952 10953 10954
            // 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 已提交
10955

T
Théo DELRIEU 已提交
10956 10957 10958 10959 10960
            // 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 已提交
10961

T
Théo DELRIEU 已提交
10962
            // number of processed characters (p)
N
Niels Lohmann 已提交
10963
            const auto num_processed_chars = static_cast<size_t>(m_start - m_content);
T
Théo DELRIEU 已提交
10964 10965 10966 10967
            // 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 已提交
10968

T
Théo DELRIEU 已提交
10969 10970 10971 10972
            // 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 已提交
10973
                // this point. We trust the standard library to do the right
T
Théo DELRIEU 已提交
10974 10975
                // thing. See http://stackoverflow.com/q/28142011/266378
                m_line_buffer.assign(m_start, m_limit);
10976

T
Théo DELRIEU 已提交
10977 10978 10979 10980 10981 10982 10983 10984 10985
                // 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
10986
            {
T
Théo DELRIEU 已提交
10987 10988 10989 10990 10991 10992 10993 10994 10995
                // 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');
10996
            }
10997

T
Théo DELRIEU 已提交
10998 10999 11000 11001 11002 11003 11004
            // 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 已提交
11005 11006
        }

T
Théo DELRIEU 已提交
11007 11008 11009 11010 11011 11012 11013
        /// 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));
        }
11014

T
Théo DELRIEU 已提交
11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060
        /*!
        @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 已提交
11061
        indefinitely if i is always decreased. However, observe that the value
T
Théo DELRIEU 已提交
11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074
        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);
11075

T
Théo DELRIEU 已提交
11076 11077
            string_t result;
            result.reserve(static_cast<size_t>(m_cursor - m_start - 2));
11078

T
Théo DELRIEU 已提交
11079 11080
            // iterate the result between the quotes
            for (const lexer_char_t* i = m_start + 1; i < m_cursor - 1; ++i)
N
Niels 已提交
11081
            {
T
Théo DELRIEU 已提交
11082 11083 11084
                // find next escape character
                auto e = std::find(i, m_cursor - 1, '\\');
                if (e != i)
N
Niels 已提交
11085
                {
T
Théo DELRIEU 已提交
11086 11087
                    // see https://github.com/nlohmann/json/issues/365#issuecomment-262874705
                    for (auto k = i; k < e; k++)
11088
                    {
T
Théo DELRIEU 已提交
11089
                        result.push_back(static_cast<typename string_t::value_type>(*k));
11090
                    }
T
Théo DELRIEU 已提交
11091 11092 11093 11094 11095 11096 11097
                    i = e - 1; // -1 because of ++i
                }
                else
                {
                    // processing escaped character
                    // read next character
                    ++i;
N
Niels 已提交
11098

T
Théo DELRIEU 已提交
11099
                    switch (*i)
N
Niels 已提交
11100
                    {
T
Théo DELRIEU 已提交
11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141
                        // 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 已提交
11142

T
Théo DELRIEU 已提交
11143 11144
                        // unicode
                        case 'u':
N
Niels 已提交
11145
                        {
T
Théo DELRIEU 已提交
11146 11147 11148 11149 11150 11151
                            // 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 已提交
11152
                            {
T
Théo DELRIEU 已提交
11153 11154 11155
                                // make sure there is a subsequent unicode
                                if ((i + 6 >= m_limit) or * (i + 5) != '\\' or * (i + 6) != 'u')
                                {
11156
                                    JSON_THROW(std::invalid_argument("missing low surrogate"));
T
Théo DELRIEU 已提交
11157 11158 11159 11160 11161 11162 11163 11164
                                }

                                // 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 已提交
11165
                            }
T
Théo DELRIEU 已提交
11166 11167 11168
                            else if (codepoint >= 0xDC00 and codepoint <= 0xDFFF)
                            {
                                // we found a lone low surrogate
11169
                                JSON_THROW(std::invalid_argument("missing high surrogate"));
T
Théo DELRIEU 已提交
11170 11171 11172 11173 11174 11175 11176 11177 11178
                            }
                            else
                            {
                                // add unicode character(s)
                                result += to_unicode(codepoint);
                                // skip the next four characters (xxxx)
                                i += 4;
                            }
                            break;
N
Niels 已提交
11179 11180 11181 11182
                        }
                    }
                }
            }
T
Théo DELRIEU 已提交
11183 11184

            return result;
N
Niels 已提交
11185 11186
        }

11187

T
Théo DELRIEU 已提交
11188
        /*!
N
Niels Lohmann 已提交
11189 11190
        @brief parse string into a built-in arithmetic type as if the current
               locale is POSIX.
11191

N
Niels Lohmann 已提交
11192 11193
        @note in floating-point case strtod may parse past the token's end -
              this is not an error
11194

N
Niels Lohmann 已提交
11195
        @note any leading blanks are not handled
T
Théo DELRIEU 已提交
11196
        */
11197
        struct strtonum
T
Théo DELRIEU 已提交
11198
        {
11199
          public:
11200
            strtonum(const char* start, const char* end)
11201 11202
                : m_start(start), m_end(end)
            {}
11203

N
Niels Lohmann 已提交
11204 11205 11206 11207 11208 11209 11210
            /*!
            @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>
11211 11212 11213 11214
            bool to(T& val) const
            {
                return parse(val, std::is_integral<T>());
            }
N
Niels 已提交
11215

11216
          private:
11217
            const char* const m_start = nullptr;
N
Niels Lohmann 已提交
11218
            const char* const m_end = nullptr;
N
Niels 已提交
11219

11220 11221
            // floating-point conversion

A
Alex Astashyn 已提交
11222 11223
            // overloaded wrappers for strtod/strtof/strtold
            // that will be called from parse<floating_point_t>
N
Niels Lohmann 已提交
11224
            static void strtof(float& f, const char* str, char** endptr)
11225
            {
11226
                f = std::strtof(str, endptr);
N
Niels 已提交
11227 11228
            }

N
Niels Lohmann 已提交
11229
            static void strtof(double& f, const char* str, char** endptr)
T
Théo DELRIEU 已提交
11230
            {
11231
                f = std::strtod(str, endptr);
T
Théo DELRIEU 已提交
11232
            }
N
Niels 已提交
11233

N
Niels Lohmann 已提交
11234
            static void strtof(long double& f, const char* str, char** endptr)
T
Théo DELRIEU 已提交
11235
            {
11236
                f = std::strtold(str, endptr);
T
Théo DELRIEU 已提交
11237
            }
11238

11239 11240
            template<typename T>
            bool parse(T& value, /*is_integral=*/std::false_type) const
T
Théo DELRIEU 已提交
11241
            {
N
Niels Lohmann 已提交
11242 11243 11244
                // 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.
11245 11246
                std::string tempstr;
                std::array<char, 64> buf;
11247 11248
                const size_t len = static_cast<size_t>(m_end - m_start);

11249 11250 11251
                // lexer will reject empty numbers
                assert(len > 0);

N
Niels Lohmann 已提交
11252 11253 11254
                // 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
11255 11256
                const auto loc = localeconv();
                assert(loc != nullptr);
N
Niels Lohmann 已提交
11257
                const char decimal_point_char = (loc->decimal_point == nullptr) ? '.' : loc->decimal_point[0];
11258 11259 11260

                const char* data = m_start;

11261
                if (decimal_point_char != '.')
T
Théo DELRIEU 已提交
11262
                {
N
Niels Lohmann 已提交
11263
                    const size_t ds_pos = static_cast<size_t>(std::find(m_start, m_end, '.') - m_start);
11264

11265
                    if (ds_pos != len)
T
Théo DELRIEU 已提交
11266
                    {
N
Niels Lohmann 已提交
11267 11268 11269 11270
                        // 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())
11271
                        {
11272
                            std::copy(m_start, m_end, buf.begin());
11273 11274 11275 11276 11277 11278 11279 11280 11281 11282
                            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 已提交
11283 11284
                    }
                }
11285

11286 11287
                char* endptr = nullptr;
                value = 0;
11288
                // this calls appropriate overload depending on T
11289
                strtof(value, data, &endptr);
T
Théo DELRIEU 已提交
11290

11291 11292 11293
                // parsing was successful iff strtof parsed exactly the number
                // of characters determined by the lexer (len)
                const bool ok = (endptr == (data + len));
11294

11295
                if (ok and (value == static_cast<T>(0.0)) and (*data == '-'))
A
Alex Astashyn 已提交
11296
                {
11297 11298
                    // some implementations forget to negate the zero
                    value = -0.0;
N
Niels 已提交
11299
                }
N
Niels 已提交
11300

11301
                return ok;
N
Niels 已提交
11302
            }
11303

11304 11305
            // integral conversion

N
Niels Lohmann 已提交
11306
            signed long long parse_integral(char** endptr, /*is_signed*/std::true_type) const
11307 11308
            {
                return std::strtoll(m_start, endptr, 10);
11309
            }
N
Niels 已提交
11310

N
Niels Lohmann 已提交
11311
            unsigned long long parse_integral(char** endptr, /*is_signed*/std::false_type) const
T
Théo DELRIEU 已提交
11312
            {
11313
                return std::strtoull(m_start, endptr, 10);
T
Théo DELRIEU 已提交
11314
            }
11315 11316 11317

            template<typename T>
            bool parse(T& value, /*is_integral=*/std::true_type) const
N
Niels 已提交
11318
            {
11319
                char* endptr = nullptr;
N
Niels Lohmann 已提交
11320
                errno = 0; // these are thread-local
11321
                const auto x = parse_integral(&endptr, std::is_signed<T>());
N
Niels Lohmann 已提交
11322

N
Niels Lohmann 已提交
11323 11324
                // called right overload?
                static_assert(std::is_signed<T>() == std::is_signed<decltype(x)>(), "");
11325 11326 11327

                value = static_cast<T>(x);

N
Niels Lohmann 已提交
11328 11329
                return (x == static_cast<decltype(x)>(value)) // x fits into destination T
                       and (x < 0) == (value < 0)             // preserved sign
11330
                       //and ((x != 0) or is_integral())        // strto[u]ll did nto fail
N
Niels Lohmann 已提交
11331 11332 11333
                       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
11334
            }
11335 11336 11337 11338 11339 11340 11341 11342
        };

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

11344 11345
        integral numbers that don't fit into the the range of the respective
        type are parsed as number_float_t
N
Niels 已提交
11346

11347 11348
        floating-point values do not satisfy std::isfinite predicate
        are converted to value_t::null
11349 11350

        throws if the entire string [m_start .. m_cursor) cannot be
11351 11352 11353
        interpreted as a number

        @param[out] result  @ref basic_json object to receive the number.
11354
        @param[in]  token   the type of the number token
11355
        */
11356
        bool get_number(basic_json& result, const token_type token) const
11357 11358 11359
        {
            assert(m_start != nullptr);
            assert(m_start < m_cursor);
N
Niels Lohmann 已提交
11360 11361
            assert((token == token_type::value_unsigned) or
                   (token == token_type::value_integer) or
11362
                   (token == token_type::value_float));
11363

N
Niels Lohmann 已提交
11364 11365
            strtonum num_converter(reinterpret_cast<const char*>(m_start),
                                   reinterpret_cast<const char*>(m_cursor));
11366

11367
            switch (token)
11368
            {
N
Niels Lohmann 已提交
11369
                case lexer::token_type::value_unsigned:
N
Niels Lohmann 已提交
11370
                {
N
Niels Lohmann 已提交
11371 11372
                    number_unsigned_t val;
                    if (num_converter.to(val))
11373
                    {
11374
                        // parsing successful
11375 11376
                        result.m_type = value_t::number_unsigned;
                        result.m_value = val;
11377
                        return true;
11378 11379
                    }
                    break;
N
Niels Lohmann 已提交
11380
                }
11381

N
Niels Lohmann 已提交
11382
                case lexer::token_type::value_integer:
11383
                {
N
Niels Lohmann 已提交
11384 11385
                    number_integer_t val;
                    if (num_converter.to(val))
11386
                    {
11387
                        // parsing successful
11388 11389
                        result.m_type = value_t::number_integer;
                        result.m_value = val;
11390
                        return true;
11391 11392 11393 11394 11395
                    }
                    break;
                }

                default:
T
Théo DELRIEU 已提交
11396
                {
11397
                    break;
T
Théo DELRIEU 已提交
11398 11399 11400
                }
            }

N
Niels Lohmann 已提交
11401 11402 11403
            // parse float (either explicitly or because a previous conversion
            // failed)
            number_float_t val;
11404
            if (num_converter.to(val))
A
Alex Astashyn 已提交
11405
            {
11406 11407 11408
                // parsing successful
                result.m_type = value_t::number_float;
                result.m_value = val;
N
Niels 已提交
11409

11410 11411 11412 11413 11414 11415
                // 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();
                }
11416

11417
                return true;
11418
            }
11419 11420 11421

            // couldn't parse number in any format
            return false;
T
Théo DELRIEU 已提交
11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443
        }

      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 已提交
11444

N
Niels 已提交
11445 11446
    /*!
    @brief syntax analysis
N
Niels 已提交
11447 11448

    This class implements a recursive decent parser.
N
Niels 已提交
11449
    */
N
Niels 已提交
11450 11451
    class parser
    {
T
Théo DELRIEU 已提交
11452
      public:
11453
        /// a parser reading from a string literal
N
Niels 已提交
11454
        parser(const char* buff, const parser_callback_t cb = nullptr)
T
Théo DELRIEU 已提交
11455 11456 11457
            : callback(cb),
              m_lexer(reinterpret_cast<const typename lexer::lexer_char_t*>(buff), std::strlen(buff))
        {}
11458

T
Théo DELRIEU 已提交
11459 11460 11461 11462
        /// a parser reading from an input stream
        parser(std::istream& is, const parser_callback_t cb = nullptr)
            : callback(cb), m_lexer(is)
        {}
11463

T
Théo DELRIEU 已提交
11464 11465 11466 11467 11468 11469 11470 11471 11472 11473
        /// 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 已提交
11474

T
Théo DELRIEU 已提交
11475 11476 11477 11478 11479
        /// public parser interface
        basic_json parse()
        {
            // read first token
            get_token();
N
Niels 已提交
11480

T
Théo DELRIEU 已提交
11481 11482
            basic_json result = parse_internal(true);
            result.assert_invariant();
N
Niels 已提交
11483

T
Théo DELRIEU 已提交
11484
            expect(lexer::token_type::end_of_input);
N
Niels 已提交
11485

T
Théo DELRIEU 已提交
11486 11487 11488 11489
            // 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 已提交
11490

T
Théo DELRIEU 已提交
11491 11492 11493
      private:
        /// the actual parser
        basic_json parse_internal(bool keep)
11494
        {
T
Théo DELRIEU 已提交
11495 11496 11497
            auto result = basic_json(value_t::discarded);

            switch (last_token)
N
Niels 已提交
11498
            {
T
Théo DELRIEU 已提交
11499
                case lexer::token_type::begin_object:
N
Niels 已提交
11500
                {
T
Théo DELRIEU 已提交
11501 11502 11503 11504 11505 11506 11507
                    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 已提交
11508

T
Théo DELRIEU 已提交
11509 11510
                    // read next token
                    get_token();
N
Niels 已提交
11511

T
Théo DELRIEU 已提交
11512 11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561 11562 11563 11564 11565 11566 11567 11568
                    // 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 已提交
11569
                    get_token();
N
Niels 已提交
11570
                    if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
N
Niels 已提交
11571 11572 11573
                    {
                        result = basic_json(value_t::discarded);
                    }
T
Théo DELRIEU 已提交
11574

N
Niels 已提交
11575
                    return result;
N
Niels 已提交
11576 11577
                }

T
Théo DELRIEU 已提交
11578
                case lexer::token_type::begin_array:
11579
                {
T
Théo DELRIEU 已提交
11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592
                    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 已提交
11593
                    {
N
Niels 已提交
11594
                        get_token();
T
Théo DELRIEU 已提交
11595 11596 11597 11598 11599
                        if (callback and not callback(--depth, parse_event_t::array_end, result))
                        {
                            result = basic_json(value_t::discarded);
                        }
                        return result;
N
Niels 已提交
11600 11601
                    }

T
Théo DELRIEU 已提交
11602 11603
                    // no comma is expected here
                    unexpect(lexer::token_type::value_separator);
N
Niels 已提交
11604

T
Théo DELRIEU 已提交
11605 11606
                    // otherwise: parse values
                    do
N
Niels 已提交
11607
                    {
T
Théo DELRIEU 已提交
11608 11609
                        // ugly, but could be fixed with loop reorganization
                        if (last_token == lexer::token_type::value_separator)
N
Niels 已提交
11610
                        {
T
Théo DELRIEU 已提交
11611
                            get_token();
N
Niels 已提交
11612
                        }
T
Théo DELRIEU 已提交
11613 11614 11615 11616

                        // parse value
                        auto value = parse_internal(keep);
                        if (keep and not value.is_discarded())
N
Niels 已提交
11617
                        {
T
Théo DELRIEU 已提交
11618
                            result.push_back(std::move(value));
N
Niels 已提交
11619
                        }
N
Niels 已提交
11620
                    }
T
Théo DELRIEU 已提交
11621
                    while (last_token == lexer::token_type::value_separator);
N
Niels 已提交
11622

T
Théo DELRIEU 已提交
11623 11624
                    // closing ]
                    expect(lexer::token_type::end_array);
11625
                    get_token();
T
Théo DELRIEU 已提交
11626
                    if (keep and callback and not callback(--depth, parse_event_t::array_end, result))
N
Niels 已提交
11627
                    {
T
Théo DELRIEU 已提交
11628
                        result = basic_json(value_t::discarded);
N
Niels 已提交
11629
                    }
T
Théo DELRIEU 已提交
11630 11631

                    return result;
N
Niels 已提交
11632 11633
                }

T
Théo DELRIEU 已提交
11634
                case lexer::token_type::literal_null:
N
Niels 已提交
11635
                {
T
Théo DELRIEU 已提交
11636 11637 11638
                    get_token();
                    result.m_type = value_t::null;
                    break;
N
Niels 已提交
11639 11640
                }

T
Théo DELRIEU 已提交
11641
                case lexer::token_type::value_string:
N
Niels 已提交
11642
                {
T
Théo DELRIEU 已提交
11643 11644 11645 11646
                    const auto s = m_lexer.get_string();
                    get_token();
                    result = basic_json(s);
                    break;
N
Niels 已提交
11647 11648
                }

T
Théo DELRIEU 已提交
11649
                case lexer::token_type::literal_true:
N
Niels 已提交
11650
                {
N
Niels 已提交
11651
                    get_token();
T
Théo DELRIEU 已提交
11652 11653 11654
                    result.m_type = value_t::boolean;
                    result.m_value = true;
                    break;
N
Niels 已提交
11655 11656
                }

T
Théo DELRIEU 已提交
11657
                case lexer::token_type::literal_false:
N
Niels 已提交
11658
                {
T
Théo DELRIEU 已提交
11659 11660 11661 11662
                    get_token();
                    result.m_type = value_t::boolean;
                    result.m_value = false;
                    break;
N
Niels 已提交
11663 11664
                }

N
Niels Lohmann 已提交
11665 11666
                case lexer::token_type::value_unsigned:
                case lexer::token_type::value_integer:
11667
                case lexer::token_type::value_float:
N
Niels 已提交
11668
                {
N
Niels Lohmann 已提交
11669
                    m_lexer.get_number(result, last_token);
T
Théo DELRIEU 已提交
11670 11671
                    get_token();
                    break;
N
Niels 已提交
11672
                }
11673

T
Théo DELRIEU 已提交
11674 11675 11676 11677 11678
                default:
                {
                    // the last token was unexpected
                    unexpect(last_token);
                }
11679 11680
            }

T
Théo DELRIEU 已提交
11681
            if (keep and callback and not callback(depth, parse_event_t::value, result))
11682
            {
T
Théo DELRIEU 已提交
11683
                result = basic_json(value_t::discarded);
N
Niels 已提交
11684
            }
T
Théo DELRIEU 已提交
11685
            return result;
N
Niels 已提交
11686 11687
        }

T
Théo DELRIEU 已提交
11688 11689
        /// get next token from lexer
        typename lexer::token_type get_token()
N
Niels 已提交
11690
        {
T
Théo DELRIEU 已提交
11691 11692
            last_token = m_lexer.scan();
            return last_token;
N
Niels 已提交
11693 11694
        }

T
Théo DELRIEU 已提交
11695
        void expect(typename lexer::token_type t) const
N
Niels 已提交
11696
        {
T
Théo DELRIEU 已提交
11697 11698 11699 11700 11701 11702 11703
            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);
11704
                JSON_THROW(std::invalid_argument(error_msg));
T
Théo DELRIEU 已提交
11705
            }
N
Niels 已提交
11706 11707
        }

T
Théo DELRIEU 已提交
11708
        void unexpect(typename lexer::token_type t) const
N
Niels 已提交
11709
        {
T
Théo DELRIEU 已提交
11710 11711 11712 11713 11714 11715
            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));
11716
                JSON_THROW(std::invalid_argument(error_msg));
T
Théo DELRIEU 已提交
11717
            }
N
Niels 已提交
11718 11719
        }

T
Théo DELRIEU 已提交
11720 11721 11722 11723 11724 11725 11726 11727 11728 11729
      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 已提交
11730 11731

  public:
N
Niels 已提交
11732 11733 11734
    /*!
    @brief JSON Pointer

N
Niels 已提交
11735 11736 11737 11738
    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 已提交
11739
    @sa [RFC 6901](https://tools.ietf.org/html/rfc6901)
N
Niels 已提交
11740 11741

    @since version 2.0.0
N
Niels 已提交
11742
    */
N
Niels 已提交
11743 11744
    class json_pointer
    {
N
Niels 已提交
11745 11746 11747
        /// allow basic_json to access private members
        friend class basic_json;

T
Théo DELRIEU 已提交
11748
      public:
N
Niels 已提交
11749 11750 11751 11752 11753 11754 11755 11756 11757 11758
        /*!
        @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 已提交
11759 11760 11761 11762 11763 11764
        @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 已提交
11765 11766 11767

        @liveexample{The example shows the construction several valid JSON
        pointers as well as the exceptional behavior.,json_pointer}
N
Niels 已提交
11768

N
Niels 已提交
11769 11770 11771
        @since version 2.0.0
        */
        explicit json_pointer(const std::string& s = "")
T
Théo DELRIEU 已提交
11772 11773
            : reference_tokens(split(s))
        {}
N
Niels 已提交
11774

T
Théo DELRIEU 已提交
11775 11776
        /*!
        @brief return a string representation of the JSON pointer
N
Niels 已提交
11777

T
Théo DELRIEU 已提交
11778 11779 11780 11781
        @invariant For each JSON pointer `ptr`, it holds:
        @code {.cpp}
        ptr == json_pointer(ptr.to_string());
        @endcode
N
Niels 已提交
11782

T
Théo DELRIEU 已提交
11783
        @return a string representation of the JSON pointer
N
Niels 已提交
11784

T
Théo DELRIEU 已提交
11785 11786
        @liveexample{The example shows the result of `to_string`.,
        json_pointer__to_string}
N
Niels 已提交
11787

T
Théo DELRIEU 已提交
11788 11789 11790
        @since version 2.0.0
        */
        std::string to_string() const noexcept
N
Niels 已提交
11791
        {
T
Théo DELRIEU 已提交
11792 11793 11794 11795 11796 11797 11798
            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 已提交
11799

T
Théo DELRIEU 已提交
11800 11801
        /// @copydoc to_string()
        operator std::string() const
N
Niels 已提交
11802
        {
T
Théo DELRIEU 已提交
11803
            return to_string();
N
Niels 已提交
11804 11805
        }

T
Théo DELRIEU 已提交
11806 11807 11808 11809 11810 11811 11812 11813
      private:
        /// remove and return last reference pointer
        std::string pop_back()
        {
            if (is_root())
            {
                JSON_THROW(std::domain_error("JSON pointer has no parent"));
            }
11814

T
Théo DELRIEU 已提交
11815 11816 11817 11818
            auto last = reference_tokens.back();
            reference_tokens.pop_back();
            return last;
        }
N
Niels 已提交
11819

T
Théo DELRIEU 已提交
11820 11821
        /// return whether pointer points to the root document
        bool is_root() const
N
Niels 已提交
11822
        {
T
Théo DELRIEU 已提交
11823
            return reference_tokens.empty();
N
Niels 已提交
11824 11825
        }

T
Théo DELRIEU 已提交
11826 11827 11828 11829 11830 11831
        json_pointer top() const
        {
            if (is_root())
            {
                JSON_THROW(std::domain_error("JSON pointer has no parent"));
            }
N
Niels 已提交
11832

T
Théo DELRIEU 已提交
11833 11834 11835 11836
            json_pointer result = *this;
            result.reference_tokens = {reference_tokens[0]};
            return result;
        }
N
Niels 已提交
11837

T
Théo DELRIEU 已提交
11838 11839
        /*!
        @brief create and return a reference to the pointed to value
11840

T
Théo DELRIEU 已提交
11841 11842 11843
        @complexity Linear in the number of reference tokens.
        */
        reference get_and_create(reference j) const
11844
        {
T
Théo DELRIEU 已提交
11845 11846 11847 11848 11849
            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 已提交
11850
            {
T
Théo DELRIEU 已提交
11851
                switch (result->m_type)
N
Niels 已提交
11852
                {
T
Théo DELRIEU 已提交
11853
                    case value_t::null:
N
Niels 已提交
11854
                    {
T
Théo DELRIEU 已提交
11855 11856 11857 11858 11859 11860 11861 11862 11863 11864 11865
                        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 已提交
11866
                    }
T
Théo DELRIEU 已提交
11867 11868

                    case value_t::object:
N
Niels 已提交
11869
                    {
T
Théo DELRIEU 已提交
11870
                        // create an entry in the object
N
Niels 已提交
11871
                        result = &result->operator[](reference_token);
T
Théo DELRIEU 已提交
11872
                        break;
N
Niels 已提交
11873
                    }
N
Niels 已提交
11874

T
Théo DELRIEU 已提交
11875 11876 11877 11878 11879 11880
                    case value_t::array:
                    {
                        // create an entry in the array
                        result = &result->operator[](static_cast<size_type>(std::stoi(reference_token)));
                        break;
                    }
11881

T
Théo DELRIEU 已提交
11882 11883 11884 11885 11886 11887 11888 11889 11890
                    /*
                    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:
                    {
11891
                        JSON_THROW(std::domain_error("invalid value to unflatten"));
T
Théo DELRIEU 已提交
11892
                    }
N
Niels 已提交
11893 11894
                }
            }
11895

T
Théo DELRIEU 已提交
11896 11897
            return *result;
        }
11898

T
Théo DELRIEU 已提交
11899 11900
        /*!
        @brief return a reference to the pointed to value
11901

T
Théo DELRIEU 已提交
11902 11903 11904 11905 11906
        @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 已提交
11907

T
Théo DELRIEU 已提交
11908
        @param[in] ptr  a JSON value
N
Niels 已提交
11909

T
Théo DELRIEU 已提交
11910
        @return reference to the JSON value pointed to by the JSON pointer
N
Niels 已提交
11911

T
Théo DELRIEU 已提交
11912
        @complexity Linear in the length of the JSON pointer.
11913

T
Théo DELRIEU 已提交
11914 11915 11916 11917 11918
        @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
11919
        {
T
Théo DELRIEU 已提交
11920
            for (const auto& reference_token : reference_tokens)
11921
            {
T
Théo DELRIEU 已提交
11922 11923
                // convert null values to arrays or objects before continuing
                if (ptr->m_type == value_t::null)
11924
                {
T
Théo DELRIEU 已提交
11925 11926 11927 11928
                    // check if reference token is a number
                    const bool nums = std::all_of(reference_token.begin(),
                                                  reference_token.end(),
                                                  [](const char x)
N
Niels 已提交
11929
                    {
T
Théo DELRIEU 已提交
11930 11931
                        return std::isdigit(x);
                    });
N
Niels 已提交
11932

T
Théo DELRIEU 已提交
11933 11934 11935
                    // change value to array for numbers or "-" or to object
                    // otherwise
                    if (nums or reference_token == "-")
N
Niels 已提交
11936
                    {
T
Théo DELRIEU 已提交
11937
                        *ptr = value_t::array;
N
Niels 已提交
11938 11939 11940
                    }
                    else
                    {
T
Théo DELRIEU 已提交
11941
                        *ptr = value_t::object;
N
Niels 已提交
11942
                    }
N
Niels 已提交
11943 11944
                }

T
Théo DELRIEU 已提交
11945
                switch (ptr->m_type)
N
Niels 已提交
11946
                {
T
Théo DELRIEU 已提交
11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963
                    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 已提交
11964
                            // explicitly treat "-" as index beyond the end
T
Théo DELRIEU 已提交
11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976
                            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:
                    {
11977
                        JSON_THROW(std::out_of_range("unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
11978
                    }
N
Niels 已提交
11979 11980
                }
            }
N
Niels 已提交
11981

T
Théo DELRIEU 已提交
11982 11983
            return *ptr;
        }
11984

T
Théo DELRIEU 已提交
11985
        reference get_checked(pointer ptr) const
N
Niels 已提交
11986
        {
T
Théo DELRIEU 已提交
11987
            for (const auto& reference_token : reference_tokens)
N
Niels 已提交
11988
            {
T
Théo DELRIEU 已提交
11989
                switch (ptr->m_type)
11990
                {
T
Théo DELRIEU 已提交
11991
                    case value_t::object:
N
Niels 已提交
11992
                    {
T
Théo DELRIEU 已提交
11993 11994 11995
                        // note: at performs range check
                        ptr = &ptr->at(reference_token);
                        break;
N
Niels 已提交
11996 11997
                    }

T
Théo DELRIEU 已提交
11998
                    case value_t::array:
N
Niels 已提交
11999
                    {
T
Théo DELRIEU 已提交
12000 12001 12002
                        if (reference_token == "-")
                        {
                            // "-" always fails the range check
12003 12004 12005
                            JSON_THROW(std::out_of_range("array index '-' (" +
                                                         std::to_string(ptr->m_value.array->size()) +
                                                         ") is out of range"));
T
Théo DELRIEU 已提交
12006 12007 12008 12009 12010
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
12011
                            JSON_THROW(std::domain_error("array index must not begin with '0'"));
T
Théo DELRIEU 已提交
12012
                        }
N
Niels 已提交
12013

T
Théo DELRIEU 已提交
12014 12015 12016 12017
                        // note: at performs range check
                        ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
                        break;
                    }
12018

T
Théo DELRIEU 已提交
12019 12020
                    default:
                    {
12021
                        JSON_THROW(std::out_of_range("unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
12022
                    }
N
Niels 已提交
12023 12024 12025
                }
            }

T
Théo DELRIEU 已提交
12026 12027
            return *ptr;
        }
N
Niels 已提交
12028

T
Théo DELRIEU 已提交
12029 12030
        /*!
        @brief return a const reference to the pointed to value
N
Niels 已提交
12031

T
Théo DELRIEU 已提交
12032
        @param[in] ptr  a JSON value
12033

T
Théo DELRIEU 已提交
12034 12035 12036 12037
        @return const reference to the JSON value pointed to by the JSON
                pointer
        */
        const_reference get_unchecked(const_pointer ptr) const
N
Niels 已提交
12038
        {
T
Théo DELRIEU 已提交
12039
            for (const auto& reference_token : reference_tokens)
N
Niels 已提交
12040
            {
T
Théo DELRIEU 已提交
12041
                switch (ptr->m_type)
12042
                {
T
Théo DELRIEU 已提交
12043
                    case value_t::object:
N
Niels 已提交
12044
                    {
T
Théo DELRIEU 已提交
12045 12046 12047
                        // use unchecked object access
                        ptr = &ptr->operator[](reference_token);
                        break;
N
Niels 已提交
12048 12049
                    }

T
Théo DELRIEU 已提交
12050
                    case value_t::array:
N
Niels 已提交
12051
                    {
T
Théo DELRIEU 已提交
12052 12053 12054
                        if (reference_token == "-")
                        {
                            // "-" cannot be used for const access
12055 12056 12057
                            JSON_THROW(std::out_of_range("array index '-' (" +
                                                         std::to_string(ptr->m_value.array->size()) +
                                                         ") is out of range"));
T
Théo DELRIEU 已提交
12058 12059 12060 12061 12062
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
12063
                            JSON_THROW(std::domain_error("array index must not begin with '0'"));
T
Théo DELRIEU 已提交
12064
                        }
N
Niels 已提交
12065

T
Théo DELRIEU 已提交
12066 12067 12068 12069
                        // use unchecked array access
                        ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
                        break;
                    }
12070

T
Théo DELRIEU 已提交
12071 12072
                    default:
                    {
12073
                        JSON_THROW(std::out_of_range("unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
12074
                    }
N
Niels 已提交
12075 12076 12077
                }
            }

T
Théo DELRIEU 已提交
12078 12079
            return *ptr;
        }
12080

T
Théo DELRIEU 已提交
12081
        const_reference get_checked(const_pointer ptr) const
12082
        {
T
Théo DELRIEU 已提交
12083
            for (const auto& reference_token : reference_tokens)
12084
            {
T
Théo DELRIEU 已提交
12085
                switch (ptr->m_type)
12086
                {
T
Théo DELRIEU 已提交
12087
                    case value_t::object:
N
Niels 已提交
12088
                    {
T
Théo DELRIEU 已提交
12089 12090 12091
                        // note: at performs range check
                        ptr = &ptr->at(reference_token);
                        break;
N
Niels 已提交
12092
                    }
12093

T
Théo DELRIEU 已提交
12094
                    case value_t::array:
N
Niels 已提交
12095
                    {
T
Théo DELRIEU 已提交
12096 12097 12098
                        if (reference_token == "-")
                        {
                            // "-" always fails the range check
12099 12100 12101
                            JSON_THROW(std::out_of_range("array index '-' (" +
                                                         std::to_string(ptr->m_value.array->size()) +
                                                         ") is out of range"));
T
Théo DELRIEU 已提交
12102 12103 12104 12105 12106
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
12107
                            JSON_THROW(std::domain_error("array index must not begin with '0'"));
T
Théo DELRIEU 已提交
12108
                        }
12109

T
Théo DELRIEU 已提交
12110 12111 12112 12113
                        // note: at performs range check
                        ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
                        break;
                    }
12114

T
Théo DELRIEU 已提交
12115 12116
                    default:
                    {
12117
                        JSON_THROW(std::out_of_range("unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
12118
                    }
12119 12120
                }
            }
N
Niels 已提交
12121

T
Théo DELRIEU 已提交
12122
            return *ptr;
12123 12124
        }

T
Théo DELRIEU 已提交
12125 12126
        /// split the string input to reference tokens
        static std::vector<std::string> split(const std::string& reference_string)
12127
        {
T
Théo DELRIEU 已提交
12128 12129 12130 12131 12132 12133 12134 12135 12136 12137 12138
            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] != '/')
            {
12139
                JSON_THROW(std::domain_error("JSON pointer must be empty or begin with '/'"));
T
Théo DELRIEU 已提交
12140
            }
N
Niels 已提交
12141

T
Théo DELRIEU 已提交
12142 12143 12144 12145 12146
            // 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 已提交
12147
                size_t slash = reference_string.find_first_of('/', 1),
T
Théo DELRIEU 已提交
12148 12149 12150 12151 12152 12153 12154 12155
                // 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 已提交
12156
                slash = reference_string.find_first_of('/', start))
T
Théo DELRIEU 已提交
12157 12158 12159 12160
            {
                // 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 已提交
12161

T
Théo DELRIEU 已提交
12162
                // check reference tokens are properly escaped
N
Niels Lohmann 已提交
12163
                for (size_t pos = reference_token.find_first_of('~');
T
Théo DELRIEU 已提交
12164
                        pos != std::string::npos;
N
Niels Lohmann 已提交
12165
                        pos = reference_token.find_first_of('~', pos + 1))
12166
                {
T
Théo DELRIEU 已提交
12167 12168 12169 12170 12171 12172 12173
                    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'))
                    {
12174
                        JSON_THROW(std::domain_error("escape error: '~' must be followed with '0' or '1'"));
T
Théo DELRIEU 已提交
12175
                    }
N
Niels 已提交
12176
                }
T
Théo DELRIEU 已提交
12177 12178 12179 12180

                // finally, store the reference token
                unescape(reference_token);
                result.push_back(reference_token);
12181
            }
N
Niels 已提交
12182

T
Théo DELRIEU 已提交
12183
            return result;
N
Niels 已提交
12184
        }
N
Niels 已提交
12185

T
Théo DELRIEU 已提交
12186 12187 12188
      private:
        /*!
        @brief replace all occurrences of a substring by another string
N
Niels 已提交
12189

T
Théo DELRIEU 已提交
12190 12191 12192 12193
        @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 已提交
12194

T
Théo DELRIEU 已提交
12195
        @pre The search string @a f must not be empty.
N
Niels 已提交
12196

T
Théo DELRIEU 已提交
12197 12198 12199 12200 12201 12202 12203
        @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 已提交
12204

T
Théo DELRIEU 已提交
12205 12206 12207 12208 12209 12210 12211
            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 已提交
12212

T
Théo DELRIEU 已提交
12213 12214 12215 12216 12217 12218 12219 12220
        /// 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 已提交
12221

T
Théo DELRIEU 已提交
12222 12223 12224 12225 12226 12227 12228 12229
        /// 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 已提交
12230

T
Théo DELRIEU 已提交
12231 12232 12233 12234
        /*!
        @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
12235

T
Théo DELRIEU 已提交
12236 12237 12238 12239 12240
        @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 已提交
12241
        {
T
Théo DELRIEU 已提交
12242
            switch (value.m_type)
N
Niels 已提交
12243
            {
T
Théo DELRIEU 已提交
12244
                case value_t::array:
12245
                {
T
Théo DELRIEU 已提交
12246 12247 12248 12249 12250 12251
                    if (value.m_value.array->empty())
                    {
                        // flatten empty array as null
                        result[reference_string] = nullptr;
                    }
                    else
N
Niels 已提交
12252
                    {
T
Théo DELRIEU 已提交
12253 12254 12255 12256 12257 12258
                        // 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 已提交
12259
                    }
T
Théo DELRIEU 已提交
12260
                    break;
N
Niels 已提交
12261 12262
                }

T
Théo DELRIEU 已提交
12263
                case value_t::object:
12264
                {
T
Théo DELRIEU 已提交
12265 12266 12267 12268 12269 12270
                    if (value.m_value.object->empty())
                    {
                        // flatten empty object as null
                        result[reference_string] = nullptr;
                    }
                    else
N
Niels 已提交
12271
                    {
T
Théo DELRIEU 已提交
12272 12273 12274 12275 12276 12277
                        // 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 已提交
12278
                    }
T
Théo DELRIEU 已提交
12279
                    break;
N
Niels 已提交
12280 12281
                }

T
Théo DELRIEU 已提交
12282 12283 12284 12285 12286 12287
                default:
                {
                    // add primitive value with its reference string
                    result[reference_string] = value;
                    break;
                }
N
Niels 已提交
12288 12289
            }
        }
N
Niels 已提交
12290

T
Théo DELRIEU 已提交
12291 12292
        /*!
        @param[in] value  flattened JSON
N
Niels 已提交
12293

T
Théo DELRIEU 已提交
12294 12295 12296
        @return unflattened JSON
        */
        static basic_json unflatten(const basic_json& value)
N
Niels 已提交
12297
        {
T
Théo DELRIEU 已提交
12298 12299
            if (not value.is_object())
            {
12300
                JSON_THROW(std::domain_error("only objects can be unflattened"));
T
Théo DELRIEU 已提交
12301
            }
N
Niels 已提交
12302

T
Théo DELRIEU 已提交
12303
            basic_json result;
N
Niels 已提交
12304

T
Théo DELRIEU 已提交
12305 12306
            // iterate the JSON object values
            for (const auto& element : *value.m_value.object)
N
Niels 已提交
12307
            {
T
Théo DELRIEU 已提交
12308 12309
                if (not element.second.is_primitive())
                {
12310
                    JSON_THROW(std::domain_error("values in object must be primitive"));
T
Théo DELRIEU 已提交
12311 12312 12313 12314 12315 12316 12317 12318
                }

                // 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 已提交
12319 12320
            }

T
Théo DELRIEU 已提交
12321
            return result;
N
Niels 已提交
12322
        }
N
Niels 已提交
12323

T
Théo DELRIEU 已提交
12324 12325 12326 12327 12328 12329
      private:
        friend bool operator==(json_pointer const& lhs,
                               json_pointer const& rhs) noexcept
        {
            return lhs.reference_tokens == rhs.reference_tokens;
        }
12330

T
Théo DELRIEU 已提交
12331 12332 12333 12334 12335
        friend bool operator!=(json_pointer const& lhs,
                               json_pointer const& rhs) noexcept
        {
            return !(lhs == rhs);
        }
12336

T
Théo DELRIEU 已提交
12337 12338
        /// the reference tokens
        std::vector<std::string> reference_tokens {};
12339
    };
N
Niels 已提交
12340

N
Niels 已提交
12341 12342 12343
    //////////////////////////
    // JSON Pointer support //
    //////////////////////////
N
Niels 已提交
12344 12345 12346 12347

    /// @name JSON Pointer functions
    /// @{

N
Niels 已提交
12348 12349 12350 12351
    /*!
    @brief access specified element via JSON Pointer

    Uses a JSON pointer to retrieve a reference to the respective JSON value.
N
Niels 已提交
12352 12353 12354
    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 已提交
12355 12356 12357 12358 12359 12360 12361 12362 12363 12364 12365 12366 12367 12368 12369 12370 12371 12372 12373 12374 12375 12376 12377 12378 12379 12380 12381 12382 12383 12384 12385 12386 12387 12388 12389 12390 12391 12392 12393 12394 12395 12396 12397 12398 12399 12400 12401 12402 12403 12404 12405 12406 12407 12408 12409 12410 12411 12412 12413 12414 12415 12416 12417 12418 12419 12420 12421 12422 12423 12424 12425 12426 12427 12428 12429 12430 12431 12432 12433 12434 12435 12436 12437 12438 12439 12440

    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 已提交
12441 12442
    Returns a const reference to the element at with specified JSON pointer @a
    ptr, with bounds checking.
N
Niels 已提交
12443 12444 12445 12446 12447 12448 12449 12450 12451 12452 12453 12454 12455 12456 12457 12458 12459 12460 12461 12462

    @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 已提交
12463
    /*!
N
Niels 已提交
12464 12465
    @brief return flattened JSON value

N
Niels 已提交
12466 12467 12468 12469
    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 已提交
12470

N
Niels Lohmann 已提交
12471
    @return an object that maps JSON pointers to primitive values
N
Niels 已提交
12472

N
Niels 已提交
12473 12474
    @note Empty objects and arrays are flattened to `null` and will not be
          reconstructed correctly by the @ref unflatten() function.
N
Niels 已提交
12475 12476 12477 12478 12479 12480 12481 12482 12483

    @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 已提交
12484 12485 12486 12487 12488 12489 12490
    */
    basic_json flatten() const
    {
        basic_json result(value_t::object);
        json_pointer::flatten("", *this, result);
        return result;
    }
N
Niels 已提交
12491 12492

    /*!
N
Niels 已提交
12493 12494 12495 12496 12497 12498 12499 12500 12501 12502
    @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 已提交
12503
    @return the original JSON from a flattened version
N
Niels 已提交
12504 12505 12506 12507 12508 12509 12510 12511 12512 12513 12514 12515 12516 12517

    @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 已提交
12518
    */
N
Niels 已提交
12519
    basic_json unflatten() const
N
Niels 已提交
12520
    {
N
Niels 已提交
12521
        return json_pointer::unflatten(*this);
N
Niels 已提交
12522
    }
N
Niels 已提交
12523 12524

    /// @}
12525

N
Niels 已提交
12526 12527 12528 12529 12530 12531 12532
    //////////////////////////
    // JSON Patch functions //
    //////////////////////////

    /// @name JSON Patch functions
    /// @{

12533 12534 12535
    /*!
    @brief applies a JSON patch

N
Niels 已提交
12536 12537
    [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 已提交
12538
    this function, a JSON Patch is applied to the current JSON value by
N
Niels 已提交
12539 12540
    executing all operations from the patch.

N
Niels 已提交
12541
    @param[in] json_patch  JSON patch document
12542 12543
    @return patched document

N
Niels 已提交
12544 12545 12546 12547 12548 12549 12550 12551 12552 12553 12554 12555 12556 12557
    @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.
12558

N
Niels 已提交
12559 12560 12561 12562 12563 12564 12565 12566 12567
    @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
12568
    */
N
Niels 已提交
12569
    basic_json patch(const basic_json& json_patch) const
12570
    {
N
Niels 已提交
12571
        // make a working copy to apply the patch to
12572 12573
        basic_json result = *this;

N
Niels 已提交
12574 12575 12576
        // the valid JSON Patch operations
        enum class patch_operations {add, remove, replace, move, copy, test, invalid};

N
Niels Lohmann 已提交
12577
        const auto get_op = [](const std::string & op)
N
Niels 已提交
12578 12579 12580 12581 12582 12583 12584 12585 12586 12587 12588 12589 12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605 12606
        {
            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 已提交
12607
        // wrapper for "add" operation; add value at ptr
N
Niels 已提交
12608
        const auto operation_add = [&result](json_pointer & ptr, basic_json val)
N
Niels 已提交
12609
        {
N
Niels 已提交
12610 12611
            // adding to the root of the target document means replacing it
            if (ptr.is_root())
N
Niels 已提交
12612
            {
N
Niels 已提交
12613
                result = val;
N
Niels 已提交
12614
            }
N
Niels 已提交
12615
            else
N
Niels 已提交
12616
            {
N
Niels 已提交
12617 12618 12619
                // make sure the top element of the pointer exists
                json_pointer top_pointer = ptr.top();
                if (top_pointer != ptr)
N
Niels 已提交
12620
                {
N
Niels 已提交
12621
                    result.at(top_pointer);
N
Niels 已提交
12622
                }
N
Niels 已提交
12623 12624 12625 12626 12627 12628

                // 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 已提交
12629
                {
N
Niels 已提交
12630 12631 12632 12633 12634 12635 12636 12637 12638 12639 12640 12641 12642 12643 12644 12645 12646 12647 12648 12649 12650
                    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
12651
                                JSON_THROW(std::out_of_range("array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
12652 12653 12654 12655 12656 12657 12658 12659 12660 12661 12662 12663
                            }
                            else
                            {
                                // default case: insert add offset
                                parent.insert(parent.begin() + static_cast<difference_type>(idx), val);
                            }
                        }
                        break;
                    }

                    default:
                    {
N
Niels 已提交
12664 12665
                        // if there exists a parent it cannot be primitive
                        assert(false);  // LCOV_EXCL_LINE
N
Niels 已提交
12666
                    }
N
Niels 已提交
12667 12668 12669 12670
                }
            }
        };

N
Niels 已提交
12671
        // wrapper for "remove" operation; remove value at ptr
N
Niels 已提交
12672 12673
        const auto operation_remove = [&result](json_pointer & ptr)
        {
N
Niels 已提交
12674
            // get reference to parent of JSON pointer ptr
N
Niels 已提交
12675 12676
            const auto last_path = ptr.pop_back();
            basic_json& parent = result.at(ptr);
N
Niels 已提交
12677 12678

            // remove child
N
Niels 已提交
12679 12680
            if (parent.is_object())
            {
N
Niels 已提交
12681 12682 12683 12684 12685 12686 12687 12688
                // perform range check
                auto it = parent.find(last_path);
                if (it != parent.end())
                {
                    parent.erase(it);
                }
                else
                {
12689
                    JSON_THROW(std::out_of_range("key '" + last_path + "' not found"));
N
Niels 已提交
12690
                }
N
Niels 已提交
12691 12692 12693
            }
            else if (parent.is_array())
            {
N
Niels 已提交
12694 12695
                // note erase performs range check
                parent.erase(static_cast<size_type>(std::stoi(last_path)));
N
Niels 已提交
12696 12697 12698
            }
        };

N
Niels 已提交
12699
        // type check
N
Niels 已提交
12700
        if (not json_patch.is_array())
N
Niels 已提交
12701 12702
        {
            // a JSON patch must be an array of objects
12703
            JSON_THROW(std::invalid_argument("JSON patch must be an array of objects"));
N
Niels 已提交
12704 12705
        }

N
Niels Lohmann 已提交
12706
        // iterate and apply the operations
N
Niels 已提交
12707
        for (const auto& val : json_patch)
12708
        {
N
Niels 已提交
12709 12710 12711
            // wrapper to get a value for an operation
            const auto get_value = [&val](const std::string & op,
                                          const std::string & member,
N
Niels 已提交
12712
                                          bool string_type) -> basic_json&
12713
            {
N
Niels 已提交
12714 12715
                // find value
                auto it = val.m_value.object->find(member);
12716

N
Niels 已提交
12717 12718
                // context-sensitive error message
                const auto error_msg = (op == "op") ? "operation" : "operation '" + op + "'";
12719

N
Niels 已提交
12720 12721 12722
                // check if desired value is present
                if (it == val.m_value.object->end())
                {
12723
                    JSON_THROW(std::invalid_argument(error_msg + " must have member '" + member + "'"));
N
Niels 已提交
12724
                }
12725

N
Niels 已提交
12726 12727 12728
                // check if result is of type string
                if (string_type and not it->second.is_string())
                {
12729
                    JSON_THROW(std::invalid_argument(error_msg + " must have string member '" + member + "'"));
N
Niels 已提交
12730 12731 12732 12733 12734 12735 12736 12737
                }

                // no error: return value
                return it->second;
            };

            // type check
            if (not val.is_object())
12738
            {
12739
                JSON_THROW(std::invalid_argument("JSON patch must be an array of objects"));
12740 12741
            }

N
Niels 已提交
12742 12743 12744
            // collect mandatory members
            const std::string op = get_value("op", "op", true);
            const std::string path = get_value(op, "path", true);
N
oops  
Niels 已提交
12745
            json_pointer ptr(path);
12746

N
Niels 已提交
12747
            switch (get_op(op))
12748
            {
N
Niels 已提交
12749 12750 12751 12752 12753 12754 12755 12756 12757 12758 12759 12760 12761 12762 12763 12764 12765 12766 12767 12768 12769 12770 12771 12772 12773 12774 12775 12776 12777 12778 12779 12780 12781 12782 12783 12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794 12795 12796 12797
                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;
12798
                    JSON_TRY
N
Niels 已提交
12799 12800 12801 12802 12803
                    {
                        // check if "value" matches the one at "path"
                        // the "path" location must exist - use at()
                        success = (result.at(ptr) == get_value("test", "value", false));
                    }
12804
                    JSON_CATCH (std::out_of_range&)
N
Niels 已提交
12805 12806 12807 12808 12809 12810 12811
                    {
                        // ignore out of range errors: success remains false
                    }

                    // throw an exception if test fails
                    if (not success)
                    {
12812
                        JSON_THROW(std::domain_error("unsuccessful: " + val.dump()));
N
Niels 已提交
12813 12814 12815 12816 12817 12818 12819 12820 12821
                    }

                    break;
                }

                case patch_operations::invalid:
                {
                    // op must be "add", "remove", "replace", "move", "copy", or
                    // "test"
12822
                    JSON_THROW(std::invalid_argument("operation value '" + op + "' is invalid"));
N
Niels 已提交
12823
                }
12824
            }
N
Niels 已提交
12825 12826 12827 12828 12829 12830 12831 12832 12833 12834 12835 12836 12837 12838 12839 12840 12841 12842 12843 12844
        }

        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 已提交
12845 12846
    @param[in] source  JSON value to compare from
    @param[in] target  JSON value to compare against
N
Niels 已提交
12847 12848 12849 12850 12851 12852 12853 12854 12855 12856 12857 12858 12859 12860 12861 12862 12863
    @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,
12864
                           const std::string& path = "")
N
Niels 已提交
12865 12866 12867 12868 12869 12870 12871 12872 12873 12874 12875 12876 12877 12878
    {
        // 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(
12879
            {
N
Niels 已提交
12880 12881 12882 12883 12884 12885 12886 12887
                {"op", "replace"},
                {"path", path},
                {"value", target}
            });
        }
        else
        {
            switch (source.type())
12888
            {
N
Niels 已提交
12889 12890 12891 12892 12893 12894 12895 12896 12897 12898 12899
                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 已提交
12900

N
Niels 已提交
12901 12902
                    // i now reached the end of at least one array
                    // in a second pass, traverse the remaining elements
N
Niels 已提交
12903

N
Niels 已提交
12904
                    // remove my remaining elements
N
Niels 已提交
12905
                    const auto end_index = static_cast<difference_type>(result.size());
N
Niels 已提交
12906 12907
                    while (i < source.size())
                    {
N
Niels 已提交
12908 12909
                        // add operations in reverse order to avoid invalid
                        // indices
N
Niels 已提交
12910
                        result.insert(result.begin() + end_index, object(
N
Niels 已提交
12911 12912 12913 12914 12915 12916 12917 12918 12919 12920 12921 12922 12923 12924 12925 12926 12927 12928 12929 12930 12931 12932 12933
                        {
                            {"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:
12934
                {
N
Niels 已提交
12935 12936 12937 12938 12939 12940 12941 12942 12943 12944 12945 12946 12947 12948 12949 12950 12951 12952 12953 12954 12955 12956 12957 12958 12959 12960 12961 12962 12963 12964 12965 12966 12967 12968 12969 12970 12971 12972 12973 12974 12975 12976 12977 12978 12979 12980 12981 12982 12983 12984 12985 12986
                    // 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;
12987 12988 12989 12990 12991 12992
                }
            }
        }

        return result;
    }
N
Niels 已提交
12993 12994

    /// @}
N
Niels 已提交
12995 12996 12997 12998 12999 13000
};

/////////////
// presets //
/////////////

N
Niels 已提交
13001 13002 13003
/*!
@brief default JSON class

N
Niels 已提交
13004 13005
This type is the default specialization of the @ref basic_json class which
uses the standard template types.
N
Niels 已提交
13006

N
Niels 已提交
13007
@since version 1.0.0
N
Niels 已提交
13008
*/
N
Niels 已提交
13009
using json = basic_json<>;
N
Niels Lohmann 已提交
13010
} // namespace nlohmann
N
Niels 已提交
13011 13012


N
Niels 已提交
13013 13014 13015
///////////////////////
// nonmember support //
///////////////////////
N
Niels 已提交
13016 13017 13018

// specialization of std::swap, and std::hash
namespace std
T
Théo DELRIEU 已提交
13019 13020 13021 13022 13023 13024 13025 13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036 13037
{
/*!
@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 已提交
13038
{
N
Niels 已提交
13039
    /*!
T
Théo DELRIEU 已提交
13040
    @brief return a hash value for a JSON object
N
Niels 已提交
13041

N
Niels 已提交
13042
    @since version 1.0.0
N
Niels 已提交
13043
    */
T
Théo DELRIEU 已提交
13044
    std::size_t operator()(const nlohmann::json& j) const
N
Niels 已提交
13045 13046
    {
        // a naive hashing via the string representation
N
Niels 已提交
13047 13048
        const auto& h = hash<nlohmann::json::string_t>();
        return h(j.dump());
N
Niels 已提交
13049
    }
T
Théo DELRIEU 已提交
13050
};
13051 13052 13053 13054 13055 13056 13057 13058 13059 13060 13061 13062 13063 13064 13065 13066

/// specialization for std::less<value_t>
template <>
struct less<::nlohmann::detail::value_t>
{
    /*!
    @brief compare two value_t enum values
    @since version 3.0.0
    */
    bool operator()(nlohmann::detail::value_t lhs,
                    nlohmann::detail::value_t rhs) const noexcept
    {
        return nlohmann::detail::operator<(lhs, rhs);
    }
};

N
Niels Lohmann 已提交
13067
} // namespace std
N
Niels 已提交
13068 13069

/*!
N
Niels 已提交
13070 13071
@brief user-defined string literal for JSON values

N
Niels 已提交
13072
This operator implements a user-defined string literal for JSON objects. It
N
Niels 已提交
13073
can be used by adding `"_json"` to a string literal and returns a JSON object
N
Niels 已提交
13074
if no parse error occurred.
N
Niels 已提交
13075

N
Niels 已提交
13076
@param[in] s  a string representation of a JSON object
13077
@param[in] n  the length of string @a s
N
Niels 已提交
13078
@return a JSON object
N
Niels 已提交
13079

N
Niels 已提交
13080
@since version 1.0.0
N
Niels 已提交
13081
*/
13082
inline nlohmann::json operator "" _json(const char* s, std::size_t n)
N
Niels 已提交
13083
{
13084
    return nlohmann::json::parse(s, s + n);
N
Niels 已提交
13085 13086
}

N
Niels 已提交
13087 13088 13089
/*!
@brief user-defined string literal for JSON pointer

N
Niels 已提交
13090
This operator implements a user-defined string literal for JSON Pointers. It
N
Niels 已提交
13091
can be used by adding `"_json_pointer"` to a string literal and returns a JSON pointer
N
Niels 已提交
13092 13093 13094
object if no parse error occurred.

@param[in] s  a string representation of a JSON Pointer
13095
@param[in] n  the length of string @a s
N
Niels 已提交
13096 13097
@return a JSON pointer object

N
Niels 已提交
13098 13099
@since version 2.0.0
*/
13100
inline nlohmann::json::json_pointer operator "" _json_pointer(const char* s, std::size_t n)
N
Niels 已提交
13101
{
13102
    return nlohmann::json::json_pointer(std::string(s, n));
N
Niels 已提交
13103 13104
}

13105 13106 13107 13108 13109
// restore GCC/clang diagnostic settings
#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
    #pragma GCC diagnostic pop
#endif

13110 13111
// clean up
#undef JSON_CATCH
N
Niels Lohmann 已提交
13112 13113
#undef JSON_THROW
#undef JSON_TRY
13114

N
Niels 已提交
13115
#endif