json.hpp.re2c 380.3 KB
Newer Older
1 2 3
/*
    __ _____ _____ _____
 __|  |   __|     |   | |  JSON for Modern C++
4
|  |  |__   |  |  | | | |  version 2.0.10
5 6 7
|_____|_____|_____|_|___|  https://github.com/nlohmann/json

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

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

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

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

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

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

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

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

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

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

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

N
cleanup  
Niels 已提交
103
/*!
N
Niels 已提交
104
@brief namespace for Niels Lohmann
N
cleanup  
Niels 已提交
105
@see https://github.com/nlohmann
N
Niels 已提交
106
@since version 1.0.0
N
cleanup  
Niels 已提交
107 108 109
*/
namespace nlohmann
{
110 111 112 113 114 115 116 117 118

///////////////////////////
// JSON type enumeration //
///////////////////////////

/*!
@brief the JSON type enumeration

This enumeration collects the different JSON types. It is internally used
T
Théo DELRIEU 已提交
119 120 121 122 123
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
@ref basic_json::is_structured() rely on it.
124 125 126

@note There are three enumeration entries (number_integer,
number_unsigned, and number_float), because the library distinguishes
T
Théo DELRIEU 已提交
127 128 129
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
130 131
integers which do not fit in the limits of their respective type.

T
Théo DELRIEU 已提交
132
@sa @ref basic_json::basic_json(const value_t value_type) -- create a JSON value with
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
the default value for a given type

@since version 1.0.0
*/
enum class value_t : uint8_t
{
  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
};

150 151 152
// alias templates to reduce boilerplate
template <bool B, typename T = void>
using enable_if_t = typename std::enable_if<B, T>::type;
N
cleanup  
Niels 已提交
153

154
template <typename T>
T
Théo DELRIEU 已提交
155
using uncvref_t = typename std::remove_cv<typename std::remove_reference<T>::type>::type;
156 157 158 159 160 161 162 163

// Taken from http://stackoverflow.com/questions/26936640/how-to-implement-is-enum-class-type-trait
template <typename T>
using is_unscoped_enum =
    std::integral_constant<bool, std::is_convertible<T, int>::value and
    std::is_enum<T>::value>;

// TODO update this doc
164 165
/*!
@brief unnamed namespace with internal helper functions
N
Niels 已提交
166
@since version 1.0.0
167
*/
168 169

namespace detail
N
Niels 已提交
170
{
T
Théo DELRIEU 已提交
171
template <typename Json> std::string type_name(const  Json &j)
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
{
  switch (j.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 已提交
192 193 194 195 196
// dispatch utility (taken from ranges-v3)
template <unsigned N> struct priority_tag : priority_tag<N - 1> {};

template <> struct priority_tag<0> {};

197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
// This is an experiment. I need this to move constructors out of basic_json.
// I'm sure there is a better way, but this might need a big basic_json refactoring
template <value_t> struct external_constructor;

template <>
struct external_constructor<value_t::boolean>
{
  template <typename Json>
  static void construct(Json &j, typename Json::boolean_t b) noexcept
  {
    j.m_type = value_t::boolean;
    j.m_value = b;
    j.assert_invariant();
  }
};
212 213 214 215 216 217 218 219 220 221 222 223

template <>
struct external_constructor<value_t::string>
{
  template <typename Json>
  static void construct(Json &j, const typename Json::string_t& s)
  {
    j.m_type = value_t::string;
    j.m_value = s;
    j.assert_invariant();
  }
};
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242

template <>
struct external_constructor<value_t::number_float>
{
  template <typename Json>
  static void construct(Json &j, typename Json::number_float_t val) noexcept
  {
    // replace infinity and NAN by null
    if (not std::isfinite(val))
      j = Json{};
    else
    {
      j.m_type = value_t::number_float;
      j.m_value = val;
    }
    j.assert_invariant();
  }
};

243 244 245 246 247 248 249 250 251 252 253 254
template <>
struct external_constructor<value_t::number_unsigned>
{
  template <typename Json>
  static void construct(Json &j, typename Json::number_unsigned_t val) noexcept
  {
    j.m_type = value_t::number_unsigned;
    j.m_value = val;
    j.assert_invariant();
  }
};

255 256 257 258 259 260 261 262 263 264 265 266
template <>
struct external_constructor<value_t::number_integer>
{
  template <typename Json>
  static void construct(Json &j, typename Json::number_integer_t val) noexcept
  {
    j.m_type = value_t::number_integer;
    j.m_value = val;
    j.assert_invariant();
  }
};

267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
template <>
struct external_constructor<value_t::array>
{
  template <typename Json>
  static void construct(Json &j, const typename Json::array_t& arr)
  {
    j.m_type = value_t::array;
    j.m_value = arr;
    j.assert_invariant();
  }

  template <typename Json, typename CompatibleArrayType,
            enable_if_t<not std::is_same<CompatibleArrayType,
                                         typename Json::array_t>::value,
                        int> = 0>
  static void construct(Json &j, const CompatibleArrayType &arr)
  {
    using std::begin;
    using std::end;
    j.m_type = value_t::array;
    j.m_value.array =
        j.template create<typename Json::array_t>(begin(arr), end(arr));
    j.assert_invariant();
  }
};

293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
template <>
struct external_constructor<value_t::object>
{
  template <typename Json>
  static void construct(Json &j, const typename Json::object_t& obj)
  {
    j.m_type = value_t::object;
    j.m_value = obj;
    j.assert_invariant();
  }

  template <typename Json, typename CompatibleObjectType,
            enable_if_t<not std::is_same<CompatibleObjectType,
                                         typename Json::object_t>::value,
                        int> = 0>
  static void construct(Json &j, const CompatibleObjectType &obj)
  {
    using std::begin;
    using std::end;

    j.m_type = value_t::object;
    j.m_value.object =
        j.template create<typename Json::object_t>(begin(obj), end(obj));
    j.assert_invariant();
  }
};

T
Théo DELRIEU 已提交
320
// Implementation of 2 C++17 constructs: conjunction, negation.
321 322 323 324 325 326 327 328 329 330 331 332 333 334
// This is needed 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 too (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...>
T
Théo DELRIEU 已提交
335
: std::conditional<bool(B1::value), conjunction<Bn...>, B1>::type {};
336 337 338

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

339 340
/*!
@brief Helper to determine whether there's a key_type for T.
N
Niels Lohmann 已提交
341 342

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

346
@sa http://stackoverflow.com/a/7728728/266378
N
Niels 已提交
347
@since version 1.0.0, overworked in version 2.0.6
348
*/
N
Niels Lohmann 已提交
349 350 351 352 353 354 355 356 357
#define NLOHMANN_JSON_HAS_HELPER(type)                                        \
    template <typename T> struct has_##type {                                 \
    private:                                                                  \
        template <typename U, typename = typename U::type>                    \
        static int detect(U &&);                                              \
        static void detect(...);                                              \
    public:                                                                   \
        static constexpr bool value =                                         \
                std::is_integral<decltype(detect(std::declval<T>()))>::value; \
358 359
    };

N
Niels Lohmann 已提交
360 361 362 363
NLOHMANN_JSON_HAS_HELPER(mapped_type);
NLOHMANN_JSON_HAS_HELPER(key_type);
NLOHMANN_JSON_HAS_HELPER(value_type);
NLOHMANN_JSON_HAS_HELPER(iterator);
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379

#undef NLOHMANN_JSON_HAS_HELPER

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

template <class RealType, class CompatibleObjectType>
struct is_compatible_object_type_impl<true, RealType, CompatibleObjectType>
{
    static constexpr auto value =
        std::is_constructible<typename RealType::key_type,
        typename CompatibleObjectType::key_type>::value and
        std::is_constructible<typename RealType::mapped_type,
        typename CompatibleObjectType::mapped_type>::value;
};

T
Théo DELRIEU 已提交
380
template<class BasicJson, class CompatibleObjectType>
381 382
struct is_compatible_object_type
{
T
Théo DELRIEU 已提交
383 384 385 386 387
    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,
        typename BasicJson::object_t, CompatibleObjectType>::value;
388 389
};

390 391
template <typename BasicJson, typename T>
struct is_basic_json_nested_type
392
{
393 394 395 396 397
    static auto constexpr value = std::is_same<T, typename BasicJson::iterator>::value or
                                  std::is_same<T, typename BasicJson::const_iterator>::value or
                                  std::is_same<T, typename BasicJson::reverse_iterator>::value or
                                  std::is_same<T, typename BasicJson::const_reverse_iterator>::value or
                                  std::is_same<T, typename BasicJson::json_pointer>::value;
398 399 400 401 402
};

template <class BasicJson, class CompatibleArrayType>
struct is_compatible_array_type
{
403 404 405 406 407
  // TODO concept Container?
  // this might not make VS happy
    static auto constexpr value = 
        conjunction<negation<std::is_same<void, CompatibleArrayType>>,
                    negation<is_compatible_object_type<
T
Théo DELRIEU 已提交
408
                        BasicJson, CompatibleArrayType>>,
409 410
                    negation<std::is_constructible<typename BasicJson::string_t,
                                                   CompatibleArrayType>>,
411
                    negation<is_basic_json_nested_type<BasicJson, CompatibleArrayType>>,
412
                    has_value_type<CompatibleArrayType>,
413
                    has_iterator<CompatibleArrayType>>::value;
414 415 416 417 418 419 420 421
};

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

template <typename RealIntegerType, typename CompatibleNumberIntegerType>
struct is_compatible_integer_type_impl<true, RealIntegerType, CompatibleNumberIntegerType>
{
422
  // is there an assert somewhere on overflows?
423 424 425 426 427 428 429 430 431 432 433 434 435
    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;
};

template <typename RealIntegerType, typename CompatibleNumberIntegerType>
struct is_compatible_integer_type
{
436 437
  static constexpr auto
      value = is_compatible_integer_type_impl <
438
                  std::is_integral<CompatibleNumberIntegerType>::value and
439 440
              not std::is_same<bool, CompatibleNumberIntegerType>::value,
      RealIntegerType, CompatibleNumberIntegerType > ::value;
441 442 443
};

// This trait checks if JSONSerializer<T>::from_json(json const&, udt&) exists
444
template <typename Json, typename T>
445 446 447 448 449 450 451 452 453 454 455
struct has_from_json
{
  private:
    // also check the return type of from_json
    template <typename U, typename = enable_if_t<std::is_same<void, decltype(uncvref_t<U>::from_json(
                  std::declval<Json>(), std::declval<T&>()))>::value>>
    static int detect(U&&);
    static void detect(...);

  public:
    static constexpr bool value = std::is_integral<decltype(
456
                                      detect(std::declval<typename Json::template json_serializer<T, void>>()))>::value;
457 458 459 460
};

// This trait checks if JSONSerializer<T>::from_json(json const&) exists
// this overload is used for non-default-constructible user-defined-types
461
template <typename Json, typename T>
462 463
struct has_non_default_from_json
{
464 465 466 467 468 469 470 471 472 473 474
private:
  template <
      typename U,
      typename = enable_if_t<std::is_same<
          T, decltype(uncvref_t<U>::from_json(std::declval<Json>()))>::value>>
  static int detect(U &&);
  static void detect(...);

public:
  static constexpr bool value = std::is_integral<decltype(detect(
      std::declval<typename Json::template json_serializer<T, void>>()))>::value;
475 476
};

477 478
// This trait checks if Json::json_serializer<T>::to_json exists
template <typename Json, typename T>
479
struct has_to_json
N
Niels 已提交
480
{
481 482 483 484 485 486 487 488 489
private:
  template <typename U, typename = decltype(uncvref_t<U>::to_json(
                            std::declval<Json &>(), std::declval<T>()))>
  static int detect(U &&);
  static void detect(...);

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

492 493
// overloads for basic_json template parameters

494 495 496 497 498
template <typename Json, typename ArithmeticType,
          enable_if_t<std::is_arithmetic<ArithmeticType>::value and
                          not std::is_same<ArithmeticType,
                                           typename Json::boolean_t>::value,
                      int> = 0>
T
Théo DELRIEU 已提交
499
void get_arithmetic_value(const  Json &j, ArithmeticType &val)
500
{
T
Théo DELRIEU 已提交
501 502 503 504 505
  // unsigned must be checked first, since is_number_integer() == true for unsigned
  if (j.is_number_unsigned())
    val = static_cast<ArithmeticType>(*j.template get_ptr<const typename Json::number_unsigned_t*>());
  else if (j.is_number_integer())
    val = static_cast<ArithmeticType>(*j.template get_ptr<const typename Json::number_integer_t*>());
506
  else if (j.is_number_float())
T
Théo DELRIEU 已提交
507
    val = static_cast<ArithmeticType>(*j.template get_ptr<const typename Json::number_float_t*>());
508 509 510 511
  else
    throw std::domain_error("type must be number, but is " + type_name(j));
}

512 513 514 515 516 517
template <typename Json>
void to_json(Json &j, typename Json::boolean_t b) noexcept
{
  external_constructor<value_t::boolean>::construct(j, b);
}

518 519 520 521 522 523 524 525 526
template <typename Json, typename CompatibleString,
          enable_if_t<std::is_constructible<typename Json::string_t,
                                            CompatibleString>::value,
                      int> = 0>
void to_json(Json &j, const CompatibleString &s)
{
  external_constructor<value_t::string>::construct(j, s);
}

527 528 529
template <typename Json, typename FloatType,
          enable_if_t<std::is_floating_point<FloatType>::value, int> = 0>
void to_json(Json &j, FloatType val) noexcept
530
{
T
Théo DELRIEU 已提交
531
  external_constructor<value_t::number_float>::construct(j, static_cast<typename Json::number_float_t>(val));
532 533
}

534 535 536 537 538 539 540 541

template <
    typename Json, typename CompatibleNumberUnsignedType,
   enable_if_t<is_compatible_integer_type<typename Json::number_unsigned_t,
                                         CompatibleNumberUnsignedType>::value,
                int> = 0>
void to_json(Json &j, CompatibleNumberUnsignedType val) noexcept
{
T
Théo DELRIEU 已提交
542
  external_constructor<value_t::number_unsigned>::construct(j, static_cast<typename Json::number_unsigned_t>(val));
543 544
}

545 546 547 548 549 550 551
template <
    typename Json, typename CompatibleNumberIntegerType,
   enable_if_t<is_compatible_integer_type<typename Json::number_integer_t,
                                         CompatibleNumberIntegerType>::value,
                int> = 0>
void to_json(Json &j, CompatibleNumberIntegerType val) noexcept
{
T
Théo DELRIEU 已提交
552
  external_constructor<value_t::number_integer>::construct(j, static_cast<typename Json::number_integer_t>(val));
553 554
}

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

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

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

582
template <typename Json>
T
Théo DELRIEU 已提交
583
void from_json(const Json & j, typename Json::boolean_t& b)
584 585 586
{
  if (!j.is_boolean())
    throw std::domain_error("type must be boolean, but is " + type_name(j));
T
Théo DELRIEU 已提交
587
  b = *j.template get_ptr<const typename Json::boolean_t*>();
588 589
}

590
template <typename Json>
T
Théo DELRIEU 已提交
591
void from_json(const Json & j, typename Json::string_t& s)
592 593 594
{
  if (!j.is_string())
    throw std::domain_error("type must be string, but is " + type_name(j));
T
Théo DELRIEU 已提交
595
  s = *j.template get_ptr<const typename Json::string_t*>();
596 597
}

598
template <typename Json>
T
Théo DELRIEU 已提交
599
void from_json(const Json & j, typename Json::number_float_t& val)
600 601 602 603
{
  get_arithmetic_value(j, val);
}

604
template <typename Json>
T
Théo DELRIEU 已提交
605
void from_json(const Json & j, typename Json::number_unsigned_t& val)
606 607 608 609
{
  get_arithmetic_value(j, val);
}

610
template <typename Json>
T
Théo DELRIEU 已提交
611
void from_json(const Json & j, typename Json::number_integer_t& val)
612 613 614 615
{
  get_arithmetic_value(j, val);
}

616 617
template <typename Json, typename UnscopedEnumType,
          enable_if_t<is_unscoped_enum<UnscopedEnumType>::value, int> = 0>
T
Théo DELRIEU 已提交
618
void from_json(const  Json &j, UnscopedEnumType& e)
619 620 621 622 623 624
{
  typename std::underlying_type<UnscopedEnumType>::type val = e;
  get_arithmetic_value(j, val);
  e = static_cast<UnscopedEnumType>(val);
}

625
template <typename Json>
T
Théo DELRIEU 已提交
626
void from_json(const  Json &j, typename Json::array_t &arr)
627 628 629
{
  if (!j.is_array())
    throw std::domain_error("type must be array, but is " + type_name(j));
T
Théo DELRIEU 已提交
630
  arr = *j.template get_ptr<const typename Json::array_t*>();
631 632 633 634
}

// forward_list doesn't have an insert method, TODO find a way to avoid including forward_list
template <typename Json, typename T, typename Allocator>
T
Théo DELRIEU 已提交
635
void from_json(const Json &j, std::forward_list<T, Allocator>& l)
636 637 638 639 640 641 642 643 644 645 646 647 648 649
{
  // do not perform the check when user wants to retrieve jsons
  // (except when it's null.. ?)
  if (j.is_null())
      throw std::domain_error("type must be array, but is " + type_name(j));
  if (not std::is_same<T, Json>::value)
  {
    if (!j.is_array())
      throw std::domain_error("type must be array, but is " + type_name(j));
  }
  for (auto it = j.rbegin(), end = j.rend(); it != end; ++it)
    l.push_front(it->template get<T>());
}

T
Théo DELRIEU 已提交
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
template <typename Json, typename CompatibleArrayType>
void from_json_array_impl(const  Json &j, CompatibleArrayType &arr, priority_tag<0>)
{
  using std::begin;
  using std::end;

  std::transform(
      j.begin(), j.end(), std::inserter(arr, end(arr)), [](const  Json &i)
      {
        // get<Json>() returns *this, this won't call a from_json method when
        // value_type is Json
        return i.template get<typename CompatibleArrayType::value_type>();
      });
}

template <typename Json, typename CompatibleArrayType>
auto from_json_array_impl(const  Json &j, CompatibleArrayType &arr, priority_tag<1>)
    -> decltype(
        arr.reserve(std::declval<typename CompatibleArrayType::size_type>()),
        void())
{
  using std::begin;
  using std::end;

  arr.reserve(j.size());
  std::transform(
      j.begin(), j.end(), std::inserter(arr, end(arr)), [](const  Json &i)
      {
        // get<Json>() returns *this, this won't call a from_json method when
        // value_type is Json
        return i.template get<typename CompatibleArrayType::value_type>();
      });
}

684 685 686 687 688 689
template <
    typename Json, typename CompatibleArrayType,
    enable_if_t<is_compatible_array_type<Json, CompatibleArrayType>::value and
                    not std::is_same<typename Json::array_t,
                                     CompatibleArrayType>::value,
                int> = 0>
T
Théo DELRIEU 已提交
690
void from_json(const  Json &j, CompatibleArrayType &arr)
691 692 693 694 695 696 697 698 699
{
  if (j.is_null())
      throw std::domain_error("type must be array, but is " + type_name(j));
  // when T == Json, do not check if value_t is correct
  if (not std::is_same<typename CompatibleArrayType::value_type, Json>::value)
  {
    if (!j.is_array())
      throw std::domain_error("type must be array, but is " + type_name(j));
  }
T
Théo DELRIEU 已提交
700
  from_json_array_impl(j, arr, priority_tag<1>{});
701 702
}

703 704 705

template <
    typename Json, typename CompatibleObjectType,
T
Théo DELRIEU 已提交
706
    enable_if_t<is_compatible_object_type<Json, CompatibleObjectType>::value,
707
                int> = 0>
T
Théo DELRIEU 已提交
708
void from_json(const  Json &j, CompatibleObjectType &obj)
709 710 711 712
{
  if (!j.is_object())
    throw std::domain_error("type must be object, but is " + type_name(j));

T
Théo DELRIEU 已提交
713
  auto inner_object = j.template get_ptr<const typename Json::object_t*>();
714 715 716 717 718 719 720
  using std::begin;
  using std::end;
  // we could avoid the assignment, but this might require a for loop, which
  // might be less efficient than the container constructor for some containers (would it?)
  obj = CompatibleObjectType(begin(*inner_object), end(*inner_object));
}

721 722 723 724 725 726 727 728
// 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?
template <
    typename Json, typename ArithmeticType,
    enable_if_t<
        std::is_arithmetic<ArithmeticType>::value and
729 730 731
            not std::is_same<ArithmeticType, typename Json::number_unsigned_t>::value and
            not std::is_same<ArithmeticType, typename Json::number_integer_t>::value and
            not std::is_same<ArithmeticType, typename Json::number_float_t>::value and
732 733
            not std::is_same<ArithmeticType, typename Json::boolean_t>::value,
        int> = 0>
T
Théo DELRIEU 已提交
734
void from_json(const  Json &j, ArithmeticType &val)
735
{
T
Théo DELRIEU 已提交
736 737 738 739
  if (j.is_number_unsigned())
    val = static_cast<ArithmeticType>(*j.template get_ptr<const typename Json::number_unsigned_t*>());
  else if (j.is_number_integer())
    val = static_cast<ArithmeticType>(*j.template get_ptr<const typename Json::number_integer_t*>());
740
  else if (j.is_number_float())
T
Théo DELRIEU 已提交
741
    val = static_cast<ArithmeticType>(*j.template get_ptr<const typename Json::number_float_t*>());
742
  else if (j.is_boolean())
T
Théo DELRIEU 已提交
743
    val = static_cast<ArithmeticType>(*j.template get_ptr<const typename Json::boolean_t*>());
744 745 746 747
  else
    throw std::domain_error("type must be number, but is " + type_name(j));
}

748 749 750
struct to_json_fn
{
    template <typename Json, typename T>
T
Théo DELRIEU 已提交
751 752 753
    auto call(Json& j, T&& val, priority_tag<1>) const
    noexcept(noexcept(to_json(j, std::forward<T>(val))))
    -> decltype(to_json(j, std::forward<T>(val)),
754 755
                void())
    {
T
Théo DELRIEU 已提交
756
        return to_json(j, std::forward<T>(val));
757 758 759
    }

    template <typename Json, typename T>
T
Théo DELRIEU 已提交
760
    void call(Json&, T&&, priority_tag<0>) const noexcept
761
    {
T
Théo DELRIEU 已提交
762
        static_assert(sizeof(Json) == 0, "to_json method in T's namespace can not be called");
763
    }
T
Théo DELRIEU 已提交
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797

public:
  template <typename Json, typename T>
  void operator()(Json &j, T &&val) const
      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>{});
  }
};

struct from_json_fn
{
private:
  template <typename Json, typename T>
  auto call(const  Json &j, T &val, priority_tag<1>) const
      noexcept(noexcept(from_json(j, val)))
          -> decltype(from_json(j, val), void())
  {
    return from_json(j, val);
  }

  template <typename Json, typename T>
  void call(const Json &, T&, priority_tag<0>) const noexcept
  {
      static_assert(sizeof(Json) == 0, "from_json method in T's namespace can not be called");
  }

public:
  template <typename Json, typename T>
  void operator()(const  Json &j, T &val) const
      noexcept(noexcept(std::declval<from_json_fn>().call(j, val, priority_tag<1>{})))
  {
      return call(j, val, priority_tag<1>{});
  }
798 799
};

800 801 802 803 804 805 806 807 808 809
// taken from ranges-v3
template <typename T>
struct static_const
{
    static constexpr T value{};
};

template <typename T>
constexpr T static_const<T>::value;

810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832
/*!
@brief helper class to create locales with decimal point

This struct is used a default locale during the JSON serialization. JSON
requires the decimal point to be `.`, so this function overloads the
`do_decimal_point()` function to return `.`. This function is called by
float-to-string conversions to retrieve the decimal separator between integer
and fractional parts.

@sa https://github.com/nlohmann/json/issues/51#issuecomment-86869315
@since version 2.0.0
*/
struct DecimalSeparator : std::numpunct<char>
{
    char do_decimal_point() const
    {
        return '.';
    }
};
}

inline namespace
{
833 834
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;
835 836 837 838 839 840 841 842
}

// default JSONSerializer template argument, doesn't care about template argument
// will use ADL for serialization
template <typename = void, typename = void>
struct adl_serializer
{
    template <typename Json, typename T>
T
Théo DELRIEU 已提交
843
    static void from_json(Json&& j, T& val) noexcept(noexcept(::nlohmann::from_json(std::forward<Json>(j), val)))
844 845 846 847 848
    {
        ::nlohmann::from_json(std::forward<Json>(j), val);
    }

    template <typename Json, typename T>
T
Théo DELRIEU 已提交
849 850
    static void to_json(Json &j, T &&val) noexcept(
        noexcept(::nlohmann::to_json(j, std::forward<T>(val))))
851
    {
T
Théo DELRIEU 已提交
852
      ::nlohmann::to_json(j, std::forward<T>(val));
853 854
    }
};
N
Niels 已提交
855

N
cleanup  
Niels 已提交
856
/*!
N
Niels 已提交
857
@brief a class to store JSON values
N
cleanup  
Niels 已提交
858

N
Niels 已提交
859
@tparam ObjectType type for JSON objects (`std::map` by default; will be used
N
Niels 已提交
860
in @ref object_t)
N
Niels 已提交
861
@tparam ArrayType type for JSON arrays (`std::vector` by default; will be used
N
Niels 已提交
862
in @ref array_t)
N
Niels 已提交
863
@tparam StringType type for JSON strings and object keys (`std::string` by
N
Niels 已提交
864
default; will be used in @ref string_t)
N
Niels 已提交
865
@tparam BooleanType type for JSON booleans (`bool` by default; will be used
N
Niels 已提交
866
in @ref boolean_t)
N
Niels 已提交
867
@tparam NumberIntegerType type for JSON integer numbers (`int64_t` by
N
Niels 已提交
868
default; will be used in @ref number_integer_t)
N
Niels 已提交
869 870
@tparam NumberUnsignedType type for JSON unsigned integer numbers (@c
`uint64_t` by default; will be used in @ref number_unsigned_t)
N
Niels 已提交
871
@tparam NumberFloatType type for JSON floating-point numbers (`double` by
N
Niels 已提交
872
default; will be used in @ref number_float_t)
N
Niels 已提交
873
@tparam AllocatorType type of the allocator to use (`std::allocator` by
N
Niels 已提交
874
default)
N
Niels 已提交
875

N
Niels 已提交
876 877
@requirement The class satisfies the following concept requirements:
- Basic
N
Niels 已提交
878
 - [DefaultConstructible](http://en.cppreference.com/w/cpp/concept/DefaultConstructible):
N
Niels Lohmann 已提交
879 880
   JSON values can be default constructed. The result will be a JSON null
   value.
N
Niels 已提交
881 882 883
 - [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 已提交
884
   A JSON value can be copy-constructed from an lvalue expression.
N
Niels 已提交
885 886 887 888 889 890
 - [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 已提交
891
- Layout
N
Niels 已提交
892 893 894
 - [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 已提交
895 896
   All non-static data members are private and standard layout types, the
   class has no virtual functions or (virtual) base classes.
N
Niels 已提交
897
- Library-wide
N
Niels 已提交
898 899 900 901 902 903 904 905 906 907 908 909
 - [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 已提交
910
- Container
N
Niels 已提交
911 912 913 914 915
 - [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 已提交
916

917 918 919 920 921 922 923
@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 已提交
924
@internal
N
Niels 已提交
925
@note ObjectType trick from http://stackoverflow.com/a/9860911
N
Niels 已提交
926
@endinternal
N
Niels 已提交
927

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

N
Niels 已提交
931
@since version 1.0.0
N
Niels 已提交
932 933

@nosubgrouping
N
cleanup  
Niels 已提交
934 935 936 937 938 939
*/
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,
940 941
    class NumberIntegerType = std::int64_t,
    class NumberUnsignedType = std::uint64_t,
N
Niels 已提交
942
    class NumberFloatType = double,
943 944
    template<typename U> class AllocatorType = std::allocator,
    template<typename T, typename SFINAE = void> class JSONSerializer = adl_serializer
N
cleanup  
Niels 已提交
945 946 947
    >
class basic_json
{
948
  private:
949
    template <::nlohmann::value_t> friend struct detail::external_constructor;
T
Théo DELRIEU 已提交
950
    template <typename Json> friend std::string detail::type_name(const  Json &);
951
    /// workaround type for MSVC
N
Niels 已提交
952 953
    using basic_json_t = basic_json<ObjectType, ArrayType, StringType,
          BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType,
954 955
          AllocatorType, JSONSerializer>;
    class primitive_iterator_t;
956 957

