json.hpp 403.6 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
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
N
Niels 已提交
42 43 44 45 46 47
#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 已提交
48
#include <locale> // locale
N
Niels 已提交
49 50 51 52 53 54 55 56 57
#include <map> // map
#include <memory> // addressof, allocator, allocator_traits, unique_ptr
#include <numeric> // accumulate
#include <sstream> // stringstream
#include <stdexcept> // domain_error, invalid_argument, out_of_range
#include <string> // getline, stoi, string, to_string
#include <type_traits> // add_pointer, enable_if, is_arithmetic, is_base_of, is_const, is_constructible, is_convertible, is_floating_point, is_integral, is_nothrow_move_assignable, std::is_nothrow_move_constructible, std::is_pointer, std::is_reference, std::is_same, remove_const, remove_pointer, remove_reference
#include <utility> // declval, forward, make_pair, move, pair, swap
#include <vector> // vector
N
Niels 已提交
58

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

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

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

N
Niels 已提交
82 83 84 85 86 87 88 89 90
// 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

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

N
Niels 已提交
102
/*!
N
Niels 已提交
103
@brief namespace for Niels Lohmann
N
Niels 已提交
104
@see https://github.com/nlohmann
N
Niels 已提交
105
@since version 1.0.0
N
Niels 已提交
106 107 108
*/
namespace nlohmann
{
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148

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

/*!
@brief the JSON type enumeration

This enumeration collects the different JSON types. It is internally used
to distinguish the stored values, and the functions @ref is_null(), @ref
is_object(), @ref is_array(), @ref is_string(), @ref is_boolean(), @ref
is_number() (with @ref is_number_integer(), @ref is_number_unsigned(), and
@ref is_number_float()), @ref is_discarded(), @ref is_primitive(), and
@ref is_structured() rely on it.

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

@sa @ref basic_json(const value_t value_type) -- create a JSON value with
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
};

149 150 151 152 153 154 155 156 157 158
// alias templates to reduce boilerplate
template <bool B, typename T = void>
using enable_if_t = typename std::enable_if<B, T>::type;

template <typename T>
using remove_cv_t = typename std::remove_cv<T>::type;

template <typename T>
using remove_reference_t = typename std::remove_reference<T>::type;

159 160 161
template <typename T>
using uncvref_t = remove_cv_t<remove_reference_t<T>>;

162 163 164
template <bool If, typename Then, typename Else>
using conditional_t = typename std::conditional<If, Then, Else>::type;

T
Théo DELRIEU 已提交
165 166 167 168
// Taken from http://stackoverflow.com/questions/26936640/how-to-implement-is-enum-class-type-trait
template <typename T>
using is_scoped_enum =
    std::integral_constant<bool, not std::is_convertible<T, int>::value and
169
    std::is_enum<T>::value>;
T
Théo DELRIEU 已提交
170 171 172 173

template <typename T>
using is_unscoped_enum =
    std::integral_constant<bool, std::is_convertible<T, int>::value and
174
    std::is_enum<T>::value>;
T
Théo DELRIEU 已提交
175

176
// TODO update this doc
177 178
/*!
@brief unnamed namespace with internal helper functions
N
Niels 已提交
179
@since version 1.0.0
180
*/
181 182

namespace detail
N
Niels 已提交
183
{
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
template <typename Json> std::string type_name(Json const &j)
{
  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";
  }
}

N
Niels Lohmann 已提交
205 206
// very useful construct against boilerplate (more boilerplate needed than in
// C++17: http://en.cppreference.com/w/cpp/types/void_t)
207 208 209 210
template <typename...> struct make_void
{
    using type = void;
};
T
Théo DELRIEU 已提交
211 212
template <typename... Ts> using void_t = typename make_void<Ts...>::type;

213 214 215 216 217 218 219 220 221 222 223
// Implementation of 3 C++17 constructs: conjunction, disjunction, negation.
// 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)
224 225 226 227
template <class...> struct conjunction : std::true_type {};
template <class B1> struct conjunction<B1> : B1 {};
template <class B1, class... Bn>
struct conjunction<B1, Bn...>
228
: conditional_t<bool(B1::value), conjunction<Bn...>, B1> {};
T
Théo Delrieu 已提交
229

230
template <class B> struct negation : std::integral_constant < bool, !B::value > {};
231 232 233 234
template <class...> struct disjunction : std::false_type {};
template <class B1> struct disjunction<B1> : B1 {};
template <class B1, class... Bn>
struct disjunction<B1, Bn...>
235
: conditional_t<bool(B1::value), B1, disjunction<Bn...>> {};
236

237 238
/*!
@brief Helper to determine whether there's a key_type for T.
N
Niels Lohmann 已提交
239 240

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

244
@sa http://stackoverflow.com/a/7728728/266378
N
Niels 已提交
245
@since version 1.0.0, overworked in version 2.0.6
246
*/
N
Niels Lohmann 已提交
247 248 249 250 251 252 253 254 255
#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; \
256
    };
T
Théo Delrieu 已提交
257

N
Niels Lohmann 已提交
258 259 260 261
NLOHMANN_JSON_HAS_HELPER(mapped_type);
NLOHMANN_JSON_HAS_HELPER(key_type);
NLOHMANN_JSON_HAS_HELPER(value_type);
NLOHMANN_JSON_HAS_HELPER(iterator);
T
Théo Delrieu 已提交
262 263

#undef NLOHMANN_JSON_HAS_HELPER
264

T
Théo DELRIEU 已提交
265
template <bool B, class RealType, class CompatibleObjectType>
266
struct is_compatible_object_type_impl : std::false_type {};
T
Théo DELRIEU 已提交
267 268 269 270

template <class RealType, class CompatibleObjectType>
struct is_compatible_object_type_impl<true, RealType, CompatibleObjectType>
{
271 272 273 274 275
    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 已提交
276 277
};

278
template<class RealType, class CompatibleObjectType>
T
Théo DELRIEU 已提交
279 280
struct is_compatible_object_type
{
N
Niels Lohmann 已提交
281 282
    // As noted ahead, we need to stop evaluating traits if
    // `CompatibleObjectType = void`, hence the conjunction
283 284 285 286 287
    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,
                                  RealType, CompatibleObjectType >::value;
T
Théo DELRIEU 已提交
288 289 290
};

template <bool B, class BasicJson, class CompatibleArrayType>
291
struct is_compatible_array_type_impl : std::false_type {};
T
Théo DELRIEU 已提交
292 293 294 295

template <class BasicJson, class CompatibleArrayType>
struct is_compatible_array_type_impl<true, BasicJson, CompatibleArrayType>
{
296 297 298 299 300 301 302 303 304 305 306 307 308
    static constexpr auto value =
        not std::is_same<CompatibleArrayType,
        typename BasicJson::iterator>::value and
        not std::is_same<CompatibleArrayType,
        typename BasicJson::const_iterator>::value and
        not std::is_same<CompatibleArrayType,
        typename BasicJson::reverse_iterator>::value and
        not std::is_same<CompatibleArrayType,
        typename BasicJson::const_reverse_iterator>::value and
        not std::is_same<CompatibleArrayType,
        typename BasicJson::array_t::iterator>::value and
        not std::is_same<CompatibleArrayType,
        typename BasicJson::array_t::const_iterator>::value;
T
Théo DELRIEU 已提交
309 310 311 312 313
};

template <class BasicJson, class CompatibleArrayType>
struct is_compatible_array_type
{
N
Niels Lohmann 已提交
314 315
    // the check for CompatibleArrayType = void is done in
    // `is_compatible_object_type`, but we need the conjunction here as well
316 317 318 319 320 321
    static auto constexpr value = is_compatible_array_type_impl <
                                  conjunction<negation<is_compatible_object_type<
                                  typename BasicJson::object_t, CompatibleArrayType>>,
                                  has_value_type<CompatibleArrayType>,
                                  has_iterator<CompatibleArrayType>>::value,
                                  BasicJson, CompatibleArrayType >::value;
T
Théo DELRIEU 已提交
322 323
};

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