  public:
958
    using value_t = ::nlohmann::value_t;
N
Niels 已提交
959
    // forward declarations
N
Niels Lohmann 已提交
960
    template<typename U> class iter_impl;
N
Niels 已提交
961 962
    template<typename Base> class json_reverse_iterator;
    class json_pointer;
963 964
    template <typename T, typename SFINAE>
    using json_serializer = JSONSerializer<T, SFINAE>;
965

N
cleanup  
Niels 已提交
966 967 968 969
    /////////////////////
    // container types //
    /////////////////////

N
Niels 已提交
970
    /// @name container types
N
Niels 已提交
971 972
    /// The canonic container types to use @ref basic_json like any other STL
    /// container.
N
Niels 已提交
973 974
    /// @{

N
Niels 已提交
975
    /// the type of elements in a basic_json container
N
cleanup  
Niels 已提交
976
    using value_type = basic_json;
N
Niels 已提交
977

N
Niels 已提交
978
    /// the type of an element reference
N
Niels 已提交
979
    using reference = value_type&;
N
Niels 已提交
980
    /// the type of an element const reference
N
Niels 已提交
981
    using const_reference = const value_type&;
N
Niels 已提交
982

N
Niels 已提交
983
    /// a type to represent differences between iterators
N
Niels 已提交
984
    using difference_type = std::ptrdiff_t;
N
Niels 已提交
985
    /// a type to represent container sizes
N
Niels 已提交
986 987 988
    using size_type = std::size_t;

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

N
cleanup  
Niels 已提交
991
    /// the type of an element pointer
N
Niels 已提交
992
    using pointer = typename std::allocator_traits<allocator_type>::pointer;
N
cleanup  
Niels 已提交
993
    /// the type of an element const pointer
N
Niels 已提交
994
    using const_pointer = typename std::allocator_traits<allocator_type>::const_pointer;
N
Niels 已提交
995

N
Niels 已提交
996
    /// an iterator for a basic_json container
N
Niels Lohmann 已提交
997
    using iterator = iter_impl<basic_json>;
N
Niels 已提交
998
    /// a const iterator for a basic_json container
N
Niels Lohmann 已提交
999
    using const_iterator = iter_impl<const basic_json>;
N
Niels 已提交
1000
    /// a reverse iterator for a basic_json container
N
Niels 已提交
1001
    using reverse_iterator = json_reverse_iterator<typename basic_json::iterator>;
N
Niels 已提交
1002
    /// a const reverse iterator for a basic_json container
N
Niels 已提交
1003
    using const_reverse_iterator = json_reverse_iterator<typename basic_json::const_iterator>;
N
Niels 已提交
1004

N
Niels 已提交
1005 1006 1007
    /// @}


N
Niels 已提交
1008 1009 1010
    /*!
    @brief returns the allocator associated with the container
    */
1011
    static allocator_type get_allocator()
N
Niels 已提交
1012 1013 1014 1015
    {
        return allocator_type();
    }

1016 1017 1018
    /*!
    @brief returns version information on the library
    */
1019
    static basic_json meta()
1020 1021 1022
    {
        basic_json result;

1023
        result["copyright"] = "(C) 2013-2017 Niels Lohmann";
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
        result["name"] = "JSON for Modern C++";
        result["url"] = "https://github.com/nlohmann/json";
        result["version"] =
        {
            {"string", "2.0.10"},
            {"major", 2},
            {"minor", 0},
            {"patch", 10},
        };

#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__)
1047
        result["compiler"] = {{"family", "clang"}, {"version", __clang_version__}};
1048 1049 1050
#elif defined(__ICC) || defined(__INTEL_COMPILER)
        result["compiler"] = {{"family", "icc"}, {"version", __INTEL_COMPILER}};
#elif defined(__GNUC__) || defined(__GNUG__)
1051
        result["compiler"] = {{"family", "gcc"}, {"version", std::to_string(__GNUC__) + "." + std::to_string(__GNUC_MINOR__) + "." + std::to_string(__GNUC_PATCHLEVEL__)}};
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
#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 已提交
1074

N
cleanup  
Niels 已提交
1075 1076 1077 1078
    ///////////////////////////
    // JSON value data types //
    ///////////////////////////

N
Niels 已提交
1079
    /// @name JSON value data types
N
Niels 已提交
1080 1081
    /// The data types to store a JSON value. These types are derived from
    /// the template arguments passed to class @ref basic_json.
N
Niels 已提交
1082 1083
    /// @{

N
Niels 已提交
1084 1085 1086 1087 1088 1089 1090 1091
    /*!
    @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 已提交
1092 1093 1094 1095 1096
    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 已提交
1097 1098
    @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 已提交
1099 1100 1101
    inside the container.
    @tparam AllocatorType the allocator to use for objects (e.g.,
    `std::allocator`)
N
Niels 已提交
1102 1103 1104 1105

    #### Default type

    With the default values for @a ObjectType (`std::map`), @a StringType
N
Niels 已提交
1106 1107
    (`std::string`), and @a AllocatorType (`std::allocator`), the default
    value for @a object_t is:
N
Niels 已提交
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123

    @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 已提交
1124 1125
      that all software implementations receiving that object will agree on
      the name-value mappings.
N
Niels 已提交
1126 1127 1128 1129 1130
    - 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 已提交
1131 1132 1133
      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 已提交
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
    - 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 已提交
1146 1147
    runtime environment. A theoretical limit can be queried by calling the
    @ref max_size function of a JSON object.
N
Niels 已提交
1148 1149 1150

    #### Storage

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

1155 1156
    @sa @ref array_t -- type for an array value

N
Niels 已提交
1157
    @since version 1.0.0
N
Niels 已提交
1158

N
Niels 已提交
1159 1160 1161 1162 1163
    @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 已提交
1164 1165
    7159](http://rfc7159.net/rfc7159), because any order implements the
    specified "unordered" nature of JSON objects.
N
Niels 已提交
1166
    */
N
Niels 已提交
1167 1168 1169 1170 1171
    using object_t = ObjectType<StringType,
          basic_json,
          std::less<StringType>,
          AllocatorType<std::pair<const StringType,
          basic_json>>>;
N
Niels 已提交
1172 1173 1174 1175 1176 1177 1178

    /*!
    @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 已提交
1179 1180 1181 1182 1183
    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 已提交
1184
    @tparam AllocatorType allocator to use for arrays (e.g., `std::allocator`)
N
Niels 已提交
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204

    #### 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 已提交
1205 1206
    runtime environment. A theoretical limit can be queried by calling the
    @ref max_size function of a JSON array.
N
Niels 已提交
1207 1208 1209

    #### Storage

1210
    Arrays are stored as pointers in a @ref basic_json type. That is, for any
N
Niels 已提交
1211
    access to array values, a pointer of type `array_t*` must be dereferenced.
1212 1213 1214

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

N
Niels 已提交
1215
    @since version 1.0.0
N
Niels 已提交
1216
    */
N
Niels 已提交
1217
    using array_t = ArrayType<basic_json, AllocatorType<basic_json>>;
N
Niels 已提交
1218 1219 1220 1221 1222 1223 1224

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

N
Niels 已提交
1229 1230
    @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 已提交
1231 1232 1233 1234 1235 1236 1237 1238 1239 1240

    #### Default type

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

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

1241 1242 1243 1244 1245 1246
    #### 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 已提交
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263
    #### 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

1264 1265
    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 已提交
1266
    dereferenced.
1267

N
Niels 已提交
1268
    @since version 1.0.0
N
Niels 已提交
1269
    */
N
cleanup  
Niels 已提交
1270
    using string_t = StringType;
N
Niels 已提交
1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291

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

1292 1293
    Boolean values are stored directly inside a @ref basic_json type.

N
Niels 已提交
1294
    @since version 1.0.0
N
Niels 已提交
1295
    */
N
cleanup  
Niels 已提交
1296
    using boolean_t = BooleanType;
N
Niels 已提交
1297 1298 1299 1300 1301

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

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314
    > 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 已提交
1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332

    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 已提交
1333 1334
      instance, the C++ integer literal `010` will be serialized to `8`.
      During deserialization, leading zeros yield an error.
N
Niels 已提交
1335 1336 1337 1338 1339 1340 1341 1342 1343 1344
    - 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 已提交
1345 1346 1347 1348
    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 已提交
1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359

    [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

1360 1361 1362 1363
    Integer number values are stored directly inside a @ref basic_json type.

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

1364 1365
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
1366
    @since version 1.0.0
N
Niels 已提交
1367
    */
N
cleanup  
Niels 已提交
1368
    using number_integer_t = NumberIntegerType;
N
Niels 已提交
1369

1370 1371 1372 1373
    /*!
    @brief a type for a number (unsigned)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389
    > 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.
1390 1391 1392

    #### Default type

N
Niels 已提交
1393 1394
    With the default values for @a NumberUnsignedType (`uint64_t`), the
    default value for @a number_unsigned_t is:
1395 1396 1397 1398 1399 1400 1401 1402 1403 1404

    @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 已提交
1405 1406
      instance, the C++ integer literal `010` will be serialized to `8`.
      During deserialization, leading zeros yield an error.
1407 1408 1409 1410 1411 1412 1413 1414
    - 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 已提交
1415 1416 1417 1418 1419
    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.
1420 1421 1422 1423 1424 1425 1426

    [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 已提交
1427 1428
    number_integer_t type) of the exactly supported range [0, UINT64_MAX],
    this class's integer type is interoperable.
1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439

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

N
Niels 已提交
1441 1442 1443 1444
    /*!
    @brief a type for a number (floating-point)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457
    > 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 已提交
1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473

    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 已提交
1474 1475
      leading zeros in floating-point literals will be ignored. Internally,
      the value will be stored as decimal number. For instance, the C++
N
Niels 已提交
1476 1477 1478 1479 1480 1481 1482 1483 1484 1485
      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 已提交
1486 1487 1488
    > 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 已提交
1489 1490 1491 1492
    > precision.

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

    #### Storage

1498 1499 1500 1501 1502
    Floating-point number values are stored directly inside a @ref basic_json
    type.

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

1503 1504
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
1505
    @since version 1.0.0
N
Niels 已提交
1506
    */
N
cleanup  
Niels 已提交
1507 1508
    using number_float_t = NumberFloatType;

N
Niels 已提交
1509 1510
    /// @}

N
Niels 已提交
1511
  private:
N
Niels 已提交
1512

1513 1514
    /// helper for exception-safe object creation
    template<typename T, typename... Args>
N
Cleanup  
Niels 已提交
1515
    static T* create(Args&& ... args)
1516 1517
    {
        AllocatorType<T> alloc;
N
cleanup  
Niels 已提交
1518
        auto deleter = [&](T * object)
N
Cleanup  
Niels 已提交
1519 1520 1521
        {
            alloc.deallocate(object, 1);
        };
1522 1523
        std::unique_ptr<T, decltype(deleter)> object(alloc.allocate(1), deleter);
        alloc.construct(object.get(), std::forward<Args>(args)...);
N
Niels Lohmann 已提交
1524
        assert(object != nullptr);
1525 1526 1527
        return object.release();
    }

N
cleanup  
Niels 已提交
1528 1529 1530 1531
    ////////////////////////
    // JSON value storage //
    ////////////////////////

1532 1533 1534
    /*!
    @brief a JSON value

N
Niels 已提交
1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552
    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.
1553

N
Niels 已提交
1554
    @since version 1.0.0
1555
    */
N
cleanup  
Niels 已提交
1556 1557 1558 1559 1560 1561 1562 1563
    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 已提交
1564
        /// boolean
N
cleanup  
Niels 已提交
1565 1566 1567
        boolean_t boolean;
        /// number (integer)
        number_integer_t number_integer;
1568 1569
        /// number (unsigned integer)
        number_unsigned_t number_unsigned;
N
Niels 已提交
1570
        /// number (floating-point)
N
cleanup  
Niels 已提交
1571 1572 1573
        number_float_t number_float;

        /// default constructor (for null values)
N
Niels 已提交
1574
        json_value() = default;
N
cleanup  
Niels 已提交
1575
        /// constructor for booleans
1576
        json_value(boolean_t v) noexcept : boolean(v) {}
N
cleanup  
Niels 已提交
1577
        /// constructor for numbers (integer)
1578
        json_value(number_integer_t v) noexcept : number_integer(v) {}
1579 1580
        /// constructor for numbers (unsigned)
        json_value(number_unsigned_t v) noexcept : number_unsigned(v) {}
N
Niels 已提交
1581
        /// constructor for numbers (floating-point)
1582
        json_value(number_float_t v) noexcept : number_float(v) {}
N
Niels 已提交
1583
        /// constructor for empty values of a given type
1584
        json_value(value_t t)
N
Niels 已提交
1585 1586 1587
        {
            switch (t)
            {
1588
                case value_t::object:
N
Niels 已提交
1589
                {
1590
                    object = create<object_t>();
N
Niels 已提交
1591 1592
                    break;
                }
N
cleanup  
Niels 已提交
1593

1594
                case value_t::array:
N
Niels 已提交
1595
                {
1596
                    array = create<array_t>();
N
Niels 已提交
1597 1598
                    break;
                }
N
cleanup  
Niels 已提交
1599

1600
                case value_t::string:
N
Niels 已提交
1601
                {
1602
                    string = create<string_t>("");
N
Niels 已提交
1603 1604
                    break;
                }
N
cleanup  
Niels 已提交
1605

1606
                case value_t::boolean:
N
Niels 已提交
1607 1608 1609 1610 1611
                {
                    boolean = boolean_t(false);
                    break;
                }

1612
                case value_t::number_integer:
N
Niels 已提交
1613 1614 1615 1616
                {
                    number_integer = number_integer_t(0);
                    break;
                }
N
Niels 已提交
1617

1618 1619 1620 1621 1622
                case value_t::number_unsigned:
                {
                    number_unsigned = number_unsigned_t(0);
                    break;
                }
N
Niels 已提交
1623

1624
                case value_t::number_float:
N
Niels 已提交
1625 1626 1627 1628
                {
                    number_float = number_float_t(0.0);
                    break;
                }
1629

1630 1631 1632 1633 1634
                case value_t::null:
                {
                    break;
                }

1635 1636
                default:
                {
1637 1638
                    if (t == value_t::null)
                    {
1639
                        JSON_THROW(std::domain_error("961c151d2e87f2686a955a9be24d316f1362bf21 2.0.10")); // LCOV_EXCL_LINE
1640
                    }
1641 1642
                    break;
                }
N
Niels 已提交
1643 1644
            }
        }
N
Niels 已提交
1645 1646

        /// constructor for strings
1647
        json_value(const string_t& value)
N
Niels 已提交
1648
        {
1649
            string = create<string_t>(value);
N
Niels 已提交
1650 1651 1652
        }

        /// constructor for objects
1653
        json_value(const object_t& value)
N
Niels 已提交
1654
        {
1655
            object = create<object_t>(value);
N
Niels 已提交
1656 1657 1658
        }

        /// constructor for arrays
1659
        json_value(const array_t& value)
N
Niels 已提交
1660
        {
1661
            array = create<array_t>(value);
N
Niels 已提交
1662
        }
N
cleanup  
Niels 已提交
1663 1664
    };

1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679
    /*!
    @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 已提交
1680 1681

  public:
N
Niels 已提交
1682 1683 1684 1685
    //////////////////////////
    // JSON parser callback //
    //////////////////////////

N
Niels 已提交
1686 1687 1688 1689 1690
    /*!
    @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.
1691

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

N
Niels 已提交
1694
    @since version 1.0.0
N
Niels 已提交
1695
    */
N
Niels 已提交
1696 1697
    enum class parse_event_t : uint8_t
    {
N
Niels 已提交
1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709
        /// 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 已提交
1710 1711
    };

N
Niels 已提交
1712 1713 1714 1715
    /*!
    @brief per-element parser callback type

    With a parser callback function, the result of parsing a JSON text can be
N
Niels 已提交
1716
    influenced. When passed to @ref parse(std::istream&, const
1717
    parser_callback_t) or @ref parse(const CharT, const parser_callback_t),
N
Niels 已提交
1718 1719 1720 1721 1722
    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 已提交
1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736

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

N
Niels 已提交
1739 1740
    Discarding a value (i.e., returning `false`) has different effects
    depending on the context in which function was called:
N
Niels 已提交
1741 1742 1743

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

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

N
Niels 已提交
1749
    @param[in] event  an event of type parse_event_t indicating the context in
N
Niels 已提交
1750 1751 1752 1753 1754 1755 1756 1757 1758 1759
    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
1760
    @ref parse(const CharT, const parser_callback_t) for examples
1761

N
Niels 已提交
1762
    @since version 1.0.0
N
Niels 已提交
1763
    */
N
Niels 已提交
1764 1765 1766
    using parser_callback_t = std::function<bool(int depth,
                              parse_event_t event,
                              basic_json& parsed)>;
N
Niels 已提交
1767

N
cleanup  
Niels 已提交
1768 1769 1770 1771 1772

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

N
Niels 已提交
1773
    /// @name constructors and destructors
N
Niels 已提交
1774 1775
    /// Constructors of class @ref basic_json, copy/move constructor, copy
    /// assignment, static functions creating objects, and the destructor.
N
Niels 已提交
1776 1777
    /// @{

N
Niels 已提交
1778 1779 1780
    /*!
    @brief create an empty value with a given type

N
Niels 已提交
1781 1782 1783 1784 1785
    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 已提交
1786 1787 1788 1789 1790 1791
    null        | `null`
    boolean     | `false`
    string      | `""`
    number      | `0`
    object      | `{}`
    array       | `[]`
N
Niels 已提交
1792

1793
    @param[in] value_type  the type of the value to create
N
Niels 已提交
1794 1795 1796

    @complexity Constant.

N
Niels 已提交
1797
    @throw std::bad_alloc if allocation for object, array, or string value
N
Niels 已提交
1798
    fails
N
Niels 已提交
1799 1800 1801

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

N
Niels 已提交
1803
    @since version 1.0.0
N
Niels 已提交
1804
    */
1805 1806
    basic_json(const value_t value_type)
        : m_type(value_type), m_value(value_type)
1807 1808 1809
    {
        assert_invariant();
    }
N
cleanup  
Niels 已提交
1810

N
Niels 已提交
1811
    /*!
N
Niels 已提交
1812
    @brief create a null object
N
Niels 已提交
1813

N
Niels 已提交
1814 1815
    Create a `null` JSON value. It either takes a null pointer as parameter
    (explicitly creating `null`) or no parameter (implicitly creating `null`).
N
Niels 已提交
1816 1817
    The passed null pointer itself is not read -- it is only used to choose
    the right constructor.
N
Niels 已提交
1818 1819 1820

    @complexity Constant.

N
Niels 已提交
1821 1822 1823
    @exceptionsafety No-throw guarantee: this constructor never throws
    exceptions.

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

N
Niels 已提交
1827
    @since version 1.0.0
N
Niels 已提交
1828
    */
N
Niels 已提交
1829
    basic_json(std::nullptr_t = nullptr) noexcept
N
Niels 已提交
1830
        : basic_json(value_t::null)
1831 1832 1833
    {
        assert_invariant();
    }
N
cleanup  
Niels 已提交
1834

T
Théo DELRIEU 已提交
1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849
    /*!
    @brief forwards the parameter to json_serializer<U>::to_json method (U = uncvref_t<T>)

    this constructor is chosen if:
    - T is not derived from std::istream
    - T is not @ref basic_json (to avoid hijacking copy/move constructors)
    - T is not a @ref basic_json nested type (@ref json_pointer, @ref iterator, etc ...)
    - @ref json_serializer<U> has a to_json(basic_json_t&, T&&) method

    @param[in] val the value to be forwarded

    @throw what json_serializer<U>::to_json throws

    @since version 2.1.0
    */
1850
    template <typename T, typename U = uncvref_t<T>,
T
Théo DELRIEU 已提交
1851 1852 1853 1854 1855 1856 1857 1858
              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>
    basic_json(T &&val) noexcept(noexcept(JSONSerializer<U>::to_json(
        std::declval<basic_json_t &>(), std::forward<T>(val))))
1859
    {
T
Théo DELRIEU 已提交
1860
      JSONSerializer<U>::to_json(*this, std::forward<T>(val));
1861 1862
    }

N
Niels 已提交
1863 1864 1865 1866 1867 1868 1869 1870 1871 1872
    /*!
    @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 已提交
1873 1874
       object value is created where the first elements of the pairs are
       treated as keys and the second elements are as values.
N
Niels 已提交
1875 1876 1877
    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 已提交
1878
    JSON values. The rationale is as follows:
N
Niels 已提交
1879 1880

    1. The empty initializer list is written as `{}` which is exactly an empty
N
Niels 已提交
1881
       JSON object.
N
Niels 已提交
1882
    2. C++ has now way of describing mapped types other than to list a list of
N
Niels 已提交
1883 1884 1885
       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 已提交
1886
    3. In all other cases, the initializer list could not be interpreted as
N
Niels 已提交
1887
       JSON object type, so interpreting it as JSON array type is safe.
N
Niels 已提交
1888

N
Niels 已提交
1889 1890
    With the rules described above, the following JSON values cannot be
    expressed by an initializer list:
N
Niels 已提交
1891

N
Niels 已提交
1892 1893 1894 1895 1896
    - 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 已提交
1897 1898 1899 1900 1901

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

N
Niels 已提交
1904 1905 1906
    @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 已提交
1907 1908
    used by the functions @ref array(std::initializer_list<basic_json>) and
    @ref object(std::initializer_list<basic_json>).
N
Niels 已提交
1909

N
Niels 已提交
1910 1911
    @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 已提交
1912 1913 1914
    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 已提交
1915 1916
    @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 已提交
1917 1918
    whose first element is a string; example: `"cannot create object from
    initializer list"`
N
Niels 已提交
1919 1920 1921 1922

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

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

N
Niels 已提交
1925
    @sa @ref array(std::initializer_list<basic_json>) -- create a JSON array
1926
    value from an initializer list
N
Niels 已提交
1927
    @sa @ref object(std::initializer_list<basic_json>) -- create a JSON object
1928 1929
    value from an initializer list

N
Niels 已提交
1930
    @since version 1.0.0
N
Niels 已提交
1931
    */
N
Niels 已提交
1932 1933
    basic_json(std::initializer_list<basic_json> init,
               bool type_deduction = true,
N
Niels 已提交
1934
               value_t manual_type = value_t::array)
N
cleanup  
Niels 已提交
1935
    {
N
Niels 已提交
1936 1937
        // check if each element is an array with two elements whose first
        // element is a string
N
Niels 已提交
1938 1939
        bool is_an_object = std::all_of(init.begin(), init.end(),
                                        [](const basic_json & element)
N
cleanup  
Niels 已提交
1940
        {
N
Niels 已提交
1941 1942
            return element.is_array() and element.size() == 2 and element[0].is_string();
        });
N
cleanup  
Niels 已提交
1943 1944 1945 1946 1947 1948 1949

        // 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)
            {
1950
                is_an_object = false;
N
cleanup  
Niels 已提交
1951 1952 1953
            }

            // if object is wanted but impossible, throw an exception
1954
            if (manual_type == value_t::object and not is_an_object)
N
cleanup  
Niels 已提交
1955
            {
1956
                JSON_THROW(std::domain_error("cannot create object from initializer list"));
N
cleanup  
Niels 已提交
1957 1958 1959
            }
        }

1960
        if (is_an_object)
N
cleanup  
Niels 已提交
1961 1962 1963
        {
            // the initializer list is a list of pairs -> create object
            m_type = value_t::object;
N
Niels 已提交
1964
            m_value = value_t::object;
N
Niels 已提交
1965

N
Niels 已提交
1966
            std::for_each(init.begin(), init.end(), [this](const basic_json & element)
N
cleanup  
Niels 已提交
1967
            {
N
Niels 已提交
1968
                m_value.object->emplace(*(element[0].m_value.string), element[1]);
N
Niels 已提交
1969
            });
N
cleanup  
Niels 已提交
1970 1971 1972 1973 1974
        }
        else
        {
            // the initializer list describes an array -> create array
            m_type = value_t::array;
N
Niels 已提交
1975
            m_value.array = create<array_t>(init);
N
cleanup  
Niels 已提交
1976
        }
1977 1978

        assert_invariant();
N
cleanup  
Niels 已提交
1979 1980
    }

N
Niels 已提交
1981 1982 1983 1984 1985 1986 1987
    /*!
    @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 已提交
1988 1989
    @note This function is only needed to express two edge cases that cannot
    be realized with the initializer list constructor (@ref
N
Niels 已提交
1990 1991
    basic_json(std::initializer_list<basic_json>, bool, value_t)). These cases
    are:
N
Niels 已提交
1992
    1. creating an array whose elements are all pairs whose first element is a
N
Niels 已提交
1993
    string -- in this case, the initializer list constructor would create an
N
Niels 已提交
1994
    object, taking the first elements as keys
N
Niels 已提交
1995
    2. creating an empty array -- passing the empty initializer list to the
N
Niels 已提交
1996 1997
    initializer list constructor yields an empty object

N
Niels 已提交
1998
    @param[in] init  initializer list with JSON values to create an array from
N
Niels 已提交
1999 2000 2001 2002 2003 2004
    (optional)

    @return JSON array value

    @complexity Linear in the size of @a init.

N
Niels 已提交
2005
    @liveexample{The following code shows an example for the `array`
N
Niels 已提交
2006 2007
    function.,array}

2008 2009 2010 2011 2012
    @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 已提交
2013
    @since version 1.0.0
N
Niels 已提交
2014
    */
N
Niels 已提交
2015
    static basic_json array(std::initializer_list<basic_json> init =
2016
                            std::initializer_list<basic_json>())
N
cleanup  
Niels 已提交
2017
    {
N
Niels 已提交
2018
        return basic_json(init, false, value_t::array);
N
cleanup  
Niels 已提交
2019 2020
    }

N
Niels 已提交
2021 2022 2023 2024
    /*!
    @brief explicitly create an object from an initializer list

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

    @note This function is only added for symmetry reasons. In contrast to the
2029 2030 2031
    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 已提交
2032 2033
    constructor @ref basic_json(std::initializer_list<basic_json>, bool,
    value_t).
N
Niels 已提交
2034

N
Niels 已提交
2035
    @param[in] init  initializer list to create an object from (optional)
N
Niels 已提交
2036 2037 2038 2039

    @return JSON object value

    @throw std::domain_error if @a init is not a pair whose first elements are
2040 2041
    strings; thrown by
    @ref basic_json(std::initializer_list<basic_json>, bool, value_t)
N
Niels 已提交
2042 2043 2044

    @complexity Linear in the size of @a init.

N
Niels 已提交
2045
    @liveexample{The following code shows an example for the `object`
N
Niels 已提交
2046 2047
    function.,object}

2048 2049 2050 2051 2052
    @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 已提交
2053
    @since version 1.0.0
N
Niels 已提交
2054
    */
N
Niels 已提交
2055
    static basic_json object(std::initializer_list<basic_json> init =
2056
                             std::initializer_list<basic_json>())
N
cleanup  
Niels 已提交
2057
    {
N
Niels 已提交
2058
        return basic_json(init, false, value_t::object);
N
cleanup  
Niels 已提交
2059 2060
    }

N
Niels 已提交
2061 2062 2063
    /*!
    @brief construct an array with count copies of given value

N
Niels 已提交
2064 2065
    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,
2066
    `std::distance(begin(),end()) == cnt` holds.
N
Niels 已提交
2067

2068 2069
    @param[in] cnt  the number of JSON copies of @a val to create
    @param[in] val  the JSON value to copy
N
Niels 已提交
2070

2071
    @complexity Linear in @a cnt.
N
Niels 已提交
2072 2073 2074 2075

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

N
Niels 已提交
2077
    @since version 1.0.0
N
Niels 已提交
2078
    */
2079
    basic_json(size_type cnt, const basic_json& val)
N
Niels 已提交
2080 2081
        : m_type(value_t::array)
    {
2082
        m_value.array = create<array_t>(cnt, val);
2083
        assert_invariant();
N
Niels 已提交
2084
    }
N
Niels 已提交
2085

N
Niels 已提交
2086 2087 2088 2089 2090
    /*!
    @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 已提交
2091
    - In case of primitive types (number, boolean, or string), @a first must
N
Niels 已提交
2092 2093
      be `begin()` and @a last must be `end()`. In this case, the value is
      copied. Otherwise, std::out_of_range is thrown.
N
Niels 已提交
2094 2095
    - In case of structured types (array, object), the constructor behaves as
      similar versions for `std::vector`.
N
Niels 已提交
2096
    - In case of a null type, std::domain_error is thrown.
N
Niels 已提交
2097 2098 2099 2100 2101 2102 2103

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

N
Niels 已提交
2107
    @throw std::domain_error if iterators are not compatible; that is, do not
N
Niels 已提交
2108
    belong to the same JSON value; example: `"iterators are not compatible"`
N
Niels 已提交
2109
    @throw std::out_of_range if iterators are for a primitive type (number,
N
Niels 已提交
2110 2111
    boolean, or string) where an out of range error can be detected easily;
    example: `"iterators out of range"`
N
Niels 已提交
2112
    @throw std::bad_alloc if allocation for object, array, or string fails
N
Niels 已提交
2113 2114
    @throw std::domain_error if called with a null value; example: `"cannot
    use construct with iterators from null"`
N
Niels 已提交
2115 2116 2117 2118 2119

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

N
Niels 已提交
2121
    @since version 1.0.0
N
Niels 已提交
2122
    */
N
Niels 已提交
2123 2124 2125
    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 已提交
2126
    basic_json(InputIT first, InputIT last)
N
Niels 已提交
2127
    {
N
Niels 已提交
2128 2129 2130
        assert(first.m_object != nullptr);
        assert(last.m_object != nullptr);

N
Niels 已提交
2131
        // make sure iterator fits the current value
N
Niels 已提交
2132
        if (first.m_object != last.m_object)
N
Niels 已提交
2133
        {
2134
            JSON_THROW(std::domain_error("iterators are not compatible"));
N
Niels 已提交
2135 2136
        }

N
Niels 已提交
2137 2138 2139
        // copy type from first iterator
        m_type = first.m_object->m_type;

N
Niels 已提交
2140
        // check if iterator range is complete for primitive values
N
Niels 已提交
2141 2142 2143
        switch (m_type)
        {
            case value_t::boolean:
2144 2145
            case value_t::number_float:
            case value_t::number_integer:
2146
            case value_t::number_unsigned:
N
Niels 已提交
2147 2148
            case value_t::string:
            {
2149
                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
N
Niels 已提交
2150
                {
2151
                    JSON_THROW(std::out_of_range("iterators out of range"));
N
Niels 已提交
2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168
                }
                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 已提交
2169

2170 2171 2172 2173 2174
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = first.m_object->m_value.number_unsigned;
                break;
            }
N
Niels 已提交
2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189

            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 已提交
2190
                m_value = *first.m_object->m_value.string;
N
Niels 已提交
2191 2192 2193 2194 2195
                break;
            }

            case value_t::object:
            {
N
Niels Lohmann 已提交
2196 2197
                m_value.object = create<object_t>(first.m_it.object_iterator,
                                                  last.m_it.object_iterator);
N
Niels 已提交
2198 2199 2200 2201 2202
                break;
            }

            case value_t::array:
            {
N
Niels Lohmann 已提交
2203 2204
                m_value.array = create<array_t>(first.m_it.array_iterator,
                                                last.m_it.array_iterator);
N
Niels 已提交
2205 2206 2207 2208 2209
                break;
            }

            default:
            {
2210
                JSON_THROW(std::domain_error("cannot use construct with iterators from " + first.m_object->type_name()));
N
Niels 已提交
2211 2212
            }
        }
2213 2214

        assert_invariant();
N
Niels 已提交
2215 2216
    }

N
Niels 已提交
2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230
    /*!
    @brief construct a JSON value given an input stream

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

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

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

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

N
Niels 已提交
2238 2239 2240 2241
    @liveexample{The example below demonstrates constructing a JSON value from
    a `std::stringstream` with and without callback
    function.,basic_json__istream}

N
Niels 已提交
2242 2243
    @since version 2.0.0, deprecated in version 2.0.3, to be removed in
           version 3.0.0
N
Niels 已提交
2244
    */
N
Niels 已提交
2245
    JSON_DEPRECATED
N
Niels 已提交
2246
    explicit basic_json(std::istream& i, const parser_callback_t cb = nullptr)
N
Niels 已提交
2247 2248
    {
        *this = parser(i, cb).parse();
2249
        assert_invariant();
N
Niels 已提交
2250 2251
    }

N
cleanup  
Niels 已提交
2252 2253 2254 2255
    ///////////////////////////////////////
    // other constructors and destructor //
    ///////////////////////////////////////

N
Niels 已提交
2256 2257
    /*!
    @brief copy constructor
N
Niels 已提交
2258

N
Niels 已提交
2259 2260
    Creates a copy of a given JSON value.

N
Niels 已提交
2261
    @param[in] other  the JSON value to copy
N
Niels 已提交
2262 2263 2264

    @complexity Linear in the size of @a other.

N
Niels 已提交
2265 2266 2267
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2268 2269 2270
    - The complexity is linear.
    - As postcondition, it holds: `other == basic_json(other)`.

N
Niels 已提交
2271
    @throw std::bad_alloc if allocation for object, array, or string fails.
N
Niels 已提交
2272 2273

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

N
Niels 已提交
2276
    @since version 1.0.0
N
Niels 已提交
2277
    */
2278
    basic_json(const basic_json& other)
N
cleanup  
Niels 已提交
2279 2280
        : m_type(other.m_type)
    {
2281 2282 2283
        // check of passed value is valid
        other.assert_invariant();

N
cleanup  
Niels 已提交
2284 2285
        switch (m_type)
        {
2286
            case value_t::object:
N
cleanup  
Niels 已提交
2287
            {
N
Niels 已提交
2288
                m_value = *other.m_value.object;
N
cleanup  
Niels 已提交
2289 2290
                break;
            }
N
Niels 已提交
2291

2292
            case value_t::array:
N
cleanup  
Niels 已提交
2293
            {
N
Niels 已提交
2294
                m_value = *other.m_value.array;
N
cleanup  
Niels 已提交
2295 2296
                break;
            }
N
Niels 已提交
2297

2298
            case value_t::string:
N
cleanup  
Niels 已提交
2299
            {
N
Niels 已提交
2300
                m_value = *other.m_value.string;
N
cleanup  
Niels 已提交
2301 2302
                break;
            }
N
Niels 已提交
2303

2304
            case value_t::boolean:
N
cleanup  
Niels 已提交
2305
            {
N
Niels 已提交
2306
                m_value = other.m_value.boolean;
N
cleanup  
Niels 已提交
2307 2308
                break;
            }
N
Niels 已提交
2309

2310
            case value_t::number_integer:
N
cleanup  
Niels 已提交
2311
            {
N
Niels 已提交
2312
                m_value = other.m_value.number_integer;
N
cleanup  
Niels 已提交
2313 2314
                break;
            }
N
Niels 已提交
2315

2316 2317 2318 2319 2320
            case value_t::number_unsigned:
            {
                m_value = other.m_value.number_unsigned;
                break;
            }
N
Niels 已提交
2321

2322
            case value_t::number_float:
N
cleanup  
Niels 已提交
2323
            {
N
Niels 已提交
2324
                m_value = other.m_value.number_float;
N
cleanup  
Niels 已提交
2325 2326
                break;
            }
2327 2328 2329 2330 2331

            default:
            {
                break;
            }
N
cleanup  
Niels 已提交
2332
        }
2333 2334

        assert_invariant();
N
cleanup  
Niels 已提交
2335 2336
    }

N
Niels 已提交
2337 2338 2339 2340 2341 2342 2343
    /*!
    @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 已提交
2344
    @param[in,out] other  value to move to this object
N
Niels 已提交
2345 2346 2347 2348 2349 2350 2351

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

N
Niels 已提交
2353
    @since version 1.0.0
N
Niels 已提交
2354
    */
2355
    basic_json(basic_json&& other) noexcept
N
Niels 已提交
2356 2357
        : m_type(std::move(other.m_type)),
          m_value(std::move(other.m_value))
N
cleanup  
Niels 已提交
2358
    {
2359 2360 2361
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2362
        // invalidate payload
N
cleanup  
Niels 已提交
2363 2364
        other.m_type = value_t::null;
        other.m_value = {};
2365 2366

        assert_invariant();
N
cleanup  
Niels 已提交
2367 2368
    }

N
Niels 已提交
2369 2370
    /*!
    @brief copy assignment
N
Niels 已提交
2371

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

N
Niels 已提交
2376
    @param[in] other  value to copy from
N
Niels 已提交
2377 2378 2379

    @complexity Linear.

N
Niels 已提交
2380 2381 2382
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2383 2384
    - The complexity is linear.

N
Niels 已提交
2385 2386 2387 2388
    @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 已提交
2389

N
Niels 已提交
2390
    @since version 1.0.0
N
Niels 已提交
2391
    */
2392
    reference& operator=(basic_json other) noexcept (
N
Niels 已提交
2393 2394 2395 2396
        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
2397
                                       )
N
cleanup  
Niels 已提交
2398
    {
2399 2400 2401
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2402
        using std::swap;
C
Colin Hirsch 已提交
2403 2404
        swap(m_type, other.m_type);
        swap(m_value, other.m_value);
2405 2406

        assert_invariant();
N
cleanup  
Niels 已提交
2407 2408 2409
        return *this;
    }

N
Niels 已提交
2410 2411
    /*!
    @brief destructor
N
Niels 已提交
2412

N
Niels 已提交
2413
    Destroys the JSON value and frees all allocated memory.
N
Niels 已提交
2414 2415 2416

    @complexity Linear.

N
Niels 已提交
2417 2418 2419
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2420 2421
    - The complexity is linear.
    - All stored elements are destroyed and all memory is freed.
2422

N
Niels 已提交
2423
    @since version 1.0.0
N
Niels 已提交
2424
    */
N
Niels 已提交
2425
    ~basic_json()
N
cleanup  
Niels 已提交
2426
    {
2427 2428
        assert_invariant();

N
cleanup  
Niels 已提交
2429 2430
        switch (m_type)
        {
2431
            case value_t::object:
N
cleanup  
Niels 已提交
2432
            {
N
Niels 已提交
2433
                AllocatorType<object_t> alloc;
N
Niels 已提交
2434 2435
                alloc.destroy(m_value.object);
                alloc.deallocate(m_value.object, 1);
N
cleanup  
Niels 已提交
2436 2437
                break;
            }
N
Niels 已提交
2438

2439
            case value_t::array:
N
cleanup  
Niels 已提交
2440
            {
N
Niels 已提交
2441
                AllocatorType<array_t> alloc;
N
Niels 已提交
2442 2443
                alloc.destroy(m_value.array);
                alloc.deallocate(m_value.array, 1);
N
cleanup  
Niels 已提交
2444 2445
                break;
            }
N
Niels 已提交
2446

2447
            case value_t::string:
N
cleanup  
Niels 已提交
2448
            {
N
Niels 已提交
2449
                AllocatorType<string_t> alloc;
N
Niels 已提交
2450
                alloc.destroy(m_value.string);
N
Niels 已提交
2451
                alloc.deallocate(m_value.string, 1);
N
cleanup  
Niels 已提交
2452 2453
                break;
            }
N
Niels 已提交
2454 2455

            default:
N
cleanup  
Niels 已提交
2456
            {
N
Niels 已提交
2457
                // all other types need no specific destructor
N
cleanup  
Niels 已提交
2458 2459 2460 2461 2462
                break;
            }
        }
    }

N
Niels 已提交
2463
    /// @}
N
cleanup  
Niels 已提交
2464 2465 2466 2467 2468 2469

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

N
Niels 已提交
2470
    /// @name object inspection
N
Niels 已提交
2471
    /// Functions to inspect the type of a JSON value.
N
Niels 已提交
2472 2473
    /// @{

N
cleanup  
Niels 已提交
2474
    /*!
N
Niels 已提交
2475 2476
    @brief serialization

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

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

N
Niels 已提交
2486 2487 2488 2489 2490
    @return string containing the serialization of the JSON value

    @complexity Linear.

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

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

N
Niels 已提交
2495
    @since version 1.0.0
N
cleanup  
Niels 已提交
2496
    */
N
Niels 已提交
2497
    string_t dump(const int indent = -1) const
N
cleanup  
Niels 已提交
2498
    {
N
Niels 已提交
2499
        std::stringstream ss;
N
Niels 已提交
2500
        // fix locale problems
N
Niels 已提交
2501
        ss.imbue(std::locale::classic());
N
Niels 已提交
2502

2503 2504 2505 2506 2507 2508
        // 6, 15 or 16 digits of precision allows round-trip IEEE 754
        // string->float->string, string->double->string or string->long
        // double->string; to be safe, we read this value from
        // std::numeric_limits<number_float_t>::digits10
        ss.precision(std::numeric_limits<double>::digits10);

N
cleanup  
Niels 已提交
2509 2510
        if (indent >= 0)
        {
N
Niels 已提交
2511
            dump(ss, true, static_cast<unsigned int>(indent));
N
cleanup  
Niels 已提交
2512 2513 2514
        }
        else
        {
N
Niels 已提交
2515
            dump(ss, false, 0);
N
cleanup  
Niels 已提交
2516
        }
N
Niels 已提交
2517 2518

        return ss.str();
N
cleanup  
Niels 已提交
2519 2520
    }

N
Niels 已提交
2521 2522 2523 2524 2525 2526 2527
    /*!
    @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 已提交
2528 2529 2530

    @complexity Constant.

N
Niels 已提交
2531 2532 2533
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2534
    @liveexample{The following code exemplifies `type()` for all JSON
N
Niels 已提交
2535
    types.,type}
N
Niels 已提交
2536

N
Niels 已提交
2537
    @since version 1.0.0
N
Niels 已提交
2538
    */
N
Niels 已提交
2539
    constexpr value_t type() const noexcept
N
cleanup  
Niels 已提交
2540 2541 2542 2543
    {
        return m_type;
    }

N
Niels 已提交
2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554
    /*!
    @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 已提交
2555 2556 2557
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2558
    @liveexample{The following code exemplifies `is_primitive()` for all JSON
N
Niels 已提交
2559
    types.,is_primitive}
N
Niels 已提交
2560

N
Niels 已提交
2561 2562 2563 2564 2565 2566
    @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 已提交
2567
    @since version 1.0.0
N
Niels 已提交
2568
    */
N
Niels 已提交
2569
    constexpr bool is_primitive() const noexcept
N
Niels 已提交
2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583
    {
        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 已提交
2584 2585 2586
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2587
    @liveexample{The following code exemplifies `is_structured()` for all JSON
N
Niels 已提交
2588
    types.,is_structured}
N
Niels 已提交
2589

N
Niels 已提交
2590 2591 2592 2593
    @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 已提交
2594
    @since version 1.0.0
N
Niels 已提交
2595
    */
N
Niels 已提交
2596
    constexpr bool is_structured() const noexcept
N
Niels 已提交
2597 2598 2599 2600
    {
        return is_array() or is_object();
    }

N
Niels 已提交
2601 2602 2603 2604 2605
    /*!
    @brief return whether value is null

    This function returns true iff the JSON value is null.

N
Niels 已提交
2606
    @return `true` if type is null, `false` otherwise.
N
Niels 已提交
2607 2608 2609

    @complexity Constant.

N
Niels 已提交
2610 2611 2612
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2613
    @liveexample{The following code exemplifies `is_null()` for all JSON
N
Niels 已提交
2614
    types.,is_null}
N
Niels 已提交
2615

N
Niels 已提交
2616
    @since version 1.0.0
N
Niels 已提交
2617
    */
N
Niels 已提交
2618
    constexpr bool is_null() const noexcept
N
Niels 已提交
2619 2620 2621 2622
    {
        return m_type == value_t::null;
    }

N
Niels 已提交
2623 2624 2625 2626 2627
    /*!
    @brief return whether value is a boolean

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

N
Niels 已提交
2628
    @return `true` if type is boolean, `false` otherwise.
N
Niels 已提交
2629 2630 2631

    @complexity Constant.

N
Niels 已提交
2632 2633 2634
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2635
    @liveexample{The following code exemplifies `is_boolean()` for all JSON
N
Niels 已提交
2636
    types.,is_boolean}
N
Niels 已提交
2637

N
Niels 已提交
2638
    @since version 1.0.0
N
Niels 已提交
2639
    */
N
Niels 已提交
2640
    constexpr bool is_boolean() const noexcept
N
Niels 已提交
2641 2642 2643 2644
    {
        return m_type == value_t::boolean;
    }

N
Niels 已提交
2645 2646 2647 2648 2649 2650
    /*!
    @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.

2651 2652
    @return `true` if type is number (regardless whether integer, unsigned
    integer or floating-type), `false` otherwise.
N
Niels 已提交
2653 2654 2655

    @complexity Constant.

N
Niels 已提交
2656 2657 2658
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2659
    @liveexample{The following code exemplifies `is_number()` for all JSON
N
Niels 已提交
2660
    types.,is_number}
N
Niels 已提交
2661

N
Niels 已提交
2662
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
2663
    integer number
N
Niels 已提交
2664 2665
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2666 2667
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
2668
    @since version 1.0.0
N
Niels 已提交
2669
    */
N
Niels 已提交
2670
    constexpr bool is_number() const noexcept
N
Niels 已提交
2671
    {
N
Niels 已提交
2672
        return is_number_integer() or is_number_float();
N
Niels 已提交
2673 2674
    }

N
Niels 已提交
2675 2676 2677
    /*!
    @brief return whether value is an integer number

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

N
Niels 已提交
2681
    @return `true` if type is an integer or unsigned integer number, `false`
2682
    otherwise.
N
Niels 已提交
2683 2684 2685

    @complexity Constant.

N
Niels 已提交
2686 2687 2688
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2689
    @liveexample{The following code exemplifies `is_number_integer()` for all
N
Niels 已提交
2690
    JSON types.,is_number_integer}
N
Niels 已提交
2691 2692

    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
2693 2694
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2695 2696
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
2697
    @since version 1.0.0
N
Niels 已提交
2698
    */
N
Niels 已提交
2699
    constexpr bool is_number_integer() const noexcept
N
Niels 已提交
2700
    {
2701 2702
        return m_type == value_t::number_integer or m_type == value_t::number_unsigned;
    }
N
Niels 已提交
2703

2704 2705 2706
    /*!
    @brief return whether value is an unsigned integer number

N
Niels 已提交
2707 2708
    This function returns true iff the JSON value is an unsigned integer
    number. This excludes floating-point and (signed) integer values.
2709 2710 2711 2712 2713

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

    @complexity Constant.

N
Niels 已提交
2714 2715 2716
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2717
    @liveexample{The following code exemplifies `is_number_unsigned()` for all
N
Niels 已提交
2718 2719
    JSON types.,is_number_unsigned}

2720
    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
2721
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
2722 2723 2724 2725 2726
    integer number
    @sa @ref is_number_float() -- check if value is a floating-point number

    @since version 2.0.0
    */
N
Niels 已提交
2727
    constexpr bool is_number_unsigned() const noexcept
2728 2729
    {
        return m_type == value_t::number_unsigned;
N
Niels 已提交
2730 2731
    }

N
Niels 已提交
2732 2733 2734 2735
    /*!
    @brief return whether value is a floating-point number

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

N
Niels 已提交
2738
    @return `true` if type is a floating-point number, `false` otherwise.
N
Niels 已提交
2739 2740 2741

    @complexity Constant.

N
Niels 已提交
2742 2743 2744
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2745
    @liveexample{The following code exemplifies `is_number_float()` for all
N
Niels 已提交
2746
    JSON types.,is_number_float}
N
Niels 已提交
2747 2748 2749

    @sa @ref is_number() -- check if value is number
    @sa @ref is_number_integer() -- check if value is an integer number
N
Niels 已提交
2750 2751
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
2752

N
Niels 已提交
2753
    @since version 1.0.0
N
Niels 已提交
2754
    */
N
Niels 已提交
2755
    constexpr bool is_number_float() const noexcept
N
Niels 已提交
2756 2757 2758 2759
    {
        return m_type == value_t::number_float;
    }

N
Niels 已提交
2760 2761 2762 2763 2764
    /*!
    @brief return whether value is an object

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

N
Niels 已提交
2765
    @return `true` if type is object, `false` otherwise.
N
Niels 已提交
2766 2767 2768

    @complexity Constant.

N
Niels 已提交
2769 2770 2771
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2772
    @liveexample{The following code exemplifies `is_object()` for all JSON
N
Niels 已提交
2773
    types.,is_object}
N
Niels 已提交
2774

N
Niels 已提交
2775
    @since version 1.0.0
N
Niels 已提交
2776
    */
N
Niels 已提交
2777
    constexpr bool is_object() const noexcept
N
Niels 已提交
2778 2779 2780 2781
    {
        return m_type == value_t::object;
    }

N
Niels 已提交
2782 2783 2784 2785 2786
    /*!
    @brief return whether value is an array

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

N
Niels 已提交
2787
    @return `true` if type is array, `false` otherwise.
N
Niels 已提交
2788 2789 2790

    @complexity Constant.

N
Niels 已提交
2791 2792 2793
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2794
    @liveexample{The following code exemplifies `is_array()` for all JSON
N
Niels 已提交
2795
    types.,is_array}
N
Niels 已提交
2796

N
Niels 已提交
2797
    @since version 1.0.0
N
Niels 已提交
2798
    */
N
Niels 已提交
2799
    constexpr bool is_array() const noexcept
N
Niels 已提交
2800 2801 2802 2803
    {
        return m_type == value_t::array;
    }

N
Niels 已提交
2804 2805 2806 2807 2808
    /*!
    @brief return whether value is a string

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

N
Niels 已提交
2809
    @return `true` if type is string, `false` otherwise.
N
Niels 已提交
2810 2811 2812

    @complexity Constant.

N
Niels 已提交
2813 2814 2815
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2816
    @liveexample{The following code exemplifies `is_string()` for all JSON
N
Niels 已提交
2817
    types.,is_string}
N
Niels 已提交
2818

N
Niels 已提交
2819
    @since version 1.0.0
N
Niels 已提交
2820
    */
N
Niels 已提交
2821
    constexpr bool is_string() const noexcept
N
Niels 已提交
2822 2823 2824 2825
    {
        return m_type == value_t::string;
    }

N
Niels 已提交
2826 2827 2828 2829 2830 2831
    /*!
    @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 已提交
2832 2833 2834 2835
    @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 已提交
2836 2837 2838 2839
    @return `true` if type is discarded, `false` otherwise.

    @complexity Constant.

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

N
Niels 已提交
2843
    @liveexample{The following code exemplifies `is_discarded()` for all JSON
N
Niels 已提交
2844
    types.,is_discarded}
N
Niels 已提交
2845

N
Niels 已提交
2846
    @since version 1.0.0
N
Niels 已提交
2847
    */
N
Niels 已提交
2848
    constexpr bool is_discarded() const noexcept
N
Niels 已提交
2849 2850 2851 2852
    {
        return m_type == value_t::discarded;
    }

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

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

N
Niels 已提交
2869
    @since version 1.0.0
N
Niels 已提交
2870
    */
N
Niels 已提交
2871
    constexpr operator value_t() const noexcept
N
Niels 已提交
2872 2873 2874 2875
    {
        return m_type;
    }

N
Niels 已提交
2876 2877
    /// @}

N
Niels 已提交
2878 2879
  private:
    /// get a boolean (explicit)
2880
    boolean_t get_impl(boolean_t* /*unused*/) const
N
Niels 已提交
2881
    {
2882 2883 2884 2885 2886 2887 2888 2889
        if (is_boolean())
        {
            return m_value.boolean;
        }
        else
        {
            JSON_THROW(std::domain_error("type must be boolean, but is " + type_name()));
        }
N
cleanup  
Niels 已提交
2890 2891
    }

N
Niels 已提交
2892
    /// get a pointer to the value (object)
N
Niels Lohmann 已提交
2893
    object_t* get_impl_ptr(object_t* /*unused*/) noexcept
N
Niels 已提交
2894 2895 2896 2897 2898
    {
        return is_object() ? m_value.object : nullptr;
    }

    /// get a pointer to the value (object)
N
Niels Lohmann 已提交
2899
    constexpr const object_t* get_impl_ptr(const object_t* /*unused*/) const noexcept
N
Niels 已提交
2900 2901 2902 2903 2904
    {
        return is_object() ? m_value.object : nullptr;
    }

    /// get a pointer to the value (array)
N
Niels Lohmann 已提交
2905
    array_t* get_impl_ptr(array_t* /*unused*/) noexcept
N
Niels 已提交
2906 2907 2908 2909
    {
        return is_array() ? m_value.array : nullptr;
    }

N
Niels 已提交
2910
    /// get a pointer to the value (array)
N
Niels Lohmann 已提交
2911
    constexpr const array_t* get_impl_ptr(const array_t* /*unused*/) const noexcept
N
Niels 已提交
2912 2913 2914 2915 2916
    {
        return is_array() ? m_value.array : nullptr;
    }

    /// get a pointer to the value (string)
N
Niels Lohmann 已提交
2917
    string_t* get_impl_ptr(string_t* /*unused*/) noexcept
N
Niels 已提交
2918 2919 2920 2921
    {
        return is_string() ? m_value.string : nullptr;
    }

N
Niels 已提交
2922
    /// get a pointer to the value (string)
N
Niels Lohmann 已提交
2923
    constexpr const string_t* get_impl_ptr(const string_t* /*unused*/) const noexcept
N
Niels 已提交
2924 2925 2926 2927 2928
    {
        return is_string() ? m_value.string : nullptr;
    }

    /// get a pointer to the value (boolean)
N
Niels Lohmann 已提交
2929
    boolean_t* get_impl_ptr(boolean_t* /*unused*/) noexcept
N
Niels 已提交
2930 2931 2932 2933 2934
    {
        return is_boolean() ? &m_value.boolean : nullptr;
    }

    /// get a pointer to the value (boolean)
N
Niels Lohmann 已提交
2935
    constexpr const boolean_t* get_impl_ptr(const boolean_t* /*unused*/) const noexcept
N
Niels 已提交
2936 2937 2938 2939 2940
    {
        return is_boolean() ? &m_value.boolean : nullptr;
    }

    /// get a pointer to the value (integer number)
N
Niels Lohmann 已提交
2941
    number_integer_t* get_impl_ptr(number_integer_t* /*unused*/) noexcept
N
Niels 已提交
2942 2943 2944 2945
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }

N
Niels 已提交
2946
    /// get a pointer to the value (integer number)
N
Niels Lohmann 已提交
2947
    constexpr const number_integer_t* get_impl_ptr(const number_integer_t* /*unused*/) const noexcept
N
Niels 已提交
2948 2949 2950
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }
N
Niels 已提交
2951