T
Théo DELRIEU 已提交
327
template <typename RealIntegerType, typename CompatibleNumberIntegerType>
328
struct is_compatible_integer_type_impl<true, RealIntegerType, CompatibleNumberIntegerType>
T
Théo DELRIEU 已提交
329
{
330 331 332 333 334 335 336 337
    using RealLimits = std::numeric_limits<RealIntegerType>;
    using CompatibleLimits = std::numeric_limits<CompatibleNumberIntegerType>;

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

340 341 342
template <typename RealIntegerType, typename CompatibleNumberIntegerType>
struct is_compatible_integer_type
{
343 344 345
    static constexpr auto value = is_compatible_integer_type_impl <
                                  std::is_arithmetic<CompatibleNumberIntegerType>::value, RealIntegerType,
                                  CompatibleNumberIntegerType >::value;
346 347
};

T
Théo DELRIEU 已提交
348 349 350
template <typename RealFloat, typename CompatibleFloat>
struct is_compatible_float_type
{
351 352 353
    static constexpr auto value =
        std::is_constructible<RealFloat, CompatibleFloat>::value and
        std::is_floating_point<CompatibleFloat>::value;
T
Théo DELRIEU 已提交
354 355
};

356 357 358
template <typename T, typename BasicJson>
struct is_compatible_basic_json_type
{
359 360 361 362 363 364 365 366
    static auto constexpr value =
        is_unscoped_enum<T>::value or
        std::is_same<T, BasicJson>::value or
        std::is_constructible<typename BasicJson::string_t, T>::value or
        std::is_same<typename BasicJson::boolean_t, T>::value or
        is_compatible_array_type<BasicJson, T>::value or
        is_compatible_object_type<typename BasicJson::object_t, T>::value or
        is_compatible_float_type<typename BasicJson::number_float_t, T>::value or
N
Niels Lohmann 已提交
367
        is_compatible_integer_type<typename BasicJson::number_integer_t, T>::value or
368 369
        is_compatible_integer_type<typename BasicJson::number_unsigned_t,
        T>::value;
370 371
};

T
Théo Delrieu 已提交
372 373 374
template <typename T, typename BasicJson, typename PrimitiveIterator>
struct is_basic_json_nested_class
{
375 376 377 378 379 380
    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, PrimitiveIterator>::value or
                                  std::is_same<T, typename BasicJson::json_pointer>::value;
T
Théo Delrieu 已提交
381
};
T
Théo DELRIEU 已提交
382

383
// This trait checks if JSONSerializer<T>::from_json(json const&, udt&) exists
N
Niels Lohmann 已提交
384
template <template <typename, typename> class JSONSerializer, typename Json, typename T>
385 386
struct has_from_json
{
387 388 389 390 391 392
  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(...);
393

394 395 396
  public:
    static constexpr bool value = std::is_integral<decltype(
                                      detect(std::declval<JSONSerializer<T, void>>()))>::value;
397 398 399 400 401 402 403 404
};

// This trait checks if JSONSerializer<T>::from_json(json const&) exists
// this overload is used for non-default-constructible user-defined-types
template <template <typename, typename> class JSONSerializer, typename Json,
          typename T>
struct has_non_default_from_json
{
405 406 407 408
  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(...);
409

410 411 412
  public:
    static constexpr bool value = std::is_integral<decltype(
                                      detect(std::declval<JSONSerializer<T, void>>()))>::value;
413 414
};

T
Théo DELRIEU 已提交
415
// This trait checks if JSONSerializer<T>::to_json exists
416 417 418 419
template <template <typename, typename> class JSONSerializer, typename Json,
          typename T>
struct has_to_json
{
420 421 422 423 424
  private:
    template <typename U, typename = decltype(uncvref_t<U>::to_json(
                  std::declval<Json&>(), std::declval<T>()))>
    static int detect(U&&);
    static void detect(...);
425

426 427 428
  public:
    static constexpr bool value = std::is_integral<decltype(
                                      detect(std::declval<JSONSerializer<T, void>>()))>::value;
429 430
};

431
// those declarations are needed to workaround a MSVC bug related to ADL
T
Théo DELRIEU 已提交
432
// (taken from MSVC-Ranges implementation)
T
Théo Delrieu 已提交
433 434
void to_json();
void from_json();
435

436 437
struct to_json_fn
{
438 439 440 441 442 443 444 445 446
    // is it really useful to mark those as constexpr?
    template <typename Json, typename T>
    constexpr auto operator()(Json&& j, T&& val) const
    noexcept(noexcept(to_json(std::forward<Json>(j), std::forward<T>(val))))
    -> decltype(to_json(std::forward<Json>(j), std::forward<T>(val)),
                void())
    {
        return to_json(std::forward<Json>(j), std::forward<T>(val));
    }
447 448 449 450
};

struct from_json_fn
{
451 452 453 454 455 456 457
    template <typename Json, typename T>
    constexpr auto operator()(Json&& j, T& val) const
    noexcept(noexcept(from_json(std::forward<Json>(j), val)))
    -> decltype(from_json(std::forward<Json>(j), val), void())
    {
        return from_json(std::forward<Json>(j), val);
    }
458
};
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479

/*!
@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 '.';
    }
};

N
Niels 已提交
480

481 482 483
// taken from ranges-v3
// TODO add doc
template <typename T>
484
struct static_const
485
{
486
    static constexpr T value{};
487 488 489
};

template <typename T>
490
constexpr T static_const<T>::value;
491 492 493

inline namespace
{
494 495
constexpr auto const& to_json = static_const<detail::to_json_fn>::value;
constexpr auto const& from_json = static_const<detail::from_json_fn>::value;
496 497
}

498
// default JSONSerializer template argument, doesn't care about template argument
499
// will use ADL for serialization
500
template <typename = void, typename = void>
501 502
struct adl_serializer
{
503 504 505 506 507 508 509 510 511 512 513
    template <typename Json, typename T>
    static void from_json(Json&& j, T& val)
    {
        ::nlohmann::from_json(std::forward<Json>(j), val);
    }

    template <typename Json, typename T>
    static void to_json(Json& j, T&& val)
    {
        ::nlohmann::to_json(j, std::forward<T>(val));
    }
514 515
};

N
Niels 已提交
516
/*!
N
Niels 已提交
517
@brief a class to store JSON values
N
Niels 已提交
518

N
Niels 已提交
519
@tparam ObjectType type for JSON objects (`std::map` by default; will be used
N
Niels 已提交
520
in @ref object_t)
N
Niels 已提交
521
@tparam ArrayType type for JSON arrays (`std::vector` by default; will be used
N
Niels 已提交
522
in @ref array_t)
N
Niels 已提交
523
@tparam StringType type for JSON strings and object keys (`std::string` by
N
Niels 已提交
524
default; will be used in @ref string_t)
N
Niels 已提交
525
@tparam BooleanType type for JSON booleans (`bool` by default; will be used
N
Niels 已提交
526
in @ref boolean_t)
N
Niels 已提交
527
@tparam NumberIntegerType type for JSON integer numbers (`int64_t` by
N
Niels 已提交
528
default; will be used in @ref number_integer_t)
N
Niels 已提交
529 530
@tparam NumberUnsignedType type for JSON unsigned integer numbers (@c
`uint64_t` by default; will be used in @ref number_unsigned_t)
N
Niels 已提交
531
@tparam NumberFloatType type for JSON floating-point numbers (`double` by
N
Niels 已提交
532
default; will be used in @ref number_float_t)
N
Niels 已提交
533
@tparam AllocatorType type of the allocator to use (`std::allocator` by
N
Niels 已提交
534
default)
N
Niels 已提交
535

N
Niels 已提交
536 537
@requirement The class satisfies the following concept requirements:
- Basic
N
Niels 已提交
538
 - [DefaultConstructible](http://en.cppreference.com/w/cpp/concept/DefaultConstructible):
N
Niels Lohmann 已提交
539 540
   JSON values can be default constructed. The result will be a JSON null
   value.
N
Niels 已提交
541 542 543
 - [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 已提交
544
   A JSON value can be copy-constructed from an lvalue expression.
N
Niels 已提交
545 546 547 548 549 550
 - [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 已提交
551
- Layout
N
Niels 已提交
552 553 554
 - [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 已提交
555 556
   All non-static data members are private and standard layout types, the
   class has no virtual functions or (virtual) base classes.
N
Niels 已提交
557
- Library-wide
N
Niels 已提交
558 559 560 561 562 563 564 565 566 567 568 569
 - [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 已提交
570
- Container
N
Niels 已提交
571 572 573 574 575
 - [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 已提交
576

577 578 579 580 581 582 583
@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 已提交
584
@internal
N
Niels 已提交
585
@note ObjectType trick from http://stackoverflow.com/a/9860911
N
Niels 已提交
586
@endinternal
N
Niels 已提交
587

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

N
Niels 已提交
591
@since version 1.0.0
N
Niels 已提交
592 593

@nosubgrouping
N
Niels 已提交
594 595 596 597 598 599
*/
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,
600 601
    class NumberIntegerType = std::int64_t,
    class NumberUnsignedType = std::uint64_t,
N
Niels 已提交
602
    class NumberFloatType = double,
603
    template<typename U> class AllocatorType = std::allocator,
604
    template<typename T, typename SFINAE = void> class JSONSerializer = adl_serializer
N
Niels 已提交
605 606 607
    >
class basic_json
{
608
  private:
609
    template <typename Json> friend std::string detail::type_name(Json const &);
610
    /// workaround type for MSVC
N
Niels 已提交
611 612
    using basic_json_t = basic_json<ObjectType, ArrayType, StringType,
          BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType,
613
          AllocatorType, JSONSerializer>;
T
Théo Delrieu 已提交
614
    class primitive_iterator_t;
615 616

  public:
617
    using value_t = ::nlohmann::value_t;
N
Niels 已提交
618
    // forward declarations
N
Niels Lohmann 已提交
619
    template<typename U> class iter_impl;
N
Niels 已提交
620 621
    template<typename Base> class json_reverse_iterator;
    class json_pointer;
622

N
Niels 已提交
623 624 625 626
    /////////////////////
    // container types //
    /////////////////////

N
Niels 已提交
627
    /// @name container types
N
Niels 已提交
628 629
    /// The canonic container types to use @ref basic_json like any other STL
    /// container.
N
Niels 已提交
630 631
    /// @{

N
Niels 已提交
632
    /// the type of elements in a basic_json container
N
Niels 已提交
633
    using value_type = basic_json;
N
Niels 已提交
634

N
Niels 已提交
635
    /// the type of an element reference
N
Niels 已提交
636
    using reference = value_type&;
N
Niels 已提交
637
    /// the type of an element const reference
N
Niels 已提交
638
    using const_reference = const value_type&;
N
Niels 已提交
639

N
Niels 已提交
640
    /// a type to represent differences between iterators
N
Niels 已提交
641
    using difference_type = std::ptrdiff_t;
N
Niels 已提交
642
    /// a type to represent container sizes
N
Niels 已提交
643 644 645
    using size_type = std::size_t;

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

N
Niels 已提交
648
    /// the type of an element pointer
N
Niels 已提交
649
    using pointer = typename std::allocator_traits<allocator_type>::pointer;
N
Niels 已提交
650
    /// the type of an element const pointer
N
Niels 已提交
651
    using const_pointer = typename std::allocator_traits<allocator_type>::const_pointer;
N
Niels 已提交
652

N
Niels 已提交
653
    /// an iterator for a basic_json container
654
    using iterator = iter_impl<basic_json>;
N
Niels 已提交
655
    /// a const iterator for a basic_json container
656
    using const_iterator = iter_impl<const basic_json>;
N
Niels 已提交
657
    /// a reverse iterator for a basic_json container
N
Niels 已提交
658
    using reverse_iterator = json_reverse_iterator<typename basic_json::iterator>;
N
Niels 已提交
659
    /// a const reverse iterator for a basic_json container
N
Niels 已提交
660
    using const_reverse_iterator = json_reverse_iterator<typename basic_json::const_iterator>;
N
Niels 已提交
661

N
Niels 已提交
662 663 664
    /// @}


N
Niels 已提交
665 666 667
    /*!
    @brief returns the allocator associated with the container
    */
N
Niels 已提交
668
    static allocator_type get_allocator()
N
Niels 已提交
669 670 671 672
    {
        return allocator_type();
    }

673 674 675
    /*!
    @brief returns version information on the library
    */
676
    static basic_json meta()
677 678 679
    {
        basic_json result;

680
        result["copyright"] = "(C) 2013-2017 Niels Lohmann";
681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703
        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__)
704
        result["compiler"] = {{"family", "clang"}, {"version", __clang_version__}};
705 706 707
#elif defined(__ICC) || defined(__INTEL_COMPILER)
        result["compiler"] = {{"family", "icc"}, {"version", __INTEL_COMPILER}};
#elif defined(__GNUC__) || defined(__GNUG__)
708
        result["compiler"] = {{"family", "gcc"}, {"version", std::to_string(__GNUC__) + "." + std::to_string(__GNUC_MINOR__) + "." + std::to_string(__GNUC_PATCHLEVEL__)}};
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
#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 已提交
731

N
Niels 已提交
732 733 734 735
    ///////////////////////////
    // JSON value data types //
    ///////////////////////////

N
Niels 已提交
736
    /// @name JSON value data types
N
Niels 已提交
737 738
    /// The data types to store a JSON value. These types are derived from
    /// the template arguments passed to class @ref basic_json.
N
Niels 已提交
739 740
    /// @{

N
Niels 已提交
741 742 743 744 745 746 747 748
    /*!
    @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 已提交
749 750 751 752 753
    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 已提交
754 755
    @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 已提交
756 757 758
    inside the container.
    @tparam AllocatorType the allocator to use for objects (e.g.,
    `std::allocator`)
N
Niels 已提交
759 760 761 762

    #### Default type

    With the default values for @a ObjectType (`std::map`), @a StringType
N
Niels 已提交
763 764
    (`std::string`), and @a AllocatorType (`std::allocator`), the default
    value for @a object_t is:
N
Niels 已提交
765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780

    @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 已提交
781 782
      that all software implementations receiving that object will agree on
      the name-value mappings.
N
Niels 已提交
783 784 785 786 787
    - 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 已提交
788 789 790
      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 已提交
791 792 793 794 795 796 797 798 799 800 801 802
    - 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 已提交
803 804
    runtime environment. A theoretical limit can be queried by calling the
    @ref max_size function of a JSON object.
N
Niels 已提交
805 806 807

    #### Storage

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

812 813
    @sa @ref array_t -- type for an array value

N
Niels 已提交
814
    @since version 1.0.0
N
Niels 已提交
815

N
Niels 已提交
816 817 818 819 820
    @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 已提交
821 822
    7159](http://rfc7159.net/rfc7159), because any order implements the
    specified "unordered" nature of JSON objects.
N
Niels 已提交
823
    */
N
Niels 已提交
824 825 826 827 828
    using object_t = ObjectType<StringType,
          basic_json,
          std::less<StringType>,
          AllocatorType<std::pair<const StringType,
          basic_json>>>;
N
Niels 已提交
829 830 831 832 833 834 835

    /*!
    @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 已提交
836 837 838 839 840
    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 已提交
841
    @tparam AllocatorType allocator to use for arrays (e.g., `std::allocator`)
N
Niels 已提交
842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861

    #### 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 已提交
862 863
    runtime environment. A theoretical limit can be queried by calling the
    @ref max_size function of a JSON array.
N
Niels 已提交
864 865 866

    #### Storage

867
    Arrays are stored as pointers in a @ref basic_json type. That is, for any
N
Niels 已提交
868
    access to array values, a pointer of type `array_t*` must be dereferenced.
869 870 871

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

N
Niels 已提交
872
    @since version 1.0.0
N
Niels 已提交
873
    */
N
Niels 已提交
874
    using array_t = ArrayType<basic_json, AllocatorType<basic_json>>;
N
Niels 已提交
875 876 877 878 879 880 881

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

N
Niels 已提交
886 887
    @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 已提交
888 889 890 891 892 893 894 895 896 897

    #### Default type

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

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

898 899 900 901 902 903
    #### 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 已提交
904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
    #### 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

921 922
    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 已提交
923
    dereferenced.
924

N
Niels 已提交
925
    @since version 1.0.0
N
Niels 已提交
926
    */
N
Niels 已提交
927
    using string_t = StringType;
N
Niels 已提交
928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948

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

949 950
    Boolean values are stored directly inside a @ref basic_json type.

N
Niels 已提交
951
    @since version 1.0.0
N
Niels 已提交
952
    */
N
Niels 已提交
953
    using boolean_t = BooleanType;
N
Niels 已提交
954 955 956 957 958

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

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
959 960 961 962 963 964 965 966 967 968 969 970 971
    > 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 已提交
972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989

    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 已提交
990 991
      instance, the C++ integer literal `010` will be serialized to `8`.
      During deserialization, leading zeros yield an error.
N
Niels 已提交
992 993 994 995 996 997 998 999 1000 1001
    - 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 已提交
1002 1003 1004 1005
    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 已提交
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016

    [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

1017 1018 1019 1020
    Integer number values are stored directly inside a @ref basic_json type.

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

1021 1022
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
1023
    @since version 1.0.0
N
Niels 已提交
1024
    */
N
Niels 已提交
1025
    using number_integer_t = NumberIntegerType;
N
Niels 已提交
1026

1027 1028 1029 1030
    /*!
    @brief a type for a number (unsigned)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
    > 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.
1047 1048 1049

    #### Default type

N
Niels 已提交
1050 1051
    With the default values for @a NumberUnsignedType (`uint64_t`), the
    default value for @a number_unsigned_t is:
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061

    @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 已提交
1062 1063
      instance, the C++ integer literal `010` will be serialized to `8`.
      During deserialization, leading zeros yield an error.
1064 1065 1066 1067 1068 1069 1070 1071
    - 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 已提交
1072 1073 1074 1075 1076
    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.
1077 1078 1079 1080 1081 1082 1083

    [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 已提交
1084 1085
    number_integer_t type) of the exactly supported range [0, UINT64_MAX],
    this class's integer type is interoperable.
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096

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

N
Niels 已提交
1098 1099 1100 1101
    /*!
    @brief a type for a number (floating-point)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114
    > 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 已提交
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130

    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 已提交
1131 1132
      leading zeros in floating-point literals will be ignored. Internally,
      the value will be stored as decimal number. For instance, the C++
N
Niels 已提交
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
      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 已提交
1143 1144 1145
    > 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 已提交
1146 1147 1148 1149
    > precision.

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

    #### Storage

1155 1156 1157 1158 1159
    Floating-point number values are stored directly inside a @ref basic_json
    type.

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

1160 1161
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
1162
    @since version 1.0.0
N
Niels 已提交
1163
    */
N
Niels 已提交
1164 1165
    using number_float_t = NumberFloatType;

N
Niels 已提交
1166 1167
    /// @}

N
Niels 已提交
1168
  private:
N
Niels 已提交
1169

N
Cleanup  
Niels 已提交
1170 1171
    /// helper for exception-safe object creation
    template<typename T, typename... Args>
N
cleanup  
Niels 已提交
1172
    static T* create(Args&& ... args)
N
Cleanup  
Niels 已提交
1173 1174 1175 1176 1177 1178 1179 1180
    {
        AllocatorType<T> alloc;
        auto deleter = [&](T * object)
        {
            alloc.deallocate(object, 1);
        };
        std::unique_ptr<T, decltype(deleter)> object(alloc.allocate(1), deleter);
        alloc.construct(object.get(), std::forward<Args>(args)...);
N
Niels Lohmann 已提交
1181
        assert(object != nullptr);
N
Cleanup  
Niels 已提交
1182 1183 1184
        return object.release();
    }

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

1189 1190 1191
    /*!
    @brief a JSON value

N
Niels 已提交
1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209
    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.
1210

N
Niels 已提交
1211
    @since version 1.0.0
1212
    */
N
Niels 已提交
1213 1214 1215 1216 1217 1218 1219 1220
    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 已提交
1221
        /// boolean
N
Niels 已提交
1222 1223 1224
        boolean_t boolean;
        /// number (integer)
        number_integer_t number_integer;
1225 1226
        /// number (unsigned integer)
        number_unsigned_t number_unsigned;
N
Niels 已提交
1227
        /// number (floating-point)
N
Niels 已提交
1228 1229 1230
        number_float_t number_float;

        /// default constructor (for null values)
N
Niels 已提交
1231
        json_value() = default;
N
Niels 已提交
1232
        /// constructor for booleans
N
Niels 已提交
1233
        json_value(boolean_t v) noexcept : boolean(v) {}
N
Niels 已提交
1234
        /// constructor for numbers (integer)
N
Niels 已提交
1235
        json_value(number_integer_t v) noexcept : number_integer(v) {}
1236 1237
        /// constructor for numbers (unsigned)
        json_value(number_unsigned_t v) noexcept : number_unsigned(v) {}
N
Niels 已提交
1238
        /// constructor for numbers (floating-point)
N
Niels 已提交
1239
        json_value(number_float_t v) noexcept : number_float(v) {}
N
Niels 已提交
1240
        /// constructor for empty values of a given type
N
Niels 已提交
1241
        json_value(value_t t)
N
Niels 已提交
1242 1243 1244
        {
            switch (t)
            {
1245
                case value_t::object:
N
Niels 已提交
1246
                {
N
Cleanup  
Niels 已提交
1247
                    object = create<object_t>();
N
Niels 已提交
1248 1249
                    break;
                }
N
Niels 已提交
1250

1251
                case value_t::array:
N
Niels 已提交
1252
                {
N
Cleanup  
Niels 已提交
1253
                    array = create<array_t>();
N
Niels 已提交
1254 1255
                    break;
                }
N
Niels 已提交
1256

1257
                case value_t::string:
N
Niels 已提交
1258
                {
N
Cleanup  
Niels 已提交
1259
                    string = create<string_t>("");
N
Niels 已提交
1260 1261
                    break;
                }
N
Niels 已提交
1262

1263
                case value_t::boolean:
N
Niels 已提交
1264 1265 1266 1267 1268
                {
                    boolean = boolean_t(false);
                    break;
                }

1269
                case value_t::number_integer:
N
Niels 已提交
1270 1271 1272 1273
                {
                    number_integer = number_integer_t(0);
                    break;
                }
N
Niels 已提交
1274

1275 1276 1277 1278 1279
                case value_t::number_unsigned:
                {
                    number_unsigned = number_unsigned_t(0);
                    break;
                }
N
Niels 已提交
1280

1281
                case value_t::number_float:
N
Niels 已提交
1282 1283 1284 1285
                {
                    number_float = number_float_t(0.0);
                    break;
                }
1286

1287 1288 1289 1290 1291
                case value_t::null:
                {
                    break;
                }

1292 1293
                default:
                {
1294 1295
                    if (t == value_t::null)
                    {
1296
                        JSON_THROW(std::domain_error("961c151d2e87f2686a955a9be24d316f1362bf21 2.0.10")); // LCOV_EXCL_LINE
1297
                    }
1298 1299
                    break;
                }
N
Niels 已提交
1300 1301
            }
        }
N
Niels 已提交
1302 1303

        /// constructor for strings
N
Niels 已提交
1304
        json_value(const string_t& value)
N
Niels 已提交
1305
        {
N
Cleanup  
Niels 已提交
1306
            string = create<string_t>(value);
N
Niels 已提交
1307 1308 1309
        }

        /// constructor for objects
N
Niels 已提交
1310
        json_value(const object_t& value)
N
Niels 已提交
1311
        {
N
Cleanup  
Niels 已提交
1312
            object = create<object_t>(value);
N
Niels 已提交
1313 1314 1315
        }

        /// constructor for arrays
N
Niels 已提交
1316
        json_value(const array_t& value)
N
Niels 已提交
1317
        {
N
Cleanup  
Niels 已提交
1318
            array = create<array_t>(value);
N
Niels 已提交
1319
        }
N
Niels 已提交
1320 1321
    };

1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
    /*!
    @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 已提交
1337 1338

  public:
N
Niels 已提交
1339 1340 1341 1342
    //////////////////////////
    // JSON parser callback //
    //////////////////////////

N
Niels 已提交
1343 1344 1345 1346 1347
    /*!
    @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.
1348

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

N
Niels 已提交
1351
    @since version 1.0.0
N
Niels 已提交
1352
    */
N
Niels 已提交
1353 1354
    enum class parse_event_t : uint8_t
    {
N
Niels 已提交
1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366
        /// 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 已提交
1367 1368
    };

N
Niels 已提交
1369 1370 1371 1372
    /*!
    @brief per-element parser callback type

    With a parser callback function, the result of parsing a JSON text can be
N
Niels 已提交
1373
    influenced. When passed to @ref parse(std::istream&, const
1374
    parser_callback_t) or @ref parse(const CharT, const parser_callback_t),
N
Niels 已提交
1375 1376 1377 1378 1379
    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 已提交
1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393

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

N
Niels 已提交
1396 1397
    Discarding a value (i.e., returning `false`) has different effects
    depending on the context in which function was called:
N
Niels 已提交
1398 1399 1400

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

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

N
Niels 已提交
1406
    @param[in] event  an event of type parse_event_t indicating the context in
N
Niels 已提交
1407 1408 1409 1410 1411 1412 1413 1414 1415 1416
    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
1417
    @ref parse(const CharT, const parser_callback_t) for examples
1418

N
Niels 已提交
1419
    @since version 1.0.0
N
Niels 已提交
1420
    */
N
Niels 已提交
1421 1422 1423
    using parser_callback_t = std::function<bool(int depth,
                              parse_event_t event,
                              basic_json& parsed)>;
N
Niels 已提交
1424

N
Niels 已提交
1425 1426 1427 1428 1429

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

N
Niels 已提交
1430
    /// @name constructors and destructors
N
Niels 已提交
1431 1432
    /// Constructors of class @ref basic_json, copy/move constructor, copy
    /// assignment, static functions creating objects, and the destructor.
N
Niels 已提交
1433 1434
    /// @{

N
Niels 已提交
1435 1436 1437
    /*!
    @brief create an empty value with a given type

N
Niels 已提交
1438 1439 1440 1441 1442
    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 已提交
1443 1444 1445 1446 1447 1448
    null        | `null`
    boolean     | `false`
    string      | `""`
    number      | `0`
    object      | `{}`
    array       | `[]`
N
Niels 已提交
1449

1450
    @param[in] value_type  the type of the value to create
N
Niels 已提交
1451 1452 1453

    @complexity Constant.

N
Niels 已提交
1454
    @throw std::bad_alloc if allocation for object, array, or string value
N
Niels 已提交
1455
    fails
N
Niels 已提交
1456 1457 1458

    @liveexample{The following code shows the constructor for different @ref
    value_t values,basic_json__value_t}
1459 1460 1461 1462 1463 1464

    @sa @ref basic_json(std::nullptr_t) -- create a `null` value
    @sa @ref basic_json(boolean_t value) -- create a boolean value
    @sa @ref basic_json(const string_t&) -- create a string value
    @sa @ref basic_json(const object_t&) -- create a object value
    @sa @ref basic_json(const array_t&) -- create a array value
N
Niels 已提交
1465 1466 1467 1468
    @sa @ref basic_json(const number_float_t) -- create a number
    (floating-point) value
    @sa @ref basic_json(const number_integer_t) -- create a number (integer)
    value
1469 1470
    @sa @ref basic_json(const number_unsigned_t) -- create a number (unsigned)
    value
1471

N
Niels 已提交
1472
    @since version 1.0.0
N
Niels 已提交
1473
    */
1474 1475
    basic_json(const value_t value_type)
        : m_type(value_type), m_value(value_type)
1476 1477 1478
    {
        assert_invariant();
    }
N
Niels 已提交
1479

N
Niels 已提交
1480
    /*!
N
Niels 已提交
1481
    @brief create a null object
N
Niels 已提交
1482

N
Niels 已提交
1483 1484
    Create a `null` JSON value. It either takes a null pointer as parameter
    (explicitly creating `null`) or no parameter (implicitly creating `null`).
N
Niels 已提交
1485 1486
    The passed null pointer itself is not read -- it is only used to choose
    the right constructor.
N
Niels 已提交
1487 1488 1489

    @complexity Constant.

N
Niels 已提交
1490 1491 1492
    @exceptionsafety No-throw guarantee: this constructor never throws
    exceptions.

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

N
Niels 已提交
1496
    @since version 1.0.0
N
Niels 已提交
1497
    */
N
Niels 已提交
1498
    basic_json(std::nullptr_t = nullptr) noexcept
N
Niels 已提交
1499
        : basic_json(value_t::null)
1500 1501 1502
    {
        assert_invariant();
    }
N
Niels 已提交
1503

N
Niels 已提交
1504 1505 1506 1507 1508
    /*!
    @brief create an object (explicit)

    Create an object JSON value with a given content.

1509
    @param[in] val  a value for the object
N
Niels 已提交
1510

1511
    @complexity Linear in the size of the passed @a val.
N
Niels 已提交
1512

N
Niels 已提交
1513
    @throw std::bad_alloc if allocation for object value fails
N
Niels 已提交
1514

N
Niels 已提交
1515 1516
    @liveexample{The following code shows the constructor with an @ref
    object_t parameter.,basic_json__object_t}
N
Niels 已提交
1517

1518 1519 1520
    @sa @ref basic_json(const CompatibleObjectType&) -- create an object value
    from a compatible STL container

N
Niels 已提交
1521
    @since version 1.0.0
N
Niels 已提交
1522
    */
1523 1524
    basic_json(const object_t& val)
        : m_type(value_t::object), m_value(val)
1525 1526 1527
    {
        assert_invariant();
    }
N
Niels 已提交
1528

N
Niels 已提交
1529 1530 1531 1532
    /*!
    @brief create an object (implicit)

    Create an object JSON value with a given content. This constructor allows
N
Niels 已提交
1533 1534
    any type @a CompatibleObjectType that can be used to construct values of
    type @ref object_t.
N
Niels 已提交
1535

N
Niels 已提交
1536 1537 1538 1539 1540
    @tparam CompatibleObjectType An object type whose `key_type` and
    `value_type` is compatible to @ref object_t. Examples include `std::map`,
    `std::unordered_map`, `std::multimap`, and `std::unordered_multimap` with
    a `key_type` of `std::string`, and a `value_type` from which a @ref
    basic_json value can be constructed.
N
Niels 已提交
1541

1542
    @param[in] val  a value for the object
N
Niels 已提交
1543

1544
    @complexity Linear in the size of the passed @a val.
N
Niels 已提交
1545

N
Niels 已提交
1546
    @throw std::bad_alloc if allocation for object value fails
N
Niels 已提交
1547 1548 1549 1550

    @liveexample{The following code shows the constructor with several
    compatible object type parameters.,basic_json__CompatibleObjectType}

1551 1552
    @sa @ref basic_json(const object_t&) -- create an object value

N
Niels 已提交
1553
    @since version 1.0.0
N
Niels 已提交
1554
    */
1555 1556 1557 1558
    template <class CompatibleObjectType,
              enable_if_t<detail::is_compatible_object_type<
                              object_t, CompatibleObjectType>::value,
                          int> = 0>
1559
    basic_json(const CompatibleObjectType& val) : m_type(value_t::object)
N
Niels 已提交
1560
    {
1561 1562 1563 1564
        using std::begin;
        using std::end;
        m_value.object = create<object_t>(begin(val), end(val));
        assert_invariant();
N
Niels 已提交
1565
    }
N
Niels 已提交
1566

N
Niels 已提交
1567 1568 1569 1570 1571
    /*!
    @brief create an array (explicit)

    Create an array JSON value with a given content.

1572
    @param[in] val  a value for the array
N
Niels 已提交
1573

1574
    @complexity Linear in the size of the passed @a val.
N
Niels 已提交
1575

N
Niels 已提交
1576
    @throw std::bad_alloc if allocation for array value fails
N
Niels 已提交
1577 1578 1579 1580

    @liveexample{The following code shows the constructor with an @ref array_t
    parameter.,basic_json__array_t}

1581 1582 1583
    @sa @ref basic_json(const CompatibleArrayType&) -- create an array value
    from a compatible STL containers

N
Niels 已提交
1584
    @since version 1.0.0
N
Niels 已提交
1585
    */
1586 1587
    basic_json(const array_t& val)
        : m_type(value_t::array), m_value(val)
1588 1589 1590
    {
        assert_invariant();
    }
N
Niels 已提交
1591

N
Niels 已提交
1592 1593 1594 1595
    /*!
    @brief create an array (implicit)

    Create an array JSON value with a given content. This constructor allows
N
Niels 已提交
1596 1597
    any type @a CompatibleArrayType that can be used to construct values of
    type @ref array_t.
N
Niels 已提交
1598

N
Niels 已提交
1599 1600 1601 1602 1603
    @tparam CompatibleArrayType An object type whose `value_type` is
    compatible to @ref array_t. Examples include `std::vector`, `std::deque`,
    `std::list`, `std::forward_list`, `std::array`, `std::set`,
    `std::unordered_set`, `std::multiset`, and `unordered_multiset` with a
    `value_type` from which a @ref basic_json value can be constructed.
N
Niels 已提交
1604

1605
    @param[in] val  a value for the array
N
Niels 已提交
1606

1607
    @complexity Linear in the size of the passed @a val.
N
Niels 已提交
1608

N
Niels 已提交
1609
    @throw std::bad_alloc if allocation for array value fails
N
Niels 已提交
1610 1611 1612 1613

    @liveexample{The following code shows the constructor with several
    compatible array type parameters.,basic_json__CompatibleArrayType}

1614 1615
    @sa @ref basic_json(const array_t&) -- create an array value

N
Niels 已提交
1616
    @since version 1.0.0
N
Niels 已提交
1617
    */
1618
    template <class CompatibleArrayType,
N
Niels Lohmann 已提交
1619
              enable_if_t<detail::is_compatible_array_type<basic_json_t, CompatibleArrayType>::value,
1620
                          int> = 0>
1621
    basic_json(const CompatibleArrayType& val) : m_type(value_t::array)
1622
    {
1623 1624 1625 1626
        using std::begin;
        using std::end;
        m_value.array = create<array_t>(begin(val), end(val));
        assert_invariant();
N
Niels 已提交
1627
    }
N
Niels 已提交
1628

1629

1630 1631 1632 1633
    // constructor chosen when:
    // - JSONSerializer::to_json exists for type T
    // - T is not a istream, nor convertible to basic_json (float, vectors, etc)
    // is_compatible_basic_json_type == not is_user_defined_type
T
Théo DELRIEU 已提交
1634 1635
    template <
        typename T,
1636
        enable_if_t<not std::is_base_of<std::istream, uncvref_t<T>>::value and
1637 1638 1639 1640 1641 1642 1643 1644 1645
                    not detail::is_basic_json_nested_class<uncvref_t<T>, basic_json_t, primitive_iterator_t>::value and
                    not std::is_same<uncvref_t<T>, typename basic_json_t::array_t::iterator>::value and
                    not std::is_same<uncvref_t<T>, typename basic_json_t::object_t::iterator>::value and
                    detail::conjunction<detail::negation<detail::is_compatible_basic_json_type<
                                            uncvref_t<T>, basic_json_t>>,
                                        detail::has_to_json<JSONSerializer, basic_json,
                                                uncvref_t<T>>>::value,
                                                int> = 0 >
                    basic_json(T && val)
1646
    {
1647
        JSONSerializer<uncvref_t<T>>::to_json(*this, std::forward<T>(val));
1648
    }
1649

N
Niels 已提交
1650 1651 1652 1653 1654
    /*!
    @brief create a string (explicit)

    Create an string JSON value with a given content.

1655
    @param[in] val  a value for the string
N
Niels 已提交
1656

1657
    @complexity Linear in the size of the passed @a val.
N
Niels 已提交
1658

N
Niels 已提交
1659
    @throw std::bad_alloc if allocation for string value fails
N
Niels 已提交
1660

N
Niels 已提交
1661 1662
    @liveexample{The following code shows the constructor with an @ref
    string_t parameter.,basic_json__string_t}
N
Niels 已提交
1663

1664 1665
    @sa @ref basic_json(const typename string_t::value_type*) -- create a
    string value from a character pointer
1666
    @sa @ref basic_json(const CompatibleStringType&) -- create a string value
1667 1668
    from a compatible string container

N
Niels 已提交
1669
    @since version 1.0.0
N
Niels 已提交
1670
    */
1671 1672 1673 1674
    basic_json(const string_t& val)
        : m_type(value_t::string), m_value(val)
    {
        assert_invariant();
1675
    }
N
Niels 已提交
1676

N
Niels 已提交
1677 1678 1679
    /*!
    @brief create a string (explicit)

N
Niels 已提交
1680
    Create a string JSON value with a given content.
N
Niels 已提交
1681

1682
    @param[in] val  a literal value for the string
N
Niels 已提交
1683

1684
    @complexity Linear in the size of the passed @a val.
N
Niels 已提交
1685

N
Niels 已提交
1686
    @throw std::bad_alloc if allocation for string value fails
N
Niels 已提交
1687 1688 1689 1690

    @liveexample{The following code shows the constructor with string literal
    parameter.,basic_json__string_t_value_type}

1691 1692 1693 1694
    @sa @ref basic_json(const string_t&) -- create a string value
    @sa @ref basic_json(const CompatibleStringType&) -- create a string value
    from a compatible string container

N
Niels 已提交
1695
    @since version 1.0.0
N
Niels 已提交
1696
    */
1697 1698
    basic_json(const typename string_t::value_type* val)
        : basic_json(string_t(val))
1699 1700 1701
    {
        assert_invariant();
    }
N
Niels 已提交
1702

N
Niels 已提交
1703 1704 1705 1706 1707
    /*!
    @brief create a string (implicit)

    Create a string JSON value with a given content.

1708
    @param[in] val  a value for the string
N
Niels 已提交
1709 1710

    @tparam CompatibleStringType an string type which is compatible to @ref
N
Niels 已提交
1711
    string_t, for instance `std::string`.
N
Niels 已提交
1712

1713
    @complexity Linear in the size of the passed @a val.
N
Niels 已提交
1714

N
Niels 已提交
1715
    @throw std::bad_alloc if allocation for string value fails
N
Niels 已提交
1716 1717 1718 1719

    @liveexample{The following code shows the construction of a string value
    from a compatible type.,basic_json__CompatibleStringType}

1720 1721 1722 1723
    @sa @ref basic_json(const string_t&) -- create a string value
    @sa @ref basic_json(const typename string_t::value_type*) -- create a
    string value from a character pointer

N
Niels 已提交
1724
    @since version 1.0.0
N
Niels 已提交
1725
    */
N
Niels 已提交
1726 1727
    template<class CompatibleStringType, typename std::enable_if<
                 std::is_constructible<string_t, CompatibleStringType>::value, int>::type = 0>
1728 1729
    basic_json(const CompatibleStringType& val)
        : basic_json(string_t(val))
1730 1731 1732
    {
        assert_invariant();
    }
N
Niels 已提交
1733

N
Niels 已提交
1734 1735 1736 1737 1738
    /*!
    @brief create a boolean (explicit)

    Creates a JSON boolean type from a given value.

1739
    @param[in] val  a boolean value to store
N
Niels 已提交
1740 1741 1742 1743 1744

    @complexity Constant.

    @liveexample{The example below demonstrates boolean
    values.,basic_json__boolean_t}
1745

N
Niels 已提交
1746
    @since version 1.0.0
N
Niels 已提交
1747
    */
N
Niels 已提交
1748
    basic_json(boolean_t val) noexcept
1749
        : m_type(value_t::boolean), m_value(val)
1750 1751 1752
    {
        assert_invariant();
    }
N
Niels 已提交
1753

N
Niels 已提交
1754 1755 1756
    /*!
    @brief create an integer number (explicit)

N
Niels 已提交
1757
    Create an integer number JSON value with a given content.
N
Niels 已提交
1758

N
Niels 已提交
1759
    @tparam T A helper type to remove this function via SFINAE in case @ref
N
Niels 已提交
1760 1761 1762
    number_integer_t is the same as `int`. In this case, this constructor
    would have the same signature as @ref basic_json(const int value). Note
    the helper type @a T is not visible in this constructor's interface.
N
Niels 已提交
1763

1764
    @param[in] val  an integer to create a JSON number from
N
Niels 已提交
1765

N
Niels 已提交
1766 1767
    @complexity Constant.

N
Niels 已提交
1768
    @liveexample{The example below shows the construction of an integer
N
Niels 已提交
1769
    number value.,basic_json__number_integer_t}
N
Niels 已提交
1770

1771 1772 1773 1774
    @sa @ref basic_json(const int) -- create a number value (integer)
    @sa @ref basic_json(const CompatibleNumberIntegerType) -- create a number
    value (integer) from a compatible number type

N
Niels 已提交
1775
    @since version 1.0.0
N
Niels 已提交
1776
    */
N
Niels 已提交
1777 1778 1779
    template<typename T, typename std::enable_if<
                 not (std::is_same<T, int>::value) and
                 std::is_same<T, number_integer_t>::value, int>::type = 0>
N
Niels 已提交
1780
    basic_json(const number_integer_t val) noexcept
1781
        : m_type(value_t::number_integer), m_value(val)
1782 1783 1784
    {
        assert_invariant();
    }
N
Niels 已提交
1785

N
Niels 已提交
1786
    /*!
N
Niels 已提交
1787 1788
    @brief create an integer number from an enum type (explicit)

N
Niels 已提交
1789
    Create an integer number JSON value with a given content.
N
Niels 已提交
1790

1791
    @param[in] val  an integer to create a JSON number from
N
Niels 已提交
1792

N
Niels 已提交
1793 1794 1795
    @note This constructor allows to pass enums directly to a constructor. As
    C++ has no way of specifying the type of an anonymous enum explicitly, we
    can only rely on the fact that such values implicitly convert to int. As
N
Niels 已提交
1796 1797
    int may already be the same type of number_integer_t, we may need to
    switch off the constructor @ref basic_json(const number_integer_t).
N
Niels 已提交
1798 1799 1800

    @complexity Constant.

N
Niels 已提交
1801
    @liveexample{The example below shows the construction of an integer
N
Niels 已提交
1802
    number value from an anonymous enum.,basic_json__const_int}
N
Niels 已提交
1803

1804 1805 1806 1807 1808
    @sa @ref basic_json(const number_integer_t) -- create a number value
    (integer)
    @sa @ref basic_json(const CompatibleNumberIntegerType) -- create a number
    value (integer) from a compatible number type

N
Niels 已提交
1809
    @since version 1.0.0
N
Niels 已提交
1810
    */
1811

T
Théo DELRIEU 已提交
1812 1813
    // Constructor for unscoped enums (not enum classes)
    template <typename T, enable_if_t<is_unscoped_enum<T>::value, int> = 0>
1814
    basic_json(T val) noexcept
N
Niels 已提交
1815
        : m_type(value_t::number_integer),
1816
          m_value(static_cast<number_integer_t>(val))
1817 1818 1819
    {
        assert_invariant();
    }
N
Niels 已提交
1820

N
Niels 已提交
1821 1822 1823
    /*!
    @brief create an integer number (implicit)

N
Niels 已提交
1824
    Create an integer number JSON value with a given content. This constructor
N
Niels 已提交
1825 1826
    allows any type @a CompatibleNumberIntegerType that can be used to
    construct values of type @ref number_integer_t.
N
Niels 已提交
1827

N
Niels 已提交
1828
    @tparam CompatibleNumberIntegerType An integer type which is compatible to
N
Niels 已提交
1829 1830
    @ref number_integer_t. Examples include the types `int`, `int32_t`,
    `long`, and `short`.
N
Niels 已提交
1831

1832
    @param[in] val  an integer to create a JSON number from
N
Niels 已提交
1833 1834 1835

    @complexity Constant.

N
Niels 已提交
1836 1837
    @liveexample{The example below shows the construction of several integer
    number values from compatible
N
Niels 已提交
1838 1839
    types.,basic_json__CompatibleIntegerNumberType}

1840 1841 1842 1843
    @sa @ref basic_json(const number_integer_t) -- create a number value
    (integer)
    @sa @ref basic_json(const int) -- create a number value (integer)

N
Niels 已提交
1844
    @since version 1.0.0
N
Niels 已提交
1845
    */
1846 1847 1848 1849
    template <
        typename CompatibleNumberIntegerType,
        enable_if_t<detail::is_compatible_integer_type<
                        number_integer_t, CompatibleNumberIntegerType>::value,
1850
                    int> = 0 >
1851
    basic_json(const CompatibleNumberIntegerType val) noexcept
N
Niels 已提交
1852
        : m_type(value_t::number_integer),
1853 1854 1855
          m_value(static_cast<number_integer_t>(val))
    {
        assert_invariant();
1856
    }
N
Niels 已提交
1857

1858 1859 1860 1861 1862
    /*!
    @brief create an unsigned integer number (explicit)

    Create an unsigned integer number JSON value with a given content.

N
Niels 已提交
1863 1864
    @tparam T  helper type to compare number_unsigned_t and unsigned int (not
    visible in) the interface.
1865 1866 1867 1868 1869 1870 1871 1872 1873 1874

    @param[in] val  an integer to create a JSON number from

    @complexity Constant.

    @sa @ref basic_json(const CompatibleNumberUnsignedType) -- create a number
    value (unsigned integer) from a compatible number type

    @since version 2.0.0
    */
N
Niels 已提交
1875 1876 1877
    template<typename T, typename std::enable_if<
                 not (std::is_same<T, int>::value) and
                 std::is_same<T, number_unsigned_t>::value, int>::type = 0>
N
Niels 已提交
1878
    basic_json(const number_unsigned_t val) noexcept
1879
        : m_type(value_t::number_unsigned), m_value(val)
1880 1881 1882
    {
        assert_invariant();
    }
N
Niels 已提交
1883

1884 1885 1886
    /*!
    @brief create an unsigned number (implicit)

N
Niels 已提交
1887 1888 1889
    Create an unsigned number JSON value with a given content. This
    constructor allows any type @a CompatibleNumberUnsignedType that can be
    used to construct values of type @ref number_unsigned_t.
1890

N
Niels 已提交
1891 1892
    @tparam CompatibleNumberUnsignedType An integer type which is compatible
    to @ref number_unsigned_t. Examples may include the types `unsigned int`,
N
Niels 已提交
1893
    `uint32_t`, or `unsigned short`.
1894 1895 1896 1897 1898 1899 1900 1901 1902 1903

    @param[in] val  an unsigned integer to create a JSON number from

    @complexity Constant.

    @sa @ref basic_json(const number_unsigned_t) -- create a number value
    (unsigned)

    @since version 2.0.0
    */
T
Théo DELRIEU 已提交
1904 1905
    template <
        typename CompatibleNumberUnsignedType,
1906 1907
        enable_if_t<detail::is_compatible_integer_type<
                        number_unsigned_t, CompatibleNumberUnsignedType>::value,
1908
                    int> = 0 >
1909 1910
    basic_json(const CompatibleNumberUnsignedType val) noexcept
        : m_type(value_t::number_unsigned),
1911 1912 1913
          m_value(static_cast<number_unsigned_t>(val))
    {
        assert_invariant();
1914
    }
1915

N
Niels 已提交
1916 1917 1918 1919 1920
    /*!
    @brief create a floating-point number (explicit)

    Create a floating-point number JSON value with a given content.

1921
    @param[in] val  a floating-point value to create a JSON number from
N
Niels 已提交
1922

1923
    @note [RFC 7159](http://www.rfc-editor.org/rfc/rfc7159.txt), section 6
N
Niels 已提交
1924
    disallows NaN values:
N
Niels 已提交
1925 1926
    > Numeric values that cannot be represented in the grammar below (such as
    > Infinity and NaN) are not permitted.
N
Niels 已提交
1927 1928
    In case the parameter @a val is not a number, a JSON null value is created
    instead.
N
Niels 已提交
1929

N
Niels 已提交
1930
    @complexity Constant.
N
Niels 已提交
1931 1932 1933

    @liveexample{The following example creates several floating-point
    values.,basic_json__number_float_t}
1934 1935 1936 1937

    @sa @ref basic_json(const CompatibleNumberFloatType) -- create a number
    value (floating-point) from a compatible number type

N
Niels 已提交
1938
    @since version 1.0.0
N
Niels 已提交
1939
    */
N
Niels 已提交
1940
    basic_json(const number_float_t val) noexcept
1941
        : m_type(value_t::number_float), m_value(val)
N
Niels 已提交
1942 1943
    {
        // replace infinity and NAN by null
1944
        if (not std::isfinite(val))
N
Niels 已提交
1945 1946 1947 1948
        {
            m_type = value_t::null;
            m_value = json_value();
        }
1949 1950

        assert_invariant();
N
Niels 已提交
1951
    }
N
Niels 已提交
1952

N
Niels 已提交
1953 1954 1955 1956
    /*!
    @brief create an floating-point number (implicit)

    Create an floating-point number JSON value with a given content. This
N
Niels 已提交
1957 1958
    constructor allows any type @a CompatibleNumberFloatType that can be used
    to construct values of type @ref number_float_t.
N
Niels 已提交
1959

N
Niels 已提交
1960 1961 1962
    @tparam CompatibleNumberFloatType A floating-point type which is
    compatible to @ref number_float_t. Examples may include the types `float`
    or `double`.
N
Niels 已提交
1963

1964
    @param[in] val  a floating-point to create a JSON number from
N
Niels 已提交
1965

1966
    @note [RFC 7159](http://www.rfc-editor.org/rfc/rfc7159.txt), section 6
N
Niels 已提交
1967
    disallows NaN values:
N
Niels 已提交
1968 1969
    > Numeric values that cannot be represented in the grammar below (such as
    > Infinity and NaN) are not permitted.
N
Niels 已提交
1970 1971
    In case the parameter @a val is not a number, a JSON null value is
    created instead.
N
Niels 已提交
1972 1973 1974

    @complexity Constant.

N
Niels 已提交
1975
    @liveexample{The example below shows the construction of several
N
Niels 已提交
1976 1977 1978
    floating-point number values from compatible
    types.,basic_json__CompatibleNumberFloatType}

1979 1980 1981
    @sa @ref basic_json(const number_float_t) -- create a number value
    (floating-point)

N
Niels 已提交
1982
    @since version 1.0.0
N
Niels 已提交
1983
    */
T
Théo DELRIEU 已提交
1984 1985 1986 1987
    template <typename CompatibleNumberFloatType,
              enable_if_t<detail::is_compatible_float_type<
                              number_float_t, CompatibleNumberFloatType>::value,
                          int> = 0>
1988 1989
    basic_json(const CompatibleNumberFloatType val) noexcept
        : basic_json(number_float_t(val))
1990 1991 1992
    {
        assert_invariant();
    }
N
Niels 已提交
1993

N
Niels 已提交
1994 1995 1996 1997 1998 1999 2000 2001 2002 2003
    /*!
    @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 已提交
2004 2005
       object value is created where the first elements of the pairs are
       treated as keys and the second elements are as values.
N
Niels 已提交
2006 2007 2008
    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 已提交
2009
    JSON values. The rationale is as follows:
N
Niels 已提交
2010 2011

    1. The empty initializer list is written as `{}` which is exactly an empty
N
Niels 已提交
2012
       JSON object.
N
Niels 已提交
2013
    2. C++ has now way of describing mapped types other than to list a list of
N
Niels 已提交
2014 2015 2016
       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 已提交
2017
    3. In all other cases, the initializer list could not be interpreted as
N
Niels 已提交
2018
       JSON object type, so interpreting it as JSON array type is safe.
N
Niels 已提交
2019

N
Niels 已提交
2020 2021
    With the rules described above, the following JSON values cannot be
    expressed by an initializer list:
N
Niels 已提交
2022

N
Niels 已提交
2023 2024 2025 2026 2027
    - 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 已提交
2028 2029 2030 2031 2032

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

N
Niels 已提交
2035 2036 2037
    @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 已提交
2038 2039
    used by the functions @ref array(std::initializer_list<basic_json>) and
    @ref object(std::initializer_list<basic_json>).
N
Niels 已提交
2040

N
Niels 已提交
2041 2042
    @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 已提交
2043 2044 2045
    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 已提交
2046 2047
    @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 已提交
2048 2049
    whose first element is a string; example: `"cannot create object from
    initializer list"`
N
Niels 已提交
2050 2051 2052 2053

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

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

N
Niels 已提交
2056
    @sa @ref array(std::initializer_list<basic_json>) -- create a JSON array
2057
    value from an initializer list
N
Niels 已提交
2058
    @sa @ref object(std::initializer_list<basic_json>) -- create a JSON object
2059 2060
    value from an initializer list

N
Niels 已提交
2061
    @since version 1.0.0
N
Niels 已提交
2062
    */
N
Niels 已提交
2063 2064
    basic_json(std::initializer_list<basic_json> init,
               bool type_deduction = true,
N
Niels 已提交
2065
               value_t manual_type = value_t::array)
N
Niels 已提交
2066
    {
N
Niels 已提交
2067 2068
        // check if each element is an array with two elements whose first
        // element is a string
N
Niels 已提交
2069 2070
        bool is_an_object = std::all_of(init.begin(), init.end(),
                                        [](const basic_json & element)
N
Niels 已提交
2071
        {
N
Niels 已提交
2072 2073
            return element.is_array() and element.size() == 2 and element[0].is_string();
        });
N
Niels 已提交
2074 2075 2076 2077 2078 2079 2080

        // 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)
            {
2081
                is_an_object = false;
N
Niels 已提交
2082 2083 2084
            }

            // if object is wanted but impossible, throw an exception
2085
            if (manual_type == value_t::object and not is_an_object)
N
Niels 已提交
2086
            {
2087
                JSON_THROW(std::domain_error("cannot create object from initializer list"));
N
Niels 已提交
2088 2089 2090
            }
        }

2091
        if (is_an_object)
N
Niels 已提交
2092 2093 2094
        {
            // the initializer list is a list of pairs -> create object
            m_type = value_t::object;
N
Niels 已提交
2095
            m_value = value_t::object;
N
Niels 已提交
2096

N
Niels 已提交
2097
            std::for_each(init.begin(), init.end(), [this](const basic_json & element)
N
Niels 已提交
2098
            {
N
Niels 已提交
2099
                m_value.object->emplace(*(element[0].m_value.string), element[1]);
N
Niels 已提交
2100
            });
N
Niels 已提交
2101 2102 2103 2104 2105
        }
        else
        {
            // the initializer list describes an array -> create array
            m_type = value_t::array;
N
Niels 已提交
2106
            m_value.array = create<array_t>(init);
N
Niels 已提交
2107
        }
2108 2109

        assert_invariant();
N
Niels 已提交
2110 2111
    }

N
Niels 已提交
2112 2113 2114 2115 2116 2117 2118
    /*!
    @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 已提交
2119 2120
    @note This function is only needed to express two edge cases that cannot
    be realized with the initializer list constructor (@ref
N
Niels 已提交
2121 2122
    basic_json(std::initializer_list<basic_json>, bool, value_t)). These cases
    are:
N
Niels 已提交
2123
    1. creating an array whose elements are all pairs whose first element is a
N
Niels 已提交
2124
    string -- in this case, the initializer list constructor would create an
N
Niels 已提交
2125
    object, taking the first elements as keys
N
Niels 已提交
2126
    2. creating an empty array -- passing the empty initializer list to the
N
Niels 已提交
2127 2128
    initializer list constructor yields an empty object

N
Niels 已提交
2129
    @param[in] init  initializer list with JSON values to create an array from
N
Niels 已提交
2130 2131 2132 2133 2134 2135
    (optional)

    @return JSON array value

    @complexity Linear in the size of @a init.

N
Niels 已提交
2136
    @liveexample{The following code shows an example for the `array`
N
Niels 已提交
2137 2138
    function.,array}

2139 2140 2141 2142 2143
    @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 已提交
2144
    @since version 1.0.0
N
Niels 已提交
2145
    */
N
Niels 已提交
2146
    static basic_json array(std::initializer_list<basic_json> init =
2147
                            std::initializer_list<basic_json>())
N
Niels 已提交
2148
    {
N
Niels 已提交
2149
        return basic_json(init, false, value_t::array);
N
Niels 已提交
2150 2151
    }

N
Niels 已提交
2152 2153 2154 2155
    /*!
    @brief explicitly create an object from an initializer list

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

    @note This function is only added for symmetry reasons. In contrast to the
2160 2161 2162
    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 已提交
2163 2164
    constructor @ref basic_json(std::initializer_list<basic_json>, bool,
    value_t).
N
Niels 已提交
2165

N
Niels 已提交
2166
    @param[in] init  initializer list to create an object from (optional)
N
Niels 已提交
2167 2168 2169 2170

    @return JSON object value

    @throw std::domain_error if @a init is not a pair whose first elements are
2171 2172
    strings; thrown by
    @ref basic_json(std::initializer_list<basic_json>, bool, value_t)
N
Niels 已提交
2173 2174 2175

    @complexity Linear in the size of @a init.

N
Niels 已提交
2176
    @liveexample{The following code shows an example for the `object`
N
Niels 已提交
2177 2178
    function.,object}

2179 2180 2181 2182 2183
    @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 已提交
2184
    @since version 1.0.0
N
Niels 已提交
2185
    */
N
Niels 已提交
2186
    static basic_json object(std::initializer_list<basic_json> init =
2187
                             std::initializer_list<basic_json>())
N
Niels 已提交
2188
    {
N
Niels 已提交
2189
        return basic_json(init, false, value_t::object);
N
Niels 已提交
2190 2191
    }

N
Niels 已提交
2192 2193 2194
    /*!
    @brief construct an array with count copies of given value

N
Niels 已提交
2195 2196
    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,
2197
    `std::distance(begin(),end()) == cnt` holds.
N
Niels 已提交
2198

2199 2200
    @param[in] cnt  the number of JSON copies of @a val to create
    @param[in] val  the JSON value to copy
N
Niels 已提交
2201

2202
    @complexity Linear in @a cnt.
N
Niels 已提交
2203 2204 2205 2206

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

N
Niels 已提交
2208
    @since version 1.0.0
N
Niels 已提交
2209
    */
2210
    basic_json(size_type cnt, const basic_json& val)
N
Niels 已提交
2211 2212
        : m_type(value_t::array)
    {
2213
        m_value.array = create<array_t>(cnt, val);
2214
        assert_invariant();
N
Niels 已提交
2215
    }
N
Niels 已提交
2216

N
Niels 已提交
2217 2218 2219 2220 2221
    /*!
    @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 已提交
2222
    - In case of primitive types (number, boolean, or string), @a first must
N
Niels 已提交
2223 2224
      be `begin()` and @a last must be `end()`. In this case, the value is
      copied. Otherwise, std::out_of_range is thrown.
N
Niels 已提交
2225 2226
    - In case of structured types (array, object), the constructor behaves as
      similar versions for `std::vector`.
N
Niels 已提交
2227
    - In case of a null type, std::domain_error is thrown.
N
Niels 已提交
2228 2229 2230 2231 2232 2233 2234

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

N
Niels 已提交
2238
    @throw std::domain_error if iterators are not compatible; that is, do not
N
Niels 已提交
2239
    belong to the same JSON value; example: `"iterators are not compatible"`
N
Niels 已提交
2240
    @throw std::out_of_range if iterators are for a primitive type (number,
N
Niels 已提交
2241 2242
    boolean, or string) where an out of range error can be detected easily;
    example: `"iterators out of range"`
N
Niels 已提交
2243
    @throw std::bad_alloc if allocation for object, array, or string fails
N
Niels 已提交
2244 2245
    @throw std::domain_error if called with a null value; example: `"cannot
    use construct with iterators from null"`
N
Niels 已提交
2246 2247 2248 2249 2250

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

N
Niels 已提交
2252
    @since version 1.0.0
N
Niels 已提交
2253
    */
N
Niels 已提交
2254 2255 2256
    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 已提交
2257
    basic_json(InputIT first, InputIT last)
N
Niels 已提交
2258
    {
N
Niels 已提交
2259 2260 2261
        assert(first.m_object != nullptr);
        assert(last.m_object != nullptr);

N
Niels 已提交
2262
        // make sure iterator fits the current value
N
Niels 已提交
2263
        if (first.m_object != last.m_object)
N
Niels 已提交
2264
        {
2265
            JSON_THROW(std::domain_error("iterators are not compatible"));
N
Niels 已提交
2266 2267
        }

N
Niels 已提交
2268 2269 2270
        // copy type from first iterator
        m_type = first.m_object->m_type;

N
Niels 已提交
2271
        // check if iterator range is complete for primitive values
N
Niels 已提交
2272 2273 2274
        switch (m_type)
        {
            case value_t::boolean:
2275 2276
            case value_t::number_float:
            case value_t::number_integer:
2277
            case value_t::number_unsigned:
N
Niels 已提交
2278 2279
            case value_t::string:
            {
2280
                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
N
Niels 已提交
2281
                {
2282
                    JSON_THROW(std::out_of_range("iterators out of range"));
N
Niels 已提交
2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299
                }
                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 已提交
2300

2301 2302 2303 2304 2305
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = first.m_object->m_value.number_unsigned;
                break;
            }
N
Niels 已提交
2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320

            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 已提交
2321
                m_value = *first.m_object->m_value.string;
N
Niels 已提交
2322 2323 2324 2325 2326
                break;
            }

            case value_t::object:
            {
N
Niels Lohmann 已提交
2327 2328
                m_value.object = create<object_t>(first.m_it.object_iterator,
                                                  last.m_it.object_iterator);
N
Niels 已提交
2329 2330 2331 2332 2333
                break;
            }

            case value_t::array:
            {
N
Niels Lohmann 已提交
2334 2335
                m_value.array = create<array_t>(first.m_it.array_iterator,
                                                last.m_it.array_iterator);
N
Niels 已提交
2336 2337 2338 2339 2340
                break;
            }

            default:
            {
2341
                JSON_THROW(std::domain_error("cannot use construct with iterators from " + first.m_object->type_name()));
N
Niels 已提交
2342 2343
            }
        }
2344 2345

        assert_invariant();
N
Niels 已提交
2346 2347
    }

N
Niels 已提交
2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361
    /*!
    @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 已提交
2362 2363 2364 2365 2366 2367 2368
    @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 已提交
2369 2370 2371 2372
    @liveexample{The example below demonstrates constructing a JSON value from
    a `std::stringstream` with and without callback
    function.,basic_json__istream}

N
Niels 已提交
2373 2374
    @since version 2.0.0, deprecated in version 2.0.3, to be removed in
           version 3.0.0
N
Niels 已提交
2375
    */
N
Niels 已提交
2376
    JSON_DEPRECATED
N
Niels 已提交
2377
    explicit basic_json(std::istream& i, const parser_callback_t cb = nullptr)
N
Niels 已提交
2378 2379
    {
        *this = parser(i, cb).parse();
2380
        assert_invariant();
N
Niels 已提交
2381 2382
    }

N
Niels 已提交
2383 2384 2385 2386
    ///////////////////////////////////////
    // other constructors and destructor //
    ///////////////////////////////////////

N
Niels 已提交
2387 2388
    /*!
    @brief copy constructor
N
Niels 已提交
2389

N
Niels 已提交
2390 2391
    Creates a copy of a given JSON value.

N
Niels 已提交
2392
    @param[in] other  the JSON value to copy
N
Niels 已提交
2393 2394 2395

    @complexity Linear in the size of @a other.

N
Niels 已提交
2396 2397 2398
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2399 2400 2401
    - The complexity is linear.
    - As postcondition, it holds: `other == basic_json(other)`.

N
Niels 已提交
2402
    @throw std::bad_alloc if allocation for object, array, or string fails.
N
Niels 已提交
2403 2404

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

N
Niels 已提交
2407
    @since version 1.0.0
N
Niels 已提交
2408
    */
N
Niels 已提交
2409
    basic_json(const basic_json& other)
N
Niels 已提交
2410 2411
        : m_type(other.m_type)
    {
2412 2413 2414
        // check of passed value is valid
        other.assert_invariant();

N
Niels 已提交
2415 2416
        switch (m_type)
        {
2417
            case value_t::object:
N
Niels 已提交
2418
            {
N
Niels 已提交
2419
                m_value = *other.m_value.object;
N
Niels 已提交
2420 2421
                break;
            }
N
Niels 已提交
2422

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

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

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

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

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

2453
            case value_t::number_float:
N
Niels 已提交
2454
            {
N
Niels 已提交
2455
                m_value = other.m_value.number_float;
N
Niels 已提交
2456 2457
                break;
            }
2458 2459 2460 2461 2462

            default:
            {
                break;
            }
N
Niels 已提交
2463
        }
2464 2465

        assert_invariant();
N
Niels 已提交
2466 2467
    }

N
Niels 已提交
2468 2469 2470 2471 2472 2473 2474
    /*!
    @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 已提交
2475
    @param[in,out] other  value to move to this object
N
Niels 已提交
2476 2477 2478 2479 2480 2481 2482

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

N
Niels 已提交
2484
    @since version 1.0.0
N
Niels 已提交
2485
    */
N
Niels 已提交
2486
    basic_json(basic_json&& other) noexcept
N
Niels 已提交
2487 2488
        : m_type(std::move(other.m_type)),
          m_value(std::move(other.m_value))
N
Niels 已提交
2489
    {
2490 2491 2492
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2493
        // invalidate payload
N
Niels 已提交
2494 2495
        other.m_type = value_t::null;
        other.m_value = {};
2496 2497

        assert_invariant();
N
Niels 已提交
2498 2499
    }

N
Niels 已提交
2500 2501
    /*!
    @brief copy assignment
N
Niels 已提交
2502

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

N
Niels 已提交
2507
    @param[in] other  value to copy from
N
Niels 已提交
2508 2509 2510

    @complexity Linear.

N
Niels 已提交
2511 2512 2513
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2514 2515
    - The complexity is linear.

N
Niels 已提交
2516 2517 2518 2519
    @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 已提交
2520

N
Niels 已提交
2521
    @since version 1.0.0
N
Niels 已提交
2522
    */
N
Niels 已提交
2523
    reference& operator=(basic_json other) noexcept (
N
Niels 已提交
2524 2525 2526 2527
        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
2528
                                       )
N
Niels 已提交
2529
    {
2530 2531 2532
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2533
        using std::swap;
N
Cleanup  
Niels 已提交
2534 2535
        swap(m_type, other.m_type);
        swap(m_value, other.m_value);
2536 2537

        assert_invariant();
N
Niels 已提交
2538 2539 2540
        return *this;
    }

2541 2542 2543 2544
    // this overload is needed, since constructor for udt is explicit
    template <typename T, enable_if_t<not detail::is_compatible_basic_json_type<
                                          uncvref_t<T>, basic_json_t>::value and
                                      detail::has_to_json<JSONSerializer, basic_json_t, uncvref_t<T>>::value>>
2545
    reference& operator=(T&& val) noexcept(std::is_nothrow_constructible<basic_json_t, uncvref_t<T>>::value and
2546 2547
                                           std::is_nothrow_move_assignable<uncvref_t<T>>::value)
    {
2548 2549 2550
        static_assert(sizeof(T) == 0 , "");
        // I'm not sure this a is good practice...
        return *this = basic_json_t{std::forward<T>(val)};
2551
    }
N
Niels 已提交
2552

2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570
    /*!
    @brief destructor

    Destroys the JSON value and frees all allocated memory.

    @complexity Linear.

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

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

2572 2573 2574 2575 2576 2577 2578 2579 2580
        switch (m_type)
        {
            case value_t::object:
            {
                AllocatorType<object_t> alloc;
                alloc.destroy(m_value.object);
                alloc.deallocate(m_value.object, 1);
                break;
            }
N
Niels 已提交
2581

2582 2583 2584 2585 2586 2587 2588
            case value_t::array:
            {
                AllocatorType<array_t> alloc;
                alloc.destroy(m_value.array);
                alloc.deallocate(m_value.array, 1);
                break;
            }
2589

2590 2591 2592 2593 2594 2595 2596
            case value_t::string:
            {
                AllocatorType<string_t> alloc;
                alloc.destroy(m_value.string);
                alloc.deallocate(m_value.string, 1);
                break;
            }
2597

2598 2599 2600 2601 2602 2603
            default:
            {
                // all other types need no specific destructor
                break;
            }
        }
N
Niels 已提交
2604 2605
    }

N
Niels 已提交
2606
    /// @}
N
Niels 已提交
2607 2608 2609 2610 2611 2612

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

N
Niels 已提交
2613
    /// @name object inspection
N
Niels 已提交
2614
    /// Functions to inspect the type of a JSON value.
N
Niels 已提交
2615 2616
    /// @{

N
Niels 已提交
2617
    /*!
N
Niels 已提交
2618 2619
    @brief serialization

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

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

N
Niels 已提交
2629 2630 2631 2632 2633
    @return string containing the serialization of the JSON value

    @complexity Linear.

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

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

N
Niels 已提交
2638
    @since version 1.0.0
N
Niels 已提交
2639
    */
N
Niels 已提交
2640
    string_t dump(const int indent = -1) const
N
Niels 已提交
2641
    {
N
Niels 已提交
2642
        std::stringstream ss;
N
Niels 已提交
2643
        // fix locale problems
N
Niels 已提交
2644
        ss.imbue(std::locale::classic());
N
Niels 已提交
2645

2646 2647 2648 2649 2650 2651
        // 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
Niels 已提交
2652 2653
        if (indent >= 0)
        {
N
Niels 已提交
2654
            dump(ss, true, static_cast<unsigned int>(indent));
N
Niels 已提交
2655 2656 2657
        }
        else
        {
N
Niels 已提交
2658
            dump(ss, false, 0);
N
Niels 已提交
2659
        }
N
Niels 已提交
2660 2661

        return ss.str();
N
Niels 已提交
2662 2663
    }

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

    @complexity Constant.

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

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

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

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

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

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

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

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

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

    This function returns true iff the JSON value is null.

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

    @complexity Constant.

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

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

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

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

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

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

    @complexity Constant.

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

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

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

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

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

    @complexity Constant.

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

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

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

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

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

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

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

    @complexity Constant.

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

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

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

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

2847 2848 2849
    /*!
    @brief return whether value is an unsigned integer number

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

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

    @complexity Constant.

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

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

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

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

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

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

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

    @complexity Constant.

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

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

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

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

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

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

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

    @complexity Constant.

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

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

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

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

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

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

    @complexity Constant.

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

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

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

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

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

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

    @complexity Constant.

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

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

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

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

    @complexity Constant.

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

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

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

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

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

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

N
Niels 已提交
3019 3020
    /// @}

N
Niels 已提交
3021
  private:
N
Niels 已提交
3022 3023 3024
    //////////////////
    // value access //
    //////////////////
N
Niels 已提交
3025

3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036
    template<class T, typename std::enable_if<
                 std::is_convertible<typename object_t::key_type, typename T::key_type>::value and
                 std::is_convertible<basic_json_t, typename T::mapped_type>::value, int>::type = 0>
    T get_impl(T*) const
    {
        if (is_object())
        {
            return T(m_value.object->begin(), m_value.object->end());
        }
        else
        {
N
Niels Lohmann 已提交
3037

3038
        JSON_THROW(std::domain_error("type must be object, but is " + type_name()));
N
Niels 已提交
3039 3040 3041
    }

    /// get an object (explicit)
N
Niels Lohmann 已提交
3042
    object_t get_impl(object_t* /*unused*/) const
N
Niels 已提交
3043
    {
N
Niels 已提交
3044 3045 3046 3047
        if (is_object())
        {
            return *(m_value.object);
        }
N
Niels Lohmann 已提交
3048

3049
        JSON_THROW(std::domain_error("type must be object, but is " + type_name()));
N
Niels 已提交
3050 3051
    }

N
Niels 已提交
3052
    /// get an array (explicit)
T
Théo DELRIEU 已提交
3053 3054
    template <
        class T,
3055
        typename std::enable_if <
T
Théo DELRIEU 已提交
3056
            std::is_convertible<basic_json_t, typename T::value_type>::value and
3057 3058 3059 3060 3061 3062 3063
            not std::is_same<basic_json_t,
                             typename T::value_type>::value and
            not std::is_arithmetic<T>::value and
            not std::is_convertible<std::string, T>::value and
            not detail::has_mapped_type<T>::value,
            int >::type = 0 >
    T get_impl(T*) const
N
Niels 已提交
3064
    {
N
cleanup  
Niels 已提交
3065
        if (is_array())
N
Niels 已提交
3066
        {
3067 3068 3069
            T to_vector;
            std::transform(m_value.array->begin(), m_value.array->end(),
                           std::inserter(to_vector, to_vector.end()), [](basic_json i)
N
Niels 已提交
3070
            {
3071 3072 3073 3074
                return i.get<typename T::value_type>();
            });
            return to_vector;
        }
N
Niels Lohmann 已提交
3075

3076
        JSON_THROW(std::domain_error("type must be array, but is " + type_name()));
N
Niels 已提交
3077 3078
    }

N
Niels 已提交
3079
    /// get an array (explicit)
N
Niels 已提交
3080 3081 3082
    template<class T, typename std::enable_if<
                 std::is_convertible<basic_json_t, T>::value and
                 not std::is_same<basic_json_t, T>::value, int>::type = 0>
N
Niels Lohmann 已提交
3083
    std::vector<T> get_impl(std::vector<T>* /*unused*/) const
N
Niels 已提交
3084
    {
N
cleanup  
Niels 已提交
3085
        if (is_array())
N
Niels 已提交
3086
        {
3087 3088 3089 3090
            std::vector<T> to_vector;
            to_vector.reserve(m_value.array->size());
            std::transform(m_value.array->begin(), m_value.array->end(),
                           std::inserter(to_vector, to_vector.end()), [](basic_json i)
N
Niels 已提交
3091
            {
3092 3093 3094 3095
                return i.get<T>();
            });
            return to_vector;
        }
N
Niels Lohmann 已提交
3096

3097
        JSON_THROW(std::domain_error("type must be array, but is " + type_name()));
N
Niels 已提交
3098 3099
    }

N
Niels 已提交
3100
    /// get an array (explicit)
N
Niels 已提交
3101 3102
    template<class T, typename std::enable_if<
                 std::is_same<basic_json, typename T::value_type>::value and
3103
                 not detail::has_mapped_type<T>::value, int>::type = 0>
N
Niels Lohmann 已提交
3104
    T get_impl(T* /*unused*/) const
N
Niels 已提交
3105
    {
N
Niels 已提交
3106 3107 3108 3109
        if (is_array())
        {
            return T(m_value.array->begin(), m_value.array->end());
        }
N
Niels Lohmann 已提交
3110

3111
        JSON_THROW(std::domain_error("type must be array, but is " + type_name()));
N
Niels 已提交
3112 3113
    }

N
Niels 已提交
3114
    /// get an array (explicit)
N
Niels Lohmann 已提交
3115
    array_t get_impl(array_t* /*unused*/) const
N
Niels 已提交
3116
    {
N
Niels 已提交
3117 3118 3119 3120
        if (is_array())
        {
            return *(m_value.array);
        }
N
Niels Lohmann 已提交
3121

3122
        JSON_THROW(std::domain_error("type must be array, but is " + type_name()));
N
Niels 已提交
3123 3124 3125
    }

    /// get a string (explicit)
N
Niels 已提交
3126 3127
    template<typename T, typename std::enable_if<
                 std::is_convertible<string_t, T>::value, int>::type = 0>
N
Niels Lohmann 已提交
3128
    T get_impl(T* /*unused*/) const
N
Niels 已提交
3129
    {
N
Niels 已提交
3130 3131 3132 3133
        if (is_string())
        {
            return *m_value.string;
        }
N
Niels Lohmann 已提交
3134

3135
        JSON_THROW(std::domain_error("type must be string, but is " + type_name()));
N
Niels 已提交
3136 3137
    }

N
Niels 已提交
3138
    /// get a number (explicit)
N
Niels 已提交
3139 3140
    template<typename T, typename std::enable_if<
                 std::is_arithmetic<T>::value, int>::type = 0>
N
Niels Lohmann 已提交
3141
    T get_impl(T* /*unused*/) const
N
Niels 已提交
3142 3143 3144
    {
        switch (m_type)
        {
3145
            case value_t::number_integer:
N
Niels 已提交
3146
            {
N
Niels 已提交
3147
                return static_cast<T>(m_value.number_integer);
N
Niels 已提交
3148
            }
N
Niels 已提交
3149

3150 3151 3152 3153
            case value_t::number_unsigned:
            {
                return static_cast<T>(m_value.number_unsigned);
            }
3154 3155

            case value_t::number_float:
N
Niels 已提交
3156
            {
N
Niels 已提交
3157
                return static_cast<T>(m_value.number_float);
N
Niels 已提交
3158
            }
3159

N
Niels 已提交
3160
            default:
N
Niels 已提交
3161
            {
3162
                JSON_THROW(std::domain_error("type must be number, but is " + type_name()));
N
Niels 已提交
3163 3164 3165 3166 3167
            }
        }
    }

    /// get a boolean (explicit)
3168
    boolean_t get_impl(boolean_t* /*unused*/) const
N
Niels 已提交
3169
    {
3170 3171 3172 3173 3174 3175 3176 3177
        if (is_boolean())
        {
            return m_value.boolean;
        }
        else
        {
            JSON_THROW(std::domain_error("type must be boolean, but is " + type_name()));
        }
N
Niels 已提交
3178 3179
    }

N
Niels 已提交
3180
    /// get a pointer to the value (object)
N
Niels Lohmann 已提交
3181
    object_t* get_impl_ptr(object_t* /*unused*/) noexcept
N
Niels 已提交
3182 3183 3184 3185
    {
        return is_object() ? m_value.object : nullptr;
    }

N
Niels 已提交
3186
    /// get a pointer to the value (object)
N
Niels Lohmann 已提交
3187
    constexpr const object_t* get_impl_ptr(const object_t* /*unused*/) const noexcept
N
Niels 已提交
3188 3189 3190 3191 3192
    {
        return is_object() ? m_value.object : nullptr;
    }

    /// get a pointer to the value (array)
N
Niels Lohmann 已提交
3193
    array_t* get_impl_ptr(array_t* /*unused*/) noexcept
N
Niels 已提交
3194 3195 3196 3197
    {
        return is_array() ? m_value.array : nullptr;
    }

N
Niels 已提交
3198
    /// get a pointer to the value (array)
N
Niels Lohmann 已提交
3199
    constexpr const array_t* get_impl_ptr(const array_t* /*unused*/) const noexcept
N
Niels 已提交
3200 3201 3202 3203 3204
    {
        return is_array() ? m_value.array : nullptr;
    }

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

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

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

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

    /// get a pointer to the value (integer number)
N
Niels Lohmann 已提交
3229
    number_integer_t* get_impl_ptr(number_integer_t* /*unused*/) noexcept
N
Niels 已提交
3230 3231 3232 3233 3234
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }

    /// get a pointer to the value (integer number)
N
Niels Lohmann 已提交
3235
    constexpr const number_integer_t* get_impl_ptr(const number_integer_t* /*unused*/) const noexcept
N
Niels 已提交
3236 3237 3238
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }
N
Niels 已提交
3239

3240
    /// get a pointer to the value (unsigned number)
N
Niels Lohmann 已提交
3241
    number_unsigned_t* get_impl_ptr(number_unsigned_t* /*unused*/) noexcept
3242 3243 3244
    {
        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
    }
N
Niels 已提交
3245

3246
    /// get a pointer to the value (unsigned number)
N
Niels Lohmann 已提交
3247
    constexpr const number_unsigned_t* get_impl_ptr(const number_unsigned_t* /*unused*/) const noexcept
3248 3249 3250
    {
        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
    }
N
Niels 已提交
3251

N
Niels 已提交
3252
    /// get a pointer to the value (floating-point number)
N
Niels Lohmann 已提交
3253
    number_float_t* get_impl_ptr(number_float_t* /*unused*/) noexcept
N
Niels 已提交
3254 3255 3256 3257 3258
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

    /// get a pointer to the value (floating-point number)
N
Niels Lohmann 已提交
3259
    constexpr const number_float_t* get_impl_ptr(const number_float_t* /*unused*/) const noexcept
N
Niels 已提交
3260 3261 3262 3263
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

N
Niels 已提交
3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275
    /*!
    @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>
3276
    static ReferenceType get_ref_impl(ThisType& obj)
D
dariomt 已提交
3277
    {
N
Niels 已提交
3278
        // helper type
N
Niels 已提交
3279 3280
        using PointerType = typename std::add_pointer<ReferenceType>::type;

N
Niels 已提交
3281
        // delegate the call to get_ptr<>()
3282 3283 3284 3285 3286 3287
        auto ptr = obj.template get_ptr<PointerType>();

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

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

N
Niels 已提交
3293
  public:
N
Niels 已提交
3294 3295

    /// @name value access
N
Niels 已提交
3296
    /// Direct access to the stored value of a JSON value.
N
Niels 已提交
3297 3298
    /// @{

N
Niels 已提交
3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310
    /*!
    @brief get a value (explicit)

    Explicit type conversion between the JSON value and a compatible value.

    @tparam ValueType non-pointer type compatible to the JSON value, for
    instance `int` for JSON integer numbers, `bool` for JSON booleans, or
    `std::vector` types for JSON arrays

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

    @throw std::domain_error in case passed type @a ValueType is incompatible
N
Niels 已提交
3311
    to JSON; example: `"type must be object, but is null"`
N
Niels 已提交
3312 3313 3314

    @complexity Linear in the size of the JSON value.

N
Niels 已提交
3315
    @liveexample{The example below shows several conversions from JSON values
N
Niels 已提交
3316 3317 3318
    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 已提交
3319
    associative containers such as `std::unordered_map<std::string\,
N
Niels 已提交
3320 3321 3322 3323 3324 3325 3326 3327 3328
    json>`.,get__ValueType_const}

    @internal
    The idea of using a casted null pointer to choose the correct
    implementation is from <http://stackoverflow.com/a/8315197/266378>.
    @endinternal

    @sa @ref operator ValueType() const for implicit conversion
    @sa @ref get() for pointer-member access
N
Niels 已提交
3329

N
Niels 已提交
3330
    @since version 1.0.0
N
Niels 已提交
3331
    */
3332
    template <typename ValueType,
3333
              enable_if_t<not std::is_pointer<ValueType>::value, int> = 0>
3334
    auto get() const
3335
    -> decltype(this->get_impl(static_cast<ValueType*>(nullptr)))
3336
    {
3337
        return get_impl(static_cast<ValueType*>(nullptr));
3338 3339
    }

T
Théo DELRIEU 已提交
3340 3341
    template <
        typename T,
3342
        enable_if_t<detail::conjunction<detail::negation<detail::is_compatible_basic_json_type<
3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356
                                            uncvref_t<T>, basic_json_t>>,
                                        detail::has_from_json<JSONSerializer, basic_json_t,
                                                uncvref_t<T>>>::value,
                                                int> = 0 >
                    auto get() const -> uncvref_t<T>
    {
        using type = uncvref_t<T>;
        static_assert(std::is_default_constructible<type>::value&&
        std::is_copy_constructible<type>::value,
        "user-defined types must be DefaultConstructible and "
        "CopyConstructible when used with get");
        type ret;
        JSONSerializer<type>::from_json(*this, ret);
        return ret;
3357
    }
3358

3359 3360 3361
    // This overload is chosen for non-default constructible user-defined-types
    template <
        typename T,
3362
        enable_if_t<detail::conjunction<detail::negation<detail::is_compatible_basic_json_type<
3363 3364 3365 3366 3367
                                            uncvref_t<T>, basic_json_t>>,
                                        detail::has_non_default_from_json<JSONSerializer, basic_json_t,
                                                uncvref_t<T>>>::value,
                                                short> = 0 >
                    T get() const
3368
    {
3369
        return JSONSerializer<T>::from_json(*this);
3370 3371
    }

N
Niels 已提交
3372 3373 3374 3375 3376 3377
    /*!
    @brief get a pointer value (explicit)

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

N
Niels 已提交
3378 3379
    @warning The pointer becomes invalid if the underlying JSON object
    changes.
N
Niels 已提交
3380 3381

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

N
Niels 已提交
3385 3386
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
3387 3388 3389 3390 3391 3392 3393 3394 3395

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

N
Niels 已提交
3397
    @since version 1.0.0
N
Niels 已提交
3398
    */
N
Niels 已提交
3399 3400
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3401 3402 3403 3404 3405 3406 3407 3408 3409 3410
    PointerType get() noexcept
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

    /*!
    @brief get a pointer value (explicit)
    @copydoc get()
    */
N
Niels 已提交
3411 3412
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3413
    constexpr const PointerType get() const noexcept
N
Niels 已提交
3414 3415 3416 3417 3418 3419 3420 3421
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

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

N
Niels 已提交
3422
    Implicit pointer access to the internally stored JSON value. No copies are
N
Niels 已提交
3423 3424 3425 3426 3427 3428
    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 已提交
3429
    object_t, @ref string_t, @ref boolean_t, @ref number_integer_t,
N
Niels 已提交
3430 3431
    @ref number_unsigned_t, or @ref number_float_t. Enforced by a static
    assertion.
N
Niels 已提交
3432

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

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

N
Niels 已提交
3443
    @since version 1.0.0
N
Niels 已提交
3444
    */
N
Niels 已提交
3445 3446
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3447 3448
    PointerType get_ptr() noexcept
    {
N
Niels 已提交
3449 3450
        // get the type of the PointerType (remove pointer and const)
        using pointee_t = typename std::remove_const<typename
3451 3452
                std::remove_pointer<typename
                                    std::remove_const<PointerType>::type>::type>::type;
N
Niels 已提交
3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463
        // 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 已提交
3464 3465 3466 3467 3468 3469 3470 3471
        // 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 已提交
3472 3473 3474
    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 已提交
3475
    constexpr const PointerType get_ptr() const noexcept
N
Niels 已提交
3476
    {
N
Niels 已提交
3477 3478
        // get the type of the PointerType (remove pointer and const)
        using pointee_t = typename std::remove_const<typename
3479 3480
                std::remove_pointer<typename
                                    std::remove_const<PointerType>::type>::type>::type;
N
Niels 已提交
3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491
        // 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 已提交
3492
        // delegate the call to get_impl_ptr<>() const
D
dariomt 已提交
3493
        return get_impl_ptr(static_cast<const PointerType>(nullptr));
D
dariomt 已提交
3494 3495
    }

N
Niels 已提交
3496
    /*!
D
dariomt 已提交
3497 3498
    @brief get a reference value (implicit)

N
Niels 已提交
3499 3500
    Implict reference access to the internally stored JSON value. No copies
    are made.
D
dariomt 已提交
3501 3502 3503 3504

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

N
Niels 已提交
3505 3506
    @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 已提交
3507
    @ref number_float_t. Enforced by static assertion.
D
dariomt 已提交
3508

N
Niels 已提交
3509 3510 3511
    @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 已提交
3512

N
Niels 已提交
3513 3514
    @throw std::domain_error in case passed type @a ReferenceType is
    incompatible with the stored JSON value
D
dariomt 已提交
3515 3516

    @complexity Constant.
N
Niels 已提交
3517 3518 3519

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

N
Niels 已提交
3520
    @since version 1.1.0
D
dariomt 已提交
3521
    */
N
Niels 已提交
3522 3523
    template<typename ReferenceType, typename std::enable_if<
                 std::is_reference<ReferenceType>::value, int>::type = 0>
D
dariomt 已提交
3524 3525
    ReferenceType get_ref()
    {
N
Niels 已提交
3526 3527
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
D
dariomt 已提交
3528 3529 3530 3531 3532 3533
    }

    /*!
    @brief get a reference value (implicit)
    @copydoc get_ref()
    */
N
Niels 已提交
3534 3535 3536
    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>
3537
    ReferenceType get_ref() const
D
dariomt 已提交
3538
    {
N
Niels 已提交
3539 3540
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
N
Niels 已提交
3541 3542 3543 3544 3545
    }

    /*!
    @brief get a value (implicit)

N
Niels 已提交
3546 3547
    Implicit type conversion between the JSON value and a compatible value.
    The call is realized by calling @ref get() const.
N
Niels 已提交
3548 3549 3550

    @tparam ValueType non-pointer type compatible to the JSON value, for
    instance `int` for JSON integer numbers, `bool` for JSON booleans, or
N
Niels 已提交
3551 3552 3553
    `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 已提交
3554 3555 3556 3557 3558 3559 3560 3561

    @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 已提交
3562
    @liveexample{The example below shows several conversions from JSON values
N
Niels 已提交
3563 3564 3565
    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 已提交
3566
    associative containers such as `std::unordered_map<std::string\,
N
Niels 已提交
3567
    json>`.,operator__ValueType}
N
Niels 已提交
3568

N
Niels 已提交
3569
    @since version 1.0.0
N
Niels 已提交
3570
    */
N
Niels 已提交
3571 3572 3573
    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 已提交
3574
#ifndef _MSC_VER  // fix for issue #167 operator<< abiguity under VS2015
N
Niels 已提交
3575
                   and not std::is_same<ValueType, std::initializer_list<typename string_t::value_type>>::value
3576
#endif
N
Niels 已提交
3577
                   , int >::type = 0 >
N
Niels 已提交
3578
    operator ValueType() const
N
Niels 已提交
3579
    {
N
Niels 已提交
3580 3581
        // delegate the call to get<>() const
        return get<ValueType>();
N
Niels 已提交
3582 3583
    }

N
Niels 已提交
3584 3585
    /// @}

N
Niels 已提交
3586 3587 3588 3589 3590

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

N
Niels 已提交
3591
    /// @name element access
N
Niels 已提交
3592
    /// Access to the JSON value.
N
Niels 已提交
3593 3594
    /// @{

N
Niels 已提交
3595 3596 3597 3598 3599 3600 3601 3602 3603 3604
    /*!
    @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 已提交
3605 3606
    @throw std::domain_error if the JSON value is not an array; example:
    `"cannot use at() with string"`
N
Niels 已提交
3607
    @throw std::out_of_range if the index @a idx is out of range of the array;
N
Niels 已提交
3608
    that is, `idx >= size()`; example: `"array index 7 is out of range"`
N
Niels 已提交
3609 3610 3611 3612

    @complexity Constant.

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

N
Niels 已提交
3615
    @since version 1.0.0
N
Niels 已提交
3616
    */
N
Niels 已提交
3617
    reference at(size_type idx)
N
Niels 已提交
3618 3619
    {
        // at only works for arrays
3620 3621
        if (is_array())
        {
3622
            JSON_TRY
N
Niels 已提交
3623 3624 3625
            {
                return m_value.array->at(idx);
            }
3626
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3627 3628
            {
                // create better exception explanation
3629
                JSON_THROW(std::out_of_range("array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
3630
            }
3631 3632
        }
        else
N
Niels 已提交
3633
        {
3634
            JSON_THROW(std::domain_error("cannot use at() with " + type_name()));
N
Niels 已提交
3635 3636 3637
        }
    }

N
Niels 已提交
3638 3639 3640
    /*!
    @brief access specified array element with bounds checking

N
Niels 已提交
3641 3642
    Returns a const reference to the element at specified location @a idx,
    with bounds checking.
N
Niels 已提交
3643 3644 3645 3646 3647

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

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

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

    @complexity Constant.

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

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

N
Niels 已提交
3681 3682 3683 3684 3685 3686 3687 3688 3689 3690
    /*!
    @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 已提交
3691 3692
    @throw std::domain_error if the JSON value is not an object; example:
    `"cannot use at() with boolean"`
N
Niels 已提交
3693
    @throw std::out_of_range if the key @a key is is not stored in the object;
N
Niels 已提交
3694
    that is, `find(key) == end()`; example: `"key "the fast" not found"`
N
Niels 已提交
3695 3696 3697 3698

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3699
    written using `at()`.,at__object_t_key_type}
N
Niels 已提交
3700 3701 3702 3703

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

N
Niels 已提交
3705
    @since version 1.0.0
N
Niels 已提交
3706
    */
N
Niels 已提交
3707
    reference at(const typename object_t::key_type& key)
3708 3709
    {
        // at only works for objects
3710 3711
        if (is_object())
        {
3712
            JSON_TRY
N
Niels 已提交
3713 3714 3715
            {
                return m_value.object->at(key);
            }
3716
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3717 3718
            {
                // create better exception explanation
3719
                JSON_THROW(std::out_of_range("key '" + key + "' not found"));
N
Niels 已提交
3720
            }
3721 3722
        }
        else
3723
        {
3724
            JSON_THROW(std::domain_error("cannot use at() with " + type_name()));
3725 3726 3727
        }
    }

N
Niels 已提交
3728 3729 3730
    /*!
    @brief access specified object element with bounds checking

N
Niels 已提交
3731 3732
    Returns a const reference to the element at with specified key @a key,
    with bounds checking.
N
Niels 已提交
3733 3734 3735 3736 3737

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

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

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

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3746
    `at()`.,at__object_t_key_type_const}
N
Niels 已提交
3747 3748 3749 3750

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

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

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

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

N
Niels 已提交
3798
    @since version 1.0.0
N
Niels 已提交
3799
    */
N
Niels 已提交
3800
    reference operator[](size_type idx)
N
Niels 已提交
3801
    {
N
Niels 已提交
3802
        // implicitly convert null value to an empty array
N
cleanup  
Niels 已提交
3803
        if (is_null())
N
Niels 已提交
3804 3805
        {
            m_type = value_t::array;
N
Cleanup  
Niels 已提交
3806
            m_value.array = create<array_t>();
3807
            assert_invariant();
N
Niels 已提交
3808 3809
        }

N
Niels 已提交
3810
        // operator[] only works for arrays
N
cleanup  
Niels 已提交
3811
        if (is_array())
N
Niels 已提交
3812
        {
N
Niels 已提交
3813 3814
            // fill up array with null values if given idx is outside range
            if (idx >= m_value.array->size())
N
cleanup  
Niels 已提交
3815
            {
N
Niels 已提交
3816 3817 3818
                m_value.array->insert(m_value.array->end(),
                                      idx - m_value.array->size() + 1,
                                      basic_json());
N
cleanup  
Niels 已提交
3819
            }
N
Niels 已提交
3820

N
cleanup  
Niels 已提交
3821 3822
            return m_value.array->operator[](idx);
        }
N
Niels Lohmann 已提交
3823

3824
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
N
Niels 已提交
3825 3826
    }

N
Niels 已提交
3827 3828 3829 3830 3831 3832 3833 3834 3835
    /*!
    @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 已提交
3836 3837
    @throw std::domain_error if JSON is not an array; example: `"cannot use
    operator[] with null"`
N
Niels 已提交
3838 3839 3840 3841

    @complexity Constant.

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

N
Niels 已提交
3844
    @since version 1.0.0
N
Niels 已提交
3845
    */
N
Niels 已提交
3846
    const_reference operator[](size_type idx) const
N
Niels 已提交
3847
    {
N
Niels 已提交
3848
        // const operator[] only works for arrays
N
Niels 已提交
3849 3850 3851 3852
        if (is_array())
        {
            return m_value.array->operator[](idx);
        }
N
Niels Lohmann 已提交
3853

3854
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
N
Niels 已提交
3855 3856
    }

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

    @complexity Logarithmic in the size of the container.

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

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

N
Niels 已提交
3882
    @since version 1.0.0
N
Niels 已提交
3883
    */
N
Niels 已提交
3884
    reference operator[](const typename object_t::key_type& key)
N
Niels 已提交
3885
    {
N
Niels 已提交
3886
        // implicitly convert null value to an empty object
N
cleanup  
Niels 已提交
3887
        if (is_null())
N
Niels 已提交
3888 3889
        {
            m_type = value_t::object;
N
Cleanup  
Niels 已提交
3890
            m_value.object = create<object_t>();
3891
            assert_invariant();
N
Niels 已提交
3892 3893
        }

N
Niels 已提交
3894
        // operator[] only works for objects
N
Niels 已提交
3895 3896 3897 3898
        if (is_object())
        {
            return m_value.object->operator[](key);
        }
N
Niels Lohmann 已提交
3899

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

N
Niels 已提交
3903
    /*!
3904
    @brief read-only access specified object element
N
Niels 已提交
3905

3906 3907 3908 3909 3910
    Returns a const reference to the element at with specified key @a key. No
    bounds checking is performed.

    @warning If the element with key @a key does not exist, the behavior is
    undefined.
N
Niels 已提交
3911 3912 3913

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

3914
    @return const reference to the element at key @a key
N
Niels 已提交
3915

N
Niels 已提交
3916 3917 3918
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

N
Niels 已提交
3919 3920
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    operator[] with null"`
N
Niels 已提交
3921 3922 3923 3924

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
3925
    the `[]` operator.,operatorarray__key_type_const}
3926 3927 3928 3929 3930

    @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 已提交
3931
    @since version 1.0.0
N
Niels 已提交
3932
    */
N
Niels 已提交
3933
    const_reference operator[](const typename object_t::key_type& key) const
3934
    {
N
Niels 已提交
3935
        // const operator[] only works for objects
N
Niels 已提交
3936 3937 3938 3939 3940
        if (is_object())
        {
            assert(m_value.object->find(key) != m_value.object->end());
            return m_value.object->find(key)->second;
        }
N
Niels Lohmann 已提交
3941

3942
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
3943 3944
    }

N
Niels 已提交
3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957
    /*!
    @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 已提交
3958
    @throw std::domain_error if JSON is not an object or null; example:
N
Niels 已提交
3959
    `"cannot use operator[] with string"`
N
Niels 已提交
3960 3961 3962 3963

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
3964
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
3965 3966 3967 3968

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

N
Niels 已提交
3970
    @since version 1.0.0
N
Niels 已提交
3971
    */
N
Niels 已提交
3972
    template<typename T, std::size_t n>
N
Niels 已提交
3973
    reference operator[](T * (&key)[n])
3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998
    {
        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 已提交
3999
    the `[]` operator.,operatorarray__key_type_const}
4000 4001 4002 4003 4004 4005 4006 4007

    @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 已提交
4008
    const_reference operator[](T * (&key)[n]) const
4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026
    {
        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 已提交
4027
    `"cannot use operator[] with string"`
4028 4029 4030 4031

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
4032
    written using the `[]` operator.,operatorarray__key_type}
4033 4034 4035 4036 4037

    @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 已提交
4038
    @since version 1.1.0
4039 4040 4041
    */
    template<typename T>
    reference operator[](T* key)
N
Niels 已提交
4042
    {
N
Niels 已提交
4043
        // implicitly convert null to object
N
cleanup  
Niels 已提交
4044
        if (is_null())
N
Niels 已提交
4045 4046
        {
            m_type = value_t::object;
N
Niels 已提交
4047
            m_value = value_t::object;
4048
            assert_invariant();
N
Niels 已提交
4049 4050
        }

N
Niels 已提交
4051
        // at only works for objects
N
Niels 已提交
4052 4053 4054 4055
        if (is_object())
        {
            return m_value.object->operator[](key);
        }
N
Niels Lohmann 已提交
4056

4057
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
N
Niels 已提交
4058 4059
    }

N
Niels 已提交
4060
    /*!
4061
    @brief read-only access specified object element
N
Niels 已提交
4062

4063 4064 4065 4066 4067
    Returns a const reference to the element at with specified key @a key. No
    bounds checking is performed.

    @warning If the element with key @a key does not exist, the behavior is
    undefined.
N
Niels 已提交
4068 4069 4070

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

4071
    @return const reference to the element at key @a key
N
Niels 已提交
4072

N
Niels 已提交
4073 4074 4075
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

N
Niels 已提交
4076 4077
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    operator[] with null"`
N
Niels 已提交
4078 4079 4080 4081

    @complexity Logarithmic in the size of the container.

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

    @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 已提交
4088
    @since version 1.1.0
N
Niels 已提交
4089
    */
4090 4091
    template<typename T>
    const_reference operator[](T* key) const
4092 4093
    {
        // at only works for objects
N
Niels 已提交
4094 4095 4096 4097 4098
        if (is_object())
        {
            assert(m_value.object->find(key) != m_value.object->end());
            return m_value.object->find(key)->second;
        }
N
Niels Lohmann 已提交
4099

4100
        JSON_THROW(std::domain_error("cannot use operator[] with " + type_name()));
4101 4102
    }

N
Niels 已提交
4103 4104 4105
    /*!
    @brief access specified object element with default value

N
Niels 已提交
4106 4107
    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.
4108

N
Niels 已提交
4109
    The function is basically equivalent to executing
4110
    @code {.cpp}
N
Niels 已提交
4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135
    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 已提交
4136 4137
    @throw std::domain_error if JSON is not an object; example: `"cannot use
    value() with null"`
N
Niels 已提交
4138 4139 4140 4141 4142 4143 4144 4145 4146 4147

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

N
Niels 已提交
4149
    @since version 1.0.0
N
Niels 已提交
4150
    */
N
Niels 已提交
4151 4152
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163
    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 已提交
4164 4165

            return default_value;
N
Niels 已提交
4166 4167 4168
        }
        else
        {
4169
            JSON_THROW(std::domain_error("cannot use value() with " + type_name()));
N
Niels 已提交
4170 4171 4172 4173
        }
    }

    /*!
N
Niels 已提交
4174
    @brief overload for a default value of type const char*
N
Niels 已提交
4175
    @copydoc basic_json::value(const typename object_t::key_type&, ValueType) const
N
Niels 已提交
4176 4177 4178 4179
    */
    string_t value(const typename object_t::key_type& key, const char* default_value) const
    {
        return value(key, string_t(default_value));
4180 4181
    }

N
Niels 已提交
4182 4183 4184
    /*!
    @brief access specified object element via JSON Pointer with default value

N
Niels 已提交
4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199
    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 已提交
4200 4201 4202 4203 4204 4205 4206 4207
    @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 已提交
4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218
    @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 已提交
4219
    @sa @ref operator[](const json_pointer&) for unchecked access by reference
N
Niels 已提交
4220

N
Niels 已提交
4221 4222
    @since version 2.0.2
    */
N
Niels 已提交
4223 4224
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
4225 4226 4227 4228 4229 4230
    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
4231
            JSON_TRY
N
Niels 已提交
4232 4233 4234
            {
                return ptr.get_checked(this);
            }
4235
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
4236 4237 4238 4239
            {
                return default_value;
            }
        }
N
Niels Lohmann 已提交
4240

4241
        JSON_THROW(std::domain_error("cannot use value() with " + type_name()));
N
Niels 已提交
4242 4243 4244 4245
    }

    /*!
    @brief overload for a default value of type const char*
N
Niels 已提交
4246
    @copydoc basic_json::value(const json_pointer&, ValueType) const
N
Niels 已提交
4247 4248 4249 4250 4251 4252
    */
    string_t value(const json_pointer& ptr, const char* default_value) const
    {
        return value(ptr, string_t(default_value));
    }

N
Niels 已提交
4253 4254 4255 4256 4257 4258
    /*!
    @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 已提交
4259
    @return In case of a structured type (array or object), a reference to the
4260
    first element is returned. In case of number, string, or boolean values, a
N
Niels 已提交
4261 4262 4263 4264
    reference to the value is returned.

    @complexity Constant.

N
Niels 已提交
4265
    @pre The JSON value must not be `null` (would throw `std::out_of_range`)
N
Niels 已提交
4266 4267
    or an empty array or object (undefined behavior, **guarded by
    assertions**).
N
Niels 已提交
4268 4269 4270
    @post The JSON value remains unchanged.

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

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

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

N
Niels 已提交
4276
    @since version 1.0.0
N
Niels 已提交
4277
    */
N
Niels 已提交
4278
    reference front()
N
Niels 已提交
4279 4280 4281 4282
    {
        return *begin();
    }

N
Niels 已提交
4283 4284 4285
    /*!
    @copydoc basic_json::front()
    */
N
Niels 已提交
4286
    const_reference front() const
N
Niels 已提交
4287 4288 4289 4290
    {
        return *cbegin();
    }

N
Niels 已提交
4291 4292 4293 4294
    /*!
    @brief access the last element

    Returns a reference to the last element in the container. For a JSON
N
Niels 已提交
4295 4296 4297 4298 4299 4300
    container `c`, the expression `c.back()` is equivalent to
    @code {.cpp}
    auto tmp = c.end();
    --tmp;
    return *tmp;
    @endcode
N
Niels 已提交
4301

N
Niels 已提交
4302
    @return In case of a structured type (array or object), a reference to the
4303
    last element is returned. In case of number, string, or boolean values, a
N
Niels 已提交
4304 4305 4306 4307
    reference to the value is returned.

    @complexity Constant.

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

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

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

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

N
Niels 已提交
4319
    @since version 1.0.0
N
Niels 已提交
4320
    */
N
Niels 已提交
4321
    reference back()