2952
    /// get a pointer to the value (unsigned number)
N
Niels Lohmann 已提交
2953
    number_unsigned_t* get_impl_ptr(number_unsigned_t* /*unused*/) noexcept
2954 2955 2956
    {
        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
    }
N
Niels 已提交
2957

2958
    /// get a pointer to the value (unsigned number)
N
Niels Lohmann 已提交
2959
    constexpr const number_unsigned_t* get_impl_ptr(const number_unsigned_t* /*unused*/) const noexcept
2960 2961 2962
    {
        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
    }
N
Niels 已提交
2963

N
Niels 已提交
2964
    /// get a pointer to the value (floating-point number)
N
Niels Lohmann 已提交
2965
    number_float_t* get_impl_ptr(number_float_t* /*unused*/) noexcept
N
Niels 已提交
2966 2967 2968 2969
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

N
Niels 已提交
2970
    /// get a pointer to the value (floating-point number)
N
Niels Lohmann 已提交
2971
    constexpr const number_float_t* get_impl_ptr(const number_float_t* /*unused*/) const noexcept
N
Niels 已提交
2972 2973 2974 2975
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

N
Niels 已提交
2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987
    /*!
    @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>
2988
    static ReferenceType get_ref_impl(ThisType& obj)
D
dariomt 已提交
2989
    {
N
Niels 已提交
2990
        // helper type
N
Niels 已提交
2991 2992
        using PointerType = typename std::add_pointer<ReferenceType>::type;

N
Niels 已提交
2993
        // delegate the call to get_ptr<>()
2994 2995 2996 2997 2998 2999
        auto ptr = obj.template get_ptr<PointerType>();

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

        throw std::domain_error("incompatible ReferenceType for get_ref, actual type is " +
                                obj.type_name());
D
dariomt 已提交
3003 3004
    }

N
Niels 已提交
3005
  public:
T
Théo DELRIEU 已提交
3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018
    /*!
    @brief get special-case overload

    This overloads avoids a lot of template boilerplate, it can be seen as the identity method

    @tparam T type; T == @ref basic_json

    @return a copy of *this

    @complexity Constant.

    @since version 2.1.0
    */
3019 3020 3021 3022 3023 3024 3025
    template <typename T,
              enable_if_t<std::is_same<T, basic_json_t>::value, int> = 0>
    basic_json get() const
    {
      return *this;
    }

T
Théo DELRIEU 已提交
3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040
    /*!
    @brief get overload for CopyConstructible and DefaultConstructible types
    construct a default U value, and call @ref json_serializer<U> from_json method with it

    This overloads is chosen if:
    - U is not @ref basic_json
    - @ref json_serializer<U> has a from_json method of the form: void from_json(const @ref basic_json&, U&)
    - @ref json_serializer<U> does not have a from_json method of the form: U from_json(const @ref basic_json&);

    @return a value of type U 

    @throw what json_serializer<U> from_json method throws

    @since version 2.1.0
    */
3041 3042
    template <
        typename T,
T
Théo DELRIEU 已提交
3043
                 typename U = uncvref_t<T>,
T
Théo DELRIEU 已提交
3044
        enable_if_t<
T
Théo DELRIEU 已提交
3045 3046
            not std::is_same<basic_json_t, U>::value and
                detail::has_from_json<basic_json_t, U>::value and
T
Théo DELRIEU 已提交
3047
                not detail::has_non_default_from_json<basic_json_t,
T
Théo DELRIEU 已提交
3048
                                                      U>::value,
T
Théo DELRIEU 已提交
3049
            int> = 0>
3050 3051
    // do we really want the uncvref ? if a user call get<int &>, shouldn't we
    // static assert ?
T
Théo DELRIEU 已提交
3052
    // i know there is a special behaviour for boolean_t* and such
T
Théo DELRIEU 已提交
3053 3054 3055
    auto get() const noexcept(noexcept(JSONSerializer<U>::from_json(
        std::declval<const basic_json_t &>(), std::declval<U &>())))
        -> U
3056
    {
T
Théo DELRIEU 已提交
3057 3058
      static_assert(std::is_default_constructible<U>::value and
                        std::is_copy_constructible<U>::value,
T
Théo DELRIEU 已提交
3059
                    "Types must be DefaultConstructible and "
3060
                    "CopyConstructible when used with get");
T
Théo DELRIEU 已提交
3061 3062
      U ret;
      JSONSerializer<U>::from_json(*this, ret);
3063
      return ret;
3064 3065
    }

T
Théo DELRIEU 已提交
3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080
    /*!
    @brief get overload for types than cannot be default constructed or copy constructed

    If @ref json_serializer<U> has both overloads of from_json, this one is chosen

    This overloads is chosen if:
    - U is not @ref basic_json
    - @ref json_serializer<U> has a from_json method of the form: U from_json(const @ref basic_json&);

    @return a value of type U 

    @throw what json_serializer<U> from_json method throws

    @since version 2.1.0
    */
3081 3082
    template <
        typename T,
3083
        enable_if_t<not std::is_same<basic_json_t, uncvref_t<T>>::value and
3084 3085
                        detail::has_non_default_from_json<basic_json_t,
                                                          uncvref_t<T>>::value,
3086
                    int> = 0>
T
Théo DELRIEU 已提交
3087
    uncvref_t<T> get() const noexcept(noexcept(JSONSerializer<T>::from_json(std::declval<const basic_json_t &>())))
3088
    {
3089
      return JSONSerializer<T>::from_json(*this);
3090 3091
    }

N
Niels 已提交
3092 3093 3094 3095 3096 3097
    /*!
    @brief get a pointer value (explicit)

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

N
Niels 已提交
3098 3099
    @warning The pointer becomes invalid if the underlying JSON object
    changes.
N
Niels 已提交
3100 3101

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

N
Niels 已提交
3105 3106
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
3107 3108 3109 3110 3111 3112 3113 3114 3115

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

N
Niels 已提交
3117
    @since version 1.0.0
N
Niels 已提交
3118
    */
N
Niels 已提交
3119 3120
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3121 3122 3123 3124 3125 3126 3127 3128 3129 3130
    PointerType get() noexcept
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

    /*!
    @brief get a pointer value (explicit)
    @copydoc get()
    */
N
Niels 已提交
3131 3132
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3133
    constexpr const PointerType get() const noexcept
N
Niels 已提交
3134 3135 3136 3137 3138 3139 3140 3141
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

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

N
Niels 已提交
3142
    Implicit pointer access to the internally stored JSON value. No copies are
N
Niels 已提交
3143 3144 3145 3146 3147 3148
    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 已提交
3149
    object_t, @ref string_t, @ref boolean_t, @ref number_integer_t,
N
Niels 已提交
3150 3151
    @ref number_unsigned_t, or @ref number_float_t. Enforced by a static
    assertion.
N
Niels 已提交
3152

N
Niels 已提交
3153 3154
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
3155 3156 3157 3158 3159 3160 3161

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

N
Niels 已提交
3163
    @since version 1.0.0
N
Niels 已提交
3164
    */