N
Niels 已提交
4322 4323 4324 4325 4326 4327
    {
        auto tmp = end();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
4328 4329 4330
    /*!
    @copydoc basic_json::back()
    */
N
Niels 已提交
4331
    const_reference back() const
N
Niels 已提交
4332 4333 4334 4335 4336 4337
    {
        auto tmp = cend();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
4338 4339 4340
    /*!
    @brief remove element given an iterator

N
Niels 已提交
4341 4342 4343
    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 已提交
4344

N
Niels 已提交
4345
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
4346 4347 4348
    will be `null`.

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

4352
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
4353

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

N
Niels 已提交
4357 4358
    @throw std::domain_error if called on a `null` value; example: `"cannot
    use erase() with null"`
N
Niels 已提交
4359
    @throw std::domain_error if called on an iterator which does not belong to
N
Niels 已提交
4360
    the current JSON value; example: `"iterator does not fit current value"`
N
Niels 已提交
4361
    @throw std::out_of_range if called on a primitive type with invalid
N
Niels 已提交
4362 4363
    iterator (i.e., any iterator which is not `begin()`); example: `"iterator
    out of range"`
N
Niels 已提交
4364 4365 4366 4367 4368 4369 4370

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

4374
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4375
    the given range
N
Niels 已提交
4376
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4377
    from an object at the given key
N
Niels 已提交
4378 4379
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4380

N
Niels 已提交
4381
    @since version 1.0.0
N
Niels 已提交
4382
    */
N
Niels 已提交
4383 4384 4385 4386
    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>
4387
    IteratorType erase(IteratorType pos)
4388 4389
    {
        // make sure iterator fits the current value
N
Niels 已提交
4390
        if (this != pos.m_object)
4391
        {
4392
            JSON_THROW(std::domain_error("iterator does not fit current value"));
4393 4394
        }

4395
        IteratorType result = end();
4396 4397 4398 4399

        switch (m_type)
        {
            case value_t::boolean:
4400 4401
            case value_t::number_float:
            case value_t::number_integer:
4402
            case value_t::number_unsigned:
4403 4404
            case value_t::string:
            {
4405
                if (not pos.m_it.primitive_iterator.is_begin())
4406
                {
4407
                    JSON_THROW(std::out_of_range("iterator out of range"));
4408 4409
                }

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

                m_type = value_t::null;
4419
                assert_invariant();
4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436
                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:
            {
4437
                JSON_THROW(std::domain_error("cannot use erase() with " + type_name()));
4438 4439 4440 4441 4442 4443
            }
        }

        return result;
    }

N
Niels 已提交
4444 4445 4446
    /*!
    @brief remove elements given an iterator range

N
Niels 已提交
4447 4448 4449
    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 已提交
4450

N
Niels 已提交
4451
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
4452 4453 4454 4455 4456
    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 已提交
4457
    second refers to the last element, the `end()` iterator is returned.
N
Niels 已提交
4458

4459
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
4460

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

N
Niels 已提交
4464 4465
    @throw std::domain_error if called on a `null` value; example: `"cannot
    use erase() with null"`
N
Niels 已提交
4466
    @throw std::domain_error if called on iterators which does not belong to
N
Niels 已提交
4467
    the current JSON value; example: `"iterators do not fit current value"`
N
Niels 已提交
4468
    @throw std::out_of_range if called on a primitive type with invalid
N
Niels 已提交
4469 4470
    iterators (i.e., if `first != begin()` and `last != end()`); example:
    `"iterators out of range"`
N
Niels 已提交
4471 4472 4473 4474 4475 4476 4477 4478

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

4482
    @sa @ref erase(IteratorType) -- removes the element at a given position
N
Niels 已提交
4483
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4484
    from an object at the given key
N
Niels 已提交
4485 4486
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4487

N
Niels 已提交
4488
    @since version 1.0.0
N
Niels 已提交
4489
    */
N
Niels 已提交
4490 4491 4492 4493
    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>
4494
    IteratorType erase(IteratorType first, IteratorType last)
4495 4496
    {
        // make sure iterator fits the current value
N
Niels 已提交
4497
        if (this != first.m_object or this != last.m_object)
4498
        {
4499
            JSON_THROW(std::domain_error("iterators do not fit current value"));
4500 4501
        }

4502
        IteratorType result = end();
4503 4504 4505 4506

        switch (m_type)
        {
            case value_t::boolean:
4507 4508
            case value_t::number_float:
            case value_t::number_integer:
4509
            case value_t::number_unsigned:
4510 4511
            case value_t::string:
            {
4512
                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
4513
                {
4514
                    JSON_THROW(std::out_of_range("iterators out of range"));
4515 4516
                }

N
cleanup  
Niels 已提交
4517
                if (is_string())
4518
                {
4519 4520 4521
                    AllocatorType<string_t> alloc;
                    alloc.destroy(m_value.string);
                    alloc.deallocate(m_value.string, 1);
4522 4523 4524 4525
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
4526
                assert_invariant();
4527 4528 4529 4530 4531 4532
                break;
            }

            case value_t::object:
            {
                result.m_it.object_iterator = m_value.object->erase(first.m_it.object_iterator,
4533
                        last.m_it.object_iterator);
4534 4535 4536 4537 4538 4539
                break;
            }

            case value_t::array:
            {
                result.m_it.array_iterator = m_value.array->erase(first.m_it.array_iterator,
4540
                        last.m_it.array_iterator);
4541 4542 4543 4544 4545
                break;
            }

            default:
            {
4546
                JSON_THROW(std::domain_error("cannot use erase() with " + type_name()));
4547 4548 4549 4550 4551 4552
            }
        }

        return result;
    }

N
Niels 已提交
4553 4554 4555 4556 4557 4558 4559
    /*!
    @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 已提交
4560
    @return Number of elements removed. If @a ObjectType is the default
N
Niels 已提交
4561 4562
    `std::map` type, the return value will always be `0` (@a key was not
    found) or `1` (@a key was found).
N
Niels 已提交
4563 4564 4565

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

N
Niels 已提交
4567 4568
    @throw std::domain_error when called on a type other than JSON object;
    example: `"cannot use erase() with null"`
N
Niels 已提交
4569 4570 4571

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

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

4574 4575
    @sa @ref erase(IteratorType) -- removes the element at a given position
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4576 4577 4578
    the given range
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4579

N
Niels 已提交
4580
    @since version 1.0.0
N
Niels 已提交
4581
    */
N
Niels 已提交
4582
    size_type erase(const typename object_t::key_type& key)
4583
    {
N
Niels 已提交
4584
        // this erase only works for objects
N
Niels 已提交
4585 4586 4587 4588
        if (is_object())
        {
            return m_value.object->erase(key);
        }
N
Niels Lohmann 已提交
4589

4590
        JSON_THROW(std::domain_error("cannot use erase() with " + type_name()));
4591 4592
    }

N
Niels 已提交
4593 4594 4595 4596 4597 4598 4599
    /*!
    @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 已提交
4600 4601
    @throw std::domain_error when called on a type other than JSON array;
    example: `"cannot use erase() with null"`
N
Niels 已提交
4602 4603
    @throw std::out_of_range when `idx >= size()`; example: `"array index 17
    is out of range"`
N
Niels 已提交
4604 4605 4606

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

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

4609 4610
    @sa @ref erase(IteratorType) -- removes the element at a given position
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4611
    the given range
N
Niels 已提交
4612
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4613 4614
    from an object at the given key

N
Niels 已提交
4615
    @since version 1.0.0
N
Niels 已提交
4616
    */
N
Niels 已提交
4617
    void erase(const size_type idx)
N
Niels 已提交
4618 4619
    {
        // this erase only works for arrays
N
cleanup  
Niels 已提交
4620
        if (is_array())
N
Niels 已提交
4621
        {
N
cleanup  
Niels 已提交
4622 4623
            if (idx >= size())
            {
4624
                JSON_THROW(std::out_of_range("array index " + std::to_string(idx) + " is out of range"));
N
cleanup  
Niels 已提交
4625
            }
N
Niels 已提交
4626

N
cleanup  
Niels 已提交
4627 4628 4629
            m_value.array->erase(m_value.array->begin() + static_cast<difference_type>(idx));
        }
        else
N
Niels 已提交
4630
        {
4631
            JSON_THROW(std::domain_error("cannot use erase() with " + type_name()));
N
Niels 已提交
4632 4633 4634
        }
    }

N
Niels 已提交
4635 4636 4637 4638 4639 4640 4641 4642 4643 4644
    /// @}


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

    /// @name lookup
    /// @{

N
Niels 已提交
4645 4646 4647 4648
    /*!
    @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 已提交
4649 4650
    element is not found or the JSON value is not an object, end() is
    returned.
N
Niels 已提交
4651

4652 4653 4654
    @note This method always returns @ref end() when executed on a JSON type
          that is not an object.

N
Niels 已提交
4655 4656 4657
    @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
4658 4659
    element is found or the JSON value is not an object, past-the-end (see
    @ref end()) iterator is returned.
N
Niels 已提交
4660 4661 4662

    @complexity Logarithmic in the size of the JSON object.

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

N
Niels 已提交
4665
    @since version 1.0.0
N
Niels 已提交
4666
    */
N
Niels 已提交
4667
    iterator find(typename object_t::key_type key)
N
Niels 已提交
4668 4669 4670
    {
        auto result = end();

N
cleanup  
Niels 已提交
4671
        if (is_object())
N
Niels 已提交
4672 4673 4674 4675 4676 4677 4678
        {
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4679 4680 4681 4682
    /*!
    @brief find an element in a JSON object
    @copydoc find(typename object_t::key_type)
    */
N
Niels 已提交
4683
    const_iterator find(typename object_t::key_type key) const
N
Niels 已提交
4684 4685 4686
    {
        auto result = cend();

N
cleanup  
Niels 已提交
4687
        if (is_object())
N
Niels 已提交
4688 4689 4690 4691 4692 4693 4694
        {
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4695 4696 4697 4698 4699 4700 4701
    /*!
    @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).

4702 4703 4704
    @note This method always returns `0` when executed on a JSON type that is
          not an object.

N
Niels 已提交
4705 4706 4707 4708 4709 4710 4711
    @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 已提交
4712
    @liveexample{The example shows how `count()` is used.,count}
N
Niels 已提交
4713

N
Niels 已提交
4714
    @since version 1.0.0
N
Niels 已提交
4715
    */
N
Niels 已提交
4716
    size_type count(typename object_t::key_type key) const
4717 4718
    {
        // return 0 for all nonobject types
N
Niels 已提交
4719
        return is_object() ? m_value.object->count(key) : 0;
4720 4721
    }

N
Niels 已提交
4722 4723
    /// @}

N
Niels 已提交
4724

N
Niels 已提交
4725 4726 4727 4728
    ///////////////
    // iterators //
    ///////////////

N
Niels 已提交
4729 4730 4731
    /// @name iterators
    /// @{

N
Niels 已提交
4732 4733
    /*!
    @brief returns an iterator to the first element
N
Niels 已提交
4734 4735 4736 4737 4738 4739 4740 4741 4742

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

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

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

N
Niels 已提交
4763
    /*!
N
Niels 已提交
4764
    @copydoc basic_json::cbegin()
N
Niels 已提交
4765
    */
N
Niels 已提交
4766
    const_iterator begin() const noexcept
N
Niels 已提交
4767
    {
N
Niels 已提交
4768
        return cbegin();
N
Niels 已提交
4769 4770
    }

N
Niels 已提交
4771 4772
    /*!
    @brief returns a const iterator to the first element
N
Niels 已提交
4773 4774 4775 4776 4777 4778 4779 4780 4781

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

N
Niels 已提交
4788 4789 4790 4791 4792
    @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 已提交
4793

N
Niels 已提交
4794
    @since version 1.0.0
N
Niels 已提交
4795
    */
N
Niels 已提交
4796
    const_iterator cbegin() const noexcept
N
Niels 已提交
4797 4798 4799 4800 4801 4802
    {
        const_iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4803 4804
    /*!
    @brief returns an iterator to one past the last element
N
Niels 已提交
4805 4806 4807 4808 4809 4810 4811 4812 4813

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

N
Niels 已提交
4819 4820 4821 4822 4823
    @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 已提交
4824

N
Niels 已提交
4825
    @since version 1.0.0
N
Niels 已提交
4826
    */
N
Niels 已提交
4827
    iterator end() noexcept
N
Niels 已提交
4828 4829 4830 4831 4832 4833
    {
        iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
4834
    /*!
N
Niels 已提交
4835
    @copydoc basic_json::cend()
N
Niels 已提交
4836
    */
N
Niels 已提交
4837
    const_iterator end() const noexcept
N
Niels 已提交
4838
    {
N
Niels 已提交
4839
        return cend();
N
Niels 已提交
4840 4841
    }

N
Niels 已提交
4842 4843
    /*!
    @brief returns a const iterator to one past the last element
N
Niels 已提交
4844 4845 4846 4847 4848 4849 4850 4851 4852

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

N
Niels 已提交
4859 4860 4861 4862 4863
    @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 已提交
4864

N
Niels 已提交
4865
    @since version 1.0.0
N
Niels 已提交
4866
    */
N
Niels 已提交
4867
    const_iterator cend() const noexcept
N
Niels 已提交
4868 4869 4870 4871 4872 4873
    {
        const_iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
4874
    /*!
N
Niels 已提交
4875 4876 4877 4878 4879 4880 4881 4882
    @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 已提交
4883 4884 4885
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4886 4887 4888
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(end())`.

N
Niels 已提交
4889 4890 4891 4892 4893
    @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 已提交
4894

N
Niels 已提交
4895
    @since version 1.0.0
N
Niels 已提交
4896
    */
N
Niels 已提交
4897
    reverse_iterator rbegin() noexcept
N
Niels 已提交
4898 4899 4900 4901
    {
        return reverse_iterator(end());
    }

N
Niels 已提交
4902
    /*!
N
Niels 已提交
4903
    @copydoc basic_json::crbegin()
N
Niels 已提交
4904
    */
N
Niels 已提交
4905
    const_reverse_iterator rbegin() const noexcept
N
Niels 已提交
4906
    {
N
Niels 已提交
4907
        return crbegin();
N
Niels 已提交
4908 4909
    }

N
Niels 已提交
4910
    /*!
N
Niels 已提交
4911 4912 4913 4914 4915 4916 4917 4918 4919
    @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 已提交
4920 4921 4922
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4923 4924 4925
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(begin())`.

N
Niels 已提交
4926 4927 4928 4929 4930
    @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 已提交
4931

N
Niels 已提交
4932
    @since version 1.0.0
N
Niels 已提交
4933
    */
N
Niels 已提交
4934
    reverse_iterator rend() noexcept
N
Niels 已提交
4935 4936 4937 4938
    {
        return reverse_iterator(begin());
    }

N
Niels 已提交
4939
    /*!
N
Niels 已提交
4940
    @copydoc basic_json::crend()
N
Niels 已提交
4941
    */
N
Niels 已提交
4942
    const_reverse_iterator rend() const noexcept
N
Niels 已提交
4943
    {
N
Niels 已提交
4944
        return crend();
N
Niels 已提交
4945 4946
    }

N
Niels 已提交
4947
    /*!
N
Niels 已提交
4948 4949 4950 4951 4952 4953 4954 4955 4956
    @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 已提交
4957 4958 4959
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4960 4961 4962
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).rbegin()`.

N
Niels 已提交
4963 4964 4965 4966 4967
    @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 已提交
4968

N
Niels 已提交
4969
    @since version 1.0.0
N
Niels 已提交
4970
    */
N
Niels 已提交
4971
    const_reverse_iterator crbegin() const noexcept
N
Niels 已提交
4972 4973 4974 4975
    {
        return const_reverse_iterator(cend());
    }

N
Niels 已提交
4976
    /*!
N
Niels 已提交
4977 4978 4979 4980 4981 4982 4983 4984 4985
    @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 已提交
4986 4987 4988
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
4989 4990 4991
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).rend()`.

N
Niels 已提交
4992 4993 4994 4995 4996
    @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 已提交
4997

N
Niels 已提交
4998
    @since version 1.0.0
N
Niels 已提交
4999
    */
N
Niels 已提交
5000
    const_reverse_iterator crend() const noexcept
N
Niels 已提交
5001 5002 5003 5004
    {
        return const_reverse_iterator(cbegin());
    }

N
cleanup  
Niels 已提交
5005 5006 5007 5008 5009 5010 5011 5012
  private:
    // forward declaration
    template<typename IteratorType> class iteration_proxy;

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

N
Niels 已提交
5013
    This function allows to access @ref iterator::key() and @ref
N
Niels 已提交
5014 5015 5016
    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 已提交
5017 5018 5019

    @note The name of this function is not yet final and may change in the
    future.
N
cleanup  
Niels 已提交
5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033
    */
    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 已提交
5034 5035
    /// @}

N
Niels 已提交
5036 5037 5038 5039 5040

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

N
Niels 已提交
5041 5042 5043
    /// @name capacity
    /// @{

N
Niels 已提交
5044 5045
    /*!
    @brief checks whether the container is empty
N
Niels 已提交
5046 5047 5048

    Checks if a JSON value has no elements.

N
Niels 已提交
5049
    @return The return value depends on the different types and is
N
Niels 已提交
5050 5051 5052
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
5053 5054 5055 5056 5057 5058
            null        | `true`
            boolean     | `false`
            string      | `false`
            number      | `false`
            object      | result of function `object_t::empty()`
            array       | result of function `array_t::empty()`
N
Niels 已提交
5059

N
Niels 已提交
5060 5061 5062 5063
    @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 已提交
5064 5065
    @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 已提交
5066
    complexity.
N
Niels 已提交
5067

N
Niels 已提交
5068 5069 5070
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
5071 5072 5073
    - The complexity is constant.
    - Has the semantics of `begin() == end()`.

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

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

N
Niels 已提交
5079
    @since version 1.0.0
N
Niels 已提交
5080
    */
N
Niels 已提交
5081
    bool empty() const noexcept
N
Niels 已提交
5082 5083 5084
    {
        switch (m_type)
        {
5085
            case value_t::null:
N
Niels 已提交
5086
            {
N
Niels 已提交
5087
                // null values are empty
N
Niels 已提交
5088 5089
                return true;
            }
N
Niels 已提交
5090

5091
            case value_t::array:
N
Niels 已提交
5092
            {
N
Niels 已提交
5093
                // delegate call to array_t::empty()
N
Niels 已提交
5094 5095
                return m_value.array->empty();
            }
N
Niels 已提交
5096

5097
            case value_t::object:
N
Niels 已提交
5098
            {
N
Niels 已提交
5099
                // delegate call to object_t::empty()
N
Niels 已提交
5100 5101
                return m_value.object->empty();
            }
N
Niels 已提交
5102

N
Niels 已提交
5103 5104 5105 5106 5107 5108
            default:
            {
                // all other types are nonempty
                return false;
            }
        }
N
Niels 已提交
5109 5110
    }

N
Niels 已提交
5111 5112
    /*!
    @brief returns the number of elements
N
Niels 已提交
5113 5114 5115

    Returns the number of elements in a JSON value.

N
Niels 已提交
5116
    @return The return value depends on the different types and is
N
Niels 已提交
5117 5118 5119
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
5120 5121 5122 5123
            null        | `0`
            boolean     | `1`
            string      | `1`
            number      | `1`
N
Niels 已提交
5124 5125 5126
            object      | result of function object_t::size()
            array       | result of function array_t::size()

N
Niels 已提交
5127 5128 5129 5130
    @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 已提交
5131 5132 5133
    @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 已提交
5134

N
Niels 已提交
5135 5136 5137
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
5138 5139 5140
    - The complexity is constant.
    - Has the semantics of `std::distance(begin(), end())`.

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

N
Niels 已提交
5144 5145 5146
    @sa @ref empty() -- checks whether the container is empty
    @sa @ref max_size() -- returns the maximal number of elements

N
Niels 已提交
5147
    @since version 1.0.0
N
Niels 已提交
5148
    */
N
Niels 已提交
5149
    size_type size() const noexcept
N
Niels 已提交
5150 5151 5152
    {
        switch (m_type)
        {
5153
            case value_t::null:
N
Niels 已提交
5154
            {
N
Niels 已提交
5155
                // null values are empty
N
Niels 已提交
5156 5157
                return 0;
            }
N
Niels 已提交
5158

5159
            case value_t::array:
N
Niels 已提交
5160
            {
N
Niels 已提交
5161
                // delegate call to array_t::size()
N
Niels 已提交
5162 5163
                return m_value.array->size();
            }
N
Niels 已提交
5164

5165
            case value_t::object:
N
Niels 已提交
5166
            {
N
Niels 已提交
5167
                // delegate call to object_t::size()
N
Niels 已提交
5168 5169
                return m_value.object->size();
            }
N
Niels 已提交
5170

N
Niels 已提交
5171 5172 5173 5174 5175 5176
            default:
            {
                // all other types have size 1
                return 1;
            }
        }
N
Niels 已提交
5177 5178
    }

N
Niels 已提交
5179 5180
    /*!
    @brief returns the maximum possible number of elements
N
Niels 已提交
5181 5182 5183 5184 5185

    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 已提交
5186
    @return The return value depends on the different types and is
N
Niels 已提交
5187 5188 5189
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
5190 5191 5192 5193 5194 5195
            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 已提交
5196

N
Niels 已提交
5197 5198
    @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 已提交
5199
    complexity.
N
Niels 已提交
5200

N
Niels 已提交
5201 5202 5203
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
5204 5205 5206 5207
    - The complexity is constant.
    - Has the semantics of returning `b.size()` where `b` is the largest
      possible JSON value.

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

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

N
Niels 已提交
5213
    @since version 1.0.0
N
Niels 已提交
5214
    */
N
Niels 已提交
5215
    size_type max_size() const noexcept
N
Niels 已提交
5216 5217 5218
    {
        switch (m_type)
        {
5219
            case value_t::array:
N
Niels 已提交
5220
            {
N
Niels 已提交
5221
                // delegate call to array_t::max_size()
N
Niels 已提交
5222 5223
                return m_value.array->max_size();
            }
N
Niels 已提交
5224

5225
            case value_t::object:
N
Niels 已提交
5226
            {
N
Niels 已提交
5227
                // delegate call to object_t::max_size()
N
Niels 已提交
5228 5229
                return m_value.object->max_size();
            }
N
Niels 已提交
5230

N
Niels 已提交
5231 5232
            default:
            {
5233 5234
                // all other types have max_size() == size()
                return size();
N
Niels 已提交
5235 5236
            }
        }
N
Niels 已提交
5237 5238
    }

N
Niels 已提交
5239 5240
    /// @}

N
Niels 已提交
5241 5242 5243 5244 5245

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

N
Niels 已提交
5246 5247 5248
    /// @name modifiers
    /// @{

N
Niels 已提交
5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265
    /*!
    @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 已提交
5266
    @liveexample{The example below shows the effect of `clear()` to different
N
Niels 已提交
5267
    JSON types.,clear}
N
Niels 已提交
5268

N
Niels 已提交
5269
    @since version 1.0.0
N
Niels 已提交
5270
    */
N
Niels 已提交
5271
    void clear() noexcept
N
Niels 已提交
5272 5273 5274
    {
        switch (m_type)
        {
5275
            case value_t::number_integer:
N
Niels 已提交
5276
            {
N
Niels 已提交
5277
                m_value.number_integer = 0;
N
Niels 已提交
5278 5279
                break;
            }
N
Niels 已提交
5280

5281 5282 5283 5284 5285 5286
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = 0;
                break;
            }

5287
            case value_t::number_float:
N
Niels 已提交
5288
            {
N
Niels 已提交
5289
                m_value.number_float = 0.0;
N
Niels 已提交
5290 5291
                break;
            }
N
Niels 已提交
5292

5293
            case value_t::boolean:
N
Niels 已提交
5294
            {
N
Niels 已提交
5295
                m_value.boolean = false;
N
Niels 已提交
5296 5297
                break;
            }
N
Niels 已提交
5298

5299
            case value_t::string:
N
Niels 已提交
5300 5301 5302 5303
            {
                m_value.string->clear();
                break;
            }
N
Niels 已提交
5304

5305
            case value_t::array:
N
Niels 已提交
5306 5307 5308 5309
            {
                m_value.array->clear();
                break;
            }
N
Niels 已提交
5310

5311
            case value_t::object:
N
Niels 已提交
5312 5313 5314 5315
            {
                m_value.object->clear();
                break;
            }
5316 5317 5318 5319 5320

            default:
            {
                break;
            }
N
Niels 已提交
5321 5322 5323
        }
    }

5324 5325 5326
    /*!
    @brief add an object to an array

5327
    Appends the given element @a val to the end of the JSON value. If the
5328
    function is called on a JSON null value, an empty array is created before
5329
    appending @a val.
5330

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

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

    @complexity Amortized constant.

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

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

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

        // add element to array (move semantics)
5361
        m_value.array->push_back(std::move(val));
N
Niels 已提交
5362
        // invalidate object
5363
        val.m_type = value_t::null;
N
Niels 已提交
5364 5365
    }

5366 5367 5368 5369
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5370
    reference operator+=(basic_json&& val)
N
Niels 已提交
5371
    {
5372
        push_back(std::move(val));
N
Niels 已提交
5373 5374 5375
        return *this;
    }

5376 5377 5378 5379
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5380
    void push_back(const basic_json& val)
N
Niels 已提交
5381 5382
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
5383
        if (not(is_null() or is_array()))
N
Niels 已提交
5384
        {
5385
            JSON_THROW(std::domain_error("cannot use push_back() with " + type_name()));
N
Niels 已提交
5386 5387 5388
        }

        // transform null object into an array
N
cleanup  
Niels 已提交
5389
        if (is_null())
N
Niels 已提交
5390 5391
        {
            m_type = value_t::array;
N
Niels 已提交
5392
            m_value = value_t::array;
5393
            assert_invariant();
N
Niels 已提交
5394 5395 5396
        }

        // add element to array
5397
        m_value.array->push_back(val);
N
Niels 已提交
5398 5399
    }

5400 5401 5402 5403
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5404
    reference operator+=(const basic_json& val)
N
Niels 已提交
5405
    {
5406
        push_back(val);
N
Niels 已提交
5407 5408 5409
        return *this;
    }

5410 5411 5412
    /*!
    @brief add an object to an object

5413
    Inserts the given element @a val to the JSON object. If the function is
N
Niels 已提交
5414 5415
    called on a JSON null value, an empty object is created before inserting
    @a val.
5416

5417
    @param[in] val the value to add to the JSON object
5418 5419

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

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

N
Niels 已提交
5424 5425 5426
    @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 已提交
5427

N
Niels 已提交
5428
    @since version 1.0.0
5429
    */
5430
    void push_back(const typename object_t::value_type& val)
N
Niels 已提交
5431 5432
    {
        // push_back only works for null objects or objects
N
cleanup  
Niels 已提交
5433
        if (not(is_null() or is_object()))
N
Niels 已提交
5434
        {
5435
            JSON_THROW(std::domain_error("cannot use push_back() with " + type_name()));
N
Niels 已提交
5436 5437 5438
        }

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

        // add element to array
5447
        m_value.object->insert(val);
N
Niels 已提交
5448 5449
    }

5450 5451 5452 5453
    /*!
    @brief add an object to an object
    @copydoc push_back(const typename object_t::value_type&)
    */
5454
    reference operator+=(const typename object_t::value_type& val)
N
Niels 已提交
5455
    {
5456
        push_back(val);
N
Niels 已提交
5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505
        return *this;
    }

    /*!
    @brief add an object to an object

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

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

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

    @param init  an initializer list

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

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

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

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

N
Niels 已提交
5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534
    /*!
    @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()))
        {
5535
            JSON_THROW(std::domain_error("cannot use emplace_back() with " + type_name()));
N
Niels 已提交
5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550
        }

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

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

N
Niels Lohmann 已提交
5553 5554
    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
5555 5556
    function is called on a JSON null value, an empty object is created before
    appending the value created from @a args.
N
Niels 已提交
5557 5558 5559 5560

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

5561 5562 5563 5564
    @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 已提交
5565 5566 5567 5568 5569 5570 5571
    @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
5572 5573
    JSON object. Further note how no value is added if there was already one
    value stored with the same key.,emplace}
N
Niels 已提交
5574 5575 5576 5577

    @since version 2.0.8
    */
    template<class... Args>
5578
    std::pair<iterator, bool> emplace(Args&& ... args)
N
Niels 已提交
5579 5580 5581 5582
    {
        // emplace only works for null objects or arrays
        if (not(is_null() or is_object()))
        {
5583
            JSON_THROW(std::domain_error("cannot use emplace() with " + type_name()));
N
Niels 已提交
5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594
        }

        // 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)
5595 5596 5597 5598 5599 5600 5601
        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 已提交
5602 5603
    }

N
Niels 已提交
5604 5605 5606
    /*!
    @brief inserts element

5607
    Inserts element @a val before iterator @a pos.
N
Niels 已提交
5608 5609 5610

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

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

N
Niels Lohmann 已提交
5619 5620
    @complexity Constant plus linear in the distance between pos and end of
    the container.
N
Niels 已提交
5621

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

N
Niels 已提交
5624
    @since version 1.0.0
N
Niels 已提交
5625
    */
5626
    iterator insert(const_iterator pos, const basic_json& val)
N
Niels 已提交
5627 5628
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5629
        if (is_array())
N
Niels 已提交
5630
        {
N
cleanup  
Niels 已提交
5631 5632 5633
            // check if iterator pos fits to this JSON value
            if (pos.m_object != this)
            {
5634
                JSON_THROW(std::domain_error("iterator does not fit current value"));
N
cleanup  
Niels 已提交
5635
            }
N
Niels 已提交
5636

N
cleanup  
Niels 已提交
5637 5638
            // insert to array and return iterator
            iterator result(this);
5639
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, val);
N
cleanup  
Niels 已提交
5640 5641
            return result;
        }
N
Niels Lohmann 已提交
5642

5643
        JSON_THROW(std::domain_error("cannot use insert() with " + type_name()));
N
Niels 已提交
5644 5645 5646 5647 5648 5649
    }

    /*!
    @brief inserts element
    @copydoc insert(const_iterator, const basic_json&)
    */
5650
    iterator insert(const_iterator pos, basic_json&& val)
N
Niels 已提交
5651
    {
5652
        return insert(pos, val);
N
Niels 已提交
5653 5654 5655 5656 5657
    }

    /*!
    @brief inserts elements

5658
    Inserts @a cnt copies of @a val before iterator @a pos.
N
Niels 已提交
5659 5660 5661

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

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

5672
    @complexity Linear in @a cnt plus linear in the distance between @a pos
N
Niels 已提交
5673 5674
    and end of the container.

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

N
Niels 已提交
5677
    @since version 1.0.0
N
Niels 已提交
5678
    */
5679
    iterator insert(const_iterator pos, size_type cnt, const basic_json& val)
N
Niels 已提交
5680 5681
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5682
        if (is_array())
N
Niels 已提交
5683
        {
N
cleanup  
Niels 已提交
5684 5685 5686
            // check if iterator pos fits to this JSON value
            if (pos.m_object != this)
            {
5687
                JSON_THROW(std::domain_error("iterator does not fit current value"));
N
cleanup  
Niels 已提交
5688
            }
N
Niels 已提交
5689

N
cleanup  
Niels 已提交
5690 5691
            // insert to array and return iterator
            iterator result(this);
5692
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, cnt, val);
N
cleanup  
Niels 已提交
5693 5694
            return result;
        }
N
Niels Lohmann 已提交
5695

5696
        JSON_THROW(std::domain_error("cannot use insert() with " + type_name()));
N
Niels 已提交
5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708
    }

    /*!
    @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 已提交
5709 5710
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
N
Niels 已提交
5711 5712
    @throw std::domain_error if @a pos is not an iterator of *this; example:
    `"iterator does not fit current value"`
N
Niels 已提交
5713
    @throw std::domain_error if @a first and @a last do not belong to the same
N
Niels 已提交
5714
    JSON value; example: `"iterators do not fit"`
N
Niels 已提交
5715
    @throw std::domain_error if @a first or @a last are iterators into
N
Niels 已提交
5716 5717 5718
    container for which insert is called; example: `"passed iterators may not
    belong to container"`

N
Niels 已提交
5719 5720 5721 5722 5723 5724
    @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 已提交
5725
    @liveexample{The example shows how `insert()` is used.,insert__range}
N
Niels 已提交
5726

N
Niels 已提交
5727
    @since version 1.0.0
N
Niels 已提交
5728 5729 5730 5731
    */
    iterator insert(const_iterator pos, const_iterator first, const_iterator last)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5732
        if (not is_array())
N
Niels 已提交
5733
        {
5734
            JSON_THROW(std::domain_error("cannot use insert() with " + type_name()));
N
Niels 已提交
5735 5736 5737 5738 5739
        }

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

N
Niels 已提交
5743
        // check if range iterators belong to the same JSON object
N
Niels 已提交
5744 5745
        if (first.m_object != last.m_object)
        {
5746
            JSON_THROW(std::domain_error("iterators do not fit"));
N
Niels 已提交
5747 5748 5749 5750
        }

        if (first.m_object == this or last.m_object == this)
        {
5751
            JSON_THROW(std::domain_error("passed iterators may not belong to container"));
N
Niels 已提交
5752 5753 5754 5755
        }

        // insert to array and return iterator
        iterator result(this);
N
Niels 已提交
5756
        result.m_it.array_iterator = m_value.array->insert(
5757 5758 5759
            pos.m_it.array_iterator,
            first.m_it.array_iterator,
            last.m_it.array_iterator);
N
Niels 已提交
5760 5761 5762
        return result;
    }

N
Niels 已提交
5763 5764 5765 5766 5767 5768 5769 5770 5771
    /*!
    @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 已提交
5772 5773
    @throw std::domain_error if called on JSON values other than arrays;
    example: `"cannot use insert() with string"`
N
Niels 已提交
5774 5775
    @throw std::domain_error if @a pos is not an iterator of *this; example:
    `"iterator does not fit current value"`
N
Niels 已提交
5776

N
Niels 已提交
5777 5778 5779
    @return iterator pointing to the first element inserted, or @a pos if
    `ilist` is empty

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

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

N
Niels 已提交
5785
    @since version 1.0.0
N
Niels 已提交
5786 5787 5788 5789
    */
    iterator insert(const_iterator pos, std::initializer_list<basic_json> ilist)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5790
        if (not is_array())
N
Niels 已提交
5791
        {
5792
            JSON_THROW(std::domain_error("cannot use insert() with " + type_name()));
N
Niels 已提交
5793 5794 5795 5796 5797
        }

        // check if iterator pos fits to this JSON value
        if (pos.m_object != this)
        {
5798
            JSON_THROW(std::domain_error("iterator does not fit current value"));
N
Niels 已提交
5799 5800 5801 5802 5803 5804 5805 5806
        }

        // 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 已提交
5807 5808
    /*!
    @brief exchanges the values
N
Niels 已提交
5809 5810 5811 5812 5813 5814 5815 5816 5817 5818

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

N
Niels 已提交
5822
    @since version 1.0.0
N
Niels 已提交
5823
    */
N
Niels 已提交
5824
    void swap(reference other) noexcept (
N
Niels 已提交
5825 5826 5827 5828
        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
5829
                                       )
N
Niels 已提交
5830 5831 5832
    {
        std::swap(m_type, other.m_type);
        std::swap(m_value, other.m_value);
5833
        assert_invariant();
N
Niels 已提交
5834 5835
    }

N
Niels 已提交
5836 5837 5838 5839 5840 5841 5842 5843 5844 5845
    /*!
    @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 已提交
5846 5847
    @throw std::domain_error when JSON value is not an array; example:
    `"cannot use swap() with string"`
N
Niels 已提交
5848 5849 5850

    @complexity Constant.

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

N
Niels 已提交
5854
    @since version 1.0.0
N
Niels 已提交
5855
    */
N
Niels 已提交
5856
    void swap(array_t& other)
N
Niels 已提交
5857 5858
    {
        // swap only works for arrays
N
cleanup  
Niels 已提交
5859 5860 5861 5862 5863
        if (is_array())
        {
            std::swap(*(m_value.array), other);
        }
        else
N
Niels 已提交
5864
        {
5865
            JSON_THROW(std::domain_error("cannot use swap() with " + type_name()));
N
Niels 已提交
5866 5867 5868
        }
    }

5869 5870 5871 5872 5873 5874 5875 5876 5877 5878
    /*!
    @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 已提交
5879 5880
    @throw std::domain_error when JSON value is not an object; example:
    `"cannot use swap() with string"`
5881 5882 5883

    @complexity Constant.

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

N
Niels 已提交
5887
    @since version 1.0.0
5888
    */
N
Niels 已提交
5889
    void swap(object_t& other)
N
Niels 已提交
5890 5891
    {
        // swap only works for objects
N
cleanup  
Niels 已提交
5892 5893 5894 5895 5896
        if (is_object())
        {
            std::swap(*(m_value.object), other);
        }
        else
N
Niels 已提交
5897
        {
5898
            JSON_THROW(std::domain_error("cannot use swap() with " + type_name()));
N
Niels 已提交
5899 5900 5901
        }
    }

5902 5903 5904 5905 5906 5907 5908 5909 5910 5911
    /*!
    @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 已提交
5912 5913
    @throw std::domain_error when JSON value is not a string; example: `"cannot
    use swap() with boolean"`
5914 5915 5916

    @complexity Constant.

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

N
Niels 已提交
5920
    @since version 1.0.0
5921
    */
N
Niels 已提交
5922
    void swap(string_t& other)
N
Niels 已提交
5923 5924
    {
        // swap only works for strings
N
cleanup  
Niels 已提交
5925 5926 5927 5928 5929
        if (is_string())
        {
            std::swap(*(m_value.string), other);
        }
        else
N
Niels 已提交
5930
        {
5931
            JSON_THROW(std::domain_error("cannot use swap() with " + type_name()));
N
Niels 已提交
5932 5933 5934
        }
    }

N
Niels 已提交
5935 5936
    /// @}

N
Niels 已提交
5937
  public:
N
Niels 已提交
5938 5939
    /*!
    @brief comparison: equal
N
Niels 已提交
5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955

    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.

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

N
Niels 已提交
5959
    @since version 1.0.0
N
Niels 已提交
5960
    */
N
Niels 已提交
5961
    friend bool operator==(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
5962
    {
F
Florian Weber 已提交
5963 5964
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
5965

F
Florian Weber 已提交
5966
        if (lhs_type == rhs_type)
N
Niels 已提交
5967
        {
F
Florian Weber 已提交
5968
            switch (lhs_type)
N
Niels 已提交
5969
            {
5970
                case value_t::array:
N
Niels 已提交
5971
                {
N
Niels 已提交
5972
                    return *lhs.m_value.array == *rhs.m_value.array;
N
Niels 已提交
5973
                }
5974
                case value_t::object:
N
Niels 已提交
5975
                {
N
Niels 已提交
5976
                    return *lhs.m_value.object == *rhs.m_value.object;
N
Niels 已提交
5977
                }
5978
                case value_t::null:
N
Niels 已提交
5979
                {
N
Niels 已提交
5980
                    return true;
N
Niels 已提交
5981
                }
5982
                case value_t::string:
N
Niels 已提交
5983
                {
N
Niels 已提交
5984
                    return *lhs.m_value.string == *rhs.m_value.string;
N
Niels 已提交
5985
                }
5986
                case value_t::boolean:
N
Niels 已提交
5987
                {
N
Niels 已提交
5988
                    return lhs.m_value.boolean == rhs.m_value.boolean;
N
Niels 已提交
5989
                }
5990
                case value_t::number_integer:
N
Niels 已提交
5991
                {
N
Niels 已提交
5992
                    return lhs.m_value.number_integer == rhs.m_value.number_integer;
N
Niels 已提交
5993
                }
5994 5995 5996 5997
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned == rhs.m_value.number_unsigned;
                }
5998
                case value_t::number_float:
N
Niels 已提交
5999
                {
6000
                    return lhs.m_value.number_float == rhs.m_value.number_float;
N
Niels 已提交
6001
                }
6002
                default:
N
Niels 已提交
6003
                {
N
Niels 已提交
6004
                    return false;
N
Niels 已提交
6005
                }
N
Niels 已提交
6006 6007
            }
        }
F
Florian Weber 已提交
6008 6009
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
N
Niels 已提交
6010
            return static_cast<number_float_t>(lhs.m_value.number_integer) == rhs.m_value.number_float;
F
Florian Weber 已提交
6011 6012 6013
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
6014
            return lhs.m_value.number_float == static_cast<number_float_t>(rhs.m_value.number_integer);
F
Florian Weber 已提交
6015
        }
6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030
        else if (lhs_type == value_t::number_unsigned and rhs_type == value_t::number_float)
        {
            return static_cast<number_float_t>(lhs.m_value.number_unsigned) == rhs.m_value.number_float;
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_unsigned)
        {
            return lhs.m_value.number_float == static_cast<number_float_t>(rhs.m_value.number_unsigned);
        }
        else if (lhs_type == value_t::number_unsigned and rhs_type == value_t::number_integer)
        {
            return static_cast<number_integer_t>(lhs.m_value.number_unsigned) == rhs.m_value.number_integer;
        }
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_unsigned)
        {
            return lhs.m_value.number_integer == static_cast<number_integer_t>(rhs.m_value.number_unsigned);
F
Florian Weber 已提交
6031
        }
6032

N
Niels 已提交
6033 6034 6035
        return false;
    }

N
Niels 已提交
6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050
    /*!
    @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 已提交
6051

N
Niels 已提交
6052
    @since version 1.0.0
N
Niels 已提交
6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067
    */
    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 已提交
6068 6069
    /*!
    @brief comparison: not equal
N
Niels 已提交
6070 6071 6072 6073 6074 6075 6076 6077 6078

    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.

6079 6080
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__notequal}
N
Niels 已提交
6081

N
Niels 已提交
6082
    @since version 1.0.0
N
Niels 已提交
6083
    */
N
Niels 已提交
6084
    friend bool operator!=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6085 6086 6087 6088
    {
        return not (lhs == rhs);
    }

N
Niels 已提交
6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103
    /*!
    @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 已提交
6104

N
Niels 已提交
6105
    @since version 1.0.0
N
Niels 已提交
6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120
    */
    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 已提交
6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139
    /*!
    @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.

6140 6141
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__less}
N
Niels 已提交
6142

N
Niels 已提交
6143
    @since version 1.0.0
N
Niels 已提交
6144
    */
N
Niels 已提交
6145
    friend bool operator<(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6146
    {
F
Florian Weber 已提交
6147 6148
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
6149

F
Florian Weber 已提交
6150
        if (lhs_type == rhs_type)
N
Niels 已提交
6151
        {
F
Florian Weber 已提交
6152
            switch (lhs_type)
N
Niels 已提交
6153
            {
6154
                case value_t::array:
N
Niels 已提交
6155
                {
N
Niels 已提交
6156
                    return *lhs.m_value.array < *rhs.m_value.array;
N
Niels 已提交
6157
                }
6158
                case value_t::object:
N
Niels 已提交
6159
                {
N
Niels 已提交
6160
                    return *lhs.m_value.object < *rhs.m_value.object;
N
Niels 已提交
6161
                }
6162
                case value_t::null:
N
Niels 已提交
6163
                {
N
Niels 已提交
6164
                    return false;
N
Niels 已提交
6165
                }
6166
                case value_t::string:
N
Niels 已提交
6167
                {
N
Niels 已提交
6168
                    return *lhs.m_value.string < *rhs.m_value.string;
N
Niels 已提交
6169
                }
6170
                case value_t::boolean:
N
Niels 已提交
6171
                {
N
Niels 已提交
6172
                    return lhs.m_value.boolean < rhs.m_value.boolean;
N
Niels 已提交
6173
                }
6174
                case value_t::number_integer:
N
Niels 已提交
6175
                {
N
Niels 已提交
6176
                    return lhs.m_value.number_integer < rhs.m_value.number_integer;
N
Niels 已提交
6177
                }
6178 6179 6180 6181
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned < rhs.m_value.number_unsigned;
                }
6182
                case value_t::number_float:
N
Niels 已提交
6183
                {
N
Niels 已提交
6184
                    return lhs.m_value.number_float < rhs.m_value.number_float;
N
Niels 已提交
6185
                }
6186
                default:
N
Niels 已提交
6187
                {
N
Niels 已提交
6188
                    return false;
N
Niels 已提交
6189
                }
N
Niels 已提交
6190 6191
            }
        }
F
Florian Weber 已提交
6192 6193
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
6194
            return static_cast<number_float_t>(lhs.m_value.number_integer) < rhs.m_value.number_float;
F
Florian Weber 已提交
6195 6196 6197
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214
            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 已提交
6215
        }
N
Niels 已提交
6216

N
Niels 已提交
6217
        // We only reach this line if we cannot compare values. In that case,
N
Niels 已提交
6218 6219 6220
        // we compare types. Note we have to call the operator explicitly,
        // because MSVC has problems otherwise.
        return operator<(lhs_type, rhs_type);
N
Niels 已提交
6221 6222
    }

N
Niels 已提交
6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234
    /*!
    @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.

6235 6236
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greater}
N
Niels 已提交
6237

N
Niels 已提交
6238
    @since version 1.0.0
N
Niels 已提交
6239
    */
N
Niels 已提交
6240
    friend bool operator<=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6241 6242 6243 6244
    {
        return not (rhs < lhs);
    }

N
Niels 已提交
6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256
    /*!
    @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.

6257 6258
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__lessequal}
N
Niels 已提交
6259

N
Niels 已提交
6260
    @since version 1.0.0
N
Niels 已提交
6261
    */
N
Niels 已提交
6262
    friend bool operator>(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6263 6264 6265 6266
    {
        return not (lhs <= rhs);
    }

N
Niels 已提交
6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278
    /*!
    @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.

6279 6280
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greaterequal}
N
Niels 已提交
6281

N
Niels 已提交
6282
    @since version 1.0.0
N
Niels 已提交
6283
    */
N
Niels 已提交
6284
    friend bool operator>=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6285 6286 6287 6288
    {
        return not (lhs < rhs);
    }

N
Niels 已提交
6289 6290
    /// @}

N
Niels 已提交
6291 6292 6293 6294 6295

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

N
Niels 已提交
6296 6297 6298
    /// @name serialization
    /// @{

N
Niels 已提交
6299 6300 6301 6302 6303 6304 6305 6306 6307 6308
    /*!
    @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)`.

6309 6310 6311 6312
    @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 已提交
6313 6314 6315 6316 6317 6318 6319
    @param[in,out] o  stream to serialize to
    @param[in] j  JSON value to serialize

    @return the stream @a o

    @complexity Linear.

N
Niels 已提交
6320 6321
    @liveexample{The example below shows the serialization with different
    parameters to `width` to adjust the indentation level.,operator_serialize}
N
Niels 已提交
6322

N
Niels 已提交
6323
    @since version 1.0.0
N
Niels 已提交
6324
    */
N
Niels 已提交
6325 6326
    friend std::ostream& operator<<(std::ostream& o, const basic_json& j)
    {
N
Niels 已提交
6327
        // read width member and use it as indentation parameter if nonzero
N
Niels 已提交
6328 6329
        const bool pretty_print = (o.width() > 0);
        const auto indentation = (pretty_print ? o.width() : 0);
N
Niels 已提交
6330

N
Niels 已提交
6331 6332
        // reset width to 0 for subsequent calls to this stream
        o.width(0);
6333

N
Niels 已提交
6334
        // fix locale problems
N
Niels 已提交
6335
        const auto old_locale = o.imbue(std::locale::classic());
6336 6337 6338 6339 6340 6341
        // 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 已提交
6342
        const auto old_precision = o.precision(std::numeric_limits<double>::digits10);
N
Niels 已提交
6343 6344

        // do the actual serialization
N
Niels 已提交
6345
        j.dump(o, pretty_print, static_cast<unsigned int>(indentation));
N
Niels 已提交
6346

6347
        // reset locale and precision
N
Niels 已提交
6348
        o.imbue(old_locale);
N
Niels 已提交
6349
        o.precision(old_precision);
N
Niels 已提交
6350 6351 6352
        return o;
    }

N
Niels 已提交
6353 6354 6355 6356
    /*!
    @brief serialize to stream
    @copydoc operator<<(std::ostream&, const basic_json&)
    */
N
Niels 已提交
6357 6358
    friend std::ostream& operator>>(const basic_json& j, std::ostream& o)
    {
N
Niels 已提交
6359
        return o << j;
N
Niels 已提交
6360 6361
    }

N
Niels 已提交
6362 6363
    /// @}

N
Niels 已提交
6364 6365 6366 6367 6368

    /////////////////////
    // deserialization //
    /////////////////////

N
Niels 已提交
6369 6370 6371
    /// @name deserialization
    /// @{

N
Niels 已提交
6372 6373 6374 6375 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 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433
    /*!
    @brief deserialize from an array

    This function reads from an array of 1-byte values.

    @pre Each element of the container has a size of 1 byte. Violating this
    precondition yields undefined behavior. **This precondition is enforced
    with a static assertion.**

    @param[in] array  array to read from
    @param[in] cb  a parser callback function of type @ref parser_callback_t
    which is used to control the deserialization by filtering unwanted values
    (optional)

    @return result of the deserialization

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

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

    @liveexample{The example below demonstrates the `parse()` function reading
    from an array.,parse__array__parser_callback_t}

    @since version 2.0.3
    */
    template<class T, std::size_t N>
    static basic_json parse(T (&array)[N],
                            const parser_callback_t cb = nullptr)
    {
        // delegate the call to the iterator-range parse overload
        return parse(std::begin(array), std::end(array), cb);
    }

    /*!
    @brief deserialize from string literal

    @tparam CharT character/literal type with size of 1 byte
    @param[in] s  string literal to read a serialized JSON value from
    @param[in] cb a parser callback function of type @ref parser_callback_t
    which is used to control the deserialization by filtering unwanted values
    (optional)

    @return result of the deserialization

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

    @note A UTF-8 byte order mark is silently ignored.
    @note String containers like `std::string` or @ref string_t can be parsed
          with @ref parse(const ContiguousContainer&, const parser_callback_t)

    @liveexample{The example below demonstrates the `parse()` function with
    and without callback function.,parse__string__parser_callback_t}

    @sa @ref parse(std::istream&, const parser_callback_t) for a version that
    reads from an input stream

    @since version 1.0.0 (originally for @ref string_t)
    */
6434 6435 6436 6437 6438
    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 已提交
6439 6440 6441 6442 6443
                            const parser_callback_t cb = nullptr)
    {
        return parser(reinterpret_cast<const char*>(s), cb).parse();
    }

N
Niels 已提交
6444 6445 6446 6447
    /*!
    @brief deserialize from stream

    @param[in,out] i  stream to read a serialized JSON value from
N
Niels 已提交
6448 6449 6450
    @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 已提交
6451 6452 6453 6454 6455 6456 6457

    @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 已提交
6458 6459
    @note A UTF-8 byte order mark is silently ignored.

N
Niels 已提交
6460 6461
    @liveexample{The example below demonstrates the `parse()` function with
    and without callback function.,parse__istream__parser_callback_t}
N
Niels 已提交
6462

6463
    @sa @ref parse(const CharT, const parser_callback_t) for a version
N
Niels 已提交
6464
    that reads from a string
N
Niels 已提交
6465

N
Niels 已提交
6466
    @since version 1.0.0
N
Niels 已提交
6467
    */
N
Niels 已提交
6468 6469
    static basic_json parse(std::istream& i,
                            const parser_callback_t cb = nullptr)
N
Niels 已提交
6470
    {
N
Niels 已提交
6471
        return parser(i, cb).parse();
N
Niels 已提交
6472 6473
    }

N
Niels 已提交
6474
    /*!
N
Niels 已提交
6475
    @copydoc parse(std::istream&, const parser_callback_t)
N
Niels 已提交
6476
    */
N
Niels 已提交
6477 6478
    static basic_json parse(std::istream&& i,
                            const parser_callback_t cb = nullptr)
N
Cleanup  
Niels 已提交
6479 6480 6481 6482
    {
        return parser(i, cb).parse();
    }

6483
    /*!
N
Niels 已提交
6484
    @brief deserialize from an iterator range with contiguous storage
6485

6486 6487
    This function reads from an iterator range of a container with contiguous
    storage of 1-byte values. Compatible container types include
6488 6489 6490 6491 6492 6493 6494 6495 6496
    `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
6497
    with a static assertion.**
6498

N
Niels 已提交
6499 6500 6501 6502
    @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.
6503

N
Niels 已提交
6504
    @tparam IteratorType iterator of container with contiguous storage
N
Niels 已提交
6505 6506 6507
    @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
6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518
    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 已提交
6519 6520
    @liveexample{The example below demonstrates the `parse()` function reading
    from an iterator range.,parse__iteratortype__parser_callback_t}
6521 6522 6523

    @since version 2.0.3
    */
N
Niels 已提交
6524 6525 6526 6527
    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>
6528 6529 6530 6531 6532
    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 已提交
6533
        assert(std::accumulate(first, last, std::pair<bool, int>(true, 0),
6534 6535 6536 6537 6538 6539 6540
                               [&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
6541 6542
        static_assert(sizeof(typename std::iterator_traits<IteratorType>::value_type) == 1,
                      "each element in the iterator range must have the size of 1 byte");
6543

6544 6545 6546 6547 6548 6549
        // 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();
        }
6550 6551 6552 6553

        return parser(first, last, cb).parse();
    }

N
Niels 已提交
6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574
    /*!
    @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 已提交
6575
    @tparam ContiguousContainer container type with contiguous storage
N
Niels 已提交
6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593
    @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 已提交
6594
    template<class ContiguousContainer, typename std::enable_if<
N
Niels 已提交
6595
                 not std::is_pointer<ContiguousContainer>::value and
6596 6597
                 std::is_base_of<
                     std::random_access_iterator_tag,
N
Niels 已提交
6598
                     typename std::iterator_traits<decltype(std::begin(std::declval<ContiguousContainer const>()))>::iterator_category>::value
6599 6600 6601 6602 6603 6604 6605 6606
                 , 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 已提交
6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619
    /*!
    @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 已提交
6620 6621
    @note A UTF-8 byte order mark is silently ignored.

N
Niels 已提交
6622 6623 6624
    @liveexample{The example below shows how a JSON value is constructed by
    reading a serialization from a stream.,operator_deserialize}

N
Niels 已提交
6625 6626
    @sa parse(std::istream&, const parser_callback_t) for a variant with a
    parser callback function to filter values while parsing
N
Niels 已提交
6627

N
Niels 已提交
6628
    @since version 1.0.0
N
Niels 已提交
6629 6630
    */
    friend std::istream& operator<<(basic_json& j, std::istream& i)
N
Niels 已提交
6631 6632 6633 6634 6635
    {
        j = parser(i).parse();
        return i;
    }

N
Niels 已提交
6636 6637 6638 6639 6640
    /*!
    @brief deserialize from stream
    @copydoc operator<<(basic_json&, std::istream&)
    */
    friend std::istream& operator>>(std::istream& i, basic_json& j)
N
Niels 已提交
6641 6642 6643 6644 6645
    {
        j = parser(i).parse();
        return i;
    }

N
Niels 已提交
6646 6647
    /// @}

N
Niels Lohmann 已提交
6648 6649 6650
    //////////////////////////////////////////
    // binary serialization/deserialization //
    //////////////////////////////////////////
N
Niels 已提交
6651

N
Niels Lohmann 已提交
6652
    /// @name binary serialization/deserialization support
N
Niels 已提交
6653 6654 6655
    /// @{

  private:
6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692
    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;
            }
        }
    }