N
Niels 已提交
3165 3166
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3167 3168
    PointerType get_ptr() noexcept
    {
N
Niels 已提交
3169 3170
        // get the type of the PointerType (remove pointer and const)
        using pointee_t = typename std::remove_const<typename
3171 3172
                std::remove_pointer<typename
                                    std::remove_const<PointerType>::type>::type>::type;
N
Niels 已提交
3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183
        // 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 已提交
3184 3185 3186 3187 3188 3189 3190 3191
        // 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 已提交
3192 3193 3194
    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 已提交
3195
    constexpr const PointerType get_ptr() const noexcept
N
Niels 已提交
3196
    {
N
Niels 已提交
3197 3198
        // get the type of the PointerType (remove pointer and const)
        using pointee_t = typename std::remove_const<typename
3199 3200
                std::remove_pointer<typename
                                    std::remove_const<PointerType>::type>::type>::type;
N
Niels 已提交
3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211
        // 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 已提交
3212 3213
        // delegate the call to get_impl_ptr<>() const
        return get_impl_ptr(static_cast<const PointerType>(nullptr));
N
Niels 已提交
3214 3215
    }

N
Niels 已提交
3216
    /*!
D
dariomt 已提交
3217 3218
    @brief get a reference value (implicit)

N
Niels 已提交
3219 3220
    Implict reference access to the internally stored JSON value. No copies
    are made.
D
dariomt 已提交
3221 3222 3223 3224

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

N
Niels 已提交
3225 3226
    @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 已提交
3227
    @ref number_float_t. Enforced by static assertion.
D
dariomt 已提交
3228

N
Niels 已提交
3229 3230 3231
    @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 已提交
3232

N
Niels 已提交
3233 3234
    @throw std::domain_error in case passed type @a ReferenceType is
    incompatible with the stored JSON value
D
dariomt 已提交
3235 3236

    @complexity Constant.
N
Niels 已提交
3237 3238 3239

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

N
Niels 已提交
3240
    @since version 1.1.0
D
dariomt 已提交
3241
    */
N
Niels 已提交
3242 3243
    template<typename ReferenceType, typename std::enable_if<
                 std::is_reference<ReferenceType>::value, int>::type = 0>
D
dariomt 已提交
3244 3245
    ReferenceType get_ref()
    {
N
Niels 已提交
3246 3247
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
D
dariomt 已提交
3248 3249 3250 3251 3252 3253
    }

    /*!
    @brief get a reference value (implicit)
    @copydoc get_ref()
    */
N
Niels 已提交
3254 3255 3256
    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>
3257
    ReferenceType get_ref() const
D
dariomt 已提交
3258
    {
N
Niels 已提交
3259 3260
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
D
dariomt 已提交
3261 3262
    }

N
Niels 已提交
3263 3264 3265
    /*!
    @brief get a value (implicit)

N
Niels 已提交
3266 3267
    Implicit type conversion between the JSON value and a compatible value.
    The call is realized by calling @ref get() const.
N
Niels 已提交
3268 3269 3270

    @tparam ValueType non-pointer type compatible to the JSON value, for
    instance `int` for JSON integer numbers, `bool` for JSON booleans, or
N
Niels 已提交
3271 3272 3273
    `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 已提交
3274 3275 3276 3277 3278 3279 3280 3281

    @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 已提交
3282
    @liveexample{The example below shows several conversions from JSON values
N
Niels 已提交
3283 3284 3285
    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 已提交
3286
    associative containers such as `std::unordered_map<std::string\,
N
Niels 已提交
3287
    json>`.,operator__ValueType}
N
Niels 已提交
3288

N
Niels 已提交
3289
    @since version 1.0.0
N
Niels 已提交
3290
    */
N
Niels 已提交
3291 3292 3293
    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 已提交
3294
#ifndef _MSC_VER  // fix for issue #167 operator<< abiguity under VS2015
N
Niels 已提交
3295
                   and not std::is_same<ValueType, std::initializer_list<typename string_t::value_type>>::value
3296
#endif
N
Niels 已提交
3297
                   , int >::type = 0 >
N
Niels 已提交
3298
    operator ValueType() const
N
cleanup  
Niels 已提交
3299
    {
N
Niels 已提交
3300 3301
        // delegate the call to get<>() const
        return get<ValueType>();
N
cleanup  
Niels 已提交
3302 3303
    }

N
Niels 已提交
3304 3305
    /// @}

N
cleanup  
Niels 已提交
3306 3307 3308 3309 3310

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

N
Niels 已提交
3311
    /// @name element access
N
Niels 已提交
3312
    /// Access to the JSON value.
N
Niels 已提交
3313 3314
    /// @{

N
Niels 已提交
3315 3316 3317 3318 3319 3320 3321 3322 3323 3324
    /*!
    @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 已提交
3325 3326
    @throw std::domain_error if the JSON value is not an array; example:
    `"cannot use at() with string"`
N
Niels 已提交
3327
    @throw std::out_of_range if the index @a idx is out of range of the array;
N
Niels 已提交
3328
    that is, `idx >= size()`; example: `"array index 7 is out of range"`
N
Niels 已提交
3329 3330 3331 3332

    @complexity Constant.

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

N
Niels 已提交
3335
    @since version 1.0.0
N
Niels 已提交
3336
    */
3337
    reference at(size_type idx)
N
cleanup  
Niels 已提交
3338 3339
    {
        // at only works for arrays
3340 3341
        if (is_array())
        {
3342
            JSON_TRY
N
Niels 已提交
3343 3344 3345
            {
                return m_value.array->at(idx);
            }
3346
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3347 3348
            {
                // create better exception explanation
3349
                JSON_THROW(std::out_of_range("array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
3350
            }
3351 3352 3353
        }
        else
        {
3354
            JSON_THROW(std::domain_error("cannot use at() with " + type_name()));
3355
        }
N
cleanup  
Niels 已提交
3356 3357
    }

N
Niels 已提交
3358 3359 3360
    /*!
    @brief access specified array element with bounds checking

N
Niels 已提交
3361 3362
    Returns a const reference to the element at specified location @a idx,
    with bounds checking.
N
Niels 已提交
3363 3364 3365 3366 3367

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

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

N
Niels 已提交
3368 3369
    @throw std::domain_error if the JSON value is not an array; example:
    `"cannot use at() with string"`
N
Niels 已提交
3370
    @throw std::out_of_range if the index @a idx is out of range of the array;
N
Niels 已提交
3371
    that is, `idx >= size()`; example: `"array index 7 is out of range"`
N
Niels 已提交
3372 3373 3374 3375

    @complexity Constant.

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

N
Niels 已提交
3378
    @since version 1.0.0
N
Niels 已提交
3379
    */
3380
    const_reference at(size_type idx) const
N
cleanup  
Niels 已提交
3381 3382
    {
        // at only works for arrays
3383 3384
        if (is_array())
        {
3385
            JSON_TRY
N
Niels 已提交
3386 3387 3388
            {
                return m_value.array->at(idx);
            }
3389
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3390 3391
            {
                // create better exception explanation
3392
                JSON_THROW(std::out_of_range("array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
3393
            }
3394 3395 3396
        }
        else
        {
3397
            JSON_THROW(std::domain_error("cannot use at() with " + type_name()));
3398
        }
3399 3400
    }

N
Niels 已提交
3401 3402 3403 3404 3405 3406 3407 3408 3409 3410
    /*!
    @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 已提交
3411 3412
    @throw std::domain_error if the JSON value is not an object; example:
    `"cannot use at() with boolean"`
N
Niels 已提交
3413
    @throw std::out_of_range if the key @a key is is not stored in the object;
N
Niels 已提交
3414
    that is, `find(key) == end()`; example: `"key "the fast" not found"`
N
Niels 已提交
3415 3416 3417 3418

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3419
    written using `at()`.,at__object_t_key_type}
N
Niels 已提交
3420 3421 3422 3423

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

N
Niels 已提交
3425
    @since version 1.0.0
N
Niels 已提交
3426
    */
3427
    reference at(const typename object_t::key_type& key)
3428 3429
    {
        // at only works for objects
3430 3431
        if (is_object())
        {
3432
            JSON_TRY
N
Niels 已提交
3433 3434 3435
            {
                return m_value.object->at(key);
            }
3436
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3437 3438
            {
                // create better exception explanation
3439
                JSON_THROW(std::out_of_range("key '" + key + "' not found"));
N
Niels 已提交
3440
            }
3441 3442 3443
        }
        else
        {
3444
            JSON_THROW(std::domain_error("cannot use at() with " + type_name()));
3445
        }
3446 3447
    }

N
Niels 已提交
3448 3449 3450
    /*!
    @brief access specified object element with bounds checking

N
Niels 已提交
3451 3452
    Returns a const reference to the element at with specified key @a key,
    with bounds checking.
N
Niels 已提交
3453 3454 3455 3456 3457

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

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

N
Niels 已提交
3458 3459
    @throw std::domain_error if the JSON value is not an object; example:
    `"cannot use at() with boolean"`
N
Niels 已提交
3460
    @throw std::out_of_range if the key @a key is is not stored in the object;
N
Niels 已提交
3461
    that is, `find(key) == end()`; example: `"key "the fast" not found"`
N
Niels 已提交
3462 3463 3464 3465

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3466
    `at()`.,at__object_t_key_type_const}
N
Niels 已提交
3467 3468 3469 3470

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

N
Niels 已提交
3472
    @since version 1.0.0
N
Niels 已提交
3473
    */
3474
    const_reference at(const typename object_t::key_type& key) const
3475 3476
    {
        // at only works for objects
3477 3478
        if (is_object())
        {
3479
            JSON_TRY
N
Niels 已提交
3480 3481 3482
            {
                return m_value.object->at(key);
            }
3483
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3484 3485
            {
                // create better exception explanation
3486
                JSON_THROW(std::out_of_range("key '" + key + "' not found"));
N
Niels 已提交
3487
            }
3488 3489 3490
        }
        else
        {
3491
            JSON_THROW(std::domain_error("cannot use at() with " + type_name()));
3492
        }
N
cleanup  
Niels 已提交
3493 3494
    }

N
Niels 已提交
3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507
    /*!
    @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 已提交
3508 3509
    @throw std::domain_error if JSON is not an array or null; example:
    `"cannot use operator[] with string"`
N
Niels 已提交
3510 3511 3512 3513 3514

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

N
Niels 已提交
3518
    @since version 1.0.0
N
Niels 已提交
3519
    */
3520
    reference operator[](size_type idx)
N
cleanup  
Niels 已提交
3521
    {
N
Niels 已提交
3522
        // implicitly convert null value to an empty array
N
cleanup  
Niels 已提交
3523
        if (is_null())
N
Niels 已提交
3524 3525
        {
            m_type = value_t::array;
3526
            m_value.array = create<array_t>();
3527
            assert_invariant();
N
Niels 已提交
3528 3529
        }

N
Niels 已提交
3530
        // operator[] only works for arrays
N
cleanup  
Niels 已提交
3531
        if (is_array())
N
cleanup  
Niels 已提交
3532
        {
N
Niels 已提交
3533 3534
            // fill up array with null values if given idx is outside range
            if (idx >= m_value.array->size())
N
cleanup  
Niels 已提交
3535
            {
N
Niels 已提交
3536 3537 3538
                m_value.array->insert(m_value.array->end(),
                                      idx - m_value.array->size() + 1,
                                      basic_json());
N
cleanup  
Niels 已提交
3539
            }
N
cleanup  
Niels 已提交
3540

N
cleanup  
Niels 已提交
3541 3542
            return m_value.array->operator[](idx);
        }
N
Niels Lohmann 已提交
3543

3544
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
N
cleanup  
Niels 已提交
3545 3546
    }

N
Niels 已提交
3547 3548 3549 3550 3551 3552 3553 3554 3555
    /*!
    @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 已提交
3556 3557
    @throw std::domain_error if JSON is not an array; example: `"cannot use
    operator[] with null"`
N
Niels 已提交
3558 3559 3560 3561

    @complexity Constant.

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

N
Niels 已提交
3564
    @since version 1.0.0
N
Niels 已提交
3565
    */
3566
    const_reference operator[](size_type idx) const
N
cleanup  
Niels 已提交
3567
    {
N
Niels 已提交
3568
        // const operator[] only works for arrays
N
Niels 已提交
3569 3570 3571 3572
        if (is_array())
        {
            return m_value.array->operator[](idx);
        }
N
Niels Lohmann 已提交
3573

3574
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
N
cleanup  
Niels 已提交
3575 3576
    }

N
Niels 已提交
3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589
    /*!
    @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 已提交
3590
    @throw std::domain_error if JSON is not an object or null; example:
N
Niels 已提交
3591
    `"cannot use operator[] with string"`
N
Niels 已提交
3592 3593 3594 3595

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3596
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
3597 3598 3599 3600

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

N
Niels 已提交
3602
    @since version 1.0.0
N
Niels 已提交
3603
    */
3604
    reference operator[](const typename object_t::key_type& key)
N
cleanup  
Niels 已提交
3605
    {
N
Niels 已提交
3606
        // implicitly convert null value to an empty object
N
cleanup  
Niels 已提交
3607
        if (is_null())
N
Niels 已提交
3608 3609
        {
            m_type = value_t::object;
3610
            m_value.object = create<object_t>();
3611
            assert_invariant();
N
Niels 已提交
3612 3613
        }

N
Niels 已提交
3614
        // operator[] only works for objects
N
Niels 已提交
3615 3616 3617 3618
        if (is_object())
        {
            return m_value.object->operator[](key);
        }
N
Niels Lohmann 已提交
3619

3620
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
N
cleanup  
Niels 已提交
3621 3622
    }

3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635
    /*!
    @brief read-only access specified object element

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

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

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

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

N
Niels 已提交
3636 3637 3638
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

N
Niels 已提交
3639 3640
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    operator[] with null"`
3641 3642 3643 3644

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3645
    the `[]` operator.,operatorarray__key_type_const}
3646 3647 3648 3649 3650

    @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 已提交
3651
    @since version 1.0.0
3652 3653 3654
    */
    const_reference operator[](const typename object_t::key_type& key) const
    {
N
Niels 已提交
3655
        // const operator[] only works for objects
N
Niels 已提交
3656 3657 3658 3659 3660
        if (is_object())
        {
            assert(m_value.object->find(key) != m_value.object->end());
            return m_value.object->find(key)->second;
        }
N
Niels Lohmann 已提交
3661

3662
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
3663 3664
    }

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

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3684
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
3685 3686 3687 3688

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

N
Niels 已提交
3690
    @since version 1.0.0
N
Niels 已提交
3691
    */
N
Niels 已提交
3692
    template<typename T, std::size_t n>
N
Niels 已提交
3693
    reference operator[](T * (&key)[n])
3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718
    {
        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 已提交
3719
    the `[]` operator.,operatorarray__key_type_const}
3720 3721 3722 3723 3724 3725 3726 3727

    @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 已提交
3728
    const_reference operator[](T * (&key)[n]) const
3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746
    {
        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 已提交
3747
    `"cannot use operator[] with string"`
3748 3749 3750 3751

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3752
    written using the `[]` operator.,operatorarray__key_type}
3753 3754 3755 3756 3757

    @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 已提交
3758
    @since version 1.1.0
3759 3760 3761
    */
    template<typename T>
    reference operator[](T* key)
N
cleanup  
Niels 已提交
3762
    {
N
Niels 已提交
3763
        // implicitly convert null to object
N
cleanup  
Niels 已提交
3764
        if (is_null())
N
Niels 已提交
3765 3766
        {
            m_type = value_t::object;
N
Niels 已提交
3767
            m_value = value_t::object;
3768
            assert_invariant();
N
Niels 已提交
3769 3770
        }

N
cleanup  
Niels 已提交
3771
        // at only works for objects
N
Niels 已提交
3772 3773 3774 3775
        if (is_object())
        {
            return m_value.object->operator[](key);
        }
N
Niels Lohmann 已提交
3776

3777
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
N
cleanup  
Niels 已提交
3778 3779
    }

3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792
    /*!
    @brief read-only access specified object element

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

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

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

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

N
Niels 已提交
3793 3794 3795
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

N
Niels 已提交
3796 3797
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    operator[] with null"`
3798 3799 3800 3801

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3802
    the `[]` operator.,operatorarray__key_type_const}
3803 3804 3805 3806 3807

    @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 已提交
3808
    @since version 1.1.0
3809
    */
3810 3811
    template<typename T>
    const_reference operator[](T* key) const
3812 3813
    {
        // at only works for objects
N
Niels 已提交
3814 3815 3816 3817 3818
        if (is_object())
        {
            assert(m_value.object->find(key) != m_value.object->end());
            return m_value.object->find(key)->second;
        }
N
Niels Lohmann 已提交
3819

3820
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
3821 3822
    }

N
Niels 已提交
3823 3824 3825
    /*!
    @brief access specified object element with default value

N
Niels 已提交
3826 3827
    Returns either a copy of an object's element at the specified key @a key
    or a given default value if no element with key @a key exists.
N
Niels 已提交
3828 3829

    The function is basically equivalent to executing
3830
    @code {.cpp}
N
Niels 已提交
3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855
    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 已提交
3856 3857
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    value() with null"`
N
Niels 已提交
3858 3859 3860 3861 3862 3863 3864 3865 3866 3867

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

N
Niels 已提交
3869
    @since version 1.0.0
N
Niels 已提交
3870
    */
N
Niels 已提交
3871 3872
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883
    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 已提交
3884 3885

            return default_value;
N
Niels 已提交
3886 3887 3888
        }
        else
        {
3889
            JSON_THROW(std::domain_error("cannot use value() with " + type_name()));
N
Niels 已提交
3890 3891 3892 3893
        }
    }

    /*!
N
Niels 已提交
3894
    @brief overload for a default value of type const char*
N
Niels 已提交
3895
    @copydoc basic_json::value(const typename object_t::key_type&, ValueType) const
N
Niels 已提交
3896 3897 3898 3899 3900 3901
    */
    string_t value(const typename object_t::key_type& key, const char* default_value) const
    {
        return value(key, string_t(default_value));
    }

N
Niels 已提交
3902 3903 3904
    /*!
    @brief access specified object element via JSON Pointer with default value

N
Niels 已提交
3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919
    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 已提交
3920 3921 3922 3923 3924 3925 3926 3927
    @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 已提交
3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938
    @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 已提交
3939
    @sa @ref operator[](const json_pointer&) for unchecked access by reference
N
Niels 已提交
3940

N
Niels 已提交
3941 3942
    @since version 2.0.2
    */
N
Niels 已提交
3943 3944
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
3945 3946 3947 3948 3949 3950
    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
3951
            JSON_TRY
N
Niels 已提交
3952 3953 3954
            {
                return ptr.get_checked(this);
            }
3955
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3956 3957 3958 3959
            {
                return default_value;
            }
        }
N
Niels Lohmann 已提交
3960

3961
        JSON_THROW(std::domain_error("cannot use value() with " + type_name()));
N
Niels 已提交
3962 3963 3964 3965
    }

    /*!
    @brief overload for a default value of type const char*
N
Niels 已提交
3966
    @copydoc basic_json::value(const json_pointer&, ValueType) const
N
Niels 已提交
3967 3968 3969 3970 3971 3972
    */
    string_t value(const json_pointer& ptr, const char* default_value) const
    {
        return value(ptr, string_t(default_value));
    }

N
Niels 已提交
3973 3974 3975 3976 3977 3978
    /*!
    @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 已提交
3979
    @return In case of a structured type (array or object), a reference to the
3980
    first element is returned. In case of number, string, or boolean values, a
N
Niels 已提交
3981 3982 3983 3984
    reference to the value is returned.

    @complexity Constant.

N
Niels 已提交
3985
    @pre The JSON value must not be `null` (would throw `std::out_of_range`)
N
Niels 已提交
3986 3987
    or an empty array or object (undefined behavior, **guarded by
    assertions**).
N
Niels 已提交
3988 3989 3990
    @post The JSON value remains unchanged.

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

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

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

N
Niels 已提交
3996
    @since version 1.0.0
N
Niels 已提交
3997
    */
3998
    reference front()
N
Niels 已提交
3999 4000 4001 4002
    {
        return *begin();
    }

N
Niels 已提交
4003 4004 4005
    /*!
    @copydoc basic_json::front()
    */
4006
    const_reference front() const
N
Niels 已提交
4007 4008 4009 4010
    {
        return *cbegin();
    }

N
Niels 已提交
4011 4012 4013 4014
    /*!
    @brief access the last element

    Returns a reference to the last element in the container. For a JSON
N
Niels 已提交
4015 4016 4017 4018 4019 4020
    container `c`, the expression `c.back()` is equivalent to
    @code {.cpp}
    auto tmp = c.end();
    --tmp;
    return *tmp;
    @endcode
N
Niels 已提交
4021

N
Niels 已提交
4022
    @return In case of a structured type (array or object), a reference to the
4023
    last element is returned. In case of number, string, or boolean values, a
N
Niels 已提交
4024 4025 4026 4027
    reference to the value is returned.

    @complexity Constant.

N
Niels 已提交
4028
    @pre The JSON value must not be `null` (would throw `std::out_of_range`)
N
Niels 已提交
4029 4030
    or an empty array or object (undefined behavior, **guarded by
    assertions**).
N
Niels 已提交
4031
    @post The JSON value remains unchanged.
N
Niels 已提交
4032

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

N
Niels 已提交
4035 4036 4037
    @liveexample{The following code shows an example for `back()`.,back}

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

N
Niels 已提交
4039
    @since version 1.0.0
N
Niels 已提交
4040
    */
4041
    reference back()
N
Niels 已提交
4042 4043 4044 4045 4046 4047
    {
        auto tmp = end();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
4048 4049 4050
    /*!
    @copydoc basic_json::back()
    */
4051
    const_reference back() const
N
Niels 已提交
4052 4053 4054 4055 4056 4057
    {
        auto tmp = cend();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
4058 4059 4060
    /*!
    @brief remove element given an iterator

N
Niels 已提交
4061 4062 4063
    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 已提交
4064

N
Niels 已提交
4065
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
4066 4067 4068
    will be `null`.

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

4072
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
4073

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

N
Niels 已提交
4077 4078
    @throw std::domain_error if called on a `null` value; example: `"cannot
    use erase() with null"`
N
Niels 已提交
4079
    @throw std::domain_error if called on an iterator which does not belong to
N
Niels 已提交
4080
    the current JSON value; example: `"iterator does not fit current value"`
N
Niels 已提交
4081
    @throw std::out_of_range if called on a primitive type with invalid
N
Niels 已提交
4082 4083
    iterator (i.e., any iterator which is not `begin()`); example: `"iterator
    out of range"`
N
Niels 已提交
4084 4085 4086 4087 4088 4089 4090

    @complexity The complexity depends on the type:
    - objects: amortized constant
    - arrays: linear in distance between pos and the end of the container
    - strings: linear in the length of the string
    - other types: constant

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

4094
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4095
    the given range
N
Niels 已提交
4096
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4097
    from an object at the given key
N
Niels 已提交
4098 4099
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4100

N
Niels 已提交
4101
    @since version 1.0.0
N
Niels 已提交
4102
    */
N
Niels 已提交
4103 4104 4105 4106
    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>
4107
    IteratorType erase(IteratorType pos)
4108 4109
    {
        // make sure iterator fits the current value
N
Niels 已提交
4110
        if (this != pos.m_object)
4111
        {
4112
            JSON_THROW(std::domain_error("iterator does not fit current value"));
4113 4114
        }

4115
        IteratorType result = end();
4116 4117 4118 4119

        switch (m_type)
        {
            case value_t::boolean:
4120 4121
            case value_t::number_float:
            case value_t::number_integer:
4122
            case value_t::number_unsigned:
4123 4124
            case value_t::string:
            {
4125
                if (not pos.m_it.primitive_iterator.is_begin())
4126
                {
4127
                    JSON_THROW(std::out_of_range("iterator out of range"));
4128 4129
                }

N
cleanup  
Niels 已提交
4130
                if (is_string())
4131
                {
4132 4133 4134
                    AllocatorType<string_t> alloc;
                    alloc.destroy(m_value.string);
                    alloc.deallocate(m_value.string, 1);
4135 4136 4137 4138
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
4139
                assert_invariant();
4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156
                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:
            {
4157
                JSON_THROW(std::domain_error("cannot use erase() with " + type_name()));
4158 4159 4160 4161 4162 4163
            }
        }

        return result;
    }

N
Niels 已提交
4164 4165 4166
    /*!
    @brief remove elements given an iterator range

N
Niels 已提交
4167 4168 4169
    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 已提交
4170

N
Niels 已提交
4171
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
4172 4173 4174 4175 4176
    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 已提交
4177
    second refers to the last element, the `end()` iterator is returned.
N
Niels 已提交
4178

4179
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
4180

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

N
Niels 已提交
4184 4185
    @throw std::domain_error if called on a `null` value; example: `"cannot
    use erase() with null"`
N
Niels 已提交
4186
    @throw std::domain_error if called on iterators which does not belong to
N
Niels 已提交
4187
    the current JSON value; example: `"iterators do not fit current value"`
N
Niels 已提交
4188
    @throw std::out_of_range if called on a primitive type with invalid
N
Niels 已提交
4189 4190
    iterators (i.e., if `first != begin()` and `last != end()`); example:
    `"iterators out of range"`
N
Niels 已提交
4191 4192 4193 4194 4195 4196 4197 4198

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

4202
    @sa @ref erase(IteratorType) -- removes the element at a given position
N
Niels 已提交
4203
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4204
    from an object at the given key
N
Niels 已提交
4205 4206
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4207

N
Niels 已提交
4208
    @since version 1.0.0
N
Niels 已提交
4209
    */
N
Niels 已提交
4210 4211 4212 4213
    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>
4214
    IteratorType erase(IteratorType first, IteratorType last)
4215 4216
    {
        // make sure iterator fits the current value
N
Niels 已提交
4217
        if (this != first.m_object or this != last.m_object)
4218
        {
4219
            JSON_THROW(std::domain_error("iterators do not fit current value"));
4220 4221
        }

4222
        IteratorType result = end();
4223 4224 4225 4226

        switch (m_type)
        {
            case value_t::boolean:
4227 4228
            case value_t::number_float:
            case value_t::number_integer:
4229
            case value_t::number_unsigned:
4230 4231
            case value_t::string:
            {
4232
                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
4233
                {
4234
                    JSON_THROW(std::out_of_range("iterators out of range"));
4235 4236
                }

N
cleanup  
Niels 已提交
4237
                if (is_string())
4238
                {
4239 4240 4241
                    AllocatorType<string_t> alloc;
                    alloc.destroy(m_value.string);
                    alloc.deallocate(m_value.string, 1);
4242 4243 4244 4245
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
4246
                assert_invariant();
4247 4248 4249 4250 4251 4252
                break;
            }

            case value_t::object:
            {
                result.m_it.object_iterator = m_value.object->erase(first.m_it.object_iterator,
4253
                        last.m_it.object_iterator);
4254 4255 4256 4257 4258 4259
                break;
            }

            case value_t::array:
            {
                result.m_it.array_iterator = m_value.array->erase(first.m_it.array_iterator,
4260
                        last.m_it.array_iterator);
4261 4262 4263 4264 4265
                break;
            }

            default:
            {
4266
                JSON_THROW(std::domain_error("cannot use erase() with " + type_name()));
4267 4268 4269 4270 4271 4272
            }
        }

        return result;
    }

N
Niels 已提交
4273 4274 4275 4276 4277 4278 4279
    /*!
    @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 已提交
4280
    @return Number of elements removed. If @a ObjectType is the default
N
Niels 已提交
4281 4282
    `std::map` type, the return value will always be `0` (@a key was not
    found) or `1` (@a key was found).
N
Niels 已提交
4283 4284 4285

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

N
Niels 已提交
4287 4288
    @throw std::domain_error when called on a type other than JSON object;
    example: `"cannot use erase() with null"`
N
Niels 已提交
4289 4290 4291

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

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

4294 4295
    @sa @ref erase(IteratorType) -- removes the element at a given position
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4296 4297 4298
    the given range
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4299

N
Niels 已提交
4300
    @since version 1.0.0
N
Niels 已提交
4301
    */
4302
    size_type erase(const typename object_t::key_type& key)
4303
    {
N
Niels 已提交
4304
        // this erase only works for objects
N
Niels 已提交
4305 4306 4307 4308
        if (is_object())
        {
            return m_value.object->erase(key);
        }
N
Niels Lohmann 已提交
4309

4310
        JSON_THROW(std::domain_error("cannot use erase() with " + type_name()));
4311 4312
    }

N
Niels 已提交
4313 4314 4315 4316 4317 4318 4319
    /*!
    @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 已提交
4320 4321
    @throw std::domain_error when called on a type other than JSON array;
    example: `"cannot use erase() with null"`
N
Niels 已提交
4322 4323
    @throw std::out_of_range when `idx >= size()`; example: `"array index 17
    is out of range"`
N
Niels 已提交
4324 4325 4326

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

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

4329 4330
    @sa @ref erase(IteratorType) -- removes the element at a given position
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4331
    the given range
N
Niels 已提交
4332
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4333 4334
    from an object at the given key

N
Niels 已提交
4335
    @since version 1.0.0
N
Niels 已提交
4336
    */
4337
    void erase(const size_type idx)
N
Niels 已提交
4338 4339
    {
        // this erase only works for arrays
N
cleanup  
Niels 已提交
4340
        if (is_array())
N
Niels 已提交
4341
        {
N
cleanup  
Niels 已提交
4342 4343
            if (idx >= size())
            {
4344
                JSON_THROW(std::out_of_range("array index " + std::to_string(idx) + " is out of range"));
N
cleanup  
Niels 已提交
4345
            }
N
Niels 已提交
4346

N
cleanup  
Niels 已提交
4347 4348 4349
            m_value.array->erase(m_value.array->begin() + static_cast<difference_type>(idx));
        }
        else
N
Niels 已提交
4350
        {
4351
            JSON_THROW(std::domain_error("cannot use erase() with " + type_name()));
N
Niels 已提交
4352 4353 4354
        }
    }

N
Niels 已提交
4355 4356 4357 4358 4359 4360 4361 4362 4363 4364
    /// @}


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

    /// @name lookup
    /// @{

N
Niels 已提交
4365 4366 4367 4368
    /*!
    @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 已提交
4369 4370
    element is not found or the JSON value is not an object, end() is
    returned.
N
Niels 已提交
4371

4372 4373 4374
    @note This method always returns @ref end() when executed on a JSON type
          that is not an object.

N
Niels 已提交
4375 4376 4377
    @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
4378 4379
    element is found or the JSON value is not an object, past-the-end (see
    @ref end()) iterator is returned.
N
Niels 已提交
4380 4381 4382

    @complexity Logarithmic in the size of the JSON object.

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

N
Niels 已提交
4385
    @since version 1.0.0
N
Niels 已提交
4386
    */
4387
    iterator find(typename object_t::key_type key)
N
Niels 已提交
4388 4389 4390
    {
        auto result = end();

N
cleanup  
Niels 已提交
4391
        if (is_object())
N
Niels 已提交
4392 4393 4394 4395 4396 4397 4398
        {
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4399 4400 4401 4402
    /*!
    @brief find an element in a JSON object
    @copydoc find(typename object_t::key_type)
    */
4403
    const_iterator find(typename object_t::key_type key) const
N
Niels 已提交
4404 4405 4406
    {
        auto result = cend();

N
cleanup  
Niels 已提交
4407
        if (is_object())
N
Niels 已提交
4408 4409 4410 4411 4412 4413 4414
        {
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4415 4416 4417 4418 4419 4420 4421
    /*!
    @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).

4422 4423 4424
    @note This method always returns `0` when executed on a JSON type that is
          not an object.

N
Niels 已提交
4425 4426 4427 4428 4429 4430 4431
    @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 已提交
4432
    @liveexample{The example shows how `count()` is used.,count}
N
Niels 已提交
4433

N
Niels 已提交
4434
    @since version 1.0.0
N
Niels 已提交
4435
    */
4436
    size_type count(typename object_t::key_type key) const
4437 4438
    {
        // return 0 for all nonobject types
N
Niels 已提交
4439
        return is_object() ? m_value.object->count(key) : 0;
4440 4441
    }

N
Niels 已提交
4442 4443
    /// @}

N
Niels 已提交
4444

N
cleanup  
Niels 已提交
4445 4446 4447 4448
    ///////////////
    // iterators //
    ///////////////

N
Niels 已提交
4449 4450 4451
    /// @name iterators
    /// @{

N
Niels 已提交
4452 4453
    /*!
    @brief returns an iterator to the first element
N
Niels 已提交
4454 4455 4456 4457 4458 4459 4460 4461 4462

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

N
Niels 已提交
4468 4469 4470 4471 4472
    @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 已提交
4473

N
Niels 已提交
4474
    @since version 1.0.0
N
Niels 已提交
4475
    */
N
Niels 已提交
4476
    iterator begin() noexcept
N
cleanup  
Niels 已提交
4477 4478 4479 4480 4481 4482
    {
        iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4483
    /*!
N
Niels 已提交
4484
    @copydoc basic_json::cbegin()
N
Niels 已提交
4485
    */
N
Niels 已提交
4486
    const_iterator begin() const noexcept
N
cleanup  
Niels 已提交
4487
    {
N
Niels 已提交
4488
        return cbegin();
N
cleanup  
Niels 已提交
4489 4490
    }

N
Niels 已提交
4491 4492
    /*!
    @brief returns a const iterator to the first element
N
Niels 已提交
4493 4494 4495 4496 4497 4498 4499 4500 4501

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

N
Niels 已提交
4508 4509 4510 4511 4512
    @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 已提交
4513

N
Niels 已提交
4514
    @since version 1.0.0
N
Niels 已提交
4515
    */
N
Niels 已提交
4516
    const_iterator cbegin() const noexcept
N
cleanup  
Niels 已提交
4517 4518 4519 4520 4521 4522
    {
        const_iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4523 4524
    /*!
    @brief returns an iterator to one past the last element
N
Niels 已提交
4525 4526 4527 4528 4529 4530 4531 4532 4533

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

N
Niels 已提交
4539 4540 4541 4542 4543
    @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 已提交
4544

N
Niels 已提交
4545
    @since version 1.0.0
N
Niels 已提交
4546
    */
N
Niels 已提交
4547
    iterator end() noexcept
N
cleanup  
Niels 已提交
4548 4549 4550 4551 4552 4553
    {
        iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
4554
    /*!
N
Niels 已提交
4555
    @copydoc basic_json::cend()
N
Niels 已提交
4556
    */
N
Niels 已提交
4557
    const_iterator end() const noexcept
N
cleanup  
Niels 已提交
4558
    {
N
Niels 已提交
4559
        return cend();
N
cleanup  
Niels 已提交
4560 4561
    }

N
Niels 已提交
4562 4563
    /*!
    @brief returns a const iterator to one past the last element
N
Niels 已提交
4564 4565 4566 4567 4568 4569 4570 4571 4572

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

N
Niels 已提交
4579 4580 4581 4582 4583
    @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 已提交
4584

N
Niels 已提交
4585
    @since version 1.0.0
N
Niels 已提交
4586
    */
N
Niels 已提交
4587
    const_iterator cend() const noexcept
N
cleanup  
Niels 已提交
4588 4589 4590 4591 4592 4593
    {
        const_iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
4594
    /*!
N
Niels 已提交
4595 4596 4597 4598 4599 4600 4601 4602
    @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 已提交
4603 4604 4605
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4606 4607 4608
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(end())`.

N
Niels 已提交
4609 4610 4611 4612 4613
    @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 已提交
4614

N
Niels 已提交
4615
    @since version 1.0.0
N
Niels 已提交
4616
    */
N
Niels 已提交
4617
    reverse_iterator rbegin() noexcept
N
Niels 已提交
4618 4619 4620 4621
    {
        return reverse_iterator(end());
    }

N
Niels 已提交
4622
    /*!
N
Niels 已提交
4623
    @copydoc basic_json::crbegin()
N
Niels 已提交
4624
    */
N
Niels 已提交
4625
    const_reverse_iterator rbegin() const noexcept
N
Niels 已提交
4626
    {
N
Niels 已提交
4627
        return crbegin();
N
Niels 已提交
4628 4629
    }

N
Niels 已提交
4630
    /*!
N
Niels 已提交
4631 4632 4633 4634 4635 4636 4637 4638 4639
    @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 已提交
4640 4641 4642
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4643 4644 4645
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(begin())`.

N
Niels 已提交
4646 4647 4648 4649 4650
    @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 已提交
4651

N
Niels 已提交
4652
    @since version 1.0.0
N
Niels 已提交
4653
    */
N
Niels 已提交
4654
    reverse_iterator rend() noexcept
N
Niels 已提交
4655 4656 4657 4658
    {
        return reverse_iterator(begin());
    }

N
Niels 已提交
4659
    /*!
N
Niels 已提交
4660
    @copydoc basic_json::crend()
N
Niels 已提交
4661
    */
N
Niels 已提交
4662
    const_reverse_iterator rend() const noexcept
N
Niels 已提交
4663
    {
N
Niels 已提交
4664
        return crend();
N
Niels 已提交
4665 4666
    }

N
Niels 已提交
4667
    /*!
N
Niels 已提交
4668 4669 4670 4671 4672 4673 4674 4675 4676
    @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 已提交
4677 4678 4679
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4680 4681 4682
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).rbegin()`.

N
Niels 已提交
4683 4684 4685 4686 4687
    @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 已提交
4688

N
Niels 已提交
4689
    @since version 1.0.0
N
Niels 已提交
4690
    */
N
Niels 已提交
4691
    const_reverse_iterator crbegin() const noexcept
N
Niels 已提交
4692 4693 4694 4695
    {
        return const_reverse_iterator(cend());
    }

N
Niels 已提交
4696
    /*!
N
Niels 已提交
4697 4698 4699 4700 4701 4702 4703 4704 4705
    @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 已提交
4706 4707 4708
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4709 4710 4711
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).rend()`.

N
Niels 已提交
4712 4713 4714 4715 4716
    @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 已提交
4717

N
Niels 已提交
4718
    @since version 1.0.0
N
Niels 已提交
4719
    */
N
Niels 已提交
4720
    const_reverse_iterator crend() const noexcept
N
Niels 已提交
4721 4722 4723 4724
    {
        return const_reverse_iterator(cbegin());
    }

N
cleanup  
Niels 已提交
4725 4726 4727 4728 4729 4730 4731 4732
  private:
    // forward declaration
    template<typename IteratorType> class iteration_proxy;

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

N
Niels 已提交
4733
    This function allows to access @ref iterator::key() and @ref
N
Niels 已提交
4734 4735 4736
    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 已提交
4737 4738 4739

    @note The name of this function is not yet final and may change in the
    future.
N
cleanup  
Niels 已提交
4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753
    */
    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 已提交
4754 4755
    /// @}

N
cleanup  
Niels 已提交
4756 4757 4758 4759 4760

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

N
Niels 已提交
4761 4762 4763
    /// @name capacity
    /// @{

N
Niels 已提交
4764 4765
    /*!
    @brief checks whether the container is empty
N
Niels 已提交
4766 4767 4768

    Checks if a JSON value has no elements.

N
Niels 已提交
4769
    @return The return value depends on the different types and is
N
Niels 已提交
4770 4771 4772
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
4773 4774 4775 4776 4777 4778
            null        | `true`
            boolean     | `false`
            string      | `false`
            number      | `false`
            object      | result of function `object_t::empty()`
            array       | result of function `array_t::empty()`
N
Niels 已提交
4779

N
Niels 已提交
4780 4781 4782 4783
    @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 已提交
4784 4785
    @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 已提交
4786
    complexity.
N
Niels 已提交
4787

N
Niels 已提交
4788 4789 4790
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
4791 4792 4793
    - The complexity is constant.
    - Has the semantics of `begin() == end()`.

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

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

N
Niels 已提交
4799
    @since version 1.0.0
N
Niels 已提交
4800
    */
4801
    bool empty() const noexcept
N
cleanup  
Niels 已提交
4802 4803 4804
    {
        switch (m_type)
        {
4805
            case value_t::null:
N
cleanup  
Niels 已提交
4806
            {
N
Niels 已提交
4807
                // null values are empty
N
cleanup  
Niels 已提交
4808 4809
                return true;
            }
N
Niels 已提交
4810

4811
            case value_t::array:
N
cleanup  
Niels 已提交
4812
            {
N
Niels 已提交
4813
                // delegate call to array_t::empty()
N
cleanup  
Niels 已提交
4814 4815
                return m_value.array->empty();
            }
N
Niels 已提交
4816

4817
            case value_t::object:
N
cleanup  
Niels 已提交
4818
            {
N
Niels 已提交
4819
                // delegate call to object_t::empty()
N
cleanup  
Niels 已提交
4820 4821
                return m_value.object->empty();
            }
N
Niels 已提交
4822

N
Niels 已提交
4823 4824 4825 4826 4827 4828
            default:
            {
                // all other types are nonempty
                return false;
            }
        }
N
cleanup  
Niels 已提交
4829 4830
    }

N
Niels 已提交
4831 4832
    /*!
    @brief returns the number of elements
N
Niels 已提交
4833 4834 4835

    Returns the number of elements in a JSON value.

N
Niels 已提交
4836
    @return The return value depends on the different types and is
N
Niels 已提交
4837 4838 4839
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
4840 4841 4842 4843
            null        | `0`
            boolean     | `1`
            string      | `1`
            number      | `1`
N
Niels 已提交
4844 4845 4846
            object      | result of function object_t::size()
            array       | result of function array_t::size()

N
Niels 已提交
4847 4848 4849 4850
    @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 已提交
4851 4852 4853
    @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 已提交
4854

N
Niels 已提交
4855 4856 4857
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
4858 4859 4860
    - The complexity is constant.
    - Has the semantics of `std::distance(begin(), end())`.

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

N
Niels 已提交
4864 4865 4866
    @sa @ref empty() -- checks whether the container is empty
    @sa @ref max_size() -- returns the maximal number of elements

N
Niels 已提交
4867
    @since version 1.0.0
N
Niels 已提交
4868
    */
4869
    size_type size() const noexcept
N
cleanup  
Niels 已提交
4870 4871 4872
    {
        switch (m_type)
        {
4873
            case value_t::null:
N
cleanup  
Niels 已提交
4874
            {
N
Niels 已提交
4875
                // null values are empty
N
cleanup  
Niels 已提交
4876 4877
                return 0;
            }
N
Niels 已提交
4878

4879
            case value_t::array:
N
cleanup  
Niels 已提交
4880
            {
N
Niels 已提交
4881
                // delegate call to array_t::size()
N
cleanup  
Niels 已提交
4882 4883
                return m_value.array->size();
            }
N
Niels 已提交
4884

4885
            case value_t::object:
N
cleanup  
Niels 已提交
4886
            {
N
Niels 已提交
4887
                // delegate call to object_t::size()
N
cleanup  
Niels 已提交
4888 4889
                return m_value.object->size();
            }
N
Niels 已提交
4890

N
Niels 已提交
4891 4892 4893 4894 4895 4896
            default:
            {
                // all other types have size 1
                return 1;
            }
        }
N
cleanup  
Niels 已提交
4897 4898
    }

N
Niels 已提交
4899 4900
    /*!
    @brief returns the maximum possible number of elements
N
Niels 已提交
4901 4902 4903 4904 4905

    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 已提交
4906
    @return The return value depends on the different types and is
N
Niels 已提交
4907 4908 4909
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
4910 4911 4912 4913 4914 4915
            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 已提交
4916

N
Niels 已提交
4917 4918
    @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 已提交
4919
    complexity.
N
Niels 已提交
4920

N
Niels 已提交
4921 4922 4923
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
4924 4925 4926 4927
    - The complexity is constant.
    - Has the semantics of returning `b.size()` where `b` is the largest
      possible JSON value.

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

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

N
Niels 已提交
4933
    @since version 1.0.0
N
Niels 已提交
4934
    */
4935
    size_type max_size() const noexcept
N
cleanup  
Niels 已提交
4936 4937 4938
    {
        switch (m_type)
        {
4939
            case value_t::array:
N
cleanup  
Niels 已提交
4940
            {
N
Niels 已提交
4941
                // delegate call to array_t::max_size()
N
cleanup  
Niels 已提交
4942 4943
                return m_value.array->max_size();
            }
N
Niels 已提交
4944

4945
            case value_t::object:
N
cleanup  
Niels 已提交
4946
            {
N
Niels 已提交
4947
                // delegate call to object_t::max_size()
N
cleanup  
Niels 已提交
4948 4949
                return m_value.object->max_size();
            }
N
Niels 已提交
4950

N
Niels 已提交
4951 4952
            default:
            {
4953 4954
                // all other types have max_size() == size()
                return size();
N
Niels 已提交
4955 4956
            }
        }
N
cleanup  
Niels 已提交
4957 4958
    }

N
Niels 已提交
4959 4960
    /// @}

N
cleanup  
Niels 已提交
4961 4962 4963 4964 4965

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

N
Niels 已提交
4966 4967 4968
    /// @name modifiers
    /// @{

N
Niels 已提交
4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985
    /*!
    @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 已提交
4986
    @liveexample{The example below shows the effect of `clear()` to different
N
Niels 已提交
4987
    JSON types.,clear}
N
Niels 已提交
4988

N
Niels 已提交
4989
    @since version 1.0.0
N
Niels 已提交
4990
    */
4991
    void clear() noexcept
N
cleanup  
Niels 已提交
4992 4993 4994
    {
        switch (m_type)
        {
4995
            case value_t::number_integer:
N
cleanup  
Niels 已提交
4996
            {
N
Niels 已提交
4997
                m_value.number_integer = 0;
N
cleanup  
Niels 已提交
4998 4999
                break;
            }
N
Niels 已提交
5000

5001 5002 5003 5004 5005 5006
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = 0;
                break;
            }

5007
            case value_t::number_float:
N
cleanup  
Niels 已提交
5008
            {
N
Niels 已提交
5009
                m_value.number_float = 0.0;
N
cleanup  
Niels 已提交
5010 5011
                break;
            }
N
Niels 已提交
5012

5013
            case value_t::boolean:
N
cleanup  
Niels 已提交
5014
            {
N
Niels 已提交
5015
                m_value.boolean = false;
N
cleanup  
Niels 已提交
5016 5017
                break;
            }
N
Niels 已提交
5018

5019
            case value_t::string:
N
cleanup  
Niels 已提交
5020 5021 5022 5023
            {
                m_value.string->clear();
                break;
            }
N
Niels 已提交
5024

5025
            case value_t::array:
N
cleanup  
Niels 已提交
5026 5027 5028 5029
            {
                m_value.array->clear();
                break;
            }
N
Niels 已提交
5030

5031
            case value_t::object:
N
cleanup  
Niels 已提交
5032 5033 5034 5035
            {
                m_value.object->clear();
                break;
            }
5036 5037 5038 5039 5040

            default:
            {
                break;
            }
N
cleanup  
Niels 已提交
5041 5042 5043
        }
    }

5044 5045 5046
    /*!
    @brief add an object to an array

5047
    Appends the given element @a val to the end of the JSON value. If the
5048
    function is called on a JSON null value, an empty array is created before
5049
    appending @a val.
5050

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

N
Niels 已提交
5053 5054
    @throw std::domain_error when called on a type other than JSON array or
    null; example: `"cannot use push_back() with number"`
5055 5056 5057

    @complexity Amortized constant.

N
Niels 已提交
5058 5059 5060
    @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 已提交
5061

N
Niels 已提交
5062
    @since version 1.0.0
5063
    */
5064
    void push_back(basic_json&& val)
N
cleanup  
Niels 已提交
5065 5066
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
5067
        if (not(is_null() or is_array()))
N
cleanup  
Niels 已提交
5068
        {
5069
            JSON_THROW(std::domain_error("cannot use push_back() with " + type_name()));
N
cleanup  
Niels 已提交
5070 5071 5072
        }

        // transform null object into an array
N
cleanup  
Niels 已提交
5073
        if (is_null())
N
cleanup  
Niels 已提交
5074 5075
        {
            m_type = value_t::array;
N
Niels 已提交
5076
            m_value = value_t::array;
5077
            assert_invariant();
N
cleanup  
Niels 已提交
5078 5079 5080
        }

        // add element to array (move semantics)
5081
        m_value.array->push_back(std::move(val));
N
cleanup  
Niels 已提交
5082
        // invalidate object
5083
        val.m_type = value_t::null;
N
cleanup  
Niels 已提交
5084 5085
    }

5086 5087 5088 5089
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5090
    reference operator+=(basic_json&& val)
N
Niels 已提交
5091
    {
5092
        push_back(std::move(val));
N
Niels 已提交
5093 5094 5095
        return *this;
    }

5096 5097 5098 5099
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5100
    void push_back(const basic_json& val)
N
cleanup  
Niels 已提交
5101 5102
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
5103
        if (not(is_null() or is_array()))
N
cleanup  
Niels 已提交
5104
        {
5105
            JSON_THROW(std::domain_error("cannot use push_back() with " + type_name()));
N
cleanup  
Niels 已提交
5106 5107 5108
        }

        // transform null object into an array
N
cleanup  
Niels 已提交
5109
        if (is_null())
N
cleanup  
Niels 已提交
5110 5111
        {
            m_type = value_t::array;
N
Niels 已提交
5112
            m_value = value_t::array;
5113
            assert_invariant();
N
cleanup  
Niels 已提交
5114 5115 5116
        }

        // add element to array
5117
        m_value.array->push_back(val);
N
cleanup  
Niels 已提交
5118 5119
    }

5120 5121 5122 5123
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5124
    reference operator+=(const basic_json& val)
N
cleanup  
Niels 已提交
5125
    {
5126
        push_back(val);
N
cleanup  
Niels 已提交
5127 5128 5129
        return *this;
    }

5130 5131 5132
    /*!
    @brief add an object to an object

5133
    Inserts the given element @a val to the JSON object. If the function is
N
Niels 已提交
5134 5135
    called on a JSON null value, an empty object is created before inserting
    @a val.
5136

5137
    @param[in] val the value to add to the JSON object
5138 5139

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

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

N
Niels 已提交
5144 5145 5146
    @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 已提交
5147

N
Niels 已提交
5148
    @since version 1.0.0
5149
    */
5150
    void push_back(const typename object_t::value_type& val)
N
cleanup  
Niels 已提交
5151 5152
    {
        // push_back only works for null objects or objects
N
cleanup  
Niels 已提交
5153
        if (not(is_null() or is_object()))
N
cleanup  
Niels 已提交
5154
        {
5155
            JSON_THROW(std::domain_error("cannot use push_back() with " + type_name()));
N
cleanup  
Niels 已提交
5156 5157 5158
        }

        // transform null object into an object
N
cleanup  
Niels 已提交
5159
        if (is_null())
N
cleanup  
Niels 已提交
5160 5161
        {
            m_type = value_t::object;
N
Niels 已提交
5162
            m_value = value_t::object;
5163
            assert_invariant();
N
cleanup  
Niels 已提交
5164 5165 5166
        }

        // add element to array
5167
        m_value.object->insert(val);
N
cleanup  
Niels 已提交
5168 5169
    }

5170 5171 5172 5173
    /*!
    @brief add an object to an object
    @copydoc push_back(const typename object_t::value_type&)
    */
5174
    reference operator+=(const typename object_t::value_type& val)
N
cleanup  
Niels 已提交
5175
    {
5176
        push_back(val);
N
Niels 已提交
5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225
        return *this;
    }

    /*!
    @brief add an object to an object

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

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

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

    @param init  an initializer list

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

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

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

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

N
Niels 已提交
5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254
    /*!
    @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()))
        {
5255
            JSON_THROW(std::domain_error("cannot use emplace_back() with " + type_name()));
N
Niels 已提交
5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270
        }

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

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

N
Niels Lohmann 已提交
5273 5274
    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
5275 5276
    function is called on a JSON null value, an empty object is created before
    appending the value created from @a args.
N
Niels 已提交
5277 5278 5279 5280

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

5281 5282 5283 5284
    @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 已提交
5285 5286 5287 5288 5289 5290 5291
    @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
5292 5293
    JSON object. Further note how no value is added if there was already one
    value stored with the same key.,emplace}
N
Niels 已提交
5294 5295 5296 5297

    @since version 2.0.8
    */
    template<class... Args>
5298
    std::pair<iterator, bool> emplace(Args&& ... args)
N
Niels 已提交
5299 5300 5301 5302
    {
        // emplace only works for null objects or arrays
        if (not(is_null() or is_object()))
        {
5303
            JSON_THROW(std::domain_error("cannot use emplace() with " + type_name()));
N
Niels 已提交
5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314
        }

        // 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)
5315 5316 5317 5318 5319 5320 5321
        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 已提交
5322 5323
    }

N
Niels 已提交
5324 5325 5326
    /*!
    @brief inserts element

5327
    Inserts element @a val before iterator @a pos.
N
Niels 已提交
5328 5329 5330

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

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

N
Niels Lohmann 已提交
5339 5340
    @complexity Constant plus linear in the distance between pos and end of
    the container.
N
Niels 已提交
5341

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

N
Niels 已提交
5344
    @since version 1.0.0
N
Niels 已提交
5345
    */
5346
    iterator insert(const_iterator pos, const basic_json& val)
N
Niels 已提交
5347 5348
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5349
        if (is_array())
N
Niels 已提交
5350
        {
N
cleanup  
Niels 已提交
5351 5352 5353
            // check if iterator pos fits to this JSON value
            if (pos.m_object != this)
            {
5354
                JSON_THROW(std::domain_error("iterator does not fit current value"));
N
cleanup  
Niels 已提交
5355
            }
N
Niels 已提交
5356

N
cleanup  
Niels 已提交
5357 5358
            // insert to array and return iterator
            iterator result(this);
5359
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, val);
N
cleanup  
Niels 已提交
5360 5361
            return result;
        }
N
Niels Lohmann 已提交
5362

5363
        JSON_THROW(std::domain_error("cannot use insert() with " + type_name()));
N
Niels 已提交
5364 5365 5366 5367 5368 5369
    }

    /*!
    @brief inserts element
    @copydoc insert(const_iterator, const basic_json&)
    */
5370
    iterator insert(const_iterator pos, basic_json&& val)
N
Niels 已提交
5371
    {
5372
        return insert(pos, val);
N
Niels 已提交
5373 5374 5375 5376 5377
    }

    /*!
    @brief inserts elements

5378
    Inserts @a cnt copies of @a val before iterator @a pos.
N
Niels 已提交
5379 5380 5381

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

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

5392
    @complexity Linear in @a cnt plus linear in the distance between @a pos
N
Niels 已提交
5393 5394
    and end of the container.

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

N
Niels 已提交
5397
    @since version 1.0.0
N
Niels 已提交
5398
    */
5399
    iterator insert(const_iterator pos, size_type cnt, const basic_json& val)
N
Niels 已提交
5400 5401
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5402
        if (is_array())
N
Niels 已提交
5403
        {
N
cleanup  
Niels 已提交
5404 5405 5406
            // check if iterator pos fits to this JSON value
            if (pos.m_object != this)
            {
5407
                JSON_THROW(std::domain_error("iterator does not fit current value"));
N
cleanup  
Niels 已提交
5408
            }
N
Niels 已提交
5409

N
cleanup  
Niels 已提交
5410 5411
            // insert to array and return iterator
            iterator result(this);
5412
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, cnt, val);
N
cleanup  
Niels 已提交
5413 5414
            return result;
        }
N
Niels Lohmann 已提交
5415

5416
        JSON_THROW(std::domain_error("cannot use insert() with " + type_name()));
N
Niels 已提交
5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428
    }

    /*!
    @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 已提交
5429 5430
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
N
Niels 已提交
5431 5432
    @throw std::domain_error if @a pos is not an iterator of *this; example:
    `"iterator does not fit current value"`
N
Niels 已提交
5433
    @throw std::domain_error if @a first and @a last do not belong to the same
N
Niels 已提交
5434
    JSON value; example: `"iterators do not fit"`
N
Niels 已提交
5435
    @throw std::domain_error if @a first or @a last are iterators into
N
Niels 已提交
5436 5437 5438
    container for which insert is called; example: `"passed iterators may not
    belong to container"`

N
Niels 已提交
5439 5440 5441 5442 5443 5444
    @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 已提交
5445
    @liveexample{The example shows how `insert()` is used.,insert__range}
N
Niels 已提交
5446

N
Niels 已提交
5447
    @since version 1.0.0
N
Niels 已提交
5448 5449 5450 5451
    */
    iterator insert(const_iterator pos, const_iterator first, const_iterator last)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5452
        if (not is_array())
N
Niels 已提交
5453
        {
5454
            JSON_THROW(std::domain_error("cannot use insert() with " + type_name()));
N
Niels 已提交
5455 5456 5457 5458 5459
        }

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

N
Niels 已提交
5463
        // check if range iterators belong to the same JSON object
N
Niels 已提交
5464 5465
        if (first.m_object != last.m_object)
        {
5466
            JSON_THROW(std::domain_error("iterators do not fit"));
N
Niels 已提交
5467 5468 5469 5470
        }

        if (first.m_object == this or last.m_object == this)
        {
5471
            JSON_THROW(std::domain_error("passed iterators may not belong to container"));
N
Niels 已提交
5472 5473 5474 5475
        }

        // insert to array and return iterator
        iterator result(this);
N
Niels 已提交
5476
        result.m_it.array_iterator = m_value.array->insert(
5477 5478 5479
            pos.m_it.array_iterator,
            first.m_it.array_iterator,
            last.m_it.array_iterator);
N
Niels 已提交
5480 5481 5482
        return result;
    }

N
Niels 已提交
5483 5484 5485 5486 5487 5488 5489 5490 5491
    /*!
    @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 已提交
5492 5493
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
N
Niels 已提交
5494 5495
    @throw std::domain_error if @a pos is not an iterator of *this; example:
    `"iterator does not fit current value"`
N
Niels 已提交
5496

N
Niels 已提交
5497 5498 5499
    @return iterator pointing to the first element inserted, or @a pos if
    `ilist` is empty

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

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

N
Niels 已提交
5505
    @since version 1.0.0
N
Niels 已提交
5506 5507 5508 5509
    */
    iterator insert(const_iterator pos, std::initializer_list<basic_json> ilist)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5510
        if (not is_array())
N
Niels 已提交
5511
        {
5512
            JSON_THROW(std::domain_error("cannot use insert() with " + type_name()));
N
Niels 已提交
5513 5514 5515 5516 5517
        }

        // check if iterator pos fits to this JSON value
        if (pos.m_object != this)
        {
5518
            JSON_THROW(std::domain_error("iterator does not fit current value"));
N
Niels 已提交
5519 5520 5521 5522 5523 5524 5525 5526
        }

        // 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 已提交
5527 5528
    /*!
    @brief exchanges the values
N
Niels 已提交
5529 5530 5531 5532 5533 5534 5535 5536 5537 5538

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

N
Niels 已提交
5542
    @since version 1.0.0
N
Niels 已提交
5543
    */
5544
    void swap(reference other) noexcept (
N
Niels 已提交
5545 5546 5547 5548
        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
5549
                                       )
N
cleanup  
Niels 已提交
5550 5551 5552
    {
        std::swap(m_type, other.m_type);
        std::swap(m_value, other.m_value);
5553
        assert_invariant();
N
cleanup  
Niels 已提交
5554 5555
    }

N
Niels 已提交
5556 5557 5558 5559 5560 5561 5562 5563 5564 5565
    /*!
    @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 已提交
5566 5567
    @throw std::domain_error when JSON value is not an array; example:
    `"cannot use swap() with string"`
N
Niels 已提交
5568 5569 5570

    @complexity Constant.

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

N
Niels 已提交
5574
    @since version 1.0.0
N
Niels 已提交
5575
    */
5576
    void swap(array_t& other)
N
cleanup  
Niels 已提交
5577 5578
    {
        // swap only works for arrays
N
cleanup  
Niels 已提交
5579 5580 5581 5582 5583
        if (is_array())
        {
            std::swap(*(m_value.array), other);
        }
        else
N
cleanup  
Niels 已提交
5584
        {
5585
            JSON_THROW(std::domain_error("cannot use swap() with " + type_name()));
N
cleanup  
Niels 已提交
5586 5587 5588
        }
    }

5589 5590 5591 5592 5593 5594 5595 5596 5597 5598
    /*!
    @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 已提交
5599 5600
    @throw std::domain_error when JSON value is not an object; example:
    `"cannot use swap() with string"`
5601 5602 5603

    @complexity Constant.

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

N
Niels 已提交
5607
    @since version 1.0.0
5608
    */
5609
    void swap(object_t& other)
N
cleanup  
Niels 已提交
5610 5611
    {
        // swap only works for objects
N
cleanup  
Niels 已提交
5612 5613 5614 5615 5616
        if (is_object())
        {
            std::swap(*(m_value.object), other);
        }
        else
N
cleanup  
Niels 已提交
5617
        {
5618
            JSON_THROW(std::domain_error("cannot use swap() with " + type_name()));
N
cleanup  
Niels 已提交
5619 5620 5621
        }
    }

5622 5623 5624 5625 5626 5627 5628 5629 5630 5631
    /*!
    @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 已提交
5632 5633
    @throw std::domain_error when JSON value is not a string; example: `"cannot
    use swap() with boolean"`
5634 5635 5636

    @complexity Constant.

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

N
Niels 已提交
5640
    @since version 1.0.0
5641
    */
5642
    void swap(string_t& other)
N
cleanup  
Niels 已提交
5643 5644
    {
        // swap only works for strings
N
cleanup  
Niels 已提交
5645 5646 5647 5648 5649
        if (is_string())
        {
            std::swap(*(m_value.string), other);
        }
        else
N
cleanup  
Niels 已提交
5650
        {
5651
            JSON_THROW(std::domain_error("cannot use swap() with " + type_name()));
N
cleanup  
Niels 已提交
5652 5653 5654
        }
    }

N
Niels 已提交
5655 5656
    /// @}

N
Niels 已提交
5657
  public:
N
Niels 已提交
5658 5659
    /*!
    @brief comparison: equal
N
Niels 已提交
5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675

    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.

5676 5677
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__equal}
N
Niels 已提交
5678

N
Niels 已提交
5679
    @since version 1.0.0
N
Niels 已提交
5680
    */
N
Niels 已提交
5681
    friend bool operator==(const_reference lhs, const_reference rhs) noexcept
N
cleanup  
Niels 已提交
5682
    {
F
Florian Weber 已提交
5683 5684
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
5685

F
Florian Weber 已提交
5686
        if (lhs_type == rhs_type)
N
cleanup  
Niels 已提交
5687
        {
F
Florian Weber 已提交
5688
            switch (lhs_type)
N
cleanup  
Niels 已提交
5689
            {
5690
                case value_t::array:
N
Niels 已提交
5691
                {
N
cleanup  
Niels 已提交
5692
                    return *lhs.m_value.array == *rhs.m_value.array;
N
Niels 已提交
5693
                }
5694
                case value_t::object:
N
Niels 已提交
5695
                {
N
cleanup  
Niels 已提交
5696
                    return *lhs.m_value.object == *rhs.m_value.object;
N
Niels 已提交
5697
                }
5698
                case value_t::null:
N
Niels 已提交
5699
                {
N
cleanup  
Niels 已提交
5700
                    return true;
N
Niels 已提交
5701
                }
5702
                case value_t::string:
N
Niels 已提交
5703
                {
N
cleanup  
Niels 已提交
5704
                    return *lhs.m_value.string == *rhs.m_value.string;
N
Niels 已提交
5705
                }
5706
                case value_t::boolean:
N
Niels 已提交
5707
                {
N
cleanup  
Niels 已提交
5708
                    return lhs.m_value.boolean == rhs.m_value.boolean;
N
Niels 已提交
5709
                }
5710
                case value_t::number_integer:
N
Niels 已提交
5711
                {
N
cleanup  
Niels 已提交
5712
                    return lhs.m_value.number_integer == rhs.m_value.number_integer;
N
Niels 已提交
5713
                }
5714 5715 5716 5717
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned == rhs.m_value.number_unsigned;
                }
5718
                case value_t::number_float:
N
Niels 已提交
5719
                {
5720
                    return lhs.m_value.number_float == rhs.m_value.number_float;
N
Niels 已提交
5721
                }
5722
                default:
N
Niels 已提交
5723
                {
N
Niels 已提交
5724
                    return false;
N
Niels 已提交
5725
                }
N
cleanup  
Niels 已提交
5726 5727
            }
        }
F
Florian Weber 已提交
5728 5729
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
N
Niels 已提交
5730
            return static_cast<number_float_t>(lhs.m_value.number_integer) == rhs.m_value.number_float;
F
Florian Weber 已提交
5731 5732 5733
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
5734
            return lhs.m_value.number_float == static_cast<number_float_t>(rhs.m_value.number_integer);
F
Florian Weber 已提交
5735
        }
5736 5737 5738
        else if (lhs_type == value_t::number_unsigned and rhs_type == value_t::number_float)
        {
            return static_cast<number_float_t>(lhs.m_value.number_unsigned) == rhs.m_value.number_float;
F
Florian Weber 已提交
5739
        }
5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_unsigned)
        {
            return lhs.m_value.number_float == static_cast<number_float_t>(rhs.m_value.number_unsigned);
        }
        else if (lhs_type == value_t::number_unsigned and rhs_type == value_t::number_integer)
        {
            return static_cast<number_integer_t>(lhs.m_value.number_unsigned) == rhs.m_value.number_integer;
        }
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_unsigned)
        {
            return lhs.m_value.number_integer == static_cast<number_integer_t>(rhs.m_value.number_unsigned);
        }

N
cleanup  
Niels 已提交
5753 5754 5755
        return false;
    }

N
Niels 已提交
5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770
    /*!
    @brief comparison: equal

    The functions compares the given JSON value against a null pointer. As the
    null pointer can be used to initialize a JSON value to null, a comparison
    of JSON value @a v with a null pointer should be equivalent to call
    `v.is_null()`.

    @param[in] v  JSON value to consider
    @return whether @a v is null

    @complexity Constant.

    @liveexample{The example compares several JSON types to the null pointer.
    ,operator__equal__nullptr_t}
N
Niels 已提交
5771

N
Niels 已提交
5772
    @since version 1.0.0
N
Niels 已提交
5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787
    */
    friend bool operator==(const_reference v, std::nullptr_t) noexcept
    {
        return v.is_null();
    }

    /*!
    @brief comparison: equal
    @copydoc operator==(const_reference, std::nullptr_t)
    */
    friend bool operator==(std::nullptr_t, const_reference v) noexcept
    {
        return v.is_null();
    }

N
Niels 已提交
5788 5789
    /*!
    @brief comparison: not equal
N
Niels 已提交
5790 5791 5792 5793 5794 5795 5796 5797 5798

    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.

5799 5800
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__notequal}
N
Niels 已提交
5801

N
Niels 已提交
5802
    @since version 1.0.0
N
Niels 已提交
5803
    */
N
Niels 已提交
5804
    friend bool operator!=(const_reference lhs, const_reference rhs) noexcept
N
cleanup  
Niels 已提交
5805 5806 5807 5808
    {
        return not (lhs == rhs);
    }

N
Niels 已提交
5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823
    /*!
    @brief comparison: not equal

    The functions compares the given JSON value against a null pointer. As the
    null pointer can be used to initialize a JSON value to null, a comparison
    of JSON value @a v with a null pointer should be equivalent to call
    `not v.is_null()`.

    @param[in] v  JSON value to consider
    @return whether @a v is not null

    @complexity Constant.

    @liveexample{The example compares several JSON types to the null pointer.
    ,operator__notequal__nullptr_t}
N
Niels 已提交
5824

N
Niels 已提交
5825
    @since version 1.0.0
N
Niels 已提交
5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840
    */
    friend bool operator!=(const_reference v, std::nullptr_t) noexcept
    {
        return not v.is_null();
    }

    /*!
    @brief comparison: not equal
    @copydoc operator!=(const_reference, std::nullptr_t)
    */
    friend bool operator!=(std::nullptr_t, const_reference v) noexcept
    {
        return not v.is_null();
    }

N
Niels 已提交
5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859
    /*!
    @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.

5860 5861
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__less}
N
Niels 已提交
5862

N
Niels 已提交
5863
    @since version 1.0.0
N
Niels 已提交
5864
    */
N
Niels 已提交
5865
    friend bool operator<(const_reference lhs, const_reference rhs) noexcept
N
cleanup  
Niels 已提交
5866
    {
F
Florian Weber 已提交
5867 5868
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
5869

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

N
Niels 已提交
5937
        // We only reach this line if we cannot compare values. In that case,
N
Niels 已提交
5938 5939 5940
        // we compare types. Note we have to call the operator explicitly,
        // because MSVC has problems otherwise.
        return operator<(lhs_type, rhs_type);
N
cleanup  
Niels 已提交
5941 5942
    }

N
Niels 已提交
5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954
    /*!
    @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.

5955 5956
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greater}
N
Niels 已提交
5957

N
Niels 已提交
5958
    @since version 1.0.0
N
Niels 已提交
5959
    */
N
Niels 已提交
5960
    friend bool operator<=(const_reference lhs, const_reference rhs) noexcept
N
cleanup  
Niels 已提交
5961 5962 5963 5964
    {
        return not (rhs < lhs);
    }

N
Niels 已提交
5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976
    /*!
    @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.

5977 5978
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__lessequal}
N
Niels 已提交
5979

N
Niels 已提交
5980
    @since version 1.0.0
N
Niels 已提交
5981
    */
N
Niels 已提交
5982
    friend bool operator>(const_reference lhs, const_reference rhs) noexcept
N
cleanup  
Niels 已提交
5983 5984 5985 5986
    {
        return not (lhs <= rhs);
    }

N
Niels 已提交
5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998
    /*!
    @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.

5999 6000
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greaterequal}
N
Niels 已提交
6001

N
Niels 已提交
6002
    @since version 1.0.0
N
Niels 已提交
6003
    */
N
Niels 已提交
6004
    friend bool operator>=(const_reference lhs, const_reference rhs) noexcept
N
cleanup  
Niels 已提交
6005 6006 6007 6008
    {
        return not (lhs < rhs);
    }

N
Niels 已提交
6009 6010
    /// @}

N
cleanup  
Niels 已提交
6011 6012 6013 6014 6015

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

N
Niels 已提交
6016 6017 6018
    /// @name serialization
    /// @{

N
Niels 已提交
6019 6020 6021 6022 6023 6024 6025 6026 6027 6028
    /*!
    @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)`.

6029 6030 6031 6032
    @note During serializaion, the locale and the precision of the output
    stream @a o are changed. The original values are restored when the
    function returns.

N
Niels 已提交
6033 6034 6035 6036 6037 6038 6039
    @param[in,out] o  stream to serialize to
    @param[in] j  JSON value to serialize

    @return the stream @a o

    @complexity Linear.

N
Niels 已提交
6040 6041
    @liveexample{The example below shows the serialization with different
    parameters to `width` to adjust the indentation level.,operator_serialize}
N
Niels 已提交
6042

N
Niels 已提交
6043
    @since version 1.0.0
N
Niels 已提交
6044
    */
N
cleanup  
Niels 已提交
6045 6046
    friend std::ostream& operator<<(std::ostream& o, const basic_json& j)
    {
N
Niels 已提交
6047
        // read width member and use it as indentation parameter if nonzero
N
Niels 已提交
6048 6049
        const bool pretty_print = (o.width() > 0);
        const auto indentation = (pretty_print ? o.width() : 0);
N
Niels 已提交
6050

N
Niels 已提交
6051 6052
        // reset width to 0 for subsequent calls to this stream
        o.width(0);
6053

N
Niels 已提交
6054
        // fix locale problems
N
Niels 已提交
6055
        const auto old_locale = o.imbue(std::locale::classic());
6056 6057 6058 6059 6060 6061
        // set precision

        // 6, 15 or 16 digits of precision allows round-trip IEEE 754
        // string->float->string, string->double->string or string->long
        // double->string; to be safe, we read this value from
        // std::numeric_limits<number_float_t>::digits10
N
Niels 已提交
6062
        const auto old_precision = o.precision(std::numeric_limits<double>::digits10);
N
Niels 已提交
6063 6064

        // do the actual serialization
N
Niels 已提交
6065
        j.dump(o, pretty_print, static_cast<unsigned int>(indentation));
N
Niels 已提交
6066

6067
        // reset locale and precision
N
Niels 已提交
6068
        o.imbue(old_locale);
N
Niels 已提交
6069
        o.precision(old_precision);
N
cleanup  
Niels 已提交
6070 6071 6072
        return o;
    }

N
Niels 已提交
6073 6074 6075 6076
    /*!
    @brief serialize to stream
    @copydoc operator<<(std::ostream&, const basic_json&)
    */
N
cleanup  
Niels 已提交
6077 6078
    friend std::ostream& operator>>(const basic_json& j, std::ostream& o)
    {
A
Alexandre Hamez 已提交
6079
        return o << j;
N
cleanup  
Niels 已提交
6080 6081
    }

N
Niels 已提交
6082 6083
    /// @}

N
cleanup  
Niels 已提交
6084

N
Niels 已提交
6085 6086 6087 6088
    /////////////////////
    // deserialization //
    /////////////////////

N
Niels 已提交
6089 6090 6091
    /// @name deserialization
    /// @{

N
Niels 已提交
6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126
    /*!
    @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);
    }

N
Niels 已提交
6127
    /*!
N
Niels 已提交
6128
    @brief deserialize from string literal
N
Niels 已提交
6129

N
Niels 已提交
6130
    @tparam CharT character/literal type with size of 1 byte
N
Niels 已提交
6131
    @param[in] s  string literal to read a serialized JSON value from
N
Niels 已提交
6132 6133 6134
    @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 已提交
6135 6136 6137 6138 6139 6140 6141

    @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 已提交
6142
    @note A UTF-8 byte order mark is silently ignored.
N
Niels 已提交
6143 6144
    @note String containers like `std::string` or @ref string_t can be parsed
          with @ref parse(const ContiguousContainer&, const parser_callback_t)
N
Niels 已提交
6145

N
Niels 已提交
6146 6147
    @liveexample{The example below demonstrates the `parse()` function with
    and without callback function.,parse__string__parser_callback_t}
N
Niels 已提交
6148

N
Niels 已提交
6149 6150
    @sa @ref parse(std::istream&, const parser_callback_t) for a version that
    reads from an input stream
N
Niels 已提交
6151

N
Niels 已提交
6152
    @since version 1.0.0 (originally for @ref string_t)
N
Niels 已提交
6153
    */
6154 6155 6156 6157 6158
    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 已提交
6159
                            const parser_callback_t cb = nullptr)
N
Niels 已提交
6160
    {
N
Niels 已提交
6161
        return parser(reinterpret_cast<const char*>(s), cb).parse();
6162 6163
    }

N
Niels 已提交
6164 6165 6166 6167
    /*!
    @brief deserialize from stream

    @param[in,out] i  stream to read a serialized JSON value from
N
Niels 已提交
6168 6169 6170
    @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 已提交
6171 6172 6173 6174 6175 6176 6177

    @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 已提交
6178 6179
    @note A UTF-8 byte order mark is silently ignored.

N
Niels 已提交
6180 6181
    @liveexample{The example below demonstrates the `parse()` function with
    and without callback function.,parse__istream__parser_callback_t}
N
Niels 已提交
6182

6183
    @sa @ref parse(const CharT, const parser_callback_t) for a version
N
Niels 已提交
6184
    that reads from a string
N
Niels 已提交
6185

N
Niels 已提交
6186
    @since version 1.0.0
N
Niels 已提交
6187
    */
N
Niels 已提交
6188 6189
    static basic_json parse(std::istream& i,
                            const parser_callback_t cb = nullptr)
A
Aaron Burghardt 已提交
6190
    {
N
Niels 已提交
6191
        return parser(i, cb).parse();
N
Niels 已提交
6192 6193
    }

N
Niels 已提交
6194
    /*!
N
Niels 已提交
6195
    @copydoc parse(std::istream&, const parser_callback_t)
N
Niels 已提交
6196
    */
N
Niels 已提交
6197 6198
    static basic_json parse(std::istream&& i,
                            const parser_callback_t cb = nullptr)
6199 6200 6201 6202
    {
        return parser(i, cb).parse();
    }

6203
    /*!
N
Niels 已提交
6204
    @brief deserialize from an iterator range with contiguous storage
6205

6206 6207
    This function reads from an iterator range of a container with contiguous
    storage of 1-byte values. Compatible container types include
6208 6209 6210 6211 6212 6213 6214 6215 6216
    `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
6217
    with a static assertion.**
6218

N
Niels 已提交
6219 6220 6221 6222
    @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.
6223

N
Niels 已提交
6224
    @tparam IteratorType iterator of container with contiguous storage
N
Niels 已提交
6225 6226 6227
    @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
6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238
    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 已提交
6239 6240
    @liveexample{The example below demonstrates the `parse()` function reading
    from an iterator range.,parse__iteratortype__parser_callback_t}
6241 6242 6243

    @since version 2.0.3
    */
N
Niels 已提交
6244 6245 6246 6247
    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>
6248 6249 6250 6251 6252
    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 已提交
6253
        assert(std::accumulate(first, last, std::pair<bool, int>(true, 0),
6254 6255 6256 6257 6258 6259 6260
                               [&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
6261 6262
        static_assert(sizeof(typename std::iterator_traits<IteratorType>::value_type) == 1,
                      "each element in the iterator range must have the size of 1 byte");
6263

6264 6265 6266 6267 6268 6269
        // 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();
        }
6270 6271 6272 6273

        return parser(first, last, cb).parse();
    }

N
Niels 已提交
6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294
    /*!
    @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 已提交
6295
    @tparam ContiguousContainer container type with contiguous storage
N
Niels 已提交
6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313
    @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 已提交
6314
    template<class ContiguousContainer, typename std::enable_if<
N
Niels 已提交
6315
                 not std::is_pointer<ContiguousContainer>::value and
6316 6317
                 std::is_base_of<
                     std::random_access_iterator_tag,
N
Niels 已提交
6318
                     typename std::iterator_traits<decltype(std::begin(std::declval<ContiguousContainer const>()))>::iterator_category>::value
6319 6320 6321 6322 6323 6324 6325 6326
                 , 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 已提交
6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339
    /*!
    @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 已提交
6340 6341
    @note A UTF-8 byte order mark is silently ignored.

N
Niels 已提交
6342 6343 6344
    @liveexample{The example below shows how a JSON value is constructed by
    reading a serialization from a stream.,operator_deserialize}

N
Niels 已提交
6345 6346
    @sa parse(std::istream&, const parser_callback_t) for a variant with a
    parser callback function to filter values while parsing
N
Niels 已提交
6347

N
Niels 已提交
6348
    @since version 1.0.0
N
Niels 已提交
6349 6350
    */
    friend std::istream& operator<<(basic_json& j, std::istream& i)
N
Niels 已提交
6351 6352 6353 6354 6355
    {
        j = parser(i).parse();
        return i;
    }

N
Niels 已提交
6356 6357 6358 6359 6360
    /*!
    @brief deserialize from stream
    @copydoc operator<<(basic_json&, std::istream&)
    */
    friend std::istream& operator>>(std::istream& i, basic_json& j)
N
Niels 已提交
6361 6362 6363 6364 6365
    {
        j = parser(i).parse();
        return i;
    }

N
Niels 已提交
6366 6367
    /// @}

N
Niels Lohmann 已提交
6368 6369 6370
    //////////////////////////////////////////
    // binary serialization/deserialization //
    //////////////////////////////////////////
N
Niels 已提交
6371

N
Niels Lohmann 已提交
6372
    /// @name binary serialization/deserialization support
N
Niels 已提交
6373 6374 6375
    /// @{

  private:
6376 6377 6378 6379 6380 6381 6382 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
    template<typename T>
    static void add_to_vector(std::vector<uint8_t>& vec, size_t bytes, const T number)
    {
        assert(bytes == 1 or bytes == 2 or bytes == 4 or bytes == 8);

        switch (bytes)
        {
            case 8:
            {
                vec.push_back(static_cast<uint8_t>((number >> 070) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 060) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 050) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 040) & 0xff));
                // intentional fall-through
            }

            case 4:
            {
                vec.push_back(static_cast<uint8_t>((number >> 030) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 020) & 0xff));
                // intentional fall-through
            }

            case 2:
            {
                vec.push_back(static_cast<uint8_t>((number >> 010) & 0xff));
                // intentional fall-through
            }

            case 1:
            {
                vec.push_back(static_cast<uint8_t>(number & 0xff));
                break;
            }
        }
    }