6693 6694 6695 6696 6697 6698 6699 6700
    /*!
    @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
6701
    @param[in] current_index  the position in the vector after which to read
6702 6703 6704 6705 6706 6707 6708 6709

    @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

6710 6711 6712 6713
    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.

6714 6715
    Precondition:

6716 6717 6718
    vec:   |   |   | a | b | c | d |      T: |   |   |   |   |
                 ^               ^             ^                ^
           current_index         i            ptr        sizeof(T)
6719 6720 6721

    Postcondition:

6722 6723 6724
    vec:   |   |   | a | b | c | d |      T: | d | c | b | a |
                 ^   ^                                     ^
                 |   i                                    ptr
6725 6726
           current_index

6727
    @sa Code adapted from <http://stackoverflow.com/a/41031865/266378>.
6728 6729 6730
    */
    template<typename T>
    static T get_from_vector(const std::vector<uint8_t>& vec, const size_t current_index)
6731
    {
6732 6733
        if (current_index + sizeof(T) + 1 > vec.size())
        {
6734
            JSON_THROW(std::out_of_range("cannot read " + std::to_string(sizeof(T)) + " bytes from vector"));
6735 6736
        }

6737
        T result;
N
Niels Lohmann 已提交
6738
        auto* ptr = reinterpret_cast<uint8_t*>(&result);
6739
        for (size_t i = 0; i < sizeof(T); ++i)
6740
        {
6741
            *ptr++ = vec[current_index + sizeof(T) - i];
6742 6743
        }
        return result;
6744 6745
    }