6413 6414 6415 6416 6417 6418 6419 6420
    /*!
    @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
6421
    @param[in] current_index  the position in the vector after which to read
6422 6423 6424 6425 6426 6427 6428 6429

    @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

6430 6431 6432 6433
    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.

6434 6435
    Precondition:

6436 6437 6438
    vec:   |   |   | a | b | c | d |      T: |   |   |   |   |
                 ^               ^             ^                ^
           current_index         i            ptr        sizeof(T)
6439 6440 6441

    Postcondition:

6442 6443 6444
    vec:   |   |   | a | b | c | d |      T: | d | c | b | a |
                 ^   ^                                     ^
                 |   i                                    ptr
6445 6446
           current_index

6447
    @sa Code adapted from <http://stackoverflow.com/a/41031865/266378>.
6448 6449 6450
    */
    template<typename T>
    static T get_from_vector(const std::vector<uint8_t>& vec, const size_t current_index)
6451
    {
6452 6453
        if (current_index + sizeof(T) + 1 > vec.size())
        {
6454
            JSON_THROW(std::out_of_range("cannot read " + std::to_string(sizeof(T)) + " bytes from vector"));
6455 6456
        }

6457
        T result;
N
Niels Lohmann 已提交
6458
        auto* ptr = reinterpret_cast<uint8_t*>(&result);
6459
        for (size_t i = 0; i < sizeof(T); ++i)
6460
        {
6461
            *ptr++ = vec[current_index + sizeof(T) - i];
6462 6463
        }
        return result;
6464 6465
    }

6466 6467 6468 6469 6470 6471 6472 6473 6474 6475
    /*!
    @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 已提交
6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495
    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:
            {
6496
                if (j.m_value.number_integer >= 0)
N
Niels 已提交
6497
                {
6498
                    // MessagePack does not differentiate between positive
N
Niels Lohmann 已提交
6499 6500 6501
                    // signed integers and unsigned integers. Therefore, we
                    // used the code from the value_t::number_unsigned case
                    // here.
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
                    if (j.m_value.number_unsigned < 128)
                    {
                        // positive fixnum
                        add_to_vector(v, 1, j.m_value.number_unsigned);
                    }
                    else if (j.m_value.number_unsigned <= UINT8_MAX)
                    {
                        // uint 8
                        v.push_back(0xcc);
                        add_to_vector(v, 1, j.m_value.number_unsigned);
                    }
                    else if (j.m_value.number_unsigned <= UINT16_MAX)
                    {
                        // uint 16
                        v.push_back(0xcd);
                        add_to_vector(v, 2, j.m_value.number_unsigned);
                    }
                    else if (j.m_value.number_unsigned <= UINT32_MAX)
                    {
                        // uint 32
                        v.push_back(0xce);
                        add_to_vector(v, 4, j.m_value.number_unsigned);
                    }
                    else if (j.m_value.number_unsigned <= UINT64_MAX)
                    {
                        // uint 64
                        v.push_back(0xcf);
                        add_to_vector(v, 8, j.m_value.number_unsigned);
                    }
N
Niels 已提交
6531
                }
6532
                else
N
Niels 已提交
6533
                {
6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562
                    if (j.m_value.number_integer >= -32)
                    {
                        // negative fixnum
                        add_to_vector(v, 1, j.m_value.number_integer);
                    }
                    else if (j.m_value.number_integer >= INT8_MIN and j.m_value.number_integer <= INT8_MAX)
                    {
                        // int 8
                        v.push_back(0xd0);
                        add_to_vector(v, 1, j.m_value.number_integer);
                    }
                    else if (j.m_value.number_integer >= INT16_MIN and j.m_value.number_integer <= INT16_MAX)
                    {
                        // int 16
                        v.push_back(0xd1);
                        add_to_vector(v, 2, j.m_value.number_integer);
                    }
                    else if (j.m_value.number_integer >= INT32_MIN and j.m_value.number_integer <= INT32_MAX)
                    {
                        // int 32
                        v.push_back(0xd2);
                        add_to_vector(v, 4, j.m_value.number_integer);
                    }
                    else if (j.m_value.number_integer >= INT64_MIN and j.m_value.number_integer <= INT64_MAX)
                    {
                        // int 64
                        v.push_back(0xd3);
                        add_to_vector(v, 8, j.m_value.number_integer);
                    }
N
Niels 已提交
6563 6564 6565 6566 6567 6568 6569 6570 6571
                }
                break;
            }

            case value_t::number_unsigned:
            {
                if (j.m_value.number_unsigned < 128)
                {
                    // positive fixnum
6572
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels 已提交
6573 6574 6575 6576 6577
                }
                else if (j.m_value.number_unsigned <= UINT8_MAX)
                {
                    // uint 8
                    v.push_back(0xcc);
6578
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels 已提交
6579 6580 6581 6582 6583
                }
                else if (j.m_value.number_unsigned <= UINT16_MAX)
                {
                    // uint 16
                    v.push_back(0xcd);
6584
                    add_to_vector(v, 2, j.m_value.number_unsigned);
N
Niels 已提交
6585 6586 6587 6588 6589
                }
                else if (j.m_value.number_unsigned <= UINT32_MAX)
                {
                    // uint 32
                    v.push_back(0xce);
6590
                    add_to_vector(v, 4, j.m_value.number_unsigned);
N
Niels 已提交
6591 6592 6593 6594 6595
                }
                else if (j.m_value.number_unsigned <= UINT64_MAX)
                {
                    // uint 64
                    v.push_back(0xcf);
6596
                    add_to_vector(v, 8, j.m_value.number_unsigned);
N
Niels 已提交
6597 6598 6599 6600 6601 6602 6603 6604
                }
                break;
            }

            case value_t::number_float:
            {
                // float 64
                v.push_back(0xcb);
N
Niels Lohmann 已提交
6605
                const auto* helper = reinterpret_cast<const uint8_t*>(&(j.m_value.number_float));
N
Niels 已提交
6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624
                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);
6625
                    add_to_vector(v, 1, N);
N
Niels 已提交
6626 6627 6628 6629 6630
                }
                else if (N <= 65535)
                {
                    // str 16
                    v.push_back(0xda);
6631
                    add_to_vector(v, 2, N);
N
Niels 已提交
6632 6633 6634 6635 6636
                }
                else if (N <= 4294967295)
                {
                    // str 32
                    v.push_back(0xdb);
6637
                    add_to_vector(v, 4, N);
N
Niels 已提交
6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657
                }

                // 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);
6658
                    add_to_vector(v, 2, N);
N
Niels 已提交
6659 6660 6661 6662 6663
                }
                else if (N <= 0xffffffff)
                {
                    // array 32
                    v.push_back(0xdd);
6664
                    add_to_vector(v, 4, N);
N
Niels 已提交
6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686
                }

                // 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);
6687
                    add_to_vector(v, 2, N);
N
Niels 已提交
6688 6689 6690 6691 6692
                }
                else if (N <= 4294967295)
                {
                    // map 32
                    v.push_back(0xdf);
6693
                    add_to_vector(v, 4, N);
N
Niels 已提交
6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711
                }

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

6712 6713 6714 6715 6716 6717 6718 6719 6720 6721
    /*!
    @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 已提交
6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744
    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.
6745
                    if (j.m_value.number_integer <= 0x17)
N
Niels Lohmann 已提交
6746
                    {
6747
                        add_to_vector(v, 1, j.m_value.number_integer);
N
Niels Lohmann 已提交
6748 6749 6750 6751 6752
                    }
                    else if (j.m_value.number_integer <= UINT8_MAX)
                    {
                        v.push_back(0x18);
                        // one-byte uint8_t
6753
                        add_to_vector(v, 1, j.m_value.number_integer);
N
Niels Lohmann 已提交
6754 6755 6756 6757 6758
                    }
                    else if (j.m_value.number_integer <= UINT16_MAX)
                    {
                        v.push_back(0x19);
                        // two-byte uint16_t
6759
                        add_to_vector(v, 2, j.m_value.number_integer);
N
Niels Lohmann 已提交
6760 6761 6762 6763 6764
                    }
                    else if (j.m_value.number_integer <= UINT32_MAX)
                    {
                        v.push_back(0x1a);
                        // four-byte uint32_t
6765
                        add_to_vector(v, 4, j.m_value.number_integer);
N
Niels Lohmann 已提交
6766
                    }
6767
                    else
N
Niels Lohmann 已提交
6768
                    {
N
Niels Lohmann 已提交
6769
                        v.push_back(0x1b);
N
Niels Lohmann 已提交
6770
                        // eight-byte uint64_t
6771
                        add_to_vector(v, 8, j.m_value.number_integer);
N
Niels Lohmann 已提交
6772 6773 6774 6775
                    }
                }
                else
                {
N
Niels Lohmann 已提交
6776 6777
                    // The conversions below encode the sign in the first
                    // byte, and the value is converted to a positive number.
N
Niels Lohmann 已提交
6778
                    const auto positive_number = -1 - j.m_value.number_integer;
6779
                    if (j.m_value.number_integer >= -24)
N
Niels Lohmann 已提交
6780 6781 6782 6783 6784 6785 6786
                    {
                        v.push_back(static_cast<uint8_t>(0x20 + positive_number));
                    }
                    else if (positive_number <= UINT8_MAX)
                    {
                        // int 8
                        v.push_back(0x38);
6787
                        add_to_vector(v, 1, positive_number);
N
Niels Lohmann 已提交
6788 6789 6790 6791 6792
                    }
                    else if (positive_number <= UINT16_MAX)
                    {
                        // int 16
                        v.push_back(0x39);
6793
                        add_to_vector(v, 2, positive_number);
N
Niels Lohmann 已提交
6794 6795 6796 6797 6798
                    }
                    else if (positive_number <= UINT32_MAX)
                    {
                        // int 32
                        v.push_back(0x3a);
6799
                        add_to_vector(v, 4, positive_number);
N
Niels Lohmann 已提交
6800
                    }
6801
                    else
N
Niels Lohmann 已提交
6802 6803 6804
                    {
                        // int 64
                        v.push_back(0x3b);
6805
                        add_to_vector(v, 8, positive_number);
N
Niels Lohmann 已提交
6806 6807
                    }
                }
6808
                break;
N
Niels Lohmann 已提交
6809 6810 6811 6812
            }

            case value_t::number_unsigned:
            {
6813
                if (j.m_value.number_unsigned <= 0x17)
N
Niels Lohmann 已提交
6814 6815 6816 6817 6818 6819 6820
                {
                    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
6821
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
6822 6823 6824 6825 6826
                }
                else if (j.m_value.number_unsigned <= 0xffff)
                {
                    v.push_back(0x19);
                    // two-byte uint16_t
6827
                    add_to_vector(v, 2, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
6828 6829 6830 6831 6832
                }
                else if (j.m_value.number_unsigned <= 0xffffffff)
                {
                    v.push_back(0x1a);
                    // four-byte uint32_t
6833
                    add_to_vector(v, 4, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
6834 6835 6836
                }
                else if (j.m_value.number_unsigned <= 0xffffffffffffffff)
                {
N
Niels Lohmann 已提交
6837
                    v.push_back(0x1b);
N
Niels Lohmann 已提交
6838
                    // eight-byte uint64_t
6839
                    add_to_vector(v, 8, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
6840 6841 6842 6843 6844 6845 6846 6847
                }
                break;
            }

            case value_t::number_float:
            {
                // Double-Precision Float
                v.push_back(0xfb);
N
Niels Lohmann 已提交
6848
                const auto* helper = reinterpret_cast<const uint8_t*>(&(j.m_value.number_float));
N
Niels Lohmann 已提交
6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860
                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)
                {
6861
                    v.push_back(0x60 + N);  // 1 byte for string + size
N
Niels Lohmann 已提交
6862 6863 6864
                }
                else if (N <= 0xff)
                {
6865
                    v.push_back(0x78);  // one-byte uint8_t for N
6866
                    add_to_vector(v, 1, N);
N
Niels Lohmann 已提交
6867 6868 6869
                }
                else if (N <= 0xffff)
                {
6870
                    v.push_back(0x79);  // two-byte uint16_t for N
6871
                    add_to_vector(v, 2, N);
N
Niels Lohmann 已提交
6872 6873 6874
                }
                else if (N <= 0xffffffff)
                {
6875
                    v.push_back(0x7a); // four-byte uint32_t for N
6876
                    add_to_vector(v, 4, N);
N
Niels Lohmann 已提交
6877
                }
6878
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
6879 6880
                else if (N <= 0xffffffffffffffff)
                {
6881
                    v.push_back(0x7b);  // eight-byte uint64_t for N
6882
                    add_to_vector(v, 8, N);
N
Niels Lohmann 已提交
6883
                }
6884
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896

                // 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)
                {
6897
                    v.push_back(0x80 + N);  // 1 byte for array + size
N
Niels Lohmann 已提交
6898 6899 6900
                }
                else if (N <= 0xff)
                {
6901
                    v.push_back(0x98);  // one-byte uint8_t for N
6902
                    add_to_vector(v, 1, N);
N
Niels Lohmann 已提交
6903 6904 6905
                }
                else if (N <= 0xffff)
                {
6906
                    v.push_back(0x99);  // two-byte uint16_t for N
6907
                    add_to_vector(v, 2, N);
N
Niels Lohmann 已提交
6908 6909 6910
                }
                else if (N <= 0xffffffff)
                {
6911
                    v.push_back(0x9a);  // four-byte uint32_t for N
6912
                    add_to_vector(v, 4, N);
N
Niels Lohmann 已提交
6913
                }
6914
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
6915 6916
                else if (N <= 0xffffffffffffffff)
                {
6917
                    v.push_back(0x9b);  // eight-byte uint64_t for N
6918
                    add_to_vector(v, 8, N);
N
Niels Lohmann 已提交
6919
                }
6920
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934

                // 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)
                {
6935
                    v.push_back(0xa0 + N);  // 1 byte for object + size
N
Niels Lohmann 已提交
6936 6937 6938 6939
                }
                else if (N <= 0xff)
                {
                    v.push_back(0xb8);
6940
                    add_to_vector(v, 1, N);  // one-byte uint8_t for N
N
Niels Lohmann 已提交
6941 6942 6943 6944
                }
                else if (N <= 0xffff)
                {
                    v.push_back(0xb9);
6945
                    add_to_vector(v, 2, N);  // two-byte uint16_t for N
N
Niels Lohmann 已提交
6946 6947 6948 6949
                }
                else if (N <= 0xffffffff)
                {
                    v.push_back(0xba);
6950
                    add_to_vector(v, 4, N);  // four-byte uint32_t for N
N
Niels Lohmann 已提交
6951
                }
6952
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
6953 6954 6955
                else if (N <= 0xffffffffffffffff)
                {
                    v.push_back(0xbb);
6956
                    add_to_vector(v, 8, N);  // eight-byte uint64_t for N
N
Niels Lohmann 已提交
6957
                }
6958
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975

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

6976 6977 6978 6979 6980 6981

    /*
    @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 已提交
6982 6983 6984
    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.
6985

N
Niels Lohmann 已提交
6986 6987
    This function checks whether reading the bytes is safe; that is, offset is
    a valid index in the vector, offset+len
6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003

    @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)
        {
7004
            JSON_THROW(std::out_of_range("len out of range"));
7005 7006 7007 7008 7009
        }

        // second case: adding offset would result in overflow
        if ((size > (std::numeric_limits<size_t>::max() - offset)))
        {
7010
            JSON_THROW(std::out_of_range("len+offset out of range"));
7011
        }
N
Niels Lohmann 已提交
7012 7013 7014 7015

        // last case: reading past the end of the vector
        if (len + offset > size)
        {
7016
            JSON_THROW(std::out_of_range("len+offset out of range"));
N
Niels Lohmann 已提交
7017
        }
7018 7019
    }

N
Niels 已提交
7020
    /*!
7021 7022
    @brief create a JSON value from a given MessagePack vector

N
Niels 已提交
7023 7024
    @param[in] v  MessagePack serialization
    @param[in] idx  byte index to start reading from @a v
7025 7026 7027 7028 7029 7030 7031 7032

    @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 已提交
7033 7034 7035
    */
    static basic_json from_msgpack_internal(const std::vector<uint8_t>& v, size_t& idx)
    {
N
Niels Lohmann 已提交
7036 7037 7038
        // make sure reading 1 byte is safe
        check_length(v.size(), 1, idx);

N
Niels 已提交
7039 7040 7041
        // store and increment index
        const size_t current_idx = idx++;

N
Niels Lohmann 已提交
7042
        if (v[current_idx] <= 0xbf)
N
Niels 已提交
7043
        {
N
Niels Lohmann 已提交
7044
            if (v[current_idx] <= 0x7f) // positive fixint
N
Niels 已提交
7045
            {
N
Niels Lohmann 已提交
7046
                return v[current_idx];
N
Niels 已提交
7047
            }
N
Niels Lohmann 已提交
7048
            if (v[current_idx] <= 0x8f) // fixmap
N
Niels 已提交
7049
            {
N
Niels Lohmann 已提交
7050 7051 7052 7053 7054 7055 7056 7057
                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 已提交
7058
            }
N
Niels Lohmann 已提交
7059
            else if (v[current_idx] <= 0x9f) // fixarray
N
Niels 已提交
7060
            {
N
Niels Lohmann 已提交
7061 7062 7063 7064 7065 7066 7067
                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 已提交
7068
            }
N
Niels Lohmann 已提交
7069
            else // fixstr
N
Niels 已提交
7070
            {
N
Niels Lohmann 已提交
7071 7072 7073
                const size_t len = v[current_idx] & 0x1f;
                const size_t offset = current_idx + 1;
                idx += len; // skip content bytes
7074
                check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
7075
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels 已提交
7076 7077
            }
        }
N
Niels Lohmann 已提交
7078
        else if (v[current_idx] >= 0xe0) // negative fixint
N
Niels 已提交
7079
        {
N
Niels Lohmann 已提交
7080
            return static_cast<int8_t>(v[current_idx]);
N
Niels 已提交
7081
        }
N
Niels Lohmann 已提交
7082
        else
N
Niels 已提交
7083
        {
N
Niels Lohmann 已提交
7084
            switch (v[current_idx])
N
Niels 已提交
7085
            {
N
Niels Lohmann 已提交
7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106
                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 已提交
7107
                        reinterpret_cast<uint8_t*>(&res)[sizeof(float) - byte - 1] = v.at(current_idx + 1 + byte);
N
Niels Lohmann 已提交
7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118
                    }
                    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 已提交
7119
                        reinterpret_cast<uint8_t*>(&res)[sizeof(double) - byte - 1] = v.at(current_idx + 1 + byte);
N
Niels Lohmann 已提交
7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174
                    }
                    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
                {
7175
                    const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
N
Niels Lohmann 已提交
7176 7177
                    const size_t offset = current_idx + 2;
                    idx += len + 1; // skip size byte + content bytes
7178
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
7179 7180 7181 7182 7183
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xda: // str 16
                {
7184
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
7185 7186
                    const size_t offset = current_idx + 3;
                    idx += len + 2; // skip 2 size bytes + content bytes
7187
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
7188 7189 7190 7191 7192
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xdb: // str 32
                {
7193
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
7194 7195
                    const size_t offset = current_idx + 5;
                    idx += len + 4; // skip 4 size bytes + content bytes
7196
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
7197 7198 7199 7200 7201 7202
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xdc: // array 16
                {
                    basic_json result = value_t::array;
7203
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214
                    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;
7215
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226
                    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;
7227
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239
                    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;
7240
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251
                    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:
                {
7252
                    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 已提交
7253
                }
N
Niels 已提交
7254 7255 7256 7257
            }
        }
    }

7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271
    /*!
    @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 已提交
7272 7273 7274 7275 7276
    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++;

7277
        switch (v.at(current_idx))
7278
        {
N
Niels Lohmann 已提交
7279
            // Integer 0x00..0x17 (0..23)
7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303
            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:
7304
            {
7305
                return v[current_idx];
7306
            }
7307

N
Niels Lohmann 已提交
7308
            case 0x18: // Unsigned integer (one-byte uint8_t follows)
N
Niels Lohmann 已提交
7309
            {
7310 7311
                idx += 1; // skip content byte
                return get_from_vector<uint8_t>(v, current_idx);
N
Niels Lohmann 已提交
7312
            }
7313

N
Niels Lohmann 已提交
7314
            case 0x19: // Unsigned integer (two-byte uint16_t follows)
N
Niels Lohmann 已提交
7315
            {
7316 7317
                idx += 2; // skip 2 content bytes
                return get_from_vector<uint16_t>(v, current_idx);
N
Niels Lohmann 已提交
7318
            }
7319

N
Niels Lohmann 已提交
7320
            case 0x1a: // Unsigned integer (four-byte uint32_t follows)
N
Niels Lohmann 已提交
7321
            {
7322 7323
                idx += 4; // skip 4 content bytes
                return get_from_vector<uint32_t>(v, current_idx);
N
Niels Lohmann 已提交
7324
            }
7325

N
Niels Lohmann 已提交
7326
            case 0x1b: // Unsigned integer (eight-byte uint64_t follows)
N
Niels Lohmann 已提交
7327
            {
7328 7329
                idx += 8; // skip 8 content bytes
                return get_from_vector<uint64_t>(v, current_idx);
N
Niels Lohmann 已提交
7330
            }
7331

N
Niels Lohmann 已提交
7332
            // Negative integer -1-0x00..-1-0x17 (-1..-24)
7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356
            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 已提交
7357
            {
7358
                return static_cast<int8_t>(0x20 - 1 - v[current_idx]);
N
Niels Lohmann 已提交
7359
            }
7360

N
Niels Lohmann 已提交
7361
            case 0x38: // Negative integer (one-byte uint8_t follows)
7362
            {
7363 7364
                idx += 1; // skip content byte
                // must be uint8_t !
7365
                return static_cast<number_integer_t>(-1) - get_from_vector<uint8_t>(v, current_idx);
7366
            }
7367

N
Niels Lohmann 已提交
7368
            case 0x39: // Negative integer -1-n (two-byte uint16_t follows)
N
Niels Lohmann 已提交
7369
            {
7370
                idx += 2; // skip 2 content bytes
7371
                return static_cast<number_integer_t>(-1) - get_from_vector<uint16_t>(v, current_idx);
N
Niels Lohmann 已提交
7372
            }
7373

N
Niels Lohmann 已提交
7374
            case 0x3a: // Negative integer -1-n (four-byte uint32_t follows)
N
Niels Lohmann 已提交
7375
            {
7376
                idx += 4; // skip 4 content bytes
7377
                return static_cast<number_integer_t>(-1) - get_from_vector<uint32_t>(v, current_idx);
N
Niels Lohmann 已提交
7378
            }
7379

N
Niels Lohmann 已提交
7380
            case 0x3b: // Negative integer -1-n (eight-byte uint64_t follows)
N
Niels Lohmann 已提交
7381
            {
7382
                idx += 8; // skip 8 content bytes
7383
                return static_cast<number_integer_t>(-1) - static_cast<number_integer_t>(get_from_vector<uint64_t>(v, current_idx));
N
Niels Lohmann 已提交
7384
            }
7385

N
Niels Lohmann 已提交
7386
            // UTF-8 string (0x00..0x17 bytes follow)
7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410
            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 已提交
7411
            {
7412
                const auto len = static_cast<size_t>(v[current_idx] - 0x60);
7413 7414
                const size_t offset = current_idx + 1;
                idx += len; // skip content bytes
7415
                check_length(v.size(), len, offset);
7416
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels Lohmann 已提交
7417
            }
7418

N
Niels Lohmann 已提交
7419
            case 0x78: // UTF-8 string (one-byte uint8_t for n follows)
N
Niels Lohmann 已提交
7420
            {
7421
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
7422 7423
                const size_t offset = current_idx + 2;
                idx += len + 1; // skip size byte + content bytes
7424
                check_length(v.size(), len, offset);
7425
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels Lohmann 已提交
7426
            }
7427

N
Niels Lohmann 已提交
7428
            case 0x79: // UTF-8 string (two-byte uint16_t for n follow)
7429
            {
7430
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
7431 7432
                const size_t offset = current_idx + 3;
                idx += len + 2; // skip 2 size bytes + content bytes
7433
                check_length(v.size(), len, offset);
7434
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
7435
            }
7436

N
Niels Lohmann 已提交
7437
            case 0x7a: // UTF-8 string (four-byte uint32_t for n follow)
7438
            {
7439
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
7440 7441
                const size_t offset = current_idx + 5;
                idx += len + 4; // skip 4 size bytes + content bytes
7442
                check_length(v.size(), len, offset);
7443
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
7444
            }
7445

N
Niels Lohmann 已提交
7446
            case 0x7b: // UTF-8 string (eight-byte uint64_t for n follow)
7447
            {
7448
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
7449 7450
                const size_t offset = current_idx + 9;
                idx += len + 8; // skip 8 size bytes + content bytes
7451
                check_length(v.size(), len, offset);
7452
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
7453
            }
7454 7455

            case 0x7f: // UTF-8 string (indefinite length)
7456
            {
7457
                std::string result;
7458
                while (v.at(idx) != 0xff)
7459 7460 7461 7462 7463 7464 7465
                {
                    string_t s = from_cbor_internal(v, idx);
                    result += s;
                }
                // skip break byte (0xFF)
                idx += 1;
                return result;
7466
            }
7467

N
Niels Lohmann 已提交
7468
            // array (0x00..0x17 data items follow)
7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492
            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 已提交
7493
            {
7494
                basic_json result = value_t::array;
7495
                const auto len = static_cast<size_t>(v[current_idx] - 0x80);
7496 7497 7498 7499 7500
                for (size_t i = 0; i < len; ++i)
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                return result;
N
Niels Lohmann 已提交
7501
            }
7502

N
Niels Lohmann 已提交
7503
            case 0x98: // array (one-byte uint8_t for n follows)
N
Niels Lohmann 已提交
7504
            {
7505
                basic_json result = value_t::array;
7506
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
7507 7508 7509 7510 7511 7512
                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 已提交
7513 7514
            }

N
Niels Lohmann 已提交
7515
            case 0x99: // array (two-byte uint16_t for n follow)
7516 7517
            {
                basic_json result = value_t::array;
7518
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
7519 7520 7521 7522 7523 7524 7525 7526
                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 已提交
7527
            case 0x9a: // array (four-byte uint32_t for n follow)
7528 7529
            {
                basic_json result = value_t::array;
7530
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
7531 7532 7533 7534 7535 7536 7537 7538
                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 已提交
7539
            case 0x9b: // array (eight-byte uint64_t for n follow)
7540 7541
            {
                basic_json result = value_t::array;
7542
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553
                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;
7554
                while (v.at(idx) != 0xff)
7555 7556 7557 7558 7559 7560 7561 7562
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                // skip break byte (0xFF)
                idx += 1;
                return result;
            }

N
Niels Lohmann 已提交
7563
            // map (0x00..0x17 pairs of data items follow)
7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589
            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;
7590
                const auto len = static_cast<size_t>(v[current_idx] - 0xa0);
7591 7592 7593 7594 7595 7596 7597 7598
                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 已提交
7599
            case 0xb8: // map (one-byte uint8_t for n follows)
7600 7601
            {
                basic_json result = value_t::object;
7602
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
7603 7604 7605 7606 7607 7608 7609 7610 7611
                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 已提交
7612
            case 0xb9: // map (two-byte uint16_t for n follow)
7613 7614
            {
                basic_json result = value_t::object;
7615
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
7616 7617 7618 7619 7620 7621 7622 7623 7624
                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 已提交
7625
            case 0xba: // map (four-byte uint32_t for n follow)
7626 7627
            {
                basic_json result = value_t::object;
7628
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
7629 7630 7631 7632 7633 7634 7635 7636 7637
                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 已提交
7638
            case 0xbb: // map (eight-byte uint64_t for n follow)
7639 7640
            {
                basic_json result = value_t::object;
7641
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653
                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;
7654
                while (v.at(idx) != 0xff)
7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678
                {
                    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 已提交
7679
            case 0xf9: // Half-Precision Float (two-byte IEEE 754)
7680 7681 7682 7683
            {
                idx += 2; // skip two content bytes

                // code from RFC 7049, Appendix D, Figure 3:
N
Niels Lohmann 已提交
7684 7685 7686 7687 7688 7689
                // As half-precision floating-point numbers were only added to
                // IEEE 754 in 2008, today's programming platforms often still
                // only have limited support for them. It is very easy to
                // include at least decoding support for them even without such
                // support. An example of a small decoder for half-precision
                // floating-point numbers in the C language is shown in Fig. 3.
N
Niels Lohmann 已提交
7690
                const int half = (v.at(current_idx + 1) << 8) + v.at(current_idx + 2);
7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705
                const int exp = (half >> 10) & 0x1f;
                const int mant = half & 0x3ff;
                double val;
                if (exp == 0)
                {
                    val = std::ldexp(mant, -24);
                }
                else if (exp != 31)
                {
                    val = std::ldexp(mant + 1024, exp - 25);
                }
                else
                {
                    val = mant == 0 ? INFINITY : NAN;
                }
N
Niels Lohmann 已提交
7706
                return (half & 0x8000) != 0 ? -val : val;
7707 7708
            }

N
Niels Lohmann 已提交
7709
            case 0xfa: // Single-Precision Float (four-byte IEEE 754)
7710 7711 7712 7713 7714
            {
                // copy bytes in reverse order into the float variable
                float res;
                for (size_t byte = 0; byte < sizeof(float); ++byte)
                {
N
Niels Lohmann 已提交
7715
                    reinterpret_cast<uint8_t*>(&res)[sizeof(float) - byte - 1] = v.at(current_idx + 1 + byte);
7716 7717 7718 7719 7720
                }
                idx += sizeof(float); // skip content bytes
                return res;
            }

N
Niels Lohmann 已提交
7721
            case 0xfb: // Double-Precision Float (eight-byte IEEE 754)
7722 7723 7724 7725 7726
            {
                // copy bytes in reverse order into the double variable
                double res;
                for (size_t byte = 0; byte < sizeof(double); ++byte)
                {
N
Niels Lohmann 已提交
7727
                    reinterpret_cast<uint8_t*>(&res)[sizeof(double) - byte - 1] = v.at(current_idx + 1 + byte);
7728 7729 7730 7731 7732
                }
                idx += sizeof(double); // skip content bytes
                return res;
            }

N
Niels Lohmann 已提交
7733
            default: // anything else (0xFF is handled inside the other types)
7734
            {
7735
                JSON_THROW(std::invalid_argument("error parsing a CBOR @ " + std::to_string(current_idx) + ": " + std::to_string(static_cast<int>(v[current_idx]))));
7736 7737
            }
        }
N
Niels Lohmann 已提交
7738 7739
    }

N
Niels 已提交
7740 7741
  public:
    /*!
7742 7743 7744 7745 7746 7747
    @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 已提交
7748
    @param[in] j  JSON value to serialize
7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759
    @return MessagePack serialization as byte vector

    @complexity Linear in the size of the JSON value @a j.

    @liveexample{The example shows the serialization of a JSON value to a byte
    vector in MessagePack format.,to_msgpack}

    @sa http://msgpack.org
    @sa @ref from_msgpack(const std::vector<uint8_t>&) for the analogous
        deserialization
    @sa @ref to_cbor(const basic_json& for the related CBOR format
N
Niels 已提交
7760 7761 7762 7763 7764 7765 7766 7767
    */
    static std::vector<uint8_t> to_msgpack(const basic_json& j)
    {
        std::vector<uint8_t> result;
        to_msgpack_internal(j, result);
        return result;
    }

7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789
    /*!
    @brief create a JSON value from a byte vector in MessagePack format

    Deserializes a given byte vector @a v to a JSON value using the MessagePack
    serialization format.

    @param[in] v  a byte vector in MessagePack format
    @return deserialized JSON value

    @throw std::invalid_argument if unsupported features from MessagePack were
    used in the given vector @a v or if the input is not valid MessagePack
    @throw std::out_of_range if the given vector ends prematurely

    @complexity Linear in the size of the byte vector @a v.

    @liveexample{The example shows the deserialization of a byte vector in
    MessagePack format to a JSON value.,from_msgpack}

    @sa http://msgpack.org
    @sa @ref to_msgpack(const basic_json&) for the analogous serialization
    @sa @ref from_cbor(const std::vector<uint8_t>&) for the related CBOR format
    */
N
Niels 已提交
7790 7791 7792 7793 7794 7795
    static basic_json from_msgpack(const std::vector<uint8_t>& v)
    {
        size_t i = 0;
        return from_msgpack_internal(v, i);
    }

N
Niels Lohmann 已提交
7796
    /*!
7797 7798 7799 7800 7801 7802 7803
    @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 已提交
7804
    @param[in] j  JSON value to serialize
7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815
    @return MessagePack serialization as byte vector

    @complexity Linear in the size of the JSON value @a j.

    @liveexample{The example shows the serialization of a JSON value to a byte
    vector in CBOR format.,to_cbor}

    @sa http://cbor.io
    @sa @ref from_cbor(const std::vector<uint8_t>&) for the analogous
        deserialization
    @sa @ref to_msgpack(const basic_json& for the related MessagePack format
N
Niels Lohmann 已提交
7816 7817 7818 7819 7820 7821 7822 7823
    */
    static std::vector<uint8_t> to_cbor(const basic_json& j)
    {
        std::vector<uint8_t> result;
        to_cbor_internal(j, result);
        return result;
    }

7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846
    /*!
    @brief create a JSON value from a byte vector in CBOR format

    Deserializes a given byte vector @a v to a JSON value using the CBOR
    (Concise Binary Object Representation) serialization format.

    @param[in] v  a byte vector in CBOR format
    @return deserialized JSON value

    @throw std::invalid_argument if unsupported features from CBOR were used in
    the given vector @a v or if the input is not valid MessagePack
    @throw std::out_of_range if the given vector ends prematurely

    @complexity Linear in the size of the byte vector @a v.

    @liveexample{The example shows the deserialization of a byte vector in CBOR
    format to a JSON value.,from_cbor}

    @sa http://cbor.io
    @sa @ref to_cbor(const basic_json&) for the analogous serialization
    @sa @ref from_msgpack(const std::vector<uint8_t>&) for the related
        MessagePack format
    */
N
Niels Lohmann 已提交
7847 7848 7849 7850 7851 7852
    static basic_json from_cbor(const std::vector<uint8_t>& v)
    {
        size_t i = 0;
        return from_cbor_internal(v, i);
    }

N
Niels 已提交
7853
    /// @}
N
Niels 已提交
7854

N
cleanup  
Niels 已提交
7855 7856 7857 7858
    ///////////////////////////
    // convenience functions //
    ///////////////////////////

N
Niels 已提交
7859 7860 7861 7862 7863 7864
    /*!
    @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 已提交
7865
    @return basically a string representation of a the @a m_type member
N
Niels 已提交
7866 7867 7868

    @complexity Constant.

7869 7870 7871
    @liveexample{The following code exemplifies `type_name()` for all JSON
    types.,typename}

N
Niels 已提交
7872 7873
    @since version 1.0.0
    */
7874
    std::string type_name() const { return detail::type_name(*this); }
N
cleanup  
Niels 已提交
7875

7876
  private:
N
Niels 已提交
7877 7878 7879 7880 7881 7882 7883 7884 7885 7886
    /*!
    @brief calculates the extra space to escape a JSON string

    @param[in] s  the string to escape
    @return the number of characters required to escape string @a s

    @complexity Linear in the length of string @a s.
    */
    static std::size_t extra_space(const string_t& s) noexcept
    {
N
Niels 已提交
7887 7888
        return std::accumulate(s.begin(), s.end(), size_t{},
                               [](size_t res, typename string_t::value_type c)
N
Niels 已提交
7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900
        {
            switch (c)
            {
                case '"':
                case '\\':
                case '\b':
                case '\f':
                case '\n':
                case '\r':
                case '\t':
                {
                    // from c (1 byte) to \x (2 bytes)
N
Niels 已提交
7901
                    return res + 1;
N
Niels 已提交
7902 7903 7904 7905 7906 7907 7908
                }

                default:
                {
                    if (c >= 0x00 and c <= 0x1f)
                    {
                        // from c (1 byte) to \uxxxx (6 bytes)
N
Niels 已提交
7909 7910
                        return res + 5;
                    }
N
Niels Lohmann 已提交
7911 7912

                    return res;
N
Niels 已提交
7913 7914
                }
            }
N
Niels 已提交
7915
        });
N
Niels 已提交
7916 7917
    }

N
Niels 已提交
7918
    /*!
N
Niels 已提交
7919
    @brief escape a string
N
Niels 已提交
7920

N
Niels 已提交
7921 7922
    Escape a string by replacing certain special characters by a sequence of
    an escape character (backslash) and another character and other control
N
Niels 已提交
7923 7924 7925
    characters by a sequence of "\u" followed by a four-digit hex
    representation.

N
Niels 已提交
7926
    @param[in] s  the string to escape
N
Niels 已提交
7927 7928 7929
    @return  the escaped string

    @complexity Linear in the length of string @a s.
N
Niels 已提交
7930
    */
N
Niels 已提交
7931
    static string_t escape_string(const string_t& s)
N
Niels 已提交
7932
    {
N
Niels 已提交
7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943
        const auto space = extra_space(s);
        if (space == 0)
        {
            return s;
        }

        // create a result string of necessary size
        string_t result(s.size() + space, '\\');
        std::size_t pos = 0;

        for (const auto& c : s)
N
Niels 已提交
7944 7945 7946
        {
            switch (c)
            {
N
Niels 已提交
7947
                // quotation mark (0x22)
N
Niels 已提交
7948 7949
                case '"':
                {
N
Niels 已提交
7950 7951
                    result[pos + 1] = '"';
                    pos += 2;
N
Niels 已提交
7952 7953
                    break;
                }
N
Niels 已提交
7954

N
Niels 已提交
7955
                // reverse solidus (0x5c)
N
Niels 已提交
7956 7957
                case '\\':
                {
N
Niels 已提交
7958 7959
                    // nothing to change
                    pos += 2;
N
Niels 已提交
7960 7961
                    break;
                }
N
Niels 已提交
7962

N
Niels 已提交
7963
                // backspace (0x08)
N
Niels 已提交
7964 7965
                case '\b':
                {
N
Niels 已提交
7966 7967
                    result[pos + 1] = 'b';
                    pos += 2;
N
Niels 已提交
7968 7969
                    break;
                }
N
Niels 已提交
7970

N
Niels 已提交
7971
                // formfeed (0x0c)
N
Niels 已提交
7972 7973
                case '\f':
                {
N
Niels 已提交
7974 7975
                    result[pos + 1] = 'f';
                    pos += 2;
N
Niels 已提交
7976 7977
                    break;
                }
N
Niels 已提交
7978

N
Niels 已提交
7979
                // newline (0x0a)
N
Niels 已提交
7980 7981
                case '\n':
                {
N
Niels 已提交
7982 7983
                    result[pos + 1] = 'n';
                    pos += 2;
N
Niels 已提交
7984 7985
                    break;
                }
N
Niels 已提交
7986

N
Niels 已提交
7987
                // carriage return (0x0d)
N
Niels 已提交
7988 7989
                case '\r':
                {
N
Niels 已提交
7990 7991
                    result[pos + 1] = 'r';
                    pos += 2;
N
Niels 已提交
7992 7993
                    break;
                }
N
Niels 已提交
7994

N
Niels 已提交
7995
                // horizontal tab (0x09)
N
Niels 已提交
7996 7997
                case '\t':
                {
N
Niels 已提交
7998 7999
                    result[pos + 1] = 't';
                    pos += 2;
N
Niels 已提交
8000 8001
                    break;
                }
N
Niels 已提交
8002

N
Niels 已提交
8003 8004
                default:
                {
8005
                    if (c >= 0x00 and c <= 0x1f)
N
Niels 已提交
8006
                    {
N
Niels 已提交
8007 8008
                        // convert a number 0..15 to its hex representation
                        // (0..f)
N
Niels 已提交
8009
                        static const char hexify[16] =
8010
                        {
N
Niels 已提交
8011 8012
                            '0', '1', '2', '3', '4', '5', '6', '7',
                            '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'
8013 8014
                        };

N
Niels 已提交
8015
                        // print character c as \uxxxx
N
Niels 已提交
8016
                        for (const char m :
N
Niels 已提交
8017
                    { 'u', '0', '0', hexify[c >> 4], hexify[c & 0x0f]
N
Niels 已提交
8018
                        })
8019 8020 8021 8022 8023
                        {
                            result[++pos] = m;
                        }

                        ++pos;
N
Niels 已提交
8024 8025 8026 8027
                    }
                    else
                    {
                        // all other characters are added as-is
N
Niels 已提交
8028
                        result[pos++] = c;
N
Niels 已提交
8029 8030
                    }
                    break;
N
Niels 已提交
8031 8032 8033
                }
            }
        }
N
Niels 已提交
8034 8035

        return result;
N
Niels 已提交
8036 8037
    }

N
cleanup  
Niels 已提交
8038
    /*!
N
Niels 已提交
8039
    @brief internal implementation of the serialization function
N
Niels 已提交
8040

N
Niels 已提交
8041
    This function is called by the public member function dump and organizes
N
Niels 已提交
8042
    the serialization internally. The indentation level is propagated as
N
Niels 已提交
8043 8044
    additional parameter. In case of arrays and objects, the function is
    called recursively. Note that
N
Niels 已提交
8045

N
Niels 已提交
8046 8047 8048
    - strings and object keys are escaped using `escape_string()`
    - integer numbers are converted implicitly via `operator<<`
    - floating-point numbers are converted to a string using `"%g"` format
N
cleanup  
Niels 已提交
8049

N
Niels 已提交
8050 8051 8052 8053
    @param[out] o              stream to write to
    @param[in] pretty_print    whether the output shall be pretty-printed
    @param[in] indent_step     the indent level
    @param[in] current_indent  the current indent level (only used internally)
N
cleanup  
Niels 已提交
8054
    */
N
Niels 已提交
8055 8056 8057
    void dump(std::ostream& o,
              const bool pretty_print,
              const unsigned int indent_step,
N
Niels 已提交
8058
              const unsigned int current_indent = 0) const
N
cleanup  
Niels 已提交
8059
    {
N
Niels 已提交
8060
        // variable to hold indentation for recursive calls
N
Niels 已提交
8061
        unsigned int new_indent = current_indent;
N
Niels 已提交
8062

N
cleanup  
Niels 已提交
8063 8064
        switch (m_type)
        {
8065
            case value_t::object:
N
cleanup  
Niels 已提交
8066 8067 8068
            {
                if (m_value.object->empty())
                {
N
Niels 已提交
8069 8070
                    o << "{}";
                    return;
N
cleanup  
Niels 已提交
8071 8072
                }

N
Niels 已提交
8073
                o << "{";
N
cleanup  
Niels 已提交
8074 8075

                // increase indentation
N
Niels 已提交
8076
                if (pretty_print)
N
cleanup  
Niels 已提交
8077
                {
N
Niels 已提交
8078
                    new_indent += indent_step;
N
Niels 已提交
8079
                    o << "\n";
N
cleanup  
Niels 已提交
8080 8081
                }

N
Niels 已提交
8082
                for (auto i = m_value.object->cbegin(); i != m_value.object->cend(); ++i)
N
cleanup  
Niels 已提交
8083
                {
N
Niels 已提交
8084
                    if (i != m_value.object->cbegin())
N
cleanup  
Niels 已提交
8085
                    {
N
Niels 已提交
8086
                        o << (pretty_print ? ",\n" : ",");
N
cleanup  
Niels 已提交
8087
                    }
N
Niels 已提交
8088
                    o << string_t(new_indent, ' ') << "\""
8089 8090 8091
                                                    << escape_string(i->first) << "\":"
                                                            << (pretty_print ? " " : "");
                                                            i->second.dump(o, pretty_print, indent_step, new_indent);
N
cleanup  
Niels 已提交
8092 8093
                }

8094 8095
                                                        // decrease indentation
                                                        if (pretty_print)
N
cleanup  
Niels 已提交
8096
                {
N
Niels 已提交
8097
                    new_indent -= indent_step;
N
Niels 已提交
8098
                    o << "\n";
N
cleanup  
Niels 已提交
8099 8100
                }

N
Niels 已提交
8101 8102
                o << string_t(new_indent, ' ') + "}";
                return;
N
cleanup  
Niels 已提交
8103 8104
            }

8105
            case value_t::array:
N
cleanup  
Niels 已提交
8106 8107 8108
            {
                if (m_value.array->empty())
                {
N
Niels 已提交
8109 8110
                    o << "[]";
                    return;
N
cleanup  
Niels 已提交
8111 8112
                }

N
Niels 已提交
8113
                o << "[";
N
cleanup  
Niels 已提交
8114 8115

                // increase indentation
N
Niels 已提交
8116
                if (pretty_print)
N
cleanup  
Niels 已提交
8117
                {
N
Niels 已提交
8118
                    new_indent += indent_step;
N
Niels 已提交
8119
                    o << "\n";
N
cleanup  
Niels 已提交
8120 8121
                }

N
Niels 已提交
8122
                for (auto i = m_value.array->cbegin(); i != m_value.array->cend(); ++i)
N
cleanup  
Niels 已提交
8123
                {
N
Niels 已提交
8124
                    if (i != m_value.array->cbegin())
N
cleanup  
Niels 已提交
8125
                    {
N
Niels 已提交
8126
                        o << (pretty_print ? ",\n" : ",");
N
cleanup  
Niels 已提交
8127
                    }
N
Niels 已提交
8128
                    o << string_t(new_indent, ' ');
N
Niels 已提交
8129
                    i->dump(o, pretty_print, indent_step, new_indent);
N
cleanup  
Niels 已提交
8130 8131 8132
                }

                // decrease indentation
N
Niels 已提交
8133
                if (pretty_print)
N
cleanup  
Niels 已提交
8134
                {
N
Niels 已提交
8135
                    new_indent -= indent_step;
N
Niels 已提交
8136
                    o << "\n";
N
cleanup  
Niels 已提交
8137 8138
                }

N
Niels 已提交
8139
                o << string_t(new_indent, ' ') << "]";
8140
                   return;
N
cleanup  
Niels 已提交
8141 8142
            }

8143
               case value_t::string:
N
cleanup  
Niels 已提交
8144
            {
N
Niels 已提交
8145
                o << string_t("\"") << escape_string(*m_value.string) << "\"";
8146
                                     return;
N
cleanup  
Niels 已提交
8147 8148
            }

8149
                                 case value_t::boolean:
N
cleanup  
Niels 已提交
8150
            {
N
Niels 已提交
8151 8152
                o << (m_value.boolean ? "true" : "false");
                return;
N
cleanup  
Niels 已提交
8153 8154
            }

8155
            case value_t::number_integer:
N
cleanup  
Niels 已提交
8156
            {
N
Niels 已提交
8157 8158
                o << m_value.number_integer;
                return;
N
cleanup  
Niels 已提交
8159 8160
            }

8161 8162 8163 8164 8165 8166
            case value_t::number_unsigned:
            {
                o << m_value.number_unsigned;
                return;
            }

8167
            case value_t::number_float:
N
cleanup  
Niels 已提交
8168
            {
N
Niels 已提交
8169
                if (m_value.number_float == 0)
N
Niels 已提交
8170
                {
N
Niels 已提交
8171 8172
                    // special case for zero to get "0.0"/"-0.0"
                    o << (std::signbit(m_value.number_float) ? "-0.0" : "0.0");
N
Niels 已提交
8173
                }
N
Niels 已提交
8174
                else
N
Niels 已提交
8175
                {
8176
                    o << m_value.number_float;
N
Niels 已提交
8177
                }
N
Niels 已提交
8178
                return;
N
cleanup  
Niels 已提交
8179
            }
N
Niels 已提交
8180

8181
            case value_t::discarded:
N
Niels 已提交
8182
            {
N
Niels 已提交
8183 8184
                o << "<discarded>";
                return;
N
Niels 已提交
8185
            }
N
Niels 已提交
8186

8187
            case value_t::null:
N
Niels 已提交
8188
            {
N
Niels 已提交
8189 8190
                o << "null";
                return;
N
Niels 已提交
8191
            }
N
cleanup  
Niels 已提交
8192 8193 8194 8195 8196 8197 8198 8199 8200
        }
    }

  private:
    //////////////////////
    // member variables //
    //////////////////////

    /// the type of the current element
N
Niels 已提交
8201
    value_t m_type = value_t::null;
N
cleanup  
Niels 已提交
8202 8203 8204 8205

    /// the value of the current element
    json_value m_value = {};

N
Niels 已提交
8206

N
Niels 已提交
8207
  private:
N
cleanup  
Niels 已提交
8208 8209 8210 8211
    ///////////////
    // iterators //
    ///////////////

8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222
    /*!
    @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
    {
8223
        public:
8224

8225 8226 8227 8228 8229 8230 8231 8232 8233
        difference_type get_value() const noexcept
    {
        return m_it;
    }
    /// set iterator to a defined beginning
    void set_begin() noexcept
    {
        m_it = begin_value;
    }
8234

8235 8236 8237 8238 8239
    /// set iterator to a defined past the end
    void set_end() noexcept
    {
        m_it = end_value;
    }
8240

8241 8242 8243 8244 8245
    /// return whether the iterator can be dereferenced
    constexpr bool is_begin() const noexcept
    {
        return (m_it == begin_value);
    }
8246

8247 8248 8249 8250 8251
    /// return whether the iterator is at end
    constexpr bool is_end() const noexcept
    {
        return (m_it == end_value);
    }
8252

8253 8254 8255 8256
    friend constexpr bool operator==(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
    {
        return lhs.m_it == rhs.m_it;
    }
8257

8258 8259 8260 8261
    friend constexpr bool operator!=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
    {
        return !(lhs == rhs);
    }
8262

8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 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 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342
    friend constexpr bool operator<(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
    {
        return lhs.m_it < rhs.m_it;
    }

    friend constexpr bool operator<=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
    {
        return lhs.m_it <= rhs.m_it;
    }

    friend constexpr bool operator>(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
    {
        return lhs.m_it > rhs.m_it;
    }

    friend constexpr bool operator>=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
    {
        return lhs.m_it >= rhs.m_it;
    }

    primitive_iterator_t operator+(difference_type i)
    {
        auto result = *this;
        result += i;
        return result;
    }

    friend constexpr difference_type operator-(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
    {
        return lhs.m_it - rhs.m_it;
    }

    friend std::ostream& operator<<(std::ostream& os, primitive_iterator_t it)
    {
        return os << it.m_it;
    }

    primitive_iterator_t& operator++()
    {
        ++m_it;
        return *this;
    }

    primitive_iterator_t& operator++(int)
    {
        m_it++;
        return *this;
    }

    primitive_iterator_t& operator--()
    {
        --m_it;
        return *this;
    }

    primitive_iterator_t& operator--(int)
    {
        m_it--;
        return *this;
    }

    primitive_iterator_t& operator+=(difference_type n)
    {
        m_it += n;
        return *this;
    }

    primitive_iterator_t& operator-=(difference_type n)
    {
        m_it -= n;
        return *this;
    }

    private:
    static constexpr difference_type begin_value = 0;
    static constexpr difference_type end_value = begin_value + 1;

    /// iterator as signed integer type
    difference_type m_it = std::numeric_limits<std::ptrdiff_t>::denorm_min();
                                              };
8343

N
Niels 已提交
8344 8345 8346 8347 8348 8349 8350 8351
    /*!
    @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 已提交
8352 8353
    {
        /// iterator for JSON objects
N
Niels 已提交
8354
        typename object_t::iterator object_iterator;
N
Niels 已提交
8355
        /// iterator for JSON arrays
N
Niels 已提交
8356
        typename array_t::iterator array_iterator;
N
Niels 已提交
8357
        /// generic iterator for all other types
N
Niels 已提交
8358 8359 8360
        primitive_iterator_t primitive_iterator;

        /// create an uninitialized internal_iterator
N
Niels 已提交
8361
        internal_iterator() noexcept
8362 8363
        : object_iterator(), array_iterator(), primitive_iterator()
    {}
N
Niels 已提交
8364 8365
    };

N
cleanup  
Niels 已提交
8366 8367 8368 8369
    /// proxy class for the iterator_wrapper functions
    template<typename IteratorType>
    class iteration_proxy
    {
8370
        private:
N
cleanup  
Niels 已提交
8371 8372 8373
        /// helper class for iteration
        class iteration_proxy_internal
        {
8374
            private:
N
cleanup  
Niels 已提交
8375 8376 8377 8378 8379
            /// the iterator
            IteratorType anchor;
            /// an index for arrays (used to create key names)
            size_t array_index = 0;

8380
            public:
N
Niels 已提交
8381
            explicit iteration_proxy_internal(IteratorType it) noexcept
8382 8383
            : anchor(it)
    {}
N
cleanup  
Niels 已提交
8384

8385 8386 8387 8388 8389
    /// dereference operator (needed for range-based for)
    iteration_proxy_internal& operator*()
    {
        return *this;
    }
N
cleanup  
Niels 已提交
8390

8391 8392 8393 8394 8395
    /// increment operator (needed for range-based for)
    iteration_proxy_internal& operator++()
    {
        ++anchor;
        ++array_index;
N
cleanup  
Niels 已提交
8396

8397 8398 8399 8400 8401 8402 8403 8404
        return *this;
    }

    /// inequality operator (needed for range-based for)
    bool operator!= (const iteration_proxy_internal& o) const
    {
        return anchor != o.anchor;
    }
N
cleanup  
Niels 已提交
8405

8406 8407 8408 8409 8410 8411 8412 8413 8414
    /// return key of the iterator
    typename basic_json::string_t key() const
    {
        assert(anchor.m_object != nullptr);

        switch (anchor.m_object->type())
        {
            // use integer array index as key
            case value_t::array:
N
cleanup  
Niels 已提交
8415
            {
8416
                return std::to_string(array_index);
N
cleanup  
Niels 已提交
8417 8418
            }

8419 8420
            // use key from the object
            case value_t::object:
N
cleanup  
Niels 已提交
8421
            {
8422
                return anchor.key();
N
cleanup  
Niels 已提交
8423 8424
            }

8425 8426
            // use an empty key for all primitive types
            default:
N
cleanup  
Niels 已提交
8427
            {
8428
                return "";
N
cleanup  
Niels 已提交
8429
            }
8430 8431 8432 8433 8434 8435 8436 8437
        }
    }

    /// return value of the iterator
    typename IteratorType::reference value() const
    {
        return anchor.value();
    }
N
cleanup  
Niels 已提交
8438 8439
        };

8440 8441
    /// the container to iterate
    typename IteratorType::reference container;
N
cleanup  
Niels 已提交
8442

8443 8444 8445 8446 8447
    public:
    /// construct iteration proxy from a container
    explicit iteration_proxy(typename IteratorType::reference cont)
    : container(cont)
    {}
N
cleanup  
Niels 已提交
8448

8449 8450 8451 8452 8453
    /// return iterator begin (needed for range-based for)
    iteration_proxy_internal begin() noexcept
    {
        return iteration_proxy_internal(container.begin());
    }
N
cleanup  
Niels 已提交
8454

8455 8456 8457 8458 8459
    /// return iterator end (needed for range-based for)
    iteration_proxy_internal end() noexcept
    {
        return iteration_proxy_internal(container.end());
    }
N
cleanup  
Niels 已提交
8460 8461
    };

N
Niels 已提交
8462
  public:
N
Niels 已提交
8463
    /*!
8464
    @brief a template for a random access iterator for the @ref basic_json class
N
Niels 已提交
8465

N
Niels Lohmann 已提交
8466 8467
    This class implements a both iterators (iterator and const_iterator) for the
    @ref basic_json class.
N
Niels 已提交
8468

N
Niels 已提交
8469 8470 8471
    @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 已提交
8472 8473
          methods are undefined. **The library uses assertions to detect calls
          on uninitialized iterators.**
N
Niels 已提交
8474

N
Niels 已提交
8475 8476 8477 8478
    @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 已提交
8479

N
Niels Lohmann 已提交
8480
    @since version 1.0.0, simplified in version 2.0.9
N
Niels 已提交
8481
    */
N
Niels Lohmann 已提交
8482
    template<typename U>
8483
  class iter_impl : public std::iterator<std::random_access_iterator_tag, U>
N
cleanup  
Niels 已提交
8484
    {
N
Niels 已提交
8485
        /// allow basic_json to access private members
8486 8487
        friend class basic_json;

8488 8489 8490 8491 8492
        // 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");

8493
        public:
N
cleanup  
Niels 已提交
8494
        /// the type of the values when the iterator is dereferenced
N
Niels 已提交
8495
        using value_type = typename basic_json::value_type;
N
cleanup  
Niels 已提交
8496
        /// a type to represent differences between iterators
N
Niels 已提交
8497
        using difference_type = typename basic_json::difference_type;
N
cleanup  
Niels 已提交
8498
        /// defines a pointer to the type iterated over (value_type)
8499
        using pointer = typename std::conditional<std::is_const<U>::value,
8500 8501
                typename basic_json::const_pointer,
                typename basic_json::pointer>::type;
N
cleanup  
Niels 已提交
8502
        /// defines a reference to the type iterated over (value_type)
8503
        using reference = typename std::conditional<std::is_const<U>::value,
8504 8505
                typename basic_json::const_reference,
                typename basic_json::reference>::type;
N
cleanup  
Niels 已提交
8506
        /// the category of the iterator
N
Niels 已提交
8507
        using iterator_category = std::bidirectional_iterator_tag;
N
cleanup  
Niels 已提交
8508

8509
        /// default constructor
8510
        iter_impl() = default;
8511

N
Niels 已提交
8512 8513 8514 8515 8516 8517
        /*!
        @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`.
        */
8518
        explicit iter_impl(pointer object) noexcept
8519 8520 8521 8522 8523
        : m_object(object)
    {
        assert(m_object != nullptr);

        switch (m_object->m_type)
N
cleanup  
Niels 已提交
8524
        {
8525 8526 8527 8528 8529
            case basic_json::value_t::object:
            {
                m_it.object_iterator = typename object_t::iterator();
                break;
            }
N
Niels 已提交
8530

8531
            case basic_json::value_t::array:
N
cleanup  
Niels 已提交
8532
            {
8533 8534 8535
                m_it.array_iterator = typename array_t::iterator();
                break;
            }
8536

8537 8538 8539 8540
            default:
            {
                m_it.primitive_iterator = primitive_iterator_t();
                break;
N
cleanup  
Niels 已提交
8541 8542
            }
        }
8543
    }
N
cleanup  
Niels 已提交
8544

8545 8546 8547 8548
    /*
    Use operator `const_iterator` instead of `const_iterator(const iterator&
    other) noexcept` to avoid two class definitions for @ref iterator and
    @ref const_iterator.
N
Niels 已提交
8549

8550 8551 8552 8553 8554 8555 8556 8557
    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
    {
        const_iterator ret;

        if (m_object)
N
Niels Lohmann 已提交
8558
        {
8559 8560 8561
            ret.m_object = m_object;
            ret.m_it = m_it;
        }
N
Niels 已提交
8562

8563 8564
        return ret;
    }
8565

8566 8567 8568 8569 8570 8571 8572 8573
    /*!
    @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 已提交
8574

8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590
    /*!
    @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 已提交
8591

8592 8593 8594 8595 8596 8597 8598 8599
    private:
    /*!
    @brief set the iterator to the first value
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    void set_begin() noexcept
    {
        assert(m_object != nullptr);
N
cleanup  
Niels 已提交
8600

8601
        switch (m_object->m_type)
N
cleanup  
Niels 已提交
8602
        {
8603
            case basic_json::value_t::object:
N
cleanup  
Niels 已提交
8604
            {
8605 8606 8607
                m_it.object_iterator = m_object->m_value.object->begin();
                break;
            }
N
cleanup  
Niels 已提交
8608

8609 8610 8611 8612 8613
            case basic_json::value_t::array:
            {
                m_it.array_iterator = m_object->m_value.array->begin();
                break;
            }
N
cleanup  
Niels 已提交
8614

8615 8616 8617 8618 8619 8620
            case basic_json::value_t::null:
            {
                // set to end so begin()==end() is true: null is empty
                m_it.primitive_iterator.set_end();
                break;
            }
N
cleanup  
Niels 已提交
8621

8622 8623 8624 8625
            default:
            {
                m_it.primitive_iterator.set_begin();
                break;
N
cleanup  
Niels 已提交
8626 8627
            }
        }
8628
    }
N
cleanup  
Niels 已提交
8629

8630 8631 8632 8633 8634 8635 8636
    /*!
    @brief set the iterator past the last value
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    void set_end() noexcept
    {
        assert(m_object != nullptr);
N
Niels 已提交
8637

8638 8639 8640
        switch (m_object->m_type)
        {
            case basic_json::value_t::object:
N
cleanup  
Niels 已提交
8641
            {
8642 8643 8644
                m_it.object_iterator = m_object->m_value.object->end();
                break;
            }
N
cleanup  
Niels 已提交
8645

8646 8647 8648 8649 8650
            case basic_json::value_t::array:
            {
                m_it.array_iterator = m_object->m_value.array->end();
                break;
            }
N
cleanup  
Niels 已提交
8651

8652 8653 8654 8655
            default:
            {
                m_it.primitive_iterator.set_end();
                break;
N
cleanup  
Niels 已提交
8656 8657
            }
        }
8658
    }
N
cleanup  
Niels 已提交
8659

8660 8661 8662 8663 8664 8665 8666 8667
    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
    {
        assert(m_object != nullptr);
N
Niels 已提交
8668

8669 8670 8671
        switch (m_object->m_type)
        {
            case basic_json::value_t::object:
N
cleanup  
Niels 已提交
8672
            {
8673 8674 8675
                assert(m_it.object_iterator != m_object->m_value.object->end());
                return m_it.object_iterator->second;
            }
N
cleanup  
Niels 已提交
8676

8677 8678 8679 8680 8681
            case basic_json::value_t::array:
            {
                assert(m_it.array_iterator != m_object->m_value.array->end());
                return *m_it.array_iterator;
            }
N
cleanup  
Niels 已提交
8682

8683 8684
            case basic_json::value_t::null:
            {
8685
                    JSON_THROW(std::out_of_range("cannot get value"));
8686
            }
N
cleanup  
Niels 已提交
8687

8688 8689 8690
            default:
            {
                if (m_it.primitive_iterator.is_begin())
N
cleanup  
Niels 已提交
8691
                {
8692 8693
                    return *m_object;
                }
N
Niels Lohmann 已提交
8694

8695
                    JSON_THROW(std::out_of_range("cannot get value"));
N
cleanup  
Niels 已提交
8696 8697
            }
        }
8698
    }
N
cleanup  
Niels 已提交
8699

8700 8701 8702 8703 8704 8705 8706 8707 8708
    /*!
    @brief dereference the iterator
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    pointer operator->() const
    {
        assert(m_object != nullptr);

        switch (m_object->m_type)
N
cleanup  
Niels 已提交
8709
        {
8710 8711 8712 8713 8714
            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 已提交
8715

8716
            case basic_json::value_t::array:
N
cleanup  
Niels 已提交
8717
            {
8718 8719 8720
                assert(m_it.array_iterator != m_object->m_value.array->end());
                return &*m_it.array_iterator;
            }
N
cleanup  
Niels 已提交
8721

8722 8723 8724
            default:
            {
                if (m_it.primitive_iterator.is_begin())
N
cleanup  
Niels 已提交
8725
                {
8726
                    return m_object;
N
cleanup  
Niels 已提交
8727 8728
                }

8729
                    JSON_THROW(std::out_of_range("cannot get value"));
N
cleanup  
Niels 已提交
8730 8731
            }
        }
8732
    }
N
cleanup  
Niels 已提交
8733

8734 8735 8736 8737 8738 8739 8740 8741 8742 8743
    /*!
    @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
cleanup  
Niels 已提交
8744

8745 8746 8747 8748 8749 8750 8751
    /*!
    @brief pre-increment (++it)
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    iter_impl& operator++()
    {
        assert(m_object != nullptr);
N
Niels 已提交
8752

8753 8754 8755
        switch (m_object->m_type)
        {
            case basic_json::value_t::object:
N
cleanup  
Niels 已提交
8756
            {
8757 8758 8759
                std::advance(m_it.object_iterator, 1);
                break;
            }
N
cleanup  
Niels 已提交
8760

8761 8762 8763 8764
            case basic_json::value_t::array:
            {
                std::advance(m_it.array_iterator, 1);
                break;
N
cleanup  
Niels 已提交
8765 8766
            }

8767 8768 8769 8770 8771
            default:
            {
                ++m_it.primitive_iterator;
                break;
            }
N
cleanup  
Niels 已提交
8772 8773
        }

8774 8775
        return *this;
    }
N
cleanup  
Niels 已提交
8776

8777 8778 8779 8780 8781 8782 8783 8784 8785 8786
    /*!
    @brief post-decrement (it--)
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    iter_impl operator--(int)
    {
        auto result = *this;
        --(*this);
        return result;
    }
N
Niels 已提交
8787

8788 8789 8790 8791 8792 8793 8794
    /*!
    @brief pre-decrement (--it)
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    iter_impl& operator--()
    {
        assert(m_object != nullptr);
N
cleanup  
Niels 已提交
8795

8796 8797 8798 8799 8800 8801 8802
        switch (m_object->m_type)
        {
            case basic_json::value_t::object:
            {
                std::advance(m_it.object_iterator, -1);
                break;
            }
N
cleanup  
Niels 已提交
8803

8804 8805 8806 8807
            case basic_json::value_t::array:
            {
                std::advance(m_it.array_iterator, -1);
                break;
N
cleanup  
Niels 已提交
8808 8809
            }

8810 8811 8812 8813 8814
            default:
            {
                --m_it.primitive_iterator;
                break;
            }
N
cleanup  
Niels 已提交
8815 8816
        }

8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827
        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
cleanup  
Niels 已提交
8828
        {
8829
                JSON_THROW(std::domain_error("cannot compare iterators of different containers"));
8830
        }
N
cleanup  
Niels 已提交
8831

8832
        assert(m_object != nullptr);
N
Niels 已提交
8833

8834 8835 8836
        switch (m_object->m_type)
        {
            case basic_json::value_t::object:
N
cleanup  
Niels 已提交
8837
            {
8838 8839
                return (m_it.object_iterator == other.m_it.object_iterator);
            }
N
cleanup  
Niels 已提交
8840

8841 8842 8843 8844
            case basic_json::value_t::array:
            {
                return (m_it.array_iterator == other.m_it.array_iterator);
            }
N
cleanup  
Niels 已提交
8845

8846 8847 8848
            default:
            {
                return (m_it.primitive_iterator == other.m_it.primitive_iterator);
N
cleanup  
Niels 已提交
8849 8850
            }
        }
8851
    }
N
cleanup  
Niels 已提交
8852

8853 8854 8855 8856 8857 8858 8859 8860
    /*!
    @brief  comparison: not equal
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    bool operator!=(const iter_impl& other) const
    {
        return not operator==(other);
    }
N
cleanup  
Niels 已提交
8861

8862 8863 8864 8865 8866 8867 8868 8869
    /*!
    @brief  comparison: smaller
    @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 已提交
8870
        {
8871
                JSON_THROW(std::domain_error("cannot compare iterators of different containers"));
8872
        }
N
Niels 已提交
8873

8874
        assert(m_object != nullptr);
N
Niels 已提交
8875

8876 8877 8878
        switch (m_object->m_type)
        {
            case basic_json::value_t::object:
N
Niels 已提交
8879
            {
8880
                    JSON_THROW(std::domain_error("cannot compare order of object iterators"));
8881
            }
N
Niels 已提交
8882

8883 8884 8885 8886
            case basic_json::value_t::array:
            {
                return (m_it.array_iterator < other.m_it.array_iterator);
            }
N
Niels 已提交
8887

8888 8889 8890
            default:
            {
                return (m_it.primitive_iterator < other.m_it.primitive_iterator);
N
Niels 已提交
8891 8892
            }
        }
8893
    }
N
Niels 已提交
8894

8895 8896 8897 8898 8899 8900 8901 8902
    /*!
    @brief  comparison: less than or equal
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    bool operator<=(const iter_impl& other) const
    {
        return not other.operator < (*this);
    }
N
Niels 已提交
8903

8904 8905 8906 8907 8908 8909 8910 8911
    /*!
    @brief  comparison: greater than
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    bool operator>(const iter_impl& other) const
    {
        return not operator<=(other);
    }
N
Niels 已提交
8912

8913 8914 8915 8916 8917 8918 8919 8920
    /*!
    @brief  comparison: greater than or equal
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    bool operator>=(const iter_impl& other) const
    {
        return not operator<(other);
    }
N
Niels 已提交
8921

8922 8923 8924 8925 8926 8927 8928
    /*!
    @brief  add to iterator
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    iter_impl& operator+=(difference_type i)
    {
        assert(m_object != nullptr);
N
Niels 已提交
8929

8930 8931 8932
        switch (m_object->m_type)
        {
            case basic_json::value_t::object:
N
Niels 已提交
8933
            {
8934
                    JSON_THROW(std::domain_error("cannot use offsets with object iterators"));
8935
            }
N
Niels 已提交
8936

8937 8938 8939 8940
            case basic_json::value_t::array:
            {
                std::advance(m_it.array_iterator, i);
                break;
N
Niels 已提交
8941 8942
            }

8943 8944 8945 8946 8947
            default:
            {
                m_it.primitive_iterator += i;
                break;
            }
N
Niels 已提交
8948 8949
        }

8950 8951
        return *this;
    }
N
Niels 已提交
8952

8953 8954 8955 8956 8957 8958 8959 8960
    /*!
    @brief  subtract from iterator
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    iter_impl& operator-=(difference_type i)
    {
        return operator+=(-i);
    }
N
Niels 已提交
8961

8962 8963 8964 8965 8966 8967 8968 8969 8970 8971
    /*!
    @brief  add to iterator
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    iter_impl operator+(difference_type i)
    {
        auto result = *this;
        result += i;
        return result;
    }
N
Niels 已提交
8972

8973 8974 8975 8976 8977 8978 8979 8980 8981 8982
    /*!
    @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 已提交
8983

8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994
    /*!
    @brief  return difference
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    difference_type operator-(const iter_impl& other) const
    {
        assert(m_object != nullptr);

        switch (m_object->m_type)
        {
            case basic_json::value_t::object:
N
Niels 已提交
8995
            {
8996
                    JSON_THROW(std::domain_error("cannot use offsets with object iterators"));
8997
            }
N
Niels 已提交
8998

8999 9000 9001 9002
            case basic_json::value_t::array:
            {
                return m_it.array_iterator - other.m_it.array_iterator;
            }
N
Niels 已提交
9003

9004 9005 9006
            default:
            {
                return m_it.primitive_iterator - other.m_it.primitive_iterator;
N
Niels 已提交
9007 9008
            }
        }
9009
    }
N
Niels 已提交
9010

9011 9012 9013 9014 9015 9016 9017
    /*!
    @brief  access to successor
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    reference operator[](difference_type n) const
    {
        assert(m_object != nullptr);
N
Niels 已提交
9018

9019 9020 9021
        switch (m_object->m_type)
        {
            case basic_json::value_t::object:
N
Niels 已提交
9022
            {
9023
                    JSON_THROW(std::domain_error("cannot use operator[] for object iterators"));
9024
            }
N
Niels 已提交
9025

9026 9027 9028 9029
            case basic_json::value_t::array:
            {
                return *std::next(m_it.array_iterator, n);
            }
N
Niels 已提交
9030

9031 9032
            case basic_json::value_t::null:
            {
9033
                    JSON_THROW(std::out_of_range("cannot get value"));
9034
            }
N
Niels 已提交
9035

9036 9037 9038
            default:
            {
                if (m_it.primitive_iterator.get_value() == -n)
N
Niels 已提交
9039
                {
9040 9041
                    return *m_object;
                }
N
Niels Lohmann 已提交
9042

9043
                    JSON_THROW(std::out_of_range("cannot get value"));
N
Niels 已提交
9044 9045
            }
        }
9046
    }
N
Niels 已提交
9047

9048 9049 9050 9051 9052 9053 9054
    /*!
    @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
    {
        assert(m_object != nullptr);
N
Niels 已提交
9055

9056 9057 9058 9059
        if (m_object->is_object())
        {
            return m_it.object_iterator->first;
        }
N
Niels Lohmann 已提交
9060

9061
            JSON_THROW(std::domain_error("cannot use key() for non-object iterators"));
9062
    }
N
Niels 已提交
9063

9064 9065 9066 9067 9068 9069 9070 9071
    /*!
    @brief  return the value of an iterator
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    reference value() const
    {
        return operator*();
    }
N
Niels 已提交
9072

9073 9074 9075 9076 9077 9078
    private:
    /// associated JSON instance
    pointer m_object = nullptr;
    /// the actual iterator of the associated instance
    internal_iterator m_it = internal_iterator();
                       };
N
cleanup  
Niels 已提交
9079

N
Niels 已提交
9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093
    /*!
    @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 已提交
9094

N
Niels 已提交
9095
    @since version 1.0.0
N
Niels 已提交
9096
    */
N
Niels 已提交
9097
    template<typename Base>
9098
  class json_reverse_iterator : public std::reverse_iterator<Base>
9099
    {
9100
        public:
9101
        /// shortcut to the reverse iterator adaptor
N
Niels 已提交
9102
        using base_iterator = std::reverse_iterator<Base>;
N
Niels 已提交
9103
        /// the reference type for the pointed-to element
N
Niels 已提交
9104
        using reference = typename Base::reference;
9105

9106
        /// create reverse iterator from iterator
N
Niels 已提交
9107
        json_reverse_iterator(const typename base_iterator::iterator_type& it) noexcept
9108 9109
        : base_iterator(it)
    {}
9110

9111 9112 9113 9114
    /// create reverse iterator from base class
    json_reverse_iterator(const base_iterator& it) noexcept
    : base_iterator(it)
    {}
9115

9116 9117 9118 9119 9120
    /// post-increment (it++)
    json_reverse_iterator operator++(int)
    {
        return base_iterator::operator++(1);
    }
9121

9122 9123 9124 9125 9126 9127
    /// pre-increment (++it)
    json_reverse_iterator& operator++()
    {
        base_iterator::operator++();
        return *this;
    }
9128

9129 9130 9131 9132 9133
    /// post-decrement (it--)
    json_reverse_iterator operator--(int)
    {
        return base_iterator::operator--(1);
    }
9134

9135 9136 9137 9138 9139 9140
    /// pre-decrement (--it)
    json_reverse_iterator& operator--()
    {
        base_iterator::operator--();
        return *this;
    }
9141

9142 9143 9144 9145 9146 9147
    /// add to iterator
    json_reverse_iterator& operator+=(difference_type i)
    {
        base_iterator::operator+=(i);
        return *this;
    }
9148

9149 9150 9151 9152 9153 9154 9155
    /// add to iterator
    json_reverse_iterator operator+(difference_type i) const
    {
        auto result = *this;
        result += i;
        return result;
    }
9156

9157 9158 9159 9160 9161 9162 9163
    /// subtract from iterator
    json_reverse_iterator operator-(difference_type i) const
    {
        auto result = *this;
        result -= i;
        return result;
    }
9164

9165 9166 9167 9168 9169
    /// return difference
    difference_type operator-(const json_reverse_iterator& other) const
    {
        return this->base() - other.base();
    }
N
Niels 已提交
9170

9171 9172 9173 9174 9175
    /// access to successor
    reference operator[](difference_type n) const
    {
        return *(this->operator+(n));
    }
9176

9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190
    /// return the key of an object iterator
    typename object_t::key_type key() const
    {
        auto it = --this->base();
        return it.key();
    }

    /// return the value of an iterator
    reference value() const
    {
        auto it = --this->base();
        return it.operator * ();
    }
                                                   };
9191

N
Niels 已提交
9192

N
Niels 已提交
9193
  private:
N
Niels 已提交
9194 9195 9196
    //////////////////////
    // lexer and parser //
    //////////////////////
N
Niels 已提交
9197

N
Niels 已提交
9198 9199 9200 9201
    /*!
    @brief lexical analysis

    This class organizes the lexical analysis during JSON deserialization. The
N
Niels 已提交
9202 9203
    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 已提交
9204
    */
N
Niels 已提交
9205
    class lexer
N
Niels 已提交
9206
    {
9207
        public:
N
Niels 已提交
9208 9209
        /// token types for the parser
        enum class token_type
9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225
    {
        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
        value_number,    ///< a number -- use get_number() for actual value
        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 已提交
9226

9227 9228
    /// the char type to use in the lexer
    using lexer_char_t = unsigned char;
N
Niels 已提交
9229

9230 9231 9232 9233 9234 9235 9236 9237
    /// 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 已提交
9238

9239 9240 9241 9242 9243 9244
    /// a lexer from an input stream
    explicit lexer(std::istream& s)
    : m_stream(&s), m_line_buffer()
    {
        // immediately abort if stream is erroneous
        if (s.fail())
9245
        {
9246
                JSON_THROW(std::invalid_argument("stream error"));
N
Niels 已提交
9247 9248
        }

9249 9250
        // fill buffer
        fill_line_buffer();
N
Niels 已提交
9251

9252 9253 9254 9255 9256 9257 9258 9259
        // 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] = ' ';
        }
    }
N
Niels 已提交
9260

9261 9262 9263 9264
    // switch off unwanted functions (due to pointer members)
    lexer() = delete;
    lexer(const lexer&) = delete;
    lexer operator=(const lexer&) = delete;
N
Niels 已提交
9265

9266 9267
    /*!
    @brief create a string from one or two Unicode code points
N
Niels 已提交
9268

9269 9270 9271 9272
    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 已提交
9273

9274 9275
    @param[in] codepoint1  the code point (can be high surrogate)
    @param[in] codepoint2  the code point (can be low surrogate or 0)
N
Niels 已提交
9276

9277 9278
    @return string representation of the code point; the length of the
    result string is between 1 and 4 characters.
N
Niels 已提交
9279

9280 9281 9282 9283
    @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 已提交
9284

9285
    @complexity Constant.
N
Niels 已提交
9286

9287 9288 9289 9290 9291 9292 9293
    @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)
    {
        // calculate the code point from the given code points
        std::size_t codepoint = codepoint1;
N
Niels 已提交
9294

9295 9296 9297 9298 9299
        // check if codepoint1 is a high surrogate
        if (codepoint1 >= 0xD800 and codepoint1 <= 0xDBFF)
        {
            // check if codepoint2 is a low surrogate
            if (codepoint2 >= 0xDC00 and codepoint2 <= 0xDFFF)
N
Niels 已提交
9300
            {
9301 9302 9303 9304 9305 9306 9307 9308 9309
                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;
N
Niels 已提交
9310 9311 9312
            }
            else
            {
9313
                    JSON_THROW(std::invalid_argument("missing or wrong low surrogate"));
N
Niels 已提交
9314 9315 9316
            }
        }

9317 9318 9319
        string_t result;

        if (codepoint < 0x80)
N
cleanup  
Niels 已提交
9320
        {
9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386
            // 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
        {
                JSON_THROW(std::out_of_range("code points above 0x10FFFF are invalid"));
        }

        return result;
    }

    /// return name of values of type token_type (only used for errors)
    static std::string token_type_name(const token_type t)
    {
        switch (t)
        {
            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";
            case token_type::value_number:
                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:
N
cleanup  
Niels 已提交
9387
            {
9388 9389
                // catch non-enum values
                return "unknown token"; // LCOV_EXCL_LINE
N
cleanup  
Niels 已提交
9390 9391
            }
        }
9392
    }
N
cleanup  
Niels 已提交
9393

9394 9395 9396 9397 9398 9399 9400
    /*!
    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 已提交
9401

9402
    @return the class of the next token read from the buffer
N
Niels 已提交
9403

9404
    @complexity Linear in the length of the input.\n
N
Niels 已提交
9405

9406
    Proposition: The loop below will always terminate for finite input.\n
N
Niels 已提交
9407

9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555
    Proof (by contradiction): Assume a finite input. To loop forever, the
    loop must never hit code with a `break` statement. The only code
    snippets without a `break` statement are the continue statements for
    whitespace and byte-order-marks. To loop forever, the input must be an
    infinite sequence of whitespace or byte-order-marks. This contradicts
    the assumption of finite input, q.e.d.
    */
    token_type scan()
    {
        while (true)
        {
            // pointer for backtracking information
            m_marker = nullptr;

            // remember the begin of the token
            m_start = m_cursor;
            assert(m_start != nullptr);

            /*!re2c
                re2c:define:YYCTYPE      = lexer_char_t;
                re2c:define:YYCURSOR     = m_cursor;
                re2c:define:YYLIMIT      = m_limit;
                re2c:define:YYMARKER     = m_marker;
                re2c:define:YYFILL       = "fill_line_buffer(@@); // LCOV_EXCL_LINE";
                re2c:define:YYFILL:naked = 1;
                re2c:yyfill:enable       = 1;
                re2c:indent:string       = "    ";
                re2c:indent:top          = 1;
                re2c:labelprefix         = "basic_json_parser_";

                // ignore whitespace
                ws = [ \t\n\r]+;
                ws   { continue; }

                // structural characters
                "[" { last_token_type = token_type::begin_array; break; }
                "]" { last_token_type = token_type::end_array; break; }
                "{" { last_token_type = token_type::begin_object; break; }
                "}" { last_token_type = token_type::end_object; break; }
                "," { last_token_type = token_type::value_separator; break; }
                ":" { last_token_type = token_type::name_separator; break; }

                // literal names
                "null"  { last_token_type = token_type::literal_null; break; }
                "true"  { last_token_type = token_type::literal_true; break; }
                "false" { last_token_type = token_type::literal_false; break; }

                // number
                decimal_point = ".";
                digit         = [0-9];
                digit_1_9     = [1-9];
                e             = "e" | "E";
                minus         = "-";
                plus          = "+";
                zero          = "0";
                exp           = e (minus | plus)? digit+;
                frac          = decimal_point digit+;
                int           = (zero | digit_1_9 digit*);
                number        = minus? int frac? exp?;
                number        { last_token_type = token_type::value_number; break; }

                // string
                quotation_mark  = "\"";
                escape          = "\\";
                unescaped       = [^"\\\x00-\x1f];
                single_escaped  = "\"" | "\\" | "/" | "b" | "f" | "n" | "r" | "t";
                unicode_escaped = "u" [0-9a-fA-F]{4};
                escaped         = escape (single_escaped | unicode_escaped);
                char            = unescaped | escaped;
                string          = quotation_mark char* quotation_mark;
                string          { last_token_type = token_type::value_string; break; }

                // end of file
                "\x00"         { last_token_type = token_type::end_of_input; break; }

                // anything else is an error
                *              { last_token_type = token_type::parse_error; break; }
            */
        }

        return last_token_type;
    }

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

        // 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());

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

        // number of processed characters (p)
            const auto num_processed_chars = static_cast<size_t>(m_start - m_content);
        // offset for m_marker wrt. to m_start
        const auto offset_marker = (m_marker == nullptr) ? 0 : m_marker - m_start;
        // number of unprocessed characters (u)
        const auto offset_cursor = m_cursor - m_start;

        // 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
            // this point. We trust the standand library to do the right
            // thing. See http://stackoverflow.com/q/28142011/266378
            m_line_buffer.assign(m_start, m_limit);

            // 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');
N
Niels 已提交
9556
            }
9557 9558 9559 9560 9561 9562 9563 9564
        }
        else
        {
            // delete processed characters from line buffer
            m_line_buffer.erase(0, num_processed_chars);
            // read next line from input stream
            m_line_buffer_tmp.clear();
            std::getline(*m_stream, m_line_buffer_tmp, '\n');
N
Niels 已提交
9565

9566 9567 9568
            // add line with newline symbol to the line buffer
            m_line_buffer += m_line_buffer_tmp;
            m_line_buffer.push_back('\n');
N
Niels 已提交
9569 9570
        }

9571 9572 9573 9574 9575 9576 9577 9578
        // 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 Lohmann 已提交
9579

9580 9581 9582 9583 9584 9585 9586
    /// 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));
    }
N
Niels Lohmann 已提交
9587

9588 9589
    /*!
    @brief return string value for string tokens
N
Niels Lohmann 已提交
9590

9591 9592 9593 9594
    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.
9595

9596
    We differentiate two cases:
9597

9598 9599 9600 9601 9602 9603 9604
    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.
N
Niels 已提交
9605

9606 9607 9608
    @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).
9609

9610 9611 9612
        " c1 c2 c3 ... "
        ^                ^
        m_start          m_cursor
N
Niels 已提交
9613

9614
    @complexity Linear in the length of the string.\n
N
Niels 已提交
9615

9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647
    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
    indefinitly if i is always decreased. However, observe that the value
    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);
N
Niels 已提交
9648

9649 9650
        string_t result;
        result.reserve(static_cast<size_t>(m_cursor - m_start - 2));
N
Niels 已提交
9651

9652 9653 9654 9655 9656 9657
        // iterate the result between the quotes
        for (const lexer_char_t* i = m_start + 1; i < m_cursor - 1; ++i)
        {
            // find next escape character
            auto e = std::find(i, m_cursor - 1, '\\');
            if (e != i)
N
Niels 已提交
9658
            {
9659 9660
                // see https://github.com/nlohmann/json/issues/365#issuecomment-262874705
                for (auto k = i; k < e; k++)
N
Niels 已提交
9661
                {
9662
                    result.push_back(static_cast<typename string_t::value_type>(*k));
N
Niels 已提交
9663
                }
9664 9665 9666 9667 9668 9669 9670 9671 9672
                i = e - 1; // -1 because of ++i
            }
            else
            {
                // processing escaped character
                // read next character
                ++i;

                switch (*i)
N
Niels 已提交
9673
                {
9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714
                    // 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 已提交
9715

9716 9717
                    // unicode
                    case 'u':
N
Niels 已提交
9718
                    {
9719 9720 9721
                        // 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);
N
Niels 已提交
9722

9723 9724
                        // check if codepoint is a high surrogate
                        if (codepoint >= 0xD800 and codepoint <= 0xDBFF)
N
Niels 已提交
9725
                        {
9726 9727
                            // make sure there is a subsequent unicode
                            if ((i + 6 >= m_limit) or * (i + 5) != '\\' or * (i + 6) != 'u')
N
Niels 已提交
9728
                            {
9729
                                    JSON_THROW(std::invalid_argument("missing low surrogate"));
N
Niels 已提交
9730
                            }
9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741

                            // 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;
                        }
                        else if (codepoint >= 0xDC00 and codepoint <= 0xDFFF)
                        {
                            // we found a lone low surrogate
9742
                                JSON_THROW(std::invalid_argument("missing high surrogate"));
N
Niels 已提交
9743
                        }
9744 9745 9746 9747 9748 9749 9750 9751
                        else
                        {
                            // add unicode character(s)
                            result += to_unicode(codepoint);
                            // skip the next four characters (xxxx)
                            i += 4;
                        }
                        break;
N
Niels 已提交
9752 9753 9754
                    }
                }
            }
N
Niels 已提交
9755 9756
        }

9757 9758
        return result;
    }
9759

9760 9761
    /*!
    @brief parse floating point number
9762

9763 9764 9765 9766
    This function (and its overloads) serves to select the most approprate
    standard floating point number parsing function based on the type
    supplied via the first parameter.  Set this to @a
    static_cast<number_float_t*>(nullptr).
9767

9768 9769
    @param[in,out] endptr recieves a pointer to the first character after
    the number
N
Niels 已提交
9770

9771 9772 9773 9774 9775 9776
    @return the floating point number
    */
    long double str_to_float_t(long double* /* type */, char** endptr) const
    {
        return std::strtold(reinterpret_cast<typename string_t::const_pointer>(m_start), endptr);
    }
N
Niels 已提交
9777

9778 9779
    /*!
    @brief parse floating point number
9780

9781 9782 9783 9784
    This function (and its overloads) serves to select the most approprate
    standard floating point number parsing function based on the type
    supplied via the first parameter.  Set this to @a
    static_cast<number_float_t*>(nullptr).
9785

9786 9787
    @param[in,out] endptr  recieves a pointer to the first character after
    the number
9788

9789 9790 9791 9792 9793 9794
    @return the floating point number
    */
    double str_to_float_t(double* /* type */, char** endptr) const
    {
        return std::strtod(reinterpret_cast<typename string_t::const_pointer>(m_start), endptr);
    }
9795

9796 9797
    /*!
    @brief parse floating point number
9798

9799 9800 9801 9802
    This function (and its overloads) serves to select the most approprate
    standard floating point number parsing function based on the type
    supplied via the first parameter.  Set this to @a
    static_cast<number_float_t*>(nullptr).
9803

9804 9805
    @param[in,out] endptr  recieves a pointer to the first character after
    the number
9806

9807 9808 9809 9810 9811 9812
    @return the floating point number
    */
    float str_to_float_t(float* /* type */, char** endptr) const
    {
        return std::strtof(reinterpret_cast<typename string_t::const_pointer>(m_start), endptr);
    }
N
Niels 已提交
9813

9814 9815
    /*!
    @brief return number value for number tokens
N
Niels 已提交
9816

9817 9818 9819
    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.
N
Niels 已提交
9820

9821 9822 9823 9824 9825 9826
    This function parses the integer component up to the radix point or
    exponent while collecting information about the 'floating point
    representation', which it stores in the result parameter. If there is
    no radix point or exponent, and the number can fit into a @ref
    number_integer_t or @ref number_unsigned_t then it sets the result
    parameter accordingly.
N
Niels 已提交
9827

9828 9829
    If the number is a floating point number the number is then parsed
    using @a std:strtod (or @a std:strtof or @a std::strtold).
N
Niels 已提交
9830

9831 9832 9833 9834 9835 9836 9837
    @param[out] result  @ref basic_json object to receive the number, or
    NAN if the conversion read past the current token. The latter case
    needs to be treated by the caller function.
    */
    void get_number(basic_json& result) const
    {
        assert(m_start != nullptr);
N
Niels 已提交
9838

9839
        const lexer::lexer_char_t* curptr = m_start;
N
Niels 已提交
9840

9841 9842
        // accumulate the integer conversion result (unsigned for now)
        number_unsigned_t value = 0;
N
Niels 已提交
9843

9844 9845
        // maximum absolute value of the relevant integer type
        number_unsigned_t max;
N
Niels 已提交
9846

9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867
        // temporarily store the type to avoid unecessary bitfield access
        value_t type;

        // look for sign
        if (*curptr == '-')
        {
            type = value_t::number_integer;
            max = static_cast<uint64_t>((std::numeric_limits<number_integer_t>::max)()) + 1;
            curptr++;
        }
        else
        {
            type = value_t::number_unsigned;
            max = static_cast<uint64_t>((std::numeric_limits<number_unsigned_t>::max)());
        }

        // count the significant figures
        for (; curptr < m_cursor; curptr++)
        {
            // quickly skip tests if a digit
            if (*curptr < '0' || *curptr > '9')
9868
            {
9869
                if (*curptr == '.')
N
Niels 已提交
9870
                {
9871
                    // don't count '.' but change to float
N
Niels 已提交
9872
                    type = value_t::number_float;
9873
                    continue;
N
Niels 已提交
9874
                }
9875 9876 9877 9878
                // assume exponent (if not then will fail parse): change to
                // float, stop counting and record exponent details
                type = value_t::number_float;
                break;
9879
            }
N
Niels 已提交
9880

9881 9882
            // skip if definitely not an integer
            if (type != value_t::number_float)
N
Niels 已提交
9883
            {
9884
                auto digit = static_cast<number_unsigned_t>(*curptr - '0');
N
Niels Lohmann 已提交
9885

9886 9887 9888
                // overflow if value * 10 + digit > max, move terms around
                // to avoid overflow in intermediate values
                if (value > (max - digit) / 10)
N
Niels Lohmann 已提交
9889
                {
9890 9891
                    // overflow
                    type = value_t::number_float;
N
Niels Lohmann 已提交
9892 9893 9894
                }
                else
                {
9895 9896
                    // no overflow
                    value = value * 10 + digit;
N
Niels Lohmann 已提交
9897
                }
N
Niels 已提交
9898
            }
9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918
        }

        // save the value (if not a float)
        if (type == value_t::number_unsigned)
        {
            result.m_value.number_unsigned = value;
        }
        else if (type == value_t::number_integer)
        {
            // invariant: if we parsed a '-', the absolute value is between
            // 0 (we allow -0) and max == -INT64_MIN
            assert(value >= 0);
            assert(value <= max);

            if (value == max)
            {
                // we cannot simply negate value (== max == -INT64_MIN),
                // see https://github.com/nlohmann/json/issues/389
                result.m_value.number_integer = static_cast<number_integer_t>(INT64_MIN);
            }
N
Niels 已提交
9919
            else
9920
            {
9921 9922 9923 9924 9925 9926 9927
                // all other values can be negated safely
                result.m_value.number_integer = -static_cast<number_integer_t>(value);
            }
        }
        else
        {
            // parse with strtod
N
Niels Lohmann 已提交
9928
                result.m_value.number_float = str_to_float_t(static_cast<number_float_t*>(nullptr), nullptr);
N
Niels 已提交
9929

9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961
            // replace infinity and NAN by null
            if (not std::isfinite(result.m_value.number_float))
            {
                type = value_t::null;
                result.m_value = basic_json::json_value();
            }
        }

        // save the type
        result.m_type = type;
    }

    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 已提交
9962

N
Niels 已提交
9963 9964
    /*!
    @brief syntax analysis
N
Niels 已提交
9965 9966

    This class implements a recursive decent parser.
N
Niels 已提交
9967
    */
N
Niels 已提交
9968 9969
    class parser
    {
9970
        public:
9971
        /// a parser reading from a string literal
N
Niels 已提交
9972
        parser(const char* buff, const parser_callback_t cb = nullptr)
9973 9974 9975
        : callback(cb),
        m_lexer(reinterpret_cast<const typename lexer::lexer_char_t*>(buff), std::strlen(buff))
    {}
9976

9977 9978 9979 9980
    /// a parser reading from an input stream
    parser(std::istream& is, const parser_callback_t cb = nullptr)
    : callback(cb), m_lexer(is)
    {}
9981

9982 9983 9984 9985 9986 9987 9988 9989 9990 9991
    /// 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
Niels 已提交
9992

9993 9994 9995 9996 9997
    /// public parser interface
    basic_json parse()
    {
        // read first token
        get_token();
N
cleanup  
Niels 已提交
9998

9999 10000
        basic_json result = parse_internal(true);
        result.assert_invariant();
N
Niels 已提交
10001

10002
        expect(lexer::token_type::end_of_input);
N
Niels 已提交
10003

10004 10005 10006 10007
        // 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 已提交
10008

10009 10010 10011 10012 10013
    private:
    /// the actual parser
    basic_json parse_internal(bool keep)
    {
        auto result = basic_json(value_t::discarded);
N
Niels 已提交
10014

10015 10016 10017
        switch (last_token)
        {
            case lexer::token_type::begin_object:
N
Niels 已提交
10018
            {
10019 10020
                if (keep and (not callback
                              or ((keep = callback(depth++, parse_event_t::object_start, result)) != 0)))
N
Niels 已提交
10021
                {
10022 10023 10024 10025
                    // explicitly set result to object to cope with {}
                    result.m_type = value_t::object;
                    result.m_value = value_t::object;
                }
N
Niels 已提交
10026

10027 10028
                // read next token
                get_token();
N
Niels 已提交
10029

10030 10031 10032
                // closing } -> we are done
                if (last_token == lexer::token_type::end_object)
                {
N
Niels 已提交
10033
                    get_token();
10034
                    if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
N
Niels 已提交
10035 10036 10037
                    {
                        result = basic_json(value_t::discarded);
                    }
N
Niels 已提交
10038
                    return result;
N
Niels 已提交
10039 10040
                }

10041 10042
                // no comma is expected here
                unexpect(lexer::token_type::value_separator);
N
Niels 已提交
10043

10044 10045 10046 10047 10048
                // otherwise: parse key-value pairs
                do
                {
                    // ugly, but could be fixed with loop reorganization
                    if (last_token == lexer::token_type::value_separator)
N
Niels 已提交
10049
                    {
N
Niels 已提交
10050
                        get_token();
N
Niels 已提交
10051 10052
                    }

10053 10054 10055
                    // store key
                    expect(lexer::token_type::value_string);
                    const auto key = m_lexer.get_string();
N
Niels 已提交
10056

10057 10058
                    bool keep_tag = false;
                    if (keep)
N
Niels 已提交
10059
                    {
10060
                        if (callback)
N
Niels 已提交
10061
                        {
10062 10063
                            basic_json k(key);
                            keep_tag = callback(depth, parse_event_t::key, k);
N
Niels 已提交
10064
                        }
10065
                        else
N
Niels 已提交
10066
                        {
10067
                            keep_tag = true;
N
Niels 已提交
10068
                        }
N
Niels 已提交
10069 10070
                    }

10071 10072 10073 10074 10075
                    // parse separator (:)
                    get_token();
                    expect(lexer::token_type::name_separator);

                    // parse and add value
N
Niels 已提交
10076
                    get_token();
10077 10078
                    auto value = parse_internal(keep);
                    if (keep and keep_tag and not value.is_discarded())
N
Niels 已提交
10079
                    {
10080
                        result[key] = std::move(value);
N
Niels 已提交
10081
                    }
N
Niels 已提交
10082
                }
10083
                while (last_token == lexer::token_type::value_separator);
N
Niels 已提交
10084

10085 10086 10087 10088
                // closing }
                expect(lexer::token_type::end_object);
                get_token();
                if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
N
Niels 已提交
10089
                {
10090
                    result = basic_json(value_t::discarded);
N
Niels 已提交
10091 10092
                }

10093 10094
                return result;
            }
N
Niels 已提交
10095

10096 10097 10098 10099
            case lexer::token_type::begin_array:
            {
                if (keep and (not callback
                              or ((keep = callback(depth++, parse_event_t::array_start, result)) != 0)))
N
Niels 已提交
10100
                {
10101 10102 10103
                    // explicitly set result to object to cope with []
                    result.m_type = value_t::array;
                    result.m_value = value_t::array;
N
Niels 已提交
10104 10105
                }

10106 10107 10108 10109 10110
                // read next token
                get_token();

                // closing ] -> we are done
                if (last_token == lexer::token_type::end_array)
N
Niels 已提交
10111
                {
N
Niels 已提交
10112
                    get_token();
10113 10114 10115 10116 10117
                    if (callback and not callback(--depth, parse_event_t::array_end, result))
                    {
                        result = basic_json(value_t::discarded);
                    }
                    return result;
N
Niels 已提交
10118 10119
                }

10120 10121 10122 10123 10124
                // no comma is expected here
                unexpect(lexer::token_type::value_separator);

                // otherwise: parse values
                do
N
Niels 已提交
10125
                {
10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137
                    // ugly, but could be fixed with loop reorganization
                    if (last_token == lexer::token_type::value_separator)
                    {
                        get_token();
                    }

                    // parse value
                    auto value = parse_internal(keep);
                    if (keep and not value.is_discarded())
                    {
                        result.push_back(std::move(value));
                    }
N
Niels 已提交
10138
                }
10139
                while (last_token == lexer::token_type::value_separator);
N
Niels 已提交
10140

10141 10142 10143 10144
                // closing ]
                expect(lexer::token_type::end_array);
                get_token();
                if (keep and callback and not callback(--depth, parse_event_t::array_end, result))
N
Niels 已提交
10145
                {
10146
                    result = basic_json(value_t::discarded);
N
Niels 已提交
10147
                }
10148 10149

                return result;
N
Niels 已提交
10150
            }
N
Niels 已提交
10151

10152
            case lexer::token_type::literal_null:
N
Niels 已提交
10153
            {
10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192 10193
                get_token();
                result.m_type = value_t::null;
                break;
            }

            case lexer::token_type::value_string:
            {
                const auto s = m_lexer.get_string();
                get_token();
                result = basic_json(s);
                break;
            }

            case lexer::token_type::literal_true:
            {
                get_token();
                result.m_type = value_t::boolean;
                result.m_value = true;
                break;
            }

            case lexer::token_type::literal_false:
            {
                get_token();
                result.m_type = value_t::boolean;
                result.m_value = false;
                break;
            }

            case lexer::token_type::value_number:
            {
                m_lexer.get_number(result);
                get_token();
                break;
            }

            default:
            {
                // the last token was unexpected
                unexpect(last_token);
N
Niels 已提交
10194
            }
N
Niels 已提交
10195 10196
        }

10197
        if (keep and callback and not callback(depth, parse_event_t::value, result))
N
Niels 已提交
10198
        {
10199
            result = basic_json(value_t::discarded);
N
Niels 已提交
10200
        }
10201 10202 10203 10204 10205 10206 10207 10208 10209
        return result;
    }

    /// get next token from lexer
    typename lexer::token_type get_token()
    {
        last_token = m_lexer.scan();
        return last_token;
    }
N
Niels 已提交
10210

10211 10212 10213
    void expect(typename lexer::token_type t) const
    {
        if (t != last_token)
N
Niels 已提交
10214
        {
10215 10216 10217 10218 10219
            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);
10220
                JSON_THROW(std::invalid_argument(error_msg));
N
Niels 已提交
10221
        }
10222
    }
N
Niels 已提交
10223

10224 10225 10226
    void unexpect(typename lexer::token_type t) const
    {
        if (t == last_token)
N
Niels 已提交
10227
        {
10228 10229 10230 10231
            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));
10232
                JSON_THROW(std::invalid_argument(error_msg));
N
Niels 已提交
10233
        }
10234
    }