6746 6747 6748 6749 6750 6751 6752 6753 6754 6755
    /*!
    @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 已提交
6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775
    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:
            {
6776
                if (j.m_value.number_integer >= 0)
N
Niels 已提交
6777
                {
6778
                    // MessagePack does not differentiate between positive
N
Niels Lohmann 已提交
6779 6780 6781
                    // signed integers and unsigned integers. Therefore, we
                    // used the code from the value_t::number_unsigned case
                    // here.
6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810
                    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 已提交
6811
                }
6812
                else
N
Niels 已提交
6813
                {
6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842
                    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 已提交
6843 6844 6845 6846 6847 6848 6849 6850 6851
                }
                break;
            }

            case value_t::number_unsigned:
            {
                if (j.m_value.number_unsigned < 128)
                {
                    // positive fixnum
6852
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels 已提交
6853 6854 6855 6856 6857
                }
                else if (j.m_value.number_unsigned <= UINT8_MAX)
                {
                    // uint 8
                    v.push_back(0xcc);
6858
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels 已提交
6859 6860 6861 6862 6863
                }
                else if (j.m_value.number_unsigned <= UINT16_MAX)
                {
                    // uint 16
                    v.push_back(0xcd);
6864
                    add_to_vector(v, 2, j.m_value.number_unsigned);
N
Niels 已提交
6865 6866 6867 6868 6869
                }
                else if (j.m_value.number_unsigned <= UINT32_MAX)
                {
                    // uint 32
                    v.push_back(0xce);
6870
                    add_to_vector(v, 4, j.m_value.number_unsigned);
N
Niels 已提交
6871 6872 6873 6874 6875
                }
                else if (j.m_value.number_unsigned <= UINT64_MAX)
                {
                    // uint 64
                    v.push_back(0xcf);
6876
                    add_to_vector(v, 8, j.m_value.number_unsigned);
N
Niels 已提交
6877 6878 6879 6880 6881 6882 6883 6884
                }
                break;
            }

            case value_t::number_float:
            {
                // float 64
                v.push_back(0xcb);
N
Niels Lohmann 已提交
6885
                const auto* helper = reinterpret_cast<const uint8_t*>(&(j.m_value.number_float));
N
Niels 已提交
6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904
                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);
6905
                    add_to_vector(v, 1, N);
N
Niels 已提交
6906 6907 6908 6909 6910
                }
                else if (N <= 65535)
                {
                    // str 16
                    v.push_back(0xda);
6911
                    add_to_vector(v, 2, N);
N
Niels 已提交
6912 6913 6914 6915 6916
                }
                else if (N <= 4294967295)
                {
                    // str 32
                    v.push_back(0xdb);
6917
                    add_to_vector(v, 4, N);
N
Niels 已提交
6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937
                }

                // 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);
6938
                    add_to_vector(v, 2, N);
N
Niels 已提交
6939 6940 6941 6942 6943
                }
                else if (N <= 0xffffffff)
                {
                    // array 32
                    v.push_back(0xdd);
6944
                    add_to_vector(v, 4, N);
N
Niels 已提交
6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966
                }

                // 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);
6967
                    add_to_vector(v, 2, N);
N
Niels 已提交
6968 6969 6970 6971 6972
                }
                else if (N <= 4294967295)
                {
                    // map 32
                    v.push_back(0xdf);
6973
                    add_to_vector(v, 4, N);
N
Niels 已提交
6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991
                }

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

6992 6993 6994 6995 6996 6997 6998 6999 7000 7001
    /*!
    @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 已提交
7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024
    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.
7025
                    if (j.m_value.number_integer <= 0x17)
N
Niels Lohmann 已提交
7026
                    {
7027
                        add_to_vector(v, 1, j.m_value.number_integer);
N
Niels Lohmann 已提交
7028 7029 7030 7031 7032
                    }
                    else if (j.m_value.number_integer <= UINT8_MAX)
                    {
                        v.push_back(0x18);
                        // one-byte uint8_t
7033
                        add_to_vector(v, 1, j.m_value.number_integer);
N
Niels Lohmann 已提交
7034 7035 7036 7037 7038
                    }
                    else if (j.m_value.number_integer <= UINT16_MAX)
                    {
                        v.push_back(0x19);
                        // two-byte uint16_t
7039
                        add_to_vector(v, 2, j.m_value.number_integer);
N
Niels Lohmann 已提交
7040 7041 7042 7043 7044
                    }
                    else if (j.m_value.number_integer <= UINT32_MAX)
                    {
                        v.push_back(0x1a);
                        // four-byte uint32_t
7045
                        add_to_vector(v, 4, j.m_value.number_integer);
N
Niels Lohmann 已提交
7046
                    }
7047
                    else
N
Niels Lohmann 已提交
7048
                    {
N
Niels Lohmann 已提交
7049
                        v.push_back(0x1b);
N
Niels Lohmann 已提交
7050
                        // eight-byte uint64_t
7051
                        add_to_vector(v, 8, j.m_value.number_integer);
N
Niels Lohmann 已提交
7052 7053 7054 7055
                    }
                }
                else
                {
N
Niels Lohmann 已提交
7056 7057
                    // The conversions below encode the sign in the first
                    // byte, and the value is converted to a positive number.
N
Niels Lohmann 已提交
7058
                    const auto positive_number = -1 - j.m_value.number_integer;
7059
                    if (j.m_value.number_integer >= -24)
N
Niels Lohmann 已提交
7060 7061 7062 7063 7064 7065 7066
                    {
                        v.push_back(static_cast<uint8_t>(0x20 + positive_number));
                    }
                    else if (positive_number <= UINT8_MAX)
                    {
                        // int 8
                        v.push_back(0x38);
7067
                        add_to_vector(v, 1, positive_number);
N
Niels Lohmann 已提交
7068 7069 7070 7071 7072
                    }
                    else if (positive_number <= UINT16_MAX)
                    {
                        // int 16
                        v.push_back(0x39);
7073
                        add_to_vector(v, 2, positive_number);
N
Niels Lohmann 已提交
7074 7075 7076 7077 7078
                    }
                    else if (positive_number <= UINT32_MAX)
                    {
                        // int 32
                        v.push_back(0x3a);
7079
                        add_to_vector(v, 4, positive_number);
N
Niels Lohmann 已提交
7080
                    }
7081
                    else
N
Niels Lohmann 已提交
7082 7083 7084
                    {
                        // int 64
                        v.push_back(0x3b);
7085
                        add_to_vector(v, 8, positive_number);
N
Niels Lohmann 已提交
7086 7087
                    }
                }
7088
                break;
N
Niels Lohmann 已提交
7089 7090 7091 7092
            }

            case value_t::number_unsigned:
            {
7093
                if (j.m_value.number_unsigned <= 0x17)
N
Niels Lohmann 已提交
7094 7095 7096 7097 7098 7099 7100
                {
                    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
7101
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7102 7103 7104 7105 7106
                }
                else if (j.m_value.number_unsigned <= 0xffff)
                {
                    v.push_back(0x19);
                    // two-byte uint16_t
7107
                    add_to_vector(v, 2, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7108 7109 7110 7111 7112
                }
                else if (j.m_value.number_unsigned <= 0xffffffff)
                {
                    v.push_back(0x1a);
                    // four-byte uint32_t
7113
                    add_to_vector(v, 4, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7114 7115 7116
                }
                else if (j.m_value.number_unsigned <= 0xffffffffffffffff)
                {
N
Niels Lohmann 已提交
7117
                    v.push_back(0x1b);
N
Niels Lohmann 已提交
7118
                    // eight-byte uint64_t
7119
                    add_to_vector(v, 8, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7120 7121 7122 7123 7124 7125 7126 7127
                }
                break;
            }

            case value_t::number_float:
            {
                // Double-Precision Float
                v.push_back(0xfb);
N
Niels Lohmann 已提交
7128
                const auto* helper = reinterpret_cast<const uint8_t*>(&(j.m_value.number_float));
N
Niels Lohmann 已提交
7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140
                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)
                {
7141
                    v.push_back(0x60 + N);  // 1 byte for string + size
N
Niels Lohmann 已提交
7142 7143 7144
                }
                else if (N <= 0xff)
                {
7145
                    v.push_back(0x78);  // one-byte uint8_t for N
7146
                    add_to_vector(v, 1, N);
N
Niels Lohmann 已提交
7147 7148 7149
                }
                else if (N <= 0xffff)
                {
7150
                    v.push_back(0x79);  // two-byte uint16_t for N
7151
                    add_to_vector(v, 2, N);
N
Niels Lohmann 已提交
7152 7153 7154
                }
                else if (N <= 0xffffffff)
                {
7155
                    v.push_back(0x7a); // four-byte uint32_t for N
7156
                    add_to_vector(v, 4, N);
N
Niels Lohmann 已提交
7157
                }
7158
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
7159 7160
                else if (N <= 0xffffffffffffffff)
                {
7161
                    v.push_back(0x7b);  // eight-byte uint64_t for N
7162
                    add_to_vector(v, 8, N);
N
Niels Lohmann 已提交
7163
                }
7164
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176

                // 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)
                {
7177
                    v.push_back(0x80 + N);  // 1 byte for array + size
N
Niels Lohmann 已提交
7178 7179 7180
                }
                else if (N <= 0xff)
                {
7181
                    v.push_back(0x98);  // one-byte uint8_t for N
7182
                    add_to_vector(v, 1, N);
N
Niels Lohmann 已提交
7183 7184 7185
                }
                else if (N <= 0xffff)
                {
7186
                    v.push_back(0x99);  // two-byte uint16_t for N
7187
                    add_to_vector(v, 2, N);
N
Niels Lohmann 已提交
7188 7189 7190
                }
                else if (N <= 0xffffffff)
                {
7191
                    v.push_back(0x9a);  // four-byte uint32_t for N
7192
                    add_to_vector(v, 4, N);
N
Niels Lohmann 已提交
7193
                }
7194
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
7195 7196
                else if (N <= 0xffffffffffffffff)
                {
7197
                    v.push_back(0x9b);  // eight-byte uint64_t for N
7198
                    add_to_vector(v, 8, N);
N
Niels Lohmann 已提交
7199
                }
7200
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214

                // 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)
                {
7215
                    v.push_back(0xa0 + N);  // 1 byte for object + size
N
Niels Lohmann 已提交
7216 7217 7218 7219
                }
                else if (N <= 0xff)
                {
                    v.push_back(0xb8);
7220
                    add_to_vector(v, 1, N);  // one-byte uint8_t for N
N
Niels Lohmann 已提交
7221 7222 7223 7224
                }
                else if (N <= 0xffff)
                {
                    v.push_back(0xb9);
7225
                    add_to_vector(v, 2, N);  // two-byte uint16_t for N
N
Niels Lohmann 已提交
7226 7227 7228 7229
                }
                else if (N <= 0xffffffff)
                {
                    v.push_back(0xba);
7230
                    add_to_vector(v, 4, N);  // four-byte uint32_t for N
N
Niels Lohmann 已提交
7231
                }
7232
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
7233 7234 7235
                else if (N <= 0xffffffffffffffff)
                {
                    v.push_back(0xbb);
7236
                    add_to_vector(v, 8, N);  // eight-byte uint64_t for N
N
Niels Lohmann 已提交
7237
                }
7238
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255

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

7256 7257 7258 7259 7260 7261

    /*
    @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 已提交
7262 7263 7264
    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.
7265

N
Niels Lohmann 已提交
7266 7267
    This function checks whether reading the bytes is safe; that is, offset is
    a valid index in the vector, offset+len
7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283

    @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)
        {
7284
            JSON_THROW(std::out_of_range("len out of range"));
7285 7286 7287 7288 7289
        }

        // second case: adding offset would result in overflow
        if ((size > (std::numeric_limits<size_t>::max() - offset)))
        {
7290
            JSON_THROW(std::out_of_range("len+offset out of range"));
7291
        }
N
Niels Lohmann 已提交
7292 7293 7294 7295

        // last case: reading past the end of the vector
        if (len + offset > size)
        {
7296
            JSON_THROW(std::out_of_range("len+offset out of range"));
N
Niels Lohmann 已提交
7297
        }
7298 7299
    }

N
Niels 已提交
7300
    /*!
7301 7302
    @brief create a JSON value from a given MessagePack vector

N
Niels 已提交
7303 7304
    @param[in] v  MessagePack serialization
    @param[in] idx  byte index to start reading from @a v
7305 7306 7307 7308 7309 7310 7311 7312

    @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 已提交
7313 7314 7315
    */
    static basic_json from_msgpack_internal(const std::vector<uint8_t>& v, size_t& idx)
    {
N
Niels Lohmann 已提交
7316 7317 7318
        // make sure reading 1 byte is safe
        check_length(v.size(), 1, idx);

N
Niels 已提交
7319 7320 7321
        // store and increment index
        const size_t current_idx = idx++;

N
Niels Lohmann 已提交
7322
        if (v[current_idx] <= 0xbf)
N
Niels 已提交
7323
        {
N
Niels Lohmann 已提交
7324
            if (v[current_idx] <= 0x7f) // positive fixint
N
Niels 已提交
7325
            {
N
Niels Lohmann 已提交
7326
                return v[current_idx];
N
Niels 已提交
7327
            }
N
Niels Lohmann 已提交
7328
            if (v[current_idx] <= 0x8f) // fixmap
N
Niels 已提交
7329
            {
N
Niels Lohmann 已提交
7330 7331 7332 7333 7334 7335 7336 7337
                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 已提交
7338
            }
N
Niels Lohmann 已提交
7339
            else if (v[current_idx] <= 0x9f) // fixarray
N
Niels 已提交
7340
            {
N
Niels Lohmann 已提交
7341 7342 7343 7344 7345 7346 7347
                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 已提交
7348
            }
N
Niels Lohmann 已提交
7349
            else // fixstr
N
Niels 已提交
7350
            {
N
Niels Lohmann 已提交
7351 7352 7353
                const size_t len = v[current_idx] & 0x1f;
                const size_t offset = current_idx + 1;
                idx += len; // skip content bytes
7354
                check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
7355
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels 已提交
7356 7357
            }
        }
N
Niels Lohmann 已提交
7358
        else if (v[current_idx] >= 0xe0) // negative fixint
N
Niels 已提交
7359
        {
N
Niels Lohmann 已提交
7360
            return static_cast<int8_t>(v[current_idx]);
N
Niels 已提交
7361
        }
N
Niels Lohmann 已提交
7362
        else
N
Niels 已提交
7363
        {
N
Niels Lohmann 已提交
7364
            switch (v[current_idx])
N
Niels 已提交
7365
            {
N
Niels Lohmann 已提交
7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386
                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 已提交
7387
                        reinterpret_cast<uint8_t*>(&res)[sizeof(float) - byte - 1] = v.at(current_idx + 1 + byte);
N
Niels Lohmann 已提交
7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398
                    }
                    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 已提交
7399
                        reinterpret_cast<uint8_t*>(&res)[sizeof(double) - byte - 1] = v.at(current_idx + 1 + byte);
N
Niels Lohmann 已提交
7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454
                    }
                    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
                {
7455
                    const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
N
Niels Lohmann 已提交
7456 7457
                    const size_t offset = current_idx + 2;
                    idx += len + 1; // skip size byte + content bytes
7458
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
7459 7460 7461 7462 7463
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xda: // str 16
                {
7464
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
7465 7466
                    const size_t offset = current_idx + 3;
                    idx += len + 2; // skip 2 size bytes + content bytes
7467
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
7468 7469 7470 7471 7472
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xdb: // str 32
                {
7473
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
7474 7475
                    const size_t offset = current_idx + 5;
                    idx += len + 4; // skip 4 size bytes + content bytes
7476
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
7477 7478 7479 7480 7481 7482
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xdc: // array 16
                {
                    basic_json result = value_t::array;
7483
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494
                    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;
7495
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506
                    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;
7507
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519
                    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;
7520
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531
                    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:
                {
7532
                    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 已提交
7533
                }
N
Niels 已提交
7534 7535 7536 7537
            }
        }
    }

7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551
    /*!
    @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 已提交
7552 7553 7554 7555 7556
    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++;

7557
        switch (v.at(current_idx))
7558
        {
N
Niels Lohmann 已提交
7559
            // Integer 0x00..0x17 (0..23)
7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583
            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:
7584
            {
7585
                return v[current_idx];
7586
            }
7587

N
Niels Lohmann 已提交
7588
            case 0x18: // Unsigned integer (one-byte uint8_t follows)
N
Niels Lohmann 已提交
7589
            {
7590 7591
                idx += 1; // skip content byte
                return get_from_vector<uint8_t>(v, current_idx);
N
Niels Lohmann 已提交
7592
            }
7593

N
Niels Lohmann 已提交
7594
            case 0x19: // Unsigned integer (two-byte uint16_t follows)
N
Niels Lohmann 已提交
7595
            {
7596 7597
                idx += 2; // skip 2 content bytes
                return get_from_vector<uint16_t>(v, current_idx);
N
Niels Lohmann 已提交
7598
            }
7599

N
Niels Lohmann 已提交
7600
            case 0x1a: // Unsigned integer (four-byte uint32_t follows)
N
Niels Lohmann 已提交
7601
            {
7602 7603
                idx += 4; // skip 4 content bytes
                return get_from_vector<uint32_t>(v, current_idx);
N
Niels Lohmann 已提交
7604
            }
7605

N
Niels Lohmann 已提交
7606
            case 0x1b: // Unsigned integer (eight-byte uint64_t follows)
N
Niels Lohmann 已提交
7607
            {
7608 7609
                idx += 8; // skip 8 content bytes
                return get_from_vector<uint64_t>(v, current_idx);
N
Niels Lohmann 已提交
7610
            }
7611

N
Niels Lohmann 已提交
7612
            // Negative integer -1-0x00..-1-0x17 (-1..-24)
7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636
            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 已提交
7637
            {
7638
                return static_cast<int8_t>(0x20 - 1 - v[current_idx]);
N
Niels Lohmann 已提交
7639
            }
7640

N
Niels Lohmann 已提交
7641
            case 0x38: // Negative integer (one-byte uint8_t follows)
7642
            {
7643 7644
                idx += 1; // skip content byte
                // must be uint8_t !
7645
                return static_cast<number_integer_t>(-1) - get_from_vector<uint8_t>(v, current_idx);
7646
            }
7647

N
Niels Lohmann 已提交
7648
            case 0x39: // Negative integer -1-n (two-byte uint16_t follows)
N
Niels Lohmann 已提交
7649
            {
7650
                idx += 2; // skip 2 content bytes
7651
                return static_cast<number_integer_t>(-1) - get_from_vector<uint16_t>(v, current_idx);
N
Niels Lohmann 已提交
7652
            }
7653

N
Niels Lohmann 已提交
7654
            case 0x3a: // Negative integer -1-n (four-byte uint32_t follows)
N
Niels Lohmann 已提交
7655
            {
7656
                idx += 4; // skip 4 content bytes
7657
                return static_cast<number_integer_t>(-1) - get_from_vector<uint32_t>(v, current_idx);
N
Niels Lohmann 已提交
7658
            }
7659

N
Niels Lohmann 已提交
7660
            case 0x3b: // Negative integer -1-n (eight-byte uint64_t follows)
N
Niels Lohmann 已提交
7661
            {
7662
                idx += 8; // skip 8 content bytes
7663
                return static_cast<number_integer_t>(-1) - static_cast<number_integer_t>(get_from_vector<uint64_t>(v, current_idx));
N
Niels Lohmann 已提交
7664
            }
7665

N
Niels Lohmann 已提交
7666
            // UTF-8 string (0x00..0x17 bytes follow)
7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690
            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 已提交
7691
            {
7692
                const auto len = static_cast<size_t>(v[current_idx] - 0x60);
7693 7694
                const size_t offset = current_idx + 1;
                idx += len; // skip content bytes
7695
                check_length(v.size(), len, offset);
7696
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels Lohmann 已提交
7697
            }
7698

N
Niels Lohmann 已提交
7699
            case 0x78: // UTF-8 string (one-byte uint8_t for n follows)
N
Niels Lohmann 已提交
7700
            {
7701
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
7702 7703
                const size_t offset = current_idx + 2;
                idx += len + 1; // skip size byte + content bytes
7704
                check_length(v.size(), len, offset);
7705
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels Lohmann 已提交
7706
            }
7707

N
Niels Lohmann 已提交
7708
            case 0x79: // UTF-8 string (two-byte uint16_t for n follow)
7709
            {
7710
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
7711 7712
                const size_t offset = current_idx + 3;
                idx += len + 2; // skip 2 size bytes + content bytes
7713
                check_length(v.size(), len, offset);
7714
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
7715
            }
7716

N
Niels Lohmann 已提交
7717
            case 0x7a: // UTF-8 string (four-byte uint32_t for n follow)
7718
            {
7719
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
7720 7721
                const size_t offset = current_idx + 5;
                idx += len + 4; // skip 4 size bytes + content bytes
7722
                check_length(v.size(), len, offset);
7723
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
7724
            }
7725

N
Niels Lohmann 已提交
7726
            case 0x7b: // UTF-8 string (eight-byte uint64_t for n follow)
7727
            {
7728
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
7729 7730
                const size_t offset = current_idx + 9;
                idx += len + 8; // skip 8 size bytes + content bytes
7731
                check_length(v.size(), len, offset);
7732
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
7733
            }
7734 7735

            case 0x7f: // UTF-8 string (indefinite length)
7736
            {
7737
                std::string result;
7738
                while (v.at(idx) != 0xff)
7739 7740 7741 7742 7743 7744 7745
                {
                    string_t s = from_cbor_internal(v, idx);
                    result += s;
                }
                // skip break byte (0xFF)
                idx += 1;
                return result;
7746
            }
7747

N
Niels Lohmann 已提交
7748
            // array (0x00..0x17 data items follow)
7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772
            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 已提交
7773
            {
7774
                basic_json result = value_t::array;
7775
                const auto len = static_cast<size_t>(v[current_idx] - 0x80);
7776 7777 7778 7779 7780
                for (size_t i = 0; i < len; ++i)
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                return result;
N
Niels Lohmann 已提交
7781
            }
7782

N
Niels Lohmann 已提交
7783
            case 0x98: // array (one-byte uint8_t for n follows)
N
Niels Lohmann 已提交
7784
            {
7785
                basic_json result = value_t::array;
7786
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
7787 7788 7789 7790 7791 7792
                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 已提交
7793 7794
            }

N
Niels Lohmann 已提交
7795
            case 0x99: // array (two-byte uint16_t for n follow)
7796 7797
            {
                basic_json result = value_t::array;
7798
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
7799 7800 7801 7802 7803 7804 7805 7806
                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 已提交
7807
            case 0x9a: // array (four-byte uint32_t for n follow)
7808 7809
            {
                basic_json result = value_t::array;
7810
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
7811 7812 7813 7814 7815 7816 7817 7818
                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 已提交
7819
            case 0x9b: // array (eight-byte uint64_t for n follow)
7820 7821
            {
                basic_json result = value_t::array;
7822
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833
                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;
7834
                while (v.at(idx) != 0xff)
7835 7836 7837 7838 7839 7840 7841 7842
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                // skip break byte (0xFF)
                idx += 1;
                return result;
            }

N
Niels Lohmann 已提交
7843
            // map (0x00..0x17 pairs of data items follow)
7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869
            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;
7870
                const auto len = static_cast<size_t>(v[current_idx] - 0xa0);
7871 7872 7873 7874 7875 7876 7877 7878
                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 已提交
7879
            case 0xb8: // map (one-byte uint8_t for n follows)
7880 7881
            {
                basic_json result = value_t::object;
7882
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
7883 7884 7885 7886 7887 7888 7889 7890 7891
                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 已提交
7892
            case 0xb9: // map (two-byte uint16_t for n follow)
7893 7894
            {
                basic_json result = value_t::object;
7895
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
7896 7897 7898 7899 7900 7901 7902 7903 7904
                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 已提交
7905
            case 0xba: // map (four-byte uint32_t for n follow)
7906 7907
            {
                basic_json result = value_t::object;
7908
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
7909 7910 7911 7912 7913 7914 7915 7916 7917
                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 已提交
7918
            case 0xbb: // map (eight-byte uint64_t for n follow)
7919 7920
            {
                basic_json result = value_t::object;
7921
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933
                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;
7934
                while (v.at(idx) != 0xff)
7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958
                {
                    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 已提交
7959
            case 0xf9: // Half-Precision Float (two-byte IEEE 754)
7960 7961 7962 7963
            {
                idx += 2; // skip two content bytes

                // code from RFC 7049, Appendix D, Figure 3:
N
Niels Lohmann 已提交
7964 7965 7966 7967 7968 7969
                // 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.
7970
                const int half = (v.at(current_idx + 1) << 8) + v.at(current_idx + 2);
7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985
                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 已提交
7986
                return (half & 0x8000) != 0 ? -val : val;
7987 7988
            }

N
Niels Lohmann 已提交
7989
            case 0xfa: // Single-Precision Float (four-byte IEEE 754)
7990 7991 7992 7993 7994
            {
                // copy bytes in reverse order into the float variable
                float res;
                for (size_t byte = 0; byte < sizeof(float); ++byte)
                {
N
Niels Lohmann 已提交
7995
                    reinterpret_cast<uint8_t*>(&res)[sizeof(float) - byte - 1] = v.at(current_idx + 1 + byte);
7996 7997 7998 7999 8000
                }
                idx += sizeof(float); // skip content bytes
                return res;
            }

N
Niels Lohmann 已提交
8001
            case 0xfb: // Double-Precision Float (eight-byte IEEE 754)
8002 8003 8004 8005 8006
            {
                // copy bytes in reverse order into the double variable
                double res;
                for (size_t byte = 0; byte < sizeof(double); ++byte)
                {
N
Niels Lohmann 已提交
8007
                    reinterpret_cast<uint8_t*>(&res)[sizeof(double) - byte - 1] = v.at(current_idx + 1 + byte);
8008 8009 8010 8011 8012
                }
                idx += sizeof(double); // skip content bytes
                return res;
            }

N
Niels Lohmann 已提交
8013
            default: // anything else (0xFF is handled inside the other types)
8014
            {
8015
                JSON_THROW(std::invalid_argument("error parsing a CBOR @ " + std::to_string(current_idx) + ": " + std::to_string(static_cast<int>(v[current_idx]))));
8016 8017
            }
        }
N
Niels Lohmann 已提交
8018 8019
    }

N
Niels 已提交
8020 8021
  public:
    /*!
8022 8023 8024 8025 8026 8027
    @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 已提交
8028
    @param[in] j  JSON value to serialize
8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039
    @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 已提交
8040 8041 8042 8043 8044 8045 8046 8047
    */
    static std::vector<uint8_t> to_msgpack(const basic_json& j)
    {
        std::vector<uint8_t> result;
        to_msgpack_internal(j, result);
        return result;
    }

8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069
    /*!
    @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 已提交
8070 8071 8072 8073 8074 8075
    static basic_json from_msgpack(const std::vector<uint8_t>& v)
    {
        size_t i = 0;
        return from_msgpack_internal(v, i);
    }

N
Niels Lohmann 已提交
8076
    /*!
8077 8078 8079 8080 8081 8082 8083
    @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 已提交
8084
    @param[in] j  JSON value to serialize
8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095
    @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 已提交
8096 8097 8098 8099 8100 8101 8102 8103
    */
    static std::vector<uint8_t> to_cbor(const basic_json& j)
    {
        std::vector<uint8_t> result;
        to_cbor_internal(j, result);
        return result;
    }

8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126
    /*!
    @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 已提交
8127 8128 8129 8130 8131 8132
    static basic_json from_cbor(const std::vector<uint8_t>& v)
    {
        size_t i = 0;
        return from_cbor_internal(v, i);
    }

N
Niels 已提交
8133
    /// @}
N
Niels 已提交
8134 8135 8136 8137 8138

    ///////////////////////////
    // convenience functions //
    ///////////////////////////

N
Niels 已提交
8139 8140 8141 8142 8143 8144
    /*!
    @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 已提交
8145
    @return basically a string representation of a the @a m_type member
N
Niels 已提交
8146 8147 8148

    @complexity Constant.

8149 8150 8151
    @liveexample{The following code exemplifies `type_name()` for all JSON
    types.,typename}

N
Niels 已提交
8152 8153
    @since version 1.0.0
    */
8154
    std::string type_name() const { return detail::type_name(*this); }
N
Niels 已提交
8155

8156
  private:
N
Niels 已提交
8157 8158 8159 8160 8161 8162 8163 8164 8165 8166
    /*!
    @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 已提交
8167 8168
        return std::accumulate(s.begin(), s.end(), size_t{},
                               [](size_t res, typename string_t::value_type c)
N
Niels 已提交
8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180
        {
            switch (c)
            {
                case '"':
                case '\\':
                case '\b':
                case '\f':
                case '\n':
                case '\r':
                case '\t':
                {
                    // from c (1 byte) to \x (2 bytes)
N
Niels 已提交
8181
                    return res + 1;
N
Niels 已提交
8182 8183 8184 8185 8186 8187 8188
                }

                default:
                {
                    if (c >= 0x00 and c <= 0x1f)
                    {
                        // from c (1 byte) to \uxxxx (6 bytes)
N
Niels 已提交
8189 8190
                        return res + 5;
                    }
N
Niels Lohmann 已提交
8191 8192

                    return res;
N
Niels 已提交
8193 8194
                }
            }
N
Niels 已提交
8195
        });
N
Niels 已提交
8196 8197
    }

N
Niels 已提交
8198 8199
    /*!
    @brief escape a string
N
Niels 已提交
8200

N
Niels 已提交
8201 8202
    Escape a string by replacing certain special characters by a sequence of
    an escape character (backslash) and another character and other control
N
Niels 已提交
8203 8204 8205
    characters by a sequence of "\u" followed by a four-digit hex
    representation.

N
Niels 已提交
8206
    @param[in] s  the string to escape
N
Niels 已提交
8207 8208 8209
    @return  the escaped string

    @complexity Linear in the length of string @a s.
N
Niels 已提交
8210
    */
N
Niels 已提交
8211
    static string_t escape_string(const string_t& s)
N
Niels 已提交
8212
    {
N
Niels 已提交
8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223
        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 已提交
8224 8225 8226 8227 8228 8229
        {
            switch (c)
            {
                // quotation mark (0x22)
                case '"':
                {
N
Niels 已提交
8230 8231
                    result[pos + 1] = '"';
                    pos += 2;
N
Niels 已提交
8232 8233
                    break;
                }
N
Niels 已提交
8234

N
Niels 已提交
8235 8236 8237
                // reverse solidus (0x5c)
                case '\\':
                {
N
Niels 已提交
8238 8239
                    // nothing to change
                    pos += 2;
N
Niels 已提交
8240 8241
                    break;
                }
N
Niels 已提交
8242

N
Niels 已提交
8243 8244 8245
                // backspace (0x08)
                case '\b':
                {
N
Niels 已提交
8246 8247
                    result[pos + 1] = 'b';
                    pos += 2;
N
Niels 已提交
8248 8249
                    break;
                }
N
Niels 已提交
8250

N
Niels 已提交
8251 8252 8253
                // formfeed (0x0c)
                case '\f':
                {
N
Niels 已提交
8254 8255
                    result[pos + 1] = 'f';
                    pos += 2;
N
Niels 已提交
8256 8257
                    break;
                }
N
Niels 已提交
8258

N
Niels 已提交
8259 8260 8261
                // newline (0x0a)
                case '\n':
                {
N
Niels 已提交
8262 8263
                    result[pos + 1] = 'n';
                    pos += 2;
N
Niels 已提交
8264 8265
                    break;
                }
N
Niels 已提交
8266

N
Niels 已提交
8267 8268 8269
                // carriage return (0x0d)
                case '\r':
                {
N
Niels 已提交
8270 8271
                    result[pos + 1] = 'r';
                    pos += 2;
N
Niels 已提交
8272 8273
                    break;
                }
N
Niels 已提交
8274

N
Niels 已提交
8275 8276 8277
                // horizontal tab (0x09)
                case '\t':
                {
N
Niels 已提交
8278 8279
                    result[pos + 1] = 't';
                    pos += 2;
N
Niels 已提交
8280 8281 8282 8283 8284
                    break;
                }

                default:
                {
8285
                    if (c >= 0x00 and c <= 0x1f)
N
Niels 已提交
8286
                    {
N
Niels 已提交
8287 8288
                        // convert a number 0..15 to its hex representation
                        // (0..f)
N
Niels 已提交
8289
                        static const char hexify[16] =
8290
                        {
N
Niels 已提交
8291 8292
                            '0', '1', '2', '3', '4', '5', '6', '7',
                            '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'
8293 8294
                        };

N
Niels 已提交
8295
                        // print character c as \uxxxx
N
Niels 已提交
8296
                        for (const char m :
N
Niels 已提交
8297
                    { 'u', '0', '0', hexify[c >> 4], hexify[c & 0x0f]
N
Niels 已提交
8298
                        })
8299 8300 8301 8302 8303
                        {
                            result[++pos] = m;
                        }

                        ++pos;
N
Niels 已提交
8304 8305 8306 8307
                    }
                    else
                    {
                        // all other characters are added as-is
N
Niels 已提交
8308
                        result[pos++] = c;
N
Niels 已提交
8309 8310 8311 8312 8313
                    }
                    break;
                }
            }
        }
N
Niels 已提交
8314 8315

        return result;
N
Niels 已提交
8316 8317 8318 8319
    }

    /*!
    @brief internal implementation of the serialization function
N
Niels 已提交
8320

N
Niels 已提交
8321
    This function is called by the public member function dump and organizes
N
Niels 已提交
8322
    the serialization internally. The indentation level is propagated as
N
Niels 已提交
8323 8324
    additional parameter. In case of arrays and objects, the function is
    called recursively. Note that
N
Niels 已提交
8325

N
Niels 已提交
8326 8327 8328
    - strings and object keys are escaped using `escape_string()`
    - integer numbers are converted implicitly via `operator<<`
    - floating-point numbers are converted to a string using `"%g"` format
N
Niels 已提交
8329

N
Niels 已提交
8330 8331 8332 8333
    @param[out] o              stream to write to
    @param[in] pretty_print    whether the output shall be pretty-printed
    @param[in] indent_step     the indent level
    @param[in] current_indent  the current indent level (only used internally)
N
Niels 已提交
8334
    */
N
Niels 已提交
8335 8336 8337
    void dump(std::ostream& o,
              const bool pretty_print,
              const unsigned int indent_step,
N
Niels 已提交
8338
              const unsigned int current_indent = 0) const
N
Niels 已提交
8339
    {
N
Niels 已提交
8340
        // variable to hold indentation for recursive calls
N
Niels 已提交
8341
        unsigned int new_indent = current_indent;
N
Niels 已提交
8342

N
Niels 已提交
8343 8344
        switch (m_type)
        {
8345
            case value_t::object:
N
Niels 已提交
8346 8347 8348
            {
                if (m_value.object->empty())
                {
N
Niels 已提交
8349 8350
                    o << "{}";
                    return;
N
Niels 已提交
8351 8352
                }

N
Niels 已提交
8353
                o << "{";
N
Niels 已提交
8354 8355

                // increase indentation
N
Niels 已提交
8356
                if (pretty_print)
N
Niels 已提交
8357
                {
N
Niels 已提交
8358
                    new_indent += indent_step;
N
Niels 已提交
8359
                    o << "\n";
N
Niels 已提交
8360 8361 8362 8363 8364 8365
                }

                for (auto i = m_value.object->cbegin(); i != m_value.object->cend(); ++i)
                {
                    if (i != m_value.object->cbegin())
                    {
N
Niels 已提交
8366
                        o << (pretty_print ? ",\n" : ",");
N
Niels 已提交
8367
                    }
N
Niels 已提交
8368
                    o << string_t(new_indent, ' ') << "\""
8369 8370 8371
                                                    << escape_string(i->first) << "\":"
                                                            << (pretty_print ? " " : "");
                                                            i->second.dump(o, pretty_print, indent_step, new_indent);
N
Niels 已提交
8372 8373
                }

8374 8375
                                                        // decrease indentation
                                                        if (pretty_print)
N
Niels 已提交
8376
                {
N
Niels 已提交
8377
                    new_indent -= indent_step;
N
Niels 已提交
8378
                    o << "\n";
N
Niels 已提交
8379 8380
                }

N
Niels 已提交
8381 8382
                o << string_t(new_indent, ' ') + "}";
                return;
N
Niels 已提交
8383 8384
            }

8385
            case value_t::array:
N
Niels 已提交
8386 8387 8388
            {
                if (m_value.array->empty())
                {
N
Niels 已提交
8389 8390
                    o << "[]";
                    return;
N
Niels 已提交
8391 8392
                }

N
Niels 已提交
8393
                o << "[";
N
Niels 已提交
8394 8395

                // increase indentation
N
Niels 已提交
8396
                if (pretty_print)
N
Niels 已提交
8397
                {
N
Niels 已提交
8398
                    new_indent += indent_step;
N
Niels 已提交
8399
                    o << "\n";
N
Niels 已提交
8400 8401 8402 8403 8404 8405
                }

                for (auto i = m_value.array->cbegin(); i != m_value.array->cend(); ++i)
                {
                    if (i != m_value.array->cbegin())
                    {
N
Niels 已提交
8406
                        o << (pretty_print ? ",\n" : ",");
N
Niels 已提交
8407
                    }
N
Niels 已提交
8408
                    o << string_t(new_indent, ' ');
N
Niels 已提交
8409
                    i->dump(o, pretty_print, indent_step, new_indent);
N
Niels 已提交
8410 8411 8412
                }

                // decrease indentation
N
Niels 已提交
8413
                if (pretty_print)
N
Niels 已提交
8414
                {
N
Niels 已提交
8415
                    new_indent -= indent_step;
N
Niels 已提交
8416
                    o << "\n";
N
Niels 已提交
8417 8418
                }

N
Niels 已提交
8419
                o << string_t(new_indent, ' ') << "]";
8420
                   return;
N
Niels 已提交
8421 8422
            }

8423
               case value_t::string:
N
Niels 已提交
8424
            {
N
Niels 已提交
8425
                o << string_t("\"") << escape_string(*m_value.string) << "\"";
8426
                                     return;
N
Niels 已提交
8427 8428
            }

8429
                                 case value_t::boolean:
N
Niels 已提交
8430
            {
N
Niels 已提交
8431 8432
                o << (m_value.boolean ? "true" : "false");
                return;
N
Niels 已提交
8433 8434
            }

8435
            case value_t::number_integer:
N
Niels 已提交
8436
            {
N
Niels 已提交
8437 8438
                o << m_value.number_integer;
                return;
N
Niels 已提交
8439 8440
            }

8441 8442 8443 8444 8445 8446
            case value_t::number_unsigned:
            {
                o << m_value.number_unsigned;
                return;
            }

8447
            case value_t::number_float:
N
Niels 已提交
8448
            {
N
Niels 已提交
8449
                if (m_value.number_float == 0)
N
Niels 已提交
8450
                {
N
Niels 已提交
8451 8452
                    // special case for zero to get "0.0"/"-0.0"
                    o << (std::signbit(m_value.number_float) ? "-0.0" : "0.0");
N
Niels 已提交
8453
                }
N
Niels 已提交
8454
                else
N
Niels 已提交
8455
                {
8456
                    o << m_value.number_float;
N
Niels 已提交
8457
                }
N
Niels 已提交
8458
                return;
N
Niels 已提交
8459
            }
N
Niels 已提交
8460

8461
            case value_t::discarded:
N
Niels 已提交
8462
            {
N
Niels 已提交
8463 8464
                o << "<discarded>";
                return;
N
Niels 已提交
8465
            }
N
Niels 已提交
8466

8467
            case value_t::null:
N
Niels 已提交
8468
            {
N
Niels 已提交
8469 8470
                o << "null";
                return;
N
Niels 已提交
8471
            }
N
Niels 已提交
8472 8473 8474 8475 8476 8477 8478 8479 8480
        }
    }

  private:
    //////////////////////
    // member variables //
    //////////////////////

    /// the type of the current element
N
Niels 已提交
8481
    value_t m_type = value_t::null;
N
Niels 已提交
8482 8483 8484 8485

    /// the value of the current element
    json_value m_value = {};

N
Niels 已提交
8486

N
Niels 已提交
8487
  private:
N
Niels 已提交
8488 8489 8490 8491
    ///////////////
    // iterators //
    ///////////////

8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502
    /*!
    @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
    {
8503
        public:
T
Théo Delrieu 已提交
8504 8505

        difference_type get_value() const noexcept
8506 8507 8508 8509 8510 8511 8512 8513
    {
        return m_it;
    }
    /// set iterator to a defined beginning
    void set_begin() noexcept
    {
        m_it = begin_value;
    }
8514

8515 8516 8517 8518 8519
    /// set iterator to a defined past the end
    void set_end() noexcept
    {
        m_it = end_value;
    }
8520

8521 8522 8523 8524 8525
    /// return whether the iterator can be dereferenced
    constexpr bool is_begin() const noexcept
    {
        return (m_it == begin_value);
    }
8526

8527 8528 8529 8530 8531
    /// return whether the iterator is at end
    constexpr bool is_end() const noexcept
    {
        return (m_it == end_value);
    }
8532

8533 8534 8535 8536
    friend constexpr bool operator==(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
    {
        return lhs.m_it == rhs.m_it;
    }
T
Théo Delrieu 已提交
8537

8538 8539 8540 8541
    friend constexpr bool operator!=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
    {
        return !(lhs == rhs);
    }
T
Théo Delrieu 已提交
8542

8543 8544 8545 8546
    friend constexpr bool operator<(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
    {
        return lhs.m_it < rhs.m_it;
    }
T
Théo Delrieu 已提交
8547

8548 8549 8550 8551
    friend constexpr bool operator<=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
    {
        return lhs.m_it <= rhs.m_it;
    }
T
Théo Delrieu 已提交
8552

8553 8554 8555 8556
    friend constexpr bool operator>(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
    {
        return lhs.m_it > rhs.m_it;
    }
T
Théo Delrieu 已提交
8557

8558 8559 8560 8561
    friend constexpr bool operator>=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
    {
        return lhs.m_it >= rhs.m_it;
    }
T
Théo Delrieu 已提交
8562

8563 8564 8565 8566 8567 8568
    primitive_iterator_t operator+(difference_type i)
    {
        auto result = *this;
        result += i;
        return result;
    }
T
Théo Delrieu 已提交
8569

8570 8571 8572 8573
    friend constexpr difference_type operator-(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
    {
        return lhs.m_it - rhs.m_it;
    }
T
Théo Delrieu 已提交
8574

8575 8576 8577 8578
    friend std::ostream& operator<<(std::ostream& os, primitive_iterator_t it)
    {
        return os << it.m_it;
    }
T
Théo Delrieu 已提交
8579

8580 8581 8582 8583 8584
    primitive_iterator_t& operator++()
    {
        ++m_it;
        return *this;
    }
T
Théo Delrieu 已提交
8585

8586 8587 8588 8589 8590
    primitive_iterator_t& operator++(int)
    {
        m_it++;
        return *this;
    }
T
Théo Delrieu 已提交
8591

8592 8593 8594 8595 8596
    primitive_iterator_t& operator--()
    {
        --m_it;
        return *this;
    }
T
Théo Delrieu 已提交
8597

8598 8599 8600 8601 8602
    primitive_iterator_t& operator--(int)
    {
        m_it--;
        return *this;
    }
T
Théo Delrieu 已提交
8603

8604 8605 8606 8607 8608
    primitive_iterator_t& operator+=(difference_type n)
    {
        m_it += n;
        return *this;
    }
8609

8610 8611 8612 8613 8614
    primitive_iterator_t& operator-=(difference_type n)
    {
        m_it -= n;
        return *this;
    }
8615

8616 8617 8618
    private:
    static constexpr difference_type begin_value = 0;
    static constexpr difference_type end_value = begin_value + 1;
8619

8620 8621 8622
    /// iterator as signed integer type
    difference_type m_it = std::numeric_limits<std::ptrdiff_t>::denorm_min();
                                              };
8623

N
Niels 已提交
8624 8625 8626 8627 8628 8629 8630 8631
    /*!
    @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 已提交
8632 8633
    {
        /// iterator for JSON objects
N
Niels 已提交
8634
        typename object_t::iterator object_iterator;
N
Niels 已提交
8635
        /// iterator for JSON arrays
N
Niels 已提交
8636
        typename array_t::iterator array_iterator;
N
Niels 已提交
8637
        /// generic iterator for all other types
N
Niels 已提交
8638 8639 8640
        primitive_iterator_t primitive_iterator;

        /// create an uninitialized internal_iterator
N
Niels 已提交
8641
        internal_iterator() noexcept
8642 8643
        : object_iterator(), array_iterator(), primitive_iterator()
    {}
N
Niels 已提交
8644 8645
    };

N
cleanup  
Niels 已提交
8646 8647 8648 8649
    /// proxy class for the iterator_wrapper functions
    template<typename IteratorType>
    class iteration_proxy
    {
8650
        private:
N
cleanup  
Niels 已提交
8651 8652 8653
        /// helper class for iteration
        class iteration_proxy_internal
        {
8654
            private:
N
cleanup  
Niels 已提交
8655 8656 8657 8658 8659
            /// the iterator
            IteratorType anchor;
            /// an index for arrays (used to create key names)
            size_t array_index = 0;

8660
            public:
N
Niels 已提交
8661
            explicit iteration_proxy_internal(IteratorType it) noexcept
8662 8663
            : anchor(it)
    {}
N
cleanup  
Niels 已提交
8664

8665 8666 8667 8668 8669
    /// dereference operator (needed for range-based for)
    iteration_proxy_internal& operator*()
    {
        return *this;
    }
N
cleanup  
Niels 已提交
8670

8671 8672 8673 8674 8675
    /// increment operator (needed for range-based for)
    iteration_proxy_internal& operator++()
    {
        ++anchor;
        ++array_index;
N
cleanup  
Niels 已提交
8676

8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689
        return *this;
    }

    /// inequality operator (needed for range-based for)
    bool operator!= (const iteration_proxy_internal& o) const
    {
        return anchor != o.anchor;
    }

    /// return key of the iterator
    typename basic_json::string_t key() const
    {
        assert(anchor.m_object != nullptr);
N
cleanup  
Niels 已提交
8690

8691 8692 8693 8694
        switch (anchor.m_object->type())
        {
            // use integer array index as key
            case value_t::array:
N
cleanup  
Niels 已提交
8695
            {
8696
                return std::to_string(array_index);
N
cleanup  
Niels 已提交
8697 8698
            }

8699 8700
            // use key from the object
            case value_t::object:
N
cleanup  
Niels 已提交
8701
            {
8702
                return anchor.key();
N
cleanup  
Niels 已提交
8703 8704
            }

8705 8706
            // use an empty key for all primitive types
            default:
N
cleanup  
Niels 已提交
8707
            {
8708
                return "";
N
cleanup  
Niels 已提交
8709
            }
8710 8711 8712 8713 8714 8715 8716 8717
        }
    }

    /// return value of the iterator
    typename IteratorType::reference value() const
    {
        return anchor.value();
    }
N
cleanup  
Niels 已提交
8718 8719
        };

8720 8721
    /// the container to iterate
    typename IteratorType::reference container;
N
cleanup  
Niels 已提交
8722

8723 8724 8725 8726 8727
    public:
    /// construct iteration proxy from a container
    explicit iteration_proxy(typename IteratorType::reference cont)
    : container(cont)
    {}
N
cleanup  
Niels 已提交
8728

8729 8730 8731 8732 8733
    /// return iterator begin (needed for range-based for)
    iteration_proxy_internal begin() noexcept
    {
        return iteration_proxy_internal(container.begin());
    }
N
cleanup  
Niels 已提交
8734

8735 8736 8737 8738 8739
    /// return iterator end (needed for range-based for)
    iteration_proxy_internal end() noexcept
    {
        return iteration_proxy_internal(container.end());
    }
N
cleanup  
Niels 已提交
8740 8741
    };

N
Niels 已提交
8742
  public:
N
Niels 已提交
8743
    /*!
8744
    @brief a template for a random access iterator for the @ref basic_json class
N
Niels 已提交
8745

N
Niels Lohmann 已提交
8746 8747
    This class implements a both iterators (iterator and const_iterator) for the
    @ref basic_json class.
N
Niels 已提交
8748

N
Niels 已提交
8749 8750 8751
    @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 已提交
8752 8753
          methods are undefined. **The library uses assertions to detect calls
          on uninitialized iterators.**
N
Niels 已提交
8754

N
Niels 已提交
8755 8756 8757 8758
    @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 已提交
8759

N
Niels Lohmann 已提交
8760
    @since version 1.0.0, simplified in version 2.0.9
N
Niels 已提交
8761
    */
N
Niels Lohmann 已提交
8762
    template<typename U>
8763
  class iter_impl : public std::iterator<std::random_access_iterator_tag, U>
N
Niels 已提交
8764
    {
N
Niels 已提交
8765
        /// allow basic_json to access private members
8766 8767
        friend class basic_json;

8768 8769 8770 8771 8772
        // 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");

8773
        public:
N
Niels 已提交
8774
        /// the type of the values when the iterator is dereferenced
N
Niels 已提交
8775
        using value_type = typename basic_json::value_type;
N
Niels 已提交
8776
        /// a type to represent differences between iterators
N
Niels 已提交
8777
        using difference_type = typename basic_json::difference_type;
N
Niels 已提交
8778
        /// defines a pointer to the type iterated over (value_type)
8779
        using pointer = typename std::conditional<std::is_const<U>::value,
8780 8781
                typename basic_json::const_pointer,
                typename basic_json::pointer>::type;
N
Niels 已提交
8782
        /// defines a reference to the type iterated over (value_type)
8783
        using reference = typename std::conditional<std::is_const<U>::value,
8784 8785
                typename basic_json::const_reference,
                typename basic_json::reference>::type;
N
Niels 已提交
8786
        /// the category of the iterator
N
Niels 已提交
8787
        using iterator_category = std::bidirectional_iterator_tag;
N
Niels 已提交
8788

8789
        /// default constructor
8790
        iter_impl() = default;
8791

N
Niels 已提交
8792 8793 8794 8795 8796 8797
        /*!
        @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`.
        */
8798
        explicit iter_impl(pointer object) noexcept
8799 8800 8801
        : m_object(object)
    {
        assert(m_object != nullptr);
N
Niels 已提交
8802

8803 8804 8805
        switch (m_object->m_type)
        {
            case basic_json::value_t::object:
N
Niels 已提交
8806
            {
8807 8808 8809
                m_it.object_iterator = typename object_t::iterator();
                break;
            }
8810

8811 8812 8813 8814 8815
            case basic_json::value_t::array:
            {
                m_it.array_iterator = typename array_t::iterator();
                break;
            }
8816

8817 8818 8819 8820
            default:
            {
                m_it.primitive_iterator = primitive_iterator_t();
                break;
N
Niels 已提交
8821 8822
            }
        }
8823
    }
N
Niels 已提交
8824

8825 8826 8827 8828
    /*
    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 已提交
8829

8830 8831 8832 8833 8834 8835 8836 8837
    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 已提交
8838
        {
8839 8840 8841
            ret.m_object = m_object;
            ret.m_it = m_it;
        }
N
Niels 已提交
8842

8843 8844
        return ret;
    }
8845

8846 8847 8848 8849 8850 8851 8852 8853
    /*!
    @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 已提交
8854

8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870
    /*!
    @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 已提交
8871

8872 8873 8874 8875 8876 8877 8878 8879
    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
Niels 已提交
8880

8881
        switch (m_object->m_type)
N
Niels 已提交
8882
        {
8883 8884 8885 8886 8887
            case basic_json::value_t::object:
            {
                m_it.object_iterator = m_object->m_value.object->begin();
                break;
            }
N
Niels 已提交
8888

8889
            case basic_json::value_t::array:
N
Niels 已提交
8890
            {
8891 8892 8893
                m_it.array_iterator = m_object->m_value.array->begin();
                break;
            }
N
Niels 已提交
8894

8895 8896 8897 8898 8899 8900
            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
Niels 已提交
8901

8902 8903 8904 8905
            default:
            {
                m_it.primitive_iterator.set_begin();
                break;
N
Niels 已提交
8906 8907
            }
        }
8908
    }
N
Niels 已提交
8909

8910 8911 8912 8913 8914 8915 8916
    /*!
    @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 已提交
8917

8918 8919 8920
        switch (m_object->m_type)
        {
            case basic_json::value_t::object:
N
Niels 已提交
8921
            {
8922 8923 8924
                m_it.object_iterator = m_object->m_value.object->end();
                break;
            }
N
Niels 已提交
8925

8926 8927 8928 8929 8930
            case basic_json::value_t::array:
            {
                m_it.array_iterator = m_object->m_value.array->end();
                break;
            }
N
Niels 已提交
8931

8932 8933 8934 8935
            default:
            {
                m_it.primitive_iterator.set_end();
                break;
N
Niels 已提交
8936 8937
            }
        }
8938
    }
N
Niels 已提交
8939

8940 8941 8942 8943 8944 8945 8946 8947
    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 已提交
8948

8949 8950 8951
        switch (m_object->m_type)
        {
            case basic_json::value_t::object:
N
Niels 已提交
8952
            {
8953 8954 8955
                assert(m_it.object_iterator != m_object->m_value.object->end());
                return m_it.object_iterator->second;
            }
N
Niels 已提交
8956

8957 8958 8959 8960 8961
            case basic_json::value_t::array:
            {
                assert(m_it.array_iterator != m_object->m_value.array->end());
                return *m_it.array_iterator;
            }
N
Niels Lohmann 已提交
8962

8963 8964
            case basic_json::value_t::null:
            {
8965
                    JSON_THROW(std::out_of_range("cannot get value"));
N
Niels 已提交
8966
            }
N
Niels 已提交
8967

8968
            default:
N
Niels 已提交
8969
            {
8970
                if (m_it.primitive_iterator.is_begin())
N
Niels 已提交
8971
                {
8972
                    return *m_object;
N
Niels 已提交
8973 8974
                }

8975
                    JSON_THROW(std::out_of_range("cannot get value"));
N
Niels 已提交
8976 8977
            }
        }
8978
    }
N
Niels 已提交
8979

8980 8981 8982 8983 8984 8985 8986
    /*!
    @brief dereference the iterator
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    pointer operator->() const
    {
        assert(m_object != nullptr);
N
Niels 已提交
8987

8988
        switch (m_object->m_type)
N
Niels 已提交
8989
        {
8990 8991 8992 8993 8994
            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 已提交
8995

8996
            case basic_json::value_t::array:
N
Niels 已提交
8997
            {
8998 8999 9000
                assert(m_it.array_iterator != m_object->m_value.array->end());
                return &*m_it.array_iterator;
            }
N
Niels 已提交
9001

9002 9003 9004
            default:
            {
                if (m_it.primitive_iterator.is_begin())
N
Niels 已提交
9005
                {
9006
                    return m_object;
N
Niels 已提交
9007 9008
                }

9009
                    JSON_THROW(std::out_of_range("cannot get value"));
N
Niels 已提交
9010 9011
            }
        }
9012
    }
N
Niels 已提交
9013

9014 9015 9016 9017 9018 9019 9020 9021 9022 9023
    /*!
    @brief post-increment (it++)
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    iter_impl operator++(int)
    {
        auto result = *this;
        ++(*this);
        return result;
    }
N
Niels 已提交
9024

9025 9026 9027 9028 9029 9030 9031
    /*!
    @brief pre-increment (++it)
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    iter_impl& operator++()
    {
        assert(m_object != nullptr);
N
Niels 已提交
9032

9033 9034 9035
        switch (m_object->m_type)
        {
            case basic_json::value_t::object:
N
Niels 已提交
9036
            {
9037 9038 9039
                std::advance(m_it.object_iterator, 1);
                break;
            }
N
Niels 已提交
9040

9041 9042 9043 9044
            case basic_json::value_t::array:
            {
                std::advance(m_it.array_iterator, 1);
                break;
N
Niels 已提交
9045 9046
            }

9047 9048 9049 9050 9051
            default:
            {
                ++m_it.primitive_iterator;
                break;
            }
N
Niels 已提交
9052 9053
        }

9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076
        return *this;
    }

    /*!
    @brief post-decrement (it--)
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    iter_impl operator--(int)
    {
        auto result = *this;
        --(*this);
        return result;
    }

    /*!
    @brief pre-decrement (--it)
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    iter_impl& operator--()
    {
        assert(m_object != nullptr);

        switch (m_object->m_type)
N
Niels 已提交
9077
        {
9078
            case basic_json::value_t::object:
N
Niels 已提交
9079
            {
9080 9081
                std::advance(m_it.object_iterator, -1);
                break;
N
Niels 已提交
9082 9083
            }

9084
            case basic_json::value_t::array:
N
Niels 已提交
9085
            {
9086 9087 9088
                std::advance(m_it.array_iterator, -1);
                break;
            }
N
Niels 已提交
9089

9090 9091 9092 9093
            default:
            {
                --m_it.primitive_iterator;
                break;
N
Niels 已提交
9094 9095 9096
            }
        }

9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107
        return *this;
    }

    /*!
    @brief  comparison: equal
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    bool operator==(const iter_impl& other) const
    {
        // if objects are not the same, the comparison is undefined
        if (m_object != other.m_object)
N
Niels 已提交
9108
        {
9109
                JSON_THROW(std::domain_error("cannot compare iterators of different containers"));
N
Niels 已提交
9110 9111
        }

9112 9113 9114
        assert(m_object != nullptr);

        switch (m_object->m_type)
N
Niels 已提交
9115
        {
9116
            case basic_json::value_t::object:
N
Niels 已提交
9117
            {
9118
                return (m_it.object_iterator == other.m_it.object_iterator);
N
Niels 已提交
9119 9120
            }

9121
            case basic_json::value_t::array:
N
Niels 已提交
9122
            {
9123 9124
                return (m_it.array_iterator == other.m_it.array_iterator);
            }
N
Niels 已提交
9125

9126 9127 9128
            default:
            {
                return (m_it.primitive_iterator == other.m_it.primitive_iterator);
N
Niels 已提交
9129 9130
            }
        }
9131
    }
N
Niels 已提交
9132

9133 9134 9135 9136 9137 9138 9139 9140
    /*!
    @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
Niels 已提交
9141

9142 9143 9144 9145 9146 9147 9148 9149
    /*!
    @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 已提交
9150
        {
9151
                JSON_THROW(std::domain_error("cannot compare iterators of different containers"));
N
Niels 已提交
9152 9153
        }

9154
        assert(m_object != nullptr);
N
Niels 已提交
9155

9156
        switch (m_object->m_type)
N
Niels 已提交
9157
        {
9158
            case basic_json::value_t::object:
N
Niels 已提交
9159
            {
9160
                    JSON_THROW(std::domain_error("cannot compare order of object iterators"));
N
Niels 已提交
9161 9162
            }

9163 9164 9165 9166
            case basic_json::value_t::array:
            {
                return (m_it.array_iterator < other.m_it.array_iterator);
            }
N
Niels 已提交
9167

9168 9169 9170 9171
            default:
            {
                return (m_it.primitive_iterator < other.m_it.primitive_iterator);
            }
N
Niels 已提交
9172
        }
9173
    }
N
Niels 已提交
9174

9175 9176 9177 9178 9179 9180 9181 9182
    /*!
    @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 已提交
9183

9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210
    /*!
    @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);
    }

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

    /*!
    @brief  add to iterator
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    iter_impl& operator+=(difference_type i)
    {
        assert(m_object != nullptr);

        switch (m_object->m_type)
N
Niels 已提交
9211
        {
9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227
            case basic_json::value_t::object:
            {
                    JSON_THROW(std::domain_error("cannot use offsets with object iterators"));
            }

            case basic_json::value_t::array:
            {
                std::advance(m_it.array_iterator, i);
                break;
            }

            default:
            {
                m_it.primitive_iterator += i;
                break;
            }
N
Niels 已提交
9228 9229
        }

9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270
        return *this;
    }

    /*!
    @brief  subtract from iterator
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    iter_impl& operator-=(difference_type i)
    {
        return operator+=(-i);
    }

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

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

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

9272 9273 9274
        switch (m_object->m_type)
        {
            case basic_json::value_t::object:
N
Niels 已提交
9275
            {
9276
                    JSON_THROW(std::domain_error("cannot use offsets with object iterators"));
9277
            }
N
Niels 已提交
9278

9279 9280 9281 9282
            case basic_json::value_t::array:
            {
                return m_it.array_iterator - other.m_it.array_iterator;
            }
N
Niels 已提交
9283

9284 9285 9286
            default:
            {
                return m_it.primitive_iterator - other.m_it.primitive_iterator;
N
Niels 已提交
9287 9288
            }
        }
9289
    }
N
Niels 已提交
9290

9291 9292 9293 9294 9295 9296 9297
    /*!
    @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 已提交
9298

9299 9300 9301
        switch (m_object->m_type)
        {
            case basic_json::value_t::object:
N
Niels 已提交
9302
            {
9303
                    JSON_THROW(std::domain_error("cannot use operator[] for object iterators"));
9304
            }
N
Niels 已提交
9305

9306 9307 9308 9309
            case basic_json::value_t::array:
            {
                return *std::next(m_it.array_iterator, n);
            }
N
Niels 已提交
9310

9311 9312
            case basic_json::value_t::null:
            {
9313
                    JSON_THROW(std::out_of_range("cannot get value"));
9314
            }
N
Niels 已提交
9315

9316 9317 9318
            default:
            {
                if (m_it.primitive_iterator.get_value() == -n)
N
Niels 已提交
9319
                {
9320 9321
                    return *m_object;
                }
N
Niels Lohmann 已提交
9322

9323
                    JSON_THROW(std::out_of_range("cannot get value"));
N
Niels 已提交
9324 9325
            }
        }
9326
    }
N
Niels 已提交
9327

9328 9329 9330 9331 9332 9333 9334
    /*!
    @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 已提交
9335

9336 9337 9338 9339
        if (m_object->is_object())
        {
            return m_it.object_iterator->first;
        }
N
Niels Lohmann 已提交
9340

9341
            JSON_THROW(std::domain_error("cannot use key() for non-object iterators"));
9342
    }
N
Niels 已提交
9343

9344 9345 9346 9347 9348 9349 9350 9351
    /*!
    @brief  return the value of an iterator
    @pre The iterator is initialized; i.e. `m_object != nullptr`.
    */
    reference value() const
    {
        return operator*();
    }
N
Niels 已提交
9352

9353 9354 9355 9356 9357 9358
    private:
    /// associated JSON instance
    pointer m_object = nullptr;
    /// the actual iterator of the associated instance
    internal_iterator m_it = internal_iterator();
                       };
N
Niels 已提交
9359

N
Niels 已提交
9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373
    /*!
    @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 已提交
9374

N
Niels 已提交
9375
    @since version 1.0.0
N
Niels 已提交
9376
    */
N
Niels 已提交
9377
    template<typename Base>
9378
  class json_reverse_iterator : public std::reverse_iterator<Base>
9379
    {
9380
        public:
9381
        /// shortcut to the reverse iterator adaptor
N
Niels 已提交
9382
        using base_iterator = std::reverse_iterator<Base>;
N
Niels 已提交
9383
        /// the reference type for the pointed-to element
N
Niels 已提交
9384
        using reference = typename Base::reference;
9385

9386
        /// create reverse iterator from iterator
N
Niels 已提交
9387
        json_reverse_iterator(const typename base_iterator::iterator_type& it) noexcept
9388 9389
        : base_iterator(it)
    {}
9390

9391 9392 9393 9394
    /// create reverse iterator from base class
    json_reverse_iterator(const base_iterator& it) noexcept
    : base_iterator(it)
    {}
9395

9396 9397 9398 9399 9400
    /// post-increment (it++)
    json_reverse_iterator operator++(int)
    {
        return base_iterator::operator++(1);
    }
9401

9402 9403 9404 9405 9406 9407
    /// pre-increment (++it)
    json_reverse_iterator& operator++()
    {
        base_iterator::operator++();
        return *this;
    }
9408

9409 9410 9411 9412 9413
    /// post-decrement (it--)
    json_reverse_iterator operator--(int)
    {
        return base_iterator::operator--(1);
    }
9414

9415 9416 9417 9418 9419 9420
    /// pre-decrement (--it)
    json_reverse_iterator& operator--()
    {
        base_iterator::operator--();
        return *this;
    }
9421

9422 9423 9424 9425 9426 9427
    /// add to iterator
    json_reverse_iterator& operator+=(difference_type i)
    {
        base_iterator::operator+=(i);
        return *this;
    }
9428

9429 9430 9431 9432 9433 9434 9435
    /// add to iterator
    json_reverse_iterator operator+(difference_type i) const
    {
        auto result = *this;
        result += i;
        return result;
    }
9436

9437 9438 9439 9440 9441 9442 9443
    /// subtract from iterator
    json_reverse_iterator operator-(difference_type i) const
    {
        auto result = *this;
        result -= i;
        return result;
    }
9444

9445 9446 9447 9448 9449
    /// return difference
    difference_type operator-(const json_reverse_iterator& other) const
    {
        return this->base() - other.base();
    }
9450

9451 9452 9453 9454 9455
    /// access to successor
    reference operator[](difference_type n) const
    {
        return *(this->operator+(n));
    }
N
Niels 已提交
9456

9457 9458 9459 9460 9461 9462
    /// return the key of an object iterator
    typename object_t::key_type key() const
    {
        auto it = --this->base();
        return it.key();
    }
9463

9464 9465 9466 9467 9468 9469 9470
    /// return the value of an iterator
    reference value() const
    {
        auto it = --this->base();
        return it.operator * ();
    }
                                                   };
9471

N
Niels 已提交
9472

N
Niels 已提交
9473
  private:
N
Niels 已提交
9474 9475 9476
    //////////////////////
    // lexer and parser //
    //////////////////////
N
Niels 已提交
9477

N
Niels 已提交
9478 9479 9480 9481
    /*!
    @brief lexical analysis

    This class organizes the lexical analysis during JSON deserialization. The
N
Niels 已提交
9482 9483
    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 已提交
9484
    */
N
Niels 已提交
9485
    class lexer
N
Niels 已提交
9486
    {
9487
        public:
N
Niels 已提交
9488 9489
        /// token types for the parser
        enum class token_type
9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505
    {
        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 已提交
9506

9507 9508
    /// the char type to use in the lexer
    using lexer_char_t = unsigned char;
N
Niels 已提交
9509

9510 9511 9512 9513 9514 9515 9516 9517
    /// 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 已提交
9518

9519 9520 9521 9522 9523 9524
    /// 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())
N
Niels 已提交
9525
        {
9526
                JSON_THROW(std::invalid_argument("stream error"));
N
Niels 已提交
9527
        }
N
Niels 已提交
9528

9529 9530
        // fill buffer
        fill_line_buffer();
N
Niels 已提交
9531

9532 9533 9534 9535 9536 9537 9538 9539
        // 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 已提交
9540

9541 9542 9543 9544
    // switch off unwanted functions (due to pointer members)
    lexer() = delete;
    lexer(const lexer&) = delete;
    lexer operator=(const lexer&) = delete;
N
Niels 已提交
9545

9546 9547
    /*!
    @brief create a string from one or two Unicode code points
N
Niels 已提交
9548

9549 9550 9551 9552
    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 已提交
9553

9554 9555
    @param[in] codepoint1  the code point (can be high surrogate)
    @param[in] codepoint2  the code point (can be low surrogate or 0)
N
Niels 已提交
9556

9557 9558
    @return string representation of the code point; the length of the
    result string is between 1 and 4 characters.
N
Niels 已提交
9559

9560 9561 9562 9563
    @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 已提交
9564

9565
    @complexity Constant.
N
Niels 已提交
9566

9567 9568 9569 9570 9571 9572 9573
    @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 已提交
9574

9575 9576 9577 9578 9579
        // 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 已提交
9580
            {
9581 9582 9583 9584 9585 9586 9587 9588 9589
                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 已提交
9590 9591 9592
            }
            else
            {
9593
                    JSON_THROW(std::invalid_argument("missing or wrong low surrogate"));
N
Niels 已提交
9594 9595 9596
            }
        }

9597 9598 9599
        string_t result;

        if (codepoint < 0x80)
N
cleanup  
Niels 已提交
9600
        {
9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 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 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666
            // 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 已提交
9667
            {
9668 9669
                // catch non-enum values
                return "unknown token"; // LCOV_EXCL_LINE
N
cleanup  
Niels 已提交
9670 9671
            }
        }
9672
    }
N
cleanup  
Niels 已提交
9673

9674 9675 9676 9677 9678 9679 9680
    /*!
    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 已提交
9681

9682
    @return the class of the next token read from the buffer
N
Niels 已提交
9683

9684
    @complexity Linear in the length of the input.\n
N
Niels 已提交
9685

9686
    Proposition: The loop below will always terminate for finite input.\n
N
Niels 已提交
9687

9688 9689 9690 9691 9692 9693 9694 9695 9696 9697
    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)
N
Niels 已提交
9698
        {
9699 9700
            // pointer for backtracking information
            m_marker = nullptr;
N
Niels 已提交
9701

9702 9703 9704
            // remember the begin of the token
            m_start = m_cursor;
            assert(m_start != nullptr);
N
Niels 已提交
9705

9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768
            
    {
        lexer_char_t yych;
        unsigned int yyaccept = 0;
        static const unsigned char yybm[] = {
              0,   0,   0,   0,   0,   0,   0,   0, 
              0,  32,  32,   0,   0,  32,   0,   0, 
              0,   0,   0,   0,   0,   0,   0,   0, 
              0,   0,   0,   0,   0,   0,   0,   0, 
            160, 128,   0, 128, 128, 128, 128, 128, 
            128, 128, 128, 128, 128, 128, 128, 128, 
            192, 192, 192, 192, 192, 192, 192, 192, 
            192, 192, 128, 128, 128, 128, 128, 128, 
            128, 128, 128, 128, 128, 128, 128, 128, 
            128, 128, 128, 128, 128, 128, 128, 128, 
            128, 128, 128, 128, 128, 128, 128, 128, 
            128, 128, 128, 128,   0, 128, 128, 128, 
            128, 128, 128, 128, 128, 128, 128, 128, 
            128, 128, 128, 128, 128, 128, 128, 128, 
            128, 128, 128, 128, 128, 128, 128, 128, 
            128, 128, 128, 128, 128, 128, 128, 128, 
              0,   0,   0,   0,   0,   0,   0,   0, 
              0,   0,   0,   0,   0,   0,   0,   0, 
              0,   0,   0,   0,   0,   0,   0,   0, 
              0,   0,   0,   0,   0,   0,   0,   0, 
              0,   0,   0,   0,   0,   0,   0,   0, 
              0,   0,   0,   0,   0,   0,   0,   0, 
              0,   0,   0,   0,   0,   0,   0,   0, 
              0,   0,   0,   0,   0,   0,   0,   0, 
              0,   0,   0,   0,   0,   0,   0,   0, 
              0,   0,   0,   0,   0,   0,   0,   0, 
              0,   0,   0,   0,   0,   0,   0,   0, 
              0,   0,   0,   0,   0,   0,   0,   0, 
              0,   0,   0,   0,   0,   0,   0,   0, 
              0,   0,   0,   0,   0,   0,   0,   0, 
              0,   0,   0,   0,   0,   0,   0,   0, 
              0,   0,   0,   0,   0,   0,   0,   0, 
        };
        if ((m_limit - m_cursor) < 5) fill_line_buffer(5); // LCOV_EXCL_LINE
        yych = *m_cursor;
        if (yybm[0+yych] & 32) {
            goto basic_json_parser_6;
        }
        if (yych <= '[') {
            if (yych <= '-') {
                if (yych <= '"') {
                    if (yych <= 0x00) goto basic_json_parser_2;
                    if (yych <= '!') goto basic_json_parser_4;
                    goto basic_json_parser_9;
                } else {
                    if (yych <= '+') goto basic_json_parser_4;
                    if (yych <= ',') goto basic_json_parser_10;
                    goto basic_json_parser_12;
                }
            } else {
                if (yych <= '9') {
                    if (yych <= '/') goto basic_json_parser_4;
                    if (yych <= '0') goto basic_json_parser_13;
                    goto basic_json_parser_15;
                } else {
                    if (yych <= ':') goto basic_json_parser_17;
                    if (yych <= 'Z') goto basic_json_parser_4;
                    goto basic_json_parser_19;
9769
                }
9770 9771 9772 9773 9774 9775 9776 9777 9778 9779
            }
        } else {
            if (yych <= 'n') {
                if (yych <= 'e') {
                    if (yych == ']') goto basic_json_parser_21;
                    goto basic_json_parser_4;
                } else {
                    if (yych <= 'f') goto basic_json_parser_23;
                    if (yych <= 'm') goto basic_json_parser_4;
                    goto basic_json_parser_24;
9780
                }
9781 9782 9783 9784 9785 9786 9787 9788
            } else {
                if (yych <= 'z') {
                    if (yych == 't') goto basic_json_parser_25;
                    goto basic_json_parser_4;
                } else {
                    if (yych <= '{') goto basic_json_parser_26;
                    if (yych == '}') goto basic_json_parser_28;
                    goto basic_json_parser_4;
9789
                }
9790 9791 9792 9793 9794
            }
        }
basic_json_parser_2:
        ++m_cursor;
        { last_token_type = token_type::end_of_input; break; }
N
Niels 已提交
9795
basic_json_parser_4:
9796
        ++m_cursor;
N
Niels 已提交
9797
basic_json_parser_5:
9798
        { last_token_type = token_type::parse_error; break; }
N
Niels 已提交
9799
basic_json_parser_6:
9800 9801 9802 9803 9804 9805 9806
        ++m_cursor;
        if (m_limit <= m_cursor) fill_line_buffer(1); // LCOV_EXCL_LINE
        yych = *m_cursor;
        if (yybm[0+yych] & 32) {
            goto basic_json_parser_6;
        }
        { continue; }
N
Niels 已提交
9807
basic_json_parser_9:
9808 9809 9810 9811 9812 9813 9814
        yyaccept = 0;
        yych = *(m_marker = ++m_cursor);
        if (yych <= 0x1F) goto basic_json_parser_5;
        if (yych <= 0x7F) goto basic_json_parser_31;
        if (yych <= 0xC1) goto basic_json_parser_5;
        if (yych <= 0xF4) goto basic_json_parser_31;
        goto basic_json_parser_5;
9815
basic_json_parser_10:
9816 9817
        ++m_cursor;
        { last_token_type = token_type::value_separator; break; }
9818
basic_json_parser_12:
9819 9820 9821 9822 9823
        yych = *++m_cursor;
        if (yych <= '/') goto basic_json_parser_5;
        if (yych <= '0') goto basic_json_parser_13;
        if (yych <= '9') goto basic_json_parser_15;
        goto basic_json_parser_5;
9824
basic_json_parser_13:
9825 9826 9827 9828 9829 9830 9831 9832
        yyaccept = 1;
        yych = *(m_marker = ++m_cursor);
        if (yych <= 'D') {
            if (yych == '.') goto basic_json_parser_43;
        } else {
            if (yych <= 'E') goto basic_json_parser_44;
            if (yych == 'e') goto basic_json_parser_44;
        }
9833
basic_json_parser_14:
9834
        { last_token_type = token_type::value_number; break; }
9835
basic_json_parser_15:
9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850
        yyaccept = 1;
        m_marker = ++m_cursor;
        if ((m_limit - m_cursor) < 3) fill_line_buffer(3); // LCOV_EXCL_LINE
        yych = *m_cursor;
        if (yybm[0+yych] & 64) {
            goto basic_json_parser_15;
        }
        if (yych <= 'D') {
            if (yych == '.') goto basic_json_parser_43;
            goto basic_json_parser_14;
        } else {
            if (yych <= 'E') goto basic_json_parser_44;
            if (yych == 'e') goto basic_json_parser_44;
            goto basic_json_parser_14;
        }
9851
basic_json_parser_17:
9852 9853
        ++m_cursor;
        { last_token_type = token_type::name_separator; break; }
9854
basic_json_parser_19:
9855 9856
        ++m_cursor;
        { last_token_type = token_type::begin_array; break; }
9857
basic_json_parser_21:
9858 9859
        ++m_cursor;
        { last_token_type = token_type::end_array; break; }
9860
basic_json_parser_23:
9861 9862 9863 9864
        yyaccept = 0;
        yych = *(m_marker = ++m_cursor);
        if (yych == 'a') goto basic_json_parser_45;
        goto basic_json_parser_5;
9865
basic_json_parser_24:
9866 9867 9868 9869
        yyaccept = 0;
        yych = *(m_marker = ++m_cursor);
        if (yych == 'u') goto basic_json_parser_46;
        goto basic_json_parser_5;
9870
basic_json_parser_25:
9871 9872 9873 9874
        yyaccept = 0;
        yych = *(m_marker = ++m_cursor);
        if (yych == 'r') goto basic_json_parser_47;
        goto basic_json_parser_5;
9875
basic_json_parser_26:
9876 9877
        ++m_cursor;
        { last_token_type = token_type::begin_object; break; }
9878
basic_json_parser_28:
9879 9880
        ++m_cursor;
        { last_token_type = token_type::end_object; break; }
9881
basic_json_parser_30:
9882 9883 9884
        ++m_cursor;
        if (m_limit <= m_cursor) fill_line_buffer(1); // LCOV_EXCL_LINE
        yych = *m_cursor;
9885
basic_json_parser_31:
9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908
        if (yybm[0+yych] & 128) {
            goto basic_json_parser_30;
        }
        if (yych <= 0xE0) {
            if (yych <= '\\') {
                if (yych <= 0x1F) goto basic_json_parser_32;
                if (yych <= '"') goto basic_json_parser_33;
                goto basic_json_parser_35;
            } else {
                if (yych <= 0xC1) goto basic_json_parser_32;
                if (yych <= 0xDF) goto basic_json_parser_36;
                goto basic_json_parser_37;
            }
        } else {
            if (yych <= 0xEF) {
                if (yych == 0xED) goto basic_json_parser_39;
                goto basic_json_parser_38;
            } else {
                if (yych <= 0xF0) goto basic_json_parser_40;
                if (yych <= 0xF3) goto basic_json_parser_41;
                if (yych <= 0xF4) goto basic_json_parser_42;
            }
        }
9909
basic_json_parser_32:
9910 9911 9912 9913 9914 9915
        m_cursor = m_marker;
        if (yyaccept == 0) {
            goto basic_json_parser_5;
        } else {
            goto basic_json_parser_14;
        }
9916
basic_json_parser_33:
9917 9918
        ++m_cursor;
        { last_token_type = token_type::value_string; break; }
9919
basic_json_parser_35:
9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934
        ++m_cursor;
        if (m_limit <= m_cursor) fill_line_buffer(1); // LCOV_EXCL_LINE
        yych = *m_cursor;
        if (yych <= 'e') {
            if (yych <= '/') {
                if (yych == '"') goto basic_json_parser_30;
                if (yych <= '.') goto basic_json_parser_32;
                goto basic_json_parser_30;
            } else {
                if (yych <= '\\') {
                    if (yych <= '[') goto basic_json_parser_32;
                    goto basic_json_parser_30;
                } else {
                    if (yych == 'b') goto basic_json_parser_30;
                    goto basic_json_parser_32;
9935
                }
9936 9937 9938 9939 9940
            }
        } else {
            if (yych <= 'q') {
                if (yych <= 'f') goto basic_json_parser_30;
                if (yych == 'n') goto basic_json_parser_30;
9941
                goto basic_json_parser_32;
9942 9943 9944
            } else {
                if (yych <= 's') {
                    if (yych <= 'r') goto basic_json_parser_30;
Y
Yixin Zhang 已提交
9945
                    goto basic_json_parser_32;
9946 9947 9948
                } else {
                    if (yych <= 't') goto basic_json_parser_30;
                    if (yych <= 'u') goto basic_json_parser_48;
Y
Yixin Zhang 已提交
9949
                    goto basic_json_parser_32;
9950
                }
9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973
            }
        }
basic_json_parser_36:
        ++m_cursor;
        if (m_limit <= m_cursor) fill_line_buffer(1); // LCOV_EXCL_LINE
        yych = *m_cursor;
        if (yych <= 0x7F) goto basic_json_parser_32;
        if (yych <= 0xBF) goto basic_json_parser_30;
        goto basic_json_parser_32;
basic_json_parser_37:
        ++m_cursor;
        if (m_limit <= m_cursor) fill_line_buffer(1); // LCOV_EXCL_LINE
        yych = *m_cursor;
        if (yych <= 0x9F) goto basic_json_parser_32;
        if (yych <= 0xBF) goto basic_json_parser_36;
        goto basic_json_parser_32;
basic_json_parser_38:
        ++m_cursor;
        if (m_limit <= m_cursor) fill_line_buffer(1); // LCOV_EXCL_LINE
        yych = *m_cursor;
        if (yych <= 0x7F) goto basic_json_parser_32;
        if (yych <= 0xBF) goto basic_json_parser_36;
        goto basic_json_parser_32;
N
Niels 已提交
9974
basic_json_parser_39:
9975 9976 9977 9978 9979 9980
        ++m_cursor;
        if (m_limit <= m_cursor) fill_line_buffer(1); // LCOV_EXCL_LINE
        yych = *m_cursor;
        if (yych <= 0x7F) goto basic_json_parser_32;
        if (yych <= 0x9F) goto basic_json_parser_36;
        goto basic_json_parser_32;
N
Niels 已提交
9981
basic_json_parser_40:
9982 9983 9984 9985 9986 9987
        ++m_cursor;
        if (m_limit <= m_cursor) fill_line_buffer(1); // LCOV_EXCL_LINE
        yych = *m_cursor;
        if (yych <= 0x8F) goto basic_json_parser_32;
        if (yych <= 0xBF) goto basic_json_parser_38;
        goto basic_json_parser_32;
N
Niels 已提交
9988
basic_json_parser_41:
9989 9990 9991 9992 9993 9994
        ++m_cursor;
        if (m_limit <= m_cursor) fill_line_buffer(1); // LCOV_EXCL_LINE
        yych = *m_cursor;
        if (yych <= 0x7F) goto basic_json_parser_32;
        if (yych <= 0xBF) goto basic_json_parser_38;
        goto basic_json_parser_32;
N
Niels 已提交
9995
basic_json_parser_42:
9996 9997 9998 9999 10000 10001
        ++m_cursor;
        if (m_limit <= m_cursor) fill_line_buffer(1); // LCOV_EXCL_LINE
        yych = *m_cursor;
        if (yych <= 0x7F) goto basic_json_parser_32;
        if (yych <= 0x8F) goto basic_json_parser_38;
        goto basic_json_parser_32;
N
Niels 已提交
10002
basic_json_parser_43:
10003 10004 10005 10006
        yych = *++m_cursor;
        if (yych <= '/') goto basic_json_parser_32;
        if (yych <= '9') goto basic_json_parser_49;
        goto basic_json_parser_32;
10007
basic_json_parser_44:
10008 10009 10010 10011 10012 10013 10014 10015 10016 10017
        yych = *++m_cursor;
        if (yych <= ',') {
            if (yych == '+') goto basic_json_parser_51;
            goto basic_json_parser_32;
        } else {
            if (yych <= '-') goto basic_json_parser_51;
            if (yych <= '/') goto basic_json_parser_32;
            if (yych <= '9') goto basic_json_parser_52;
            goto basic_json_parser_32;
        }
10018
basic_json_parser_45:
10019 10020 10021
        yych = *++m_cursor;
        if (yych == 'l') goto basic_json_parser_54;
        goto basic_json_parser_32;
N
Niels 已提交
10022
basic_json_parser_46:
10023 10024 10025
        yych = *++m_cursor;
        if (yych == 'l') goto basic_json_parser_55;
        goto basic_json_parser_32;
N
Niels 已提交
10026
basic_json_parser_47:
10027 10028 10029
        yych = *++m_cursor;
        if (yych == 'u') goto basic_json_parser_56;
        goto basic_json_parser_32;
N
Niels 已提交
10030
basic_json_parser_48:
10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043
        ++m_cursor;
        if (m_limit <= m_cursor) fill_line_buffer(1); // LCOV_EXCL_LINE
        yych = *m_cursor;
        if (yych <= '@') {
            if (yych <= '/') goto basic_json_parser_32;
            if (yych <= '9') goto basic_json_parser_57;
            goto basic_json_parser_32;
        } else {
            if (yych <= 'F') goto basic_json_parser_57;
            if (yych <= '`') goto basic_json_parser_32;
            if (yych <= 'f') goto basic_json_parser_57;
            goto basic_json_parser_32;
        }
10044
basic_json_parser_49:
10045 10046 10047 10048 10049 10050 10051 10052 10053 10054 10055 10056 10057
        yyaccept = 1;
        m_marker = ++m_cursor;
        if ((m_limit - m_cursor) < 3) fill_line_buffer(3); // LCOV_EXCL_LINE
        yych = *m_cursor;
        if (yych <= 'D') {
            if (yych <= '/') goto basic_json_parser_14;
            if (yych <= '9') goto basic_json_parser_49;
            goto basic_json_parser_14;
        } else {
            if (yych <= 'E') goto basic_json_parser_44;
            if (yych == 'e') goto basic_json_parser_44;
            goto basic_json_parser_14;
        }
10058
basic_json_parser_51:
10059 10060 10061
        yych = *++m_cursor;
        if (yych <= '/') goto basic_json_parser_32;
        if (yych >= ':') goto basic_json_parser_32;
10062
basic_json_parser_52:
10063 10064 10065 10066 10067 10068
        ++m_cursor;
        if (m_limit <= m_cursor) fill_line_buffer(1); // LCOV_EXCL_LINE
        yych = *m_cursor;
        if (yych <= '/') goto basic_json_parser_14;
        if (yych <= '9') goto basic_json_parser_52;
        goto basic_json_parser_14;
10069
basic_json_parser_54:
10070 10071 10072
        yych = *++m_cursor;
        if (yych == 's') goto basic_json_parser_58;
        goto basic_json_parser_32;
10073
basic_json_parser_55:
10074 10075 10076
        yych = *++m_cursor;
        if (yych == 'l') goto basic_json_parser_59;
        goto basic_json_parser_32;
10077
basic_json_parser_56:
10078 10079 10080
        yych = *++m_cursor;
        if (yych == 'e') goto basic_json_parser_61;
        goto basic_json_parser_32;
N
Niels 已提交
10081
basic_json_parser_57:
10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094
        ++m_cursor;
        if (m_limit <= m_cursor) fill_line_buffer(1); // LCOV_EXCL_LINE
        yych = *m_cursor;
        if (yych <= '@') {
            if (yych <= '/') goto basic_json_parser_32;
            if (yych <= '9') goto basic_json_parser_63;
            goto basic_json_parser_32;
        } else {
            if (yych <= 'F') goto basic_json_parser_63;
            if (yych <= '`') goto basic_json_parser_32;
            if (yych <= 'f') goto basic_json_parser_63;
            goto basic_json_parser_32;
        }
10095
basic_json_parser_58:
10096 10097 10098
        yych = *++m_cursor;
        if (yych == 'e') goto basic_json_parser_64;
        goto basic_json_parser_32;
N
Niels 已提交
10099
basic_json_parser_59:
10100 10101
        ++m_cursor;
        { last_token_type = token_type::literal_null; break; }
10102
basic_json_parser_61:
10103 10104
        ++m_cursor;
        { last_token_type = token_type::literal_true; break; }
10105
basic_json_parser_63:
10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118
        ++m_cursor;
        if (m_limit <= m_cursor) fill_line_buffer(1); // LCOV_EXCL_LINE
        yych = *m_cursor;
        if (yych <= '@') {
            if (yych <= '/') goto basic_json_parser_32;
            if (yych <= '9') goto basic_json_parser_66;
            goto basic_json_parser_32;
        } else {
            if (yych <= 'F') goto basic_json_parser_66;
            if (yych <= '`') goto basic_json_parser_32;
            if (yych <= 'f') goto basic_json_parser_66;
            goto basic_json_parser_32;
        }
N
Niels 已提交
10119
basic_json_parser_64:
10120 10121
        ++m_cursor;
        { last_token_type = token_type::literal_false; break; }
10122
basic_json_parser_66:
10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136
        ++m_cursor;
        if (m_limit <= m_cursor) fill_line_buffer(1); // LCOV_EXCL_LINE
        yych = *m_cursor;
        if (yych <= '@') {
            if (yych <= '/') goto basic_json_parser_32;
            if (yych <= '9') goto basic_json_parser_30;
            goto basic_json_parser_32;
        } else {
            if (yych <= 'F') goto basic_json_parser_30;
            if (yych <= '`') goto basic_json_parser_32;
            if (yych <= 'f') goto basic_json_parser_30;
            goto basic_json_parser_32;
        }
    }
N
Niels 已提交
10137

N
Niels 已提交
10138 10139
        }

10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175
        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()));
N
Niels Lohmann 已提交
10176

10177 10178 10179
        // if line buffer is used, m_limit is set past the end of its data
        assert(m_line_buffer.empty()
               or m_limit == m_content + m_line_buffer.size());
N
Niels Lohmann 已提交
10180

10181 10182 10183 10184 10185
        // pointer relationships
        assert(m_content <= m_start);
        assert(m_start <= m_cursor);
        assert(m_cursor <= m_limit);
        assert(m_marker == nullptr or m_marker  <= m_limit);
N
Niels Lohmann 已提交
10186

10187
        // number of processed characters (p)
N
Niels Lohmann 已提交
10188
            const auto num_processed_chars = static_cast<size_t>(m_start - m_content);
10189 10190 10191 10192
        // offset for m_marker wrt. to m_start
        const auto offset_marker = (m_marker == nullptr) ? 0 : m_marker - m_start;
        // number of unprocessed characters (u)
        const auto offset_cursor = m_cursor - m_start;
N
Niels 已提交
10193

10194 10195 10196 10197 10198 10199 10200
        // 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);
10201

10202 10203 10204 10205
            // 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)
10206
            {
10207
                m_line_buffer.append(n - 1, '\x01');
10208
            }
N
Niels 已提交
10209
        }
10210
        else
N
Niels 已提交
10211
        {
10212 10213 10214 10215 10216 10217 10218 10219 10220
            // delete processed characters from line buffer
            m_line_buffer.erase(0, num_processed_chars);
            // read next line from input stream
            m_line_buffer_tmp.clear();
            std::getline(*m_stream, m_line_buffer_tmp, '\n');

            // add line with newline symbol to the line buffer
            m_line_buffer += m_line_buffer_tmp;
            m_line_buffer.push_back('\n');
N
Niels 已提交
10221 10222
        }

10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256
        // 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();
    }

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

    /*!
    @brief return string value for string tokens

    The function iterates the characters between the opening and closing
    quotes of the string value. The complete string is the range
    [m_start,m_cursor). Consequently, we iterate from m_start+1 to
    m_cursor-1.

    We differentiate two cases:

    1. Escaped characters. In this case, a new character is constructed
       according to the nature of the escape. Some escapes create new
       characters (e.g., `"\\n"` is replaced by `"\n"`), some are copied
       as is (e.g., `"\\\\"`). Furthermore, Unicode escapes of the shape
       `"\\uxxxx"` need special care. In this case, to_unicode takes care
       of the construction of the values.
    2. Unescaped characters are copied as is.
N
Niels 已提交
10257

10258 10259 10260
    @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).
N
Niels 已提交
10261

10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309
        " c1 c2 c3 ... "
        ^                ^
        m_start          m_cursor

    @complexity Linear in the length of the string.\n

    Lemma: The loop body will always terminate.\n

    Proof (by contradiction): Assume the loop body does not terminate. As
    the loop body does not contain another loop, one of the called
    functions must never return. The called functions are `std::strtoul`
    and to_unicode. Neither function can loop forever, so the loop body
    will never loop forever which contradicts the assumption that the loop
    body does not terminate, q.e.d.\n

    Lemma: The loop condition for the for loop is eventually false.\n

    Proof (by contradiction): Assume the loop does not terminate. Due to
    the above lemma, this can only be due to a tautological loop
    condition; that is, the loop condition i < m_cursor - 1 must always be
    true. Let x be the change of i for any loop iteration. Then
    m_start + 1 + x < m_cursor - 1 must hold to loop indefinitely. This
    can be rephrased to m_cursor - m_start - 2 > x. With the
    precondition, we x <= 0, meaning that the loop condition holds
    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);

        string_t result;
        result.reserve(static_cast<size_t>(m_cursor - m_start - 2));

        // 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 已提交
10310
            {
10311 10312
                // see https://github.com/nlohmann/json/issues/365#issuecomment-262874705
                for (auto k = i; k < e; k++)
N
Niels 已提交
10313
                {
10314
                    result.push_back(static_cast<typename string_t::value_type>(*k));
N
Niels 已提交
10315
                }
10316 10317 10318 10319 10320 10321 10322 10323 10324
                i = e - 1; // -1 because of ++i
            }
            else
            {
                // processing escaped character
                // read next character
                ++i;

                switch (*i)
N
Niels 已提交
10325
                {
10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366
                    // 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 已提交
10367

10368 10369
                    // unicode
                    case 'u':
N
Niels 已提交
10370
                    {
10371 10372 10373
                        // 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 已提交
10374

10375 10376
                        // check if codepoint is a high surrogate
                        if (codepoint >= 0xD800 and codepoint <= 0xDBFF)
N
Niels 已提交
10377
                        {
10378 10379
                            // make sure there is a subsequent unicode
                            if ((i + 6 >= m_limit) or * (i + 5) != '\\' or * (i + 6) != 'u')
N
Niels 已提交
10380
                            {
10381
                                    JSON_THROW(std::invalid_argument("missing low surrogate"));
N
Niels 已提交
10382
                            }
10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393

                            // 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
10394
                                JSON_THROW(std::invalid_argument("missing high surrogate"));
N
Niels 已提交
10395
                        }
10396 10397 10398 10399 10400 10401 10402 10403
                        else
                        {
                            // add unicode character(s)
                            result += to_unicode(codepoint);
                            // skip the next four characters (xxxx)
                            i += 4;
                        }
                        break;
N
Niels 已提交
10404 10405 10406
                    }
                }
            }
N
Niels 已提交
10407 10408
        }

10409 10410
        return result;
    }
10411

10412 10413
    /*!
    @brief parse floating point number
10414

10415 10416 10417 10418
    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).
10419

10420 10421
    @param[in,out] endptr recieves a pointer to the first character after
    the number
10422

10423 10424 10425 10426 10427 10428
    @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);
    }
10429

10430 10431
    /*!
    @brief parse floating point number
10432

10433 10434 10435 10436
    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).
10437

10438 10439
    @param[in,out] endptr  recieves a pointer to the first character after
    the number
10440

10441 10442 10443 10444 10445 10446
    @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);
    }
10447

10448 10449
    /*!
    @brief parse floating point number
10450

10451 10452 10453 10454
    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).
10455

10456 10457
    @param[in,out] endptr  recieves a pointer to the first character after
    the number
N
Niels 已提交
10458

10459 10460 10461 10462 10463 10464
    @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 已提交
10465

10466 10467
    /*!
    @brief return number value for number tokens
N
Niels 已提交
10468

10469 10470 10471
    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 已提交
10472

10473 10474 10475 10476 10477 10478
    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 已提交
10479

10480 10481
    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 已提交
10482

10483 10484 10485 10486 10487 10488 10489
    @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 已提交
10490

10491
        const lexer::lexer_char_t* curptr = m_start;
N
Niels 已提交
10492

10493 10494
        // accumulate the integer conversion result (unsigned for now)
        number_unsigned_t value = 0;
N
Niels 已提交
10495

10496 10497
        // maximum absolute value of the relevant integer type
        number_unsigned_t max;
N
Niels 已提交
10498

10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519
        // 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')
10520
            {
10521
                if (*curptr == '.')
N
Niels 已提交
10522
                {
10523
                    // don't count '.' but change to float
N
Niels 已提交
10524
                    type = value_t::number_float;
10525
                    continue;
N
Niels 已提交
10526
                }
10527 10528 10529 10530
                // assume exponent (if not then will fail parse): change to
                // float, stop counting and record exponent details
                type = value_t::number_float;
                break;
10531
            }
N
Niels 已提交
10532

10533 10534
            // skip if definitely not an integer
            if (type != value_t::number_float)
N
Niels 已提交
10535
            {
10536
                auto digit = static_cast<number_unsigned_t>(*curptr - '0');
N
Niels Lohmann 已提交
10537

10538 10539 10540
                // overflow if value * 10 + digit > max, move terms around
                // to avoid overflow in intermediate values
                if (value > (max - digit) / 10)
N
Niels Lohmann 已提交
10541
                {
10542 10543
                    // overflow
                    type = value_t::number_float;
N
Niels Lohmann 已提交
10544 10545 10546
                }
                else
                {
10547 10548
                    // no overflow
                    value = value * 10 + digit;
N
Niels Lohmann 已提交
10549
                }
N
Niels 已提交
10550
            }
10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570
        }

        // 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 已提交
10571
            else
10572
            {
10573 10574 10575 10576 10577 10578 10579
                // 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 已提交
10580
                result.m_value.number_float = str_to_float_t(static_cast<number_float_t*>(nullptr), nullptr);
N
Niels 已提交
10581

10582 10583 10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611 10612 10613
            // 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 已提交
10614

N
Niels 已提交
10615 10616
    /*!
    @brief syntax analysis
N
Niels 已提交
10617 10618

    This class implements a recursive decent parser.
N
Niels 已提交
10619
    */
N
Niels 已提交
10620 10621
    class parser
    {
10622
        public:
10623
        /// a parser reading from a string literal
N
Niels 已提交
10624
        parser(const char* buff, const parser_callback_t cb = nullptr)
10625 10626 10627
        : callback(cb),
        m_lexer(reinterpret_cast<const typename lexer::lexer_char_t*>(buff), std::strlen(buff))
    {}
10628

10629 10630 10631 10632
    /// a parser reading from an input stream
    parser(std::istream& is, const parser_callback_t cb = nullptr)
    : callback(cb), m_lexer(is)
    {}
10633

10634 10635 10636 10637 10638 10639 10640 10641 10642 10643
    /// 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 已提交
10644

10645 10646 10647 10648 10649
    /// public parser interface
    basic_json parse()
    {
        // read first token
        get_token();
N
cleanup  
Niels 已提交
10650

10651 10652
        basic_json result = parse_internal(true);
        result.assert_invariant();
N
Niels 已提交
10653

10654
        expect(lexer::token_type::end_of_input);
N
Niels 已提交
10655

10656 10657 10658 10659
        // 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 已提交
10660

10661 10662 10663 10664 10665
    private:
    /// the actual parser
    basic_json parse_internal(bool keep)
    {
        auto result = basic_json(value_t::discarded);
N
Niels 已提交
10666

10667 10668 10669
        switch (last_token)
        {
            case lexer::token_type::begin_object:
N
Niels 已提交
10670
            {
10671 10672
                if (keep and (not callback
                              or ((keep = callback(depth++, parse_event_t::object_start, result)) != 0)))
N
Niels 已提交
10673
                {
10674 10675 10676 10677
                    // explicitly set result to object to cope with {}
                    result.m_type = value_t::object;
                    result.m_value = value_t::object;
                }
N
Niels 已提交
10678

10679 10680
                // read next token
                get_token();
N
Niels 已提交
10681

10682 10683 10684
                // closing } -> we are done
                if (last_token == lexer::token_type::end_object)
                {
N
Niels 已提交
10685
                    get_token();
N
Niels 已提交
10686
                    if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
N
Niels 已提交
10687 10688 10689
                    {
                        result = basic_json(value_t::discarded);
                    }
N
Niels 已提交
10690
                    return result;
N
Niels 已提交
10691 10692
                }

10693 10694
                // no comma is expected here
                unexpect(lexer::token_type::value_separator);
N
Niels 已提交
10695

10696 10697 10698 10699 10700
                // otherwise: parse key-value pairs
                do
                {
                    // ugly, but could be fixed with loop reorganization
                    if (last_token == lexer::token_type::value_separator)
N
Niels 已提交
10701
                    {
N
Niels 已提交
10702
                        get_token();
N
Niels 已提交
10703 10704
                    }

10705 10706 10707
                    // store key
                    expect(lexer::token_type::value_string);
                    const auto key = m_lexer.get_string();
N
Niels 已提交
10708

10709 10710
                    bool keep_tag = false;
                    if (keep)
N
Niels 已提交
10711
                    {
10712
                        if (callback)
N
Niels 已提交
10713
                        {
10714 10715
                            basic_json k(key);
                            keep_tag = callback(depth, parse_event_t::key, k);
N
Niels 已提交
10716
                        }
10717
                        else
N
Niels 已提交
10718
                        {
10719
                            keep_tag = true;
N
Niels 已提交
10720
                        }
N
Niels 已提交
10721 10722
                    }

10723 10724 10725 10726 10727
                    // parse separator (:)
                    get_token();
                    expect(lexer::token_type::name_separator);

                    // parse and add value
N
Niels 已提交
10728
                    get_token();
10729 10730
                    auto value = parse_internal(keep);
                    if (keep and keep_tag and not value.is_discarded())
N
Niels 已提交
10731
                    {
10732
                        result[key] = std::move(value);
N
Niels 已提交
10733
                    }
N
Niels 已提交
10734
                }
10735
                while (last_token == lexer::token_type::value_separator);
N
Niels 已提交
10736

10737 10738 10739 10740
                // 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 已提交
10741
                {
10742
                    result = basic_json(value_t::discarded);
N
Niels 已提交
10743 10744
                }

10745 10746
                return result;
            }
N
Niels 已提交
10747

10748 10749 10750 10751
            case lexer::token_type::begin_array:
            {
                if (keep and (not callback
                              or ((keep = callback(depth++, parse_event_t::array_start, result)) != 0)))
N
Niels 已提交
10752
                {
10753 10754 10755
                    // explicitly set result to object to cope with []
                    result.m_type = value_t::array;
                    result.m_value = value_t::array;
N
Niels 已提交
10756 10757
                }

10758 10759 10760 10761 10762
                // read next token
                get_token();

                // closing ] -> we are done
                if (last_token == lexer::token_type::end_array)
N
Niels 已提交
10763
                {
N
Niels 已提交
10764
                    get_token();
10765 10766 10767 10768 10769
                    if (callback and not callback(--depth, parse_event_t::array_end, result))
                    {
                        result = basic_json(value_t::discarded);
                    }
                    return result;
N
Niels 已提交
10770 10771
                }

10772 10773 10774 10775 10776
                // no comma is expected here
                unexpect(lexer::token_type::value_separator);

                // otherwise: parse values
                do
N
Niels 已提交
10777
                {
10778 10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789
                    // 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 已提交
10790
                }
10791
                while (last_token == lexer::token_type::value_separator);
N
Niels 已提交
10792

10793 10794 10795 10796
                // 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 已提交
10797
                {
10798
                    result = basic_json(value_t::discarded);
N
Niels 已提交
10799
                }
10800 10801

                return result;
N
Niels 已提交
10802
            }
N
Niels 已提交
10803

10804
            case lexer::token_type::literal_null:
N
Niels 已提交
10805
            {
10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845
                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 已提交
10846
            }
N
Niels 已提交
10847 10848
        }

10849
        if (keep and callback and not callback(depth, parse_event_t::value, result))
N
Niels 已提交
10850
        {
10851
            result = basic_json(value_t::discarded);
N
Niels 已提交
10852
        }
10853 10854 10855 10856 10857 10858 10859 10860 10861
        return result;
    }

    /// get next token from lexer
    typename lexer::token_type get_token()
    {
        last_token = m_lexer.scan();
        return last_token;
    }
N
Niels 已提交
10862

10863 10864 10865
    void expect(typename lexer::token_type t) const
    {
        if (t != last_token)
N
Niels 已提交
10866
        {
10867 10868 10869 10870 10871
            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);
10872
                JSON_THROW(std::invalid_argument(error_msg));
N
Niels 已提交
10873
        }
10874
    }
N
Niels 已提交
10875

10876 10877 10878
    void unexpect(typename lexer::token_type t) const
    {
        if (t == last_token)
N
Niels 已提交
10879
        {
10880 10881 10882 10883
            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));
10884
                JSON_THROW(std::invalid_argument(error_msg));
N
Niels 已提交
10885
        }
10886
    }
N
Niels 已提交
10887

10888 10889 10890 10891 10892 10893 10894 10895 10896 10897
    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 已提交
10898 10899

  public:
N
Niels 已提交
10900 10901 10902
    /*!
    @brief JSON Pointer

N
Niels 已提交
10903 10904 10905 10906
    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 已提交
10907
    @sa [RFC 6901](https://tools.ietf.org/html/rfc6901)
N
Niels 已提交
10908 10909

    @since version 2.0.0
N
Niels 已提交
10910
    */
N
Niels 已提交
10911 10912
    class json_pointer
    {
N
Niels 已提交
10913 10914 10915
        /// allow basic_json to access private members
        friend class basic_json;

10916
        public:
N
Niels 已提交
10917 10918 10919 10920 10921 10922 10923 10924 10925 10926
        /*!
        @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 已提交
10927 10928 10929 10930 10931 10932
        @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 已提交
10933 10934 10935

        @liveexample{The example shows the construction several valid JSON
        pointers as well as the exceptional behavior.,json_pointer}
N
Niels 已提交
10936

N
Niels 已提交
10937 10938 10939
        @since version 2.0.0
        */
        explicit json_pointer(const std::string& s = "")
10940 10941
        : reference_tokens(split(s))
    {}
N
Niels 已提交
10942

10943 10944
    /*!
    @brief return a string representation of the JSON pointer
N
Niels 已提交
10945

10946 10947 10948 10949
    @invariant For each JSON pointer `ptr`, it holds:
    @code {.cpp}
    ptr == json_pointer(ptr.to_string());
    @endcode
N
Niels 已提交
10950

10951
    @return a string representation of the JSON pointer
N
Niels 已提交
10952

10953 10954
    @liveexample{The example shows the result of `to_string`.,
    json_pointer__to_string}
N
Niels 已提交
10955

10956 10957 10958 10959 10960 10961 10962
    @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 已提交
10963
        {
10964 10965 10966
            return a + "/" + escape(b);
        });
    }
N
Niels 已提交
10967

10968 10969 10970 10971 10972
    /// @copydoc to_string()
    operator std::string() const
    {
        return to_string();
    }
N
Niels 已提交
10973

10974 10975 10976 10977 10978
    private:
    /// remove and return last reference pointer
    std::string pop_back()
    {
        if (is_root())
N
Niels 已提交
10979
        {
10980
                JSON_THROW(std::domain_error("JSON pointer has no parent"));
N
Niels 已提交
10981 10982
        }

10983 10984 10985 10986 10987 10988 10989 10990 10991 10992
        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 已提交
10993

10994 10995 10996
    json_pointer top() const
    {
        if (is_root())
N
Niels 已提交
10997
        {
10998
                JSON_THROW(std::domain_error("JSON pointer has no parent"));
N
Niels 已提交
10999 11000
        }

11001 11002 11003 11004
        json_pointer result = *this;
        result.reference_tokens = {reference_tokens[0]};
        return result;
    }
N
Niels 已提交
11005

11006 11007
    /*!
    @brief create and return a reference to the pointed to value
N
Niels 已提交
11008

11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019
    @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 已提交
11020
            {
11021
                case value_t::null:
N
Niels 已提交
11022
                {
11023
                    if (reference_token == "0")
N
Niels 已提交
11024
                    {
11025 11026
                        // start a new array if reference token is 0
                        result = &result->operator[](0);
N
Niels 已提交
11027
                    }
11028
                    else
N
Niels 已提交
11029
                    {
11030
                        // start a new object otherwise
N
Niels 已提交
11031 11032
                        result = &result->operator[](reference_token);
                    }
11033 11034
                    break;
                }
N
Niels 已提交
11035

11036 11037 11038 11039 11040 11041
                case value_t::object:
                {
                    // create an entry in the object
                    result = &result->operator[](reference_token);
                    break;
                }
N
Niels 已提交
11042

11043 11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055 11056 11057 11058
                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:
                {
11059
                        JSON_THROW(std::domain_error("invalid value to unflatten"));
N
Niels 已提交
11060 11061
                }
            }
11062 11063
        }

11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074
        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.
N
Niels 已提交
11075

11076
    @param[in] ptr  a JSON value
N
Niels 已提交
11077

11078
    @return reference to the JSON value pointed to by the JSON pointer
N
Niels 已提交
11079

11080 11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099
    @complexity Linear in the length of the JSON pointer.

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

11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111
                // 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 已提交
11112

11113
            switch (ptr->m_type)
N
Niels 已提交
11114
            {
11115
                case value_t::object:
N
Niels 已提交
11116
                {
11117 11118 11119 11120 11121 11122 11123 11124 11125
                    // use unchecked object access
                    ptr = &ptr->operator[](reference_token);
                    break;
                }

                case value_t::array:
                {
                    // error condition (cf. RFC 6901, Sect. 4)
                    if (reference_token.size() > 1 and reference_token[0] == '0')
N
Niels 已提交
11126
                    {
11127 11128
                            JSON_THROW(std::domain_error("array index must not begin with '0'"));
                    }
N
Niels 已提交
11129

11130
                    if (reference_token == "-")
N
Niels 已提交
11131
                    {
11132 11133
                        // explicityly treat "-" as index beyond the end
                        ptr = &ptr->operator[](ptr->m_value.array->size());
N
Niels 已提交
11134 11135 11136
                    }
                    else
                    {
11137 11138
                        // convert array index to number; unchecked access
                        ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
N
Niels 已提交
11139
                    }
11140
                    break;
N
Niels 已提交
11141 11142
                }

11143
                default:
N
Niels 已提交
11144
                {
11145
                        JSON_THROW(std::out_of_range("unresolved reference token '" + reference_token + "'"));
N
Niels 已提交
11146 11147 11148
                }
            }
        }
N
Niels 已提交
11149

11150 11151 11152 11153 11154 11155
        return *ptr;
    }

    reference get_checked(pointer ptr) const
    {
        for (const auto& reference_token : reference_tokens)
N
Niels 已提交
11156
        {
11157
            switch (ptr->m_type)
N
Niels 已提交
11158
            {
11159
                case value_t::object:
N
Niels 已提交
11160
                {
11161 11162 11163 11164 11165 11166 11167 11168
                    // note: at performs range check
                    ptr = &ptr->at(reference_token);
                    break;
                }

                case value_t::array:
                {
                    if (reference_token == "-")
N
Niels 已提交
11169
                    {
11170 11171 11172 11173
                        // "-" 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 已提交
11174 11175
                    }

11176 11177
                    // error condition (cf. RFC 6901, Sect. 4)
                    if (reference_token.size() > 1 and reference_token[0] == '0')
N
Niels 已提交
11178
                    {
11179
                            JSON_THROW(std::domain_error("array index must not begin with '0'"));
N
Niels 已提交
11180 11181
                    }

11182 11183 11184 11185 11186 11187 11188
                    // note: at performs range check
                    ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
                    break;
                }

                default:
                {
11189
                        JSON_THROW(std::out_of_range("unresolved reference token '" + reference_token + "'"));
N
Niels 已提交
11190 11191 11192 11193
                }
            }
        }

11194 11195
        return *ptr;
    }
N
Niels 已提交
11196

11197 11198
    /*!
    @brief return a const reference to the pointed to value
N
Niels 已提交
11199

11200 11201 11202 11203 11204 11205 11206 11207
    @param[in] ptr  a JSON value

    @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 已提交
11208
        {
11209
            switch (ptr->m_type)
N
Niels 已提交
11210
            {
11211
                case value_t::object:
N
Niels 已提交
11212
                {
11213 11214 11215 11216 11217 11218 11219 11220
                    // use unchecked object access
                    ptr = &ptr->operator[](reference_token);
                    break;
                }

                case value_t::array:
                {
                    if (reference_token == "-")
N
Niels 已提交
11221
                    {
11222 11223 11224 11225
                        // "-" 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 已提交
11226 11227
                    }

11228 11229
                    // error condition (cf. RFC 6901, Sect. 4)
                    if (reference_token.size() > 1 and reference_token[0] == '0')
N
Niels 已提交
11230
                    {
11231
                            JSON_THROW(std::domain_error("array index must not begin with '0'"));
N
Niels 已提交
11232 11233
                    }

11234 11235 11236 11237 11238 11239 11240
                    // use unchecked array access
                    ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
                    break;
                }

                default:
                {
11241
                        JSON_THROW(std::out_of_range("unresolved reference token '" + reference_token + "'"));
N
Niels 已提交
11242 11243 11244 11245
                }
            }
        }

11246 11247 11248 11249 11250 11251
        return *ptr;
    }

    const_reference get_checked(const_pointer ptr) const
    {
        for (const auto& reference_token : reference_tokens)
11252
        {
11253
            switch (ptr->m_type)
11254
            {
11255
                case value_t::object:
11256
                {
11257 11258 11259 11260 11261 11262 11263 11264
                    // note: at performs range check
                    ptr = &ptr->at(reference_token);
                    break;
                }

                case value_t::array:
                {
                    if (reference_token == "-")
N
Niels 已提交
11265
                    {
11266 11267 11268 11269
                        // "-" 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 已提交
11270
                    }
11271

11272 11273
                    // error condition (cf. RFC 6901, Sect. 4)
                    if (reference_token.size() > 1 and reference_token[0] == '0')
N
Niels 已提交
11274
                    {
11275
                            JSON_THROW(std::domain_error("array index must not begin with '0'"));
N
Niels 已提交
11276
                    }
11277

11278 11279 11280 11281 11282 11283 11284
                    // note: at performs range check
                    ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
                    break;
                }

                default:
                {
11285
                        JSON_THROW(std::out_of_range("unresolved reference token '" + reference_token + "'"));
11286 11287
                }
            }
N
Niels 已提交
11288 11289
        }

11290 11291
        return *ptr;
    }
N
Niels 已提交
11292

11293 11294 11295 11296
    /// 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 已提交
11297

11298 11299 11300 11301 11302 11303 11304 11305 11306
        // 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] != '/')
        {
11307
                JSON_THROW(std::domain_error("JSON pointer must be empty or begin with '/'"));
11308
        }
N
Niels 已提交
11309

11310 11311 11312 11313 11314
        // 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 已提交
11315
                size_t slash = reference_string.find_first_of('/', 1),
11316 11317 11318 11319 11320 11321 11322 11323
            // 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 已提交
11324
                slash = reference_string.find_first_of('/', start))
11325 11326 11327 11328
        {
            // 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 已提交
11329

11330
            // check reference tokens are properly escaped
N
Niels Lohmann 已提交
11331
                for (size_t pos = reference_token.find_first_of('~');
11332
                    pos != std::string::npos;
N
Niels Lohmann 已提交
11333
                        pos = reference_token.find_first_of('~', pos + 1))
11334 11335
            {
                assert(reference_token[pos] == '~');
N
Niels 已提交
11336

11337 11338 11339 11340 11341
                // ~ 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'))
                {
11342
                        JSON_THROW(std::domain_error("escape error: '~' must be followed with '0' or '1'"));
N
Niels 已提交
11343
                }
11344
            }
N
Niels 已提交
11345

11346 11347 11348
            // finally, store the reference token
            unescape(reference_token);
            result.push_back(reference_token);
N
Niels 已提交
11349
        }
N
Niels 已提交
11350

11351 11352
        return result;
    }
N
Niels 已提交
11353

11354 11355 11356
    private:
    /*!
    @brief replace all occurrences of a substring by another string
N
Niels 已提交
11357

11358 11359 11360 11361
    @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 已提交
11362

11363
    @pre The search string @a f must not be empty.
N
Niels 已提交
11364

11365 11366 11367 11368 11369 11370 11371
    @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 已提交
11372

11373 11374 11375 11376 11377 11378 11379
        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 已提交
11380

11381 11382 11383 11384 11385 11386 11387 11388
    /// 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 已提交
11389

11390 11391 11392 11393 11394 11395 11396 11397
    /// 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 已提交
11398

11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410
    /*!
    @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 已提交
11411
        {
11412
            case value_t::array:
N
Niels 已提交
11413
            {
11414
                if (value.m_value.array->empty())
N
Niels 已提交
11415
                {
11416 11417 11418 11419 11420 11421 11422
                    // 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 已提交
11423
                    {
11424 11425
                        flatten(reference_string + "/" + std::to_string(i),
                                value.m_value.array->operator[](i), result);
N
Niels 已提交
11426 11427
                    }
                }
11428 11429
                break;
            }
N
Niels 已提交
11430

11431 11432 11433
            case value_t::object:
            {
                if (value.m_value.object->empty())
N
Niels 已提交
11434
                {
11435 11436 11437 11438 11439 11440 11441
                    // 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 已提交
11442
                    {
11443 11444
                        flatten(reference_string + "/" + escape(element.first),
                                element.second, result);
N
Niels 已提交
11445 11446
                    }
                }
11447 11448
                break;
            }
N
Niels 已提交
11449

11450 11451 11452 11453 11454
            default:
            {
                // add primitive value with its reference string
                result[reference_string] = value;
                break;
N
Niels 已提交
11455 11456
            }
        }
11457
    }
N
Niels 已提交
11458

11459 11460
    /*!
    @param[in] value  flattened JSON
N
Niels 已提交
11461

11462 11463 11464 11465 11466
    @return unflattened JSON
    */
    static basic_json unflatten(const basic_json& value)
    {
        if (not value.is_object())
N
Niels 已提交
11467
        {
11468
                JSON_THROW(std::domain_error("only objects can be unflattened"));
11469
        }
N
Niels 已提交
11470

11471
        basic_json result;
N
Niels 已提交
11472

11473 11474 11475 11476
        // iterate the JSON object values
        for (const auto& element : *value.m_value.object)
        {
            if (not element.second.is_primitive())
N
Niels 已提交
11477
            {
11478
                    JSON_THROW(std::domain_error("values in object must be primitive"));
N
Niels 已提交
11479 11480
            }

11481 11482 11483 11484 11485 11486
            // 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 已提交
11487
        }
N
Niels 已提交
11488

11489 11490 11491 11492 11493 11494 11495
        return result;
    }

    private:
    /// the reference tokens
    std::vector<std::string> reference_tokens {};
               };
N
Niels 已提交
11496

N
Niels 已提交
11497 11498 11499
    //////////////////////////
    // JSON Pointer support //
    //////////////////////////
N
Niels 已提交
11500 11501 11502 11503

    /// @name JSON Pointer functions
    /// @{

N
Niels 已提交
11504 11505 11506 11507
    /*!
    @brief access specified element via JSON Pointer

    Uses a JSON pointer to retrieve a reference to the respective JSON value.
N
Niels 已提交
11508 11509 11510
    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 已提交
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 11550 11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561 11562 11563 11564 11565 11566 11567 11568 11569 11570 11571 11572 11573 11574 11575 11576 11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596

    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 已提交
11597 11598
    Returns a const reference to the element at with specified JSON pointer @a
    ptr, with bounds checking.
N
Niels 已提交
11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618

    @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 已提交
11619
    /*!
N
Niels 已提交
11620 11621
    @brief return flattened JSON value

N
Niels 已提交
11622 11623 11624 11625
    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 已提交
11626

N
Niels 已提交
11627
    @return an object that maps JSON pointers to primitve values
N
Niels 已提交
11628

N
Niels 已提交
11629 11630
    @note Empty objects and arrays are flattened to `null` and will not be
          reconstructed correctly by the @ref unflatten() function.
N
Niels 已提交
11631 11632 11633 11634 11635 11636 11637 11638 11639

    @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 已提交
11640 11641 11642 11643 11644 11645 11646
    */
    basic_json flatten() const
    {
        basic_json result(value_t::object);
        json_pointer::flatten("", *this, result);
        return result;
    }
N
Niels 已提交
11647 11648

    /*!
N
Niels 已提交
11649 11650 11651 11652 11653 11654 11655 11656 11657 11658
    @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 已提交
11659
    @return the original JSON from a flattened version
N
Niels 已提交
11660 11661 11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672 11673

    @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 已提交
11674
    */
N
Niels 已提交
11675
    basic_json unflatten() const
N
Niels 已提交
11676
    {
N
Niels 已提交
11677
        return json_pointer::unflatten(*this);
N
Niels 已提交
11678
    }
N
Niels 已提交
11679 11680

    /// @}
11681

N
Niels 已提交
11682 11683 11684 11685 11686 11687 11688
    //////////////////////////
    // JSON Patch functions //
    //////////////////////////

    /// @name JSON Patch functions
    /// @{

11689 11690 11691
    /*!
    @brief applies a JSON patch

N
Niels 已提交
11692 11693 11694 11695 11696
    [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 已提交
11697
    @param[in] json_patch  JSON patch document
11698 11699
    @return patched document

N
Niels 已提交
11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711 11712 11713
    @note The application of a patch is atomic: Either all operations succeed
          and the patched document is returned or an exception is thrown. In
          any case, the original value is not changed: the patch is applied
          to a copy of the value.

    @throw std::out_of_range if a JSON pointer inside the patch could not
    be resolved successfully in the current JSON value; example: `"key baz
    not found"`
    @throw invalid_argument if the JSON patch is malformed (e.g., mandatory
    attributes are missing); example: `"operation add must have member path"`

    @complexity Linear in the size of the JSON value and the length of the
    JSON patch. As usually only a fraction of the JSON value is affected by
    the patch, the complexity can usually be neglected.
11714

N
Niels 已提交
11715 11716 11717 11718 11719 11720 11721 11722 11723
    @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
11724
    */
N
Niels 已提交
11725
    basic_json patch(const basic_json& json_patch) const
11726
    {
N
Niels 已提交
11727
        // make a working copy to apply the patch to
11728 11729
        basic_json result = *this;

N
Niels 已提交
11730 11731 11732 11733 11734 11735 11736 11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762
        // 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 已提交
11763
        // wrapper for "add" operation; add value at ptr
N
Niels 已提交
11764
        const auto operation_add = [&result](json_pointer & ptr, basic_json val)
N
Niels 已提交
11765
        {
N
Niels 已提交
11766 11767
            // adding to the root of the target document means replacing it
            if (ptr.is_root())
N
Niels 已提交
11768
            {
N
Niels 已提交
11769
                result = val;
N
Niels 已提交
11770
            }
N
Niels 已提交
11771
            else
N
Niels 已提交
11772
            {
N
Niels 已提交
11773 11774 11775
                // make sure the top element of the pointer exists
                json_pointer top_pointer = ptr.top();
                if (top_pointer != ptr)
N
Niels 已提交
11776
                {
N
Niels 已提交
11777
                    result.at(top_pointer);
N
Niels 已提交
11778
                }
N
Niels 已提交
11779 11780 11781 11782 11783 11784

                // 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 已提交
11785
                {
N
Niels 已提交
11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796 11797 11798 11799 11800 11801 11802 11803 11804 11805 11806
                    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
11807
                                JSON_THROW(std::out_of_range("array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819
                            }
                            else
                            {
                                // default case: insert add offset
                                parent.insert(parent.begin() + static_cast<difference_type>(idx), val);
                            }
                        }
                        break;
                    }

                    default:
                    {
N
Niels 已提交
11820 11821
                        // if there exists a parent it cannot be primitive
                        assert(false);  // LCOV_EXCL_LINE
N
Niels 已提交
11822
                    }
N
Niels 已提交
11823 11824 11825 11826
                }
            }
        };

N
Niels 已提交
11827
        // wrapper for "remove" operation; remove value at ptr
N
Niels 已提交
11828 11829
        const auto operation_remove = [&result](json_pointer & ptr)
        {
N
Niels 已提交
11830
            // get reference to parent of JSON pointer ptr
N
Niels 已提交
11831 11832
            const auto last_path = ptr.pop_back();
            basic_json& parent = result.at(ptr);
N
Niels 已提交
11833 11834

            // remove child
N
Niels 已提交
11835 11836
            if (parent.is_object())
            {
N
Niels 已提交
11837 11838 11839 11840 11841 11842 11843 11844
                // perform range check
                auto it = parent.find(last_path);
                if (it != parent.end())
                {
                    parent.erase(it);
                }
                else
                {
11845
                    JSON_THROW(std::out_of_range("key '" + last_path + "' not found"));
N
Niels 已提交
11846
                }
N
Niels 已提交
11847 11848 11849
            }
            else if (parent.is_array())
            {
N
Niels 已提交
11850 11851
                // note erase performs range check
                parent.erase(static_cast<size_type>(std::stoi(last_path)));
N
Niels 已提交
11852 11853 11854
            }
        };

N
Niels 已提交
11855
        // type check
N
Niels 已提交
11856
        if (not json_patch.is_array())
N
Niels 已提交
11857 11858
        {
            // a JSON patch must be an array of objects
11859
            JSON_THROW(std::invalid_argument("JSON patch must be an array of objects"));
N
Niels 已提交
11860 11861 11862
        }

        // iterate and apply th eoperations
N
Niels 已提交
11863
        for (const auto& val : json_patch)
11864
        {
N
Niels 已提交
11865 11866 11867
            // wrapper to get a value for an operation
            const auto get_value = [&val](const std::string & op,
                                          const std::string & member,
N
Niels 已提交
11868
                                          bool string_type) -> basic_json&
11869
            {
N
Niels 已提交
11870 11871
                // find value
                auto it = val.m_value.object->find(member);
11872

N
Niels 已提交
11873 11874
                // context-sensitive error message
                const auto error_msg = (op == "op") ? "operation" : "operation '" + op + "'";
11875

N
Niels 已提交
11876 11877 11878
                // check if desired value is present
                if (it == val.m_value.object->end())
                {
11879
                    JSON_THROW(std::invalid_argument(error_msg + " must have member '" + member + "'"));
N
Niels 已提交
11880
                }
11881

N
Niels 已提交
11882 11883 11884
                // check if result is of type string
                if (string_type and not it->second.is_string())
                {
11885
                    JSON_THROW(std::invalid_argument(error_msg + " must have string member '" + member + "'"));
N
Niels 已提交
11886 11887 11888 11889 11890 11891 11892 11893
                }

                // no error: return value
                return it->second;
            };

            // type check
            if (not val.is_object())
11894
            {
11895
                JSON_THROW(std::invalid_argument("JSON patch must be an array of objects"));
11896 11897
            }

N
Niels 已提交
11898 11899 11900
            // collect mandatory members
            const std::string op = get_value("op", "op", true);
            const std::string path = get_value(op, "path", true);
N
oops  
Niels 已提交
11901
            json_pointer ptr(path);
11902

N
Niels 已提交
11903
            switch (get_op(op))
11904
            {
N
Niels 已提交
11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953
                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;
11954
                    JSON_TRY
N
Niels 已提交
11955 11956 11957 11958 11959
                    {
                        // check if "value" matches the one at "path"
                        // the "path" location must exist - use at()
                        success = (result.at(ptr) == get_value("test", "value", false));
                    }
11960
                    JSON_CATCH (std::out_of_range&)
N
Niels 已提交
11961 11962 11963 11964 11965 11966 11967
                    {
                        // ignore out of range errors: success remains false
                    }

                    // throw an exception if test fails
                    if (not success)
                    {
11968
                        JSON_THROW(std::domain_error("unsuccessful: " + val.dump()));
N
Niels 已提交
11969 11970 11971 11972 11973 11974 11975 11976 11977
                    }

                    break;
                }

                case patch_operations::invalid:
                {
                    // op must be "add", "remove", "replace", "move", "copy", or
                    // "test"
11978
                    JSON_THROW(std::invalid_argument("operation value '" + op + "' is invalid"));
N
Niels 已提交
11979
                }
11980
            }
N
Niels 已提交
11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019
        }

        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,
12020
                           const std::string& path = "")
N
Niels 已提交
12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033 12034
    {
        // 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(
12035
            {
N
Niels 已提交
12036 12037 12038 12039 12040 12041 12042 12043
                {"op", "replace"},
                {"path", path},
                {"value", target}
            });
        }
        else
        {
            switch (source.type())
12044
            {
N
Niels 已提交
12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055
                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 已提交
12056

N
Niels 已提交
12057 12058
                    // i now reached the end of at least one array
                    // in a second pass, traverse the remaining elements
N
Niels 已提交
12059

N
Niels 已提交
12060
                    // remove my remaining elements
N
Niels 已提交
12061
                    const auto end_index = static_cast<difference_type>(result.size());
N
Niels 已提交
12062 12063
                    while (i < source.size())
                    {
N
Niels 已提交
12064 12065
                        // add operations in reverse order to avoid invalid
                        // indices
N
Niels 已提交
12066
                        result.insert(result.begin() + end_index, object(
N
Niels 已提交
12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083 12084 12085 12086 12087 12088 12089
                        {
                            {"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:
12090
                {
N
Niels 已提交
12091 12092 12093 12094 12095 12096 12097 12098 12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132 12133 12134 12135 12136 12137 12138 12139 12140 12141 12142
                    // 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;
12143 12144 12145 12146 12147 12148
                }
            }
        }

        return result;
    }
N
Niels 已提交
12149 12150

    /// @}
N
Niels 已提交
12151 12152
};

12153 12154 12155 12156 12157 12158 12159 12160 12161 12162 12163 12164 12165 12166 12167 12168 12169 12170 12171 12172 12173 12174 12175 12176 12177 12178 12179 12180 12181 12182 12183 12184 12185 12186 12187 12188 12189
//////////////////////////////////////////
// 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
Niels 已提交
12190 12191 12192 12193 12194

/////////////
// presets //
/////////////

N
Niels 已提交
12195 12196 12197
/*!
@brief default JSON class

N
Niels 已提交
12198 12199
This type is the default specialization of the @ref basic_json class which
uses the standard template types.
N
Niels 已提交
12200

N
Niels 已提交
12201
@since version 1.0.0
N
Niels 已提交
12202
*/
N
Niels 已提交
12203
using json = basic_json<>;
N
Niels Lohmann 已提交
12204
} // namespace nlohmann
N
Niels 已提交
12205 12206


N
Niels 已提交
12207 12208 12209
///////////////////////
// nonmember support //
///////////////////////
N
Niels 已提交
12210 12211 12212 12213

// specialization of std::swap, and std::hash
namespace std
{
N
Niels 已提交
12214
    /*!
12215
    @brief exchanges the values of two JSON objects
N
Niels 已提交
12216

N
Niels 已提交
12217
    @since version 1.0.0
N
Niels 已提交
12218
    */
12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235 12236 12237 12238
    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
Niels 已提交
12239 12240
    {
        // a naive hashing via the string representation
N
Niels 已提交
12241 12242
        const auto& h = hash<nlohmann::json::string_t>();
        return h(j.dump());
N
Niels 已提交
12243
    }
12244
                        };
N
Niels Lohmann 已提交
12245
} // namespace std
N
Niels 已提交
12246 12247

/*!
N
Niels 已提交
12248 12249
@brief user-defined string literal for JSON values

N
Niels 已提交
12250
This operator implements a user-defined string literal for JSON objects. It
N
Niels 已提交
12251
can be used by adding `"_json"` to a string literal and returns a JSON object
N
Niels 已提交
12252
if no parse error occurred.
N
Niels 已提交
12253

N
Niels 已提交
12254
@param[in] s  a string representation of a JSON object
12255
@param[in] n  the length of string @a s
N
Niels 已提交
12256
@return a JSON object
N
Niels 已提交
12257

N
Niels 已提交
12258
@since version 1.0.0
N
Niels 已提交
12259
*/
12260
inline nlohmann::json operator "" _json(const char* s, std::size_t n)
N
Niels 已提交
12261
{
12262
    return nlohmann::json::parse(s, s + n);
N
Niels 已提交
12263 12264
}

N
Niels 已提交
12265 12266 12267
/*!
@brief user-defined string literal for JSON pointer

N
Niels 已提交
12268
This operator implements a user-defined string literal for JSON Pointers. It
N
Niels 已提交
12269
can be used by adding `"_json_pointer"` to a string literal and returns a JSON pointer
N
Niels 已提交
12270 12271 12272
object if no parse error occurred.

@param[in] s  a string representation of a JSON Pointer
12273
@param[in] n  the length of string @a s
N
Niels 已提交
12274 12275
@return a JSON pointer object

N
Niels 已提交
12276 12277
@since version 2.0.0
*/
12278
inline nlohmann::json::json_pointer operator "" _json_pointer(const char* s, std::size_t n)
N
Niels 已提交
12279
{
12280
    return nlohmann::json::json_pointer(std::string(s, n));
N
Niels 已提交
12281 12282
}

12283 12284 12285 12286 12287
// restore GCC/clang diagnostic settings
#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
    #pragma GCC diagnostic pop
#endif

12288 12289 12290 12291 12292 12293
// clean up
#undef JSON_THROW
#undef JSON_TRY
#undef JSON_CATCH
#undef JSON_DEPRECATED

N
Niels 已提交
12294
#endif