N
Niels 已提交
10235

10236 10237 10238 10239 10240 10241 10242 10243 10244 10245
    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 已提交
10246 10247

  public:
N
Niels 已提交
10248 10249 10250
    /*!
    @brief JSON Pointer

N
Niels 已提交
10251 10252 10253 10254
    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 已提交
10255
    @sa [RFC 6901](https://tools.ietf.org/html/rfc6901)
N
Niels 已提交
10256 10257

    @since version 2.0.0
N
Niels 已提交
10258
    */
N
Niels 已提交
10259 10260
    class json_pointer
    {
N
Niels 已提交
10261 10262 10263
        /// allow basic_json to access private members
        friend class basic_json;

10264
        public:
N
Niels 已提交
10265 10266 10267 10268 10269 10270 10271 10272 10273 10274
        /*!
        @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 已提交
10275 10276 10277 10278 10279 10280
        @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 已提交
10281 10282 10283

        @liveexample{The example shows the construction several valid JSON
        pointers as well as the exceptional behavior.,json_pointer}
N
Niels 已提交
10284

N
Niels 已提交
10285 10286 10287
        @since version 2.0.0
        */
        explicit json_pointer(const std::string& s = "")
10288 10289
        : reference_tokens(split(s))
    {}
N
Niels 已提交
10290

10291 10292
    /*!
    @brief return a string representation of the JSON pointer
N
Niels 已提交
10293

10294 10295 10296 10297
    @invariant For each JSON pointer `ptr`, it holds:
    @code {.cpp}
    ptr == json_pointer(ptr.to_string());
    @endcode
N
Niels 已提交
10298

10299
    @return a string representation of the JSON pointer
N
Niels 已提交
10300

10301 10302
    @liveexample{The example shows the result of `to_string`.,
    json_pointer__to_string}
N
Niels 已提交
10303

10304 10305 10306 10307 10308 10309 10310
    @since version 2.0.0
    */
    std::string to_string() const noexcept
    {
        return std::accumulate(reference_tokens.begin(),
                               reference_tokens.end(), std::string{},
                               [](const std::string & a, const std::string & b)
N
Niels 已提交
10311
        {
10312 10313 10314
            return a + "/" + escape(b);
        });
    }
N
Niels 已提交
10315

10316 10317 10318 10319 10320
    /// @copydoc to_string()
    operator std::string() const
    {
        return to_string();
    }
N
Niels 已提交
10321

10322 10323 10324 10325 10326
    private:
    /// remove and return last reference pointer
    std::string pop_back()
    {
        if (is_root())
N
Niels 已提交
10327
        {
10328
                JSON_THROW(std::domain_error("JSON pointer has no parent"));
N
Niels 已提交
10329 10330
        }

10331 10332 10333 10334 10335 10336 10337 10338 10339 10340
        auto last = reference_tokens.back();
        reference_tokens.pop_back();
        return last;
    }

    /// return whether pointer points to the root document
    bool is_root() const
    {
        return reference_tokens.empty();
    }
N
Niels 已提交
10341

10342 10343 10344
    json_pointer top() const
    {
        if (is_root())
N
Niels 已提交
10345
        {
10346
                JSON_THROW(std::domain_error("JSON pointer has no parent"));
N
Niels 已提交
10347 10348
        }

10349 10350 10351 10352
        json_pointer result = *this;
        result.reference_tokens = {reference_tokens[0]};
        return result;
    }
N
Niels 已提交
10353

10354 10355
    /*!
    @brief create and return a reference to the pointed to value
N
Niels 已提交
10356

10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367
    @complexity Linear in the number of reference tokens.
    */
    reference get_and_create(reference j) const
    {
        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)
        {
            switch (result->m_type)
N
Niels 已提交
10368
            {
10369
                case value_t::null:
N
Niels 已提交
10370
                {
10371
                    if (reference_token == "0")
N
Niels 已提交
10372
                    {
10373 10374
                        // start a new array if reference token is 0
                        result = &result->operator[](0);
N
Niels 已提交
10375
                    }
10376
                    else
N
Niels 已提交
10377
                    {
10378
                        // start a new object otherwise
N
Niels 已提交
10379 10380
                        result = &result->operator[](reference_token);
                    }
10381 10382
                    break;
                }
N
Niels 已提交
10383

10384 10385 10386 10387 10388 10389
                case value_t::object:
                {
                    // create an entry in the object
                    result = &result->operator[](reference_token);
                    break;
                }
N
Niels 已提交
10390

10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406
                case value_t::array:
                {
                    // create an entry in the array
                    result = &result->operator[](static_cast<size_type>(std::stoi(reference_token)));
                    break;
                }

                /*
                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:
                {
10407
                        JSON_THROW(std::domain_error("invalid value to unflatten"));
N
Niels 已提交
10408 10409
                }
            }
10410 10411
        }

10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424
        return *result;
    }

    /*!
    @brief return a reference to the pointed to value

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

    @param[in] ptr  a JSON value
N
Niels 已提交
10425

10426
    @return reference to the JSON value pointed to by the JSON pointer
N
Niels 已提交
10427

10428
    @complexity Linear in the length of the JSON pointer.
N
Niels 已提交
10429

10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447
    @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
    {
        for (const auto& reference_token : reference_tokens)
        {
            // convert null values to arrays or objects before continuing
            if (ptr->m_type == value_t::null)
            {
                // check if reference token is a number
                const bool nums = std::all_of(reference_token.begin(),
                                              reference_token.end(),
                                              [](const char x)
                {
                    return std::isdigit(x);
                });
N
Niels 已提交
10448

10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459
                // change value to array for numbers or "-" or to object
                // otherwise
                if (nums or reference_token == "-")
                {
                    *ptr = value_t::array;
                }
                else
                {
                    *ptr = value_t::object;
                }
            }
N
Niels 已提交
10460

10461
            switch (ptr->m_type)
N
Niels 已提交
10462
            {
10463 10464 10465 10466 10467 10468 10469 10470
                case value_t::object:
                {
                    // use unchecked object access
                    ptr = &ptr->operator[](reference_token);
                    break;
                }

                case value_t::array:
N
Niels 已提交
10471
                {
10472 10473
                    // error condition (cf. RFC 6901, Sect. 4)
                    if (reference_token.size() > 1 and reference_token[0] == '0')
N
Niels 已提交
10474
                    {
10475 10476
                            JSON_THROW(std::domain_error("array index must not begin with '0'"));
                    }
N
Niels 已提交
10477

10478
                    if (reference_token == "-")
N
Niels 已提交
10479
                    {
10480 10481
                        // explicityly treat "-" as index beyond the end
                        ptr = &ptr->operator[](ptr->m_value.array->size());
N
Niels 已提交
10482 10483 10484
                    }
                    else
                    {
10485 10486
                        // convert array index to number; unchecked access
                        ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
N
Niels 已提交
10487
                    }
10488
                    break;
N
Niels 已提交
10489 10490
                }

10491
                default:
N
Niels 已提交
10492
                {
10493
                        JSON_THROW(std::out_of_range("unresolved reference token '" + reference_token + "'"));
N
Niels 已提交
10494 10495 10496
                }
            }
        }
N
Niels 已提交
10497

10498 10499 10500 10501 10502 10503
        return *ptr;
    }

    reference get_checked(pointer ptr) const
    {
        for (const auto& reference_token : reference_tokens)
N
Niels 已提交
10504
        {
10505
            switch (ptr->m_type)
N
Niels 已提交
10506
            {
10507
                case value_t::object:
N
Niels 已提交
10508
                {
10509 10510 10511 10512 10513 10514 10515 10516
                    // note: at performs range check
                    ptr = &ptr->at(reference_token);
                    break;
                }

                case value_t::array:
                {
                    if (reference_token == "-")
N
Niels 已提交
10517
                    {
10518 10519 10520 10521
                        // "-" always fails the range check
                        throw std::out_of_range("array index '-' (" +
                                                std::to_string(ptr->m_value.array->size()) +
                                                ") is out of range");
N
Niels 已提交
10522 10523
                    }

10524 10525
                    // error condition (cf. RFC 6901, Sect. 4)
                    if (reference_token.size() > 1 and reference_token[0] == '0')
N
Niels 已提交
10526
                    {
10527
                            JSON_THROW(std::domain_error("array index must not begin with '0'"));
N
Niels 已提交
10528 10529
                    }

10530 10531 10532 10533 10534 10535 10536
                    // note: at performs range check
                    ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
                    break;
                }

                default:
                {
10537
                        JSON_THROW(std::out_of_range("unresolved reference token '" + reference_token + "'"));
N
Niels 已提交
10538 10539 10540 10541
                }
            }
        }

10542 10543 10544 10545 10546
        return *ptr;
    }

    /*!
    @brief return a const reference to the pointed to value
N
Niels 已提交
10547

10548
    @param[in] ptr  a JSON value
N
Niels 已提交
10549

10550 10551 10552 10553 10554 10555
    @return const reference to the JSON value pointed to by the JSON
            pointer
    */
    const_reference get_unchecked(const_pointer ptr) const
    {
        for (const auto& reference_token : reference_tokens)
N
Niels 已提交
10556
        {
10557
            switch (ptr->m_type)
N
Niels 已提交
10558
            {
10559
                case value_t::object:
N
Niels 已提交
10560
                {
10561 10562 10563 10564 10565 10566 10567 10568
                    // use unchecked object access
                    ptr = &ptr->operator[](reference_token);
                    break;
                }

                case value_t::array:
                {
                    if (reference_token == "-")
N
Niels 已提交
10569
                    {
10570 10571 10572 10573
                        // "-" cannot be used for const access
                        throw std::out_of_range("array index '-' (" +
                                                std::to_string(ptr->m_value.array->size()) +
                                                ") is out of range");
N
Niels 已提交
10574 10575
                    }

10576 10577
                    // error condition (cf. RFC 6901, Sect. 4)
                    if (reference_token.size() > 1 and reference_token[0] == '0')
N
Niels 已提交
10578
                    {
10579
                            JSON_THROW(std::domain_error("array index must not begin with '0'"));
N
Niels 已提交
10580 10581
                    }

10582 10583 10584 10585 10586 10587 10588
                    // use unchecked array access
                    ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
                    break;
                }

                default:
                {
10589
                        JSON_THROW(std::out_of_range("unresolved reference token '" + reference_token + "'"));
N
Niels 已提交
10590 10591 10592 10593
                }
            }
        }

10594 10595 10596 10597 10598 10599
        return *ptr;
    }

    const_reference get_checked(const_pointer ptr) const
    {
        for (const auto& reference_token : reference_tokens)
10600
        {
10601
            switch (ptr->m_type)
10602
            {
10603
                case value_t::object:
10604
                {
10605 10606 10607 10608 10609 10610 10611 10612
                    // note: at performs range check
                    ptr = &ptr->at(reference_token);
                    break;
                }

                case value_t::array:
                {
                    if (reference_token == "-")
N
Niels 已提交
10613
                    {
10614 10615 10616 10617
                        // "-" always fails the range check
                        throw std::out_of_range("array index '-' (" +
                                                std::to_string(ptr->m_value.array->size()) +
                                                ") is out of range");
N
Niels 已提交
10618
                    }
10619

10620 10621
                    // error condition (cf. RFC 6901, Sect. 4)
                    if (reference_token.size() > 1 and reference_token[0] == '0')
N
Niels 已提交
10622
                    {
10623
                            JSON_THROW(std::domain_error("array index must not begin with '0'"));
N
Niels 已提交
10624
                    }
10625

10626 10627 10628 10629 10630 10631 10632
                    // note: at performs range check
                    ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
                    break;
                }

                default:
                {
10633
                        JSON_THROW(std::out_of_range("unresolved reference token '" + reference_token + "'"));
10634 10635
                }
            }
N
Niels 已提交
10636 10637
        }

10638 10639
        return *ptr;
    }
N
Niels 已提交
10640

10641 10642 10643 10644
    /// split the string input to reference tokens
    static std::vector<std::string> split(const std::string& reference_string)
    {
        std::vector<std::string> result;
N
Niels 已提交
10645

10646 10647 10648 10649 10650 10651 10652 10653 10654
        // 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] != '/')
        {
10655
                JSON_THROW(std::domain_error("JSON pointer must be empty or begin with '/'"));
10656
        }
N
Niels 已提交
10657

10658 10659 10660 10661 10662
        // 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 已提交
10663
                size_t slash = reference_string.find_first_of('/', 1),
10664 10665 10666 10667 10668 10669 10670 10671
            // 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 已提交
10672
                slash = reference_string.find_first_of('/', start))
10673 10674 10675 10676
        {
            // 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 已提交
10677

10678
            // check reference tokens are properly escaped
N
Niels Lohmann 已提交
10679
                for (size_t pos = reference_token.find_first_of('~');
10680
                    pos != std::string::npos;
N
Niels Lohmann 已提交
10681
                        pos = reference_token.find_first_of('~', pos + 1))
10682 10683
            {
                assert(reference_token[pos] == '~');
N
Niels 已提交
10684

10685 10686 10687 10688 10689
                // ~ 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'))
                {
10690
                        JSON_THROW(std::domain_error("escape error: '~' must be followed with '0' or '1'"));
N
Niels 已提交
10691
                }
10692
            }
N
Niels 已提交
10693

10694 10695 10696
            // finally, store the reference token
            unescape(reference_token);
            result.push_back(reference_token);
N
Niels 已提交
10697
        }
N
Niels 已提交
10698

10699 10700
        return result;
    }
N
Niels 已提交
10701

10702 10703 10704
    private:
    /*!
    @brief replace all occurrences of a substring by another string
N
Niels 已提交
10705

10706 10707 10708 10709
    @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 已提交
10710

10711
    @pre The search string @a f must not be empty.
N
Niels 已提交
10712

10713 10714 10715 10716 10717 10718 10719
    @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 已提交
10720

10721 10722 10723 10724 10725 10726 10727
        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 已提交
10728

10729 10730 10731 10732 10733 10734 10735 10736
    /// 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 已提交
10737

10738 10739 10740 10741 10742 10743 10744 10745
    /// 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 已提交
10746

10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758
    /*!
    @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

    @note Empty objects or arrays are flattened to `null`.
    */
    static void flatten(const std::string& reference_string,
                        const basic_json& value,
                        basic_json& result)
    {
        switch (value.m_type)
N
Niels 已提交
10759
        {
10760
            case value_t::array:
N
Niels 已提交
10761
            {
10762
                if (value.m_value.array->empty())
N
Niels 已提交
10763
                {
10764 10765 10766 10767 10768 10769 10770
                    // flatten empty array as null
                    result[reference_string] = nullptr;
                }
                else
                {
                    // iterate array and use index as reference string
                    for (size_t i = 0; i < value.m_value.array->size(); ++i)
N
Niels 已提交
10771
                    {
10772 10773
                        flatten(reference_string + "/" + std::to_string(i),
                                value.m_value.array->operator[](i), result);
N
Niels 已提交
10774 10775
                    }
                }
10776 10777
                break;
            }
N
Niels 已提交
10778

10779 10780 10781
            case value_t::object:
            {
                if (value.m_value.object->empty())
N
Niels 已提交
10782
                {
10783 10784 10785 10786 10787 10788 10789
                    // flatten empty object as null
                    result[reference_string] = nullptr;
                }
                else
                {
                    // iterate object and use keys as reference string
                    for (const auto& element : *value.m_value.object)
N
Niels 已提交
10790
                    {
10791 10792
                        flatten(reference_string + "/" + escape(element.first),
                                element.second, result);
N
Niels 已提交
10793 10794
                    }
                }
10795 10796
                break;
            }
N
Niels 已提交
10797

10798 10799 10800 10801 10802
            default:
            {
                // add primitive value with its reference string
                result[reference_string] = value;
                break;
N
Niels 已提交
10803 10804
            }
        }
10805
    }
N
Niels 已提交
10806

10807 10808
    /*!
    @param[in] value  flattened JSON
N
Niels 已提交
10809

10810 10811 10812 10813 10814
    @return unflattened JSON
    */
    static basic_json unflatten(const basic_json& value)
    {
        if (not value.is_object())
N
Niels 已提交
10815
        {
10816
                JSON_THROW(std::domain_error("only objects can be unflattened"));
10817
        }
N
Niels 已提交
10818

10819
        basic_json result;
N
Niels 已提交
10820

10821 10822 10823 10824
        // iterate the JSON object values
        for (const auto& element : *value.m_value.object)
        {
            if (not element.second.is_primitive())
N
Niels 已提交
10825
            {
10826
                    JSON_THROW(std::domain_error("values in object must be primitive"));
N
Niels 已提交
10827 10828
            }

10829 10830 10831 10832 10833 10834
            // 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 已提交
10835
        }
N
Niels 已提交
10836

10837 10838 10839 10840
        return result;
    }

    private:
10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852
    friend bool operator==(json_pointer const &lhs,
                           json_pointer const &rhs) noexcept
    {
      return lhs.reference_tokens == rhs.reference_tokens;
    }

    friend bool operator!=(json_pointer const &lhs,
                           json_pointer const &rhs) noexcept
    {
      return !(lhs == rhs);
    }

10853 10854
    /// the reference tokens
    std::vector<std::string> reference_tokens {};
10855
    };
N
Niels 已提交
10856

N
Niels 已提交
10857 10858 10859
    //////////////////////////
    // JSON Pointer support //
    //////////////////////////
N
Niels 已提交
10860 10861 10862 10863

    /// @name JSON Pointer functions
    /// @{

N
Niels 已提交
10864 10865 10866 10867
    /*!
    @brief access specified element via JSON Pointer

    Uses a JSON pointer to retrieve a reference to the respective JSON value.
N
Niels 已提交
10868 10869 10870
    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 已提交
10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956

    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 已提交
10957 10958
    Returns a const reference to the element at with specified JSON pointer @a
    ptr, with bounds checking.
N
Niels 已提交
10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978

    @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 已提交
10979
    /*!
N
Niels 已提交
10980 10981
    @brief return flattened JSON value

N
Niels 已提交
10982 10983 10984 10985
    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 已提交
10986

N
Niels 已提交
10987
    @return an object that maps JSON pointers to primitve values
N
Niels 已提交
10988

N
Niels 已提交
10989 10990
    @note Empty objects and arrays are flattened to `null` and will not be
          reconstructed correctly by the @ref unflatten() function.
N
Niels 已提交
10991 10992 10993 10994 10995 10996 10997 10998 10999

    @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 已提交
11000 11001 11002 11003 11004 11005 11006
    */
    basic_json flatten() const
    {
        basic_json result(value_t::object);
        json_pointer::flatten("", *this, result);
        return result;
    }
N
Niels 已提交
11007 11008

    /*!
N
Niels 已提交
11009 11010 11011 11012 11013 11014 11015 11016 11017 11018
    @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 已提交
11019
    @return the original JSON from a flattened version
N
Niels 已提交
11020 11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033

    @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 已提交
11034
    */
N
Niels 已提交
11035
    basic_json unflatten() const
N
Niels 已提交
11036
    {
N
Niels 已提交
11037
        return json_pointer::unflatten(*this);
N
Niels 已提交
11038
    }
N
Niels 已提交
11039 11040

    /// @}
11041

N
Niels 已提交
11042 11043 11044 11045 11046 11047 11048
    //////////////////////////
    // JSON Patch functions //
    //////////////////////////

    /// @name JSON Patch functions
    /// @{

11049 11050 11051
    /*!
    @brief applies a JSON patch

N
Niels 已提交
11052 11053 11054 11055 11056
    [JSON Patch](http://jsonpatch.com) defines a JSON document structure for
    expressing a sequence of operations to apply to a JSON) document. With
    this funcion, a JSON Patch is applied to the current JSON value by
    executing all operations from the patch.

N
Niels 已提交
11057
    @param[in] json_patch  JSON patch document
11058 11059
    @return patched document

N
Niels 已提交
11060 11061 11062 11063 11064 11065 11066 11067 11068 11069
    @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"`
11070

N
Niels 已提交
11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083
    @complexity Linear in the size of the JSON value and the length of the
    JSON patch. As usually only a fraction of the JSON value is affected by
    the patch, the complexity can usually be neglected.

    @liveexample{The following code shows how a JSON patch is applied to a
    value.,patch}

    @sa @ref diff -- create a JSON patch by comparing two JSON values

    @sa [RFC 6902 (JSON Patch)](https://tools.ietf.org/html/rfc6902)
    @sa [RFC 6901 (JSON Pointer)](https://tools.ietf.org/html/rfc6901)

    @since version 2.0.0
11084
    */
N
Niels 已提交
11085
    basic_json patch(const basic_json& json_patch) const
11086
    {
N
Niels 已提交
11087
        // make a working copy to apply the patch to
11088 11089
        basic_json result = *this;

N
Niels 已提交
11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122
        // the valid JSON Patch operations
        enum class patch_operations {add, remove, replace, move, copy, test, invalid};

        const auto get_op = [](const std::string op)
        {
            if (op == "add")
            {
                return patch_operations::add;
            }
            if (op == "remove")
            {
                return patch_operations::remove;
            }
            if (op == "replace")
            {
                return patch_operations::replace;
            }
            if (op == "move")
            {
                return patch_operations::move;
            }
            if (op == "copy")
            {
                return patch_operations::copy;
            }
            if (op == "test")
            {
                return patch_operations::test;
            }

            return patch_operations::invalid;
        };

N
Niels 已提交
11123
        // wrapper for "add" operation; add value at ptr
N
Niels 已提交
11124
        const auto operation_add = [&result](json_pointer & ptr, basic_json val)
N
Niels 已提交
11125
        {
N
Niels 已提交
11126 11127
            // adding to the root of the target document means replacing it
            if (ptr.is_root())
N
Niels 已提交
11128
            {
N
Niels 已提交
11129
                result = val;
N
Niels 已提交
11130
            }
N
Niels 已提交
11131
            else
N
Niels 已提交
11132
            {
N
Niels 已提交
11133 11134 11135
                // make sure the top element of the pointer exists
                json_pointer top_pointer = ptr.top();
                if (top_pointer != ptr)
N
Niels 已提交
11136
                {
N
Niels 已提交
11137
                    result.at(top_pointer);
N
Niels 已提交
11138
                }
N
Niels 已提交
11139 11140 11141 11142 11143 11144

                // 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 已提交
11145
                {
N
Niels 已提交
11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164 11165 11166
                    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
11167
                                JSON_THROW(std::out_of_range("array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179
                            }
                            else
                            {
                                // default case: insert add offset
                                parent.insert(parent.begin() + static_cast<difference_type>(idx), val);
                            }
                        }
                        break;
                    }

                    default:
                    {
N
Niels 已提交
11180 11181
                        // if there exists a parent it cannot be primitive
                        assert(false);  // LCOV_EXCL_LINE
N
Niels 已提交
11182
                    }
N
Niels 已提交
11183 11184 11185 11186
                }
            }
        };

N
Niels 已提交
11187
        // wrapper for "remove" operation; remove value at ptr
N
Niels 已提交
11188 11189
        const auto operation_remove = [&result](json_pointer & ptr)
        {
N
Niels 已提交
11190
            // get reference to parent of JSON pointer ptr
N
Niels 已提交
11191 11192
            const auto last_path = ptr.pop_back();
            basic_json& parent = result.at(ptr);
N
Niels 已提交
11193 11194

            // remove child
N
Niels 已提交
11195 11196
            if (parent.is_object())
            {
N
Niels 已提交
11197 11198 11199 11200 11201 11202 11203 11204
                // perform range check
                auto it = parent.find(last_path);
                if (it != parent.end())
                {
                    parent.erase(it);
                }
                else
                {
11205
                    JSON_THROW(std::out_of_range("key '" + last_path + "' not found"));
N
Niels 已提交
11206
                }
N
Niels 已提交
11207 11208 11209
            }
            else if (parent.is_array())
            {
N
Niels 已提交
11210 11211
                // note erase performs range check
                parent.erase(static_cast<size_type>(std::stoi(last_path)));
N
Niels 已提交
11212 11213 11214
            }
        };

N
Niels 已提交
11215
        // type check
N
Niels 已提交
11216
        if (not json_patch.is_array())
N
Niels 已提交
11217 11218
        {
            // a JSON patch must be an array of objects
11219
            JSON_THROW(std::invalid_argument("JSON patch must be an array of objects"));
N
Niels 已提交
11220 11221 11222
        }

        // iterate and apply th eoperations
N
Niels 已提交
11223
        for (const auto& val : json_patch)
11224
        {
N
Niels 已提交
11225 11226 11227
            // wrapper to get a value for an operation
            const auto get_value = [&val](const std::string & op,
                                          const std::string & member,
N
Niels 已提交
11228
                                          bool string_type) -> basic_json&
11229
            {
N
Niels 已提交
11230 11231
                // find value
                auto it = val.m_value.object->find(member);
11232

N
Niels 已提交
11233 11234
                // context-sensitive error message
                const auto error_msg = (op == "op") ? "operation" : "operation '" + op + "'";
11235

N
Niels 已提交
11236 11237 11238
                // check if desired value is present
                if (it == val.m_value.object->end())
                {
11239
                    JSON_THROW(std::invalid_argument(error_msg + " must have member '" + member + "'"));
N
Niels 已提交
11240
                }
11241

N
Niels 已提交
11242 11243 11244
                // check if result is of type string
                if (string_type and not it->second.is_string())
                {
11245
                    JSON_THROW(std::invalid_argument(error_msg + " must have string member '" + member + "'"));
N
Niels 已提交
11246 11247 11248 11249 11250 11251 11252 11253
                }

                // no error: return value
                return it->second;
            };

            // type check
            if (not val.is_object())
11254
            {
11255
                JSON_THROW(std::invalid_argument("JSON patch must be an array of objects"));
11256 11257
            }

N
Niels 已提交
11258 11259 11260
            // collect mandatory members
            const std::string op = get_value("op", "op", true);
            const std::string path = get_value(op, "path", true);
N
oops  
Niels 已提交
11261
            json_pointer ptr(path);
11262

N
Niels 已提交
11263
            switch (get_op(op))
11264
            {
N
Niels 已提交
11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313
                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;
11314
                    JSON_TRY
N
Niels 已提交
11315 11316 11317 11318 11319
                    {
                        // check if "value" matches the one at "path"
                        // the "path" location must exist - use at()
                        success = (result.at(ptr) == get_value("test", "value", false));
                    }
11320
                    JSON_CATCH (std::out_of_range&)
N
Niels 已提交
11321 11322 11323 11324 11325 11326 11327
                    {
                        // ignore out of range errors: success remains false
                    }

                    // throw an exception if test fails
                    if (not success)
                    {
11328
                        JSON_THROW(std::domain_error("unsuccessful: " + val.dump()));
N
Niels 已提交
11329 11330 11331 11332 11333 11334 11335 11336 11337
                    }

                    break;
                }

                case patch_operations::invalid:
                {
                    // op must be "add", "remove", "replace", "move", "copy", or
                    // "test"
11338
                    JSON_THROW(std::invalid_argument("operation value '" + op + "' is invalid"));
N
Niels 已提交
11339
                }
11340
            }
N
Niels 已提交
11341 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371 11372 11373 11374 11375 11376 11377 11378 11379
        }

        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.

    @param[in] source  JSON value to copare from
    @param[in] target  JSON value to copare against
    @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,
11380
                           const std::string& path = "")
N
Niels 已提交
11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394
    {
        // 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(
11395
            {
N
Niels 已提交
11396 11397 11398 11399 11400 11401 11402 11403
                {"op", "replace"},
                {"path", path},
                {"value", target}
            });
        }
        else
        {
            switch (source.type())
11404
            {
N
Niels 已提交
11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415
                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 已提交
11416

N
Niels 已提交
11417 11418
                    // i now reached the end of at least one array
                    // in a second pass, traverse the remaining elements
N
Niels 已提交
11419

N
Niels 已提交
11420
                    // remove my remaining elements
N
Niels 已提交
11421
                    const auto end_index = static_cast<difference_type>(result.size());
N
Niels 已提交
11422 11423
                    while (i < source.size())
                    {
N
Niels 已提交
11424 11425
                        // add operations in reverse order to avoid invalid
                        // indices
N
Niels 已提交
11426
                        result.insert(result.begin() + end_index, object(
N
Niels 已提交
11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449
                        {
                            {"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:
11450
                {
N
Niels 已提交
11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502
                    // 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;
11503 11504 11505 11506 11507 11508
                }
            }
        }

        return result;
    }
N
Niels 已提交
11509 11510

    /// @}
N
cleanup  
Niels 已提交
11511 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
//////////////////////////////////////////
// lexicographical comparison operators //
//////////////////////////////////////////

/// @name lexicographical comparison operators
/// @{
/*!
@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)];
}
N
cleanup  
Niels 已提交
11550 11551 11552 11553 11554

/////////////
// presets //
/////////////

N
Niels 已提交
11555 11556 11557
/*!
@brief default JSON class

N
Niels 已提交
11558 11559
This type is the default specialization of the @ref basic_json class which
uses the standard template types.
N
Niels 已提交
11560

N
Niels 已提交
11561
@since version 1.0.0
N
Niels 已提交
11562
*/
N
cleanup  
Niels 已提交
11563
using json = basic_json<>;
N
Niels Lohmann 已提交
11564
} // namespace nlohmann
N
cleanup  
Niels 已提交
11565 11566


N
Niels 已提交
11567 11568 11569
///////////////////////
// nonmember support //
///////////////////////
N
cleanup  
Niels 已提交
11570 11571 11572 11573

// specialization of std::swap, and std::hash
namespace std
{
N
Niels 已提交
11574
    /*!
11575
    @brief exchanges the values of two JSON objects
N
Niels 已提交
11576

N
Niels 已提交
11577
    @since version 1.0.0
N
Niels 已提交
11578
    */
11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598
    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>
    {
        /*!
        @brief return a hash value for a JSON object

        @since version 1.0.0
        */
        std::size_t operator()(const nlohmann::json& j) const
N
cleanup  
Niels 已提交
11599 11600
    {
        // a naive hashing via the string representation
N
Niels 已提交
11601 11602
        const auto& h = hash<nlohmann::json::string_t>();
        return h(j.dump());
N
cleanup  
Niels 已提交
11603
    }
11604
                        };
N
Niels Lohmann 已提交
11605
} // namespace std
N
cleanup  
Niels 已提交
11606

N
Niels 已提交
11607
/*!
N
Niels 已提交
11608 11609
@brief user-defined string literal for JSON values

N
Niels 已提交
11610
This operator implements a user-defined string literal for JSON objects. It
N
Niels 已提交
11611
can be used by adding `"_json"` to a string literal and returns a JSON object
N
Niels 已提交
11612
if no parse error occurred.
N
Niels 已提交
11613

N
Niels 已提交
11614
@param[in] s  a string representation of a JSON object
11615
@param[in] n  the length of string @a s
N
Niels 已提交
11616
@return a JSON object
N
Niels 已提交
11617

N
Niels 已提交
11618
@since version 1.0.0
N
Niels 已提交
11619
*/
11620
inline nlohmann::json operator "" _json(const char* s, std::size_t n)
N
Niels 已提交
11621
{
11622
    return nlohmann::json::parse(s, s + n);
N
Niels 已提交
11623 11624
}

N
Niels 已提交
11625 11626 11627
/*!
@brief user-defined string literal for JSON pointer

N
Niels 已提交
11628
This operator implements a user-defined string literal for JSON Pointers. It
S
Stefan Codrescu 已提交
11629
can be used by adding `"_json_pointer"` to a string literal and returns a JSON pointer
N
Niels 已提交
11630 11631 11632
object if no parse error occurred.

@param[in] s  a string representation of a JSON Pointer
11633
@param[in] n  the length of string @a s
N
Niels 已提交
11634 11635
@return a JSON pointer object

N
Niels 已提交
11636 11637
@since version 2.0.0
*/
11638
inline nlohmann::json::json_pointer operator "" _json_pointer(const char* s, std::size_t n)
N
Niels 已提交
11639
{
11640
    return nlohmann::json::json_pointer(std::string(s, n));
N
Niels 已提交
11641 11642
}

11643 11644 11645 11646 11647
// restore GCC/clang diagnostic settings
#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
    #pragma GCC diagnostic pop
#endif

11648 11649 11650 11651 11652 11653
// clean up
#undef JSON_THROW
#undef JSON_TRY
#undef JSON_CATCH
#undef JSON_DEPRECATED

N
cleanup  
Niels 已提交
11654
#endif