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

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

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

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

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

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

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

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
92
#if (defined(__cpp_exceptions) || defined(__EXCEPTIONS) || defined(_CPPUNWIND)) && not defined(JSON_NOEXCEPTION)
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 Lohmann 已提交
102
// manual branch prediction
103 104 105 106 107 108 109
#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
    #define JSON_LIKELY(x)      __builtin_expect(!!(x), 1)
    #define JSON_UNLIKELY(x)    __builtin_expect(!!(x), 0)
#else
    #define JSON_LIKELY(x)      x
    #define JSON_UNLIKELY(x)    x
#endif
N
Niels Lohmann 已提交
110

N
Niels 已提交
111
/*!
N
Niels 已提交
112
@brief namespace for Niels Lohmann
N
Niels 已提交
113
@see https://github.com/nlohmann
N
Niels 已提交
114
@since version 1.0.0
N
Niels 已提交
115 116 117
*/
namespace nlohmann
{
118

119 120
/*!
@brief unnamed namespace with internal helper functions
121

122 123 124 125 126
This namespace collects some functions that could not be defined inside the
@ref basic_json class.

@since version 2.1.0
*/
127 128
namespace detail
{
129 130 131 132 133 134 135 136 137
////////////////
// exceptions //
////////////////

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

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

N
Niels Lohmann 已提交
138
@note To have nothrow-copy-constructible exceptions, we internally use
139 140 141 142
      std::runtime_error which can cope with arbitrary-length error messages.
      Intermediate strings are built with static functions and then passed to
      the actual constructor.

143 144 145 146 147 148
@since version 3.0.0
*/
class exception : public std::exception
{
  public:
    /// returns the explanatory string
149
    virtual const char* what() const noexcept override
150
    {
N
Niels Lohmann 已提交
151
        return m.what();
152 153 154 155 156
    }

    /// the id of the exception
    const int id;

157
  protected:
158
    exception(int id_, const char* what_arg)
N
Niels Lohmann 已提交
159
        : id(id_), m(what_arg)
160 161
    {}

N
Niels Lohmann 已提交
162
    static std::string name(const std::string& ename, int id)
163
    {
N
Niels Lohmann 已提交
164
        return "[json.exception." + ename + "." + std::to_string(id) + "] ";
165
    }
N
Niels Lohmann 已提交
166

167
  private:
N
Niels Lohmann 已提交
168
    /// an exception object as storage for error messages
N
Niels Lohmann 已提交
169
    std::runtime_error m;
170 171 172 173 174 175 176 177 178 179 180 181 182 183
};

/*!
@brief exception indicating a parse error

This excpetion is thrown by the library when a parse error occurs. Parse
errors can occur during the deserialization of JSON text as well as when
using JSON Patch.

Member @a byte holds the byte index of the last read character in the input
file.

@note For an input with n bytes, 1 is the index of the first character
      and n+1 is the index of the terminating null byte or the end of
184 185
      file. This also holds true when reading a byte vector (CBOR or
      MessagePack).
186 187 188 189 190

Exceptions have ids 1xx.

name / id                      | example massage | description
------------------------------ | --------------- | -------------------------
191 192 193 194 195 196 197 198 199 200 201 202
json.exception.parse_error.101 | parse error at 2: unexpected end of input; expected string literal | This error indicates a syntax error while deserializing a JSON text. The error message describes that an unexpected token (character) was encountered, and the member @a byte indicates the error position.
json.exception.parse_error.102 | parse error at 14: missing or wrong low surrogate | JSON uses the `\uxxxx` format to describe Unicode characters. Code points above above 0xFFFF are split into two `\uxxxx` entries ("surrogate pairs"). This error indicates that the surrogate pair is incomplete or contains an invalid code point.
json.exception.parse_error.103 | parse error: code points above 0x10FFFF are invalid | Unicode supports code points up to 0x10FFFF. Code points above 0x10FFFF are invalid.
json.exception.parse_error.104 | parse error: JSON patch must be an array of objects | [RFC 6902](https://tools.ietf.org/html/rfc6902) requires a JSON Patch document to be a JSON document that represents an array of objects.
json.exception.parse_error.105 | parse error: operation must have string member 'op' | An operation of a JSON Patch document must contain exactly one "op" member, whose value indicates the operation to perform. Its value must be one of "add", "remove", "replace", "move", "copy", or "test"; other values are errors.
json.exception.parse_error.106 | parse error: array index '01' must not begin with '0' | An array index in a JSON Pointer ([RFC 6901](https://tools.ietf.org/html/rfc6901)) may be `0` or any number wihtout a leading `0`.
json.exception.parse_error.107 | parse error: JSON pointer must be empty or begin with '/' - was: 'foo' | A JSON Pointer must be a Unicode string containing a sequence of zero or more reference tokens, each prefixed by a `/` character.
json.exception.parse_error.108 | parse error: escape character '~' must be followed with '0' or '1' | In a JSON Pointer, only `~0` and `~1` are valid escape sequences.
json.exception.parse_error.109 | parse error: array index 'one' is not a number | A JSON Pointer array index must be a number.
json.exception.parse_error.110 | parse error at 1: cannot read 2 bytes from vector | When parsing CBOR or MessagePack, the byte vector ends before the complete value has been read.
json.exception.parse_error.111 | parse error: bad input stream | Parsing CBOR or MessagePack from an input stream where the [`badbit` or `failbit`](http://en.cppreference.com/w/cpp/io/ios_base/iostate) is set.
json.exception.parse_error.112 | parse error at 1: error reading CBOR; last byte: 0xf8 | Not all types of CBOR or MessagePack are supported. This exception occurs if an unsupported byte was read.
203
json.exception.parse_error.113 | parse error at 2: expected a CBOR string; last byte: 0x98 | While parsing a map key, a value that is not a string has been read.
204 205 206 207 208 209 210 211

@since version 3.0.0
*/
class parse_error : public exception
{
  public:
    /*!
    @brief create a parse error exception
N
Niels Lohmann 已提交
212
    @param[in] id         the id of the exception
213 214
    @param[in] byte_      the byte index where the error occured (or 0 if
                          the position cannot be determined)
215 216
    @param[in] what_arg   the explanatory string
    @return parse_error object
217
    */
N
Niels Lohmann 已提交
218
    static parse_error create(int id, size_t byte_, const std::string& what_arg)
219
    {
N
Niels Lohmann 已提交
220
        std::string w = exception::name("parse_error", id) + "parse error" +
221 222
                        (byte_ != 0 ? (" at " + std::to_string(byte_)) : "") +
                        ": " + what_arg;
N
Niels Lohmann 已提交
223
        return parse_error(id, byte_, w.c_str());
224
    }
225 226 227 228 229 230 231 232

    /*!
    @brief byte index of the parse error

    The byte index of the last read character in the input file.

    @note For an input with n bytes, 1 is the index of the first character
          and n+1 is the index of the terminating null byte or the end of
233 234
          file. This also holds true when reading a byte vector (CBOR or
          MessagePack).
235 236
    */
    const size_t byte;
237 238

  private:
N
Niels Lohmann 已提交
239 240
    parse_error(int id_, size_t byte_, const char* what_arg)
        : exception(id_, what_arg), byte(byte_)
241
    {}
242 243 244 245 246 247 248
};

/*!
@brief exception indicating errors with iterators

Exceptions have ids 2xx.

249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
name / id                           | example massage | description
----------------------------------- | --------------- | -------------------------
json.exception.invalid_iterator.201 | iterators are not compatible | The iterators passed to constructor @ref basic_json(InputIT first, InputIT last) are not compatible, meaning they do not belong to the same container. Therefore, the range (@a first, @a last) is invalid.
json.exception.invalid_iterator.202 | iterator does not fit current value | In an erase or insert function, the passed iterator @a pos does not belong to the JSON value for which the function was called. It hence does not define a valid position for the deletion/insertion.
json.exception.invalid_iterator.203 | iterators do not fit current value | Either iterator passed to function @ref erase(IteratorType first, IteratorType last) does not belong to the JSON value from which values shall be erased. It hence does not define a valid range to delete values from.
json.exception.invalid_iterator.204 | iterators out of range | When an iterator range for a primitive type (number, boolean, or string) is passed to a constructor or an erase function, this range has to be exactly (@ref begin(), @ref end()), because this is the only way the single stored value is expressed. All other ranges are invalid.
json.exception.invalid_iterator.205 | iterator out of range | When an iterator for a primitive type (number, boolean, or string) is passed to an erase function, the iterator has to be the @ref begin() iterator, because it is the only way to address the stored value. All other iterators are invalid.
json.exception.invalid_iterator.206 | cannot construct with iterators from null | The iterators passed to constructor @ref basic_json(InputIT first, InputIT last) belong to a JSON null value and hence to not define a valid range.
json.exception.invalid_iterator.207 | cannot use key() for non-object iterators | The key() member function can only be used on iterators belonging to a JSON object, because other types do not have a concept of a key.
json.exception.invalid_iterator.208 | cannot use operator[] for object iterators | The operator[] to specify a concrete offset cannot be used on iterators belonging to a JSON object, because JSON objects are unordered.
json.exception.invalid_iterator.209 | cannot use offsets with object iterators | The offset operators (+, -, +=, -=) cannot be used on iterators belonging to a JSON object, because JSON objects are unordered.
json.exception.invalid_iterator.210 | iterators do not fit | The iterator range passed to the insert function are not compatible, meaning they do not belong to the same container. Therefore, the range (@a first, @a last) is invalid.
json.exception.invalid_iterator.211 | passed iterators may not belong to container | The iterator range passed to the insert function must not be a subrange of the container to insert to.
json.exception.invalid_iterator.212 | cannot compare iterators of different containers | When two iterators are compared, they must belong to the same container.
json.exception.invalid_iterator.213 | cannot compare order of object iterators | The order of object iterators cannot be compated, because JSON objects are unordered.
json.exception.invalid_iterator.214 | cannot get value | Cannot get value for iterator: Either the iterator belongs to a null value or it is an iterator to a primitive type (number, boolean, or string), but the iterator is different to @ref begin().
265 266 267 268 269 270

@since version 3.0.0
*/
class invalid_iterator : public exception
{
  public:
N
Niels Lohmann 已提交
271
    static invalid_iterator create(int id, const std::string& what_arg)
272
    {
N
Niels Lohmann 已提交
273 274
        std::string w = exception::name("invalid_iterator", id) + what_arg;
        return invalid_iterator(id, w.c_str());
275 276 277
    }

  private:
N
Niels Lohmann 已提交
278 279
    invalid_iterator(int id_, const char* what_arg)
        : exception(id_, what_arg)
280 281 282 283 284 285 286 287
    {}
};

/*!
@brief exception indicating executing a member function with a wrong type

Exceptions have ids 3xx.

288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
name / id                     | example massage | description
----------------------------- | --------------- | -------------------------
json.exception.type_error.301 | cannot create object from initializer list | To create an object from an initializer list, the initializer list must consist only of a list of pairs whose first element is a string. When this constraint is violated, an array is created instead.
json.exception.type_error.302 | type must be object, but is array | During implicit or explicit value conversion, the JSON type must be compatible to the target type. For instance, a JSON string can only be converted into string types, but not into numbers or boolean types.
json.exception.type_error.303 | incompatible ReferenceType for get_ref, actual type is object | To retrieve a reference to a value stored in a @ref basic_json object with @ref get_ref, the type of the reference must match the value type. For instance, for a JSON array, the @a ReferenceType must be @ref array_t&.
json.exception.type_error.304 | cannot use at() with string | The @ref at() member functions can only be executed for certain JSON types.
json.exception.type_error.305 | cannot use operator[] with string | The @ref operator[] member functions can only be executed for certain JSON types.
json.exception.type_error.306 | cannot use value() with string | The @ref value() member functions can only be executed for certain JSON types.
json.exception.type_error.307 | cannot use erase() with string | The @ref erase() member functions can only be executed for certain JSON types.
json.exception.type_error.308 | cannot use push_back() with string | The @ref push_back() and @ref operator+= member functions can only be executed for certain JSON types.
json.exception.type_error.309 | cannot use insert() with | The @ref insert() member functions can only be executed for certain JSON types.
json.exception.type_error.310 | cannot use swap() with number | The @ref swap() member functions can only be executed for certain JSON types.
json.exception.type_error.311 | cannot use emplace_back() with string | The @ref emplace_back() member function can only be executed for certain JSON types.
json.exception.type_error.313 | invalid value to unflatten | The @ref unflatten function converts an object whose keys are JSON Pointers back into an arbitrary nested JSON value. The JSON Pointers must not overlap, because then the resulting value would not be well defined.
json.exception.type_error.314 | only objects can be unflattened | The @ref unflatten function only works for an object whose keys are JSON Pointers.
json.exception.type_error.315 | values in object must be primitive | The @ref unflatten function only works for an object whose keys are JSON Pointers and whose values are primitive.
304 305 306 307 308 309

@since version 3.0.0
*/
class type_error : public exception
{
  public:
N
Niels Lohmann 已提交
310
    static type_error create(int id, const std::string& what_arg)
311
    {
N
Niels Lohmann 已提交
312 313
        std::string w = exception::name("type_error", id) + what_arg;
        return type_error(id, w.c_str());
314 315 316
    }

  private:
N
Niels Lohmann 已提交
317 318
    type_error(int id_, const char* what_arg)
        : exception(id_, what_arg)
319 320 321 322 323 324 325 326
    {}
};

/*!
@brief exception indicating access out of the defined range

Exceptions have ids 4xx.

327 328 329 330 331 332 333
name / id                       | example massage | description
------------------------------- | --------------- | -------------------------
json.exception.out_of_range.401 | array index 3 is out of range | The provided array index @a i is larger than @a size-1.
json.exception.out_of_range.402 | array index '-' (3) is out of range | The special array index `-` in a JSON Pointer never describes a valid element of the array, but the index past the end. That is, it can only be used to add elements at this position, but not to read it.
json.exception.out_of_range.403 | key 'foo' not found | The provided key was not found in the JSON object.
json.exception.out_of_range.404 | unresolved reference token 'foo' | A reference token in a JSON Pointer could not be resolved.
json.exception.out_of_range.405 | JSON pointer has no parent | The JSON Patch operations 'remove' and 'add' can not be applied to the root element of the JSON value.
334
json.exception.out_of_range.406 | number overflow parsing '10E1000' | A parsed number could not be stored as without changing it to NaN or INF.
335 336 337 338 339 340

@since version 3.0.0
*/
class out_of_range : public exception
{
  public:
N
Niels Lohmann 已提交
341
    static out_of_range create(int id, const std::string& what_arg)
342
    {
N
Niels Lohmann 已提交
343 344
        std::string w = exception::name("out_of_range", id) + what_arg;
        return out_of_range(id, w.c_str());
345 346 347
    }

  private:
N
Niels Lohmann 已提交
348 349
    out_of_range(int id_, const char* what_arg)
        : exception(id_, what_arg)
350 351 352
    {}
};

353 354 355 356 357 358 359
/*!
@brief exception indicating other errors

Exceptions have ids 5xx.

name / id                      | example massage | description
------------------------------ | --------------- | -------------------------
360
json.exception.other_error.501 | unsuccessful: {"op":"test","path":"/baz", "value":"bar"} | A JSON Patch operation 'test' failed. The unsuccessful operation is also printed.
361 362 363 364 365 366

@since version 3.0.0
*/
class other_error : public exception
{
  public:
N
Niels Lohmann 已提交
367
    static other_error create(int id, const std::string& what_arg)
368
    {
N
Niels Lohmann 已提交
369 370
        std::string w = exception::name("other_error", id) + what_arg;
        return other_error(id, w.c_str());
371 372 373
    }

  private:
N
Niels Lohmann 已提交
374 375
    other_error(int id_, const char* what_arg)
        : exception(id_, what_arg)
376 377 378 379
    {}
};


380

381 382 383 384 385 386 387
///////////////////////////
// JSON type enumeration //
///////////////////////////

/*!
@brief the JSON type enumeration

388 389 390 391 392 393 394
This enumeration collects the different JSON types. It is internally used to
distinguish the stored values, and the functions @ref basic_json::is_null(),
@ref basic_json::is_object(), @ref basic_json::is_array(),
@ref basic_json::is_string(), @ref basic_json::is_boolean(),
@ref basic_json::is_number() (with @ref basic_json::is_number_integer(),
@ref basic_json::is_number_unsigned(), and @ref basic_json::is_number_float()),
@ref basic_json::is_discarded(), @ref basic_json::is_primitive(), and
T
Théo DELRIEU 已提交
395
@ref basic_json::is_structured() rely on it.
396

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

404 405
@sa @ref basic_json::basic_json(const value_t value_type) -- create a JSON
value with the default value for a given type
406 407 408 409 410

@since version 1.0.0
*/
enum class value_t : uint8_t
{
T
Théo DELRIEU 已提交
411 412 413 414 415 416 417 418 419
    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
420 421
};

422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
/*!
@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)];
}

455 456 457 458 459

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

460
// alias templates to reduce boilerplate
461
template<bool B, typename T = void>
462 463
using enable_if_t = typename std::enable_if<B, T>::type;

464
template<typename T>
T
Théo DELRIEU 已提交
465
using uncvref_t = typename std::remove_cv<typename std::remove_reference<T>::type>::type;
466

467
/*
N
Niels Lohmann 已提交
468
Implementation of two C++17 constructs: conjunction, negation. This is needed
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
to avoid evaluating all the traits in a condition

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

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

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

487
// dispatch utility (taken from ranges-v3)
488 489
template<unsigned N> struct priority_tag : priority_tag < N - 1 > {};
template<> struct priority_tag<0> {};
490

491 492 493 494

//////////////////
// constructors //
//////////////////
495

496
template<value_t> struct external_constructor;
497

498
template<>
499 500
struct external_constructor<value_t::boolean>
{
501
    template<typename BasicJsonType>
502
    static void construct(BasicJsonType& j, typename BasicJsonType::boolean_t b) noexcept
T
Théo DELRIEU 已提交
503 504 505 506 507
    {
        j.m_type = value_t::boolean;
        j.m_value = b;
        j.assert_invariant();
    }
508
};
509

510
template<>
511 512
struct external_constructor<value_t::string>
{
513
    template<typename BasicJsonType>
514
    static void construct(BasicJsonType& j, const typename BasicJsonType::string_t& s)
T
Théo DELRIEU 已提交
515 516 517 518 519
    {
        j.m_type = value_t::string;
        j.m_value = s;
        j.assert_invariant();
    }
520
};
521

522
template<>
523 524
struct external_constructor<value_t::number_float>
{
525
    template<typename BasicJsonType>
526
    static void construct(BasicJsonType& j, typename BasicJsonType::number_float_t val) noexcept
527
    {
528 529
        j.m_type = value_t::number_float;
        j.m_value = val;
T
Théo DELRIEU 已提交
530
        j.assert_invariant();
531 532 533
    }
};

534
template<>
535 536
struct external_constructor<value_t::number_unsigned>
{
537
    template<typename BasicJsonType>
538
    static void construct(BasicJsonType& j, typename BasicJsonType::number_unsigned_t val) noexcept
T
Théo DELRIEU 已提交
539 540 541 542 543
    {
        j.m_type = value_t::number_unsigned;
        j.m_value = val;
        j.assert_invariant();
    }
544 545
};

546
template<>
547 548
struct external_constructor<value_t::number_integer>
{
549
    template<typename BasicJsonType>
550
    static void construct(BasicJsonType& j, typename BasicJsonType::number_integer_t val) noexcept
T
Théo DELRIEU 已提交
551 552 553 554 555
    {
        j.m_type = value_t::number_integer;
        j.m_value = val;
        j.assert_invariant();
    }
556 557
};

558
template<>
559 560
struct external_constructor<value_t::array>
{
561
    template<typename BasicJsonType>
562
    static void construct(BasicJsonType& j, const typename BasicJsonType::array_t& arr)
T
Théo DELRIEU 已提交
563 564 565 566 567 568
    {
        j.m_type = value_t::array;
        j.m_value = arr;
        j.assert_invariant();
    }

569 570 571 572
    template<typename BasicJsonType, typename CompatibleArrayType,
             enable_if_t<not std::is_same<CompatibleArrayType,
                                          typename BasicJsonType::array_t>::value,
                         int> = 0>
573
    static void construct(BasicJsonType& j, const CompatibleArrayType& arr)
T
Théo DELRIEU 已提交
574 575 576 577
    {
        using std::begin;
        using std::end;
        j.m_type = value_t::array;
578
        j.m_value.array = j.template create<typename BasicJsonType::array_t>(begin(arr), end(arr));
T
Théo DELRIEU 已提交
579 580
        j.assert_invariant();
    }
581 582 583 584 585 586 587 588 589 590 591 592 593

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

596
template<>
597 598
struct external_constructor<value_t::object>
{
599
    template<typename BasicJsonType>
600
    static void construct(BasicJsonType& j, const typename BasicJsonType::object_t& obj)
T
Théo DELRIEU 已提交
601 602 603 604 605 606
    {
        j.m_type = value_t::object;
        j.m_value = obj;
        j.assert_invariant();
    }

607 608 609 610
    template<typename BasicJsonType, typename CompatibleObjectType,
             enable_if_t<not std::is_same<CompatibleObjectType,
                                          typename BasicJsonType::object_t>::value,
                         int> = 0>
611
    static void construct(BasicJsonType& j, const CompatibleObjectType& obj)
T
Théo DELRIEU 已提交
612 613 614
    {
        using std::begin;
        using std::end;
615

T
Théo DELRIEU 已提交
616
        j.m_type = value_t::object;
617
        j.m_value.object = j.template create<typename BasicJsonType::object_t>(begin(obj), end(obj));
T
Théo DELRIEU 已提交
618 619
        j.assert_invariant();
    }
620 621
};

622 623 624 625 626

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

627 628
/*!
@brief Helper to determine whether there's a key_type for T.
N
Niels Lohmann 已提交
629 630

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

634
@sa http://stackoverflow.com/a/7728728/266378
N
Niels 已提交
635
@since version 1.0.0, overworked in version 2.0.6
636
*/
N
Niels Lohmann 已提交
637
#define NLOHMANN_JSON_HAS_HELPER(type)                                        \
638
    template<typename T> struct has_##type {                                  \
N
Niels Lohmann 已提交
639
    private:                                                                  \
640
        template<typename U, typename = typename U::type>                     \
N
Niels Lohmann 已提交
641 642 643 644 645
        static int detect(U &&);                                              \
        static void detect(...);                                              \
    public:                                                                   \
        static constexpr bool value =                                         \
                std::is_integral<decltype(detect(std::declval<T>()))>::value; \
T
Théo DELRIEU 已提交
646
    }
T
Théo Delrieu 已提交
647

N
Niels Lohmann 已提交
648 649 650 651
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 已提交
652 653

#undef NLOHMANN_JSON_HAS_HELPER
654

N
Niels Lohmann 已提交
655

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

659
template<class RealType, class CompatibleObjectType>
T
Théo DELRIEU 已提交
660 661
struct is_compatible_object_type_impl<true, RealType, CompatibleObjectType>
{
662 663 664 665 666
    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 已提交
667 668
};

669
template<class BasicJsonType, class CompatibleObjectType>
T
Théo DELRIEU 已提交
670 671
struct is_compatible_object_type
{
T
Théo DELRIEU 已提交
672 673 674 675
    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,
676
                                  typename BasicJsonType::object_t, CompatibleObjectType >::value;
T
Théo DELRIEU 已提交
677 678
};

679
template<typename BasicJsonType, typename T>
680
struct is_basic_json_nested_type
T
Théo DELRIEU 已提交
681
{
682 683 684 685 686
    static auto constexpr value = std::is_same<T, typename BasicJsonType::iterator>::value or
                                  std::is_same<T, typename BasicJsonType::const_iterator>::value or
                                  std::is_same<T, typename BasicJsonType::reverse_iterator>::value or
                                  std::is_same<T, typename BasicJsonType::const_reverse_iterator>::value or
                                  std::is_same<T, typename BasicJsonType::json_pointer>::value;
T
Théo DELRIEU 已提交
687 688
};

689
template<class BasicJsonType, class CompatibleArrayType>
T
Théo DELRIEU 已提交
690 691
struct is_compatible_array_type
{
T
Théo DELRIEU 已提交
692
    static auto constexpr value =
693
        conjunction<negation<std::is_same<void, CompatibleArrayType>>,
T
Théo DELRIEU 已提交
694
        negation<is_compatible_object_type<
695 696
        BasicJsonType, CompatibleArrayType>>,
        negation<std::is_constructible<typename BasicJsonType::string_t,
T
Théo DELRIEU 已提交
697
        CompatibleArrayType>>,
698
        negation<is_basic_json_nested_type<BasicJsonType, CompatibleArrayType>>,
T
Théo DELRIEU 已提交
699 700
        has_value_type<CompatibleArrayType>,
        has_iterator<CompatibleArrayType>>::value;
T
Théo DELRIEU 已提交
701 702
};

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

706
template<typename RealIntegerType, typename CompatibleNumberIntegerType>
707
struct is_compatible_integer_type_impl<true, RealIntegerType, CompatibleNumberIntegerType>
T
Théo DELRIEU 已提交
708
{
T
Théo DELRIEU 已提交
709
    // is there an assert somewhere on overflows?
710 711 712 713 714 715 716 717
    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 已提交
718 719
};

720
template<typename RealIntegerType, typename CompatibleNumberIntegerType>
721 722
struct is_compatible_integer_type
{
723 724 725 726 727
    static constexpr auto value =
        is_compatible_integer_type_impl <
        std::is_integral<CompatibleNumberIntegerType>::value and
        not std::is_same<bool, CompatibleNumberIntegerType>::value,
        RealIntegerType, CompatibleNumberIntegerType > ::value;
728 729
};

730

N
Niels Lohmann 已提交
731
// trait checking if JSONSerializer<T>::from_json(json const&, udt&) exists
732
template<typename BasicJsonType, typename T>
733 734
struct has_from_json
{
735 736
  private:
    // also check the return type of from_json
737 738
    template<typename U, typename = enable_if_t<std::is_same<void, decltype(uncvref_t<U>::from_json(
                 std::declval<BasicJsonType>(), std::declval<T&>()))>::value>>
739 740
    static int detect(U&&);
    static void detect(...);
741

742 743
  public:
    static constexpr bool value = std::is_integral<decltype(
744
                                      detect(std::declval<typename BasicJsonType::template json_serializer<T, void>>()))>::value;
745 746 747 748
};

// This trait checks if JSONSerializer<T>::from_json(json const&) exists
// this overload is used for non-default-constructible user-defined-types
749
template<typename BasicJsonType, typename T>
750 751
struct has_non_default_from_json
{
T
Théo DELRIEU 已提交
752 753 754 755
  private:
    template <
        typename U,
        typename = enable_if_t<std::is_same<
756
                                   T, decltype(uncvref_t<U>::from_json(std::declval<BasicJsonType>()))>::value >>
T
Théo DELRIEU 已提交
757 758 759 760 761
    static int detect(U&&);
    static void detect(...);

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

765
// This trait checks if BasicJsonType::json_serializer<T>::to_json exists
766
template<typename BasicJsonType, typename T>
767 768
struct has_to_json
{
T
Théo DELRIEU 已提交
769
  private:
770 771
    template<typename U, typename = decltype(uncvref_t<U>::to_json(
                 std::declval<BasicJsonType&>(), std::declval<T>()))>
T
Théo DELRIEU 已提交
772 773 774 775 776
    static int detect(U&&);
    static void detect(...);

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

780

781 782 783
/////////////
// to_json //
/////////////
784

N
Niels Lohmann 已提交
785
template<typename BasicJsonType, typename T, enable_if_t<
786
             std::is_same<T, typename BasicJsonType::boolean_t>::value, int> = 0>
N
Niels Lohmann 已提交
787
void to_json(BasicJsonType& j, T b) noexcept
788
{
T
Théo DELRIEU 已提交
789
    external_constructor<value_t::boolean>::construct(j, b);
790 791
}

792 793
template<typename BasicJsonType, typename CompatibleString,
         enable_if_t<std::is_constructible<typename BasicJsonType::string_t,
N
Niels Lohmann 已提交
794
                     CompatibleString>::value, int> = 0>
795
void to_json(BasicJsonType& j, const CompatibleString& s)
796
{
T
Théo DELRIEU 已提交
797
    external_constructor<value_t::string>::construct(j, s);
798 799
}

800 801
template<typename BasicJsonType, typename FloatType,
         enable_if_t<std::is_floating_point<FloatType>::value, int> = 0>
802
void to_json(BasicJsonType& j, FloatType val) noexcept
803
{
804
    external_constructor<value_t::number_float>::construct(j, static_cast<typename BasicJsonType::number_float_t>(val));
805 806
}

807
template <
808 809
    typename BasicJsonType, typename CompatibleNumberUnsignedType,
    enable_if_t<is_compatible_integer_type<typename BasicJsonType::number_unsigned_t,
N
Niels Lohmann 已提交
810
                CompatibleNumberUnsignedType>::value, int> = 0 >
811
void to_json(BasicJsonType& j, CompatibleNumberUnsignedType val) noexcept
812
{
813
    external_constructor<value_t::number_unsigned>::construct(j, static_cast<typename BasicJsonType::number_unsigned_t>(val));
814 815
}

816
template <
817 818
    typename BasicJsonType, typename CompatibleNumberIntegerType,
    enable_if_t<is_compatible_integer_type<typename BasicJsonType::number_integer_t,
N
Niels Lohmann 已提交
819
                CompatibleNumberIntegerType>::value, int> = 0 >
820
void to_json(BasicJsonType& j, CompatibleNumberIntegerType val) noexcept
821
{
822
    external_constructor<value_t::number_integer>::construct(j, static_cast<typename BasicJsonType::number_integer_t>(val));
823 824
}

825 826 827
template<typename BasicJsonType, typename EnumType,
         enable_if_t<std::is_enum<EnumType>::value, int> = 0>
void to_json(BasicJsonType& j, EnumType e) noexcept
828
{
829 830
    using underlying_type = typename std::underlying_type<EnumType>::type;
    external_constructor<value_t::number_integer>::construct(j, static_cast<underlying_type>(e));
831 832
}

833
template<typename BasicJsonType>
834
void to_json(BasicJsonType& j, const std::vector<bool>& e)
835 836
{
    external_constructor<value_t::array>::construct(j, e);
837 838
}

839
template <
840
    typename BasicJsonType, typename CompatibleArrayType,
T
Théo DELRIEU 已提交
841
    enable_if_t <
842 843
        is_compatible_array_type<BasicJsonType, CompatibleArrayType>::value or
        std::is_same<typename BasicJsonType::array_t, CompatibleArrayType>::value,
T
Théo DELRIEU 已提交
844
        int > = 0 >
845
void to_json(BasicJsonType& j, const  CompatibleArrayType& arr)
846
{
T
Théo DELRIEU 已提交
847
    external_constructor<value_t::array>::construct(j, arr);
848 849
}

850
template <
851 852
    typename BasicJsonType, typename CompatibleObjectType,
    enable_if_t<is_compatible_object_type<BasicJsonType, CompatibleObjectType>::value,
T
Théo DELRIEU 已提交
853
                int> = 0 >
854
void to_json(BasicJsonType& j, const  CompatibleObjectType& arr)
855
{
T
Théo DELRIEU 已提交
856
    external_constructor<value_t::object>::construct(j, arr);
857 858
}

T
Théo DELRIEU 已提交
859 860 861 862
template <typename BasicJsonType, typename T, std::size_t N,
          enable_if_t<not std::is_constructible<
                          typename BasicJsonType::string_t, T (&)[N]>::value,
                      int> = 0>
N
Niels Lohmann 已提交
863 864 865
void to_json(BasicJsonType& j, T (&arr)[N])
{
    external_constructor<value_t::array>::construct(j, arr);
T
Théo DELRIEU 已提交
866
}
867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901

///////////////
// from_json //
///////////////

// overloads for basic_json template parameters
template<typename BasicJsonType, typename ArithmeticType,
         enable_if_t<std::is_arithmetic<ArithmeticType>::value and
                     not std::is_same<ArithmeticType,
                                      typename BasicJsonType::boolean_t>::value,
                     int> = 0>
void get_arithmetic_value(const BasicJsonType& j, ArithmeticType& val)
{
    switch (static_cast<value_t>(j))
    {
        case value_t::number_unsigned:
        {
            val = static_cast<ArithmeticType>(
                      *j.template get_ptr<const typename BasicJsonType::number_unsigned_t*>());
            break;
        }
        case value_t::number_integer:
        {
            val = static_cast<ArithmeticType>(
                      *j.template get_ptr<const typename BasicJsonType::number_integer_t*>());
            break;
        }
        case value_t::number_float:
        {
            val = static_cast<ArithmeticType>(
                      *j.template get_ptr<const typename BasicJsonType::number_float_t*>());
            break;
        }
        default:
        {
902
            JSON_THROW(type_error::create(302, "type must be number, but is " + j.type_name()));
903 904 905 906 907
        }
    }
}

template<typename BasicJsonType>
908
void from_json(const BasicJsonType& j, typename BasicJsonType::boolean_t& b)
909
{
N
Niels Lohmann 已提交
910
    if (not j.is_boolean())
T
Théo DELRIEU 已提交
911
    {
912
        JSON_THROW(type_error::create(302, "type must be boolean, but is " + j.type_name()));
T
Théo DELRIEU 已提交
913
    }
914
    b = *j.template get_ptr<const typename BasicJsonType::boolean_t*>();
915 916
}

917
template<typename BasicJsonType>
918
void from_json(const BasicJsonType& j, typename BasicJsonType::string_t& s)
919
{
N
Niels Lohmann 已提交
920
    if (not j.is_string())
T
Théo DELRIEU 已提交
921
    {
922
        JSON_THROW(type_error::create(302, "type must be string, but is " + j.type_name()));
T
Théo DELRIEU 已提交
923
    }
924
    s = *j.template get_ptr<const typename BasicJsonType::string_t*>();
925 926
}

927
template<typename BasicJsonType>
928
void from_json(const BasicJsonType& j, typename BasicJsonType::number_float_t& val)
929
{
T
Théo DELRIEU 已提交
930
    get_arithmetic_value(j, val);
931 932
}

933
template<typename BasicJsonType>
934
void from_json(const BasicJsonType& j, typename BasicJsonType::number_unsigned_t& val)
935
{
T
Théo DELRIEU 已提交
936
    get_arithmetic_value(j, val);
937 938
}

939
template<typename BasicJsonType>
940
void from_json(const BasicJsonType& j, typename BasicJsonType::number_integer_t& val)
941
{
T
Théo DELRIEU 已提交
942
    get_arithmetic_value(j, val);
943 944
}

945 946 947
template<typename BasicJsonType, typename EnumType,
         enable_if_t<std::is_enum<EnumType>::value, int> = 0>
void from_json(const BasicJsonType& j, EnumType& e)
948
{
949
    typename std::underlying_type<EnumType>::type val;
T
Théo DELRIEU 已提交
950
    get_arithmetic_value(j, val);
951
    e = static_cast<EnumType>(val);
952 953
}

954 955
template<typename BasicJsonType>
void from_json(const BasicJsonType& j, typename BasicJsonType::array_t& arr)
956
{
N
Niels Lohmann 已提交
957
    if (not j.is_array())
T
Théo DELRIEU 已提交
958
    {
959
        JSON_THROW(type_error::create(302, "type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
960
    }
961
    arr = *j.template get_ptr<const typename BasicJsonType::array_t*>();
962 963
}

964
// forward_list doesn't have an insert method
965 966
template<typename BasicJsonType, typename T, typename Allocator,
         enable_if_t<std::is_convertible<BasicJsonType, T>::value, int> = 0>
967
void from_json(const BasicJsonType& j, std::forward_list<T, Allocator>& l)
968
{
969
    if (not j.is_array())
T
Théo DELRIEU 已提交
970
    {
971
        JSON_THROW(type_error::create(302, "type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
972
    }
973

T
Théo DELRIEU 已提交
974 975 976 977
    for (auto it = j.rbegin(), end = j.rend(); it != end; ++it)
    {
        l.push_front(it->template get<T>());
    }
978 979
}

980 981
template<typename BasicJsonType, typename CompatibleArrayType>
void from_json_array_impl(const BasicJsonType& j, CompatibleArrayType& arr, priority_tag<0>)
982
{
T
Théo DELRIEU 已提交
983 984
    using std::begin;
    using std::end;
985

986 987
    std::transform(j.begin(), j.end(),
                   std::inserter(arr, end(arr)), [](const BasicJsonType & i)
T
Théo DELRIEU 已提交
988
    {
989 990
        // get<BasicJsonType>() returns *this, this won't call a from_json
        // method when value_type is BasicJsonType
991
        return i.template get<typename CompatibleArrayType::value_type>();
T
Théo DELRIEU 已提交
992
    });
993 994
}

995 996
template<typename BasicJsonType, typename CompatibleArrayType>
auto from_json_array_impl(const BasicJsonType& j, CompatibleArrayType& arr, priority_tag<1>)
T
Théo DELRIEU 已提交
997 998 999
-> decltype(
    arr.reserve(std::declval<typename CompatibleArrayType::size_type>()),
    void())
1000
{
T
Théo DELRIEU 已提交
1001 1002
    using std::begin;
    using std::end;
1003

T
Théo DELRIEU 已提交
1004
    arr.reserve(j.size());
1005 1006
    std::transform(j.begin(), j.end(),
                   std::inserter(arr, end(arr)), [](const BasicJsonType & i)
T
Théo DELRIEU 已提交
1007
    {
1008 1009
        // get<BasicJsonType>() returns *this, this won't call a from_json
        // method when value_type is BasicJsonType
1010
        return i.template get<typename CompatibleArrayType::value_type>();
T
Théo DELRIEU 已提交
1011
    });
1012 1013
}

1014 1015
template<typename BasicJsonType, typename CompatibleArrayType,
         enable_if_t<is_compatible_array_type<BasicJsonType, CompatibleArrayType>::value and
1016
                     std::is_convertible<BasicJsonType, typename CompatibleArrayType::value_type>::value and
1017 1018
                     not std::is_same<typename BasicJsonType::array_t, CompatibleArrayType>::value, int> = 0>
void from_json(const BasicJsonType& j, CompatibleArrayType& arr)
1019
{
1020
    if (not j.is_array())
T
Théo DELRIEU 已提交
1021
    {
1022
        JSON_THROW(type_error::create(302, "type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
1023
    }
1024

T
Théo DELRIEU 已提交
1025
    from_json_array_impl(j, arr, priority_tag<1> {});
1026 1027
}

1028 1029 1030
template<typename BasicJsonType, typename CompatibleObjectType,
         enable_if_t<is_compatible_object_type<BasicJsonType, CompatibleObjectType>::value, int> = 0>
void from_json(const BasicJsonType& j, CompatibleObjectType& obj)
1031
{
N
Niels Lohmann 已提交
1032
    if (not j.is_object())
T
Théo DELRIEU 已提交
1033
    {
1034
        JSON_THROW(type_error::create(302, "type must be object, but is " + j.type_name()));
T
Théo DELRIEU 已提交
1035 1036
    }

1037
    auto inner_object = j.template get_ptr<const typename BasicJsonType::object_t*>();
T
Théo DELRIEU 已提交
1038 1039 1040
    using std::begin;
    using std::end;
    // we could avoid the assignment, but this might require a for loop, which
N
Niels Lohmann 已提交
1041 1042
    // might be less efficient than the container constructor for some
    // containers (would it?)
T
Théo DELRIEU 已提交
1043
    obj = CompatibleObjectType(begin(*inner_object), end(*inner_object));
1044 1045
}

N
Niels Lohmann 已提交
1046 1047 1048 1049
// overload for arithmetic types, not chosen for basic_json template arguments
// (BooleanType, etc..); note: Is it really necessary to provide explicit
// overloads for boolean_t etc. in case of a custom BooleanType which is not
// an arithmetic type?
1050 1051 1052 1053 1054 1055 1056 1057
template<typename BasicJsonType, typename ArithmeticType,
         enable_if_t <
             std::is_arithmetic<ArithmeticType>::value and
             not std::is_same<ArithmeticType, typename BasicJsonType::number_unsigned_t>::value and
             not std::is_same<ArithmeticType, typename BasicJsonType::number_integer_t>::value and
             not std::is_same<ArithmeticType, typename BasicJsonType::number_float_t>::value and
             not std::is_same<ArithmeticType, typename BasicJsonType::boolean_t>::value,
             int> = 0>
1058
void from_json(const BasicJsonType& j, ArithmeticType& val)
T
Théo DELRIEU 已提交
1059 1060 1061 1062
{
    switch (static_cast<value_t>(j))
    {
        case value_t::number_unsigned:
N
Niels Lohmann 已提交
1063
        {
1064
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_unsigned_t*>());
T
Théo DELRIEU 已提交
1065
            break;
N
Niels Lohmann 已提交
1066
        }
T
Théo DELRIEU 已提交
1067
        case value_t::number_integer:
N
Niels Lohmann 已提交
1068
        {
1069
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_integer_t*>());
T
Théo DELRIEU 已提交
1070
            break;
N
Niels Lohmann 已提交
1071
        }
T
Théo DELRIEU 已提交
1072
        case value_t::number_float:
N
Niels Lohmann 已提交
1073
        {
1074
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_float_t*>());
T
Théo DELRIEU 已提交
1075
            break;
N
Niels Lohmann 已提交
1076
        }
T
Théo DELRIEU 已提交
1077
        case value_t::boolean:
N
Niels Lohmann 已提交
1078
        {
1079
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::boolean_t*>());
T
Théo DELRIEU 已提交
1080
            break;
N
Niels Lohmann 已提交
1081
        }
T
Théo DELRIEU 已提交
1082
        default:
N
Niels Lohmann 已提交
1083
        {
1084
            JSON_THROW(type_error::create(302, "type must be number, but is " + j.type_name()));
N
Niels Lohmann 已提交
1085
        }
T
Théo DELRIEU 已提交
1086
    }
1087 1088
}

1089 1090
struct to_json_fn
{
N
Niels Lohmann 已提交
1091
  private:
1092 1093 1094
    template<typename BasicJsonType, typename T>
    auto call(BasicJsonType& j, T&& val, priority_tag<1>) const noexcept(noexcept(to_json(j, std::forward<T>(val))))
    -> decltype(to_json(j, std::forward<T>(val)), void())
1095
    {
1096
        return to_json(j, std::forward<T>(val));
1097
    }
T
Théo DELRIEU 已提交
1098

1099
    template<typename BasicJsonType, typename T>
1100
    void call(BasicJsonType&, T&&, priority_tag<0>) const noexcept
T
Théo DELRIEU 已提交
1101
    {
1102 1103
        static_assert(sizeof(BasicJsonType) == 0,
                      "could not find to_json() method in T's namespace");
T
Théo DELRIEU 已提交
1104 1105
    }

T
Théo DELRIEU 已提交
1106
  public:
1107
    template<typename BasicJsonType, typename T>
1108
    void operator()(BasicJsonType& j, T&& val) const
T
Théo DELRIEU 已提交
1109 1110 1111 1112
    noexcept(noexcept(std::declval<to_json_fn>().call(j, std::forward<T>(val), priority_tag<1> {})))
    {
        return call(j, std::forward<T>(val), priority_tag<1> {});
    }
1113 1114 1115 1116
};

struct from_json_fn
{
T
Théo DELRIEU 已提交
1117
  private:
1118 1119
    template<typename BasicJsonType, typename T>
    auto call(const BasicJsonType& j, T& val, priority_tag<1>) const
T
Théo DELRIEU 已提交
1120 1121 1122 1123 1124 1125
    noexcept(noexcept(from_json(j, val)))
    -> decltype(from_json(j, val), void())
    {
        return from_json(j, val);
    }

1126
    template<typename BasicJsonType, typename T>
1127
    void call(const BasicJsonType&, T&, priority_tag<0>) const noexcept
T
Théo DELRIEU 已提交
1128
    {
1129 1130
        static_assert(sizeof(BasicJsonType) == 0,
                      "could not find from_json() method in T's namespace");
T
Théo DELRIEU 已提交
1131 1132 1133
    }

  public:
1134 1135
    template<typename BasicJsonType, typename T>
    void operator()(const BasicJsonType& j, T& val) const
T
Théo DELRIEU 已提交
1136 1137 1138 1139
    noexcept(noexcept(std::declval<from_json_fn>().call(j, val, priority_tag<1> {})))
    {
        return call(j, val, priority_tag<1> {});
    }
1140
};
1141

1142
// taken from ranges-v3
1143
template<typename T>
1144 1145 1146 1147 1148
struct static_const
{
    static constexpr T value{};
};

1149
template<typename T>
1150
constexpr T static_const<T>::value;
1151 1152
} // namespace detail

N
Niels 已提交
1153

N
Niels Lohmann 已提交
1154
/// namespace to hold default `to_json` / `from_json` functions
1155
namespace
1156
{
T
Théo DELRIEU 已提交
1157 1158
constexpr const auto& to_json = detail::static_const<detail::to_json_fn>::value;
constexpr const auto& from_json = detail::static_const<detail::from_json_fn>::value;
1159 1160
}

N
Niels Lohmann 已提交
1161 1162 1163 1164 1165 1166 1167 1168

/*!
@brief default JSONSerializer template argument

This serializer ignores the template arguments and uses ADL
([argument-dependent lookup](http://en.cppreference.com/w/cpp/language/adl))
for serialization.
*/
1169
template<typename = void, typename = void>
1170 1171
struct adl_serializer
{
N
Niels Lohmann 已提交
1172 1173 1174 1175 1176 1177 1178
    /*!
    @brief convert a JSON value to any value type

    This function is usually called by the `get()` function of the
    @ref basic_json class (either explicit or via conversion operators).

    @param[in] j         JSON value to read from
1179
    @param[in,out] val  value to write to
N
Niels Lohmann 已提交
1180 1181 1182 1183
    */
    template<typename BasicJsonType, typename ValueType>
    static void from_json(BasicJsonType&& j, ValueType& val) noexcept(
        noexcept(::nlohmann::from_json(std::forward<BasicJsonType>(j), val)))
1184
    {
1185
        ::nlohmann::from_json(std::forward<BasicJsonType>(j), val);
1186 1187
    }

N
Niels Lohmann 已提交
1188 1189 1190 1191 1192 1193
    /*!
    @brief convert any value type to a JSON value

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

1194
    @param[in,out] j  JSON value to write to
N
Niels Lohmann 已提交
1195 1196 1197 1198 1199
    @param[in] val     value to read from
    */
    template<typename BasicJsonType, typename ValueType>
    static void to_json(BasicJsonType& j, ValueType&& val) noexcept(
        noexcept(::nlohmann::to_json(j, std::forward<ValueType>(val))))
1200
    {
N
Niels Lohmann 已提交
1201
        ::nlohmann::to_json(j, std::forward<ValueType>(val));
1202
    }
1203 1204
};

1205

N
Niels 已提交
1206
/*!
N
Niels 已提交
1207
@brief a class to store JSON values
N
Niels 已提交
1208

N
Niels 已提交
1209
@tparam ObjectType type for JSON objects (`std::map` by default; will be used
N
Niels 已提交
1210
in @ref object_t)
N
Niels 已提交
1211
@tparam ArrayType type for JSON arrays (`std::vector` by default; will be used
N
Niels 已提交
1212
in @ref array_t)
N
Niels 已提交
1213
@tparam StringType type for JSON strings and object keys (`std::string` by
N
Niels 已提交
1214
default; will be used in @ref string_t)
N
Niels 已提交
1215
@tparam BooleanType type for JSON booleans (`bool` by default; will be used
N
Niels 已提交
1216
in @ref boolean_t)
N
Niels 已提交
1217
@tparam NumberIntegerType type for JSON integer numbers (`int64_t` by
N
Niels 已提交
1218
default; will be used in @ref number_integer_t)
N
Niels 已提交
1219 1220
@tparam NumberUnsignedType type for JSON unsigned integer numbers (@c
`uint64_t` by default; will be used in @ref number_unsigned_t)
N
Niels 已提交
1221
@tparam NumberFloatType type for JSON floating-point numbers (`double` by
N
Niels 已提交
1222
default; will be used in @ref number_float_t)
N
Niels 已提交
1223
@tparam AllocatorType type of the allocator to use (`std::allocator` by
N
Niels 已提交
1224
default)
N
Niels Lohmann 已提交
1225
@tparam JSONSerializer the serializer to resolve internal calls to `to_json()`
N
Niels Lohmann 已提交
1226
and `from_json()` (@ref adl_serializer by default)
N
Niels 已提交
1227

N
Niels 已提交
1228 1229
@requirement The class satisfies the following concept requirements:
- Basic
N
Niels 已提交
1230
 - [DefaultConstructible](http://en.cppreference.com/w/cpp/concept/DefaultConstructible):
N
Niels Lohmann 已提交
1231 1232
   JSON values can be default constructed. The result will be a JSON null
   value.
N
Niels 已提交
1233 1234 1235
 - [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 已提交
1236
   A JSON value can be copy-constructed from an lvalue expression.
N
Niels 已提交
1237 1238 1239 1240 1241 1242
 - [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 已提交
1243
- Layout
N
Niels 已提交
1244 1245 1246
 - [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 已提交
1247 1248
   All non-static data members are private and standard layout types, the
   class has no virtual functions or (virtual) base classes.
N
Niels 已提交
1249
- Library-wide
N
Niels 已提交
1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261
 - [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 已提交
1262
- Container
N
Niels 已提交
1263 1264 1265 1266 1267
 - [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 已提交
1268

1269 1270 1271 1272 1273 1274 1275
@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 已提交
1276
@internal
N
Niels 已提交
1277
@note ObjectType trick from http://stackoverflow.com/a/9860911
N
Niels 已提交
1278
@endinternal
N
Niels 已提交
1279

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

N
Niels 已提交
1283
@since version 1.0.0
N
Niels 已提交
1284 1285

@nosubgrouping
N
Niels 已提交
1286 1287 1288 1289 1290 1291
*/
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,
1292 1293
    class NumberIntegerType = std::int64_t,
    class NumberUnsignedType = std::uint64_t,
N
Niels 已提交
1294
    class NumberFloatType = double,
1295
    template<typename U> class AllocatorType = std::allocator,
1296
    template<typename T, typename SFINAE = void> class JSONSerializer = adl_serializer
N
Niels 已提交
1297 1298 1299
    >
class basic_json
{
1300
  private:
1301
    template<detail::value_t> friend struct detail::external_constructor;
1302
    /// workaround type for MSVC
N
Niels 已提交
1303 1304
    using basic_json_t = basic_json<ObjectType, ArrayType, StringType,
          BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType,
1305
          AllocatorType, JSONSerializer>;
1306 1307

  public:
1308
    using value_t = detail::value_t;
N
Niels 已提交
1309
    // forward declarations
N
Niels Lohmann 已提交
1310
    template<typename U> class iter_impl;
N
Niels 已提交
1311 1312
    template<typename Base> class json_reverse_iterator;
    class json_pointer;
1313
    template<typename T, typename SFINAE>
1314
    using json_serializer = JSONSerializer<T, SFINAE>;
1315

1316 1317 1318 1319 1320 1321 1322 1323 1324

    ////////////////
    // exceptions //
    ////////////////

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

1325 1326
    /// @copydoc detail::exception
    using exception = detail::exception;
1327 1328 1329 1330 1331 1332 1333 1334
    /// @copydoc detail::parse_error
    using parse_error = detail::parse_error;
    /// @copydoc detail::invalid_iterator
    using invalid_iterator = detail::invalid_iterator;
    /// @copydoc detail::type_error
    using type_error = detail::type_error;
    /// @copydoc detail::out_of_range
    using out_of_range = detail::out_of_range;
1335 1336
    /// @copydoc detail::other_error
    using other_error = detail::other_error;
1337 1338 1339 1340

    /// @}


N
Niels 已提交
1341 1342 1343 1344
    /////////////////////
    // container types //
    /////////////////////

N
Niels 已提交
1345
    /// @name container types
N
Niels 已提交
1346 1347
    /// The canonic container types to use @ref basic_json like any other STL
    /// container.
N
Niels 已提交
1348 1349
    /// @{

N
Niels 已提交
1350
    /// the type of elements in a basic_json container
N
Niels 已提交
1351
    using value_type = basic_json;
N
Niels 已提交
1352

N
Niels 已提交
1353
    /// the type of an element reference
N
Niels 已提交
1354
    using reference = value_type&;
N
Niels 已提交
1355
    /// the type of an element const reference
N
Niels 已提交
1356
    using const_reference = const value_type&;
N
Niels 已提交
1357

N
Niels 已提交
1358
    /// a type to represent differences between iterators
N
Niels 已提交
1359
    using difference_type = std::ptrdiff_t;
N
Niels 已提交
1360
    /// a type to represent container sizes
N
Niels 已提交
1361 1362 1363
    using size_type = std::size_t;

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

N
Niels 已提交
1366
    /// the type of an element pointer
N
Niels 已提交
1367
    using pointer = typename std::allocator_traits<allocator_type>::pointer;
N
Niels 已提交
1368
    /// the type of an element const pointer
N
Niels 已提交
1369
    using const_pointer = typename std::allocator_traits<allocator_type>::const_pointer;
N
Niels 已提交
1370

N
Niels 已提交
1371
    /// an iterator for a basic_json container
1372
    using iterator = iter_impl<basic_json>;
N
Niels 已提交
1373
    /// a const iterator for a basic_json container
1374
    using const_iterator = iter_impl<const basic_json>;
N
Niels 已提交
1375
    /// a reverse iterator for a basic_json container
N
Niels 已提交
1376
    using reverse_iterator = json_reverse_iterator<typename basic_json::iterator>;
N
Niels 已提交
1377
    /// a const reverse iterator for a basic_json container
N
Niels 已提交
1378
    using const_reverse_iterator = json_reverse_iterator<typename basic_json::const_iterator>;
N
Niels 已提交
1379

N
Niels 已提交
1380 1381 1382
    /// @}


N
Niels 已提交
1383 1384 1385
    /*!
    @brief returns the allocator associated with the container
    */
N
Niels 已提交
1386
    static allocator_type get_allocator()
N
Niels 已提交
1387 1388 1389 1390
    {
        return allocator_type();
    }

1391 1392
    /*!
    @brief returns version information on the library
1393

N
Niels Lohmann 已提交
1394
    This function returns a JSON object with information about the library,
1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412
    including the version number and information on the platform and compiler.

    @return JSON object holding version information
    key         | description
    ----------- | ---------------
    `compiler`  | Information on the used compiler. It is an object with the following keys: `c++` (the used C++ standard), `family` (the compiler family; possible values are `clang`, `icc`, `gcc`, `ilecpp`, `msvc`, `pgcpp`, `sunpro`, and `unknown`), and `version` (the compiler version).
    `copyright` | The copyright line for the library as string.
    `name`      | The name of the library as string.
    `platform`  | The used platform as string. Possible values are `win32`, `linux`, `apple`, `unix`, and `unknown`.
    `url`       | The URL of the project as string.
    `version`   | The version of the library. It is an object with the following keys: `major`, `minor`, and `patch` as defined by [Semantic Versioning](http://semver.org), and `string` (the version string).

    @liveexample{The following code shows an example output of the `meta()`
    function.,meta}

    @complexity Constant.

    @since 2.1.0
1413
    */
1414
    static basic_json meta()
1415 1416 1417
    {
        basic_json result;

1418
        result["copyright"] = "(C) 2013-2017 Niels Lohmann";
1419 1420 1421 1422
        result["name"] = "JSON for Modern C++";
        result["url"] = "https://github.com/nlohmann/json";
        result["version"] =
        {
N
Niels Lohmann 已提交
1423
            {"string", "2.1.1"}, {"major", 2}, {"minor", 1}, {"patch", 1}
1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438
        };

#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__)
1439
        result["compiler"] = {{"family", "clang"}, {"version", __clang_version__}};
1440 1441 1442
#elif defined(__ICC) || defined(__INTEL_COMPILER)
        result["compiler"] = {{"family", "icc"}, {"version", __INTEL_COMPILER}};
#elif defined(__GNUC__) || defined(__GNUG__)
1443
        result["compiler"] = {{"family", "gcc"}, {"version", std::to_string(__GNUC__) + "." + std::to_string(__GNUC_MINOR__) + "." + std::to_string(__GNUC_PATCHLEVEL__)}};
1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465
#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 已提交
1466

N
Niels 已提交
1467 1468 1469 1470
    ///////////////////////////
    // JSON value data types //
    ///////////////////////////

N
Niels 已提交
1471
    /// @name JSON value data types
N
Niels 已提交
1472 1473
    /// The data types to store a JSON value. These types are derived from
    /// the template arguments passed to class @ref basic_json.
N
Niels 已提交
1474 1475
    /// @{

N
Niels 已提交
1476 1477 1478 1479 1480 1481 1482 1483
    /*!
    @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 已提交
1484 1485 1486 1487 1488
    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 已提交
1489 1490
    @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 已提交
1491 1492 1493
    inside the container.
    @tparam AllocatorType the allocator to use for objects (e.g.,
    `std::allocator`)
N
Niels 已提交
1494 1495 1496 1497

    #### Default type

    With the default values for @a ObjectType (`std::map`), @a StringType
N
Niels 已提交
1498 1499
    (`std::string`), and @a AllocatorType (`std::allocator`), the default
    value for @a object_t is:
N
Niels 已提交
1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515

    @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 已提交
1516 1517
      that all software implementations receiving that object will agree on
      the name-value mappings.
N
Niels 已提交
1518 1519 1520 1521 1522
    - 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 已提交
1523 1524 1525
      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 已提交
1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537
    - 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 已提交
1538 1539
    runtime environment. A theoretical limit can be queried by calling the
    @ref max_size function of a JSON object.
N
Niels 已提交
1540 1541 1542

    #### Storage

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

1547 1548
    @sa @ref array_t -- type for an array value

N
Niels 已提交
1549
    @since version 1.0.0
N
Niels 已提交
1550

N
Niels 已提交
1551 1552 1553 1554 1555
    @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 已提交
1556 1557
    7159](http://rfc7159.net/rfc7159), because any order implements the
    specified "unordered" nature of JSON objects.
N
Niels 已提交
1558
    */
N
Niels 已提交
1559 1560 1561 1562 1563
    using object_t = ObjectType<StringType,
          basic_json,
          std::less<StringType>,
          AllocatorType<std::pair<const StringType,
          basic_json>>>;
N
Niels 已提交
1564 1565 1566 1567 1568 1569 1570

    /*!
    @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 已提交
1571 1572 1573 1574 1575
    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 已提交
1576
    @tparam AllocatorType allocator to use for arrays (e.g., `std::allocator`)
N
Niels 已提交
1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596

    #### 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 已提交
1597 1598
    runtime environment. A theoretical limit can be queried by calling the
    @ref max_size function of a JSON array.
N
Niels 已提交
1599 1600 1601

    #### Storage

1602
    Arrays are stored as pointers in a @ref basic_json type. That is, for any
N
Niels 已提交
1603
    access to array values, a pointer of type `array_t*` must be dereferenced.
1604 1605 1606

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

N
Niels 已提交
1607
    @since version 1.0.0
N
Niels 已提交
1608
    */
N
Niels 已提交
1609
    using array_t = ArrayType<basic_json, AllocatorType<basic_json>>;
N
Niels 已提交
1610 1611 1612 1613 1614 1615 1616

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

N
Niels 已提交
1621 1622
    @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 已提交
1623 1624 1625 1626 1627 1628 1629 1630 1631 1632

    #### Default type

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

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

1633 1634 1635 1636 1637 1638
    #### 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 已提交
1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655
    #### 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

1656 1657
    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 已提交
1658
    dereferenced.
1659

N
Niels 已提交
1660
    @since version 1.0.0
N
Niels 已提交
1661
    */
N
Niels 已提交
1662
    using string_t = StringType;
N
Niels 已提交
1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683

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

1684 1685
    Boolean values are stored directly inside a @ref basic_json type.

N
Niels 已提交
1686
    @since version 1.0.0
N
Niels 已提交
1687
    */
N
Niels 已提交
1688
    using boolean_t = BooleanType;
N
Niels 已提交
1689 1690 1691 1692 1693

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

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706
    > 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 已提交
1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724

    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 已提交
1725 1726
      instance, the C++ integer literal `010` will be serialized to `8`.
      During deserialization, leading zeros yield an error.
N
Niels 已提交
1727 1728 1729 1730 1731 1732 1733 1734 1735 1736
    - 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 已提交
1737 1738 1739 1740
    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 已提交
1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751

    [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

1752 1753 1754 1755
    Integer number values are stored directly inside a @ref basic_json type.

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

1756 1757
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
1758
    @since version 1.0.0
N
Niels 已提交
1759
    */
N
Niels 已提交
1760
    using number_integer_t = NumberIntegerType;
N
Niels 已提交
1761

1762 1763 1764 1765
    /*!
    @brief a type for a number (unsigned)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781
    > 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.
1782 1783 1784

    #### Default type

N
Niels 已提交
1785 1786
    With the default values for @a NumberUnsignedType (`uint64_t`), the
    default value for @a number_unsigned_t is:
1787 1788 1789 1790 1791 1792 1793 1794 1795 1796

    @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 已提交
1797 1798
      instance, the C++ integer literal `010` will be serialized to `8`.
      During deserialization, leading zeros yield an error.
1799 1800 1801 1802 1803 1804 1805 1806
    - 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 已提交
1807 1808 1809 1810 1811
    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.
1812 1813 1814 1815 1816 1817 1818

    [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 已提交
1819 1820
    number_integer_t type) of the exactly supported range [0, UINT64_MAX],
    this class's integer type is interoperable.
1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831

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

N
Niels 已提交
1833 1834 1835 1836
    /*!
    @brief a type for a number (floating-point)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849
    > 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 已提交
1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865

    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 已提交
1866 1867
      leading zeros in floating-point literals will be ignored. Internally,
      the value will be stored as decimal number. For instance, the C++
N
Niels 已提交
1868 1869 1870 1871 1872 1873 1874 1875 1876 1877
      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 已提交
1878 1879 1880
    > 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 已提交
1881 1882 1883 1884
    > precision.

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

    #### Storage

1890 1891 1892 1893 1894
    Floating-point number values are stored directly inside a @ref basic_json
    type.

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

1895 1896
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
1897
    @since version 1.0.0
N
Niels 已提交
1898
    */
N
Niels 已提交
1899 1900
    using number_float_t = NumberFloatType;

N
Niels 已提交
1901 1902
    /// @}

N
Niels 已提交
1903
  private:
N
Niels 已提交
1904

N
Cleanup  
Niels 已提交
1905 1906
    /// helper for exception-safe object creation
    template<typename T, typename... Args>
N
cleanup  
Niels 已提交
1907
    static T* create(Args&& ... args)
N
Cleanup  
Niels 已提交
1908 1909 1910 1911 1912 1913 1914 1915
    {
        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 已提交
1916
        assert(object != nullptr);
N
Cleanup  
Niels 已提交
1917 1918 1919
        return object.release();
    }

N
Niels 已提交
1920 1921 1922 1923
    ////////////////////////
    // JSON value storage //
    ////////////////////////

1924 1925 1926
    /*!
    @brief a JSON value

N
Niels 已提交
1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944
    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.
1945

N
Niels 已提交
1946
    @since version 1.0.0
1947
    */
N
Niels 已提交
1948 1949 1950 1951 1952 1953 1954 1955
    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 已提交
1956
        /// boolean
N
Niels 已提交
1957 1958 1959
        boolean_t boolean;
        /// number (integer)
        number_integer_t number_integer;
1960 1961
        /// number (unsigned integer)
        number_unsigned_t number_unsigned;
N
Niels 已提交
1962
        /// number (floating-point)
N
Niels 已提交
1963 1964 1965
        number_float_t number_float;

        /// default constructor (for null values)
N
Niels 已提交
1966
        json_value() = default;
N
Niels 已提交
1967
        /// constructor for booleans
N
Niels 已提交
1968
        json_value(boolean_t v) noexcept : boolean(v) {}
N
Niels 已提交
1969
        /// constructor for numbers (integer)
N
Niels 已提交
1970
        json_value(number_integer_t v) noexcept : number_integer(v) {}
1971 1972
        /// constructor for numbers (unsigned)
        json_value(number_unsigned_t v) noexcept : number_unsigned(v) {}
N
Niels 已提交
1973
        /// constructor for numbers (floating-point)
N
Niels 已提交
1974
        json_value(number_float_t v) noexcept : number_float(v) {}
N
Niels 已提交
1975
        /// constructor for empty values of a given type
N
Niels 已提交
1976
        json_value(value_t t)
N
Niels 已提交
1977 1978 1979
        {
            switch (t)
            {
1980
                case value_t::object:
N
Niels 已提交
1981
                {
N
Cleanup  
Niels 已提交
1982
                    object = create<object_t>();
N
Niels 已提交
1983 1984
                    break;
                }
N
Niels 已提交
1985

1986
                case value_t::array:
N
Niels 已提交
1987
                {
N
Cleanup  
Niels 已提交
1988
                    array = create<array_t>();
N
Niels 已提交
1989 1990
                    break;
                }
N
Niels 已提交
1991

1992
                case value_t::string:
N
Niels 已提交
1993
                {
N
Cleanup  
Niels 已提交
1994
                    string = create<string_t>("");
N
Niels 已提交
1995 1996
                    break;
                }
N
Niels 已提交
1997

1998
                case value_t::boolean:
N
Niels 已提交
1999 2000 2001 2002 2003
                {
                    boolean = boolean_t(false);
                    break;
                }

2004
                case value_t::number_integer:
N
Niels 已提交
2005 2006 2007 2008
                {
                    number_integer = number_integer_t(0);
                    break;
                }
N
Niels 已提交
2009

2010 2011 2012 2013 2014
                case value_t::number_unsigned:
                {
                    number_unsigned = number_unsigned_t(0);
                    break;
                }
N
Niels 已提交
2015

2016
                case value_t::number_float:
N
Niels 已提交
2017 2018 2019 2020
                {
                    number_float = number_float_t(0.0);
                    break;
                }
2021

2022 2023 2024 2025 2026
                case value_t::null:
                {
                    break;
                }

2027 2028
                default:
                {
N
Niels Lohmann 已提交
2029
                    if (JSON_UNLIKELY(t == value_t::null))
2030
                    {
2031
                        JSON_THROW(other_error::create(500, "961c151d2e87f2686a955a9be24d316f1362bf21 2.1.1")); // LCOV_EXCL_LINE
2032
                    }
2033 2034
                    break;
                }
N
Niels 已提交
2035 2036
            }
        }
N
Niels 已提交
2037 2038

        /// constructor for strings
N
Niels 已提交
2039
        json_value(const string_t& value)
N
Niels 已提交
2040
        {
N
Cleanup  
Niels 已提交
2041
            string = create<string_t>(value);
N
Niels 已提交
2042 2043 2044
        }

        /// constructor for objects
N
Niels 已提交
2045
        json_value(const object_t& value)
N
Niels 已提交
2046
        {
N
Cleanup  
Niels 已提交
2047
            object = create<object_t>(value);
N
Niels 已提交
2048 2049 2050
        }

        /// constructor for arrays
N
Niels 已提交
2051
        json_value(const array_t& value)
N
Niels 已提交
2052
        {
N
Cleanup  
Niels 已提交
2053
            array = create<array_t>(value);
N
Niels 已提交
2054
        }
N
Niels 已提交
2055 2056
    };

2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071
    /*!
    @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 已提交
2072 2073

  public:
N
Niels 已提交
2074 2075 2076 2077
    //////////////////////////
    // JSON parser callback //
    //////////////////////////

N
Niels 已提交
2078 2079 2080 2081 2082
    /*!
    @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.
2083

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

N
Niels 已提交
2086
    @since version 1.0.0
N
Niels 已提交
2087
    */
N
Niels 已提交
2088 2089
    enum class parse_event_t : uint8_t
    {
N
Niels 已提交
2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101
        /// 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 已提交
2102 2103
    };

N
Niels 已提交
2104 2105 2106 2107
    /*!
    @brief per-element parser callback type

    With a parser callback function, the result of parsing a JSON text can be
N
Niels 已提交
2108
    influenced. When passed to @ref parse(std::istream&, const
2109
    parser_callback_t) or @ref parse(const CharT, const parser_callback_t),
N
Niels 已提交
2110 2111 2112 2113 2114
    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 已提交
2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128

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

N
Niels 已提交
2131 2132
    Discarding a value (i.e., returning `false`) has different effects
    depending on the context in which function was called:
N
Niels 已提交
2133 2134 2135

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

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

N
Niels 已提交
2141
    @param[in] event  an event of type parse_event_t indicating the context in
N
Niels 已提交
2142 2143 2144 2145 2146 2147 2148 2149 2150 2151
    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
2152
    @ref parse(const CharT, const parser_callback_t) for examples
2153

N
Niels 已提交
2154
    @since version 1.0.0
N
Niels 已提交
2155
    */
N
Niels 已提交
2156 2157 2158
    using parser_callback_t = std::function<bool(int depth,
                              parse_event_t event,
                              basic_json& parsed)>;
N
Niels 已提交
2159

N
Niels 已提交
2160 2161 2162 2163 2164

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

N
Niels 已提交
2165
    /// @name constructors and destructors
N
Niels 已提交
2166 2167
    /// Constructors of class @ref basic_json, copy/move constructor, copy
    /// assignment, static functions creating objects, and the destructor.
N
Niels 已提交
2168 2169
    /// @{

N
Niels 已提交
2170 2171 2172
    /*!
    @brief create an empty value with a given type

N
Niels 已提交
2173 2174 2175 2176 2177
    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 已提交
2178 2179 2180 2181 2182 2183
    null        | `null`
    boolean     | `false`
    string      | `""`
    number      | `0`
    object      | `{}`
    array       | `[]`
N
Niels 已提交
2184

2185
    @param[in] value_type  the type of the value to create
N
Niels 已提交
2186 2187 2188 2189 2190

    @complexity Constant.

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

N
Niels 已提交
2192
    @since version 1.0.0
N
Niels 已提交
2193
    */
2194 2195
    basic_json(const value_t value_type)
        : m_type(value_type), m_value(value_type)
2196 2197 2198
    {
        assert_invariant();
    }
N
Niels 已提交
2199

N
Niels 已提交
2200
    /*!
N
Niels 已提交
2201
    @brief create a null object
N
Niels 已提交
2202

N
Niels 已提交
2203 2204
    Create a `null` JSON value. It either takes a null pointer as parameter
    (explicitly creating `null`) or no parameter (implicitly creating `null`).
N
Niels 已提交
2205 2206
    The passed null pointer itself is not read -- it is only used to choose
    the right constructor.
N
Niels 已提交
2207 2208 2209

    @complexity Constant.

N
Niels 已提交
2210 2211 2212
    @exceptionsafety No-throw guarantee: this constructor never throws
    exceptions.

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

N
Niels 已提交
2216
    @since version 1.0.0
N
Niels 已提交
2217
    */
N
Niels 已提交
2218
    basic_json(std::nullptr_t = nullptr) noexcept
N
Niels 已提交
2219
        : basic_json(value_t::null)
2220 2221 2222
    {
        assert_invariant();
    }
N
Niels 已提交
2223

T
Théo DELRIEU 已提交
2224
    /*!
2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262
    @brief create a JSON value

    This is a "catch all" constructor for all compatible JSON types; that is,
    types for which a `to_json()` method exsits. The constructor forwards the
    parameter @a val to that method (to `json_serializer<U>::to_json` method
    with `U = uncvref_t<CompatibleType>`, to be exact).

    Template type @a CompatibleType includes, but is not limited to, the
    following types:
    - **arrays**: @ref array_t and all kinds of compatible containers such as
      `std::vector`, `std::deque`, `std::list`, `std::forward_list`,
      `std::array`, `std::set`, `std::unordered_set`, `std::multiset`, and
      `unordered_multiset` with a `value_type` from which a @ref basic_json
      value can be constructed.
    - **objects**: @ref object_t and all kinds of compatible associative
      containers such as `std::map`, `std::unordered_map`, `std::multimap`,
      and `std::unordered_multimap` with a `key_type` compatible to
      @ref string_t and a `value_type` from which a @ref basic_json value can
      be constructed.
    - **strings**: @ref string_t, string literals, and all compatible string
      containers can be used.
    - **numbers**: @ref number_integer_t, @ref number_unsigned_t,
      @ref number_float_t, and all convertible number types such as `int`,
      `size_t`, `int64_t`, `float` or `double` can be used.
    - **boolean**: @ref boolean_t / `bool` can be used.

    See the examples below.

    @tparam CompatibleType a type such that:
    - @a CompatibleType is not derived from `std::istream`,
    - @a CompatibleType is not @ref basic_json (to avoid hijacking copy/move
         constructors),
    - @a CompatibleType is not a @ref basic_json nested type (e.g.,
         @ref json_pointer, @ref iterator, etc ...)
    - @ref @ref json_serializer<U> has a
         `to_json(basic_json_t&, CompatibleType&&)` method

    @tparam U = `uncvref_t<CompatibleType>`
T
Théo DELRIEU 已提交
2263 2264 2265

    @param[in] val the value to be forwarded

2266 2267 2268 2269 2270 2271 2272 2273
    @complexity Usually linear in the size of the passed @a val, also
                depending on the implementation of the called `to_json()`
                method.

    @throw what `json_serializer<U>::to_json()` throws

    @liveexample{The following code shows the constructor with several
    compatible types.,basic_json__CompatibleType}
T
Théo DELRIEU 已提交
2274 2275 2276

    @since version 2.1.0
    */
2277
    template<typename CompatibleType, typename U = detail::uncvref_t<CompatibleType>,
2278 2279 2280 2281 2282 2283
             detail::enable_if_t<not std::is_base_of<std::istream, U>::value and
                                 not std::is_same<U, basic_json_t>::value and
                                 not detail::is_basic_json_nested_type<
                                     basic_json_t, U>::value and
                                 detail::has_to_json<basic_json, U>::value,
                                 int> = 0>
2284 2285
    basic_json(CompatibleType && val) noexcept(noexcept(JSONSerializer<U>::to_json(
                std::declval<basic_json_t&>(), std::forward<CompatibleType>(val))))
2286
    {
2287 2288
        JSONSerializer<U>::to_json(*this, std::forward<CompatibleType>(val));
        assert_invariant();
2289
    }
2290

N
Niels 已提交
2291 2292 2293 2294 2295 2296 2297 2298 2299 2300
    /*!
    @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 已提交
2301 2302
       object value is created where the first elements of the pairs are
       treated as keys and the second elements are as values.
N
Niels 已提交
2303 2304 2305
    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 已提交
2306
    JSON values. The rationale is as follows:
N
Niels 已提交
2307 2308

    1. The empty initializer list is written as `{}` which is exactly an empty
N
Niels 已提交
2309
       JSON object.
N
Niels 已提交
2310
    2. C++ has now way of describing mapped types other than to list a list of
N
Niels 已提交
2311 2312 2313
       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 已提交
2314
    3. In all other cases, the initializer list could not be interpreted as
N
Niels 已提交
2315
       JSON object type, so interpreting it as JSON array type is safe.
N
Niels 已提交
2316

N
Niels 已提交
2317 2318
    With the rules described above, the following JSON values cannot be
    expressed by an initializer list:
N
Niels 已提交
2319

N
Niels 已提交
2320 2321 2322 2323 2324
    - 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 已提交
2325 2326 2327 2328 2329

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

N
Niels 已提交
2332 2333 2334
    @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 已提交
2335 2336
    used by the functions @ref array(std::initializer_list<basic_json>) and
    @ref object(std::initializer_list<basic_json>).
N
Niels 已提交
2337

N
Niels 已提交
2338 2339
    @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 已提交
2340 2341 2342
    value_t::array and @ref value_t::object are valid); when @a type_deduction
    is set to `true`, this parameter has no effect

2343 2344
    @throw type_error.301 if @a type_deduction is `false`, @a manual_type is
    `value_t::object`, but @a init contains an element which is not a pair
2345 2346 2347 2348
    whose first element is a string. In this case, the constructor could not
    create an object. If @a type_deduction would have be `true`, an array
    would have been created. See @ref object(std::initializer_list<basic_json>)
    for an example.
N
Niels 已提交
2349 2350 2351 2352

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

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

N
Niels 已提交
2355
    @sa @ref array(std::initializer_list<basic_json>) -- create a JSON array
2356
    value from an initializer list
N
Niels 已提交
2357
    @sa @ref object(std::initializer_list<basic_json>) -- create a JSON object
2358 2359
    value from an initializer list

N
Niels 已提交
2360
    @since version 1.0.0
N
Niels 已提交
2361
    */
N
Niels 已提交
2362 2363
    basic_json(std::initializer_list<basic_json> init,
               bool type_deduction = true,
N
Niels 已提交
2364
               value_t manual_type = value_t::array)
N
Niels 已提交
2365
    {
N
Niels 已提交
2366 2367
        // check if each element is an array with two elements whose first
        // element is a string
N
Niels 已提交
2368 2369
        bool is_an_object = std::all_of(init.begin(), init.end(),
                                        [](const basic_json & element)
N
Niels 已提交
2370
        {
N
Niels 已提交
2371 2372
            return element.is_array() and element.size() == 2 and element[0].is_string();
        });
N
Niels 已提交
2373 2374 2375 2376 2377 2378 2379

        // 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)
            {
2380
                is_an_object = false;
N
Niels 已提交
2381 2382 2383
            }

            // if object is wanted but impossible, throw an exception
2384
            if (manual_type == value_t::object and not is_an_object)
N
Niels 已提交
2385
            {
2386
                JSON_THROW(type_error::create(301, "cannot create object from initializer list"));
N
Niels 已提交
2387 2388 2389
            }
        }

2390
        if (is_an_object)
N
Niels 已提交
2391 2392 2393
        {
            // the initializer list is a list of pairs -> create object
            m_type = value_t::object;
N
Niels 已提交
2394
            m_value = value_t::object;
N
Niels 已提交
2395

N
Niels 已提交
2396
            std::for_each(init.begin(), init.end(), [this](const basic_json & element)
N
Niels 已提交
2397
            {
N
Niels 已提交
2398
                m_value.object->emplace(*(element[0].m_value.string), element[1]);
N
Niels 已提交
2399
            });
N
Niels 已提交
2400 2401 2402 2403 2404
        }
        else
        {
            // the initializer list describes an array -> create array
            m_type = value_t::array;
N
Niels 已提交
2405
            m_value.array = create<array_t>(init);
N
Niels 已提交
2406
        }
2407 2408

        assert_invariant();
N
Niels 已提交
2409 2410
    }

N
Niels 已提交
2411 2412 2413 2414 2415 2416 2417
    /*!
    @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 已提交
2418 2419
    @note This function is only needed to express two edge cases that cannot
    be realized with the initializer list constructor (@ref
N
Niels 已提交
2420 2421
    basic_json(std::initializer_list<basic_json>, bool, value_t)). These cases
    are:
N
Niels 已提交
2422
    1. creating an array whose elements are all pairs whose first element is a
N
Niels 已提交
2423
    string -- in this case, the initializer list constructor would create an
N
Niels 已提交
2424
    object, taking the first elements as keys
N
Niels 已提交
2425
    2. creating an empty array -- passing the empty initializer list to the
N
Niels 已提交
2426 2427
    initializer list constructor yields an empty object

N
Niels 已提交
2428
    @param[in] init  initializer list with JSON values to create an array from
N
Niels 已提交
2429 2430 2431 2432 2433 2434
    (optional)

    @return JSON array value

    @complexity Linear in the size of @a init.

N
Niels 已提交
2435
    @liveexample{The following code shows an example for the `array`
N
Niels 已提交
2436 2437
    function.,array}

2438 2439 2440 2441 2442
    @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 已提交
2443
    @since version 1.0.0
N
Niels 已提交
2444
    */
N
Niels 已提交
2445
    static basic_json array(std::initializer_list<basic_json> init =
T
Théo DELRIEU 已提交
2446
                                std::initializer_list<basic_json>())
N
Niels 已提交
2447
    {
N
Niels 已提交
2448
        return basic_json(init, false, value_t::array);
N
Niels 已提交
2449 2450
    }

N
Niels 已提交
2451 2452 2453 2454
    /*!
    @brief explicitly create an object from an initializer list

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

    @note This function is only added for symmetry reasons. In contrast to the
2459 2460 2461
    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
2462
    constructor @ref basic_json(std::initializer_list<basic_json>, bool, value_t).
N
Niels 已提交
2463

N
Niels 已提交
2464
    @param[in] init  initializer list to create an object from (optional)
N
Niels 已提交
2465 2466 2467

    @return JSON object value

2468 2469 2470 2471 2472
    @throw type_error.301 if @a init is not a list of pairs whose first
    elements are strings. In this case, no object can be created. When such a
    value is passed to @ref basic_json(std::initializer_list<basic_json>, bool, value_t),
    an array would have been created from the passed initializer list @a init.
    See example below.
N
Niels 已提交
2473 2474 2475

    @complexity Linear in the size of @a init.

N
Niels 已提交
2476
    @liveexample{The following code shows an example for the `object`
N
Niels 已提交
2477 2478
    function.,object}

2479 2480 2481 2482 2483
    @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 已提交
2484
    @since version 1.0.0
N
Niels 已提交
2485
    */
N
Niels 已提交
2486
    static basic_json object(std::initializer_list<basic_json> init =
T
Théo DELRIEU 已提交
2487
                                 std::initializer_list<basic_json>())
N
Niels 已提交
2488
    {
N
Niels 已提交
2489
        return basic_json(init, false, value_t::object);
N
Niels 已提交
2490 2491
    }

N
Niels 已提交
2492 2493 2494
    /*!
    @brief construct an array with count copies of given value

N
Niels 已提交
2495 2496
    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,
2497
    `std::distance(begin(),end()) == cnt` holds.
N
Niels 已提交
2498

2499 2500
    @param[in] cnt  the number of JSON copies of @a val to create
    @param[in] val  the JSON value to copy
N
Niels 已提交
2501

2502
    @complexity Linear in @a cnt.
N
Niels 已提交
2503 2504 2505 2506

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

N
Niels 已提交
2508
    @since version 1.0.0
N
Niels 已提交
2509
    */
2510
    basic_json(size_type cnt, const basic_json& val)
N
Niels 已提交
2511 2512
        : m_type(value_t::array)
    {
2513
        m_value.array = create<array_t>(cnt, val);
2514
        assert_invariant();
N
Niels 已提交
2515
    }
N
Niels 已提交
2516

N
Niels 已提交
2517 2518 2519 2520 2521
    /*!
    @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 已提交
2522
    - In case of primitive types (number, boolean, or string), @a first must
N
Niels 已提交
2523
      be `begin()` and @a last must be `end()`. In this case, the value is
2524
      copied. Otherwise, invalid_iterator.204 is thrown.
N
Niels 已提交
2525 2526
    - In case of structured types (array, object), the constructor behaves as
      similar versions for `std::vector`.
2527
    - In case of a null type, invalid_iterator.206 is thrown.
N
Niels 已提交
2528 2529 2530 2531 2532 2533 2534

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

2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550
    @pre Range `[first, last)` is valid. Usually, this precondition cannot be
         checked efficiently. Only certain edge cases are detected; see the
         description of the exceptions below.

    @throw invalid_iterator.201 if iterators @a first and @a last are not
    compatible (i.e., do not belong to the same JSON value). In this case,
    the range `[first, last)` is undefined.
    @throw invalid_iterator.204 if iterators @a first and @a last belong to a
    primitive type (number, boolean, or string), but @a first does not point
    to the first element any more. In this case, the range `[first, last)` is
    undefined. See example code below.
    @throw invalid_iterator.206 if iterators @a first and @a last belong to a
    null value. In this case, the range `[first, last)` is undefined.
N
Niels 已提交
2551 2552 2553 2554 2555

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

N
Niels 已提交
2557
    @since version 1.0.0
N
Niels 已提交
2558
    */
N
Niels 已提交
2559 2560 2561
    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 已提交
2562
    basic_json(InputIT first, InputIT last)
N
Niels 已提交
2563
    {
N
Niels 已提交
2564 2565 2566
        assert(first.m_object != nullptr);
        assert(last.m_object != nullptr);

N
Niels 已提交
2567
        // make sure iterator fits the current value
N
Niels 已提交
2568
        if (first.m_object != last.m_object)
N
Niels 已提交
2569
        {
2570
            JSON_THROW(invalid_iterator::create(201, "iterators are not compatible"));
N
Niels 已提交
2571 2572
        }

N
Niels 已提交
2573 2574 2575
        // copy type from first iterator
        m_type = first.m_object->m_type;

N
Niels 已提交
2576
        // check if iterator range is complete for primitive values
N
Niels 已提交
2577 2578 2579
        switch (m_type)
        {
            case value_t::boolean:
2580 2581
            case value_t::number_float:
            case value_t::number_integer:
2582
            case value_t::number_unsigned:
N
Niels 已提交
2583 2584
            case value_t::string:
            {
2585
                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
N
Niels 已提交
2586
                {
2587
                    JSON_THROW(invalid_iterator::create(204, "iterators out of range"));
N
Niels 已提交
2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604
                }
                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 已提交
2605

2606 2607 2608 2609 2610
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = first.m_object->m_value.number_unsigned;
                break;
            }
N
Niels 已提交
2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625

            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 已提交
2626
                m_value = *first.m_object->m_value.string;
N
Niels 已提交
2627 2628 2629 2630 2631
                break;
            }

            case value_t::object:
            {
N
Niels Lohmann 已提交
2632 2633
                m_value.object = create<object_t>(first.m_it.object_iterator,
                                                  last.m_it.object_iterator);
N
Niels 已提交
2634 2635 2636 2637 2638
                break;
            }

            case value_t::array:
            {
N
Niels Lohmann 已提交
2639 2640
                m_value.array = create<array_t>(first.m_it.array_iterator,
                                                last.m_it.array_iterator);
N
Niels 已提交
2641 2642 2643 2644 2645
                break;
            }

            default:
            {
2646 2647
                JSON_THROW(invalid_iterator::create(206, "cannot construct with iterators from " +
                                                    first.m_object->type_name()));
N
Niels 已提交
2648 2649
            }
        }
2650 2651

        assert_invariant();
N
Niels 已提交
2652 2653
    }

N
Niels 已提交
2654

N
Niels 已提交
2655 2656 2657 2658
    ///////////////////////////////////////
    // other constructors and destructor //
    ///////////////////////////////////////

N
Niels 已提交
2659 2660
    /*!
    @brief copy constructor
N
Niels 已提交
2661

N
Niels 已提交
2662 2663
    Creates a copy of a given JSON value.

N
Niels 已提交
2664
    @param[in] other  the JSON value to copy
N
Niels 已提交
2665 2666 2667

    @complexity Linear in the size of @a other.

N
Niels 已提交
2668 2669 2670
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2671 2672 2673 2674
    - The complexity is linear.
    - As postcondition, it holds: `other == basic_json(other)`.

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

N
Niels 已提交
2677
    @since version 1.0.0
N
Niels 已提交
2678
    */
N
Niels 已提交
2679
    basic_json(const basic_json& other)
N
Niels 已提交
2680 2681
        : m_type(other.m_type)
    {
2682 2683 2684
        // check of passed value is valid
        other.assert_invariant();

N
Niels 已提交
2685 2686
        switch (m_type)
        {
2687
            case value_t::object:
N
Niels 已提交
2688
            {
N
Niels 已提交
2689
                m_value = *other.m_value.object;
N
Niels 已提交
2690 2691
                break;
            }
N
Niels 已提交
2692

2693
            case value_t::array:
N
Niels 已提交
2694
            {
N
Niels 已提交
2695
                m_value = *other.m_value.array;
N
Niels 已提交
2696 2697
                break;
            }
N
Niels 已提交
2698

2699
            case value_t::string:
N
Niels 已提交
2700
            {
N
Niels 已提交
2701
                m_value = *other.m_value.string;
N
Niels 已提交
2702 2703
                break;
            }
N
Niels 已提交
2704

2705
            case value_t::boolean:
N
Niels 已提交
2706
            {
N
Niels 已提交
2707
                m_value = other.m_value.boolean;
N
Niels 已提交
2708 2709
                break;
            }
N
Niels 已提交
2710

2711
            case value_t::number_integer:
N
Niels 已提交
2712
            {
N
Niels 已提交
2713
                m_value = other.m_value.number_integer;
N
Niels 已提交
2714 2715
                break;
            }
N
Niels 已提交
2716

2717 2718 2719 2720 2721
            case value_t::number_unsigned:
            {
                m_value = other.m_value.number_unsigned;
                break;
            }
N
Niels 已提交
2722

2723
            case value_t::number_float:
N
Niels 已提交
2724
            {
N
Niels 已提交
2725
                m_value = other.m_value.number_float;
N
Niels 已提交
2726 2727
                break;
            }
2728 2729 2730 2731 2732

            default:
            {
                break;
            }
N
Niels 已提交
2733
        }
2734 2735

        assert_invariant();
N
Niels 已提交
2736 2737
    }

N
Niels 已提交
2738 2739 2740 2741 2742 2743 2744
    /*!
    @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 已提交
2745
    @param[in,out] other  value to move to this object
N
Niels 已提交
2746 2747 2748 2749 2750 2751 2752

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

N
Niels 已提交
2754
    @since version 1.0.0
N
Niels 已提交
2755
    */
N
Niels 已提交
2756
    basic_json(basic_json&& other) noexcept
N
Niels 已提交
2757 2758
        : m_type(std::move(other.m_type)),
          m_value(std::move(other.m_value))
N
Niels 已提交
2759
    {
2760 2761 2762
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2763
        // invalidate payload
N
Niels 已提交
2764 2765
        other.m_type = value_t::null;
        other.m_value = {};
2766 2767

        assert_invariant();
N
Niels 已提交
2768 2769
    }

N
Niels 已提交
2770 2771
    /*!
    @brief copy assignment
N
Niels 已提交
2772

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

N
Niels 已提交
2777
    @param[in] other  value to copy from
N
Niels 已提交
2778 2779 2780

    @complexity Linear.

N
Niels 已提交
2781 2782 2783
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2784 2785
    - The complexity is linear.

N
Niels 已提交
2786 2787 2788 2789
    @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 已提交
2790

N
Niels 已提交
2791
    @since version 1.0.0
N
Niels 已提交
2792
    */
N
Niels 已提交
2793
    reference& operator=(basic_json other) noexcept (
N
Niels 已提交
2794 2795 2796 2797
        std::is_nothrow_move_constructible<value_t>::value and
        std::is_nothrow_move_assignable<value_t>::value and
        std::is_nothrow_move_constructible<json_value>::value and
        std::is_nothrow_move_assignable<json_value>::value
T
Théo DELRIEU 已提交
2798
    )
N
Niels 已提交
2799
    {
2800 2801 2802
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2803
        using std::swap;
N
Cleanup  
Niels 已提交
2804 2805
        swap(m_type, other.m_type);
        swap(m_value, other.m_value);
2806 2807

        assert_invariant();
N
Niels 已提交
2808 2809 2810
        return *this;
    }

2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828
    /*!
    @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 已提交
2829

2830 2831 2832 2833 2834 2835 2836 2837 2838
        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 已提交
2839

2840 2841 2842 2843 2844 2845 2846
            case value_t::array:
            {
                AllocatorType<array_t> alloc;
                alloc.destroy(m_value.array);
                alloc.deallocate(m_value.array, 1);
                break;
            }
2847

2848 2849 2850 2851 2852 2853 2854
            case value_t::string:
            {
                AllocatorType<string_t> alloc;
                alloc.destroy(m_value.string);
                alloc.deallocate(m_value.string, 1);
                break;
            }
2855

2856 2857 2858 2859 2860 2861
            default:
            {
                // all other types need no specific destructor
                break;
            }
        }
N
Niels 已提交
2862 2863
    }

N
Niels 已提交
2864
    /// @}
N
Niels 已提交
2865 2866 2867 2868 2869 2870

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

N
Niels 已提交
2871
    /// @name object inspection
N
Niels 已提交
2872
    /// Functions to inspect the type of a JSON value.
N
Niels 已提交
2873 2874
    /// @{

N
Niels 已提交
2875
    /*!
N
Niels 已提交
2876 2877
    @brief serialization

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

N
Niels 已提交
2882
    @param[in] indent If indent is nonnegative, then array elements and object
N
Niels 已提交
2883
    members will be pretty-printed with that indent level. An indent level of
N
Niels 已提交
2884 2885
    `0` will only insert newlines. `-1` (the default) selects the most compact
    representation.
2886 2887
    @param[in] indent_char The character to use for indentation of @a indent is
    greate than `0`. The default is ` ` (space).
N
Niels 已提交
2888

N
Niels 已提交
2889 2890 2891 2892 2893
    @return string containing the serialization of the JSON value

    @complexity Linear.

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

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

2898
    @since version 1.0.0; indentaction character added in version 3.0.0
N
Niels 已提交
2899
    */
2900
    string_t dump(const int indent = -1, const char indent_char = ' ') const
N
Niels 已提交
2901
    {
2902
        string_t result;
2903
        serializer s(output_adapter<char>::create(result), indent_char);
2904

N
Niels 已提交
2905 2906
        if (indent >= 0)
        {
2907
            s.dump(*this, true, static_cast<unsigned int>(indent));
N
Niels 已提交
2908 2909 2910
        }
        else
        {
2911
            s.dump(*this, false, 0);
N
Niels 已提交
2912
        }
N
Niels 已提交
2913

2914
        return result;
N
Niels 已提交
2915 2916
    }

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

    @complexity Constant.

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

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

N
Niels 已提交
2933
    @since version 1.0.0
N
Niels 已提交
2934
    */
N
Niels 已提交
2935
    constexpr value_t type() const noexcept
N
Niels 已提交
2936 2937 2938 2939
    {
        return m_type;
    }

N
Niels 已提交
2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950
    /*!
    @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 已提交
2951 2952 2953
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
2954
    @liveexample{The following code exemplifies `is_primitive()` for all JSON
N
Niels 已提交
2955
    types.,is_primitive}
N
Niels 已提交
2956

N
Niels 已提交
2957 2958 2959 2960 2961 2962
    @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 已提交
2963
    @since version 1.0.0
N
Niels 已提交
2964
    */
N
Niels 已提交
2965
    constexpr bool is_primitive() const noexcept
N
Niels 已提交
2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979
    {
        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 已提交
2980 2981 2982
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

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

N
Niels 已提交
2986 2987 2988 2989
    @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 已提交
2990
    @since version 1.0.0
N
Niels 已提交
2991
    */
N
Niels 已提交
2992
    constexpr bool is_structured() const noexcept
N
Niels 已提交
2993 2994 2995 2996
    {
        return is_array() or is_object();
    }

N
Niels 已提交
2997 2998 2999 3000 3001
    /*!
    @brief return whether value is null

    This function returns true iff the JSON value is null.

N
Niels 已提交
3002
    @return `true` if type is null, `false` otherwise.
N
Niels 已提交
3003 3004 3005

    @complexity Constant.

N
Niels 已提交
3006 3007 3008
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3009
    @liveexample{The following code exemplifies `is_null()` for all JSON
N
Niels 已提交
3010
    types.,is_null}
N
Niels 已提交
3011

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

N
Niels 已提交
3019 3020 3021 3022 3023
    /*!
    @brief return whether value is a boolean

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

N
Niels 已提交
3024
    @return `true` if type is boolean, `false` otherwise.
N
Niels 已提交
3025 3026 3027

    @complexity Constant.

N
Niels 已提交
3028 3029 3030
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3031
    @liveexample{The following code exemplifies `is_boolean()` for all JSON
N
Niels 已提交
3032
    types.,is_boolean}
N
Niels 已提交
3033

N
Niels 已提交
3034
    @since version 1.0.0
N
Niels 已提交
3035
    */
N
Niels 已提交
3036
    constexpr bool is_boolean() const noexcept
N
Niels 已提交
3037 3038 3039 3040
    {
        return m_type == value_t::boolean;
    }

N
Niels 已提交
3041 3042 3043 3044 3045 3046
    /*!
    @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.

3047 3048
    @return `true` if type is number (regardless whether integer, unsigned
    integer or floating-type), `false` otherwise.
N
Niels 已提交
3049 3050 3051

    @complexity Constant.

N
Niels 已提交
3052 3053 3054
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3055
    @liveexample{The following code exemplifies `is_number()` for all JSON
N
Niels 已提交
3056
    types.,is_number}
N
Niels 已提交
3057

N
Niels 已提交
3058
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
3059
    integer number
N
Niels 已提交
3060 3061
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
3062 3063
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
3064
    @since version 1.0.0
N
Niels 已提交
3065
    */
N
Niels 已提交
3066
    constexpr bool is_number() const noexcept
N
Niels 已提交
3067
    {
N
Niels 已提交
3068
        return is_number_integer() or is_number_float();
N
Niels 已提交
3069 3070
    }

N
Niels 已提交
3071 3072 3073
    /*!
    @brief return whether value is an integer number

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

N
Niels 已提交
3077
    @return `true` if type is an integer or unsigned integer number, `false`
3078
    otherwise.
N
Niels 已提交
3079 3080 3081

    @complexity Constant.

N
Niels 已提交
3082 3083 3084
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3085
    @liveexample{The following code exemplifies `is_number_integer()` for all
N
Niels 已提交
3086
    JSON types.,is_number_integer}
N
Niels 已提交
3087 3088

    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
3089 3090
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
3091 3092
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
3093
    @since version 1.0.0
N
Niels 已提交
3094
    */
N
Niels 已提交
3095
    constexpr bool is_number_integer() const noexcept
N
Niels 已提交
3096
    {
3097 3098
        return m_type == value_t::number_integer or m_type == value_t::number_unsigned;
    }
N
Niels 已提交
3099

3100 3101 3102
    /*!
    @brief return whether value is an unsigned integer number

N
Niels 已提交
3103 3104
    This function returns true iff the JSON value is an unsigned integer
    number. This excludes floating-point and (signed) integer values.
3105 3106 3107 3108 3109

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

    @complexity Constant.

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

N
Niels 已提交
3113
    @liveexample{The following code exemplifies `is_number_unsigned()` for all
N
Niels 已提交
3114 3115
    JSON types.,is_number_unsigned}

3116
    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
3117
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
3118 3119 3120 3121 3122
    integer number
    @sa @ref is_number_float() -- check if value is a floating-point number

    @since version 2.0.0
    */
N
Niels 已提交
3123
    constexpr bool is_number_unsigned() const noexcept
3124 3125
    {
        return m_type == value_t::number_unsigned;
N
Niels 已提交
3126 3127
    }

N
Niels 已提交
3128 3129 3130 3131
    /*!
    @brief return whether value is a floating-point number

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

N
Niels 已提交
3134
    @return `true` if type is a floating-point number, `false` otherwise.
N
Niels 已提交
3135 3136 3137

    @complexity Constant.

N
Niels 已提交
3138 3139 3140
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3141
    @liveexample{The following code exemplifies `is_number_float()` for all
N
Niels 已提交
3142
    JSON types.,is_number_float}
N
Niels 已提交
3143 3144 3145

    @sa @ref is_number() -- check if value is number
    @sa @ref is_number_integer() -- check if value is an integer number
N
Niels 已提交
3146 3147
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
3148

N
Niels 已提交
3149
    @since version 1.0.0
N
Niels 已提交
3150
    */
N
Niels 已提交
3151
    constexpr bool is_number_float() const noexcept
N
Niels 已提交
3152 3153 3154 3155
    {
        return m_type == value_t::number_float;
    }

N
Niels 已提交
3156 3157 3158 3159 3160
    /*!
    @brief return whether value is an object

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

N
Niels 已提交
3161
    @return `true` if type is object, `false` otherwise.
N
Niels 已提交
3162 3163 3164

    @complexity Constant.

N
Niels 已提交
3165 3166 3167
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3168
    @liveexample{The following code exemplifies `is_object()` for all JSON
N
Niels 已提交
3169
    types.,is_object}
N
Niels 已提交
3170

N
Niels 已提交
3171
    @since version 1.0.0
N
Niels 已提交
3172
    */
N
Niels 已提交
3173
    constexpr bool is_object() const noexcept
N
Niels 已提交
3174 3175 3176 3177
    {
        return m_type == value_t::object;
    }

N
Niels 已提交
3178 3179 3180 3181 3182
    /*!
    @brief return whether value is an array

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

N
Niels 已提交
3183
    @return `true` if type is array, `false` otherwise.
N
Niels 已提交
3184 3185 3186

    @complexity Constant.

N
Niels 已提交
3187 3188 3189
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3190
    @liveexample{The following code exemplifies `is_array()` for all JSON
N
Niels 已提交
3191
    types.,is_array}
N
Niels 已提交
3192

N
Niels 已提交
3193
    @since version 1.0.0
N
Niels 已提交
3194
    */
N
Niels 已提交
3195
    constexpr bool is_array() const noexcept
N
Niels 已提交
3196 3197 3198 3199
    {
        return m_type == value_t::array;
    }

N
Niels 已提交
3200 3201 3202 3203 3204
    /*!
    @brief return whether value is a string

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

N
Niels 已提交
3205
    @return `true` if type is string, `false` otherwise.
N
Niels 已提交
3206 3207 3208

    @complexity Constant.

N
Niels 已提交
3209 3210 3211
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3212
    @liveexample{The following code exemplifies `is_string()` for all JSON
N
Niels 已提交
3213
    types.,is_string}
N
Niels 已提交
3214

N
Niels 已提交
3215
    @since version 1.0.0
N
Niels 已提交
3216
    */
N
Niels 已提交
3217
    constexpr bool is_string() const noexcept
N
Niels 已提交
3218 3219 3220 3221
    {
        return m_type == value_t::string;
    }

N
Niels 已提交
3222 3223 3224 3225 3226 3227
    /*!
    @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 已提交
3228 3229 3230 3231
    @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 已提交
3232 3233 3234 3235
    @return `true` if type is discarded, `false` otherwise.

    @complexity Constant.

N
Niels 已提交
3236 3237 3238
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3239
    @liveexample{The following code exemplifies `is_discarded()` for all JSON
N
Niels 已提交
3240
    types.,is_discarded}
N
Niels 已提交
3241

N
Niels 已提交
3242
    @since version 1.0.0
N
Niels 已提交
3243
    */
N
Niels 已提交
3244
    constexpr bool is_discarded() const noexcept
N
Niels 已提交
3245 3246 3247 3248
    {
        return m_type == value_t::discarded;
    }

N
Niels 已提交
3249 3250 3251 3252 3253 3254 3255 3256 3257 3258
    /*!
    @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 已提交
3259 3260 3261
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

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

N
Niels 已提交
3265
    @since version 1.0.0
N
Niels 已提交
3266
    */
N
Niels 已提交
3267
    constexpr operator value_t() const noexcept
N
Niels 已提交
3268 3269 3270 3271
    {
        return m_type;
    }

N
Niels 已提交
3272 3273
    /// @}

N
Niels 已提交
3274
  private:
N
Niels Lohmann 已提交
3275 3276 3277 3278
    //////////////////
    // value access //
    //////////////////

N
Niels 已提交
3279
    /// get a boolean (explicit)
3280
    boolean_t get_impl(boolean_t* /*unused*/) const
N
Niels 已提交
3281
    {
3282 3283 3284 3285
        if (is_boolean())
        {
            return m_value.boolean;
        }
N
Niels Lohmann 已提交
3286

3287
        JSON_THROW(type_error::create(302, "type must be boolean, but is " + type_name()));
N
Niels 已提交
3288 3289
    }

N
Niels 已提交
3290
    /// get a pointer to the value (object)
N
Niels Lohmann 已提交
3291
    object_t* get_impl_ptr(object_t* /*unused*/) noexcept
N
Niels 已提交
3292 3293 3294 3295
    {
        return is_object() ? m_value.object : nullptr;
    }

N
Niels 已提交
3296
    /// get a pointer to the value (object)
N
Niels Lohmann 已提交
3297
    constexpr const object_t* get_impl_ptr(const object_t* /*unused*/) const noexcept
N
Niels 已提交
3298 3299 3300 3301 3302
    {
        return is_object() ? m_value.object : nullptr;
    }

    /// get a pointer to the value (array)
N
Niels Lohmann 已提交
3303
    array_t* get_impl_ptr(array_t* /*unused*/) noexcept
N
Niels 已提交
3304 3305 3306 3307
    {
        return is_array() ? m_value.array : nullptr;
    }

N
Niels 已提交
3308
    /// get a pointer to the value (array)
N
Niels Lohmann 已提交
3309
    constexpr const array_t* get_impl_ptr(const array_t* /*unused*/) const noexcept
N
Niels 已提交
3310 3311 3312 3313 3314
    {
        return is_array() ? m_value.array : nullptr;
    }

    /// get a pointer to the value (string)
N
Niels Lohmann 已提交
3315
    string_t* get_impl_ptr(string_t* /*unused*/) noexcept
N
Niels 已提交
3316 3317 3318 3319 3320
    {
        return is_string() ? m_value.string : nullptr;
    }

    /// get a pointer to the value (string)
N
Niels Lohmann 已提交
3321
    constexpr const string_t* get_impl_ptr(const string_t* /*unused*/) const noexcept
N
Niels 已提交
3322 3323 3324 3325 3326
    {
        return is_string() ? m_value.string : nullptr;
    }

    /// get a pointer to the value (boolean)
N
Niels Lohmann 已提交
3327
    boolean_t* get_impl_ptr(boolean_t* /*unused*/) noexcept
N
Niels 已提交
3328 3329 3330 3331 3332
    {
        return is_boolean() ? &m_value.boolean : nullptr;
    }

    /// get a pointer to the value (boolean)
N
Niels Lohmann 已提交
3333
    constexpr const boolean_t* get_impl_ptr(const boolean_t* /*unused*/) const noexcept
N
Niels 已提交
3334 3335 3336 3337 3338
    {
        return is_boolean() ? &m_value.boolean : nullptr;
    }

    /// get a pointer to the value (integer number)
N
Niels Lohmann 已提交
3339
    number_integer_t* get_impl_ptr(number_integer_t* /*unused*/) noexcept
N
Niels 已提交
3340 3341 3342 3343 3344
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }

    /// get a pointer to the value (integer number)
N
Niels Lohmann 已提交
3345
    constexpr const number_integer_t* get_impl_ptr(const number_integer_t* /*unused*/) const noexcept
N
Niels 已提交
3346 3347 3348
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }
N
Niels 已提交
3349

3350
    /// get a pointer to the value (unsigned number)
N
Niels Lohmann 已提交
3351
    number_unsigned_t* get_impl_ptr(number_unsigned_t* /*unused*/) noexcept
3352 3353 3354
    {
        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
    }
N
Niels 已提交
3355

3356
    /// get a pointer to the value (unsigned number)
N
Niels Lohmann 已提交
3357
    constexpr const number_unsigned_t* get_impl_ptr(const number_unsigned_t* /*unused*/) const noexcept
3358 3359 3360
    {
        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
    }
N
Niels 已提交
3361

N
Niels 已提交
3362
    /// get a pointer to the value (floating-point number)
N
Niels Lohmann 已提交
3363
    number_float_t* get_impl_ptr(number_float_t* /*unused*/) noexcept
N
Niels 已提交
3364 3365 3366 3367 3368
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

    /// get a pointer to the value (floating-point number)
N
Niels Lohmann 已提交
3369
    constexpr const number_float_t* get_impl_ptr(const number_float_t* /*unused*/) const noexcept
N
Niels 已提交
3370 3371 3372 3373
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

N
Niels 已提交
3374 3375 3376 3377 3378 3379 3380 3381
    /*!
    @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`

3382
    @throw type_error.303 if ReferenceType does not match underlying value
N
Niels 已提交
3383 3384 3385
    type of the current JSON
    */
    template<typename ReferenceType, typename ThisType>
3386
    static ReferenceType get_ref_impl(ThisType& obj)
D
dariomt 已提交
3387
    {
N
Niels 已提交
3388
        // helper type
N
Niels 已提交
3389 3390
        using PointerType = typename std::add_pointer<ReferenceType>::type;

N
Niels 已提交
3391
        // delegate the call to get_ptr<>()
3392 3393 3394 3395 3396 3397
        auto ptr = obj.template get_ptr<PointerType>();

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

3399
        JSON_THROW(type_error::create(303, "incompatible ReferenceType for get_ref, actual type is " + obj.type_name()));
D
dariomt 已提交
3400 3401
    }

N
Niels 已提交
3402
  public:
N
Niels Lohmann 已提交
3403 3404 3405 3406
    /// @name value access
    /// Direct access to the stored value of a JSON value.
    /// @{

T
Théo DELRIEU 已提交
3407 3408 3409
    /*!
    @brief get special-case overload

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

N
Niels Lohmann 已提交
3413
    @tparam BasicJsonType == @ref basic_json
T
Théo DELRIEU 已提交
3414 3415 3416 3417 3418 3419 3420

    @return a copy of *this

    @complexity Constant.

    @since version 2.1.0
    */
3421
    template <
N
Niels Lohmann 已提交
3422 3423
        typename BasicJsonType,
        detail::enable_if_t<std::is_same<typename std::remove_const<BasicJsonType>::type,
3424 3425
                                         basic_json_t>::value,
                            int> = 0 >
3426 3427
    basic_json get() const
    {
T
Théo DELRIEU 已提交
3428
        return *this;
3429 3430
    }

T
Théo DELRIEU 已提交
3431
    /*!
N
Niels Lohmann 已提交
3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445
    @brief get a value (explicit)

    Explicit type conversion between the JSON value and a compatible value
    which is [CopyConstructible](http://en.cppreference.com/w/cpp/concept/CopyConstructible)
    and [DefaultConstructible](http://en.cppreference.com/w/cpp/concept/DefaultConstructible).
    The value is converted by calling the @ref json_serializer<ValueType>
    `from_json()` method.

    The function is equivalent to executing
    @code {.cpp}
    ValueType ret;
    JSONSerializer<ValueType>::from_json(*this, ret);
    return ret;
    @endcode
T
Théo DELRIEU 已提交
3446 3447

    This overloads is chosen if:
N
Niels Lohmann 已提交
3448 3449
    - @a ValueType is not @ref basic_json,
    - @ref json_serializer<ValueType> has a `from_json()` method of the form
郭荣飞 已提交
3450
      `void from_json(const basic_json&, ValueType&)`, and
N
Niels Lohmann 已提交
3451
    - @ref json_serializer<ValueType> does not have a `from_json()` method of
郭荣飞 已提交
3452
      the form `ValueType from_json(const basic_json&)`
N
Niels Lohmann 已提交
3453 3454 3455

    @tparam ValueTypeCV the provided value type
    @tparam ValueType the returned value type
T
Théo DELRIEU 已提交
3456

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

N
Niels Lohmann 已提交
3459 3460 3461 3462 3463 3464 3465 3466
    @throw what @ref json_serializer<ValueType> `from_json()` method throws

    @liveexample{The example below shows several conversions from JSON values
    to other types. There a few things to note: (1) Floating-point numbers can
    be converted to integers\, (2) A JSON array can be converted to a standard
    `std::vector<short>`\, (3) A JSON object can be converted to C++
    associative containers such as `std::unordered_map<std::string\,
    json>`.,get__ValueType_const}
T
Théo DELRIEU 已提交
3467 3468 3469

    @since version 2.1.0
    */
T
Théo DELRIEU 已提交
3470
    template <
N
Niels Lohmann 已提交
3471 3472
        typename ValueTypeCV,
        typename ValueType = detail::uncvref_t<ValueTypeCV>,
3473
        detail::enable_if_t <
N
Niels Lohmann 已提交
3474 3475 3476
            not std::is_same<basic_json_t, ValueType>::value and
            detail::has_from_json<basic_json_t, ValueType>::value and
            not detail::has_non_default_from_json<basic_json_t, ValueType>::value,
T
Théo DELRIEU 已提交
3477
            int > = 0 >
N
Niels Lohmann 已提交
3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490
    ValueType get() const noexcept(noexcept(
                                       JSONSerializer<ValueType>::from_json(std::declval<const basic_json_t&>(), std::declval<ValueType&>())))
    {
        // we cannot static_assert on ValueTypeCV being non-const, because
        // there is support for get<const basic_json_t>(), which is why we
        // still need the uncvref
        static_assert(not std::is_reference<ValueTypeCV>::value,
                      "get() cannot be used with reference types, you might want to use get_ref()");
        static_assert(std::is_default_constructible<ValueType>::value,
                      "types must be DefaultConstructible when used with get()");

        ValueType ret;
        JSONSerializer<ValueType>::from_json(*this, ret);
T
Théo DELRIEU 已提交
3491
        return ret;
3492
    }
3493

T
Théo DELRIEU 已提交
3494
    /*!
N
Niels Lohmann 已提交
3495 3496 3497 3498 3499 3500 3501
    @brief get a value (explicit); special case

    Explicit type conversion between the JSON value and a compatible value
    which is **not** [CopyConstructible](http://en.cppreference.com/w/cpp/concept/CopyConstructible)
    and **not** [DefaultConstructible](http://en.cppreference.com/w/cpp/concept/DefaultConstructible).
    The value is converted by calling the @ref json_serializer<ValueType>
    `from_json()` method.
T
Théo DELRIEU 已提交
3502

N
Niels Lohmann 已提交
3503 3504 3505 3506
    The function is equivalent to executing
    @code {.cpp}
    return JSONSerializer<ValueTypeCV>::from_json(*this);
    @endcode
T
Théo DELRIEU 已提交
3507 3508

    This overloads is chosen if:
N
Niels Lohmann 已提交
3509 3510
    - @a ValueType is not @ref basic_json and
    - @ref json_serializer<ValueType> has a `from_json()` method of the form
郭荣飞 已提交
3511
      `ValueType from_json(const basic_json&)`
N
Niels Lohmann 已提交
3512 3513 3514 3515 3516 3517

    @note If @ref json_serializer<ValueType> has both overloads of
    `from_json()`, this one is chosen.

    @tparam ValueTypeCV the provided value type
    @tparam ValueType the returned value type
T
Théo DELRIEU 已提交
3518

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

N
Niels Lohmann 已提交
3521
    @throw what @ref json_serializer<ValueType> `from_json()` method throws
T
Théo DELRIEU 已提交
3522 3523 3524

    @since version 2.1.0
    */
3525
    template <
N
Niels Lohmann 已提交
3526 3527 3528
        typename ValueTypeCV,
        typename ValueType = detail::uncvref_t<ValueTypeCV>,
        detail::enable_if_t<not std::is_same<basic_json_t, ValueType>::value and
3529
                            detail::has_non_default_from_json<basic_json_t,
N
Niels Lohmann 已提交
3530 3531 3532
                                    ValueType>::value, int> = 0 >
    ValueType get() const noexcept(noexcept(
                                       JSONSerializer<ValueTypeCV>::from_json(std::declval<const basic_json_t&>())))
3533
    {
N
Niels Lohmann 已提交
3534 3535 3536
        static_assert(not std::is_reference<ValueTypeCV>::value,
                      "get() cannot be used with reference types, you might want to use get_ref()");
        return JSONSerializer<ValueTypeCV>::from_json(*this);
3537 3538
    }

N
Niels 已提交
3539 3540 3541 3542 3543 3544
    /*!
    @brief get a pointer value (explicit)

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

N
Niels 已提交
3545 3546
    @warning The pointer becomes invalid if the underlying JSON object
    changes.
N
Niels 已提交
3547 3548

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

N
Niels 已提交
3552 3553
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
3554 3555 3556 3557 3558 3559 3560 3561 3562

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

N
Niels 已提交
3564
    @since version 1.0.0
N
Niels 已提交
3565
    */
N
Niels 已提交
3566 3567
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3568 3569 3570 3571 3572 3573 3574 3575 3576 3577
    PointerType get() noexcept
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

    /*!
    @brief get a pointer value (explicit)
    @copydoc get()
    */
N
Niels 已提交
3578 3579
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3580
    constexpr const PointerType get() const noexcept
N
Niels 已提交
3581 3582 3583 3584 3585 3586 3587 3588
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

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

N
Niels 已提交
3589
    Implicit pointer access to the internally stored JSON value. No copies are
N
Niels 已提交
3590 3591 3592 3593 3594 3595
    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 已提交
3596
    object_t, @ref string_t, @ref boolean_t, @ref number_integer_t,
N
Niels 已提交
3597 3598
    @ref number_unsigned_t, or @ref number_float_t. Enforced by a static
    assertion.
N
Niels 已提交
3599

N
Niels 已提交
3600 3601
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
3602 3603 3604 3605 3606 3607 3608

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

N
Niels 已提交
3610
    @since version 1.0.0
N
Niels 已提交
3611
    */
N
Niels 已提交
3612 3613
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3614 3615
    PointerType get_ptr() noexcept
    {
N
Niels 已提交
3616 3617
        // get the type of the PointerType (remove pointer and const)
        using pointee_t = typename std::remove_const<typename
T
Théo DELRIEU 已提交
3618 3619
                          std::remove_pointer<typename
                          std::remove_const<PointerType>::type>::type>::type;
N
Niels 已提交
3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630
        // 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 已提交
3631 3632 3633 3634 3635 3636 3637 3638
        // 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 已提交
3639 3640 3641
    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 已提交
3642
    constexpr const PointerType get_ptr() const noexcept
N
Niels 已提交
3643
    {
N
Niels 已提交
3644 3645
        // get the type of the PointerType (remove pointer and const)
        using pointee_t = typename std::remove_const<typename
T
Théo DELRIEU 已提交
3646 3647
                          std::remove_pointer<typename
                          std::remove_const<PointerType>::type>::type>::type;
N
Niels 已提交
3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658
        // 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 已提交
3659
        // delegate the call to get_impl_ptr<>() const
D
dariomt 已提交
3660
        return get_impl_ptr(static_cast<const PointerType>(nullptr));
D
dariomt 已提交
3661 3662
    }

N
Niels 已提交
3663
    /*!
D
dariomt 已提交
3664 3665
    @brief get a reference value (implicit)

N
Niels Lohmann 已提交
3666
    Implicit reference access to the internally stored JSON value. No copies
N
Niels 已提交
3667
    are made.
D
dariomt 已提交
3668 3669 3670 3671

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

N
Niels 已提交
3672 3673
    @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 已提交
3674
    @ref number_float_t. Enforced by static assertion.
D
dariomt 已提交
3675

N
Niels 已提交
3676 3677
    @return reference to the internally stored JSON value if the requested
    reference type @a ReferenceType fits to the JSON value; throws
3678
    type_error.303 otherwise
D
dariomt 已提交
3679

3680
    @throw type_error.303 in case passed type @a ReferenceType is incompatible
3681
    with the stored JSON value; see example below
D
dariomt 已提交
3682 3683

    @complexity Constant.
N
Niels 已提交
3684 3685 3686

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

N
Niels 已提交
3687
    @since version 1.1.0
D
dariomt 已提交
3688
    */
N
Niels 已提交
3689 3690
    template<typename ReferenceType, typename std::enable_if<
                 std::is_reference<ReferenceType>::value, int>::type = 0>
D
dariomt 已提交
3691 3692
    ReferenceType get_ref()
    {
N
Niels 已提交
3693 3694
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
D
dariomt 已提交
3695 3696 3697 3698 3699 3700
    }

    /*!
    @brief get a reference value (implicit)
    @copydoc get_ref()
    */
N
Niels 已提交
3701 3702 3703
    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>
3704
    ReferenceType get_ref() const
D
dariomt 已提交
3705
    {
N
Niels 已提交
3706 3707
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
N
Niels 已提交
3708 3709 3710 3711 3712
    }

    /*!
    @brief get a value (implicit)

N
Niels 已提交
3713 3714
    Implicit type conversion between the JSON value and a compatible value.
    The call is realized by calling @ref get() const.
N
Niels 已提交
3715 3716 3717

    @tparam ValueType non-pointer type compatible to the JSON value, for
    instance `int` for JSON integer numbers, `bool` for JSON booleans, or
N
Niels 已提交
3718 3719 3720
    `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 已提交
3721 3722 3723

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

N
Niels Lohmann 已提交
3724
    @throw type_error.302 in case passed type @a ValueType is incompatible
3725 3726
    to the JSON value type (e.g., the JSON value is of type boolean, but a
    string is requested); see example below
N
Niels 已提交
3727 3728 3729

    @complexity Linear in the size of the JSON value.

N
Niels 已提交
3730
    @liveexample{The example below shows several conversions from JSON values
N
Niels 已提交
3731 3732 3733
    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 已提交
3734
    associative containers such as `std::unordered_map<std::string\,
N
Niels 已提交
3735
    json>`.,operator__ValueType}
N
Niels 已提交
3736

N
Niels 已提交
3737
    @since version 1.0.0
N
Niels 已提交
3738
    */
N
Niels 已提交
3739 3740 3741
    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 已提交
3742
#ifndef _MSC_VER  // fix for issue #167 operator<< ambiguity under VS2015
N
Niels 已提交
3743
                   and not std::is_same<ValueType, std::initializer_list<typename string_t::value_type>>::value
N
Niels Lohmann 已提交
3744
#endif
3745
#if (defined(__cplusplus) && __cplusplus >= 201703L) || (defined(_MSC_VER) && _MSC_VER >1900 && defined(_HAS_CXX17) && _HAS_CXX17 == 1) // fix for issue #464
N
Niels Lohmann 已提交
3746
                   and not std::is_same<ValueType, typename std::string_view>::value
3747
#endif
N
Niels 已提交
3748
                   , int >::type = 0 >
N
Niels 已提交
3749
    operator ValueType() const
N
Niels 已提交
3750
    {
N
Niels 已提交
3751 3752
        // delegate the call to get<>() const
        return get<ValueType>();
N
Niels 已提交
3753 3754
    }

N
Niels 已提交
3755 3756
    /// @}

N
Niels 已提交
3757 3758 3759 3760 3761

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

N
Niels 已提交
3762
    /// @name element access
N
Niels 已提交
3763
    /// Access to the JSON value.
N
Niels 已提交
3764 3765
    /// @{

N
Niels 已提交
3766 3767 3768 3769 3770 3771 3772 3773 3774 3775
    /*!
    @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

3776
    @throw type_error.304 if the JSON value is not an array; in this case,
3777
    calling `at` with an index makes no sense. See example below.
3778
    @throw out_of_range.401 if the index @a idx is out of range of the array;
3779
    that is, `idx >= size()`. See example below.
N
Niels 已提交
3780

3781 3782
    @exceptionsafety Strong guarantee: if an exception is thrown, there are no
    changes in the JSON value.
N
Niels 已提交
3783

3784
    @complexity Constant.
N
Niels 已提交
3785

N
Niels 已提交
3786
    @since version 1.0.0
3787 3788 3789 3790

    @liveexample{The example below shows how array elements can be read and
    written using `at()`. It also demonstrates the different exceptions that
    can be thrown.,at__size_type}
N
Niels 已提交
3791
    */
N
Niels 已提交
3792
    reference at(size_type idx)
N
Niels 已提交
3793 3794
    {
        // at only works for arrays
3795 3796
        if (is_array())
        {
3797
            JSON_TRY
N
Niels 已提交
3798 3799 3800
            {
                return m_value.array->at(idx);
            }
3801
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3802 3803
            {
                // create better exception explanation
3804
                JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
3805
            }
3806 3807
        }
        else
N
Niels 已提交
3808
        {
3809
            JSON_THROW(type_error::create(304, "cannot use at() with " + type_name()));
N
Niels 已提交
3810 3811 3812
        }
    }

N
Niels 已提交
3813 3814 3815
    /*!
    @brief access specified array element with bounds checking

N
Niels 已提交
3816 3817
    Returns a const reference to the element at specified location @a idx,
    with bounds checking.
N
Niels 已提交
3818 3819 3820 3821 3822

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

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

3823
    @throw type_error.304 if the JSON value is not an array; in this case,
3824
    calling `at` with an index makes no sense. See example below.
3825
    @throw out_of_range.401 if the index @a idx is out of range of the array;
3826
    that is, `idx >= size()`. See example below.
N
Niels 已提交
3827

3828 3829
    @exceptionsafety Strong guarantee: if an exception is thrown, there are no
    changes in the JSON value.
N
Niels 已提交
3830

3831
    @complexity Constant.
N
Niels 已提交
3832

N
Niels 已提交
3833
    @since version 1.0.0
3834 3835 3836 3837

    @liveexample{The example below shows how array elements can be read using
    `at()`. It also demonstrates the different exceptions that can be thrown.,
    at__size_type_const}
N
Niels 已提交
3838
    */
N
Niels 已提交
3839
    const_reference at(size_type idx) const
N
Niels 已提交
3840 3841
    {
        // at only works for arrays
3842 3843
        if (is_array())
        {
3844
            JSON_TRY
N
Niels 已提交
3845 3846 3847
            {
                return m_value.array->at(idx);
            }
3848
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3849 3850
            {
                // create better exception explanation
3851
                JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
3852
            }
3853 3854
        }
        else
N
Niels 已提交
3855
        {
3856
            JSON_THROW(type_error::create(304, "cannot use at() with " + type_name()));
N
Niels 已提交
3857
        }
3858 3859
    }

N
Niels 已提交
3860 3861 3862 3863 3864 3865 3866 3867 3868 3869
    /*!
    @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

3870
    @throw type_error.304 if the JSON value is not an object; in this case,
3871
    calling `at` with a key makes no sense. See example below.
3872
    @throw out_of_range.403 if the key @a key is is not stored in the object;
3873
    that is, `find(key) == end()`. See example below.
N
Niels 已提交
3874

3875 3876
    @exceptionsafety Strong guarantee: if an exception is thrown, there are no
    changes in the JSON value.
N
Niels 已提交
3877

3878
    @complexity Logarithmic in the size of the container.
N
Niels 已提交
3879 3880 3881 3882

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

N
Niels 已提交
3884
    @since version 1.0.0
3885 3886 3887 3888

    @liveexample{The example below shows how object elements can be read and
    written using `at()`. It also demonstrates the different exceptions that
    can be thrown.,at__object_t_key_type}
N
Niels 已提交
3889
    */
N
Niels 已提交
3890
    reference at(const typename object_t::key_type& key)
3891 3892
    {
        // at only works for objects
3893 3894
        if (is_object())
        {
3895
            JSON_TRY
N
Niels 已提交
3896 3897 3898
            {
                return m_value.object->at(key);
            }
3899
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3900 3901
            {
                // create better exception explanation
3902
                JSON_THROW(out_of_range::create(403, "key '" + key + "' not found"));
N
Niels 已提交
3903
            }
3904 3905
        }
        else
3906
        {
3907
            JSON_THROW(type_error::create(304, "cannot use at() with " + type_name()));
3908 3909 3910
        }
    }

N
Niels 已提交
3911 3912 3913
    /*!
    @brief access specified object element with bounds checking

N
Niels 已提交
3914 3915
    Returns a const reference to the element at with specified key @a key,
    with bounds checking.
N
Niels 已提交
3916 3917 3918 3919 3920

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

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

3921
    @throw type_error.304 if the JSON value is not an object; in this case,
3922
    calling `at` with a key makes no sense. See example below.
3923
    @throw out_of_range.403 if the key @a key is is not stored in the object;
3924
    that is, `find(key) == end()`. See example below.
N
Niels 已提交
3925

3926 3927
    @exceptionsafety Strong guarantee: if an exception is thrown, there are no
    changes in the JSON value.
N
Niels 已提交
3928

3929
    @complexity Logarithmic in the size of the container.
N
Niels 已提交
3930 3931 3932 3933

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

N
Niels 已提交
3935
    @since version 1.0.0
3936 3937 3938 3939

    @liveexample{The example below shows how object elements can be read using
    `at()`. It also demonstrates the different exceptions that can be thrown.,
    at__object_t_key_type_const}
N
Niels 已提交
3940
    */
N
Niels 已提交
3941
    const_reference at(const typename object_t::key_type& key) const
3942 3943
    {
        // at only works for objects
3944 3945
        if (is_object())
        {
3946
            JSON_TRY
N
Niels 已提交
3947 3948 3949
            {
                return m_value.object->at(key);
            }
3950
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3951 3952
            {
                // create better exception explanation
3953
                JSON_THROW(out_of_range::create(403, "key '" + key + "' not found"));
N
Niels 已提交
3954
            }
3955 3956
        }
        else
3957
        {
3958
            JSON_THROW(type_error::create(304, "cannot use at() with " + type_name()));
3959
        }
N
Niels 已提交
3960 3961
    }

N
Niels 已提交
3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974
    /*!
    @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

3975 3976
    @throw type_error.305 if the JSON value is not an array or null; in that
    cases, using the [] operator with an index makes no sense.
N
Niels 已提交
3977 3978 3979 3980 3981

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

N
Niels 已提交
3985
    @since version 1.0.0
N
Niels 已提交
3986
    */
N
Niels 已提交
3987
    reference operator[](size_type idx)
N
Niels 已提交
3988
    {
N
Niels 已提交
3989
        // implicitly convert null value to an empty array
N
cleanup  
Niels 已提交
3990
        if (is_null())
N
Niels 已提交
3991 3992
        {
            m_type = value_t::array;
N
Cleanup  
Niels 已提交
3993
            m_value.array = create<array_t>();
3994
            assert_invariant();
N
Niels 已提交
3995 3996
        }

N
Niels 已提交
3997
        // operator[] only works for arrays
N
cleanup  
Niels 已提交
3998
        if (is_array())
N
Niels 已提交
3999
        {
N
Niels 已提交
4000 4001
            // fill up array with null values if given idx is outside range
            if (idx >= m_value.array->size())
N
cleanup  
Niels 已提交
4002
            {
N
Niels 已提交
4003 4004 4005
                m_value.array->insert(m_value.array->end(),
                                      idx - m_value.array->size() + 1,
                                      basic_json());
N
cleanup  
Niels 已提交
4006
            }
N
Niels 已提交
4007

N
cleanup  
Niels 已提交
4008 4009
            return m_value.array->operator[](idx);
        }
N
Niels Lohmann 已提交
4010

4011
        JSON_THROW(type_error::create(305, "cannot use operator[] with " + type_name()));
N
Niels 已提交
4012 4013
    }

N
Niels 已提交
4014 4015 4016 4017 4018 4019 4020 4021 4022
    /*!
    @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

4023 4024
    @throw type_error.305 if the JSON value is not an array; in that cases,
    using the [] operator with an index makes no sense.
N
Niels 已提交
4025 4026 4027 4028

    @complexity Constant.

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

N
Niels 已提交
4031
    @since version 1.0.0
N
Niels 已提交
4032
    */
N
Niels 已提交
4033
    const_reference operator[](size_type idx) const
N
Niels 已提交
4034
    {
N
Niels 已提交
4035
        // const operator[] only works for arrays
N
Niels 已提交
4036 4037 4038 4039
        if (is_array())
        {
            return m_value.array->operator[](idx);
        }
N
Niels Lohmann 已提交
4040

4041
        JSON_THROW(type_error::create(305, "cannot use operator[] with " + type_name()));
N
Niels 已提交
4042 4043
    }

N
Niels 已提交
4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056
    /*!
    @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

4057 4058
    @throw type_error.305 if the JSON value is not an object or null; in that
    cases, using the [] operator with a key makes no sense.
N
Niels 已提交
4059 4060 4061 4062

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
4063
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
4064 4065 4066 4067

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

N
Niels 已提交
4069
    @since version 1.0.0
N
Niels 已提交
4070
    */
N
Niels 已提交
4071
    reference operator[](const typename object_t::key_type& key)
N
Niels 已提交
4072
    {
N
Niels 已提交
4073
        // implicitly convert null value to an empty object
N
cleanup  
Niels 已提交
4074
        if (is_null())
N
Niels 已提交
4075 4076
        {
            m_type = value_t::object;
N
Cleanup  
Niels 已提交
4077
            m_value.object = create<object_t>();
4078
            assert_invariant();
N
Niels 已提交
4079 4080
        }

N
Niels 已提交
4081
        // operator[] only works for objects
N
Niels 已提交
4082 4083 4084 4085
        if (is_object())
        {
            return m_value.object->operator[](key);
        }
N
Niels Lohmann 已提交
4086

4087
        JSON_THROW(type_error::create(305, "cannot use operator[] with " + type_name()));
N
Niels 已提交
4088 4089
    }

N
Niels 已提交
4090
    /*!
4091
    @brief read-only access specified object element
N
Niels 已提交
4092

4093 4094 4095 4096 4097
    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 已提交
4098 4099 4100

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

4101
    @return const reference to the element at key @a key
N
Niels 已提交
4102

N
Niels 已提交
4103 4104 4105
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

4106 4107
    @throw type_error.305 if the JSON value is not an object; in that cases,
    using the [] operator with a key makes no sense.
N
Niels 已提交
4108 4109 4110 4111

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
4112
    the `[]` operator.,operatorarray__key_type_const}
4113 4114 4115 4116 4117

    @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 已提交
4118
    @since version 1.0.0
N
Niels 已提交
4119
    */
N
Niels 已提交
4120
    const_reference operator[](const typename object_t::key_type& key) const
4121
    {
N
Niels 已提交
4122
        // const operator[] only works for objects
N
Niels 已提交
4123 4124 4125 4126 4127
        if (is_object())
        {
            assert(m_value.object->find(key) != m_value.object->end());
            return m_value.object->find(key)->second;
        }
N
Niels Lohmann 已提交
4128

4129
        JSON_THROW(type_error::create(305, "cannot use operator[] with " + type_name()));
4130 4131
    }

N
Niels 已提交
4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144
    /*!
    @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

4145 4146
    @throw type_error.305 if the JSON value is not an object or null; in that
    cases, using the [] operator with a key makes no sense.
N
Niels 已提交
4147 4148 4149 4150

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
4151
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
4152 4153 4154 4155

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

N
Niels 已提交
4157
    @since version 1.0.0
N
Niels 已提交
4158
    */
N
Niels 已提交
4159
    template<typename T, std::size_t n>
N
Niels 已提交
4160
    reference operator[](T * (&key)[n])
4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179
    {
        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

4180 4181
    @throw type_error.305 if the JSON value is not an object; in that cases,
    using the [] operator with a key makes no sense.
4182 4183 4184 4185

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
4186
    the `[]` operator.,operatorarray__key_type_const}
4187 4188 4189 4190 4191 4192 4193 4194

    @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 已提交
4195
    const_reference operator[](T * (&key)[n]) const
4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212
    {
        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

4213 4214
    @throw type_error.305 if the JSON value is not an object or null; in that
    cases, using the [] operator with a key makes no sense.
4215 4216 4217 4218

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
4219
    written using the `[]` operator.,operatorarray__key_type}
4220 4221 4222 4223 4224

    @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 已提交
4225
    @since version 1.1.0
4226 4227 4228
    */
    template<typename T>
    reference operator[](T* key)
N
Niels 已提交
4229
    {
N
Niels 已提交
4230
        // implicitly convert null to object
N
cleanup  
Niels 已提交
4231
        if (is_null())
N
Niels 已提交
4232 4233
        {
            m_type = value_t::object;
N
Niels 已提交
4234
            m_value = value_t::object;
4235
            assert_invariant();
N
Niels 已提交
4236 4237
        }

N
Niels 已提交
4238
        // at only works for objects
N
Niels 已提交
4239 4240 4241 4242
        if (is_object())
        {
            return m_value.object->operator[](key);
        }
N
Niels Lohmann 已提交
4243

4244
        JSON_THROW(type_error::create(305, "cannot use operator[] with " + type_name()));
N
Niels 已提交
4245 4246
    }

N
Niels 已提交
4247
    /*!
4248
    @brief read-only access specified object element
N
Niels 已提交
4249

4250 4251 4252 4253 4254
    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 已提交
4255 4256 4257

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

4258
    @return const reference to the element at key @a key
N
Niels 已提交
4259

N
Niels 已提交
4260 4261 4262
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

4263 4264
    @throw type_error.305 if the JSON value is not an object; in that cases,
    using the [] operator with a key makes no sense.
N
Niels 已提交
4265 4266 4267 4268

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
4269
    the `[]` operator.,operatorarray__key_type_const}
4270 4271 4272 4273 4274

    @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 已提交
4275
    @since version 1.1.0
N
Niels 已提交
4276
    */
4277 4278
    template<typename T>
    const_reference operator[](T* key) const
4279 4280
    {
        // at only works for objects
N
Niels 已提交
4281 4282 4283 4284 4285
        if (is_object())
        {
            assert(m_value.object->find(key) != m_value.object->end());
            return m_value.object->find(key)->second;
        }
N
Niels Lohmann 已提交
4286

4287
        JSON_THROW(type_error::create(305, "cannot use operator[] with " + type_name()));
4288 4289
    }

N
Niels 已提交
4290 4291 4292
    /*!
    @brief access specified object element with default value

N
Niels 已提交
4293 4294
    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.
4295

N
Niels 已提交
4296
    The function is basically equivalent to executing
4297
    @code {.cpp}
N
Niels 已提交
4298 4299
    try {
        return at(key);
4300
    } catch(out_of_range) {
N
Niels 已提交
4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322
        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

4323 4324
    @throw type_error.306 if the JSON value is not an objec; in that cases,
    using `value()` with a key makes no sense.
N
Niels 已提交
4325 4326 4327 4328 4329 4330 4331 4332 4333 4334

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

N
Niels 已提交
4336
    @since version 1.0.0
N
Niels 已提交
4337
    */
N
Niels 已提交
4338 4339
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350
    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 已提交
4351 4352

            return default_value;
N
Niels 已提交
4353 4354 4355
        }
        else
        {
4356
            JSON_THROW(type_error::create(306, "cannot use value() with " + type_name()));
N
Niels 已提交
4357 4358 4359 4360
        }
    }

    /*!
N
Niels 已提交
4361
    @brief overload for a default value of type const char*
N
Niels 已提交
4362
    @copydoc basic_json::value(const typename object_t::key_type&, ValueType) const
N
Niels 已提交
4363 4364 4365 4366
    */
    string_t value(const typename object_t::key_type& key, const char* default_value) const
    {
        return value(key, string_t(default_value));
4367 4368
    }

N
Niels 已提交
4369 4370 4371
    /*!
    @brief access specified object element via JSON Pointer with default value

N
Niels 已提交
4372 4373 4374 4375 4376 4377 4378
    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);
4379
    } catch(out_of_range) {
N
Niels 已提交
4380 4381 4382 4383 4384 4385 4386
        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 已提交
4387 4388 4389 4390 4391 4392 4393 4394
    @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 已提交
4395 4396 4397
    @return copy of the element at key @a key or @a default_value if @a key
    is not found

4398 4399
    @throw type_error.306 if the JSON value is not an objec; in that cases,
    using `value()` with a key makes no sense.
N
Niels 已提交
4400 4401 4402 4403 4404 4405

    @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 已提交
4406
    @sa @ref operator[](const json_pointer&) for unchecked access by reference
N
Niels 已提交
4407

N
Niels 已提交
4408 4409
    @since version 2.0.2
    */
N
Niels 已提交
4410 4411
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
4412 4413 4414 4415 4416 4417
    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
4418
            JSON_TRY
N
Niels 已提交
4419 4420 4421
            {
                return ptr.get_checked(this);
            }
4422
            JSON_CATCH (out_of_range&)
N
Niels 已提交
4423 4424 4425 4426
            {
                return default_value;
            }
        }
N
Niels Lohmann 已提交
4427

4428
        JSON_THROW(type_error::create(306, "cannot use value() with " + type_name()));
N
Niels 已提交
4429 4430 4431 4432
    }

    /*!
    @brief overload for a default value of type const char*
N
Niels 已提交
4433
    @copydoc basic_json::value(const json_pointer&, ValueType) const
N
Niels 已提交
4434 4435 4436 4437 4438 4439
    */
    string_t value(const json_pointer& ptr, const char* default_value) const
    {
        return value(ptr, string_t(default_value));
    }

N
Niels 已提交
4440 4441 4442 4443 4444 4445
    /*!
    @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 已提交
4446
    @return In case of a structured type (array or object), a reference to the
4447
    first element is returned. In case of number, string, or boolean values, a
N
Niels 已提交
4448 4449 4450 4451
    reference to the value is returned.

    @complexity Constant.

N
Niels 已提交
4452
    @pre The JSON value must not be `null` (would throw `std::out_of_range`)
N
Niels 已提交
4453 4454
    or an empty array or object (undefined behavior, **guarded by
    assertions**).
N
Niels 已提交
4455 4456
    @post The JSON value remains unchanged.

N
Niels Lohmann 已提交
4457
    @throw invalid_iterator.214 when called on `null` value
N
Niels 已提交
4458

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

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

N
Niels 已提交
4463
    @since version 1.0.0
N
Niels 已提交
4464
    */
N
Niels 已提交
4465
    reference front()
N
Niels 已提交
4466 4467 4468 4469
    {
        return *begin();
    }

N
Niels 已提交
4470 4471 4472
    /*!
    @copydoc basic_json::front()
    */
N
Niels 已提交
4473
    const_reference front() const
N
Niels 已提交
4474 4475 4476 4477
    {
        return *cbegin();
    }

N
Niels 已提交
4478 4479 4480 4481
    /*!
    @brief access the last element

    Returns a reference to the last element in the container. For a JSON
N
Niels 已提交
4482 4483 4484 4485 4486 4487
    container `c`, the expression `c.back()` is equivalent to
    @code {.cpp}
    auto tmp = c.end();
    --tmp;
    return *tmp;
    @endcode
N
Niels 已提交
4488

N
Niels 已提交
4489
    @return In case of a structured type (array or object), a reference to the
4490
    last element is returned. In case of number, string, or boolean values, a
N
Niels 已提交
4491 4492 4493 4494
    reference to the value is returned.

    @complexity Constant.

N
Niels 已提交
4495
    @pre The JSON value must not be `null` (would throw `std::out_of_range`)
N
Niels 已提交
4496 4497
    or an empty array or object (undefined behavior, **guarded by
    assertions**).
N
Niels 已提交
4498
    @post The JSON value remains unchanged.
N
Niels 已提交
4499

4500 4501
    @throw invalid_iterator.214 when called on a `null` value. See example
    below.
N
Niels 已提交
4502

N
Niels 已提交
4503 4504 4505
    @liveexample{The following code shows an example for `back()`.,back}

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

N
Niels 已提交
4507
    @since version 1.0.0
N
Niels 已提交
4508
    */
N
Niels 已提交
4509
    reference back()
N
Niels 已提交
4510 4511 4512 4513 4514 4515
    {
        auto tmp = end();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
4516 4517 4518
    /*!
    @copydoc basic_json::back()
    */
N
Niels 已提交
4519
    const_reference back() const
N
Niels 已提交
4520 4521 4522 4523 4524 4525
    {
        auto tmp = cend();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
4526 4527 4528
    /*!
    @brief remove element given an iterator

N
Niels 已提交
4529 4530 4531
    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 已提交
4532

N
Niels 已提交
4533
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
4534 4535 4536
    will be `null`.

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

4540
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
4541

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

4545 4546
    @throw type_error.307 if called on a `null` value; example: `"cannot use
    erase() with null"`
4547 4548 4549
    @throw invalid_iterator.202 if called on an iterator which does not belong
    to the current JSON value; example: `"iterator does not fit current
    value"`
4550
    @throw invalid_iterator.205 if called on a primitive type with invalid
N
Niels 已提交
4551 4552
    iterator (i.e., any iterator which is not `begin()`); example: `"iterator
    out of range"`
N
Niels 已提交
4553 4554 4555

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

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

4563
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4564
    the given range
N
Niels 已提交
4565
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4566
    from an object at the given key
N
Niels 已提交
4567 4568
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4569

N
Niels 已提交
4570
    @since version 1.0.0
N
Niels 已提交
4571
    */
N
Niels 已提交
4572 4573 4574 4575
    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>
4576
    IteratorType erase(IteratorType pos)
4577 4578
    {
        // make sure iterator fits the current value
N
Niels 已提交
4579
        if (this != pos.m_object)
4580
        {
4581
            JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value"));
4582 4583
        }

4584
        IteratorType result = end();
4585 4586 4587 4588

        switch (m_type)
        {
            case value_t::boolean:
4589 4590
            case value_t::number_float:
            case value_t::number_integer:
4591
            case value_t::number_unsigned:
4592 4593
            case value_t::string:
            {
4594
                if (not pos.m_it.primitive_iterator.is_begin())
4595
                {
4596
                    JSON_THROW(invalid_iterator::create(205, "iterator out of range"));
4597 4598
                }

N
cleanup  
Niels 已提交
4599
                if (is_string())
4600
                {
4601 4602 4603
                    AllocatorType<string_t> alloc;
                    alloc.destroy(m_value.string);
                    alloc.deallocate(m_value.string, 1);
4604 4605 4606 4607
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
4608
                assert_invariant();
4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625
                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:
            {
4626
                JSON_THROW(type_error::create(307, "cannot use erase() with " + type_name()));
4627 4628 4629 4630 4631 4632
            }
        }

        return result;
    }

N
Niels 已提交
4633 4634 4635
    /*!
    @brief remove elements given an iterator range

N
Niels 已提交
4636 4637 4638
    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 已提交
4639

N
Niels 已提交
4640
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
4641 4642 4643 4644 4645
    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 已提交
4646
    second refers to the last element, the `end()` iterator is returned.
N
Niels 已提交
4647

4648
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
4649

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

4653 4654
    @throw type_error.307 if called on a `null` value; example: `"cannot use
    erase() with null"`
4655 4656 4657
    @throw invalid_iterator.203 if called on iterators which does not belong
    to the current JSON value; example: `"iterators do not fit current value"`
    @throw invalid_iterator.204 if called on a primitive type with invalid
N
Niels 已提交
4658 4659
    iterators (i.e., if `first != begin()` and `last != end()`); example:
    `"iterators out of range"`
N
Niels 已提交
4660 4661 4662 4663 4664 4665 4666 4667

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

4671
    @sa @ref erase(IteratorType) -- removes the element at a given position
N
Niels 已提交
4672
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4673
    from an object at the given key
N
Niels 已提交
4674 4675
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4676

N
Niels 已提交
4677
    @since version 1.0.0
N
Niels 已提交
4678
    */
N
Niels 已提交
4679 4680 4681 4682
    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>
4683
    IteratorType erase(IteratorType first, IteratorType last)
4684 4685
    {
        // make sure iterator fits the current value
N
Niels 已提交
4686
        if (this != first.m_object or this != last.m_object)
4687
        {
4688
            JSON_THROW(invalid_iterator::create(203, "iterators do not fit current value"));
4689 4690
        }

4691
        IteratorType result = end();
4692 4693 4694 4695

        switch (m_type)
        {
            case value_t::boolean:
4696 4697
            case value_t::number_float:
            case value_t::number_integer:
4698
            case value_t::number_unsigned:
4699 4700
            case value_t::string:
            {
4701
                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
4702
                {
4703
                    JSON_THROW(invalid_iterator::create(204, "iterators out of range"));
4704 4705
                }

N
cleanup  
Niels 已提交
4706
                if (is_string())
4707
                {
4708 4709 4710
                    AllocatorType<string_t> alloc;
                    alloc.destroy(m_value.string);
                    alloc.deallocate(m_value.string, 1);
4711 4712 4713 4714
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
4715
                assert_invariant();
4716 4717 4718 4719 4720 4721
                break;
            }

            case value_t::object:
            {
                result.m_it.object_iterator = m_value.object->erase(first.m_it.object_iterator,
T
Théo DELRIEU 已提交
4722
                                              last.m_it.object_iterator);
4723 4724 4725 4726 4727 4728
                break;
            }

            case value_t::array:
            {
                result.m_it.array_iterator = m_value.array->erase(first.m_it.array_iterator,
T
Théo DELRIEU 已提交
4729
                                             last.m_it.array_iterator);
4730 4731 4732 4733 4734
                break;
            }

            default:
            {
4735
                JSON_THROW(type_error::create(307, "cannot use erase() with " + type_name()));
4736 4737 4738 4739 4740 4741
            }
        }

        return result;
    }

N
Niels 已提交
4742 4743 4744 4745 4746 4747 4748
    /*!
    @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 已提交
4749
    @return Number of elements removed. If @a ObjectType is the default
N
Niels 已提交
4750 4751
    `std::map` type, the return value will always be `0` (@a key was not
    found) or `1` (@a key was found).
N
Niels 已提交
4752 4753 4754

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

4756
    @throw type_error.307 when called on a type other than JSON object;
N
Niels 已提交
4757
    example: `"cannot use erase() with null"`
N
Niels 已提交
4758 4759 4760

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

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

4763 4764
    @sa @ref erase(IteratorType) -- removes the element at a given position
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4765 4766 4767
    the given range
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4768

N
Niels 已提交
4769
    @since version 1.0.0
N
Niels 已提交
4770
    */
N
Niels 已提交
4771
    size_type erase(const typename object_t::key_type& key)
4772
    {
N
Niels 已提交
4773
        // this erase only works for objects
N
Niels 已提交
4774 4775 4776 4777
        if (is_object())
        {
            return m_value.object->erase(key);
        }
N
Niels Lohmann 已提交
4778

4779
        JSON_THROW(type_error::create(307, "cannot use erase() with " + type_name()));
4780 4781
    }

N
Niels 已提交
4782 4783 4784 4785 4786 4787 4788
    /*!
    @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

4789
    @throw type_error.307 when called on a type other than JSON object;
N
Niels 已提交
4790
    example: `"cannot use erase() with null"`
N
Niels Lohmann 已提交
4791
    @throw out_of_range.401 when `idx >= size()`; example: `"array index 17
N
Niels 已提交
4792
    is out of range"`
N
Niels 已提交
4793 4794 4795

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

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

4798 4799
    @sa @ref erase(IteratorType) -- removes the element at a given position
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4800
    the given range
N
Niels 已提交
4801
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4802 4803
    from an object at the given key

N
Niels 已提交
4804
    @since version 1.0.0
N
Niels 已提交
4805
    */
N
Niels 已提交
4806
    void erase(const size_type idx)
N
Niels 已提交
4807 4808
    {
        // this erase only works for arrays
N
cleanup  
Niels 已提交
4809
        if (is_array())
N
Niels 已提交
4810
        {
N
cleanup  
Niels 已提交
4811 4812
            if (idx >= size())
            {
4813
                JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range"));
N
cleanup  
Niels 已提交
4814
            }
N
Niels 已提交
4815

N
cleanup  
Niels 已提交
4816 4817 4818
            m_value.array->erase(m_value.array->begin() + static_cast<difference_type>(idx));
        }
        else
N
Niels 已提交
4819
        {
4820
            JSON_THROW(type_error::create(307, "cannot use erase() with " + type_name()));
N
Niels 已提交
4821 4822 4823
        }
    }

N
Niels 已提交
4824 4825 4826 4827 4828 4829 4830 4831 4832 4833
    /// @}


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

    /// @name lookup
    /// @{

N
Niels 已提交
4834 4835 4836 4837
    /*!
    @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 已提交
4838 4839
    element is not found or the JSON value is not an object, end() is
    returned.
N
Niels 已提交
4840

4841 4842 4843
    @note This method always returns @ref end() when executed on a JSON type
          that is not an object.

N
Niels 已提交
4844 4845 4846
    @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
4847 4848
    element is found or the JSON value is not an object, past-the-end (see
    @ref end()) iterator is returned.
N
Niels 已提交
4849 4850 4851

    @complexity Logarithmic in the size of the JSON object.

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

N
Niels 已提交
4854
    @since version 1.0.0
N
Niels 已提交
4855
    */
N
Niels 已提交
4856
    iterator find(typename object_t::key_type key)
N
Niels 已提交
4857 4858 4859
    {
        auto result = end();

N
cleanup  
Niels 已提交
4860
        if (is_object())
N
Niels 已提交
4861 4862 4863 4864 4865 4866 4867
        {
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4868 4869 4870 4871
    /*!
    @brief find an element in a JSON object
    @copydoc find(typename object_t::key_type)
    */
N
Niels 已提交
4872
    const_iterator find(typename object_t::key_type key) const
N
Niels 已提交
4873 4874 4875
    {
        auto result = cend();

N
cleanup  
Niels 已提交
4876
        if (is_object())
N
Niels 已提交
4877 4878 4879 4880 4881 4882 4883
        {
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4884 4885 4886 4887 4888 4889 4890
    /*!
    @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).

4891 4892 4893
    @note This method always returns `0` when executed on a JSON type that is
          not an object.

N
Niels 已提交
4894 4895 4896 4897 4898 4899 4900
    @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 已提交
4901
    @liveexample{The example shows how `count()` is used.,count}
N
Niels 已提交
4902

N
Niels 已提交
4903
    @since version 1.0.0
N
Niels 已提交
4904
    */
N
Niels 已提交
4905
    size_type count(typename object_t::key_type key) const
4906 4907
    {
        // return 0 for all nonobject types
N
Niels 已提交
4908
        return is_object() ? m_value.object->count(key) : 0;
4909 4910
    }

N
Niels 已提交
4911 4912
    /// @}

N
Niels 已提交
4913

N
Niels 已提交
4914 4915 4916 4917
    ///////////////
    // iterators //
    ///////////////

N
Niels 已提交
4918 4919 4920
    /// @name iterators
    /// @{

N
Niels 已提交
4921 4922
    /*!
    @brief returns an iterator to the first element
N
Niels 已提交
4923 4924 4925 4926 4927 4928 4929 4930 4931

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

N
Niels 已提交
4937 4938 4939 4940 4941
    @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 已提交
4942

N
Niels 已提交
4943
    @since version 1.0.0
N
Niels 已提交
4944
    */
N
Niels 已提交
4945
    iterator begin() noexcept
N
Niels 已提交
4946 4947 4948 4949 4950 4951
    {
        iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4952
    /*!
N
Niels 已提交
4953
    @copydoc basic_json::cbegin()
N
Niels 已提交
4954
    */
N
Niels 已提交
4955
    const_iterator begin() const noexcept
N
Niels 已提交
4956
    {
N
Niels 已提交
4957
        return cbegin();
N
Niels 已提交
4958 4959
    }

N
Niels 已提交
4960 4961
    /*!
    @brief returns a const iterator to the first element
N
Niels 已提交
4962 4963 4964 4965 4966 4967 4968 4969 4970

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

N
Niels 已提交
4977 4978 4979 4980 4981
    @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 已提交
4982

N
Niels 已提交
4983
    @since version 1.0.0
N
Niels 已提交
4984
    */
N
Niels 已提交
4985
    const_iterator cbegin() const noexcept
N
Niels 已提交
4986 4987 4988 4989 4990 4991
    {
        const_iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4992 4993
    /*!
    @brief returns an iterator to one past the last element
N
Niels 已提交
4994 4995 4996 4997 4998 4999 5000 5001 5002

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

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

N
Niels 已提交
5014
    @since version 1.0.0
N
Niels 已提交
5015
    */
N
Niels 已提交
5016
    iterator end() noexcept
N
Niels 已提交
5017 5018 5019 5020 5021 5022
    {
        iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
5023
    /*!
N
Niels 已提交
5024
    @copydoc basic_json::cend()
N
Niels 已提交
5025
    */
N
Niels 已提交
5026
    const_iterator end() const noexcept
N
Niels 已提交
5027
    {
N
Niels 已提交
5028
        return cend();
N
Niels 已提交
5029 5030
    }

N
Niels 已提交
5031 5032
    /*!
    @brief returns a const iterator to one past the last element
N
Niels 已提交
5033 5034 5035 5036 5037 5038 5039 5040 5041

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

N
Niels 已提交
5048 5049 5050 5051 5052
    @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 已提交
5053

N
Niels 已提交
5054
    @since version 1.0.0
N
Niels 已提交
5055
    */
N
Niels 已提交
5056
    const_iterator cend() const noexcept
N
Niels 已提交
5057 5058 5059 5060 5061 5062
    {
        const_iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
5063
    /*!
N
Niels 已提交
5064 5065 5066 5067 5068 5069 5070 5071
    @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 已提交
5072 5073 5074
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
5075 5076 5077
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(end())`.

N
Niels 已提交
5078 5079 5080 5081 5082
    @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 已提交
5083

N
Niels 已提交
5084
    @since version 1.0.0
N
Niels 已提交
5085
    */
N
Niels 已提交
5086
    reverse_iterator rbegin() noexcept
N
Niels 已提交
5087 5088 5089 5090
    {
        return reverse_iterator(end());
    }

N
Niels 已提交
5091
    /*!
N
Niels 已提交
5092
    @copydoc basic_json::crbegin()
N
Niels 已提交
5093
    */
N
Niels 已提交
5094
    const_reverse_iterator rbegin() const noexcept
N
Niels 已提交
5095
    {
N
Niels 已提交
5096
        return crbegin();
N
Niels 已提交
5097 5098
    }

N
Niels 已提交
5099
    /*!
N
Niels 已提交
5100 5101 5102 5103 5104 5105 5106 5107 5108
    @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 已提交
5109 5110 5111
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
5112 5113 5114
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(begin())`.

N
Niels 已提交
5115 5116 5117 5118 5119
    @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 已提交
5120

N
Niels 已提交
5121
    @since version 1.0.0
N
Niels 已提交
5122
    */
N
Niels 已提交
5123
    reverse_iterator rend() noexcept
N
Niels 已提交
5124 5125 5126 5127
    {
        return reverse_iterator(begin());
    }

N
Niels 已提交
5128
    /*!
N
Niels 已提交
5129
    @copydoc basic_json::crend()
N
Niels 已提交
5130
    */
N
Niels 已提交
5131
    const_reverse_iterator rend() const noexcept
N
Niels 已提交
5132
    {
N
Niels 已提交
5133
        return crend();
N
Niels 已提交
5134 5135
    }

N
Niels 已提交
5136
    /*!
N
Niels 已提交
5137 5138 5139 5140 5141 5142 5143 5144 5145
    @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 已提交
5146 5147 5148
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
5149 5150 5151
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).rbegin()`.

N
Niels 已提交
5152 5153 5154 5155 5156
    @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 已提交
5157

N
Niels 已提交
5158
    @since version 1.0.0
N
Niels 已提交
5159
    */
N
Niels 已提交
5160
    const_reverse_iterator crbegin() const noexcept
N
Niels 已提交
5161 5162 5163 5164
    {
        return const_reverse_iterator(cend());
    }

N
Niels 已提交
5165
    /*!
N
Niels 已提交
5166 5167 5168 5169 5170 5171 5172 5173 5174
    @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 已提交
5175 5176 5177
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
5178 5179 5180
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).rend()`.

N
Niels 已提交
5181 5182 5183 5184 5185
    @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 已提交
5186

N
Niels 已提交
5187
    @since version 1.0.0
N
Niels 已提交
5188
    */
N
Niels 已提交
5189
    const_reverse_iterator crend() const noexcept
N
Niels 已提交
5190 5191 5192 5193
    {
        return const_reverse_iterator(cbegin());
    }

N
cleanup  
Niels 已提交
5194 5195 5196 5197 5198 5199 5200 5201
  private:
    // forward declaration
    template<typename IteratorType> class iteration_proxy;

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

N
Niels 已提交
5202
    This function allows to access @ref iterator::key() and @ref
N
Niels 已提交
5203 5204 5205
    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 已提交
5206

5207 5208
    @liveexample{The following code shows how the wrapper is used,iterator_wrapper}

N
cleanup  
Niels 已提交
5209 5210
    @note The name of this function is not yet final and may change in the
    future.
N
cleanup  
Niels 已提交
5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224
    */
    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 已提交
5225 5226
    /// @}

N
Niels 已提交
5227 5228 5229 5230 5231

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

N
Niels 已提交
5232 5233 5234
    /// @name capacity
    /// @{

N
Niels 已提交
5235 5236
    /*!
    @brief checks whether the container is empty
N
Niels 已提交
5237 5238 5239

    Checks if a JSON value has no elements.

N
Niels 已提交
5240
    @return The return value depends on the different types and is
N
Niels 已提交
5241 5242 5243
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
5244 5245 5246 5247 5248 5249
            null        | `true`
            boolean     | `false`
            string      | `false`
            number      | `false`
            object      | result of function `object_t::empty()`
            array       | result of function `array_t::empty()`
N
Niels 已提交
5250

N
Niels 已提交
5251 5252 5253 5254
    @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 已提交
5255 5256
    @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 已提交
5257
    complexity.
N
Niels 已提交
5258

N
Niels 已提交
5259 5260 5261
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
5262 5263 5264
    - The complexity is constant.
    - Has the semantics of `begin() == end()`.

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

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

N
Niels 已提交
5270
    @since version 1.0.0
N
Niels 已提交
5271
    */
N
Niels 已提交
5272
    bool empty() const noexcept
N
Niels 已提交
5273 5274 5275
    {
        switch (m_type)
        {
5276
            case value_t::null:
N
Niels 已提交
5277
            {
N
Niels 已提交
5278
                // null values are empty
N
Niels 已提交
5279 5280
                return true;
            }
N
Niels 已提交
5281

5282
            case value_t::array:
N
Niels 已提交
5283
            {
N
Niels 已提交
5284
                // delegate call to array_t::empty()
N
Niels 已提交
5285 5286
                return m_value.array->empty();
            }
N
Niels 已提交
5287

5288
            case value_t::object:
N
Niels 已提交
5289
            {
N
Niels 已提交
5290
                // delegate call to object_t::empty()
N
Niels 已提交
5291 5292
                return m_value.object->empty();
            }
N
Niels 已提交
5293

N
Niels 已提交
5294 5295 5296 5297 5298 5299
            default:
            {
                // all other types are nonempty
                return false;
            }
        }
N
Niels 已提交
5300 5301
    }

N
Niels 已提交
5302 5303
    /*!
    @brief returns the number of elements
N
Niels 已提交
5304 5305 5306

    Returns the number of elements in a JSON value.

N
Niels 已提交
5307
    @return The return value depends on the different types and is
N
Niels 已提交
5308 5309 5310
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
5311 5312 5313 5314
            null        | `0`
            boolean     | `1`
            string      | `1`
            number      | `1`
N
Niels 已提交
5315 5316 5317
            object      | result of function object_t::size()
            array       | result of function array_t::size()

N
Niels 已提交
5318 5319 5320 5321
    @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 已提交
5322 5323 5324
    @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 已提交
5325

N
Niels 已提交
5326 5327 5328
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
5329 5330 5331
    - The complexity is constant.
    - Has the semantics of `std::distance(begin(), end())`.

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

N
Niels 已提交
5335 5336 5337
    @sa @ref empty() -- checks whether the container is empty
    @sa @ref max_size() -- returns the maximal number of elements

N
Niels 已提交
5338
    @since version 1.0.0
N
Niels 已提交
5339
    */
N
Niels 已提交
5340
    size_type size() const noexcept
N
Niels 已提交
5341 5342 5343
    {
        switch (m_type)
        {
5344
            case value_t::null:
N
Niels 已提交
5345
            {
N
Niels 已提交
5346
                // null values are empty
N
Niels 已提交
5347 5348
                return 0;
            }
N
Niels 已提交
5349

5350
            case value_t::array:
N
Niels 已提交
5351
            {
N
Niels 已提交
5352
                // delegate call to array_t::size()
N
Niels 已提交
5353 5354
                return m_value.array->size();
            }
N
Niels 已提交
5355

5356
            case value_t::object:
N
Niels 已提交
5357
            {
N
Niels 已提交
5358
                // delegate call to object_t::size()
N
Niels 已提交
5359 5360
                return m_value.object->size();
            }
N
Niels 已提交
5361

N
Niels 已提交
5362 5363 5364 5365 5366 5367
            default:
            {
                // all other types have size 1
                return 1;
            }
        }
N
Niels 已提交
5368 5369
    }

N
Niels 已提交
5370 5371
    /*!
    @brief returns the maximum possible number of elements
N
Niels 已提交
5372 5373 5374 5375 5376

    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 已提交
5377
    @return The return value depends on the different types and is
N
Niels 已提交
5378 5379 5380
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
5381 5382 5383 5384 5385 5386
            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 已提交
5387

N
Niels 已提交
5388 5389
    @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 已提交
5390
    complexity.
N
Niels 已提交
5391

N
Niels 已提交
5392 5393 5394
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
5395 5396 5397 5398
    - The complexity is constant.
    - Has the semantics of returning `b.size()` where `b` is the largest
      possible JSON value.

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

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

N
Niels 已提交
5404
    @since version 1.0.0
N
Niels 已提交
5405
    */
N
Niels 已提交
5406
    size_type max_size() const noexcept
N
Niels 已提交
5407 5408 5409
    {
        switch (m_type)
        {
5410
            case value_t::array:
N
Niels 已提交
5411
            {
N
Niels 已提交
5412
                // delegate call to array_t::max_size()
N
Niels 已提交
5413 5414
                return m_value.array->max_size();
            }
N
Niels 已提交
5415

5416
            case value_t::object:
N
Niels 已提交
5417
            {
N
Niels 已提交
5418
                // delegate call to object_t::max_size()
N
Niels 已提交
5419 5420
                return m_value.object->max_size();
            }
N
Niels 已提交
5421

N
Niels 已提交
5422 5423
            default:
            {
5424 5425
                // all other types have max_size() == size()
                return size();
N
Niels 已提交
5426 5427
            }
        }
N
Niels 已提交
5428 5429
    }

N
Niels 已提交
5430 5431
    /// @}

N
Niels 已提交
5432 5433 5434 5435 5436

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

N
Niels 已提交
5437 5438 5439
    /// @name modifiers
    /// @{

N
Niels 已提交
5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456
    /*!
    @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 已提交
5457
    @liveexample{The example below shows the effect of `clear()` to different
N
Niels 已提交
5458
    JSON types.,clear}
N
Niels 已提交
5459

N
Niels 已提交
5460
    @since version 1.0.0
N
Niels 已提交
5461
    */
N
Niels 已提交
5462
    void clear() noexcept
N
Niels 已提交
5463 5464 5465
    {
        switch (m_type)
        {
5466
            case value_t::number_integer:
N
Niels 已提交
5467
            {
N
Niels 已提交
5468
                m_value.number_integer = 0;
N
Niels 已提交
5469 5470
                break;
            }
N
Niels 已提交
5471

5472 5473 5474 5475 5476 5477
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = 0;
                break;
            }

5478
            case value_t::number_float:
N
Niels 已提交
5479
            {
N
Niels 已提交
5480
                m_value.number_float = 0.0;
N
Niels 已提交
5481 5482
                break;
            }
N
Niels 已提交
5483

5484
            case value_t::boolean:
N
Niels 已提交
5485
            {
N
Niels 已提交
5486
                m_value.boolean = false;
N
Niels 已提交
5487 5488
                break;
            }
N
Niels 已提交
5489

5490
            case value_t::string:
N
Niels 已提交
5491 5492 5493 5494
            {
                m_value.string->clear();
                break;
            }
N
Niels 已提交
5495

5496
            case value_t::array:
N
Niels 已提交
5497 5498 5499 5500
            {
                m_value.array->clear();
                break;
            }
N
Niels 已提交
5501

5502
            case value_t::object:
N
Niels 已提交
5503 5504 5505 5506
            {
                m_value.object->clear();
                break;
            }
5507 5508 5509 5510 5511

            default:
            {
                break;
            }
N
Niels 已提交
5512 5513 5514
        }
    }

5515 5516 5517
    /*!
    @brief add an object to an array

5518
    Appends the given element @a val to the end of the JSON value. If the
5519
    function is called on a JSON null value, an empty array is created before
5520
    appending @a val.
5521

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

5524
    @throw type_error.308 when called on a type other than JSON array or
N
Niels 已提交
5525
    null; example: `"cannot use push_back() with number"`
5526 5527 5528

    @complexity Amortized constant.

N
Niels 已提交
5529 5530 5531
    @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 已提交
5532

N
Niels 已提交
5533
    @since version 1.0.0
5534
    */
5535
    void push_back(basic_json&& val)
N
Niels 已提交
5536 5537
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
5538
        if (not(is_null() or is_array()))
N
Niels 已提交
5539
        {
5540
            JSON_THROW(type_error::create(308, "cannot use push_back() with " + type_name()));
N
Niels 已提交
5541 5542 5543
        }

        // transform null object into an array
N
cleanup  
Niels 已提交
5544
        if (is_null())
N
Niels 已提交
5545 5546
        {
            m_type = value_t::array;
N
Niels 已提交
5547
            m_value = value_t::array;
5548
            assert_invariant();
N
Niels 已提交
5549 5550 5551
        }

        // add element to array (move semantics)
5552
        m_value.array->push_back(std::move(val));
N
Niels 已提交
5553
        // invalidate object
5554
        val.m_type = value_t::null;
N
Niels 已提交
5555 5556
    }

5557 5558 5559 5560
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5561
    reference operator+=(basic_json&& val)
N
Niels 已提交
5562
    {
5563
        push_back(std::move(val));
N
Niels 已提交
5564 5565 5566
        return *this;
    }

5567 5568 5569 5570
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5571
    void push_back(const basic_json& val)
N
Niels 已提交
5572 5573
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
5574
        if (not(is_null() or is_array()))
N
Niels 已提交
5575
        {
5576
            JSON_THROW(type_error::create(308, "cannot use push_back() with " + type_name()));
N
Niels 已提交
5577 5578 5579
        }

        // transform null object into an array
N
cleanup  
Niels 已提交
5580
        if (is_null())
N
Niels 已提交
5581 5582
        {
            m_type = value_t::array;
N
Niels 已提交
5583
            m_value = value_t::array;
5584
            assert_invariant();
N
Niels 已提交
5585 5586 5587
        }

        // add element to array
5588
        m_value.array->push_back(val);
N
Niels 已提交
5589 5590
    }

5591 5592 5593 5594
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5595
    reference operator+=(const basic_json& val)
N
Niels 已提交
5596
    {
5597
        push_back(val);
N
Niels 已提交
5598 5599 5600
        return *this;
    }

5601 5602 5603
    /*!
    @brief add an object to an object

5604
    Inserts the given element @a val to the JSON object. If the function is
N
Niels 已提交
5605 5606
    called on a JSON null value, an empty object is created before inserting
    @a val.
5607

5608
    @param[in] val the value to add to the JSON object
5609

5610
    @throw type_error.308 when called on a type other than JSON object or
N
Niels 已提交
5611
    null; example: `"cannot use push_back() with number"`
5612 5613 5614

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

N
Niels 已提交
5615 5616 5617
    @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 已提交
5618

N
Niels 已提交
5619
    @since version 1.0.0
5620
    */
5621
    void push_back(const typename object_t::value_type& val)
N
Niels 已提交
5622 5623
    {
        // push_back only works for null objects or objects
N
cleanup  
Niels 已提交
5624
        if (not(is_null() or is_object()))
N
Niels 已提交
5625
        {
5626
            JSON_THROW(type_error::create(308, "cannot use push_back() with " + type_name()));
N
Niels 已提交
5627 5628 5629
        }

        // transform null object into an object
N
cleanup  
Niels 已提交
5630
        if (is_null())
N
Niels 已提交
5631 5632
        {
            m_type = value_t::object;
N
Niels 已提交
5633
            m_value = value_t::object;
5634
            assert_invariant();
N
Niels 已提交
5635 5636 5637
        }

        // add element to array
5638
        m_value.object->insert(val);
N
Niels 已提交
5639 5640
    }

5641 5642 5643 5644
    /*!
    @brief add an object to an object
    @copydoc push_back(const typename object_t::value_type&)
    */
5645
    reference operator+=(const typename object_t::value_type& val)
N
Niels 已提交
5646
    {
5647
        push_back(val);
N
Niels 已提交
5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663
        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&&).

N
Niels Lohmann 已提交
5664
    @param[in] init  an initializer list
N
Niels 已提交
5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696

    @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 已提交
5697 5698
    }

N
Niels 已提交
5699 5700 5701 5702 5703 5704 5705 5706 5707 5708
    /*!
    @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

5709
    @throw type_error.311 when called on a type other than JSON array or
N
Niels 已提交
5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725
    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()))
        {
5726
            JSON_THROW(type_error::create(311, "cannot use emplace_back() with " + type_name()));
N
Niels 已提交
5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741
        }

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

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

N
Niels Lohmann 已提交
5744 5745
    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
5746 5747
    function is called on a JSON null value, an empty object is created before
    appending the value created from @a args.
N
Niels 已提交
5748 5749 5750 5751

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

5752 5753 5754 5755
    @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.

5756
    @throw type_error.311 when called on a type other than JSON object or
N
Niels 已提交
5757 5758 5759 5760 5761 5762
    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
5763 5764
    JSON object. Further note how no value is added if there was already one
    value stored with the same key.,emplace}
N
Niels 已提交
5765 5766 5767 5768

    @since version 2.0.8
    */
    template<class... Args>
5769
    std::pair<iterator, bool> emplace(Args&& ... args)
N
Niels 已提交
5770 5771 5772 5773
    {
        // emplace only works for null objects or arrays
        if (not(is_null() or is_object()))
        {
5774
            JSON_THROW(type_error::create(311, "cannot use emplace() with " + type_name()));
N
Niels 已提交
5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785
        }

        // 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)
5786 5787 5788 5789 5790 5791 5792
        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 已提交
5793 5794
    }

N
Niels 已提交
5795 5796 5797
    /*!
    @brief inserts element

5798
    Inserts element @a val before iterator @a pos.
N
Niels 已提交
5799 5800 5801

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

5805
    @throw type_error.309 if called on JSON values other than arrays;
N
Niels 已提交
5806
    example: `"cannot use insert() with string"`
5807 5808
    @throw invalid_iterator.202 if @a pos is not an iterator of *this;
    example: `"iterator does not fit current value"`
N
Niels 已提交
5809

N
Niels Lohmann 已提交
5810
    @complexity Constant plus linear in the distance between @a pos and end of
N
Niels Lohmann 已提交
5811
    the container.
N
Niels 已提交
5812

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

N
Niels 已提交
5815
    @since version 1.0.0
N
Niels 已提交
5816
    */
5817
    iterator insert(const_iterator pos, const basic_json& val)
N
Niels 已提交
5818 5819
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5820
        if (is_array())
N
Niels 已提交
5821
        {
N
cleanup  
Niels 已提交
5822 5823 5824
            // check if iterator pos fits to this JSON value
            if (pos.m_object != this)
            {
5825
                JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value"));
N
cleanup  
Niels 已提交
5826
            }
N
Niels 已提交
5827

N
cleanup  
Niels 已提交
5828 5829
            // insert to array and return iterator
            iterator result(this);
5830
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, val);
N
cleanup  
Niels 已提交
5831 5832
            return result;
        }
N
Niels Lohmann 已提交
5833

5834
        JSON_THROW(type_error::create(309, "cannot use insert() with " + type_name()));
N
Niels 已提交
5835 5836 5837 5838 5839 5840
    }

    /*!
    @brief inserts element
    @copydoc insert(const_iterator, const basic_json&)
    */
5841
    iterator insert(const_iterator pos, basic_json&& val)
N
Niels 已提交
5842
    {
5843
        return insert(pos, val);
N
Niels 已提交
5844 5845 5846 5847 5848
    }

    /*!
    @brief inserts elements

5849
    Inserts @a cnt copies of @a val before iterator @a pos.
N
Niels 已提交
5850 5851 5852

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

5858 5859
    @throw type_error.309 if called on JSON values other than arrays; example:
    `"cannot use insert() with string"`
5860 5861
    @throw invalid_iterator.202 if @a pos is not an iterator of *this;
    example: `"iterator does not fit current value"`
N
Niels 已提交
5862

5863
    @complexity Linear in @a cnt plus linear in the distance between @a pos
N
Niels 已提交
5864 5865
    and end of the container.

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

N
Niels 已提交
5868
    @since version 1.0.0
N
Niels 已提交
5869
    */
5870
    iterator insert(const_iterator pos, size_type cnt, const basic_json& val)
N
Niels 已提交
5871 5872
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5873
        if (is_array())
N
Niels 已提交
5874
        {
N
cleanup  
Niels 已提交
5875 5876 5877
            // check if iterator pos fits to this JSON value
            if (pos.m_object != this)
            {
5878
                JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value"));
N
cleanup  
Niels 已提交
5879
            }
N
Niels 已提交
5880

N
cleanup  
Niels 已提交
5881 5882
            // insert to array and return iterator
            iterator result(this);
5883
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, cnt, val);
N
cleanup  
Niels 已提交
5884 5885
            return result;
        }
N
Niels Lohmann 已提交
5886

5887
        JSON_THROW(type_error::create(309, "cannot use insert() with " + type_name()));
N
Niels 已提交
5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899
    }

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

5900 5901
    @throw type_error.309 if called on JSON values other than arrays; example:
    `"cannot use insert() with string"`
5902 5903
    @throw invalid_iterator.202 if @a pos is not an iterator of *this;
    example: `"iterator does not fit current value"`
5904 5905 5906
    @throw invalid_iterator.210 if @a first and @a last do not belong to the
    same JSON value; example: `"iterators do not fit"`
    @throw invalid_iterator.211 if @a first or @a last are iterators into
N
Niels 已提交
5907 5908 5909
    container for which insert is called; example: `"passed iterators may not
    belong to container"`

N
Niels 已提交
5910 5911 5912 5913 5914 5915
    @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 已提交
5916
    @liveexample{The example shows how `insert()` is used.,insert__range}
N
Niels 已提交
5917

N
Niels 已提交
5918
    @since version 1.0.0
N
Niels 已提交
5919 5920 5921 5922
    */
    iterator insert(const_iterator pos, const_iterator first, const_iterator last)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5923
        if (not is_array())
N
Niels 已提交
5924
        {
5925
            JSON_THROW(type_error::create(309, "cannot use insert() with " + type_name()));
N
Niels 已提交
5926 5927 5928 5929 5930
        }

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

N
Niels 已提交
5934
        // check if range iterators belong to the same JSON object
N
Niels 已提交
5935 5936
        if (first.m_object != last.m_object)
        {
5937
            JSON_THROW(invalid_iterator::create(210, "iterators do not fit"));
N
Niels 已提交
5938 5939 5940 5941
        }

        if (first.m_object == this or last.m_object == this)
        {
5942
            JSON_THROW(invalid_iterator::create(211, "passed iterators may not belong to container"));
N
Niels 已提交
5943 5944 5945 5946
        }

        // insert to array and return iterator
        iterator result(this);
N
Niels 已提交
5947
        result.m_it.array_iterator = m_value.array->insert(
T
Théo DELRIEU 已提交
5948 5949 5950
                                         pos.m_it.array_iterator,
                                         first.m_it.array_iterator,
                                         last.m_it.array_iterator);
N
Niels 已提交
5951 5952 5953
        return result;
    }

N
Niels 已提交
5954 5955 5956 5957 5958 5959 5960 5961 5962
    /*!
    @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

5963 5964
    @throw type_error.309 if called on JSON values other than arrays; example:
    `"cannot use insert() with string"`
5965 5966
    @throw invalid_iterator.202 if @a pos is not an iterator of *this;
    example: `"iterator does not fit current value"`
N
Niels 已提交
5967

N
Niels 已提交
5968 5969 5970
    @return iterator pointing to the first element inserted, or @a pos if
    `ilist` is empty

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

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

N
Niels 已提交
5976
    @since version 1.0.0
N
Niels 已提交
5977 5978 5979 5980
    */
    iterator insert(const_iterator pos, std::initializer_list<basic_json> ilist)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5981
        if (not is_array())
N
Niels 已提交
5982
        {
5983
            JSON_THROW(type_error::create(309, "cannot use insert() with " + type_name()));
N
Niels 已提交
5984 5985 5986 5987 5988
        }

        // check if iterator pos fits to this JSON value
        if (pos.m_object != this)
        {
5989
            JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value"));
N
Niels 已提交
5990 5991 5992 5993 5994 5995 5996 5997
        }

        // 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 Lohmann 已提交
5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043
    /*!
    @brief inserts elements

    Inserts elements from range `[first, last)`.

    @param[in] first begin of the range of elements to insert
    @param[in] last end of the range of elements to insert

    @throw type_error.309 if called on JSON values other than objects; example:
    `"cannot use insert() with string"`
    @throw invalid_iterator.202 if iterator @a first or @a last does does not
    point to an object; example: `"iterators first and last must point to
    objects"`
    @throw invalid_iterator.210 if @a first and @a last do not belong to the
    same JSON value; example: `"iterators do not fit"`

    @complexity Logarithmic: `O(N*log(size() + N))`, where `N` is the number
    of elements to insert.

    @liveexample{The example shows how `insert()` is used.,insert__range_object}

    @since version 3.0.0
    */
    void insert(const_iterator first, const_iterator last)
    {
        // insert only works for objects
        if (not is_object())
        {
            JSON_THROW(type_error::create(309, "cannot use insert() with " + type_name()));
        }

        // check if range iterators belong to the same JSON object
        if (first.m_object != last.m_object)
        {
            JSON_THROW(invalid_iterator::create(210, "iterators do not fit"));
        }

        // passed iterators must belong to objects
        if (not first.m_object->is_object() or not first.m_object->is_object())
        {
            JSON_THROW(invalid_iterator::create(202, "iterators first and last must point to objects"));
        }

        m_value.object->insert(first.m_it.object_iterator, last.m_it.object_iterator);
    }

N
Niels 已提交
6044 6045
    /*!
    @brief exchanges the values
N
Niels 已提交
6046 6047 6048 6049 6050 6051 6052 6053 6054 6055

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

N
Niels 已提交
6059
    @since version 1.0.0
N
Niels 已提交
6060
    */
N
Niels 已提交
6061
    void swap(reference other) noexcept (
N
Niels 已提交
6062 6063 6064 6065
        std::is_nothrow_move_constructible<value_t>::value and
        std::is_nothrow_move_assignable<value_t>::value and
        std::is_nothrow_move_constructible<json_value>::value and
        std::is_nothrow_move_assignable<json_value>::value
T
Théo DELRIEU 已提交
6066
    )
N
Niels 已提交
6067 6068 6069
    {
        std::swap(m_type, other.m_type);
        std::swap(m_value, other.m_value);
6070
        assert_invariant();
N
Niels 已提交
6071 6072
    }

N
Niels 已提交
6073 6074 6075 6076 6077 6078 6079 6080 6081 6082
    /*!
    @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

6083 6084
    @throw type_error.310 when JSON value is not an array; example: `"cannot
    use swap() with string"`
N
Niels 已提交
6085 6086 6087

    @complexity Constant.

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

N
Niels 已提交
6091
    @since version 1.0.0
N
Niels 已提交
6092
    */
N
Niels 已提交
6093
    void swap(array_t& other)
N
Niels 已提交
6094 6095
    {
        // swap only works for arrays
N
cleanup  
Niels 已提交
6096 6097 6098 6099 6100
        if (is_array())
        {
            std::swap(*(m_value.array), other);
        }
        else
N
Niels 已提交
6101
        {
6102
            JSON_THROW(type_error::create(310, "cannot use swap() with " + type_name()));
N
Niels 已提交
6103 6104 6105
        }
    }

6106 6107 6108 6109 6110 6111 6112 6113 6114 6115
    /*!
    @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

6116
    @throw type_error.310 when JSON value is not an object; example:
N
Niels 已提交
6117
    `"cannot use swap() with string"`
6118 6119 6120

    @complexity Constant.

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

N
Niels 已提交
6124
    @since version 1.0.0
6125
    */
N
Niels 已提交
6126
    void swap(object_t& other)
N
Niels 已提交
6127 6128
    {
        // swap only works for objects
N
cleanup  
Niels 已提交
6129 6130 6131 6132 6133
        if (is_object())
        {
            std::swap(*(m_value.object), other);
        }
        else
N
Niels 已提交
6134
        {
6135
            JSON_THROW(type_error::create(310, "cannot use swap() with " + type_name()));
N
Niels 已提交
6136 6137 6138
        }
    }

6139 6140 6141 6142 6143 6144 6145 6146 6147 6148
    /*!
    @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

6149
    @throw type_error.310 when JSON value is not a string; example: `"cannot
N
Niels 已提交
6150
    use swap() with boolean"`
6151 6152 6153

    @complexity Constant.

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

N
Niels 已提交
6157
    @since version 1.0.0
6158
    */
N
Niels 已提交
6159
    void swap(string_t& other)
N
Niels 已提交
6160 6161
    {
        // swap only works for strings
N
cleanup  
Niels 已提交
6162 6163 6164 6165 6166
        if (is_string())
        {
            std::swap(*(m_value.string), other);
        }
        else
N
Niels 已提交
6167
        {
6168
            JSON_THROW(type_error::create(310, "cannot use swap() with " + type_name()));
N
Niels 已提交
6169 6170 6171
        }
    }

N
Niels 已提交
6172 6173
    /// @}

N
Niels 已提交
6174
  public:
6175 6176 6177 6178 6179 6180 6181
    //////////////////////////////////////////
    // lexicographical comparison operators //
    //////////////////////////////////////////

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

N
Niels 已提交
6182 6183
    /*!
    @brief comparison: equal
N
Niels 已提交
6184 6185 6186

    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)
N
Niels Lohmann 已提交
6187 6188
      their stored values are the same according to their respective
      `operator==`.
N
Niels 已提交
6189 6190 6191
    - 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
N
Niels Lohmann 已提交
6192 6193
      `f1 > f2` nor `f2 > f1` holds. Note than two NaN values are always
      treated as unequal.
N
Niels 已提交
6194 6195
    - Two JSON null values are equal.

N
Niels Lohmann 已提交
6196 6197
    @note NaN values never compare equal to themselves or to other NaN values.

N
Niels 已提交
6198 6199 6200 6201 6202 6203
    @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.

6204 6205
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__equal}
N
Niels 已提交
6206

N
Niels 已提交
6207
    @since version 1.0.0
N
Niels 已提交
6208
    */
N
Niels 已提交
6209
    friend bool operator==(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6210
    {
F
Florian Weber 已提交
6211 6212
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
6213

F
Florian Weber 已提交
6214
        if (lhs_type == rhs_type)
N
Niels 已提交
6215
        {
F
Florian Weber 已提交
6216
            switch (lhs_type)
N
Niels 已提交
6217
            {
6218
                case value_t::array:
N
Niels 已提交
6219
                {
N
Niels 已提交
6220
                    return *lhs.m_value.array == *rhs.m_value.array;
N
Niels 已提交
6221
                }
6222
                case value_t::object:
N
Niels 已提交
6223
                {
N
Niels 已提交
6224
                    return *lhs.m_value.object == *rhs.m_value.object;
N
Niels 已提交
6225
                }
6226
                case value_t::null:
N
Niels 已提交
6227
                {
N
Niels 已提交
6228
                    return true;
N
Niels 已提交
6229
                }
6230
                case value_t::string:
N
Niels 已提交
6231
                {
N
Niels 已提交
6232
                    return *lhs.m_value.string == *rhs.m_value.string;
N
Niels 已提交
6233
                }
6234
                case value_t::boolean:
N
Niels 已提交
6235
                {
N
Niels 已提交
6236
                    return lhs.m_value.boolean == rhs.m_value.boolean;
N
Niels 已提交
6237
                }
6238
                case value_t::number_integer:
N
Niels 已提交
6239
                {
N
Niels 已提交
6240
                    return lhs.m_value.number_integer == rhs.m_value.number_integer;
N
Niels 已提交
6241
                }
6242 6243 6244 6245
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned == rhs.m_value.number_unsigned;
                }
6246
                case value_t::number_float:
N
Niels 已提交
6247
                {
6248
                    return lhs.m_value.number_float == rhs.m_value.number_float;
N
Niels 已提交
6249
                }
6250
                default:
N
Niels 已提交
6251
                {
N
Niels 已提交
6252
                    return false;
N
Niels 已提交
6253
                }
N
Niels 已提交
6254 6255
            }
        }
F
Florian Weber 已提交
6256 6257
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
N
Niels 已提交
6258
            return static_cast<number_float_t>(lhs.m_value.number_integer) == rhs.m_value.number_float;
F
Florian Weber 已提交
6259 6260 6261
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
6262
            return lhs.m_value.number_float == static_cast<number_float_t>(rhs.m_value.number_integer);
F
Florian Weber 已提交
6263
        }
6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278
        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 已提交
6279
        }
6280

N
Niels 已提交
6281 6282 6283
        return false;
    }

N
Niels 已提交
6284 6285
    /*!
    @brief comparison: equal
M
Mihai STAN 已提交
6286
    @copydoc operator==(const_reference, const_reference)
N
Niels 已提交
6287
    */
M
Mihai STAN 已提交
6288
    template<typename ScalarType, typename std::enable_if<
6289 6290
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator==(const_reference lhs, const ScalarType rhs) noexcept
N
Niels 已提交
6291
    {
M
Mihai STAN 已提交
6292
        return (lhs == basic_json(rhs));
N
Niels 已提交
6293 6294 6295 6296
    }

    /*!
    @brief comparison: equal
M
Mihai STAN 已提交
6297
    @copydoc operator==(const_reference, const_reference)
N
Niels 已提交
6298
    */
M
Mihai STAN 已提交
6299
    template<typename ScalarType, typename std::enable_if<
6300 6301
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator==(const ScalarType lhs, const_reference rhs) noexcept
N
Niels 已提交
6302
    {
M
Mihai STAN 已提交
6303
        return (basic_json(lhs) == rhs);
N
Niels 已提交
6304 6305
    }

N
Niels 已提交
6306 6307
    /*!
    @brief comparison: not equal
N
Niels 已提交
6308 6309 6310 6311 6312 6313 6314 6315 6316

    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.

6317 6318
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__notequal}
N
Niels 已提交
6319

N
Niels 已提交
6320
    @since version 1.0.0
N
Niels 已提交
6321
    */
N
Niels 已提交
6322
    friend bool operator!=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6323 6324 6325 6326
    {
        return not (lhs == rhs);
    }

N
Niels 已提交
6327 6328
    /*!
    @brief comparison: not equal
M
Mihai STAN 已提交
6329
    @copydoc operator!=(const_reference, const_reference)
N
Niels 已提交
6330
    */
M
Mihai STAN 已提交
6331 6332 6333
    template<typename ScalarType, typename std::enable_if<
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator!=(const_reference lhs, const ScalarType rhs) noexcept
N
Niels 已提交
6334
    {
M
Mihai STAN 已提交
6335
        return (lhs != basic_json(rhs));
N
Niels 已提交
6336 6337 6338 6339
    }

    /*!
    @brief comparison: not equal
M
Mihai STAN 已提交
6340
    @copydoc operator!=(const_reference, const_reference)
N
Niels 已提交
6341
    */
M
Mihai STAN 已提交
6342 6343 6344
    template<typename ScalarType, typename std::enable_if<
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator!=(const ScalarType lhs, const_reference rhs) noexcept
N
Niels 已提交
6345
    {
M
Mihai STAN 已提交
6346
        return (basic_json(lhs) != rhs);
N
Niels 已提交
6347 6348
    }

N
Niels 已提交
6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367
    /*!
    @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.

6368 6369
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__less}
N
Niels 已提交
6370

N
Niels 已提交
6371
    @since version 1.0.0
N
Niels 已提交
6372
    */
N
Niels 已提交
6373
    friend bool operator<(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6374
    {
F
Florian Weber 已提交
6375 6376
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
6377

F
Florian Weber 已提交
6378
        if (lhs_type == rhs_type)
N
Niels 已提交
6379
        {
F
Florian Weber 已提交
6380
            switch (lhs_type)
N
Niels 已提交
6381
            {
6382
                case value_t::array:
N
Niels 已提交
6383
                {
N
Niels 已提交
6384
                    return *lhs.m_value.array < *rhs.m_value.array;
N
Niels 已提交
6385
                }
6386
                case value_t::object:
N
Niels 已提交
6387
                {
N
Niels 已提交
6388
                    return *lhs.m_value.object < *rhs.m_value.object;
N
Niels 已提交
6389
                }
6390
                case value_t::null:
N
Niels 已提交
6391
                {
N
Niels 已提交
6392
                    return false;
N
Niels 已提交
6393
                }
6394
                case value_t::string:
N
Niels 已提交
6395
                {
N
Niels 已提交
6396
                    return *lhs.m_value.string < *rhs.m_value.string;
N
Niels 已提交
6397
                }
6398
                case value_t::boolean:
N
Niels 已提交
6399
                {
N
Niels 已提交
6400
                    return lhs.m_value.boolean < rhs.m_value.boolean;
N
Niels 已提交
6401
                }
6402
                case value_t::number_integer:
N
Niels 已提交
6403
                {
N
Niels 已提交
6404
                    return lhs.m_value.number_integer < rhs.m_value.number_integer;
N
Niels 已提交
6405
                }
6406 6407 6408 6409
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned < rhs.m_value.number_unsigned;
                }
6410
                case value_t::number_float:
N
Niels 已提交
6411
                {
N
Niels 已提交
6412
                    return lhs.m_value.number_float < rhs.m_value.number_float;
N
Niels 已提交
6413
                }
6414
                default:
N
Niels 已提交
6415
                {
N
Niels 已提交
6416
                    return false;
N
Niels 已提交
6417
                }
N
Niels 已提交
6418 6419
            }
        }
F
Florian Weber 已提交
6420 6421
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
6422
            return static_cast<number_float_t>(lhs.m_value.number_integer) < rhs.m_value.number_float;
F
Florian Weber 已提交
6423 6424 6425
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442
            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 已提交
6443
        }
N
Niels 已提交
6444

N
Niels 已提交
6445
        // We only reach this line if we cannot compare values. In that case,
N
Niels 已提交
6446 6447 6448
        // we compare types. Note we have to call the operator explicitly,
        // because MSVC has problems otherwise.
        return operator<(lhs_type, rhs_type);
N
Niels 已提交
6449 6450
    }

N
Niels Lohmann 已提交
6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472
    /*!
    @brief comparison: less than
    @copydoc operator<(const_reference, const_reference)
    */
    template<typename ScalarType, typename std::enable_if<
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator<(const_reference lhs, const ScalarType rhs) noexcept
    {
        return (lhs < basic_json(rhs));
    }

    /*!
    @brief comparison: less than
    @copydoc operator<(const_reference, const_reference)
    */
    template<typename ScalarType, typename std::enable_if<
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator<(const ScalarType lhs, const_reference rhs) noexcept
    {
        return (basic_json(lhs) < rhs);
    }

N
Niels 已提交
6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484
    /*!
    @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.

6485 6486
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greater}
N
Niels 已提交
6487

N
Niels 已提交
6488
    @since version 1.0.0
N
Niels 已提交
6489
    */
N
Niels 已提交
6490
    friend bool operator<=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6491 6492 6493 6494
    {
        return not (rhs < lhs);
    }

N
Niels Lohmann 已提交
6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516
    /*!
    @brief comparison: less than or equal
    @copydoc operator<=(const_reference, const_reference)
    */
    template<typename ScalarType, typename std::enable_if<
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator<=(const_reference lhs, const ScalarType rhs) noexcept
    {
        return (lhs <= basic_json(rhs));
    }

    /*!
    @brief comparison: less than or equal
    @copydoc operator<=(const_reference, const_reference)
    */
    template<typename ScalarType, typename std::enable_if<
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator<=(const ScalarType lhs, const_reference rhs) noexcept
    {
        return (basic_json(lhs) <= rhs);
    }

N
Niels 已提交
6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528
    /*!
    @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.

6529 6530
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__lessequal}
N
Niels 已提交
6531

N
Niels 已提交
6532
    @since version 1.0.0
N
Niels 已提交
6533
    */
N
Niels 已提交
6534
    friend bool operator>(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6535 6536 6537 6538
    {
        return not (lhs <= rhs);
    }

N
Niels Lohmann 已提交
6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560
    /*!
    @brief comparison: greater than
    @copydoc operator>(const_reference, const_reference)
    */
    template<typename ScalarType, typename std::enable_if<
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator>(const_reference lhs, const ScalarType rhs) noexcept
    {
        return (lhs > basic_json(rhs));
    }

    /*!
    @brief comparison: greater than
    @copydoc operator>(const_reference, const_reference)
    */
    template<typename ScalarType, typename std::enable_if<
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator>(const ScalarType lhs, const_reference rhs) noexcept
    {
        return (basic_json(lhs) > rhs);
    }

N
Niels 已提交
6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572
    /*!
    @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.

6573 6574
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greaterequal}
N
Niels 已提交
6575

N
Niels 已提交
6576
    @since version 1.0.0
N
Niels 已提交
6577
    */
N
Niels 已提交
6578
    friend bool operator>=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6579 6580 6581 6582
    {
        return not (lhs < rhs);
    }

N
Niels Lohmann 已提交
6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604
    /*!
    @brief comparison: greater than or equal
    @copydoc operator>=(const_reference, const_reference)
    */
    template<typename ScalarType, typename std::enable_if<
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator>=(const_reference lhs, const ScalarType rhs) noexcept
    {
        return (lhs >= basic_json(rhs));
    }

    /*!
    @brief comparison: greater than or equal
    @copydoc operator>=(const_reference, const_reference)
    */
    template<typename ScalarType, typename std::enable_if<
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator>=(const ScalarType lhs, const_reference rhs) noexcept
    {
        return (basic_json(lhs) >= rhs);
    }

N
Niels 已提交
6605 6606
    /// @}

6607 6608 6609 6610 6611
  private:
    /////////////////////
    // output adapters //
    /////////////////////

N
Niels Lohmann 已提交
6612
    /// abstract output adapter interface
6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636
    template<typename CharType>
    class output_adapter
    {
      public:
        virtual void write_character(CharType c) = 0;
        virtual void write_characters(const CharType* s, size_t length) = 0;
        virtual ~output_adapter() {}

        static std::shared_ptr<output_adapter<CharType>> create(std::vector<CharType>& vec)
        {
            return std::shared_ptr<output_adapter>(new output_vector_adapter<CharType>(vec));
        }

        static std::shared_ptr<output_adapter<CharType>> create(std::ostream& s)
        {
            return std::shared_ptr<output_adapter>(new output_stream_adapter<CharType>(s));
        }

        static std::shared_ptr<output_adapter<CharType>> create(std::string& s)
        {
            return std::shared_ptr<output_adapter>(new output_string_adapter<CharType>(s));
        }
    };

N
Niels Lohmann 已提交
6637
    /// a type to simplify interfaces
6638 6639 6640
    template<typename CharType>
    using output_adapter_t = std::shared_ptr<output_adapter<CharType>>;

N
Niels Lohmann 已提交
6641
    /// output adapter for byte vectors
6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663
    template<typename CharType>
    class output_vector_adapter : public output_adapter<CharType>
    {
      public:
        output_vector_adapter(std::vector<CharType>& vec)
            : v(vec)
        {}

        void write_character(CharType c) override
        {
            v.push_back(c);
        }

        void write_characters(const CharType* s, size_t length) override
        {
            std::copy(s, s + length, std::back_inserter(v));
        }

      private:
        std::vector<CharType>& v;
    };

N
Niels Lohmann 已提交
6664
    /// putput adatpter for output streams
6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686
    template<typename CharType>
    class output_stream_adapter : public output_adapter<CharType>
    {
      public:
        output_stream_adapter(std::basic_ostream<CharType>& s)
            : stream(s)
        {}

        void write_character(CharType c) override
        {
            stream.put(c);
        }

        void write_characters(const CharType* s, size_t length) override
        {
            stream.write(s, static_cast<std::streamsize>(length));
        }

      private:
        std::basic_ostream<CharType>& stream;
    };

N
Niels Lohmann 已提交
6687
    /// output adapter for basic_string
6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709
    template<typename CharType>
    class output_string_adapter : public output_adapter<CharType>
    {
      public:
        output_string_adapter(std::string& s)
            : str(s)
        {}

        void write_character(CharType c) override
        {
            str.push_back(c);
        }

        void write_characters(const CharType* s, size_t length) override
        {
            str.append(s, length);
        }

      private:
        std::basic_string<CharType>& str;
    };

N
Niels 已提交
6710 6711 6712 6713 6714

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

N
Niels 已提交
6715 6716 6717
    /// @name serialization
    /// @{

6718
  private:
6719 6720 6721
    /*!
    @brief wrapper around the serialization functions
    */
6722 6723
    class serializer
    {
T
Ted Lyngmo 已提交
6724 6725 6726 6727
      private:
        serializer(const serializer&) = delete;
        serializer& operator=(const serializer&) = delete;

6728
      public:
N
Niels Lohmann 已提交
6729 6730
        /*!
        @param[in] s  output stream to serialize to
6731
        @param[in] ichar  indentation character to use
N
Niels Lohmann 已提交
6732
        */
6733
        serializer(output_adapter_t<char> s, const char ichar)
6734 6735
            : o(s), loc(std::localeconv()),
              thousands_sep(!loc->thousands_sep ? '\0' : loc->thousands_sep[0]),
6736 6737
              decimal_point(!loc->decimal_point ? '\0' : loc->decimal_point[0]),
              indent_char(ichar), indent_string(512, indent_char)
6738 6739 6740 6741 6742
        {}

        /*!
        @brief internal implementation of the serialization function

N
Niels Lohmann 已提交
6743 6744 6745 6746
        This function is called by the public member function dump and
        organizes the serialization internally. The indentation level is
        propagated as additional parameter. In case of arrays and objects, the
        function is called recursively.
6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759

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

        @param[in] val             value to serialize
        @param[in] pretty_print    whether the output shall be pretty-printed
        @param[in] indent_step     the indent level
        @param[in] current_indent  the current indent level (only used internally)
        */
        void dump(const basic_json& val,
                  const bool pretty_print,
                  const unsigned int indent_step,
6760
                  const unsigned int current_indent = 0)
6761 6762 6763 6764 6765 6766 6767
        {
            switch (val.m_type)
            {
                case value_t::object:
                {
                    if (val.m_value.object->empty())
                    {
6768
                        o->write_characters("{}", 2);
6769 6770 6771 6772 6773
                        return;
                    }

                    if (pretty_print)
                    {
6774
                        o->write_characters("{\n", 2);
6775 6776 6777

                        // variable to hold indentation for recursive calls
                        const auto new_indent = current_indent + indent_step;
6778 6779 6780 6781
                        if (indent_string.size() < new_indent)
                        {
                            indent_string.resize(new_indent, ' ');
                        }
6782 6783 6784 6785 6786

                        // first n-1 elements
                        auto i = val.m_value.object->cbegin();
                        for (size_t cnt = 0; cnt < val.m_value.object->size() - 1; ++cnt, ++i)
                        {
6787 6788
                            o->write_characters(indent_string.c_str(), new_indent);
                            o->write_character('\"');
6789
                            dump_escaped(i->first);
6790
                            o->write_characters("\": ", 3);
6791
                            dump(i->second, true, indent_step, new_indent);
6792
                            o->write_characters(",\n", 2);
6793 6794 6795 6796
                        }

                        // last element
                        assert(i != val.m_value.object->cend());
6797 6798
                        o->write_characters(indent_string.c_str(), new_indent);
                        o->write_character('\"');
6799
                        dump_escaped(i->first);
6800
                        o->write_characters("\": ", 3);
6801 6802
                        dump(i->second, true, indent_step, new_indent);

6803 6804 6805
                        o->write_character('\n');
                        o->write_characters(indent_string.c_str(), current_indent);
                        o->write_character('}');
6806 6807 6808
                    }
                    else
                    {
6809
                        o->write_character('{');
6810 6811 6812 6813 6814

                        // first n-1 elements
                        auto i = val.m_value.object->cbegin();
                        for (size_t cnt = 0; cnt < val.m_value.object->size() - 1; ++cnt, ++i)
                        {
6815
                            o->write_character('\"');
6816
                            dump_escaped(i->first);
6817
                            o->write_characters("\":", 2);
6818
                            dump(i->second, false, indent_step, current_indent);
6819
                            o->write_character(',');
6820 6821 6822 6823
                        }

                        // last element
                        assert(i != val.m_value.object->cend());
6824
                        o->write_character('\"');
6825
                        dump_escaped(i->first);
6826
                        o->write_characters("\":", 2);
6827 6828
                        dump(i->second, false, indent_step, current_indent);

6829
                        o->write_character('}');
6830 6831 6832 6833 6834 6835 6836 6837 6838
                    }

                    return;
                }

                case value_t::array:
                {
                    if (val.m_value.array->empty())
                    {
6839
                        o->write_characters("[]", 2);
6840 6841 6842 6843 6844
                        return;
                    }

                    if (pretty_print)
                    {
6845
                        o->write_characters("[\n", 2);
6846 6847 6848

                        // variable to hold indentation for recursive calls
                        const auto new_indent = current_indent + indent_step;
6849 6850 6851 6852
                        if (indent_string.size() < new_indent)
                        {
                            indent_string.resize(new_indent, ' ');
                        }
6853 6854 6855 6856

                        // first n-1 elements
                        for (auto i = val.m_value.array->cbegin(); i != val.m_value.array->cend() - 1; ++i)
                        {
6857
                            o->write_characters(indent_string.c_str(), new_indent);
6858
                            dump(*i, true, indent_step, new_indent);
6859
                            o->write_characters(",\n", 2);
6860 6861 6862 6863
                        }

                        // last element
                        assert(not val.m_value.array->empty());
6864
                        o->write_characters(indent_string.c_str(), new_indent);
6865 6866
                        dump(val.m_value.array->back(), true, indent_step, new_indent);

6867 6868 6869
                        o->write_character('\n');
                        o->write_characters(indent_string.c_str(), current_indent);
                        o->write_character(']');
6870 6871 6872
                    }
                    else
                    {
6873
                        o->write_character('[');
6874 6875 6876 6877 6878

                        // first n-1 elements
                        for (auto i = val.m_value.array->cbegin(); i != val.m_value.array->cend() - 1; ++i)
                        {
                            dump(*i, false, indent_step, current_indent);
6879
                            o->write_character(',');
6880 6881 6882 6883 6884 6885
                        }

                        // last element
                        assert(not val.m_value.array->empty());
                        dump(val.m_value.array->back(), false, indent_step, current_indent);

6886
                        o->write_character(']');
6887 6888 6889 6890 6891 6892 6893
                    }

                    return;
                }

                case value_t::string:
                {
6894
                    o->write_character('\"');
6895
                    dump_escaped(*val.m_value.string);
6896
                    o->write_character('\"');
6897 6898 6899 6900 6901 6902 6903
                    return;
                }

                case value_t::boolean:
                {
                    if (val.m_value.boolean)
                    {
6904
                        o->write_characters("true", 4);
6905 6906 6907
                    }
                    else
                    {
6908
                        o->write_characters("false", 5);
6909 6910 6911 6912 6913 6914
                    }
                    return;
                }

                case value_t::number_integer:
                {
6915
                    dump_integer(val.m_value.number_integer);
6916 6917 6918 6919 6920
                    return;
                }

                case value_t::number_unsigned:
                {
6921
                    dump_integer(val.m_value.number_unsigned);
6922 6923 6924 6925 6926
                    return;
                }

                case value_t::number_float:
                {
6927
                    dump_float(val.m_value.number_float);
6928 6929 6930 6931 6932
                    return;
                }

                case value_t::discarded:
                {
6933
                    o->write_characters("<discarded>", 11);
6934 6935 6936 6937 6938
                    return;
                }

                case value_t::null:
                {
6939
                    o->write_characters("null", 4);
6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972
                    return;
                }
            }
        }

      private:
        /*!
        @brief calculates the extra space to escape a JSON string

        @param[in] s  the string to escape
        @return the number of characters required to escape string @a s

        @complexity Linear in the length of string @a s.
        */
        static std::size_t extra_space(const string_t& s) noexcept
        {
            return std::accumulate(s.begin(), s.end(), size_t{},
                                   [](size_t res, typename string_t::value_type c)
            {
                switch (c)
                {
                    case '"':
                    case '\\':
                    case '\b':
                    case '\f':
                    case '\n':
                    case '\r':
                    case '\t':
                    {
                        // from c (1 byte) to \x (2 bytes)
                        return res + 1;
                    }

6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999
                    case 0x00:
                    case 0x01:
                    case 0x02:
                    case 0x03:
                    case 0x04:
                    case 0x05:
                    case 0x06:
                    case 0x07:
                    case 0x0b:
                    case 0x0e:
                    case 0x0f:
                    case 0x10:
                    case 0x11:
                    case 0x12:
                    case 0x13:
                    case 0x14:
                    case 0x15:
                    case 0x16:
                    case 0x17:
                    case 0x18:
                    case 0x19:
                    case 0x1a:
                    case 0x1b:
                    case 0x1c:
                    case 0x1d:
                    case 0x1e:
                    case 0x1f:
7000
                    {
7001 7002 7003
                        // from c (1 byte) to \uxxxx (6 bytes)
                        return res + 5;
                    }
7004

7005 7006
                    default:
                    {
7007 7008 7009 7010 7011 7012 7013
                        return res;
                    }
                }
            });
        }

        /*!
N
Niels Lohmann 已提交
7014
        @brief dump escaped string
7015

N
Niels Lohmann 已提交
7016 7017 7018 7019
        Escape a string by replacing certain special characters by a sequence
        of an escape character (backslash) and another character and other
        control characters by a sequence of "\u" followed by a four-digit hex
        representation. The escaped string is written to output stream @a o.
7020 7021 7022 7023 7024

        @param[in] s  the string to escape

        @complexity Linear in the length of string @a s.
        */
7025
        void dump_escaped(const string_t& s) const
7026 7027 7028 7029
        {
            const auto space = extra_space(s);
            if (space == 0)
            {
7030
                o->write_characters(s.c_str(), s.size());
7031
                return;
7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097
            }

            // create a result string of necessary size
            string_t result(s.size() + space, '\\');
            std::size_t pos = 0;

            for (const auto& c : s)
            {
                switch (c)
                {
                    // quotation mark (0x22)
                    case '"':
                    {
                        result[pos + 1] = '"';
                        pos += 2;
                        break;
                    }

                    // reverse solidus (0x5c)
                    case '\\':
                    {
                        // nothing to change
                        pos += 2;
                        break;
                    }

                    // backspace (0x08)
                    case '\b':
                    {
                        result[pos + 1] = 'b';
                        pos += 2;
                        break;
                    }

                    // formfeed (0x0c)
                    case '\f':
                    {
                        result[pos + 1] = 'f';
                        pos += 2;
                        break;
                    }

                    // newline (0x0a)
                    case '\n':
                    {
                        result[pos + 1] = 'n';
                        pos += 2;
                        break;
                    }

                    // carriage return (0x0d)
                    case '\r':
                    {
                        result[pos + 1] = 'r';
                        pos += 2;
                        break;
                    }

                    // horizontal tab (0x09)
                    case '\t':
                    {
                        result[pos + 1] = 't';
                        pos += 2;
                        break;
                    }

7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124
                    case 0x00:
                    case 0x01:
                    case 0x02:
                    case 0x03:
                    case 0x04:
                    case 0x05:
                    case 0x06:
                    case 0x07:
                    case 0x0b:
                    case 0x0e:
                    case 0x0f:
                    case 0x10:
                    case 0x11:
                    case 0x12:
                    case 0x13:
                    case 0x14:
                    case 0x15:
                    case 0x16:
                    case 0x17:
                    case 0x18:
                    case 0x19:
                    case 0x1a:
                    case 0x1b:
                    case 0x1c:
                    case 0x1d:
                    case 0x1e:
                    case 0x1f:
7125
                    {
7126 7127 7128
                        // convert a number 0..15 to its hex representation
                        // (0..f)
                        static const char hexify[16] =
7129
                        {
7130 7131 7132 7133 7134 7135 7136 7137
                            '0', '1', '2', '3', '4', '5', '6', '7',
                            '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'
                        };

                        // print character c as \uxxxx
                        for (const char m :
                    { 'u', '0', '0', hexify[c >> 4], hexify[c & 0x0f]
                        })
7138
                        {
7139
                            result[++pos] = m;
7140
                        }
7141 7142 7143 7144 7145 7146 7147 7148 7149

                        ++pos;
                        break;
                    }

                    default:
                    {
                        // all other characters are added as-is
                        result[pos++] = c;
7150 7151 7152 7153 7154
                        break;
                    }
                }
            }

7155
            assert(pos == s.size() + space);
7156
            o->write_characters(result.c_str(), result.size());
7157 7158
        }

N
Niels Lohmann 已提交
7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170
        /*!
        @brief dump an integer

        Dump a given integer to output stream @a o. Works internally with
        @a number_buffer.

        @param[in] x  integer number (signed or unsigned) to dump
        @tparam NumberType either @a number_integer_t or @a number_unsigned_t
        */
        template<typename NumberType, detail::enable_if_t <
                     std::is_same<NumberType, number_unsigned_t>::value or
                     std::is_same<NumberType, number_integer_t>::value, int> = 0>
7171
        void dump_integer(NumberType x)
7172
        {
7173 7174
            // special case for "0"
            if (x == 0)
7175
            {
7176
                o->write_character('0');
7177
                return;
7178 7179
            }

7180 7181 7182 7183
            const bool is_negative = x < 0;
            size_t i = 0;

            // spare 1 byte for '\0'
N
Niels Lohmann 已提交
7184
            while (x != 0 and i < number_buffer.size() - 1)
7185
            {
7186
                const auto digit = std::labs(static_cast<long>(x % 10));
N
Niels Lohmann 已提交
7187
                number_buffer[i++] = static_cast<char>('0' + digit);
7188
                x /= 10;
7189 7190
            }

7191 7192
            // make sure the number has been processed completely
            assert(x == 0);
7193

7194
            if (is_negative)
7195
            {
7196
                // make sure there is capacity for the '-'
N
Niels Lohmann 已提交
7197 7198
                assert(i < number_buffer.size() - 2);
                number_buffer[i++] = '-';
7199
            }
7200

N
Niels Lohmann 已提交
7201
            std::reverse(number_buffer.begin(), number_buffer.begin() + i);
7202
            o->write_characters(number_buffer.data(), i);
7203
        }
7204

N
Niels Lohmann 已提交
7205 7206 7207 7208 7209 7210 7211 7212
        /*!
        @brief dump a floating-point number

        Dump a given floating-point number to output stream @a o. Works
        internally with @a number_buffer.

        @param[in] x  floating-point number to dump
        */
7213
        void dump_float(number_float_t x)
7214
        {
7215 7216 7217
            // NaN / inf
            if (not std::isfinite(x) or std::isnan(x))
            {
7218
                o->write_characters("null", 4);
7219 7220 7221
                return;
            }

7222 7223 7224 7225
            // special case for 0.0 and -0.0
            if (x == 0)
            {
                if (std::signbit(x))
7226
                {
7227
                    o->write_characters("-0.0", 4);
7228
                }
7229
                else
7230
                {
7231
                    o->write_characters("0.0", 3);
7232
                }
7233
                return;
7234 7235
            }

7236 7237
            // get number of digits for a text -> float -> text round-trip
            static constexpr auto d = std::numeric_limits<number_float_t>::digits10;
7238

7239
            // the actual conversion
7240 7241
            std::ptrdiff_t len = snprintf(number_buffer.data(), number_buffer.size(),
                                          "%.*g", d, x);
7242

7243
            // negative value indicates an error
N
Niels Lohmann 已提交
7244
            assert(len > 0);
7245
            // check if buffer was large enough
N
Niels Lohmann 已提交
7246
            assert(static_cast<size_t>(len) < number_buffer.size());
7247

7248 7249 7250
            // erase thousands separator
            if (thousands_sep != '\0')
            {
N
Niels Lohmann 已提交
7251 7252 7253 7254 7255 7256
                const auto end = std::remove(number_buffer.begin(),
                                             number_buffer.begin() + len,
                                             thousands_sep);
                std::fill(end, number_buffer.end(), '\0');
                assert((end - number_buffer.begin()) <= len);
                len = (end - number_buffer.begin());
7257
            }
7258

7259 7260 7261
            // convert decimal point to '.'
            if (decimal_point != '\0' and decimal_point != '.')
            {
N
Niels Lohmann 已提交
7262
                for (auto& c : number_buffer)
7263
                {
7264
                    if (c == decimal_point)
7265
                    {
7266 7267
                        c = '.';
                        break;
7268 7269
                    }
                }
7270
            }
7271

7272
            o->write_characters(number_buffer.data(), static_cast<size_t>(len));
N
Niels Lohmann 已提交
7273

7274
            // determine if need to append ".0"
N
Niels Lohmann 已提交
7275 7276 7277
            const bool value_is_int_like = std::none_of(number_buffer.begin(),
                                           number_buffer.begin() + len + 1,
                                           [](char c)
7278
            {
N
Niels Lohmann 已提交
7279 7280
                return c == '.' or c == 'e';
            });
7281

7282 7283
            if (value_is_int_like)
            {
7284
                o->write_characters(".0", 2);
7285
            }
7286
        }
7287 7288

      private:
N
Niels Lohmann 已提交
7289
        /// the output of the serializer
7290
        output_adapter_t<char> o = nullptr;
7291 7292

        /// a (hopefully) large enough character buffer
N
Niels Lohmann 已提交
7293
        std::array<char, 64> number_buffer{{}};
7294

N
Niels Lohmann 已提交
7295
        /// the locale
7296
        const std::lconv* loc = nullptr;
N
Niels Lohmann 已提交
7297
        /// the locale's thousand separator character
7298
        const char thousands_sep = '\0';
N
Niels Lohmann 已提交
7299
        /// the locale's decimal point character
7300 7301
        const char decimal_point = '\0';

7302 7303 7304
        /// the indentation character
        const char indent_char;

N
Niels Lohmann 已提交
7305
        /// the indentation string
7306
        string_t indent_string;
7307 7308 7309
    };

  public:
N
Niels 已提交
7310 7311 7312 7313
    /*!
    @brief serialize to stream

    Serialize the given JSON value @a j to the output stream @a o. The JSON
7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324
    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)`.

    - The indentation characrer can be controlled with the member variable
      `fill` of the output stream @a o. For instance, the manipulator
      `std::setfill('\\t')` sets indentation to use a tab character rather than
      the default space character.
N
Niels 已提交
7325 7326 7327 7328 7329 7330 7331 7332

    @param[in,out] o  stream to serialize to
    @param[in] j  JSON value to serialize

    @return the stream @a o

    @complexity Linear.

N
Niels 已提交
7333 7334
    @liveexample{The example below shows the serialization with different
    parameters to `width` to adjust the indentation level.,operator_serialize}
N
Niels 已提交
7335

7336
    @since version 1.0.0; indentaction character added in version 3.0.0
N
Niels 已提交
7337
    */
N
Niels 已提交
7338 7339
    friend std::ostream& operator<<(std::ostream& o, const basic_json& j)
    {
N
Niels 已提交
7340
        // read width member and use it as indentation parameter if nonzero
N
Niels 已提交
7341 7342
        const bool pretty_print = (o.width() > 0);
        const auto indentation = (pretty_print ? o.width() : 0);
N
Niels 已提交
7343

N
Niels 已提交
7344 7345
        // reset width to 0 for subsequent calls to this stream
        o.width(0);
7346

N
Niels 已提交
7347
        // do the actual serialization
7348
        serializer s(output_adapter<char>::create(o), o.fill());
7349
        s.dump(j, pretty_print, static_cast<unsigned int>(indentation));
N
Niels 已提交
7350 7351 7352
        return o;
    }

N
Niels 已提交
7353 7354
    /*!
    @brief serialize to stream
7355 7356 7357 7358
    @deprecated This stream operator is deprecated and will be removed in a
                future version of the library. Please use
                @ref std::ostream& operator<<(std::ostream&, const basic_json&)
                instead; that is, replace calls like `j >> o;` with `o << j;`.
N
Niels 已提交
7359
    */
7360
    JSON_DEPRECATED
N
Niels 已提交
7361 7362
    friend std::ostream& operator>>(const basic_json& j, std::ostream& o)
    {
N
Niels 已提交
7363
        return o << j;
N
Niels 已提交
7364 7365
    }

N
Niels 已提交
7366 7367
    /// @}

N
Niels 已提交
7368 7369 7370 7371 7372

    /////////////////////
    // deserialization //
    /////////////////////

N
Niels 已提交
7373 7374 7375
    /// @name deserialization
    /// @{

N
Niels 已提交
7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391
    /*!
    @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

7392 7393
    @throw parse_error.101 if a parse error occurs; example: `""unexpected end
    of input; expected string literal""`
N
Niels Lohmann 已提交
7394 7395
    @throw parse_error.102 if to_unicode fails or surrogate error
    @throw parse_error.103 if to_unicode fails
7396

N
Niels 已提交
7397 7398 7399 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
    @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

N
Niels Lohmann 已提交
7427 7428 7429 7430
    @throw parse_error.101 in case of an unexpected token
    @throw parse_error.102 if to_unicode fails or surrogate error
    @throw parse_error.103 if to_unicode fails

N
Niels 已提交
7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446
    @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)
    */
7447 7448 7449 7450 7451
    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 已提交
7452 7453
                            const parser_callback_t cb = nullptr)
    {
7454
        return parser(input_adapter::create(s), cb).parse(true);
N
Niels 已提交
7455 7456
    }

N
Niels 已提交
7457 7458 7459 7460
    /*!
    @brief deserialize from stream

    @param[in,out] i  stream to read a serialized JSON value from
N
Niels 已提交
7461 7462 7463
    @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 已提交
7464 7465 7466

    @return result of the deserialization

N
Niels Lohmann 已提交
7467 7468 7469 7470 7471
    @throw parse_error.101 in case of an unexpected token
    @throw parse_error.102 if to_unicode fails or surrogate error
    @throw parse_error.103 if to_unicode fails
    @throw parse_error.111 if input stream is in a bad state

N
Niels 已提交
7472 7473 7474 7475
    @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 已提交
7476 7477
    @note A UTF-8 byte order mark is silently ignored.

N
Niels 已提交
7478 7479
    @liveexample{The example below demonstrates the `parse()` function with
    and without callback function.,parse__istream__parser_callback_t}
N
Niels 已提交
7480

7481
    @sa @ref parse(const CharT, const parser_callback_t) for a version
N
Niels 已提交
7482
    that reads from a string
N
Niels 已提交
7483

N
Niels 已提交
7484
    @since version 1.0.0
N
Niels 已提交
7485
    */
N
Niels 已提交
7486 7487
    static basic_json parse(std::istream& i,
                            const parser_callback_t cb = nullptr)
N
Niels 已提交
7488
    {
7489
        return parser(input_adapter::create(i), cb).parse(true);
N
Niels 已提交
7490 7491
    }

N
Niels 已提交
7492
    /*!
N
Niels 已提交
7493
    @copydoc parse(std::istream&, const parser_callback_t)
N
Niels 已提交
7494
    */
N
Niels 已提交
7495 7496
    static basic_json parse(std::istream&& i,
                            const parser_callback_t cb = nullptr)
N
Cleanup  
Niels 已提交
7497
    {
7498
        return parser(input_adapter::create(i), cb).parse(true);
N
Cleanup  
Niels 已提交
7499 7500
    }

7501
    /*!
N
Niels 已提交
7502
    @brief deserialize from an iterator range with contiguous storage
7503

7504 7505
    This function reads from an iterator range of a container with contiguous
    storage of 1-byte values. Compatible container types include
7506 7507 7508 7509 7510 7511 7512 7513 7514
    `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
7515
    with a static assertion.**
7516

N
Niels 已提交
7517 7518 7519 7520
    @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.
7521

N
Niels 已提交
7522
    @tparam IteratorType iterator of container with contiguous storage
N
Niels 已提交
7523 7524 7525
    @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
7526 7527 7528 7529 7530
    which is used to control the deserialization by filtering unwanted values
    (optional)

    @return result of the deserialization

N
Niels Lohmann 已提交
7531 7532 7533 7534
    @throw parse_error.101 in case of an unexpected token
    @throw parse_error.102 if to_unicode fails or surrogate error
    @throw parse_error.103 if to_unicode fails

7535 7536 7537 7538 7539 7540
    @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 已提交
7541 7542
    @liveexample{The example below demonstrates the `parse()` function reading
    from an iterator range.,parse__iteratortype__parser_callback_t}
7543 7544 7545

    @since version 2.0.3
    */
N
Niels 已提交
7546 7547 7548 7549
    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>
7550 7551 7552
    static basic_json parse(IteratorType first, IteratorType last,
                            const parser_callback_t cb = nullptr)
    {
7553
        return parser(input_adapter::create(first, last), cb).parse(true);
7554 7555
    }

N
Niels 已提交
7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576
    /*!
    @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 已提交
7577
    @tparam ContiguousContainer container type with contiguous storage
N
Niels 已提交
7578 7579 7580 7581 7582 7583 7584
    @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

N
Niels Lohmann 已提交
7585 7586 7587 7588
    @throw parse_error.101 in case of an unexpected token
    @throw parse_error.102 if to_unicode fails or surrogate error
    @throw parse_error.103 if to_unicode fails

N
Niels 已提交
7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599
    @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 已提交
7600
    template<class ContiguousContainer, typename std::enable_if<
N
Niels 已提交
7601
                 not std::is_pointer<ContiguousContainer>::value and
7602 7603
                 std::is_base_of<
                     std::random_access_iterator_tag,
N
Niels 已提交
7604
                     typename std::iterator_traits<decltype(std::begin(std::declval<ContiguousContainer const>()))>::iterator_category>::value
7605 7606 7607 7608 7609 7610 7611 7612
                 , 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);
    }

7613 7614 7615 7616 7617 7618 7619 7620 7621 7622
    /*!
    @brief deserialize from stream
    @deprecated This stream operator is deprecated and will be removed in a
                future version of the library. Please use
                @ref std::istream& operator>>(std::istream&, basic_json&)
                instead; that is, replace calls like `j << i;` with `i >> j;`.
    */
    JSON_DEPRECATED
    friend std::istream& operator<<(basic_json& j, std::istream& i)
    {
N
Niels Lohmann 已提交
7623
        j = parser(input_adapter::create(i)).parse(false);
7624 7625 7626
        return i;
    }

N
Niels 已提交
7627 7628 7629 7630 7631 7632 7633 7634
    /*!
    @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

N
Niels Lohmann 已提交
7635 7636 7637 7638
    @throw parse_error.101 in case of an unexpected token
    @throw parse_error.102 if to_unicode fails or surrogate error
    @throw parse_error.103 if to_unicode fails
    @throw parse_error.111 if input stream is in a bad state
N
Niels 已提交
7639 7640 7641 7642

    @complexity Linear in the length of the input. The parser is a predictive
    LL(1) parser.

N
Niels 已提交
7643 7644
    @note A UTF-8 byte order mark is silently ignored.

N
Niels 已提交
7645 7646 7647
    @liveexample{The example below shows how a JSON value is constructed by
    reading a serialization from a stream.,operator_deserialize}

N
Niels 已提交
7648 7649
    @sa parse(std::istream&, const parser_callback_t) for a variant with a
    parser callback function to filter values while parsing
N
Niels 已提交
7650

N
Niels 已提交
7651
    @since version 1.0.0
N
Niels 已提交
7652 7653
    */
    friend std::istream& operator>>(std::istream& i, basic_json& j)
N
Niels 已提交
7654
    {
N
Niels Lohmann 已提交
7655
        j = parser(input_adapter::create(i)).parse(false);
N
Niels 已提交
7656 7657 7658
        return i;
    }

N
Niels 已提交
7659 7660
    /// @}

N
Niels 已提交
7661 7662 7663 7664
    ///////////////////////////
    // convenience functions //
    ///////////////////////////

N
Niels 已提交
7665 7666 7667 7668 7669 7670
    /*!
    @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 已提交
7671
    @return basically a string representation of a the @a m_type member
N
Niels 已提交
7672 7673 7674

    @complexity Constant.

7675
    @liveexample{The following code exemplifies `type_name()` for all JSON
7676
    types.,type_name}
7677

7678
    @since version 1.0.0, public since 2.1.0
N
Niels 已提交
7679
    */
T
Théo DELRIEU 已提交
7680 7681
    std::string type_name() const
    {
T
Théo DELRIEU 已提交
7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700
        {
            switch (m_type)
            {
                case value_t::null:
                    return "null";
                case value_t::object:
                    return "object";
                case value_t::array:
                    return "array";
                case value_t::string:
                    return "string";
                case value_t::boolean:
                    return "boolean";
                case value_t::discarded:
                    return "discarded";
                default:
                    return "number";
            }
        }
T
Théo DELRIEU 已提交
7701
    }
N
Niels 已提交
7702 7703 7704 7705 7706 7707 7708 7709


  private:
    //////////////////////
    // member variables //
    //////////////////////

    /// the type of the current element
N
Niels 已提交
7710
    value_t m_type = value_t::null;
N
Niels 已提交
7711 7712 7713 7714

    /// the value of the current element
    json_value m_value = {};

N
Niels 已提交
7715

N
Niels 已提交
7716
  private:
N
Niels 已提交
7717 7718 7719 7720
    ///////////////
    // iterators //
    ///////////////

7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731
    /*!
    @brief an iterator for primitive JSON types

    This class models an iterator for primitive JSON types (boolean, number,
    string). It's only purpose is to allow the iterator/const_iterator classes
    to "iterate" over primitive values. Internally, the iterator is modeled by
    a `difference_type` variable. Value begin_value (`0`) models the begin,
    end_value (`1`) models past the end.
    */
    class primitive_iterator_t
    {
T
Théo DELRIEU 已提交
7732
      public:
T
Théo Delrieu 已提交
7733 7734

        difference_type get_value() const noexcept
T
Théo DELRIEU 已提交
7735 7736 7737 7738 7739 7740 7741 7742
        {
            return m_it;
        }
        /// set iterator to a defined beginning
        void set_begin() noexcept
        {
            m_it = begin_value;
        }
7743

T
Théo DELRIEU 已提交
7744 7745 7746 7747 7748
        /// set iterator to a defined past the end
        void set_end() noexcept
        {
            m_it = end_value;
        }
7749

T
Théo DELRIEU 已提交
7750 7751 7752 7753 7754
        /// return whether the iterator can be dereferenced
        constexpr bool is_begin() const noexcept
        {
            return (m_it == begin_value);
        }
7755

T
Théo DELRIEU 已提交
7756 7757 7758 7759 7760
        /// return whether the iterator is at end
        constexpr bool is_end() const noexcept
        {
            return (m_it == end_value);
        }
7761

T
Théo DELRIEU 已提交
7762 7763 7764 7765
        friend constexpr bool operator==(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it == rhs.m_it;
        }
T
Théo Delrieu 已提交
7766

T
Théo DELRIEU 已提交
7767 7768 7769 7770
        friend constexpr bool operator!=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return !(lhs == rhs);
        }
T
Théo Delrieu 已提交
7771

T
Théo DELRIEU 已提交
7772 7773 7774 7775
        friend constexpr bool operator<(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it < rhs.m_it;
        }
T
Théo Delrieu 已提交
7776

T
Théo DELRIEU 已提交
7777 7778 7779 7780
        friend constexpr bool operator<=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it <= rhs.m_it;
        }
T
Théo Delrieu 已提交
7781

T
Théo DELRIEU 已提交
7782 7783 7784 7785
        friend constexpr bool operator>(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it > rhs.m_it;
        }
T
Théo Delrieu 已提交
7786

T
Théo DELRIEU 已提交
7787 7788 7789 7790
        friend constexpr bool operator>=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it >= rhs.m_it;
        }
T
Théo Delrieu 已提交
7791

T
Théo DELRIEU 已提交
7792 7793 7794 7795 7796 7797
        primitive_iterator_t operator+(difference_type i)
        {
            auto result = *this;
            result += i;
            return result;
        }
T
Théo Delrieu 已提交
7798

T
Théo DELRIEU 已提交
7799 7800 7801 7802
        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 已提交
7803

T
Théo DELRIEU 已提交
7804 7805 7806 7807
        friend std::ostream& operator<<(std::ostream& os, primitive_iterator_t it)
        {
            return os << it.m_it;
        }
T
Théo Delrieu 已提交
7808

T
Théo DELRIEU 已提交
7809 7810 7811 7812 7813
        primitive_iterator_t& operator++()
        {
            ++m_it;
            return *this;
        }
T
Théo Delrieu 已提交
7814

N
Niels Lohmann 已提交
7815
        primitive_iterator_t operator++(int)
T
Théo DELRIEU 已提交
7816
        {
N
Niels Lohmann 已提交
7817
            auto result = *this;
T
Théo DELRIEU 已提交
7818
            m_it++;
N
Niels Lohmann 已提交
7819
            return result;
T
Théo DELRIEU 已提交
7820
        }
T
Théo Delrieu 已提交
7821

T
Théo DELRIEU 已提交
7822 7823 7824 7825 7826
        primitive_iterator_t& operator--()
        {
            --m_it;
            return *this;
        }
T
Théo Delrieu 已提交
7827

N
Niels Lohmann 已提交
7828
        primitive_iterator_t operator--(int)
T
Théo DELRIEU 已提交
7829
        {
N
Niels Lohmann 已提交
7830
            auto result = *this;
T
Théo DELRIEU 已提交
7831
            m_it--;
N
Niels Lohmann 已提交
7832
            return result;
T
Théo DELRIEU 已提交
7833
        }
T
Théo Delrieu 已提交
7834

T
Théo DELRIEU 已提交
7835 7836 7837 7838 7839
        primitive_iterator_t& operator+=(difference_type n)
        {
            m_it += n;
            return *this;
        }
7840

T
Théo DELRIEU 已提交
7841 7842 7843 7844 7845
        primitive_iterator_t& operator-=(difference_type n)
        {
            m_it -= n;
            return *this;
        }
7846

T
Théo DELRIEU 已提交
7847 7848 7849
      private:
        static constexpr difference_type begin_value = 0;
        static constexpr difference_type end_value = begin_value + 1;
7850

T
Théo DELRIEU 已提交
7851 7852 7853
        /// iterator as signed integer type
        difference_type m_it = std::numeric_limits<std::ptrdiff_t>::denorm_min();
    };
7854

N
Niels 已提交
7855 7856 7857 7858 7859 7860 7861 7862
    /*!
    @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 已提交
7863 7864
    {
        /// iterator for JSON objects
N
Niels 已提交
7865
        typename object_t::iterator object_iterator;
N
Niels 已提交
7866
        /// iterator for JSON arrays
N
Niels 已提交
7867
        typename array_t::iterator array_iterator;
N
Niels 已提交
7868
        /// generic iterator for all other types
N
Niels 已提交
7869 7870 7871
        primitive_iterator_t primitive_iterator;

        /// create an uninitialized internal_iterator
N
Niels 已提交
7872
        internal_iterator() noexcept
T
Théo DELRIEU 已提交
7873 7874
            : object_iterator(), array_iterator(), primitive_iterator()
        {}
N
Niels 已提交
7875 7876
    };

N
cleanup  
Niels 已提交
7877 7878 7879 7880
    /// proxy class for the iterator_wrapper functions
    template<typename IteratorType>
    class iteration_proxy
    {
T
Théo DELRIEU 已提交
7881
      private:
N
cleanup  
Niels 已提交
7882 7883 7884
        /// helper class for iteration
        class iteration_proxy_internal
        {
T
Théo DELRIEU 已提交
7885
          private:
N
cleanup  
Niels 已提交
7886 7887 7888 7889 7890
            /// the iterator
            IteratorType anchor;
            /// an index for arrays (used to create key names)
            size_t array_index = 0;

T
Théo DELRIEU 已提交
7891
          public:
N
Niels 已提交
7892
            explicit iteration_proxy_internal(IteratorType it) noexcept
7893
                : anchor(it)
T
Théo DELRIEU 已提交
7894
            {}
N
cleanup  
Niels 已提交
7895

T
Théo DELRIEU 已提交
7896 7897 7898 7899 7900
            /// dereference operator (needed for range-based for)
            iteration_proxy_internal& operator*()
            {
                return *this;
            }
7901

T
Théo DELRIEU 已提交
7902 7903 7904 7905 7906
            /// increment operator (needed for range-based for)
            iteration_proxy_internal& operator++()
            {
                ++anchor;
                ++array_index;
7907

T
Théo DELRIEU 已提交
7908 7909
                return *this;
            }
N
cleanup  
Niels 已提交
7910

T
Théo DELRIEU 已提交
7911 7912
            /// inequality operator (needed for range-based for)
            bool operator!= (const iteration_proxy_internal& o) const
N
cleanup  
Niels 已提交
7913
            {
T
Théo DELRIEU 已提交
7914
                return anchor != o.anchor;
N
cleanup  
Niels 已提交
7915 7916
            }

T
Théo DELRIEU 已提交
7917 7918
            /// return key of the iterator
            typename basic_json::string_t key() const
N
cleanup  
Niels 已提交
7919
            {
T
Théo DELRIEU 已提交
7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941
                assert(anchor.m_object != nullptr);

                switch (anchor.m_object->type())
                {
                    // use integer array index as key
                    case value_t::array:
                    {
                        return std::to_string(array_index);
                    }

                    // use key from the object
                    case value_t::object:
                    {
                        return anchor.key();
                    }

                    // use an empty key for all primitive types
                    default:
                    {
                        return "";
                    }
                }
N
cleanup  
Niels 已提交
7942 7943
            }

T
Théo DELRIEU 已提交
7944 7945
            /// return value of the iterator
            typename IteratorType::reference value() const
N
cleanup  
Niels 已提交
7946
            {
T
Théo DELRIEU 已提交
7947
                return anchor.value();
N
cleanup  
Niels 已提交
7948 7949 7950
            }
        };

T
Théo DELRIEU 已提交
7951 7952
        /// the container to iterate
        typename IteratorType::reference container;
N
cleanup  
Niels 已提交
7953

T
Théo DELRIEU 已提交
7954 7955 7956 7957 7958
      public:
        /// construct iteration proxy from a container
        explicit iteration_proxy(typename IteratorType::reference cont)
            : container(cont)
        {}
N
cleanup  
Niels 已提交
7959

T
Théo DELRIEU 已提交
7960 7961 7962 7963 7964
        /// return iterator begin (needed for range-based for)
        iteration_proxy_internal begin() noexcept
        {
            return iteration_proxy_internal(container.begin());
        }
N
cleanup  
Niels 已提交
7965

T
Théo DELRIEU 已提交
7966 7967 7968 7969 7970 7971
        /// return iterator end (needed for range-based for)
        iteration_proxy_internal end() noexcept
        {
            return iteration_proxy_internal(container.end());
        }
    };
N
cleanup  
Niels 已提交
7972

N
Niels 已提交
7973
  public:
N
Niels 已提交
7974
    /*!
7975
    @brief a template for a random access iterator for the @ref basic_json class
N
Niels 已提交
7976

N
Niels Lohmann 已提交
7977 7978
    This class implements a both iterators (iterator and const_iterator) for the
    @ref basic_json class.
N
Niels 已提交
7979

N
Niels 已提交
7980 7981 7982
    @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 已提交
7983 7984
          methods are undefined. **The library uses assertions to detect calls
          on uninitialized iterators.**
N
Niels 已提交
7985

N
Niels 已提交
7986 7987 7988 7989
    @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 已提交
7990

N
Niels Lohmann 已提交
7991
    @since version 1.0.0, simplified in version 2.0.9
N
Niels 已提交
7992
    */
N
Niels Lohmann 已提交
7993
    template<typename U>
T
Théo DELRIEU 已提交
7994
    class iter_impl : public std::iterator<std::random_access_iterator_tag, U>
N
Niels 已提交
7995
    {
N
Niels 已提交
7996
        /// allow basic_json to access private members
7997 7998
        friend class basic_json;

7999 8000 8001 8002 8003
        // make sure U is basic_json or const basic_json
        static_assert(std::is_same<U, basic_json>::value
                      or std::is_same<U, const basic_json>::value,
                      "iter_impl only accepts (const) basic_json");

T
Théo DELRIEU 已提交
8004
      public:
N
Niels 已提交
8005
        /// the type of the values when the iterator is dereferenced
N
Niels 已提交
8006
        using value_type = typename basic_json::value_type;
N
Niels 已提交
8007
        /// a type to represent differences between iterators
N
Niels 已提交
8008
        using difference_type = typename basic_json::difference_type;
N
Niels 已提交
8009
        /// defines a pointer to the type iterated over (value_type)
8010
        using pointer = typename std::conditional<std::is_const<U>::value,
T
Théo DELRIEU 已提交
8011 8012
              typename basic_json::const_pointer,
              typename basic_json::pointer>::type;
N
Niels 已提交
8013
        /// defines a reference to the type iterated over (value_type)
8014
        using reference = typename std::conditional<std::is_const<U>::value,
T
Théo DELRIEU 已提交
8015 8016
              typename basic_json::const_reference,
              typename basic_json::reference>::type;
N
Niels 已提交
8017
        /// the category of the iterator
N
Niels 已提交
8018
        using iterator_category = std::bidirectional_iterator_tag;
N
Niels 已提交
8019

8020
        /// default constructor
8021
        iter_impl() = default;
8022

N
Niels 已提交
8023 8024 8025 8026 8027 8028
        /*!
        @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`.
        */
8029
        explicit iter_impl(pointer object) noexcept
T
Théo DELRIEU 已提交
8030
            : m_object(object)
8031
        {
T
Théo DELRIEU 已提交
8032
            assert(m_object != nullptr);
8033

T
Théo DELRIEU 已提交
8034
            switch (m_object->m_type)
8035
            {
T
Théo DELRIEU 已提交
8036 8037 8038 8039 8040
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = typename object_t::iterator();
                    break;
                }
8041

T
Théo DELRIEU 已提交
8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052
                case basic_json::value_t::array:
                {
                    m_it.array_iterator = typename array_t::iterator();
                    break;
                }

                default:
                {
                    m_it.primitive_iterator = primitive_iterator_t();
                    break;
                }
N
Niels 已提交
8053 8054
            }
        }
N
Niels 已提交
8055

8056
        /*!
8057 8058
        @note The conventional copy constructor and copy assignment are
              implicitly defined.
H
HenryLee 已提交
8059 8060 8061
              Combined with the following converting constructor and assigment,
              they support: copy from iterator to iterator,
                            copy from const iterator to const iterator,
8062
                            and conversion from iterator to const iterator.
8063
              However conversion from const iterator to iterator is not defined.
T
Théo DELRIEU 已提交
8064
        */
8065

8066 8067 8068 8069 8070 8071 8072 8073
        /*!
        @brief converting constructor
        @param[in] other  non-const iterator to copy from
        @note It is not checked whether @a other is initialized.
        */
        iter_impl(const iter_impl<basic_json>& other) noexcept
            : m_object(other.m_object), m_it(other.m_it)
        {}
N
Niels 已提交
8074

T
Théo DELRIEU 已提交
8075
        /*!
8076
        @brief converting assignment
8077
        @param[in,out] other  non-const iterator to copy from
H
HenryLee 已提交
8078
        @return const/non-const iterator
8079 8080 8081 8082
        @note It is not checked whether @a other is initialized.
        */
        iter_impl& operator=(iter_impl<basic_json> other) noexcept(
            std::is_nothrow_move_constructible<pointer>::value and
T
Théo DELRIEU 已提交
8083
            std::is_nothrow_move_assignable<pointer>::value and
8084 8085
            std::is_nothrow_move_constructible<struct internal_iterator>::value and
            std::is_nothrow_move_assignable<struct internal_iterator>::value
T
Théo DELRIEU 已提交
8086 8087 8088 8089 8090 8091
        )
        {
            std::swap(m_object, other.m_object);
            std::swap(m_it, other.m_it);
            return *this;
        }
N
Niels 已提交
8092

T
Théo DELRIEU 已提交
8093 8094 8095 8096 8097 8098
      private:
        /*!
        @brief set the iterator to the first value
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        void set_begin() noexcept
N
Niels 已提交
8099
        {
T
Théo DELRIEU 已提交
8100
            assert(m_object != nullptr);
N
Niels 已提交
8101

T
Théo DELRIEU 已提交
8102
            switch (m_object->m_type)
N
Niels 已提交
8103
            {
T
Théo DELRIEU 已提交
8104 8105 8106 8107 8108
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = m_object->m_value.object->begin();
                    break;
                }
N
Niels 已提交
8109

T
Théo DELRIEU 已提交
8110 8111 8112 8113 8114
                case basic_json::value_t::array:
                {
                    m_it.array_iterator = m_object->m_value.array->begin();
                    break;
                }
N
Niels 已提交
8115

T
Théo DELRIEU 已提交
8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127
                case basic_json::value_t::null:
                {
                    // set to end so begin()==end() is true: null is empty
                    m_it.primitive_iterator.set_end();
                    break;
                }

                default:
                {
                    m_it.primitive_iterator.set_begin();
                    break;
                }
N
Niels 已提交
8128 8129 8130
            }
        }

T
Théo DELRIEU 已提交
8131 8132 8133 8134 8135
        /*!
        @brief set the iterator past the last value
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        void set_end() noexcept
8136
        {
T
Théo DELRIEU 已提交
8137
            assert(m_object != nullptr);
N
Niels 已提交
8138

T
Théo DELRIEU 已提交
8139
            switch (m_object->m_type)
8140
            {
T
Théo DELRIEU 已提交
8141 8142 8143 8144 8145
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = m_object->m_value.object->end();
                    break;
                }
N
Niels 已提交
8146

T
Théo DELRIEU 已提交
8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157
                case basic_json::value_t::array:
                {
                    m_it.array_iterator = m_object->m_value.array->end();
                    break;
                }

                default:
                {
                    m_it.primitive_iterator.set_end();
                    break;
                }
N
Niels 已提交
8158 8159
            }
        }
N
Niels 已提交
8160

T
Théo DELRIEU 已提交
8161 8162 8163 8164 8165 8166
      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
8167
        {
T
Théo DELRIEU 已提交
8168
            assert(m_object != nullptr);
N
Niels 已提交
8169

T
Théo DELRIEU 已提交
8170
            switch (m_object->m_type)
8171
            {
T
Théo DELRIEU 已提交
8172 8173 8174 8175 8176
                case basic_json::value_t::object:
                {
                    assert(m_it.object_iterator != m_object->m_value.object->end());
                    return m_it.object_iterator->second;
                }
N
Niels Lohmann 已提交
8177

T
Théo DELRIEU 已提交
8178 8179 8180 8181 8182
                case basic_json::value_t::array:
                {
                    assert(m_it.array_iterator != m_object->m_value.array->end());
                    return *m_it.array_iterator;
                }
N
Niels 已提交
8183

T
Théo DELRIEU 已提交
8184
                case basic_json::value_t::null:
N
Niels 已提交
8185
                {
8186
                    JSON_THROW(invalid_iterator::create(214, "cannot get value"));
N
Niels 已提交
8187 8188
                }

T
Théo DELRIEU 已提交
8189 8190 8191 8192 8193 8194 8195
                default:
                {
                    if (m_it.primitive_iterator.is_begin())
                    {
                        return *m_object;
                    }

8196
                    JSON_THROW(invalid_iterator::create(214, "cannot get value"));
T
Théo DELRIEU 已提交
8197
                }
N
Niels 已提交
8198 8199 8200
            }
        }

T
Théo DELRIEU 已提交
8201 8202 8203 8204 8205
        /*!
        @brief dereference the iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        pointer operator->() const
N
Niels 已提交
8206
        {
T
Théo DELRIEU 已提交
8207
            assert(m_object != nullptr);
N
Niels 已提交
8208

T
Théo DELRIEU 已提交
8209
            switch (m_object->m_type)
N
Niels 已提交
8210
            {
T
Théo DELRIEU 已提交
8211 8212 8213 8214 8215
                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 已提交
8216

T
Théo DELRIEU 已提交
8217
                case basic_json::value_t::array:
N
Niels 已提交
8218
                {
T
Théo DELRIEU 已提交
8219 8220
                    assert(m_it.array_iterator != m_object->m_value.array->end());
                    return &*m_it.array_iterator;
N
Niels 已提交
8221 8222
                }

T
Théo DELRIEU 已提交
8223 8224 8225 8226 8227 8228 8229
                default:
                {
                    if (m_it.primitive_iterator.is_begin())
                    {
                        return m_object;
                    }

8230
                    JSON_THROW(invalid_iterator::create(214, "cannot get value"));
T
Théo DELRIEU 已提交
8231
                }
N
Niels 已提交
8232 8233 8234
            }
        }

T
Théo DELRIEU 已提交
8235 8236 8237 8238 8239 8240 8241 8242 8243 8244
        /*!
        @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 已提交
8245

T
Théo DELRIEU 已提交
8246 8247 8248 8249 8250
        /*!
        @brief pre-increment (++it)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator++()
8251
        {
T
Théo DELRIEU 已提交
8252
            assert(m_object != nullptr);
N
Niels 已提交
8253

T
Théo DELRIEU 已提交
8254
            switch (m_object->m_type)
8255
            {
T
Théo DELRIEU 已提交
8256 8257 8258 8259 8260
                case basic_json::value_t::object:
                {
                    std::advance(m_it.object_iterator, 1);
                    break;
                }
N
Niels 已提交
8261

T
Théo DELRIEU 已提交
8262 8263 8264 8265 8266
                case basic_json::value_t::array:
                {
                    std::advance(m_it.array_iterator, 1);
                    break;
                }
N
Niels 已提交
8267

T
Théo DELRIEU 已提交
8268 8269 8270 8271 8272 8273
                default:
                {
                    ++m_it.primitive_iterator;
                    break;
                }
            }
8274

T
Théo DELRIEU 已提交
8275 8276
            return *this;
        }
8277

T
Théo DELRIEU 已提交
8278 8279 8280 8281 8282 8283 8284 8285 8286 8287
        /*!
        @brief post-decrement (it--)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl operator--(int)
        {
            auto result = *this;
            --(*this);
            return result;
        }
8288

T
Théo DELRIEU 已提交
8289 8290 8291 8292 8293
        /*!
        @brief pre-decrement (--it)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator--()
N
Niels 已提交
8294
        {
T
Théo DELRIEU 已提交
8295 8296 8297
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
8298
            {
T
Théo DELRIEU 已提交
8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315
                case basic_json::value_t::object:
                {
                    std::advance(m_it.object_iterator, -1);
                    break;
                }

                case basic_json::value_t::array:
                {
                    std::advance(m_it.array_iterator, -1);
                    break;
                }

                default:
                {
                    --m_it.primitive_iterator;
                    break;
                }
N
Niels 已提交
8316 8317
            }

T
Théo DELRIEU 已提交
8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328
            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 已提交
8329
            {
8330
                JSON_THROW(invalid_iterator::create(212, "cannot compare iterators of different containers"));
8331
            }
N
Niels 已提交
8332

T
Théo DELRIEU 已提交
8333 8334 8335
            assert(m_object != nullptr);

            switch (m_object->m_type)
8336
            {
T
Théo DELRIEU 已提交
8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350
                case basic_json::value_t::object:
                {
                    return (m_it.object_iterator == other.m_it.object_iterator);
                }

                case basic_json::value_t::array:
                {
                    return (m_it.array_iterator == other.m_it.array_iterator);
                }

                default:
                {
                    return (m_it.primitive_iterator == other.m_it.primitive_iterator);
                }
N
Niels 已提交
8351 8352 8353
            }
        }

T
Théo DELRIEU 已提交
8354 8355 8356 8357 8358
        /*!
        @brief  comparison: not equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator!=(const iter_impl& other) const
N
Niels 已提交
8359
        {
T
Théo DELRIEU 已提交
8360
            return not operator==(other);
N
Niels 已提交
8361 8362
        }

T
Théo DELRIEU 已提交
8363 8364 8365 8366 8367
        /*!
        @brief  comparison: smaller
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator<(const iter_impl& other) const
N
Niels 已提交
8368
        {
T
Théo DELRIEU 已提交
8369 8370
            // if objects are not the same, the comparison is undefined
            if (m_object != other.m_object)
N
Niels 已提交
8371
            {
8372
                JSON_THROW(invalid_iterator::create(212, "cannot compare iterators of different containers"));
N
Niels 已提交
8373 8374
            }

T
Théo DELRIEU 已提交
8375
            assert(m_object != nullptr);
N
Niels 已提交
8376

T
Théo DELRIEU 已提交
8377
            switch (m_object->m_type)
8378
            {
T
Théo DELRIEU 已提交
8379 8380
                case basic_json::value_t::object:
                {
8381
                    JSON_THROW(invalid_iterator::create(213, "cannot compare order of object iterators"));
T
Théo DELRIEU 已提交
8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392
                }

                case basic_json::value_t::array:
                {
                    return (m_it.array_iterator < other.m_it.array_iterator);
                }

                default:
                {
                    return (m_it.primitive_iterator < other.m_it.primitive_iterator);
                }
N
Niels 已提交
8393 8394 8395
            }
        }

T
Théo DELRIEU 已提交
8396 8397 8398 8399 8400
        /*!
        @brief  comparison: less than or equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator<=(const iter_impl& other) const
N
Niels 已提交
8401
        {
T
Théo DELRIEU 已提交
8402
            return not other.operator < (*this);
N
Niels 已提交
8403 8404
        }

T
Théo DELRIEU 已提交
8405 8406 8407 8408 8409
        /*!
        @brief  comparison: greater than
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator>(const iter_impl& other) const
N
Niels 已提交
8410
        {
T
Théo DELRIEU 已提交
8411
            return not operator<=(other);
N
Niels 已提交
8412
        }
8413

T
Théo DELRIEU 已提交
8414 8415 8416 8417 8418 8419 8420 8421
        /*!
        @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);
        }
8422

T
Théo DELRIEU 已提交
8423 8424 8425 8426 8427
        /*!
        @brief  add to iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator+=(difference_type i)
N
Niels 已提交
8428
        {
T
Théo DELRIEU 已提交
8429 8430 8431
            assert(m_object != nullptr);

            switch (m_object->m_type)
8432
            {
T
Théo DELRIEU 已提交
8433 8434
                case basic_json::value_t::object:
                {
8435
                    JSON_THROW(invalid_iterator::create(209, "cannot use offsets with object iterators"));
T
Théo DELRIEU 已提交
8436
                }
8437

T
Théo DELRIEU 已提交
8438 8439 8440 8441 8442
                case basic_json::value_t::array:
                {
                    std::advance(m_it.array_iterator, i);
                    break;
                }
8443

T
Théo DELRIEU 已提交
8444 8445 8446 8447 8448
                default:
                {
                    m_it.primitive_iterator += i;
                    break;
                }
8449 8450
            }

T
Théo DELRIEU 已提交
8451 8452
            return *this;
        }
8453

T
Théo DELRIEU 已提交
8454 8455 8456 8457 8458 8459 8460 8461
        /*!
        @brief  subtract from iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator-=(difference_type i)
        {
            return operator+=(-i);
        }
8462

T
Théo DELRIEU 已提交
8463 8464 8465 8466 8467 8468 8469 8470 8471 8472
        /*!
        @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;
        }
8473

T
Théo DELRIEU 已提交
8474 8475 8476 8477 8478 8479 8480 8481 8482 8483
        /*!
        @brief  subtract from iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl operator-(difference_type i)
        {
            auto result = *this;
            result -= i;
            return result;
        }
N
Niels 已提交
8484

T
Théo DELRIEU 已提交
8485 8486 8487 8488 8489
        /*!
        @brief  return difference
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        difference_type operator-(const iter_impl& other) const
8490
        {
T
Théo DELRIEU 已提交
8491 8492 8493
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
8494
            {
T
Théo DELRIEU 已提交
8495 8496
                case basic_json::value_t::object:
                {
8497
                    JSON_THROW(invalid_iterator::create(209, "cannot use offsets with object iterators"));
T
Théo DELRIEU 已提交
8498
                }
N
Niels 已提交
8499

T
Théo DELRIEU 已提交
8500 8501 8502 8503
                case basic_json::value_t::array:
                {
                    return m_it.array_iterator - other.m_it.array_iterator;
                }
N
Niels 已提交
8504

T
Théo DELRIEU 已提交
8505 8506 8507 8508
                default:
                {
                    return m_it.primitive_iterator - other.m_it.primitive_iterator;
                }
N
Niels 已提交
8509 8510
            }
        }
N
Niels 已提交
8511

T
Théo DELRIEU 已提交
8512 8513 8514 8515 8516
        /*!
        @brief  access to successor
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        reference operator[](difference_type n) const
8517
        {
T
Théo DELRIEU 已提交
8518 8519 8520
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
8521
            {
T
Théo DELRIEU 已提交
8522 8523
                case basic_json::value_t::object:
                {
8524
                    JSON_THROW(invalid_iterator::create(208, "cannot use operator[] for object iterators"));
T
Théo DELRIEU 已提交
8525
                }
N
Niels 已提交
8526

T
Théo DELRIEU 已提交
8527 8528 8529 8530
                case basic_json::value_t::array:
                {
                    return *std::next(m_it.array_iterator, n);
                }
N
Niels 已提交
8531

T
Théo DELRIEU 已提交
8532 8533
                case basic_json::value_t::null:
                {
8534
                    JSON_THROW(invalid_iterator::create(214, "cannot get value"));
T
Théo DELRIEU 已提交
8535
                }
N
Niels 已提交
8536

T
Théo DELRIEU 已提交
8537
                default:
N
Niels 已提交
8538
                {
T
Théo DELRIEU 已提交
8539 8540 8541 8542
                    if (m_it.primitive_iterator.get_value() == -n)
                    {
                        return *m_object;
                    }
N
Niels Lohmann 已提交
8543

8544
                    JSON_THROW(invalid_iterator::create(214, "cannot get value"));
T
Théo DELRIEU 已提交
8545
                }
N
Niels 已提交
8546 8547
            }
        }
N
Niels 已提交
8548

T
Théo DELRIEU 已提交
8549 8550 8551 8552 8553
        /*!
        @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
8554
        {
T
Théo DELRIEU 已提交
8555 8556 8557 8558 8559 8560
            assert(m_object != nullptr);

            if (m_object->is_object())
            {
                return m_it.object_iterator->first;
            }
N
Niels Lohmann 已提交
8561

8562
            JSON_THROW(invalid_iterator::create(207, "cannot use key() for non-object iterators"));
T
Théo DELRIEU 已提交
8563
        }
N
Niels 已提交
8564

T
Théo DELRIEU 已提交
8565 8566 8567 8568 8569 8570 8571 8572
        /*!
        @brief  return the value of an iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        reference value() const
        {
            return operator*();
        }
N
Niels 已提交
8573

T
Théo DELRIEU 已提交
8574 8575 8576 8577
      private:
        /// associated JSON instance
        pointer m_object = nullptr;
        /// the actual iterator of the associated instance
8578
        struct internal_iterator m_it = internal_iterator();
T
Théo DELRIEU 已提交
8579
    };
N
Niels 已提交
8580

N
Niels 已提交
8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594
    /*!
    @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 已提交
8595

N
Niels 已提交
8596
    @since version 1.0.0
N
Niels 已提交
8597
    */
N
Niels 已提交
8598
    template<typename Base>
T
Théo DELRIEU 已提交
8599
    class json_reverse_iterator : public std::reverse_iterator<Base>
8600
    {
T
Théo DELRIEU 已提交
8601
      public:
8602
        /// shortcut to the reverse iterator adaptor
N
Niels 已提交
8603
        using base_iterator = std::reverse_iterator<Base>;
N
Niels 已提交
8604
        /// the reference type for the pointed-to element
N
Niels 已提交
8605
        using reference = typename Base::reference;
8606

8607
        /// create reverse iterator from iterator
N
Niels 已提交
8608
        json_reverse_iterator(const typename base_iterator::iterator_type& it) noexcept
T
Théo DELRIEU 已提交
8609 8610
            : base_iterator(it)
        {}
8611

T
Théo DELRIEU 已提交
8612 8613 8614 8615
        /// create reverse iterator from base class
        json_reverse_iterator(const base_iterator& it) noexcept
            : base_iterator(it)
        {}
8616

T
Théo DELRIEU 已提交
8617 8618 8619 8620 8621
        /// post-increment (it++)
        json_reverse_iterator operator++(int)
        {
            return base_iterator::operator++(1);
        }
8622

T
Théo DELRIEU 已提交
8623 8624 8625 8626 8627 8628
        /// pre-increment (++it)
        json_reverse_iterator& operator++()
        {
            base_iterator::operator++();
            return *this;
        }
8629

T
Théo DELRIEU 已提交
8630 8631 8632 8633 8634
        /// post-decrement (it--)
        json_reverse_iterator operator--(int)
        {
            return base_iterator::operator--(1);
        }
8635

T
Théo DELRIEU 已提交
8636 8637 8638 8639 8640 8641
        /// pre-decrement (--it)
        json_reverse_iterator& operator--()
        {
            base_iterator::operator--();
            return *this;
        }
8642

T
Théo DELRIEU 已提交
8643 8644 8645 8646 8647 8648
        /// add to iterator
        json_reverse_iterator& operator+=(difference_type i)
        {
            base_iterator::operator+=(i);
            return *this;
        }
8649

T
Théo DELRIEU 已提交
8650 8651 8652 8653 8654 8655 8656
        /// add to iterator
        json_reverse_iterator operator+(difference_type i) const
        {
            auto result = *this;
            result += i;
            return result;
        }
8657

T
Théo DELRIEU 已提交
8658 8659 8660 8661 8662 8663 8664
        /// subtract from iterator
        json_reverse_iterator operator-(difference_type i) const
        {
            auto result = *this;
            result -= i;
            return result;
        }
8665

T
Théo DELRIEU 已提交
8666 8667 8668 8669 8670
        /// return difference
        difference_type operator-(const json_reverse_iterator& other) const
        {
            return this->base() - other.base();
        }
8671

T
Théo DELRIEU 已提交
8672 8673 8674 8675 8676
        /// access to successor
        reference operator[](difference_type n) const
        {
            return *(this->operator+(n));
        }
N
Niels 已提交
8677

T
Théo DELRIEU 已提交
8678 8679 8680 8681 8682 8683
        /// return the key of an object iterator
        typename object_t::key_type key() const
        {
            auto it = --this->base();
            return it.key();
        }
8684

T
Théo DELRIEU 已提交
8685 8686 8687 8688 8689 8690 8691
        /// return the value of an iterator
        reference value() const
        {
            auto it = --this->base();
            return it.operator * ();
        }
    };
8692

N
Niels 已提交
8693

N
Niels 已提交
8694
  private:
N
Niels Lohmann 已提交
8695 8696 8697
    ////////////////////
    // input adapters //
    ////////////////////
N
Niels 已提交
8698

N
Niels Lohmann 已提交
8699 8700 8701 8702 8703 8704 8705
    /// abstract input adapter interface
    class input_adapter
    {
      public:
        virtual int get_character() = 0;
        virtual std::string read(size_t offset, size_t length) = 0;
        virtual ~input_adapter() {}
8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783

        // native support

        /// input adapter for input stream
        static std::shared_ptr<input_adapter> create(std::istream& i, const size_t buffer_size = 16384)
        {
            return std::shared_ptr<input_adapter>(new cached_input_stream_adapter(i, buffer_size));
        }

        /// input adapter for input stream
        static std::shared_ptr<input_adapter> create(std::istream&& i, const size_t buffer_size = 16384)
        {
            return std::shared_ptr<input_adapter>(new cached_input_stream_adapter(i, buffer_size));
        }

        /// input adapter for buffer
        static std::shared_ptr<input_adapter> create(const char* b, size_t l)
        {
            return std::shared_ptr<input_adapter>(new input_buffer_adapter(b, l));
        }

        // derived support

        /// input adapter for string literal
        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 std::shared_ptr<input_adapter> create(CharT b)
        {
            return create(reinterpret_cast<const char*>(b),
                          std::strlen(reinterpret_cast<const char*>(b)));
        }

        /// input adapter for 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>
        static std::shared_ptr<input_adapter> create(IteratorType first, IteratorType last)
        {
            // assertion to check that the iterator range is indeed contiguous,
            // see http://stackoverflow.com/a/35008842/266378 for more discussion
            assert(std::accumulate(first, last, std::pair<bool, int>(true, 0),
                                   [&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
            static_assert(sizeof(typename std::iterator_traits<IteratorType>::value_type) == 1,
                          "each element in the iterator range must have the size of 1 byte");

            return create(reinterpret_cast<const char*>(&(*first)),
                          static_cast<size_t>(std::distance(first, last)));
        }

        /// input adapter for array
        template<class T, std::size_t N>
        static std::shared_ptr<input_adapter> create(T (&array)[N])
        {
            // delegate the call to the iterator-range overload
            return create(std::begin(array), std::end(array));
        }

        /// input adapter for contiguous container
        template<class ContiguousContainer, typename std::enable_if<
                     not std::is_pointer<ContiguousContainer>::value and
                     std::is_base_of<
                         std::random_access_iterator_tag,
                         typename std::iterator_traits<decltype(std::begin(std::declval<ContiguousContainer const>()))>::iterator_category>::value
                     , int>::type = 0>
        static std::shared_ptr<input_adapter> create(const ContiguousContainer& c)
        {
            // delegate the call to the iterator-range overload
            return create(std::begin(c), std::end(c));
        }
N
Niels Lohmann 已提交
8784
    };
N
Niels 已提交
8785

N
Niels Lohmann 已提交
8786
    /// a type to simplify interfaces
N
Niels Lohmann 已提交
8787 8788
    using input_adapter_t = std::shared_ptr<input_adapter>;

N
Niels Lohmann 已提交
8789 8790
    /// input adapter for cached stream input
    class cached_input_stream_adapter : public input_adapter
N
Niels 已提交
8791
    {
N
Niels Lohmann 已提交
8792 8793
      public:
        cached_input_stream_adapter(std::istream& i, const size_t buffer_size)
N
Niels Lohmann 已提交
8794
            : is(i), start_position(is.tellg()), buffer(buffer_size, '\0')
N
Niels Lohmann 已提交
8795 8796 8797 8798 8799 8800 8801
        {
            // immediately abort if stream is erroneous
            if (JSON_UNLIKELY(i.fail()))
            {
                JSON_THROW(parse_error::create(111, 0, "bad input stream"));
            }

N
Niels Lohmann 已提交
8802
            // initial fill
N
Niels Lohmann 已提交
8803
            is.read(buffer.data(), static_cast<std::streamsize>(buffer.size()));
N
Niels Lohmann 已提交
8804 8805
            // store number of bytes in the buffer
            fill_size = static_cast<size_t>(is.gcount());
N
Niels Lohmann 已提交
8806 8807

            // skip byte-order mark
N
Niels Lohmann 已提交
8808
            if (fill_size >= 3 and buffer[0] == '\xEF' and buffer[1] == '\xBB' and buffer[2] == '\xBF')
N
Niels Lohmann 已提交
8809 8810 8811 8812 8813 8814 8815 8816 8817 8818
            {
                buffer_pos += 3;
                processed_chars += 3;
            }
        }

        ~cached_input_stream_adapter() override
        {
            // clear stream flags
            is.clear();
8819 8820 8821 8822
            // We initially read a lot of characters into the buffer, and we
            // may not have processed all of them. Therefore, we need to
            // "rewind" the stream after the last processed char.
            is.seekg(start_position + static_cast<std::streamoff>(processed_chars));
N
Niels Lohmann 已提交
8823 8824
            // clear stream flags
            is.clear();
N
Niels Lohmann 已提交
8825 8826 8827 8828
        }

        int get_character() override
        {
N
Niels Lohmann 已提交
8829 8830
            // check if refilling is necessary and possible
            if (buffer_pos == fill_size and not eof)
N
Niels Lohmann 已提交
8831 8832
            {
                // refill
N
Niels Lohmann 已提交
8833 8834 8835 8836
                is.read(buffer.data(), static_cast<std::streamsize>(buffer.size()));
                // store number of bytes in the buffer
                fill_size = static_cast<size_t>(is.gcount());

8837 8838 8839
                // the buffer is ready
                buffer_pos = 0;

N
Niels Lohmann 已提交
8840 8841 8842 8843
                // remember that filling did not yield new input
                if (fill_size == 0)
                {
                    eof = true;
8844
                    return std::char_traits<char>::eof();
N
Niels Lohmann 已提交
8845
                }
N
Niels Lohmann 已提交
8846 8847 8848
            }

            ++processed_chars;
8849
            return buffer[buffer_pos++] & 0xFF;;
N
Niels Lohmann 已提交
8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876
        }

        std::string read(size_t offset, size_t length) override
        {
            // create buffer
            std::string result(length, '\0');

            // save stream position
            auto current_pos = is.tellg();
            // save stream flags
            auto flags = is.rdstate();

            // clear stream flags
            is.clear();
            // set stream position
            is.seekg(static_cast<std::streamoff>(offset));
            // read bytes
            is.read(&result[0], static_cast<std::streamsize>(length));

            // reset stream position
            is.seekg(current_pos);
            // reset stream flags
            is.setstate(flags);

            return result;
        }

N
Niels Lohmann 已提交
8877
      private:
N
Niels Lohmann 已提交
8878 8879 8880 8881 8882 8883 8884 8885
        /// the associated input stream
        std::istream& is;

        /// chars returned via get_character()
        size_t processed_chars = 0;
        /// chars processed in the current buffer
        size_t buffer_pos = 0;

N
Niels Lohmann 已提交
8886 8887 8888 8889 8890
        /// whether stream reached eof
        bool eof = false;
        /// how many chars have been copied to the buffer by last (re)fill
        size_t fill_size = 0;

N
Niels Lohmann 已提交
8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904
        /// position of the stream when we started
        const std::streampos start_position;

        /// internal buffer
        std::vector<char> buffer;
    };

    /// input adapter for buffer input
    class input_buffer_adapter : public input_adapter
    {
      public:
        input_buffer_adapter(const char* b, size_t l)
            : input_adapter(), cursor(b), limit(b + l), start(b)
        {}
N
Niels 已提交
8905

N
Niels Lohmann 已提交
8906 8907 8908 8909 8910
        // delete because of pointer members
        input_buffer_adapter(const input_buffer_adapter&) = delete;
        input_buffer_adapter& operator=(input_buffer_adapter&) = delete;

        int get_character() override
T
Théo DELRIEU 已提交
8911
        {
N
Niels Lohmann 已提交
8912 8913 8914 8915 8916 8917 8918 8919 8920
            if (JSON_LIKELY(cursor < limit))
            {
                return *(cursor++) & 0xFF;
            }
            else
            {
                return std::char_traits<char>::eof();
            }
        }
N
Niels 已提交
8921

N
Niels Lohmann 已提交
8922
        std::string read(size_t offset, size_t length) override
N
Niels 已提交
8923
        {
N
Niels Lohmann 已提交
8924 8925
            // avoid reading too many characters
            const size_t max_length = static_cast<size_t>(limit - start);
N
Niels Lohmann 已提交
8926
            return std::string(start + offset, std::min(length, max_length - offset));
N
Niels Lohmann 已提交
8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937
        }

      private:
        /// pointer to the current character
        const char* cursor;
        /// pointer past the last character
        const char* limit;
        /// pointer to the first character
        const char* start;
    };

8938 8939 8940 8941 8942 8943
    //////////////////////////////////////////
    // binary serialization/deserialization //
    //////////////////////////////////////////

    /// @name binary serialization/deserialization support
    /// @{
N
Niels Lohmann 已提交
8944 8945

  private:
N
Niels Lohmann 已提交
8946 8947 8948
    /*!
    @brief deserialization of CBOR and MessagePack values
    */
N
Niels Lohmann 已提交
8949 8950 8951
    class binary_reader
    {
      public:
N
Niels Lohmann 已提交
8952 8953 8954 8955 8956
        /*!
        @brief create a binary reader

        @param[in] adapter  input adapter to read from
        */
N
Niels Lohmann 已提交
8957 8958
        explicit binary_reader(input_adapter_t adapter)
            : ia(adapter), is_little_endian(little_endianess())
N
Niels Lohmann 已提交
8959 8960 8961
        {
            assert(ia);
        }
N
Niels Lohmann 已提交
8962 8963

        /*!
N
Niels Lohmann 已提交
8964 8965
        @brief create a JSON value from CBOR input

N
Niels Lohmann 已提交
8966 8967 8968
        @param[in] get_char  whether a new character should be retrieved from
                             the input (true, default) or whether the last
                             read character should be considered instead
N
Niels Lohmann 已提交
8969 8970 8971 8972 8973

        @return JSON value created from CBOR input

        @throw parse_error.110 if input ended unexpectedly
        @throw parse_error.112 if unsupported byte was read
N
Niels Lohmann 已提交
8974 8975 8976 8977
        */
        basic_json parse_cbor(const bool get_char = true)
        {
            switch (get_char ? get() : current)
T
Théo DELRIEU 已提交
8978
            {
N
Niels Lohmann 已提交
8979 8980
                // EOF
                case std::char_traits<char>::eof():
N
Niels Lohmann 已提交
8981
                {
N
Niels Lohmann 已提交
8982
                    JSON_THROW(parse_error::create(110, chars_read, "unexpected end of input"));
N
Niels Lohmann 已提交
8983 8984
                }

N
Niels Lohmann 已提交
8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012
                // Integer 0x00..0x17 (0..23)
                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:
                {
                    return static_cast<number_unsigned_t>(current);
                }
N
Niels Lohmann 已提交
9013

N
Niels Lohmann 已提交
9014
                case 0x18: // Unsigned integer (one-byte uint8_t follows)
N
Niels Lohmann 已提交
9015
                {
N
Niels Lohmann 已提交
9016
                    return get_number<uint8_t>();
N
Niels Lohmann 已提交
9017
                }
N
Niels 已提交
9018

N
Niels Lohmann 已提交
9019 9020 9021 9022
                case 0x19: // Unsigned integer (two-byte uint16_t follows)
                {
                    return get_number<uint16_t>();
                }
N
Niels 已提交
9023

N
Niels Lohmann 已提交
9024
                case 0x1a: // Unsigned integer (four-byte uint32_t follows)
N
Niels Lohmann 已提交
9025
                {
N
Niels Lohmann 已提交
9026
                    return get_number<uint32_t>();
N
Niels Lohmann 已提交
9027 9028
                }

N
Niels Lohmann 已提交
9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 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 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144
                case 0x1b: // Unsigned integer (eight-byte uint64_t follows)
                {
                    return get_number<uint64_t>();
                }

                // Negative integer -1-0x00..-1-0x17 (-1..-24)
                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:
                {
                    return static_cast<int8_t>(0x20 - 1 - current);
                }

                case 0x38: // Negative integer (one-byte uint8_t follows)
                {
                    // must be uint8_t !
                    return static_cast<number_integer_t>(-1) - get_number<uint8_t>();
                }

                case 0x39: // Negative integer -1-n (two-byte uint16_t follows)
                {
                    return static_cast<number_integer_t>(-1) - get_number<uint16_t>();
                }

                case 0x3a: // Negative integer -1-n (four-byte uint32_t follows)
                {
                    return static_cast<number_integer_t>(-1) - get_number<uint32_t>();
                }

                case 0x3b: // Negative integer -1-n (eight-byte uint64_t follows)
                {
                    return static_cast<number_integer_t>(-1) - static_cast<number_integer_t>(get_number<uint64_t>());
                }

                // UTF-8 string (0x00..0x17 bytes follow)
                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:
                case 0x78: // UTF-8 string (one-byte uint8_t for n follows)
                case 0x79: // UTF-8 string (two-byte uint16_t for n follow)
                case 0x7a: // UTF-8 string (four-byte uint32_t for n follow)
                case 0x7b: // UTF-8 string (eight-byte uint64_t for n follow)
                case 0x7f: // UTF-8 string (indefinite length)
                {
                    return get_cbor_string();
                }

                // array (0x00..0x17 data items follow)
                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:
                {
                    basic_json result = value_t::array;
N
Niels Lohmann 已提交
9145
                    const auto len = static_cast<size_t>(current & 0x1f);
N
Niels Lohmann 已提交
9146 9147 9148 9149 9150 9151
                    for (size_t i = 0; i < len; ++i)
                    {
                        result.push_back(parse_cbor());
                    }
                    return result;
                }
N
Niels 已提交
9152

N
Niels Lohmann 已提交
9153 9154 9155 9156 9157 9158 9159 9160 9161 9162
                case 0x98: // array (one-byte uint8_t for n follows)
                {
                    basic_json result = value_t::array;
                    const auto len = static_cast<size_t>(get_number<uint8_t>());
                    for (size_t i = 0; i < len; ++i)
                    {
                        result.push_back(parse_cbor());
                    }
                    return result;
                }
N
Niels 已提交
9163

N
Niels Lohmann 已提交
9164 9165 9166 9167 9168 9169 9170 9171 9172 9173
                case 0x99: // array (two-byte uint16_t for n follow)
                {
                    basic_json result = value_t::array;
                    const auto len = static_cast<size_t>(get_number<uint16_t>());
                    for (size_t i = 0; i < len; ++i)
                    {
                        result.push_back(parse_cbor());
                    }
                    return result;
                }
N
Niels 已提交
9174

N
Niels Lohmann 已提交
9175 9176 9177 9178 9179 9180 9181 9182 9183 9184
                case 0x9a: // array (four-byte uint32_t for n follow)
                {
                    basic_json result = value_t::array;
                    const auto len = static_cast<size_t>(get_number<uint32_t>());
                    for (size_t i = 0; i < len; ++i)
                    {
                        result.push_back(parse_cbor());
                    }
                    return result;
                }
N
Niels 已提交
9185

N
Niels Lohmann 已提交
9186 9187 9188 9189 9190 9191 9192 9193 9194 9195
                case 0x9b: // array (eight-byte uint64_t for n follow)
                {
                    basic_json result = value_t::array;
                    const auto len = static_cast<size_t>(get_number<uint64_t>());
                    for (size_t i = 0; i < len; ++i)
                    {
                        result.push_back(parse_cbor());
                    }
                    return result;
                }
N
Niels Lohmann 已提交
9196

N
Niels Lohmann 已提交
9197 9198 9199 9200 9201 9202 9203 9204 9205
                case 0x9f: // array (indefinite length)
                {
                    basic_json result = value_t::array;
                    while (get() != 0xff)
                    {
                        result.push_back(parse_cbor(false));
                    }
                    return result;
                }
N
Niels 已提交
9206

N
Niels Lohmann 已提交
9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233
                // map (0x00..0x17 pairs of data items follow)
                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;
N
Niels Lohmann 已提交
9234
                    const auto len = static_cast<size_t>(current & 0x1f);
N
Niels Lohmann 已提交
9235 9236 9237
                    for (size_t i = 0; i < len; ++i)
                    {
                        get();
9238 9239
                        auto key = get_cbor_string();
                        result[key] = parse_cbor();
N
Niels Lohmann 已提交
9240 9241 9242
                    }
                    return result;
                }
N
Niels 已提交
9243

N
Niels Lohmann 已提交
9244 9245 9246 9247 9248 9249 9250
                case 0xb8: // map (one-byte uint8_t for n follows)
                {
                    basic_json result = value_t::object;
                    const auto len = static_cast<size_t>(get_number<uint8_t>());
                    for (size_t i = 0; i < len; ++i)
                    {
                        get();
9251 9252
                        auto key = get_cbor_string();
                        result[key] = parse_cbor();
N
Niels Lohmann 已提交
9253 9254 9255
                    }
                    return result;
                }
N
Niels 已提交
9256

N
Niels Lohmann 已提交
9257 9258 9259 9260 9261 9262 9263
                case 0xb9: // map (two-byte uint16_t for n follow)
                {
                    basic_json result = value_t::object;
                    const auto len = static_cast<size_t>(get_number<uint16_t>());
                    for (size_t i = 0; i < len; ++i)
                    {
                        get();
9264 9265
                        auto key = get_cbor_string();
                        result[key] = parse_cbor();
N
Niels Lohmann 已提交
9266 9267 9268
                    }
                    return result;
                }
N
Niels 已提交
9269

N
Niels Lohmann 已提交
9270 9271 9272 9273 9274 9275 9276
                case 0xba: // map (four-byte uint32_t for n follow)
                {
                    basic_json result = value_t::object;
                    const auto len = static_cast<size_t>(get_number<uint32_t>());
                    for (size_t i = 0; i < len; ++i)
                    {
                        get();
9277 9278
                        auto key = get_cbor_string();
                        result[key] = parse_cbor();
N
Niels Lohmann 已提交
9279 9280 9281
                    }
                    return result;
                }
T
Théo DELRIEU 已提交
9282

N
Niels Lohmann 已提交
9283
                case 0xbb: // map (eight-byte uint64_t for n follow)
T
Théo DELRIEU 已提交
9284
                {
N
Niels Lohmann 已提交
9285 9286 9287 9288 9289
                    basic_json result = value_t::object;
                    const auto len = static_cast<size_t>(get_number<uint64_t>());
                    for (size_t i = 0; i < len; ++i)
                    {
                        get();
9290 9291
                        auto key = get_cbor_string();
                        result[key] = parse_cbor();
N
Niels Lohmann 已提交
9292 9293
                    }
                    return result;
T
Théo DELRIEU 已提交
9294
                }
N
Niels 已提交
9295

N
Niels Lohmann 已提交
9296 9297 9298 9299 9300
                case 0xbf: // map (indefinite length)
                {
                    basic_json result = value_t::object;
                    while (get() != 0xff)
                    {
9301 9302
                        auto key = get_cbor_string();
                        result[key] = parse_cbor();
N
Niels Lohmann 已提交
9303 9304 9305
                    }
                    return result;
                }
N
Niels Lohmann 已提交
9306

N
Niels Lohmann 已提交
9307 9308 9309 9310
                case 0xf4: // false
                {
                    return false;
                }
N
Niels Lohmann 已提交
9311

N
Niels Lohmann 已提交
9312 9313 9314 9315
                case 0xf5: // true
                {
                    return true;
                }
N
Niels Lohmann 已提交
9316

N
Niels Lohmann 已提交
9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329
                case 0xf6: // null
                {
                    return value_t::null;
                }

                case 0xf9: // Half-Precision Float (two-byte IEEE 754)
                {
                    const int byte1 = get();
                    check_eof();
                    const int byte2 = get();
                    check_eof();

                    // code from RFC 7049, Appendix D, Figure 3:
N
Niels Lohmann 已提交
9330 9331 9332 9333 9334 9335 9336
                    // As half-precision floating-point numbers were only added
                    // to IEEE 754 in 2008, today's programming platforms often
                    // still only have limited support for them. It is very
                    // easy to include at least decoding support for them even
                    // without such support. An example of a small decoder for
                    // half-precision floating-point numbers in the C language
                    // is shown in Fig. 3.
N
Niels Lohmann 已提交
9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356
                    const int half = (byte1 << 8) + byte2;
                    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
                              ? std::numeric_limits<double>::infinity()
                              : std::numeric_limits<double>::quiet_NaN();
                    }
                    return (half & 0x8000) != 0 ? -val : val;
                }
N
Niels Lohmann 已提交
9357

N
Niels Lohmann 已提交
9358 9359 9360 9361
                case 0xfa: // Single-Precision Float (four-byte IEEE 754)
                {
                    return get_number<float>();
                }
N
Niels Lohmann 已提交
9362

N
Niels Lohmann 已提交
9363 9364 9365 9366 9367 9368 9369 9370
                case 0xfb: // Double-Precision Float (eight-byte IEEE 754)
                {
                    return get_number<double>();
                }

                default: // anything else (0xFF is handled inside the other types)
                {
                    std::stringstream ss;
N
Niels Lohmann 已提交
9371
                    ss << std::setw(2) << std::setfill('0') << std::hex << current;
N
Niels Lohmann 已提交
9372 9373
                    JSON_THROW(parse_error::create(112, chars_read, "error reading CBOR; last byte: 0x" + ss.str()));
                }
T
Théo DELRIEU 已提交
9374
            }
N
Niels Lohmann 已提交
9375
        }
N
Niels Lohmann 已提交
9376

N
Niels Lohmann 已提交
9377 9378 9379 9380 9381 9382 9383 9384
        /*!
        @brief create a JSON value from MessagePack input

        @return JSON value created from MessagePack input

        @throw parse_error.110 if input ended unexpectedly
        @throw parse_error.112 if unsupported byte was read
        */
9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 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 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 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 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780
        basic_json parse_msgpack()
        {
            switch (get())
            {
                // EOF
                case std::char_traits<char>::eof():
                {
                    JSON_THROW(parse_error::create(110, chars_read, "unexpected end of input"));
                }

                // positive fixint
                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:
                case 0x18:
                case 0x19:
                case 0x1a:
                case 0x1b:
                case 0x1c:
                case 0x1d:
                case 0x1e:
                case 0x1f:
                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:
                case 0x38:
                case 0x39:
                case 0x3a:
                case 0x3b:
                case 0x3c:
                case 0x3d:
                case 0x3e:
                case 0x3f:
                case 0x40:
                case 0x41:
                case 0x42:
                case 0x43:
                case 0x44:
                case 0x45:
                case 0x46:
                case 0x47:
                case 0x48:
                case 0x49:
                case 0x4a:
                case 0x4b:
                case 0x4c:
                case 0x4d:
                case 0x4e:
                case 0x4f:
                case 0x50:
                case 0x51:
                case 0x52:
                case 0x53:
                case 0x54:
                case 0x55:
                case 0x56:
                case 0x57:
                case 0x58:
                case 0x59:
                case 0x5a:
                case 0x5b:
                case 0x5c:
                case 0x5d:
                case 0x5e:
                case 0x5f:
                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:
                case 0x78:
                case 0x79:
                case 0x7a:
                case 0x7b:
                case 0x7c:
                case 0x7d:
                case 0x7e:
                case 0x7f:
                {
                    return static_cast<number_unsigned_t>(current);
                }

                // fixmap
                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:
                {
                    basic_json result = value_t::object;
                    const auto len = static_cast<size_t>(current & 0x0f);
                    for (size_t i = 0; i < len; ++i)
                    {
                        get();
                        auto key = get_msgpack_string();
                        result[key] = parse_msgpack();
                    }
                    return result;
                }

                // fixarray
                case 0x90:
                case 0x91:
                case 0x92:
                case 0x93:
                case 0x94:
                case 0x95:
                case 0x96:
                case 0x97:
                case 0x98:
                case 0x99:
                case 0x9a:
                case 0x9b:
                case 0x9c:
                case 0x9d:
                case 0x9e:
                case 0x9f:
                {
                    basic_json result = value_t::array;
                    const auto len = static_cast<size_t>(current & 0x0f);
                    for (size_t i = 0; i < len; ++i)
                    {
                        result.push_back(parse_msgpack());
                    }
                    return result;
                }

                // fixstr
                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:
                case 0xb8:
                case 0xb9:
                case 0xba:
                case 0xbb:
                case 0xbc:
                case 0xbd:
                case 0xbe:
                case 0xbf:
                {
                    return get_msgpack_string();
                }

                case 0xc0: // nil
                {
                    return value_t::null;
                }

                case 0xc2: // false
                {
                    return false;
                }

                case 0xc3: // true
                {
                    return true;
                }

                case 0xca: // float 32
                {
                    return get_number<float>();
                }

                case 0xcb: // float 64
                {
                    return get_number<double>();
                }

                case 0xcc: // uint 8
                {
                    return get_number<uint8_t>();
                }

                case 0xcd: // uint 16
                {
                    return get_number<uint16_t>();
                }

                case 0xce: // uint 32
                {
                    return get_number<uint32_t>();
                }

                case 0xcf: // uint 64
                {
                    return get_number<uint64_t>();
                }

                case 0xd0: // int 8
                {
                    return get_number<int8_t>();
                }

                case 0xd1: // int 16
                {
                    return get_number<int16_t>();
                }

                case 0xd2: // int 32
                {
                    return get_number<int32_t>();
                }

                case 0xd3: // int 64
                {
                    return get_number<int64_t>();
                }

                case 0xd9: // str 8
                case 0xda: // str 16
                case 0xdb: // str 32
                {
                    return get_msgpack_string();
                }

                case 0xdc: // array 16
                {
                    basic_json result = value_t::array;
                    const auto len = static_cast<size_t>(get_number<uint16_t>());
                    for (size_t i = 0; i < len; ++i)
                    {
                        result.push_back(parse_msgpack());
                    }
                    return result;
                }

                case 0xdd: // array 32
                {
                    basic_json result = value_t::array;
                    const auto len = static_cast<size_t>(get_number<uint32_t>());
                    for (size_t i = 0; i < len; ++i)
                    {
                        result.push_back(parse_msgpack());
                    }
                    return result;
                }

                case 0xde: // map 16
                {
                    basic_json result = value_t::object;
                    const auto len = static_cast<size_t>(get_number<uint16_t>());
                    for (size_t i = 0; i < len; ++i)
                    {
                        get();
                        auto key = get_msgpack_string();
                        result[key] = parse_msgpack();
                    }
                    return result;
                }

                case 0xdf: // map 32
                {
                    basic_json result = value_t::object;
                    const auto len = static_cast<size_t>(get_number<uint32_t>());
                    for (size_t i = 0; i < len; ++i)
                    {
                        get();
                        auto key = get_msgpack_string();
                        result[key] = parse_msgpack();
                    }
                    return result;
                }

                // positive fixint
                case 0xe0:
                case 0xe1:
                case 0xe2:
                case 0xe3:
                case 0xe4:
                case 0xe5:
                case 0xe6:
                case 0xe7:
                case 0xe8:
                case 0xe9:
                case 0xea:
                case 0xeb:
                case 0xec:
                case 0xed:
                case 0xee:
                case 0xef:
                case 0xf0:
                case 0xf1:
                case 0xf2:
                case 0xf3:
                case 0xf4:
                case 0xf5:
                case 0xf6:
                case 0xf7:
                case 0xf8:
                case 0xf9:
                case 0xfa:
                case 0xfb:
                case 0xfc:
                case 0xfd:
                case 0xfe:
                case 0xff:
                {
                    return static_cast<int8_t>(current);
                }

                default: // anything else
                {
                    std::stringstream ss;
N
Niels Lohmann 已提交
9781
                    ss << std::setw(2) << std::setfill('0') << std::hex << current;
9782 9783 9784 9785 9786
                    JSON_THROW(parse_error::create(112, chars_read, "error reading MessagePack; last byte: 0x" + ss.str()));
                }
            }
        }

N
Niels Lohmann 已提交
9787 9788 9789 9790 9791 9792 9793 9794
        /*!
        @brief determine system byte order

        @return true iff system's byte order is little endian

        @note from http://stackoverflow.com/a/1001328/266378
        */
        static bool little_endianess() noexcept
N
Niels Lohmann 已提交
9795 9796 9797 9798 9799
        {
            int num = 1;
            return (*reinterpret_cast<char*>(&num) == 1);
        }

N
Niels Lohmann 已提交
9800 9801 9802 9803 9804 9805 9806 9807 9808 9809
      private:
        /*!
        @brief get next character from the input

        This function provides the interface to the used input adapter. It does
        not throw in case the input reached EOF, but returns
        `std::char_traits<char>::eof()` in that case.

        @return character read from the input
        */
N
Niels Lohmann 已提交
9810 9811 9812 9813 9814
        int get()
        {
            ++chars_read;
            return (current = ia->get_character());
        }
N
Niels Lohmann 已提交
9815

N
Niels Lohmann 已提交
9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828
        /*
        @brief read a number from the input

        @tparam T the type of the number

        @return number of type @a T

        @note This function needs to respect the system's endianess, because
              bytes in CBOR and MessagePack are stored in network order (big
              endian) and therefore need reordering on little endian systems.

        @throw parse_error.110 if input has less than `sizeof(T)` bytes
        */
N
Niels Lohmann 已提交
9829 9830
        template<typename T>
        T get_number()
N
Niels Lohmann 已提交
9831
        {
N
Niels Lohmann 已提交
9832
            // step 1: read input into array with system's byte order
N
Niels Lohmann 已提交
9833 9834 9835 9836 9837
            std::array<uint8_t, sizeof(T)> vec;
            for (size_t i = 0; i < sizeof(T); ++i)
            {
                get();
                check_eof();
N
Niels Lohmann 已提交
9838 9839 9840 9841 9842 9843 9844 9845 9846 9847

                // reverse byte order prior to conversion if necessary
                if (is_little_endian)
                {
                    vec[sizeof(T) - i - 1] = static_cast<uint8_t>(current);
                }
                else
                {
                    vec[i] = static_cast<uint8_t>(current);
                }
N
Niels Lohmann 已提交
9848 9849
            }

N
Niels Lohmann 已提交
9850
            // step 2: convert array into number of type T and return
N
Niels Lohmann 已提交
9851 9852 9853 9854 9855
            T result;
            std::memcpy(&result, vec.data(), sizeof(T));
            return result;
        }

N
Niels Lohmann 已提交
9856 9857 9858 9859 9860 9861 9862 9863 9864
        /*!
        @brief create a string by reading characters from the input

        @param[in] len number of bytes to read

        @return string created by reading @a len bytes

        @throw parse_error.110 if input has less than @a len bytes
        */
N
Niels Lohmann 已提交
9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875
        std::string get_string(const size_t len)
        {
            std::string result;
            for (size_t i = 0; i < len; ++i)
            {
                get();
                check_eof();
                result.append(1, static_cast<char>(current));
            }
            return result;
        }
N
Niels Lohmann 已提交
9876

N
Niels Lohmann 已提交
9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888
        /*!
        @brief reads a CBOR string

        This function first reads starting bytes to determine the expected
        string length and then copies this number of bytes into a string.
        Additionally, CBOR's strings with indefinite lengths are supported.

        @return string

        @throw parse_error.110 if input ended
        @throw parse_error.113 if an unexpexted byte is read
        */
N
Niels Lohmann 已提交
9889 9890 9891
        std::string get_cbor_string()
        {
            check_eof();
N
Niels Lohmann 已提交
9892

N
Niels Lohmann 已提交
9893
            switch (current)
T
Théo DELRIEU 已提交
9894
            {
N
Niels Lohmann 已提交
9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919
                // UTF-8 string (0x00..0x17 bytes follow)
                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 已提交
9920
                {
N
Niels Lohmann 已提交
9921
                    const auto len = static_cast<size_t>(current & 0x1f);
N
Niels Lohmann 已提交
9922
                    return get_string(len);
N
Niels Lohmann 已提交
9923
                }
N
Niels Lohmann 已提交
9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960

                case 0x78: // UTF-8 string (one-byte uint8_t for n follows)
                {
                    const auto len = static_cast<size_t>(get_number<uint8_t>());
                    return get_string(len);
                }

                case 0x79: // UTF-8 string (two-byte uint16_t for n follow)
                {
                    const auto len = static_cast<size_t>(get_number<uint16_t>());
                    return get_string(len);
                }

                case 0x7a: // UTF-8 string (four-byte uint32_t for n follow)
                {
                    const auto len = static_cast<size_t>(get_number<uint32_t>());
                    return get_string(len);
                }

                case 0x7b: // UTF-8 string (eight-byte uint64_t for n follow)
                {
                    const auto len = static_cast<size_t>(get_number<uint64_t>());
                    return get_string(len);
                }

                case 0x7f: // UTF-8 string (indefinite length)
                {
                    std::string result;
                    while (get() != 0xff)
                    {
                        check_eof();
                        result.append(1, static_cast<char>(current));
                    }
                    return result;
                }

                default:
N
Niels Lohmann 已提交
9961
                {
N
Niels Lohmann 已提交
9962
                    std::stringstream ss;
N
Niels Lohmann 已提交
9963
                    ss << std::setw(2) << std::setfill('0') << std::hex << current;
N
Niels Lohmann 已提交
9964
                    JSON_THROW(parse_error::create(113, chars_read, "expected a CBOR string; last byte: 0x" + ss.str()));
N
Niels Lohmann 已提交
9965
                }
T
Théo DELRIEU 已提交
9966
            }
N
Niels Lohmann 已提交
9967
        }
N
Niels Lohmann 已提交
9968

N
Niels Lohmann 已提交
9969 9970 9971 9972 9973 9974 9975 9976 9977 9978 9979
        /*!
        @brief reads a MessagePack string

        This function first reads starting bytes to determine the expected
        string length and then copies this number of bytes into a string.

        @return string

        @throw parse_error.110 if input ended
        @throw parse_error.113 if an unexpexted byte is read
        */
9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019
        std::string get_msgpack_string()
        {
            check_eof();

            switch (current)
            {
                // fixstr
                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:
                case 0xb8:
                case 0xb9:
                case 0xba:
                case 0xbb:
                case 0xbc:
                case 0xbd:
                case 0xbe:
                case 0xbf:
                {
10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048 10049 10050
                    const auto len = static_cast<size_t>(current & 0x1f);
                    return get_string(len);
                }

                case 0xd9: // str 8
                {
                    const auto len = static_cast<size_t>(get_number<uint8_t>());
                    return get_string(len);
                }

                case 0xda: // str 16
                {
                    const auto len = static_cast<size_t>(get_number<uint16_t>());
                    return get_string(len);
                }

                case 0xdb: // str 32
                {
                    const auto len = static_cast<size_t>(get_number<uint32_t>());
                    return get_string(len);
                }

                default:
                {
                    std::stringstream ss;
                    ss << std::setw(2) << std::setfill('0') << std::hex << current;
                    JSON_THROW(parse_error::create(113, chars_read, "expected a MessagePack string; last byte: 0x" + ss.str()));
                }
            }
        }

N
Niels Lohmann 已提交
10051 10052 10053 10054 10055
        /*!
        @brief check if input ended
        @throw parse_error.110 if input ended
        */
        void check_eof() const
10056 10057 10058 10059 10060 10061 10062 10063 10064
        {
            if (JSON_UNLIKELY(current == std::char_traits<char>::eof()))
            {
                JSON_THROW(parse_error::create(110, chars_read, "unexpected end of input"));
            }
        }

      private:
        /// input adapter
N
Niels Lohmann 已提交
10065
        input_adapter_t ia = nullptr;
10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076

        /// the current character
        int current = std::char_traits<char>::eof();

        /// the number of characters read
        size_t chars_read = 0;

        /// whether we can assume little endianess
        const bool is_little_endian = true;
    };

N
Niels Lohmann 已提交
10077 10078 10079
    /*!
    @brief serialization to CBOR and MessagePack values
    */
10080 10081 10082
    class binary_writer
    {
      public:
N
Niels Lohmann 已提交
10083 10084
        /*!
        @brief create a binary writer
10085

N
Niels Lohmann 已提交
10086 10087
        @param[in] adapter  output adapter to write to
        */
10088
        explicit binary_writer(output_adapter_t<uint8_t> adapter)
N
Niels Lohmann 已提交
10089 10090 10091 10092
            : is_little_endian(binary_reader::little_endianess()), oa(adapter)
        {
            assert(oa);
        }
10093

N
Niels Lohmann 已提交
10094 10095 10096
        /*!
        @brief[in] j  JSON value to serialize
        */
10097
        void write_cbor(const basic_json& j)
10098 10099 10100 10101 10102
        {
            switch (j.type())
            {
                case value_t::null:
                {
10103
                    oa->write_character(0xf6);
10104 10105 10106 10107 10108
                    break;
                }

                case value_t::boolean:
                {
10109
                    oa->write_character(j.m_value.boolean ? 0xf5 : 0xf4);
10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125
                    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.
                        if (j.m_value.number_integer <= 0x17)
                        {
                            write_number(static_cast<uint8_t>(j.m_value.number_integer));
                        }
                        else if (j.m_value.number_integer <= (std::numeric_limits<uint8_t>::max)())
                        {
10126
                            oa->write_character(0x18);
10127 10128 10129 10130
                            write_number(static_cast<uint8_t>(j.m_value.number_integer));
                        }
                        else if (j.m_value.number_integer <= (std::numeric_limits<uint16_t>::max)())
                        {
10131
                            oa->write_character(0x19);
10132 10133 10134 10135
                            write_number(static_cast<uint16_t>(j.m_value.number_integer));
                        }
                        else if (j.m_value.number_integer <= (std::numeric_limits<uint32_t>::max)())
                        {
10136
                            oa->write_character(0x1a);
10137 10138 10139 10140
                            write_number(static_cast<uint32_t>(j.m_value.number_integer));
                        }
                        else
                        {
10141
                            oa->write_character(0x1b);
10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155
                            write_number(static_cast<uint64_t>(j.m_value.number_integer));
                        }
                    }
                    else
                    {
                        // The conversions below encode the sign in the first
                        // byte, and the value is converted to a positive number.
                        const auto positive_number = -1 - j.m_value.number_integer;
                        if (j.m_value.number_integer >= -24)
                        {
                            write_number(static_cast<uint8_t>(0x20 + positive_number));
                        }
                        else if (positive_number <= (std::numeric_limits<uint8_t>::max)())
                        {
10156
                            oa->write_character(0x38);
10157 10158 10159 10160
                            write_number(static_cast<uint8_t>(positive_number));
                        }
                        else if (positive_number <= (std::numeric_limits<uint16_t>::max)())
                        {
10161
                            oa->write_character(0x39);
10162 10163 10164 10165
                            write_number(static_cast<uint16_t>(positive_number));
                        }
                        else if (positive_number <= (std::numeric_limits<uint32_t>::max)())
                        {
10166
                            oa->write_character(0x3a);
10167 10168 10169 10170
                            write_number(static_cast<uint32_t>(positive_number));
                        }
                        else
                        {
10171
                            oa->write_character(0x3b);
10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185
                            write_number(static_cast<uint64_t>(positive_number));
                        }
                    }
                    break;
                }

                case value_t::number_unsigned:
                {
                    if (j.m_value.number_unsigned <= 0x17)
                    {
                        write_number(static_cast<uint8_t>(j.m_value.number_unsigned));
                    }
                    else if (j.m_value.number_unsigned <= (std::numeric_limits<uint8_t>::max)())
                    {
10186
                        oa->write_character(0x18);
10187 10188 10189 10190
                        write_number(static_cast<uint8_t>(j.m_value.number_unsigned));
                    }
                    else if (j.m_value.number_unsigned <= (std::numeric_limits<uint16_t>::max)())
                    {
10191
                        oa->write_character(0x19);
10192 10193 10194 10195
                        write_number(static_cast<uint16_t>(j.m_value.number_unsigned));
                    }
                    else if (j.m_value.number_unsigned <= (std::numeric_limits<uint32_t>::max)())
                    {
10196
                        oa->write_character(0x1a);
10197 10198 10199 10200
                        write_number(static_cast<uint32_t>(j.m_value.number_unsigned));
                    }
                    else
                    {
10201
                        oa->write_character(0x1b);
10202 10203 10204 10205 10206 10207 10208 10209
                        write_number(static_cast<uint64_t>(j.m_value.number_unsigned));
                    }
                    break;
                }

                case value_t::number_float:
                {
                    // Double-Precision Float
10210
                    oa->write_character(0xfb);
10211 10212 10213 10214 10215 10216
                    write_number(j.m_value.number_float);
                    break;
                }

                case value_t::string:
                {
N
Niels Lohmann 已提交
10217
                    // step 1: write control byte and the string length
10218 10219 10220 10221 10222 10223 10224
                    const auto N = j.m_value.string->size();
                    if (N <= 0x17)
                    {
                        write_number(static_cast<uint8_t>(0x60 + N));
                    }
                    else if (N <= 0xff)
                    {
10225
                        oa->write_character(0x78);
10226 10227 10228 10229
                        write_number(static_cast<uint8_t>(N));
                    }
                    else if (N <= 0xffff)
                    {
10230
                        oa->write_character(0x79);
10231 10232 10233 10234
                        write_number(static_cast<uint16_t>(N));
                    }
                    else if (N <= 0xffffffff)
                    {
10235
                        oa->write_character(0x7a);
10236 10237 10238 10239 10240
                        write_number(static_cast<uint32_t>(N));
                    }
                    // LCOV_EXCL_START
                    else if (N <= 0xffffffffffffffff)
                    {
10241
                        oa->write_character(0x7b);
10242 10243 10244 10245
                        write_number(static_cast<uint64_t>(N));
                    }
                    // LCOV_EXCL_STOP

N
Niels Lohmann 已提交
10246
                    // step 2: write the string
10247 10248
                    oa->write_characters(reinterpret_cast<const uint8_t*>(j.m_value.string->c_str()),
                                         j.m_value.string->size());
10249 10250 10251 10252 10253
                    break;
                }

                case value_t::array:
                {
N
Niels Lohmann 已提交
10254
                    // step 1: write control byte and the array size
10255 10256 10257 10258 10259 10260 10261
                    const auto N = j.m_value.array->size();
                    if (N <= 0x17)
                    {
                        write_number(static_cast<uint8_t>(0x80 + N));
                    }
                    else if (N <= 0xff)
                    {
10262
                        oa->write_character(0x98);
10263 10264 10265 10266
                        write_number(static_cast<uint8_t>(N));
                    }
                    else if (N <= 0xffff)
                    {
10267
                        oa->write_character(0x99);
10268 10269 10270 10271
                        write_number(static_cast<uint16_t>(N));
                    }
                    else if (N <= 0xffffffff)
                    {
10272
                        oa->write_character(0x9a);
10273 10274 10275 10276 10277
                        write_number(static_cast<uint32_t>(N));
                    }
                    // LCOV_EXCL_START
                    else if (N <= 0xffffffffffffffff)
                    {
10278
                        oa->write_character(0x9b);
10279 10280 10281 10282
                        write_number(static_cast<uint64_t>(N));
                    }
                    // LCOV_EXCL_STOP

N
Niels Lohmann 已提交
10283
                    // step 2: write each element
10284 10285
                    for (const auto& el : *j.m_value.array)
                    {
10286
                        write_cbor(el);
10287 10288 10289 10290 10291 10292
                    }
                    break;
                }

                case value_t::object:
                {
N
Niels Lohmann 已提交
10293
                    // step 1: write control byte and the object size
10294 10295 10296 10297 10298 10299 10300
                    const auto N = j.m_value.object->size();
                    if (N <= 0x17)
                    {
                        write_number(static_cast<uint8_t>(0xa0 + N));
                    }
                    else if (N <= 0xff)
                    {
10301
                        oa->write_character(0xb8);
10302 10303 10304 10305
                        write_number(static_cast<uint8_t>(N));
                    }
                    else if (N <= 0xffff)
                    {
10306
                        oa->write_character(0xb9);
10307 10308 10309 10310
                        write_number(static_cast<uint16_t>(N));
                    }
                    else if (N <= 0xffffffff)
                    {
10311
                        oa->write_character(0xba);
10312 10313 10314 10315 10316
                        write_number(static_cast<uint32_t>(N));
                    }
                    // LCOV_EXCL_START
                    else if (N <= 0xffffffffffffffff)
                    {
10317
                        oa->write_character(0xbb);
10318 10319 10320 10321
                        write_number(static_cast<uint64_t>(N));
                    }
                    // LCOV_EXCL_STOP

N
Niels Lohmann 已提交
10322
                    // step 2: write each element
10323 10324
                    for (const auto& el : *j.m_value.object)
                    {
10325 10326
                        write_cbor(el.first);
                        write_cbor(el.second);
10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337
                    }
                    break;
                }

                default:
                {
                    break;
                }
            }
        }

N
Niels Lohmann 已提交
10338 10339 10340
        /*!
        @brief[in] j  JSON value to serialize
        */
10341
        void write_msgpack(const basic_json& j)
10342 10343 10344 10345 10346 10347
        {
            switch (j.type())
            {
                case value_t::null:
                {
                    // nil
10348
                    oa->write_character(0xc0);
10349 10350 10351 10352 10353 10354
                    break;
                }

                case value_t::boolean:
                {
                    // true and false
10355
                    oa->write_character(j.m_value.boolean ? 0xc3 : 0xc2);
10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374
                    break;
                }

                case value_t::number_integer:
                {
                    if (j.m_value.number_integer >= 0)
                    {
                        // MessagePack does not differentiate between positive
                        // signed integers and unsigned integers. Therefore, we
                        // used the code from the value_t::number_unsigned case
                        // here.
                        if (j.m_value.number_unsigned < 128)
                        {
                            // positive fixnum
                            write_number(static_cast<uint8_t>(j.m_value.number_integer));
                        }
                        else if (j.m_value.number_unsigned <= (std::numeric_limits<uint8_t>::max)())
                        {
                            // uint 8
10375
                            oa->write_character(0xcc);
10376 10377 10378 10379 10380
                            write_number(static_cast<uint8_t>(j.m_value.number_integer));
                        }
                        else if (j.m_value.number_unsigned <= (std::numeric_limits<uint16_t>::max)())
                        {
                            // uint 16
10381
                            oa->write_character(0xcd);
10382 10383 10384 10385 10386
                            write_number(static_cast<uint16_t>(j.m_value.number_integer));
                        }
                        else if (j.m_value.number_unsigned <= (std::numeric_limits<uint32_t>::max)())
                        {
                            // uint 32
10387
                            oa->write_character(0xce);
10388 10389 10390 10391 10392
                            write_number(static_cast<uint32_t>(j.m_value.number_integer));
                        }
                        else if (j.m_value.number_unsigned <= (std::numeric_limits<uint64_t>::max)())
                        {
                            // uint 64
10393
                            oa->write_character(0xcf);
10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406
                            write_number(static_cast<uint64_t>(j.m_value.number_integer));
                        }
                    }
                    else
                    {
                        if (j.m_value.number_integer >= -32)
                        {
                            // negative fixnum
                            write_number(static_cast<int8_t>(j.m_value.number_integer));
                        }
                        else if (j.m_value.number_integer >= (std::numeric_limits<int8_t>::min)() and j.m_value.number_integer <= (std::numeric_limits<int8_t>::max)())
                        {
                            // int 8
10407
                            oa->write_character(0xd0);
10408 10409 10410 10411 10412
                            write_number(static_cast<int8_t>(j.m_value.number_integer));
                        }
                        else if (j.m_value.number_integer >= (std::numeric_limits<int16_t>::min)() and j.m_value.number_integer <= (std::numeric_limits<int16_t>::max)())
                        {
                            // int 16
10413
                            oa->write_character(0xd1);
10414 10415 10416 10417 10418
                            write_number(static_cast<int16_t>(j.m_value.number_integer));
                        }
                        else if (j.m_value.number_integer >= (std::numeric_limits<int32_t>::min)() and j.m_value.number_integer <= (std::numeric_limits<int32_t>::max)())
                        {
                            // int 32
10419
                            oa->write_character(0xd2);
10420 10421 10422 10423 10424
                            write_number(static_cast<int32_t>(j.m_value.number_integer));
                        }
                        else if (j.m_value.number_integer >= (std::numeric_limits<int64_t>::min)() and j.m_value.number_integer <= (std::numeric_limits<int64_t>::max)())
                        {
                            // int 64
10425
                            oa->write_character(0xd3);
10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441
                            write_number(static_cast<int64_t>(j.m_value.number_integer));
                        }
                    }
                    break;
                }

                case value_t::number_unsigned:
                {
                    if (j.m_value.number_unsigned < 128)
                    {
                        // positive fixnum
                        write_number(static_cast<uint8_t>(j.m_value.number_integer));
                    }
                    else if (j.m_value.number_unsigned <= (std::numeric_limits<uint8_t>::max)())
                    {
                        // uint 8
10442
                        oa->write_character(0xcc);
10443 10444 10445 10446 10447
                        write_number(static_cast<uint8_t>(j.m_value.number_integer));
                    }
                    else if (j.m_value.number_unsigned <= (std::numeric_limits<uint16_t>::max)())
                    {
                        // uint 16
10448
                        oa->write_character(0xcd);
10449 10450 10451 10452 10453
                        write_number(static_cast<uint16_t>(j.m_value.number_integer));
                    }
                    else if (j.m_value.number_unsigned <= (std::numeric_limits<uint32_t>::max)())
                    {
                        // uint 32
10454
                        oa->write_character(0xce);
10455 10456 10457 10458 10459
                        write_number(static_cast<uint32_t>(j.m_value.number_integer));
                    }
                    else if (j.m_value.number_unsigned <= (std::numeric_limits<uint64_t>::max)())
                    {
                        // uint 64
10460
                        oa->write_character(0xcf);
10461 10462 10463 10464 10465 10466 10467 10468
                        write_number(static_cast<uint64_t>(j.m_value.number_integer));
                    }
                    break;
                }

                case value_t::number_float:
                {
                    // float 64
10469
                    oa->write_character(0xcb);
10470 10471
                    write_number(j.m_value.number_float);
                    break;
10472 10473
                }

10474
                case value_t::string:
10475
                {
N
Niels Lohmann 已提交
10476
                    // step 1: write control byte and the string length
10477 10478 10479 10480 10481 10482 10483 10484 10485
                    const auto N = j.m_value.string->size();
                    if (N <= 31)
                    {
                        // fixstr
                        write_number(static_cast<uint8_t>(0xa0 | N));
                    }
                    else if (N <= 255)
                    {
                        // str 8
10486
                        oa->write_character(0xd9);
10487 10488 10489 10490 10491
                        write_number(static_cast<uint8_t>(N));
                    }
                    else if (N <= 65535)
                    {
                        // str 16
10492
                        oa->write_character(0xda);
10493 10494 10495 10496 10497
                        write_number(static_cast<uint16_t>(N));
                    }
                    else if (N <= 4294967295)
                    {
                        // str 32
10498
                        oa->write_character(0xdb);
10499 10500 10501
                        write_number(static_cast<uint32_t>(N));
                    }

N
Niels Lohmann 已提交
10502
                    // step 2: write the string
10503 10504
                    oa->write_characters(reinterpret_cast<const uint8_t*>(j.m_value.string->c_str()),
                                         j.m_value.string->size());
10505
                    break;
10506 10507
                }

10508
                case value_t::array:
10509
                {
N
Niels Lohmann 已提交
10510
                    // step 1: write control byte and the array size
10511 10512 10513 10514 10515 10516 10517 10518 10519
                    const auto N = j.m_value.array->size();
                    if (N <= 15)
                    {
                        // fixarray
                        write_number(static_cast<uint8_t>(0x90 | N));
                    }
                    else if (N <= 0xffff)
                    {
                        // array 16
10520
                        oa->write_character(0xdc);
10521 10522 10523 10524 10525
                        write_number(static_cast<uint16_t>(N));
                    }
                    else if (N <= 0xffffffff)
                    {
                        // array 32
10526
                        oa->write_character(0xdd);
10527 10528 10529
                        write_number(static_cast<uint32_t>(N));
                    }

N
Niels Lohmann 已提交
10530
                    // step 2: write each element
10531 10532
                    for (const auto& el : *j.m_value.array)
                    {
10533
                        write_msgpack(el);
10534 10535
                    }
                    break;
10536 10537
                }

10538
                case value_t::object:
10539
                {
N
Niels Lohmann 已提交
10540
                    // step 1: write control byte and the object size
10541 10542 10543 10544 10545 10546 10547 10548 10549
                    const auto N = j.m_value.object->size();
                    if (N <= 15)
                    {
                        // fixmap
                        write_number(static_cast<uint8_t>(0x80 | (N & 0xf)));
                    }
                    else if (N <= 65535)
                    {
                        // map 16
10550
                        oa->write_character(0xde);
10551 10552 10553 10554 10555
                        write_number(static_cast<uint16_t>(N));
                    }
                    else if (N <= 4294967295)
                    {
                        // map 32
10556
                        oa->write_character(0xdf);
10557 10558 10559
                        write_number(static_cast<uint32_t>(N));
                    }

N
Niels Lohmann 已提交
10560
                    // step 2: write each element
10561 10562
                    for (const auto& el : *j.m_value.object)
                    {
10563 10564
                        write_msgpack(el.first);
                        write_msgpack(el.second);
10565 10566
                    }
                    break;
10567 10568 10569 10570
                }

                default:
                {
10571
                    break;
10572 10573 10574 10575
                }
            }
        }

10576
      private:
N
Niels Lohmann 已提交
10577 10578 10579 10580 10581 10582 10583 10584 10585 10586
        /*
        @brief write a number to output input

        @param[in] n number of type @a T
        @tparam T the type of the number

        @note This function needs to respect the system's endianess, because
              bytes in CBOR and MessagePack are stored in network order (big
              endian) and therefore need reordering on little endian systems.
        */
10587 10588
        template<typename T>
        void write_number(T n)
N
Niels Lohmann 已提交
10589
        {
N
Niels Lohmann 已提交
10590
            // step 1: write number to array of length T
10591 10592 10593
            std::array<uint8_t, sizeof(T)> vec;
            std::memcpy(vec.data(), &n, sizeof(T));

N
Niels Lohmann 已提交
10594
            // step 2: write array to output (with possible reordering)
10595
            for (size_t i = 0; i < sizeof(T); ++i)
T
Théo DELRIEU 已提交
10596
            {
10597 10598 10599
                // reverse byte order prior to conversion if necessary
                if (is_little_endian)
                {
10600
                    oa->write_character(vec[sizeof(T) - i - 1]);
10601 10602 10603
                }
                else
                {
10604
                    oa->write_character(vec[i]);
10605
                }
T
Théo DELRIEU 已提交
10606
            }
N
Niels Lohmann 已提交
10607
        }
10608

10609
      private:
N
Niels Lohmann 已提交
10610 10611
        /// whether we can assume little endianess
        const bool is_little_endian = true;
10612

10613
        /// the output
10614
        output_adapter_t<uint8_t> oa = nullptr;
N
Niels Lohmann 已提交
10615 10616 10617
    };

  public:
10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701
    /*!
    @brief create a CBOR 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.

    The library uses the following mapping from JSON values types to
    CBOR types according to the CBOR specification (RFC 7049):

    JSON value type | value/range                                | CBOR type                          | first byte
    --------------- | ------------------------------------------ | ---------------------------------- | ---------------
    null            | `null`                                     | Null                               | 0xf6
    boolean         | `true`                                     | True                               | 0xf5
    boolean         | `false`                                    | False                              | 0xf4
    number_integer  | -9223372036854775808..-2147483649          | Negative integer (8 bytes follow)  | 0x3b
    number_integer  | -2147483648..-32769                        | Negative integer (4 bytes follow)  | 0x3a
    number_integer  | -32768..-129                               | Negative integer (2 bytes follow)  | 0x39
    number_integer  | -128..-25                                  | Negative integer (1 byte follow)   | 0x38
    number_integer  | -24..-1                                    | Negative integer                   | 0x20..0x37
    number_integer  | 0..23                                      | Integer                            | 0x00..0x17
    number_integer  | 24..255                                    | Unsigned integer (1 byte follow)   | 0x18
    number_integer  | 256..65535                                 | Unsigned integer (2 bytes follow)  | 0x19
    number_integer  | 65536..4294967295                          | Unsigned integer (4 bytes follow)  | 0x1a
    number_integer  | 4294967296..18446744073709551615           | Unsigned integer (8 bytes follow)  | 0x1b
    number_unsigned | 0..23                                      | Integer                            | 0x00..0x17
    number_unsigned | 24..255                                    | Unsigned integer (1 byte follow)   | 0x18
    number_unsigned | 256..65535                                 | Unsigned integer (2 bytes follow)  | 0x19
    number_unsigned | 65536..4294967295                          | Unsigned integer (4 bytes follow)  | 0x1a
    number_unsigned | 4294967296..18446744073709551615           | Unsigned integer (8 bytes follow)  | 0x1b
    number_float    | *any value*                                | Double-Precision Float             | 0xfb
    string          | *length*: 0..23                            | UTF-8 string                       | 0x60..0x77
    string          | *length*: 23..255                          | UTF-8 string (1 byte follow)       | 0x78
    string          | *length*: 256..65535                       | UTF-8 string (2 bytes follow)      | 0x79
    string          | *length*: 65536..4294967295                | UTF-8 string (4 bytes follow)      | 0x7a
    string          | *length*: 4294967296..18446744073709551615 | UTF-8 string (8 bytes follow)      | 0x7b
    array           | *size*: 0..23                              | array                              | 0x80..0x97
    array           | *size*: 23..255                            | array (1 byte follow)              | 0x98
    array           | *size*: 256..65535                         | array (2 bytes follow)             | 0x99
    array           | *size*: 65536..4294967295                  | array (4 bytes follow)             | 0x9a
    array           | *size*: 4294967296..18446744073709551615   | array (8 bytes follow)             | 0x9b
    object          | *size*: 0..23                              | map                                | 0xa0..0xb7
    object          | *size*: 23..255                            | map (1 byte follow)                | 0xb8
    object          | *size*: 256..65535                         | map (2 bytes follow)               | 0xb9
    object          | *size*: 65536..4294967295                  | map (4 bytes follow)               | 0xba
    object          | *size*: 4294967296..18446744073709551615   | map (8 bytes follow)               | 0xbb

    @note The mapping is **complete** in the sense that any JSON value type
          can be converted to a CBOR value.

    @note The following CBOR types are not used in the conversion:
          - byte strings (0x40..0x5f)
          - UTF-8 strings terminated by "break" (0x7f)
          - arrays terminated by "break" (0x9f)
          - maps terminated by "break" (0xbf)
          - date/time (0xc0..0xc1)
          - bignum (0xc2..0xc3)
          - decimal fraction (0xc4)
          - bigfloat (0xc5)
          - tagged items (0xc6..0xd4, 0xd8..0xdb)
          - expected conversions (0xd5..0xd7)
          - simple values (0xe0..0xf3, 0xf8)
          - undefined (0xf7)
          - half and single-precision floats (0xf9-0xfa)
          - break (0xff)

    @param[in] j  JSON value to serialize
    @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>&, const size_t) for the
        analogous deserialization
    @sa @ref to_msgpack(const basic_json& for the related MessagePack format

    @since version 2.0.9
    */
    static std::vector<uint8_t> to_cbor(const basic_json& j)
    {
10702
        std::vector<uint8_t> result;
10703
        binary_writer bw(output_adapter<uint8_t>::create(result));
10704 10705
        bw.write_cbor(j);
        return result;
10706 10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764 10765 10766 10767 10768 10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783
    }

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

    The library uses the following mapping from JSON values types to
    MessagePack types according to the MessagePack specification:

    JSON value type | value/range                       | MessagePack type | first byte
    --------------- | --------------------------------- | ---------------- | ----------
    null            | `null`                            | nil              | 0xc0
    boolean         | `true`                            | true             | 0xc3
    boolean         | `false`                           | false            | 0xc2
    number_integer  | -9223372036854775808..-2147483649 | int64            | 0xd3
    number_integer  | -2147483648..-32769               | int32            | 0xd2
    number_integer  | -32768..-129                      | int16            | 0xd1
    number_integer  | -128..-33                         | int8             | 0xd0
    number_integer  | -32..-1                           | negative fixint  | 0xe0..0xff
    number_integer  | 0..127                            | positive fixint  | 0x00..0x7f
    number_integer  | 128..255                          | uint 8           | 0xcc
    number_integer  | 256..65535                        | uint 16          | 0xcd
    number_integer  | 65536..4294967295                 | uint 32          | 0xce
    number_integer  | 4294967296..18446744073709551615  | uint 64          | 0xcf
    number_unsigned | 0..127                            | positive fixint  | 0x00..0x7f
    number_unsigned | 128..255                          | uint 8           | 0xcc
    number_unsigned | 256..65535                        | uint 16          | 0xcd
    number_unsigned | 65536..4294967295                 | uint 32          | 0xce
    number_unsigned | 4294967296..18446744073709551615  | uint 64          | 0xcf
    number_float    | *any value*                       | float 64         | 0xcb
    string          | *length*: 0..31                   | fixstr           | 0xa0..0xbf
    string          | *length*: 32..255                 | str 8            | 0xd9
    string          | *length*: 256..65535              | str 16           | 0xda
    string          | *length*: 65536..4294967295       | str 32           | 0xdb
    array           | *size*: 0..15                     | fixarray         | 0x90..0x9f
    array           | *size*: 16..65535                 | array 16         | 0xdc
    array           | *size*: 65536..4294967295         | array 32         | 0xdd
    object          | *size*: 0..15                     | fix map          | 0x80..0x8f
    object          | *size*: 16..65535                 | map 16           | 0xde
    object          | *size*: 65536..4294967295         | map 32           | 0xdf

    @note The mapping is **complete** in the sense that any JSON value type
          can be converted to a MessagePack value.

    @note The following values can **not** be converted to a MessagePack value:
          - strings with more than 4294967295 bytes
          - arrays with more than 4294967295 elements
          - objects with more than 4294967295 elements

    @note The following MessagePack types are not used in the conversion:
          - bin 8 - bin 32 (0xc4..0xc6)
          - ext 8 - ext 32 (0xc7..0xc9)
          - float 32 (0xca)
          - fixext 1 - fixext 16 (0xd4..0xd8)

    @note Any MessagePack output created @ref to_msgpack can be successfully
          parsed by @ref from_msgpack.

    @param[in] j  JSON value to serialize
    @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>&, const size_t) for the
        analogous deserialization
    @sa @ref to_cbor(const basic_json& for the related CBOR format

    @since version 2.0.9
    */
    static std::vector<uint8_t> to_msgpack(const basic_json& j)
    {
10784
        std::vector<uint8_t> result;
10785
        binary_writer bw(output_adapter<uint8_t>::create(result));
10786 10787
        bw.write_msgpack(j);
        return result;
10788
    }
N
Niels Lohmann 已提交
10789 10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876

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

    The library maps CBOR types to JSON value types as follows:

    CBOR type              | JSON value type | first byte
    ---------------------- | --------------- | ----------
    Integer                | number_unsigned | 0x00..0x17
    Unsigned integer       | number_unsigned | 0x18
    Unsigned integer       | number_unsigned | 0x19
    Unsigned integer       | number_unsigned | 0x1a
    Unsigned integer       | number_unsigned | 0x1b
    Negative integer       | number_integer  | 0x20..0x37
    Negative integer       | number_integer  | 0x38
    Negative integer       | number_integer  | 0x39
    Negative integer       | number_integer  | 0x3a
    Negative integer       | number_integer  | 0x3b
    Negative integer       | number_integer  | 0x40..0x57
    UTF-8 string           | string          | 0x60..0x77
    UTF-8 string           | string          | 0x78
    UTF-8 string           | string          | 0x79
    UTF-8 string           | string          | 0x7a
    UTF-8 string           | string          | 0x7b
    UTF-8 string           | string          | 0x7f
    array                  | array           | 0x80..0x97
    array                  | array           | 0x98
    array                  | array           | 0x99
    array                  | array           | 0x9a
    array                  | array           | 0x9b
    array                  | array           | 0x9f
    map                    | object          | 0xa0..0xb7
    map                    | object          | 0xb8
    map                    | object          | 0xb9
    map                    | object          | 0xba
    map                    | object          | 0xbb
    map                    | object          | 0xbf
    False                  | `false`         | 0xf4
    True                   | `true`          | 0xf5
    Nill                   | `null`          | 0xf6
    Half-Precision Float   | number_float    | 0xf9
    Single-Precision Float | number_float    | 0xfa
    Double-Precision Float | number_float    | 0xfb

    @warning The mapping is **incomplete** in the sense that not all CBOR
             types can be converted to a JSON value. The following CBOR types
             are not supported and will yield parse errors (parse_error.112):
             - byte strings (0x40..0x5f)
             - date/time (0xc0..0xc1)
             - bignum (0xc2..0xc3)
             - decimal fraction (0xc4)
             - bigfloat (0xc5)
             - tagged items (0xc6..0xd4, 0xd8..0xdb)
             - expected conversions (0xd5..0xd7)
             - simple values (0xe0..0xf3, 0xf8)
             - undefined (0xf7)

    @warning CBOR allows map keys of any type, whereas JSON only allows
             strings as keys in object values. Therefore, CBOR maps with keys
             other than UTF-8 strings are rejected (parse_error.113).

    @note Any CBOR output created @ref to_cbor can be successfully parsed by
          @ref from_cbor.

    @param[in] v  a byte vector in CBOR format
    @param[in] start_index the index to start reading from @a v (0 by default)
    @return deserialized JSON value

    @throw parse_error.110 if the given vector ends prematurely
    @throw parse_error.112 if unsupported features from CBOR were
    used in the given vector @a v or if the input is not valid CBOR
    @throw parse_error.113 if a string was expected as map key, but not found

    @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>&, const size_t) for the
        related MessagePack format

    @since version 2.0.9, parameter @a start_index since 2.1.1
    */
N
Niels Lohmann 已提交
10877 10878 10879
    static basic_json from_cbor(const std::vector<uint8_t>& v,
                                const size_t start_index = 0)
    {
10880
        binary_reader br(input_adapter::create(v.begin() + static_cast<difference_type>(start_index), v.end()));
N
Niels Lohmann 已提交
10881 10882
        return br.parse_cbor();
    }
N
Niels Lohmann 已提交
10883

10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954

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

    The library maps MessagePack types to JSON value types as follows:

    MessagePack type | JSON value type | first byte
    ---------------- | --------------- | ----------
    positive fixint  | number_unsigned | 0x00..0x7f
    fixmap           | object          | 0x80..0x8f
    fixarray         | array           | 0x90..0x9f
    fixstr           | string          | 0xa0..0xbf
    nil              | `null`          | 0xc0
    false            | `false`         | 0xc2
    true             | `true`          | 0xc3
    float 32         | number_float    | 0xca
    float 64         | number_float    | 0xcb
    uint 8           | number_unsigned | 0xcc
    uint 16          | number_unsigned | 0xcd
    uint 32          | number_unsigned | 0xce
    uint 64          | number_unsigned | 0xcf
    int 8            | number_integer  | 0xd0
    int 16           | number_integer  | 0xd1
    int 32           | number_integer  | 0xd2
    int 64           | number_integer  | 0xd3
    str 8            | string          | 0xd9
    str 16           | string          | 0xda
    str 32           | string          | 0xdb
    array 16         | array           | 0xdc
    array 32         | array           | 0xdd
    map 16           | object          | 0xde
    map 32           | object          | 0xdf
    negative fixint  | number_integer  | 0xe0-0xff

    @warning The mapping is **incomplete** in the sense that not all
             MessagePack types can be converted to a JSON value. The following
             MessagePack types are not supported and will yield parse errors:
              - bin 8 - bin 32 (0xc4..0xc6)
              - ext 8 - ext 32 (0xc7..0xc9)
              - fixext 1 - fixext 16 (0xd4..0xd8)

    @note Any MessagePack output created @ref to_msgpack can be successfully
          parsed by @ref from_msgpack.

    @param[in] v  a byte vector in MessagePack format
    @param[in] start_index the index to start reading from @a v (0 by default)
    @return deserialized JSON value

    @throw parse_error.110 if the given vector ends prematurely
    @throw parse_error.112 if unsupported features from MessagePack were
    used in the given vector @a v or if the input is not valid MessagePack
    @throw parse_error.113 if a string was expected as map key, but not found

    @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>&, const size_t) for the
        related CBOR format

    @since version 2.0.9, parameter @a start_index since 2.1.1
    */
    static basic_json from_msgpack(const std::vector<uint8_t>& v,
                                   const size_t start_index = 0)
    {
10955
        binary_reader br(input_adapter::create(v.begin() + static_cast<difference_type>(start_index), v.end()));
10956 10957 10958
        return br.parse_msgpack();
    }

10959 10960
    /// @}

N
Niels Lohmann 已提交
10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972
    //////////////////////
    // lexer and parser //
    //////////////////////

  private:
    /*!
    @brief lexical analysis

    This class organizes the lexical analysis during JSON deserialization.
    */
    class lexer
    {
N
Niels Lohmann 已提交
10973 10974 10975 10976 10977 10978 10979 10980 10981
      public:
        /// token types for the parser
        enum class token_type
        {
            uninitialized,   ///< indicating the scanner is uninitialized
            literal_true,    ///< the `true` literal
            literal_false,   ///< the `false` literal
            literal_null,    ///< the `null` literal
            value_string,    ///< a string -- use get_string() for actual value
N
Niels Lohmann 已提交
10982 10983 10984
            value_unsigned,  ///< an unsigned integer -- use get_number_unsigned() for actual value
            value_integer,   ///< a signed integer -- use get_number_integer() for actual value
            value_float,     ///< an floating point number -- use get_number_float() for actual value
N
Niels Lohmann 已提交
10985 10986 10987 10988 10989 10990 10991 10992 10993
            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
        };
10994

T
Théo DELRIEU 已提交
10995
        /// return name of values of type token_type (only used for errors)
N
Niels Lohmann 已提交
10996
        static const char* token_type_name(const token_type t) noexcept
T
Théo DELRIEU 已提交
10997 10998
        {
            switch (t)
N
cleanup  
Niels 已提交
10999
            {
T
Théo DELRIEU 已提交
11000 11001 11002 11003 11004 11005 11006 11007 11008 11009
                case token_type::uninitialized:
                    return "<uninitialized>";
                case token_type::literal_true:
                    return "true literal";
                case token_type::literal_false:
                    return "false literal";
                case token_type::literal_null:
                    return "null literal";
                case token_type::value_string:
                    return "string literal";
N
Niels Lohmann 已提交
11010 11011
                case lexer::token_type::value_unsigned:
                case lexer::token_type::value_integer:
11012
                case lexer::token_type::value_float:
T
Théo DELRIEU 已提交
11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033 11034
                    return "number literal";
                case token_type::begin_array:
                    return "'['";
                case token_type::begin_object:
                    return "'{'";
                case token_type::end_array:
                    return "']'";
                case token_type::end_object:
                    return "'}'";
                case token_type::name_separator:
                    return "':'";
                case token_type::value_separator:
                    return "','";
                case token_type::parse_error:
                    return "<parse error>";
                case token_type::end_of_input:
                    return "end of input";
                default:
                {
                    // catch non-enum values
                    return "unknown token"; // LCOV_EXCL_LINE
                }
N
cleanup  
Niels 已提交
11035 11036 11037
            }
        }

N
Niels Lohmann 已提交
11038 11039
        explicit lexer(input_adapter_t adapter)
            : ia(adapter), decimal_point_char(get_decimal_point())
N
Niels Lohmann 已提交
11040 11041 11042
        {}

      private:
11043 11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054
        /////////////////////
        // locales
        /////////////////////

        /// return the locale-dependent decimal point
        static char get_decimal_point() noexcept
        {
            const auto loc = localeconv();
            assert(loc != nullptr);
            return (loc->decimal_point == nullptr) ? '.' : loc->decimal_point[0];
        }

N
Niels Lohmann 已提交
11055 11056 11057
        /////////////////////
        // scan functions
        /////////////////////
N
Niels 已提交
11058

N
Niels Lohmann 已提交
11059 11060 11061 11062 11063 11064
        /*!
        @brief get codepoint from 4 hex characters following `\u`

        @return codepoint or -1 in case of an error (e.g. EOF or non-hex
                character)
        */
N
Niels Lohmann 已提交
11065 11066
        int get_codepoint()
        {
N
Niels Lohmann 已提交
11067
            // this function only makes sense after reading `\u`
11068
            assert(current == 'u');
N
Niels Lohmann 已提交
11069 11070
            int codepoint = 0;

N
Niels Lohmann 已提交
11071
            // byte 1: \uXxxx
11072
            switch (get())
N
Niels Lohmann 已提交
11073
            {
11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127
                case '0':
                    break;
                case '1':
                    codepoint += 0x1000;
                    break;
                case '2':
                    codepoint += 0x2000;
                    break;
                case '3':
                    codepoint += 0x3000;
                    break;
                case '4':
                    codepoint += 0x4000;
                    break;
                case '5':
                    codepoint += 0x5000;
                    break;
                case '6':
                    codepoint += 0x6000;
                    break;
                case '7':
                    codepoint += 0x7000;
                    break;
                case '8':
                    codepoint += 0x8000;
                    break;
                case '9':
                    codepoint += 0x9000;
                    break;
                case 'A':
                case 'a':
                    codepoint += 0xa000;
                    break;
                case 'B':
                case 'b':
                    codepoint += 0xb000;
                    break;
                case 'C':
                case 'c':
                    codepoint += 0xc000;
                    break;
                case 'D':
                case 'd':
                    codepoint += 0xd000;
                    break;
                case 'E':
                case 'e':
                    codepoint += 0xe000;
                    break;
                case 'F':
                case 'f':
                    codepoint += 0xf000;
                    break;
                default:
N
Niels Lohmann 已提交
11128
                    return -1;
11129
            }
N
Niels Lohmann 已提交
11130

N
Niels Lohmann 已提交
11131
            // byte 2: \uxXxx
11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190
            switch (get())
            {
                case '0':
                    break;
                case '1':
                    codepoint += 0x0100;
                    break;
                case '2':
                    codepoint += 0x0200;
                    break;
                case '3':
                    codepoint += 0x0300;
                    break;
                case '4':
                    codepoint += 0x0400;
                    break;
                case '5':
                    codepoint += 0x0500;
                    break;
                case '6':
                    codepoint += 0x0600;
                    break;
                case '7':
                    codepoint += 0x0700;
                    break;
                case '8':
                    codepoint += 0x0800;
                    break;
                case '9':
                    codepoint += 0x0900;
                    break;
                case 'A':
                case 'a':
                    codepoint += 0x0a00;
                    break;
                case 'B':
                case 'b':
                    codepoint += 0x0b00;
                    break;
                case 'C':
                case 'c':
                    codepoint += 0x0c00;
                    break;
                case 'D':
                case 'd':
                    codepoint += 0x0d00;
                    break;
                case 'E':
                case 'e':
                    codepoint += 0x0e00;
                    break;
                case 'F':
                case 'f':
                    codepoint += 0x0f00;
                    break;
                default:
                    return -1;
            }

N
Niels Lohmann 已提交
11191
            // byte 3: \uxxXx
11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250
            switch (get())
            {
                case '0':
                    break;
                case '1':
                    codepoint += 0x0010;
                    break;
                case '2':
                    codepoint += 0x0020;
                    break;
                case '3':
                    codepoint += 0x0030;
                    break;
                case '4':
                    codepoint += 0x0040;
                    break;
                case '5':
                    codepoint += 0x0050;
                    break;
                case '6':
                    codepoint += 0x0060;
                    break;
                case '7':
                    codepoint += 0x0070;
                    break;
                case '8':
                    codepoint += 0x0080;
                    break;
                case '9':
                    codepoint += 0x0090;
                    break;
                case 'A':
                case 'a':
                    codepoint += 0x00a0;
                    break;
                case 'B':
                case 'b':
                    codepoint += 0x00b0;
                    break;
                case 'C':
                case 'c':
                    codepoint += 0x00c0;
                    break;
                case 'D':
                case 'd':
                    codepoint += 0x00d0;
                    break;
                case 'E':
                case 'e':
                    codepoint += 0x00e0;
                    break;
                case 'F':
                case 'f':
                    codepoint += 0x00f0;
                    break;
                default:
                    return -1;
            }

N
Niels Lohmann 已提交
11251
            // byte 4: \uxxxX
11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308
            switch (get())
            {
                case '0':
                    break;
                case '1':
                    codepoint += 0x0001;
                    break;
                case '2':
                    codepoint += 0x0002;
                    break;
                case '3':
                    codepoint += 0x0003;
                    break;
                case '4':
                    codepoint += 0x0004;
                    break;
                case '5':
                    codepoint += 0x0005;
                    break;
                case '6':
                    codepoint += 0x0006;
                    break;
                case '7':
                    codepoint += 0x0007;
                    break;
                case '8':
                    codepoint += 0x0008;
                    break;
                case '9':
                    codepoint += 0x0009;
                    break;
                case 'A':
                case 'a':
                    codepoint += 0x000a;
                    break;
                case 'B':
                case 'b':
                    codepoint += 0x000b;
                    break;
                case 'C':
                case 'c':
                    codepoint += 0x000c;
                    break;
                case 'D':
                case 'd':
                    codepoint += 0x000d;
                    break;
                case 'E':
                case 'e':
                    codepoint += 0x000e;
                    break;
                case 'F':
                case 'f':
                    codepoint += 0x000f;
                    break;
                default:
                    return -1;
N
Niels Lohmann 已提交
11309
            }
N
Niels Lohmann 已提交
11310 11311

            return codepoint;
N
Niels Lohmann 已提交
11312 11313
        }

N
Niels Lohmann 已提交
11314 11315 11316 11317
        /*!
        @brief create diagnostic representation of a codepoint
        @return string "U+XXXX" for codepoint XXXX
        */
11318 11319 11320 11321 11322 11323 11324
        static std::string codepoint_to_string(int codepoint)
        {
            std::stringstream ss;
            ss << "U+" << std::setw(4) << std::uppercase << std::setfill('0') << std::hex << codepoint;
            return ss.str();
        }

N
Niels Lohmann 已提交
11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338
        /*!
        @brief scan a string literal

        This function scans a string according to Sect. 7 of RFC 7159. While
        scanning, bytes are escaped and copied into buffer yytext. Then the
        function returns successfully, yytext is null-terminated and yylen
        contains the number of bytes in the string.

        @return token_type::value_string if string could be successfully
                scanned, token_type::parse_error otherwise

        @note In case of errors, variable error_message contains a textual
              description.
        */
N
Niels Lohmann 已提交
11339
        token_type scan_string()
N
Niels 已提交
11340
        {
N
Niels Lohmann 已提交
11341 11342 11343
            // reset yytext (ignore opening quote)
            reset();

11344
            // we entered the function by reading an open quote
N
Niels Lohmann 已提交
11345
            assert(current == '\"');
11346

T
Théo DELRIEU 已提交
11347 11348
            while (true)
            {
11349
                // get next character
N
Niels Lohmann 已提交
11350
                get();
N
Niels 已提交
11351

11352
                switch (current)
N
Niels Lohmann 已提交
11353
                {
11354 11355
                    // end of file while parsing string
                    case std::char_traits<char>::eof():
11356
                    {
11357 11358
                        error_message = "invalid string: missing closing quote";
                        return token_type::parse_error;
11359 11360
                    }

11361 11362
                    // closing quote
                    case '\"':
11363
                    {
11364 11365 11366 11367
                        // terminate yytext
                        add('\0');
                        --yylen;
                        return token_type::value_string;
11368 11369
                    }

11370 11371
                    // escapes
                    case '\\':
N
Niels Lohmann 已提交
11372
                    {
N
Niels Lohmann 已提交
11373
                        switch (get())
N
Niels Lohmann 已提交
11374
                        {
N
Niels Lohmann 已提交
11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409
                            // quotation mark
                            case '\"':
                                add('\"');
                                break;
                            // reverse solidus
                            case '\\':
                                add('\\');
                                break;
                            // solidus
                            case '/':
                                add('/');
                                break;
                            // backspace
                            case 'b':
                                add('\b');
                                break;
                            // form feed
                            case 'f':
                                add('\f');
                                break;
                            // line feed
                            case 'n':
                                add('\n');
                                break;
                            // carriage return
                            case 'r':
                                add('\r');
                                break;
                            // tab
                            case 't':
                                add('\t');
                                break;

                            // unicode escapes
                            case 'u':
N
Niels Lohmann 已提交
11410
                            {
N
Niels Lohmann 已提交
11411 11412 11413 11414
                                int codepoint;
                                int codepoint1 = get_codepoint();

                                if (JSON_UNLIKELY(codepoint1 == -1))
N
Niels Lohmann 已提交
11415
                                {
N
Niels Lohmann 已提交
11416 11417
                                    error_message = "invalid string: '\\u' must be followed by 4 hex digits";
                                    return token_type::parse_error;
N
Niels Lohmann 已提交
11418
                                }
N
Niels Lohmann 已提交
11419 11420

                                // check if code point is a high surrogate
N
Niels Lohmann 已提交
11421
                                if (0xD800 <= codepoint1 and codepoint1 <= 0xDBFF)
N
Niels Lohmann 已提交
11422
                                {
N
Niels Lohmann 已提交
11423 11424 11425
                                    // expect next \uxxxx entry
                                    if (JSON_LIKELY(get() == '\\' and get() == 'u'))
                                    {
11426
                                        const int codepoint2 = get_codepoint();
N
Niels Lohmann 已提交
11427 11428 11429 11430 11431 11432 11433 11434

                                        if (JSON_UNLIKELY(codepoint2 == -1))
                                        {
                                            error_message = "invalid string: '\\u' must be followed by 4 hex digits";
                                            return token_type::parse_error;
                                        }

                                        // check if codepoint2 is a low surrogate
N
Niels Lohmann 已提交
11435
                                        if (JSON_LIKELY(0xDC00 <= codepoint2 and codepoint2 <= 0xDFFF))
N
Niels Lohmann 已提交
11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448
                                        {
                                            codepoint =
                                                // high surrogate occupies the most significant 22 bits
                                                (codepoint1 << 10)
                                                // low surrogate occupies the least significant 15 bits
                                                + codepoint2
                                                // there is still the 0xD800, 0xDC00 and 0x10000 noise
                                                // in the result so we have to subtract with:
                                                // (0xD800 << 10) + DC00 - 0x10000 = 0x35FDC00
                                                - 0x35FDC00;
                                        }
                                        else
                                        {
11449
                                            error_message = "invalid string: surrogate " + codepoint_to_string(codepoint1) + " must be followed by U+DC00..U+DFFF instead of " + codepoint_to_string(codepoint2);
N
Niels Lohmann 已提交
11450 11451 11452 11453 11454
                                            return token_type::parse_error;
                                        }
                                    }
                                    else
                                    {
11455
                                        error_message = "invalid string: surrogate " + codepoint_to_string(codepoint1) + " must be followed by U+DC00..U+DFFF";
N
Niels Lohmann 已提交
11456 11457
                                        return token_type::parse_error;
                                    }
N
Niels Lohmann 已提交
11458
                                }
N
Niels Lohmann 已提交
11459
                                else
N
Niels Lohmann 已提交
11460
                                {
N
Niels Lohmann 已提交
11461
                                    if (JSON_UNLIKELY(0xDC00 <= codepoint1 and codepoint1 <= 0xDFFF))
N
Niels Lohmann 已提交
11462
                                    {
11463
                                        error_message = "invalid string: surrogate " + codepoint_to_string(codepoint1) + " must follow U+D800..U+DBFF";
N
Niels Lohmann 已提交
11464 11465 11466 11467 11468
                                        return token_type::parse_error;
                                    }

                                    // only work with first code point
                                    codepoint = codepoint1;
N
Niels Lohmann 已提交
11469
                                }
N
Niels Lohmann 已提交
11470

N
Niels Lohmann 已提交
11471 11472 11473
                                // result of the above calculation yields a proper codepoint
                                assert(0x00 <= codepoint and codepoint <= 0x10FFFF);

N
Niels Lohmann 已提交
11474 11475
                                // translate code point to bytes
                                if (codepoint < 0x80)
N
Niels Lohmann 已提交
11476
                                {
N
Niels Lohmann 已提交
11477 11478
                                    // 1-byte characters: 0xxxxxxx (ASCII)
                                    add(codepoint);
N
Niels Lohmann 已提交
11479
                                }
N
Niels Lohmann 已提交
11480
                                else if (codepoint <= 0x7ff)
N
Niels Lohmann 已提交
11481
                                {
N
Niels Lohmann 已提交
11482 11483 11484
                                    // 2-byte characters: 110xxxxx 10xxxxxx
                                    add(0xC0 | (codepoint >> 6));
                                    add(0x80 | (codepoint & 0x3F));
N
Niels Lohmann 已提交
11485
                                }
N
Niels Lohmann 已提交
11486
                                else if (codepoint <= 0xffff)
N
Niels Lohmann 已提交
11487
                                {
N
Niels Lohmann 已提交
11488 11489 11490 11491
                                    // 3-byte characters: 1110xxxx 10xxxxxx 10xxxxxx
                                    add(0xE0 | (codepoint >> 12));
                                    add(0x80 | ((codepoint >> 6) & 0x3F));
                                    add(0x80 | (codepoint & 0x3F));
N
Niels Lohmann 已提交
11492
                                }
N
Niels Lohmann 已提交
11493
                                else
N
Niels Lohmann 已提交
11494
                                {
N
Niels Lohmann 已提交
11495 11496 11497 11498 11499
                                    // 4-byte characters: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
                                    add(0xF0 | (codepoint >> 18));
                                    add(0x80 | ((codepoint >> 12) & 0x3F));
                                    add(0x80 | ((codepoint >> 6) & 0x3F));
                                    add(0x80 | (codepoint & 0x3F));
N
Niels Lohmann 已提交
11500
                                }
N
Niels Lohmann 已提交
11501 11502

                                break;
N
Niels Lohmann 已提交
11503
                            }
N
Niels Lohmann 已提交
11504 11505 11506

                            // other characters after escape
                            default:
11507
                                error_message = "invalid string: forbidden character after backslash";
N
Niels Lohmann 已提交
11508
                                return token_type::parse_error;
N
Niels Lohmann 已提交
11509
                        }
N
Niels Lohmann 已提交
11510

N
Niels Lohmann 已提交
11511 11512
                        break;
                    }
N
Niels Lohmann 已提交
11513

11514
                    // invalid control characters
N
Niels Lohmann 已提交
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
                    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:
                    case 0x18:
                    case 0x19:
                    case 0x1a:
                    case 0x1b:
                    case 0x1c:
                    case 0x1d:
                    case 0x1e:
                    case 0x1f:
11547
                    {
11548
                        error_message = "invalid string: control character " + codepoint_to_string(current) + " must be escaped";
11549 11550 11551 11552
                        return token_type::parse_error;
                    }

                    // U+0020..U+007F (except U+0022 (quote) and U+005C (backspace))
N
Niels Lohmann 已提交
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 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646
                    case 0x20:
                    case 0x21:
                    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:
                    case 0x38:
                    case 0x39:
                    case 0x3a:
                    case 0x3b:
                    case 0x3c:
                    case 0x3d:
                    case 0x3e:
                    case 0x3f:
                    case 0x40:
                    case 0x41:
                    case 0x42:
                    case 0x43:
                    case 0x44:
                    case 0x45:
                    case 0x46:
                    case 0x47:
                    case 0x48:
                    case 0x49:
                    case 0x4a:
                    case 0x4b:
                    case 0x4c:
                    case 0x4d:
                    case 0x4e:
                    case 0x4f:
                    case 0x50:
                    case 0x51:
                    case 0x52:
                    case 0x53:
                    case 0x54:
                    case 0x55:
                    case 0x56:
                    case 0x57:
                    case 0x58:
                    case 0x59:
                    case 0x5a:
                    case 0x5b:
                    case 0x5d:
                    case 0x5e:
                    case 0x5f:
                    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:
                    case 0x78:
                    case 0x79:
                    case 0x7a:
                    case 0x7b:
                    case 0x7c:
                    case 0x7d:
                    case 0x7e:
                    case 0x7f:
11647 11648 11649 11650 11651 11652
                    {
                        add(current);
                        break;
                    }

                    // U+0080..U+07FF: bytes C2..DF 80..BF
N
Niels Lohmann 已提交
11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672 11673 11674 11675 11676 11677 11678 11679 11680 11681 11682
                    case 0xc2:
                    case 0xc3:
                    case 0xc4:
                    case 0xc5:
                    case 0xc6:
                    case 0xc7:
                    case 0xc8:
                    case 0xc9:
                    case 0xca:
                    case 0xcb:
                    case 0xcc:
                    case 0xcd:
                    case 0xce:
                    case 0xcf:
                    case 0xd0:
                    case 0xd1:
                    case 0xd2:
                    case 0xd3:
                    case 0xd4:
                    case 0xd5:
                    case 0xd6:
                    case 0xd7:
                    case 0xd8:
                    case 0xd9:
                    case 0xda:
                    case 0xdb:
                    case 0xdc:
                    case 0xdd:
                    case 0xde:
                    case 0xdf:
11683 11684 11685
                    {
                        add(current);
                        get();
N
Niels Lohmann 已提交
11686
                        if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11687 11688 11689 11690 11691
                        {
                            add(current);
                            continue;
                        }

11692
                        error_message = "invalid string: ill-formed UTF-8 byte";
11693 11694 11695 11696
                        return token_type::parse_error;
                    }

                    // U+0800..U+0FFF: bytes E0 A0..BF 80..BF
N
Niels Lohmann 已提交
11697
                    case 0xe0:
11698 11699 11700
                    {
                        add(current);
                        get();
N
Niels Lohmann 已提交
11701
                        if (JSON_LIKELY(0xa0 <= current and current <= 0xbf))
11702 11703 11704
                        {
                            add(current);
                            get();
N
Niels Lohmann 已提交
11705
                            if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11706 11707 11708 11709 11710 11711
                            {
                                add(current);
                                continue;
                            }
                        }

11712
                        error_message = "invalid string: ill-formed UTF-8 byte";
11713 11714 11715 11716 11717
                        return token_type::parse_error;
                    }

                    // U+1000..U+CFFF: bytes E1..EC 80..BF 80..BF
                    // U+E000..U+FFFF: bytes EE..EF 80..BF 80..BF
N
Niels Lohmann 已提交
11718 11719 11720 11721 11722 11723 11724 11725 11726 11727 11728 11729 11730 11731
                    case 0xe1:
                    case 0xe2:
                    case 0xe3:
                    case 0xe4:
                    case 0xe5:
                    case 0xe6:
                    case 0xe7:
                    case 0xe8:
                    case 0xe9:
                    case 0xea:
                    case 0xeb:
                    case 0xec:
                    case 0xee:
                    case 0xef:
11732 11733 11734
                    {
                        add(current);
                        get();
N
Niels Lohmann 已提交
11735
                        if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11736 11737 11738
                        {
                            add(current);
                            get();
N
Niels Lohmann 已提交
11739
                            if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11740 11741 11742 11743 11744 11745
                            {
                                add(current);
                                continue;
                            }
                        }

11746
                        error_message = "invalid string: ill-formed UTF-8 byte";
11747 11748 11749 11750
                        return token_type::parse_error;
                    }

                    // U+D000..U+D7FF: bytes ED 80..9F 80..BF
N
Niels Lohmann 已提交
11751
                    case 0xed:
11752 11753 11754
                    {
                        add(current);
                        get();
N
Niels Lohmann 已提交
11755
                        if (JSON_LIKELY(0x80 <= current and current <= 0x9f))
11756 11757 11758
                        {
                            add(current);
                            get();
N
Niels Lohmann 已提交
11759
                            if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11760 11761 11762 11763 11764 11765
                            {
                                add(current);
                                continue;
                            }
                        }

11766
                        error_message = "invalid string: ill-formed UTF-8 byte";
11767
                        return token_type::parse_error;
11768 11769
                    }

11770
                    // U+10000..U+3FFFF F0 90..BF 80..BF 80..BF
N
Niels Lohmann 已提交
11771
                    case 0xf0:
11772 11773 11774
                    {
                        add(current);
                        get();
N
Niels Lohmann 已提交
11775
                        if (JSON_LIKELY(0x90 <= current and current <= 0xbf))
11776 11777 11778
                        {
                            add(current);
                            get();
N
Niels Lohmann 已提交
11779
                            if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11780 11781 11782
                            {
                                add(current);
                                get();
N
Niels Lohmann 已提交
11783
                                if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11784 11785 11786 11787 11788 11789 11790
                                {
                                    add(current);
                                    continue;
                                }
                            }
                        }

11791
                        error_message = "invalid string: ill-formed UTF-8 byte";
11792 11793 11794 11795
                        return token_type::parse_error;
                    }

                    // U+40000..U+FFFFF F1..F3 80..BF 80..BF 80..BF
N
Niels Lohmann 已提交
11796 11797 11798
                    case 0xf1:
                    case 0xf2:
                    case 0xf3:
11799 11800 11801
                    {
                        add(current);
                        get();
N
Niels Lohmann 已提交
11802
                        if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11803 11804 11805
                        {
                            add(current);
                            get();
N
Niels Lohmann 已提交
11806
                            if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11807 11808 11809
                            {
                                add(current);
                                get();
N
Niels Lohmann 已提交
11810
                                if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11811 11812 11813 11814 11815 11816 11817
                                {
                                    add(current);
                                    continue;
                                }
                            }
                        }

11818
                        error_message = "invalid string: ill-formed UTF-8 byte";
11819 11820 11821
                        return token_type::parse_error;
                    }

11822
                    // U+100000..U+10FFFF F4 80..8F 80..BF 80..BF
N
Niels Lohmann 已提交
11823
                    case 0xf4:
11824
                    {
11825 11826
                        add(current);
                        get();
N
Niels Lohmann 已提交
11827
                        if (JSON_LIKELY(0x80 <= current and current <= 0x8f))
11828 11829 11830
                        {
                            add(current);
                            get();
N
Niels Lohmann 已提交
11831
                            if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11832 11833 11834
                            {
                                add(current);
                                get();
N
Niels Lohmann 已提交
11835
                                if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11836 11837 11838 11839 11840 11841 11842
                                {
                                    add(current);
                                    continue;
                                }
                            }
                        }

11843
                        error_message = "invalid string: ill-formed UTF-8 byte";
11844 11845 11846
                        return token_type::parse_error;
                    }

11847
                    // remaining bytes (80..C1 and F5..FF) are ill-formed
N
Niels Lohmann 已提交
11848
                    default:
N
Niels Lohmann 已提交
11849
                    {
11850
                        error_message = "invalid string: ill-formed UTF-8 byte";
11851
                        return token_type::parse_error;
N
Niels Lohmann 已提交
11852
                    }
N
Niels Lohmann 已提交
11853 11854 11855 11856
                }
            }
        }

11857 11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869 11870 11871
        static void strtof(float& f, const char* str, char** endptr) noexcept
        {
            f = std::strtof(str, endptr);
        }

        static void strtof(double& f, const char* str, char** endptr) noexcept
        {
            f = std::strtod(str, endptr);
        }

        static void strtof(long double& f, const char* str, char** endptr) noexcept
        {
            f = std::strtold(str, endptr);
        }

11872
        /*!
N
Niels Lohmann 已提交
11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883
        @brief scan a number literal

        This function scans a string according to Sect. 6 of RFC 7159.

        The function is realized with a deterministic finite state machine
        derived from the grammar described in RFC 7159. Starting in state
        "init", the input is read and used to determined the next state. Only
        state "done" accepts the number. State "error" is a trap state to model
        errors. In the table below, "anything" means any character but the ones
        listed before.

11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894
        state    | 0        | 1-9      | e E      | +       | -       | .        | anything
        ---------|----------|----------|----------|---------|---------|----------|-----------
        init     | zero     | any1     | [error]  | [error] | minus   | [error]  | [error]
        minus    | zero     | any1     | [error]  | [error] | [error] | [error]  | [error]
        zero     | done     | done     | exponent | done    | done    | decimal1 | done
        any1     | any1     | any1     | exponent | done    | done    | decimal1 | done
        decimal1 | decimal2 | [error]  | [error]  | [error] | [error] | [error]  | [error]
        decimal2 | decimal2 | decimal2 | exponent | done    | done    | done     | done
        exponent | any2     | any2     | [error]  | sign    | sign    | [error]  | [error]
        sign     | any2     | any2     | [error]  | [error] | [error] | [error]  | [error]
        any2     | any2     | any2     | done     | done    | done    | done     | done
N
Niels Lohmann 已提交
11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911

        The state machine is realized with one label per state (prefixed with
        "scan_number_") and `goto` statements between them. The state machine
        contains cycles, but any cycle can be left when EOF is read. Therefore,
        the function is guaranteed to terminate.

        During scanning, the read bytes are stored in yytext. This string is
        then converted to a signed integer, an unsigned integer, or a
        floating-point number.

        @return token_type::value_unsigned, token_type::value_integer, or
                token_type::value_float if number could be successfully scanned,
                token_type::parse_error otherwise

        @note The scanner is independent of the current locale. Internally, the
              locale's decimal point is used instead of `.` to work with the
              locale-dependent converters.
11912
        */
N
Niels Lohmann 已提交
11913 11914
        token_type scan_number()
        {
N
Niels Lohmann 已提交
11915
            // reset yytext to store the number's bytes
11916 11917
            reset();

N
Niels Lohmann 已提交
11918 11919
            // the type of the parsed number; initially set to unsigned; will be
            // changed if minus sign, decimal point or exponent is read
11920 11921
            token_type number_type = token_type::value_unsigned;

11922
            // state (init): we just found out we need to scan a number
11923
            switch (current)
N
Niels Lohmann 已提交
11924
            {
11925 11926 11927 11928 11929
                case '-':
                {
                    add(current);
                    goto scan_number_minus;
                }
N
Niels Lohmann 已提交
11930

11931 11932 11933 11934 11935
                case '0':
                {
                    add(current);
                    goto scan_number_zero;
                }
N
Niels Lohmann 已提交
11936

11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949
                case '1':
                case '2':
                case '3':
                case '4':
                case '5':
                case '6':
                case '7':
                case '8':
                case '9':
                {
                    add(current);
                    goto scan_number_any1;
                }
N
Niels Lohmann 已提交
11950

11951 11952 11953 11954 11955 11956
                default:
                {
                    // all other characters are rejected outside scan_number()
                    assert(false);  // LCOV_EXCL_LINE
                }
            }
N
Niels Lohmann 已提交
11957

11958 11959 11960 11961
scan_number_minus:
            // state: we just parsed a leading minus sign
            number_type = token_type::value_integer;
            switch (get())
N
Niels Lohmann 已提交
11962
            {
11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981
                case '0':
                {
                    add(current);
                    goto scan_number_zero;
                }

                case '1':
                case '2':
                case '3':
                case '4':
                case '5':
                case '6':
                case '7':
                case '8':
                case '9':
                {
                    add(current);
                    goto scan_number_any1;
                }
N
Niels Lohmann 已提交
11982

11983
                default:
N
Niels Lohmann 已提交
11984
                {
11985
                    error_message = "invalid number; expected digit after '-'";
N
Niels Lohmann 已提交
11986
                    return token_type::parse_error;
N
Niels Lohmann 已提交
11987
                }
11988
            }
11989

11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083 12084 12085 12086 12087 12088 12089 12090 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 12143 12144 12145 12146 12147 12148 12149 12150 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 12190 12191 12192
scan_number_zero:
            // state: we just parse a zero (maybe with a leading minus sign)
            switch (get())
            {
                case '.':
                {
                    add(decimal_point_char);
                    goto scan_number_decimal1;
                }

                case 'e':
                case 'E':
                {
                    add(current);
                    goto scan_number_exponent;
                }

                default:
                {
                    goto scan_number_done;
                }
            }

scan_number_any1:
            // state: we just parsed a number 0-9 (maybe with a leading minus sign)
            switch (get())
            {
                case '0':
                case '1':
                case '2':
                case '3':
                case '4':
                case '5':
                case '6':
                case '7':
                case '8':
                case '9':
                {
                    add(current);
                    goto scan_number_any1;
                }

                case '.':
                {
                    add(decimal_point_char);
                    goto scan_number_decimal1;
                }

                case 'e':
                case 'E':
                {
                    add(current);
                    goto scan_number_exponent;
                }

                default:
                {
                    goto scan_number_done;
                }
            }

scan_number_decimal1:
            // state: we just parsed a decimal point
            number_type = token_type::value_float;
            switch (get())
            {
                case '0':
                case '1':
                case '2':
                case '3':
                case '4':
                case '5':
                case '6':
                case '7':
                case '8':
                case '9':
                {
                    add(current);
                    goto scan_number_decimal2;
                }

                default:
                {
                    error_message = "invalid number; expected digit after '.'";
                    return token_type::parse_error;
                }
            }

scan_number_decimal2:
            // we just parsed at least one number after a decimal point
            switch (get())
            {
                case '0':
                case '1':
                case '2':
                case '3':
                case '4':
                case '5':
                case '6':
                case '7':
                case '8':
                case '9':
                {
                    add(current);
                    goto scan_number_decimal2;
                }

                case 'e':
                case 'E':
                {
                    add(current);
                    goto scan_number_exponent;
                }

                default:
                {
                    goto scan_number_done;
                }
            }

scan_number_exponent:
            // we just parsed an exponent
            number_type = token_type::value_float;
            switch (get())
            {
                case '+':
                case '-':
                {
                    add(current);
                    goto scan_number_sign;
                }

                case '0':
                case '1':
                case '2':
                case '3':
                case '4':
                case '5':
                case '6':
                case '7':
                case '8':
                case '9':
                {
                    add(current);
                    goto scan_number_any2;
                }

                default:
                {
                    error_message = "invalid number; expected '+', '-', or digit after exponent";
                    return token_type::parse_error;
                }
            }

scan_number_sign:
            // we just parsed an exponent sign
            switch (get())
            {
                case '0':
                case '1':
                case '2':
                case '3':
                case '4':
                case '5':
                case '6':
                case '7':
                case '8':
                case '9':
                {
                    add(current);
                    goto scan_number_any2;
                }

                default:
                {
                    error_message = "invalid number; expected digit after exponent sign";
                    return token_type::parse_error;
                }
            }

scan_number_any2:
            // we just parsed a number after the exponent or exponent sign
            switch (get())
            {
                case '0':
                case '1':
                case '2':
                case '3':
                case '4':
                case '5':
                case '6':
                case '7':
                case '8':
                case '9':
                {
                    add(current);
                    goto scan_number_any2;
                }

                default:
                {
                    goto scan_number_done;
                }
T
Théo DELRIEU 已提交
12193
            }
12194

12195
scan_number_done:
N
Niels Lohmann 已提交
12196 12197
            // unget the character after the number (we only read it to know
            // that we are done scanning a number)
12198 12199
            --chars_read;
            next_unget = true;
N
Niels Lohmann 已提交
12200

N
Niels Lohmann 已提交
12201 12202 12203
            // terminate token
            add('\0');
            --yylen;
N
Niels 已提交
12204

N
Niels Lohmann 已提交
12205
            // try to parse integers first and fall back to floats
12206
            if (number_type == token_type::value_unsigned)
12207
            {
12208
                char* endptr = nullptr;
N
Niels Lohmann 已提交
12209
                errno = 0;
12210 12211 12212 12213 12214 12215
                const auto x = std::strtoull(yytext.data(), &endptr, 10);

                // we checked the number format before
                assert(endptr == yytext.data() + yylen);

                if (errno == 0)
N
Niels Lohmann 已提交
12216
                {
12217 12218
                    value_unsigned = static_cast<number_unsigned_t>(x);
                    if (value_unsigned == x)
N
Niels Lohmann 已提交
12219
                    {
12220
                        return token_type::value_unsigned;
N
Niels Lohmann 已提交
12221 12222
                    }
                }
12223 12224 12225 12226 12227 12228 12229 12230 12231 12232 12233
            }
            else if (number_type == token_type::value_integer)
            {
                char* endptr = nullptr;
                errno = 0;
                const auto x = std::strtoll(yytext.data(), &endptr, 10);

                // we checked the number format before
                assert(endptr == yytext.data() + yylen);

                if (errno == 0)
N
Niels Lohmann 已提交
12234
                {
12235 12236
                    value_integer = static_cast<number_integer_t>(x);
                    if (value_integer == x)
N
Niels Lohmann 已提交
12237
                    {
12238
                        return token_type::value_integer;
N
Niels Lohmann 已提交
12239 12240
                    }
                }
12241
            }
N
Niels Lohmann 已提交
12242

12243 12244
            // this code is reached if we parse a floating-point number or if
            // an integer conversion above failed
12245
            strtof(value_float, yytext.data(), nullptr);
N
Niels Lohmann 已提交
12246
            return token_type::value_float;
N
Niels 已提交
12247 12248
        }

N
Niels Lohmann 已提交
12249
        token_type scan_true()
T
Théo DELRIEU 已提交
12250
        {
N
Niels Lohmann 已提交
12251
            assert(current == 't');
N
Niels Lohmann 已提交
12252 12253 12254 12255 12256 12257 12258
            if (JSON_LIKELY((get() == 'r' and get() == 'u' and get() == 'e')))
            {
                return token_type::literal_true;
            }

            error_message = "invalid literal; expected 'true'";
            return token_type::parse_error;
T
Théo DELRIEU 已提交
12259
        }
12260

N
Niels Lohmann 已提交
12261
        token_type scan_false()
T
Théo DELRIEU 已提交
12262
        {
N
Niels Lohmann 已提交
12263
            assert(current == 'f');
N
Niels Lohmann 已提交
12264
            if (JSON_LIKELY((get() == 'a' and get() == 'l' and get() == 's' and get() == 'e')))
N
Niels 已提交
12265
            {
N
Niels Lohmann 已提交
12266
                return token_type::literal_false;
N
Niels 已提交
12267
            }
T
Théo DELRIEU 已提交
12268

N
Niels Lohmann 已提交
12269 12270
            error_message = "invalid literal; expected 'false'";
            return token_type::parse_error;
N
Niels 已提交
12271 12272
        }

N
Niels Lohmann 已提交
12273 12274
        token_type scan_null()
        {
N
Niels Lohmann 已提交
12275
            assert(current == 'n');
N
Niels Lohmann 已提交
12276 12277 12278 12279
            if (JSON_LIKELY((get() == 'u' and get() == 'l' and get() == 'l')))
            {
                return token_type::literal_null;
            }
12280

N
Niels Lohmann 已提交
12281 12282 12283
            error_message = "invalid literal; expected 'null'";
            return token_type::parse_error;
        }
12284

N
Niels Lohmann 已提交
12285 12286 12287
        /////////////////////
        // input management
        /////////////////////
12288

N
Niels Lohmann 已提交
12289 12290
        /// reset yytext
        void reset() noexcept
T
Théo DELRIEU 已提交
12291
        {
N
Niels Lohmann 已提交
12292 12293 12294
            yylen = 0;
            start_pos = chars_read - 1;
        }
12295

N
Niels Lohmann 已提交
12296
        /// get a character from the input
N
Niels Lohmann 已提交
12297 12298 12299
        int get()
        {
            ++chars_read;
12300 12301 12302
            return next_unget
                   ? (next_unget = false, current)
                   : (current = ia->get_character());
N
Niels Lohmann 已提交
12303
        }
N
Niels 已提交
12304

N
Niels Lohmann 已提交
12305
        /// add a character to yytext
N
Niels Lohmann 已提交
12306 12307
        void add(int c)
        {
12308 12309
            // resize yytext if necessary; this condition is deemed unlikely,
            // because we start with a 1024-byte buffer
N
Niels Lohmann 已提交
12310
            if (JSON_UNLIKELY((yylen + 1 > yytext.capacity())))
T
Théo DELRIEU 已提交
12311
            {
N
Niels Lohmann 已提交
12312 12313 12314 12315
                yytext.resize(2 * yytext.capacity(), '\0');
            }
            yytext[yylen++] = static_cast<char>(c);
        }
12316

N
Niels Lohmann 已提交
12317
      public:
N
Niels Lohmann 已提交
12318 12319 12320
        /////////////////////
        // value getters
        /////////////////////
12321

N
Niels Lohmann 已提交
12322
        /// return integer value
N
Niels Lohmann 已提交
12323 12324 12325 12326 12327
        constexpr number_integer_t get_number_integer() const noexcept
        {
            return value_integer;
        }

N
Niels Lohmann 已提交
12328
        /// return unsigned integer value
N
Niels Lohmann 已提交
12329 12330 12331 12332 12333
        constexpr number_unsigned_t get_number_unsigned() const noexcept
        {
            return value_unsigned;
        }

N
Niels Lohmann 已提交
12334
        /// return floating-point value
N
Niels Lohmann 已提交
12335 12336 12337 12338 12339
        constexpr number_float_t get_number_float() const noexcept
        {
            return value_float;
        }

N
Niels Lohmann 已提交
12340
        /// return string value
N
Niels Lohmann 已提交
12341 12342
        const std::string get_string()
        {
N
Niels Lohmann 已提交
12343
            // yytext cannot be returned as char*, because it may contain a
N
Niels Lohmann 已提交
12344
            // null byte (parsed as "\u0000")
N
Niels Lohmann 已提交
12345 12346
            return std::string(yytext.data(), yylen);
        }
12347

N
Niels Lohmann 已提交
12348 12349 12350 12351 12352 12353 12354 12355 12356 12357 12358
        /////////////////////
        // diagnostics
        /////////////////////

        /// return position of last read token
        constexpr size_t get_position() const noexcept
        {
            return chars_read;
        }

        /// return the last read token (for errors only)
N
Niels Lohmann 已提交
12359 12360
        std::string get_token_string() const
        {
N
Niels Lohmann 已提交
12361
            // get the raw byte sequence of the last token
N
Niels Lohmann 已提交
12362
            std::string s = ia->read(start_pos, chars_read - start_pos);
12363

N
Niels Lohmann 已提交
12364
            // escape control characters
12365
            std::string result;
N
Niels Lohmann 已提交
12366 12367 12368
            for (auto c : s)
            {
                if (c == '\0' or c == std::char_traits<char>::eof())
T
Théo DELRIEU 已提交
12369
                {
N
Niels Lohmann 已提交
12370
                    // ignore EOF
N
Niels Lohmann 已提交
12371
                    continue;
T
Théo DELRIEU 已提交
12372
                }
N
Niels Lohmann 已提交
12373
                else if ('\x00' <= c and c <= '\x1f')
A
Alex Astashyn 已提交
12374
                {
N
Niels Lohmann 已提交
12375
                    // escape control characters
12376
                    result += "<" + codepoint_to_string(c) + ">";
N
Niels Lohmann 已提交
12377 12378 12379
                }
                else
                {
N
Niels Lohmann 已提交
12380
                    // add character as is
12381
                    result.append(1, c);
N
Niels 已提交
12382
                }
12383
            }
N
Niels 已提交
12384

12385
            return result;
N
Niels Lohmann 已提交
12386
        }
12387

N
Niels Lohmann 已提交
12388
        /// return syntax error message
N
Niels Lohmann 已提交
12389
        const std::string& get_error_message() const noexcept
N
Niels Lohmann 已提交
12390 12391 12392
        {
            return error_message;
        }
12393

N
Niels Lohmann 已提交
12394 12395 12396 12397
        /////////////////////
        // actual scanner
        /////////////////////

N
Niels Lohmann 已提交
12398
        token_type scan()
12399
        {
N
Niels Lohmann 已提交
12400 12401 12402 12403 12404 12405 12406 12407 12408 12409 12410 12411 12412 12413 12414 12415 12416 12417 12418 12419 12420 12421 12422 12423 12424 12425 12426 12427 12428 12429 12430 12431 12432 12433 12434 12435 12436 12437 12438 12439 12440 12441 12442 12443 12444 12445 12446 12447 12448
            // read next character and ignore whitespace
            do
            {
                get();
            }
            while (current == ' ' or current == '\t' or current == '\n' or current == '\r');

            switch (current)
            {
                // structural characters
                case '[':
                    return token_type::begin_array;
                case ']':
                    return token_type::end_array;
                case '{':
                    return token_type::begin_object;
                case '}':
                    return token_type::end_object;
                case ':':
                    return token_type::name_separator;
                case ',':
                    return token_type::value_separator;

                // literals
                case 't':
                    return scan_true();
                case 'f':
                    return scan_false();
                case 'n':
                    return scan_null();

                // string
                case '\"':
                    return scan_string();

                // number
                case '-':
                case '0':
                case '1':
                case '2':
                case '3':
                case '4':
                case '5':
                case '6':
                case '7':
                case '8':
                case '9':
                    return scan_number();

12449 12450
                // end of input (the null byte is needed when parsing from
                // string literals)
N
Niels Lohmann 已提交
12451 12452 12453 12454 12455 12456 12457 12458 12459
                case '\0':
                case std::char_traits<char>::eof():
                    return token_type::end_of_input;

                // error
                default:
                    error_message = "invalid literal";
                    return token_type::parse_error;
            }
12460 12461
        }

T
Théo DELRIEU 已提交
12462
      private:
N
Niels Lohmann 已提交
12463
        /// input adapter
N
Niels Lohmann 已提交
12464
        input_adapter_t ia = nullptr;
N
Niels Lohmann 已提交
12465 12466 12467 12468 12469 12470 12471 12472 12473 12474 12475 12476 12477 12478 12479 12480 12481 12482 12483 12484 12485

        /// the current character
        int current = std::char_traits<char>::eof();

        /// whether get() should return the last character again
        bool next_unget = false;

        /// the number of characters read
        size_t chars_read = 0;
        /// the start position of the current token
        size_t start_pos = 0;

        /// buffer for variable-length tokens (numbers, strings)
        std::vector<char> yytext = std::vector<char>(1024, '\0');
        /// current index in yytext
        size_t yylen = 0;

        /// a description of occurred lexer errors
        std::string error_message = "";

        // number values
12486 12487 12488
        number_integer_t value_integer = 0;
        number_unsigned_t value_unsigned = 0;
        number_float_t value_float = 0;
12489

N
Niels Lohmann 已提交
12490
        /// the decimal point
N
Niels Lohmann 已提交
12491
        const char decimal_point_char = '.';
T
Théo DELRIEU 已提交
12492
    };
N
Niels 已提交
12493

N
Niels 已提交
12494 12495
    /*!
    @brief syntax analysis
N
Niels 已提交
12496 12497

    This class implements a recursive decent parser.
N
Niels 已提交
12498
    */
N
Niels 已提交
12499 12500
    class parser
    {
T
Théo DELRIEU 已提交
12501
      public:
12502
        /// a parser reading from an input adapter
N
Niels Lohmann 已提交
12503
        explicit parser(input_adapter_t adapter,
12504
                        const parser_callback_t cb = nullptr)
N
Niels Lohmann 已提交
12505
            : callback(cb), m_lexer(adapter)
T
Théo DELRIEU 已提交
12506
        {}
N
cleanup  
Niels 已提交
12507

N
Niels Lohmann 已提交
12508 12509
        /*!
        @brief public parser interface
12510 12511

        @param[in] strict  whether to expect the last token to be EOF
12512
        @return parsed JSON value
12513

N
Niels Lohmann 已提交
12514 12515 12516 12517
        @throw parse_error.101 in case of an unexpected token
        @throw parse_error.102 if to_unicode fails or surrogate error
        @throw parse_error.103 if to_unicode fails
        */
12518
        basic_json parse(const bool strict = true)
T
Théo DELRIEU 已提交
12519 12520 12521
        {
            // read first token
            get_token();
N
Niels 已提交
12522

T
Théo DELRIEU 已提交
12523 12524
            basic_json result = parse_internal(true);
            result.assert_invariant();
N
Niels 已提交
12525

12526 12527
            if (strict)
            {
N
Niels Lohmann 已提交
12528
                get_token();
12529 12530
                expect(lexer::token_type::end_of_input);
            }
N
Niels 已提交
12531

T
Théo DELRIEU 已提交
12532 12533 12534 12535
            // 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 已提交
12536

12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547 12548 12549 12550 12551 12552
        /*!
        @brief public accept interface

        @param[in] strict  whether to expect the last token to be EOF
        @return whether the input is a proper JSON text
        */
        bool accept(const bool strict = true)
        {
            // read first token
            get_token();

            if (not accept_internal())
            {
                return false;
            }

12553
            if (strict and get_token() != lexer::token_type::end_of_input)
12554 12555 12556 12557 12558 12559 12560
            {
                return false;
            }

            return true;
        }

T
Théo DELRIEU 已提交
12561
      private:
N
Niels Lohmann 已提交
12562 12563 12564 12565 12566 12567
        /*!
        @brief the actual parser
        @throw parse_error.101 in case of an unexpected token
        @throw parse_error.102 if to_unicode fails or surrogate error
        @throw parse_error.103 if to_unicode fails
        */
T
Théo DELRIEU 已提交
12568
        basic_json parse_internal(bool keep)
12569
        {
T
Théo DELRIEU 已提交
12570 12571 12572
            auto result = basic_json(value_t::discarded);

            switch (last_token)
N
Niels 已提交
12573
            {
T
Théo DELRIEU 已提交
12574
                case lexer::token_type::begin_object:
N
Niels 已提交
12575
                {
T
Théo DELRIEU 已提交
12576 12577 12578 12579 12580 12581 12582
                    if (keep and (not callback
                                  or ((keep = callback(depth++, parse_event_t::object_start, result)) != 0)))
                    {
                        // explicitly set result to object to cope with {}
                        result.m_type = value_t::object;
                        result.m_value = value_t::object;
                    }
N
Niels 已提交
12583

T
Théo DELRIEU 已提交
12584 12585
                    // read next token
                    get_token();
N
Niels 已提交
12586

T
Théo DELRIEU 已提交
12587 12588 12589 12590 12591 12592 12593 12594 12595 12596
                    // closing } -> we are done
                    if (last_token == lexer::token_type::end_object)
                    {
                        if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
                        {
                            result = basic_json(value_t::discarded);
                        }
                        return result;
                    }

12597 12598
                    // parse values
                    while (true)
T
Théo DELRIEU 已提交
12599 12600 12601 12602 12603 12604 12605 12606 12607 12608 12609 12610 12611 12612 12613 12614 12615 12616 12617 12618 12619 12620 12621 12622 12623 12624 12625 12626 12627 12628
                    {
                        // store key
                        expect(lexer::token_type::value_string);
                        const auto key = m_lexer.get_string();

                        bool keep_tag = false;
                        if (keep)
                        {
                            if (callback)
                            {
                                basic_json k(key);
                                keep_tag = callback(depth, parse_event_t::key, k);
                            }
                            else
                            {
                                keep_tag = true;
                            }
                        }

                        // parse separator (:)
                        get_token();
                        expect(lexer::token_type::name_separator);

                        // parse and add value
                        get_token();
                        auto value = parse_internal(keep);
                        if (keep and keep_tag and not value.is_discarded())
                        {
                            result[key] = std::move(value);
                        }
12629 12630

                        // comma -> next value
N
Niels Lohmann 已提交
12631
                        get_token();
12632 12633 12634 12635 12636 12637 12638 12639 12640
                        if (last_token == lexer::token_type::value_separator)
                        {
                            get_token();
                            continue;
                        }

                        // closing }
                        expect(lexer::token_type::end_object);
                        break;
T
Théo DELRIEU 已提交
12641 12642
                    }

N
Niels 已提交
12643
                    if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
N
Niels 已提交
12644 12645 12646
                    {
                        result = basic_json(value_t::discarded);
                    }
T
Théo DELRIEU 已提交
12647

N
Niels 已提交
12648
                    return result;
N
Niels 已提交
12649 12650
                }

T
Théo DELRIEU 已提交
12651
                case lexer::token_type::begin_array:
12652
                {
T
Théo DELRIEU 已提交
12653 12654 12655 12656 12657 12658 12659 12660 12661 12662 12663 12664 12665
                    if (keep and (not callback
                                  or ((keep = callback(depth++, parse_event_t::array_start, result)) != 0)))
                    {
                        // explicitly set result to object to cope with []
                        result.m_type = value_t::array;
                        result.m_value = value_t::array;
                    }

                    // read next token
                    get_token();

                    // closing ] -> we are done
                    if (last_token == lexer::token_type::end_array)
N
Niels 已提交
12666
                    {
T
Théo DELRIEU 已提交
12667 12668 12669 12670 12671
                        if (callback and not callback(--depth, parse_event_t::array_end, result))
                        {
                            result = basic_json(value_t::discarded);
                        }
                        return result;
N
Niels 已提交
12672 12673
                    }

12674 12675
                    // parse values
                    while (true)
N
Niels 已提交
12676
                    {
T
Théo DELRIEU 已提交
12677 12678 12679
                        // parse value
                        auto value = parse_internal(keep);
                        if (keep and not value.is_discarded())
N
Niels 已提交
12680
                        {
T
Théo DELRIEU 已提交
12681
                            result.push_back(std::move(value));
N
Niels 已提交
12682
                        }
12683 12684

                        // comma -> next value
N
Niels Lohmann 已提交
12685
                        get_token();
12686 12687 12688 12689 12690 12691 12692 12693 12694
                        if (last_token == lexer::token_type::value_separator)
                        {
                            get_token();
                            continue;
                        }

                        // closing ]
                        expect(lexer::token_type::end_array);
                        break;
N
Niels 已提交
12695 12696
                    }

T
Théo DELRIEU 已提交
12697
                    if (keep and callback and not callback(--depth, parse_event_t::array_end, result))
N
Niels 已提交
12698
                    {
T
Théo DELRIEU 已提交
12699
                        result = basic_json(value_t::discarded);
N
Niels 已提交
12700
                    }
T
Théo DELRIEU 已提交
12701 12702

                    return result;
N
Niels 已提交
12703 12704
                }

T
Théo DELRIEU 已提交
12705
                case lexer::token_type::literal_null:
N
Niels 已提交
12706
                {
T
Théo DELRIEU 已提交
12707 12708
                    result.m_type = value_t::null;
                    break;
N
Niels 已提交
12709 12710
                }

T
Théo DELRIEU 已提交
12711
                case lexer::token_type::value_string:
N
Niels 已提交
12712
                {
N
Niels Lohmann 已提交
12713
                    result = basic_json(m_lexer.get_string());
T
Théo DELRIEU 已提交
12714
                    break;
N
Niels 已提交
12715 12716
                }

T
Théo DELRIEU 已提交
12717
                case lexer::token_type::literal_true:
N
Niels 已提交
12718
                {
T
Théo DELRIEU 已提交
12719 12720 12721
                    result.m_type = value_t::boolean;
                    result.m_value = true;
                    break;
N
Niels 已提交
12722 12723
                }

T
Théo DELRIEU 已提交
12724
                case lexer::token_type::literal_false:
N
Niels 已提交
12725
                {
T
Théo DELRIEU 已提交
12726 12727 12728
                    result.m_type = value_t::boolean;
                    result.m_value = false;
                    break;
N
Niels 已提交
12729 12730
                }

N
Niels Lohmann 已提交
12731
                case lexer::token_type::value_unsigned:
N
Niels Lohmann 已提交
12732 12733 12734 12735 12736 12737
                {
                    result.m_type = value_t::number_unsigned;
                    result.m_value = m_lexer.get_number_unsigned();
                    break;
                }

N
Niels Lohmann 已提交
12738
                case lexer::token_type::value_integer:
N
Niels Lohmann 已提交
12739 12740 12741 12742 12743 12744
                {
                    result.m_type = value_t::number_integer;
                    result.m_value = m_lexer.get_number_integer();
                    break;
                }

12745
                case lexer::token_type::value_float:
N
Niels 已提交
12746
                {
N
Niels Lohmann 已提交
12747 12748 12749 12750 12751 12752 12753 12754 12755
                    result.m_type = value_t::number_float;
                    result.m_value = m_lexer.get_number_float();

                    // throw in case of infinity or NAN
                    if (JSON_UNLIKELY(not std::isfinite(result.m_value.number_float)))
                    {
                        JSON_THROW(out_of_range::create(406, "number overflow parsing '" + m_lexer.get_token_string() + "'"));
                    }

T
Théo DELRIEU 已提交
12756
                    break;
N
Niels 已提交
12757
                }
12758

T
Théo DELRIEU 已提交
12759 12760 12761 12762 12763
                default:
                {
                    // the last token was unexpected
                    unexpect(last_token);
                }
12764 12765
            }

T
Théo DELRIEU 已提交
12766
            if (keep and callback and not callback(depth, parse_event_t::value, result))
12767
            {
T
Théo DELRIEU 已提交
12768
                result = basic_json(value_t::discarded);
N
Niels 已提交
12769
            }
T
Théo DELRIEU 已提交
12770
            return result;
N
Niels 已提交
12771 12772
        }

12773 12774
        /*!
        @brief the acutal acceptor
12775 12776 12777 12778 12779 12780 12781 12782

        @invariant 1. The last token is not yet processed. Therefore, the
                      caller of this function must make sure a token has
                      been read.
                   2. When this function returns, the last token is processed.
                      That is, the last read character was already considered.

        This invariant makes sure that no token needs to be "unput".
12783 12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794 12795 12796 12797 12798 12799 12800 12801 12802 12803 12804 12805 12806 12807 12808 12809 12810 12811 12812 12813 12814 12815 12816 12817 12818 12819 12820 12821 12822
        */
        bool accept_internal()
        {
            switch (last_token)
            {
                case lexer::token_type::begin_object:
                {
                    // read next token
                    get_token();

                    // closing } -> we are done
                    if (last_token == lexer::token_type::end_object)
                    {
                        return true;
                    }

                    // parse values
                    while (true)
                    {
                        // parse key
                        if (last_token != lexer::token_type::value_string)
                        {
                            return false;
                        }

                        // parse separator (:)
                        get_token();
                        if (last_token != lexer::token_type::name_separator)
                        {
                            return false;
                        }

                        // parse value
                        get_token();
                        if (not accept_internal())
                        {
                            return false;
                        }

                        // comma -> next value
12823
                        get_token();
12824 12825 12826 12827 12828 12829 12830 12831 12832 12833 12834 12835 12836 12837 12838 12839 12840 12841 12842 12843 12844 12845 12846 12847 12848 12849 12850 12851 12852 12853 12854 12855 12856 12857 12858 12859 12860
                        if (last_token == lexer::token_type::value_separator)
                        {
                            get_token();
                            continue;
                        }

                        // closing }
                        if (last_token != lexer::token_type::end_object)
                        {
                            return false;
                        }

                        return true;
                    }
                }

                case lexer::token_type::begin_array:
                {
                    // read next token
                    get_token();

                    // closing ] -> we are done
                    if (last_token == lexer::token_type::end_array)
                    {
                        return true;
                    }

                    // parse values
                    while (true)
                    {
                        // parse value
                        if (not accept_internal())
                        {
                            return false;
                        }

                        // comma -> next value
12861
                        get_token();
12862 12863 12864 12865 12866 12867 12868 12869 12870 12871 12872 12873 12874 12875 12876 12877
                        if (last_token == lexer::token_type::value_separator)
                        {
                            get_token();
                            continue;
                        }

                        // closing ]
                        if (last_token != lexer::token_type::end_array)
                        {
                            return false;
                        }

                        return true;
                    }
                }

12878
                case lexer::token_type::literal_false:
12879 12880 12881
                case lexer::token_type::literal_null:
                case lexer::token_type::literal_true:
                case lexer::token_type::value_float:
12882 12883 12884
                case lexer::token_type::value_integer:
                case lexer::token_type::value_string:
                case lexer::token_type::value_unsigned:
12885 12886 12887 12888 12889 12890 12891 12892 12893 12894 12895 12896
                {
                    return true;
                }

                default:
                {
                    // the last token was unexpected
                    return false;
                }
            }
        }

T
Théo DELRIEU 已提交
12897 12898
        /// get next token from lexer
        typename lexer::token_type get_token()
N
Niels 已提交
12899
        {
T
Théo DELRIEU 已提交
12900 12901
            last_token = m_lexer.scan();
            return last_token;
N
Niels 已提交
12902 12903
        }

N
Niels Lohmann 已提交
12904 12905 12906
        /*!
        @throw parse_error.101 if expected token did not occur
        */
T
Théo DELRIEU 已提交
12907
        void expect(typename lexer::token_type t) const
N
Niels 已提交
12908
        {
12909
            if (JSON_UNLIKELY(t != last_token))
T
Théo DELRIEU 已提交
12910
            {
N
Niels Lohmann 已提交
12911 12912 12913 12914 12915 12916 12917
                std::string error_msg = "syntax error - ";
                if (last_token == lexer::token_type::parse_error)
                {
                    error_msg += m_lexer.get_error_message() + "; last read: '" + m_lexer.get_token_string() + "'";
                }
                else
                {
N
Niels Lohmann 已提交
12918
                    error_msg += "unexpected " + std::string(lexer::token_type_name(last_token));
N
Niels Lohmann 已提交
12919 12920
                }

N
Niels Lohmann 已提交
12921
                error_msg += "; expected " + std::string(lexer::token_type_name(t));
12922
                JSON_THROW(parse_error::create(101, m_lexer.get_position(), error_msg));
T
Théo DELRIEU 已提交
12923
            }
N
Niels 已提交
12924 12925
        }

N
Niels Lohmann 已提交
12926 12927 12928
        /*!
        @throw parse_error.101 if unexpected token occurred
        */
T
Théo DELRIEU 已提交
12929
        void unexpect(typename lexer::token_type t) const
N
Niels 已提交
12930
        {
12931
            if (JSON_UNLIKELY(t == last_token))
T
Théo DELRIEU 已提交
12932
            {
N
Niels Lohmann 已提交
12933 12934 12935 12936 12937 12938 12939
                std::string error_msg = "syntax error - ";
                if (last_token == lexer::token_type::parse_error)
                {
                    error_msg += m_lexer.get_error_message() + "; last read '" + m_lexer.get_token_string() + "'";
                }
                else
                {
N
Niels Lohmann 已提交
12940
                    error_msg += "unexpected " + std::string(lexer::token_type_name(last_token));
N
Niels Lohmann 已提交
12941 12942
                }

12943
                JSON_THROW(parse_error::create(101, m_lexer.get_position(), error_msg));
T
Théo DELRIEU 已提交
12944
            }
N
Niels 已提交
12945 12946
        }

T
Théo DELRIEU 已提交
12947 12948 12949 12950 12951 12952 12953 12954 12955 12956
      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 已提交
12957 12958

  public:
N
Niels 已提交
12959 12960 12961
    /*!
    @brief JSON Pointer

N
Niels 已提交
12962 12963 12964 12965
    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 已提交
12966
    @sa [RFC 6901](https://tools.ietf.org/html/rfc6901)
N
Niels 已提交
12967 12968

    @since version 2.0.0
N
Niels 已提交
12969
    */
N
Niels 已提交
12970 12971
    class json_pointer
    {
N
Niels 已提交
12972 12973 12974
        /// allow basic_json to access private members
        friend class basic_json;

T
Théo DELRIEU 已提交
12975
      public:
N
Niels 已提交
12976 12977 12978 12979 12980 12981 12982 12983 12984 12985
        /*!
        @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 Lohmann 已提交
12986 12987 12988 12989 12990 12991
        @throw parse_error.107 if the given JSON pointer @a s is nonempty and
        does not begin with a slash (`/`); see example below

        @throw parse_error.108 if a tilde (`~`) in the given JSON pointer @a s
        is not followed by `0` (representing `~`) or `1` (representing `/`);
        see example below
N
Niels 已提交
12992 12993 12994

        @liveexample{The example shows the construction several valid JSON
        pointers as well as the exceptional behavior.,json_pointer}
N
Niels 已提交
12995

N
Niels 已提交
12996 12997 12998
        @since version 2.0.0
        */
        explicit json_pointer(const std::string& s = "")
T
Théo DELRIEU 已提交
12999 13000
            : reference_tokens(split(s))
        {}
N
Niels 已提交
13001

T
Théo DELRIEU 已提交
13002 13003
        /*!
        @brief return a string representation of the JSON pointer
N
Niels 已提交
13004

T
Théo DELRIEU 已提交
13005 13006 13007 13008
        @invariant For each JSON pointer `ptr`, it holds:
        @code {.cpp}
        ptr == json_pointer(ptr.to_string());
        @endcode
N
Niels 已提交
13009

T
Théo DELRIEU 已提交
13010
        @return a string representation of the JSON pointer
N
Niels 已提交
13011

T
Théo DELRIEU 已提交
13012 13013
        @liveexample{The example shows the result of `to_string`.,
        json_pointer__to_string}
N
Niels 已提交
13014

T
Théo DELRIEU 已提交
13015 13016 13017
        @since version 2.0.0
        */
        std::string to_string() const noexcept
N
Niels 已提交
13018
        {
T
Théo DELRIEU 已提交
13019 13020 13021 13022 13023 13024 13025
            return std::accumulate(reference_tokens.begin(),
                                   reference_tokens.end(), std::string{},
                                   [](const std::string & a, const std::string & b)
            {
                return a + "/" + escape(b);
            });
        }
N
Niels 已提交
13026

T
Théo DELRIEU 已提交
13027 13028
        /// @copydoc to_string()
        operator std::string() const
N
Niels 已提交
13029
        {
T
Théo DELRIEU 已提交
13030
            return to_string();
N
Niels 已提交
13031 13032
        }

T
Théo DELRIEU 已提交
13033
      private:
N
Niels Lohmann 已提交
13034 13035 13036 13037
        /*!
        @brief remove and return last reference pointer
        @throw out_of_range.405 if JSON pointer has no parent
        */
T
Théo DELRIEU 已提交
13038 13039 13040 13041
        std::string pop_back()
        {
            if (is_root())
            {
13042
                JSON_THROW(out_of_range::create(405, "JSON pointer has no parent"));
T
Théo DELRIEU 已提交
13043
            }
13044

T
Théo DELRIEU 已提交
13045 13046 13047 13048
            auto last = reference_tokens.back();
            reference_tokens.pop_back();
            return last;
        }
N
Niels 已提交
13049

T
Théo DELRIEU 已提交
13050 13051
        /// return whether pointer points to the root document
        bool is_root() const
N
Niels 已提交
13052
        {
T
Théo DELRIEU 已提交
13053
            return reference_tokens.empty();
N
Niels 已提交
13054 13055
        }

T
Théo DELRIEU 已提交
13056 13057 13058 13059
        json_pointer top() const
        {
            if (is_root())
            {
13060
                JSON_THROW(out_of_range::create(405, "JSON pointer has no parent"));
T
Théo DELRIEU 已提交
13061
            }
N
Niels 已提交
13062

T
Théo DELRIEU 已提交
13063 13064 13065 13066
            json_pointer result = *this;
            result.reference_tokens = {reference_tokens[0]};
            return result;
        }
N
Niels 已提交
13067

T
Théo DELRIEU 已提交
13068 13069
        /*!
        @brief create and return a reference to the pointed to value
13070

T
Théo DELRIEU 已提交
13071
        @complexity Linear in the number of reference tokens.
N
Niels Lohmann 已提交
13072 13073 13074

        @throw parse_error.109 if array index is not a number
        @throw type_error.313 if value cannot be unflattened
T
Théo DELRIEU 已提交
13075 13076
        */
        reference get_and_create(reference j) const
13077
        {
T
Théo DELRIEU 已提交
13078 13079 13080 13081 13082
            pointer result = &j;

            // in case no reference tokens exist, return a reference to the
            // JSON value j which will be overwritten by a primitive value
            for (const auto& reference_token : reference_tokens)
N
Niels 已提交
13083
            {
T
Théo DELRIEU 已提交
13084
                switch (result->m_type)
N
Niels 已提交
13085
                {
T
Théo DELRIEU 已提交
13086
                    case value_t::null:
N
Niels 已提交
13087
                    {
T
Théo DELRIEU 已提交
13088 13089 13090 13091 13092 13093 13094 13095 13096 13097 13098
                        if (reference_token == "0")
                        {
                            // start a new array if reference token is 0
                            result = &result->operator[](0);
                        }
                        else
                        {
                            // start a new object otherwise
                            result = &result->operator[](reference_token);
                        }
                        break;
N
Niels 已提交
13099
                    }
T
Théo DELRIEU 已提交
13100 13101

                    case value_t::object:
N
Niels 已提交
13102
                    {
T
Théo DELRIEU 已提交
13103
                        // create an entry in the object
N
Niels 已提交
13104
                        result = &result->operator[](reference_token);
T
Théo DELRIEU 已提交
13105
                        break;
N
Niels 已提交
13106
                    }
N
Niels 已提交
13107

T
Théo DELRIEU 已提交
13108 13109 13110
                    case value_t::array:
                    {
                        // create an entry in the array
13111 13112 13113 13114
                        JSON_TRY
                        {
                            result = &result->operator[](static_cast<size_type>(std::stoi(reference_token)));
                        }
N
Niels Lohmann 已提交
13115
                        JSON_CATCH (std::invalid_argument&)
13116
                        {
13117
                            JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number"));
13118
                        }
T
Théo DELRIEU 已提交
13119 13120
                        break;
                    }
13121

T
Théo DELRIEU 已提交
13122 13123 13124 13125 13126 13127 13128 13129 13130
                    /*
                    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:
                    {
13131
                        JSON_THROW(type_error::create(313, "invalid value to unflatten"));
T
Théo DELRIEU 已提交
13132
                    }
N
Niels 已提交
13133 13134
                }
            }
13135

T
Théo DELRIEU 已提交
13136 13137
            return *result;
        }
13138

T
Théo DELRIEU 已提交
13139 13140
        /*!
        @brief return a reference to the pointed to value
13141

T
Théo DELRIEU 已提交
13142 13143 13144 13145 13146
        @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 已提交
13147

T
Théo DELRIEU 已提交
13148
        @param[in] ptr  a JSON value
N
Niels 已提交
13149

T
Théo DELRIEU 已提交
13150
        @return reference to the JSON value pointed to by the JSON pointer
N
Niels 已提交
13151

T
Théo DELRIEU 已提交
13152
        @complexity Linear in the length of the JSON pointer.
13153

N
Niels Lohmann 已提交
13154 13155 13156
        @throw parse_error.106   if an array index begins with '0'
        @throw parse_error.109   if an array index was not a number
        @throw out_of_range.404  if the JSON pointer can not be resolved
T
Théo DELRIEU 已提交
13157 13158
        */
        reference get_unchecked(pointer ptr) const
13159
        {
T
Théo DELRIEU 已提交
13160
            for (const auto& reference_token : reference_tokens)
13161
            {
T
Théo DELRIEU 已提交
13162 13163
                // convert null values to arrays or objects before continuing
                if (ptr->m_type == value_t::null)
13164
                {
T
Théo DELRIEU 已提交
13165 13166 13167 13168
                    // check if reference token is a number
                    const bool nums = std::all_of(reference_token.begin(),
                                                  reference_token.end(),
                                                  [](const char x)
N
Niels 已提交
13169
                    {
13170
                        return (x >= '0' and x <= '9');
T
Théo DELRIEU 已提交
13171
                    });
N
Niels 已提交
13172

T
Théo DELRIEU 已提交
13173 13174 13175
                    // change value to array for numbers or "-" or to object
                    // otherwise
                    if (nums or reference_token == "-")
N
Niels 已提交
13176
                    {
T
Théo DELRIEU 已提交
13177
                        *ptr = value_t::array;
N
Niels 已提交
13178 13179 13180
                    }
                    else
                    {
T
Théo DELRIEU 已提交
13181
                        *ptr = value_t::object;
N
Niels 已提交
13182
                    }
N
Niels 已提交
13183 13184
                }

T
Théo DELRIEU 已提交
13185
                switch (ptr->m_type)
N
Niels 已提交
13186
                {
T
Théo DELRIEU 已提交
13187 13188 13189 13190 13191 13192 13193 13194 13195 13196 13197 13198
                    case value_t::object:
                    {
                        // use unchecked object access
                        ptr = &ptr->operator[](reference_token);
                        break;
                    }

                    case value_t::array:
                    {
                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
13199
                            JSON_THROW(parse_error::create(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
13200 13201 13202 13203
                        }

                        if (reference_token == "-")
                        {
N
Niels Lohmann 已提交
13204
                            // explicitly treat "-" as index beyond the end
T
Théo DELRIEU 已提交
13205 13206 13207 13208 13209
                            ptr = &ptr->operator[](ptr->m_value.array->size());
                        }
                        else
                        {
                            // convert array index to number; unchecked access
13210 13211 13212 13213
                            JSON_TRY
                            {
                                ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
                            }
N
Niels Lohmann 已提交
13214
                            JSON_CATCH (std::invalid_argument&)
13215
                            {
13216
                                JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number"));
13217
                            }
T
Théo DELRIEU 已提交
13218 13219 13220 13221 13222 13223
                        }
                        break;
                    }

                    default:
                    {
13224
                        JSON_THROW(out_of_range::create(404, "unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
13225
                    }
N
Niels 已提交
13226 13227
                }
            }
N
Niels 已提交
13228

T
Théo DELRIEU 已提交
13229 13230
            return *ptr;
        }
13231

N
Niels Lohmann 已提交
13232 13233 13234 13235 13236 13237
        /*!
        @throw parse_error.106   if an array index begins with '0'
        @throw parse_error.109   if an array index was not a number
        @throw out_of_range.402  if the array index '-' is used
        @throw out_of_range.404  if the JSON pointer can not be resolved
        */
T
Théo DELRIEU 已提交
13238
        reference get_checked(pointer ptr) const
N
Niels 已提交
13239
        {
T
Théo DELRIEU 已提交
13240
            for (const auto& reference_token : reference_tokens)
N
Niels 已提交
13241
            {
T
Théo DELRIEU 已提交
13242
                switch (ptr->m_type)
13243
                {
T
Théo DELRIEU 已提交
13244
                    case value_t::object:
N
Niels 已提交
13245
                    {
T
Théo DELRIEU 已提交
13246 13247 13248
                        // note: at performs range check
                        ptr = &ptr->at(reference_token);
                        break;
N
Niels 已提交
13249 13250
                    }

T
Théo DELRIEU 已提交
13251
                    case value_t::array:
N
Niels 已提交
13252
                    {
T
Théo DELRIEU 已提交
13253 13254 13255
                        if (reference_token == "-")
                        {
                            // "-" always fails the range check
13256 13257 13258
                            JSON_THROW(out_of_range::create(402, "array index '-' (" +
                                                            std::to_string(ptr->m_value.array->size()) +
                                                            ") is out of range"));
T
Théo DELRIEU 已提交
13259 13260 13261 13262 13263
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
13264
                            JSON_THROW(parse_error::create(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
13265
                        }
N
Niels 已提交
13266

T
Théo DELRIEU 已提交
13267
                        // note: at performs range check
13268 13269 13270 13271
                        JSON_TRY
                        {
                            ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
                        }
N
Niels Lohmann 已提交
13272
                        JSON_CATCH (std::invalid_argument&)
13273
                        {
13274
                            JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number"));
13275
                        }
T
Théo DELRIEU 已提交
13276 13277
                        break;
                    }
13278

T
Théo DELRIEU 已提交
13279 13280
                    default:
                    {
13281
                        JSON_THROW(out_of_range::create(404, "unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
13282
                    }
N
Niels 已提交
13283 13284 13285
                }
            }

T
Théo DELRIEU 已提交
13286 13287
            return *ptr;
        }
N
Niels 已提交
13288

T
Théo DELRIEU 已提交
13289 13290
        /*!
        @brief return a const reference to the pointed to value
N
Niels 已提交
13291

T
Théo DELRIEU 已提交
13292
        @param[in] ptr  a JSON value
13293

T
Théo DELRIEU 已提交
13294 13295
        @return const reference to the JSON value pointed to by the JSON
                pointer
N
Niels Lohmann 已提交
13296 13297 13298 13299 13300

        @throw parse_error.106   if an array index begins with '0'
        @throw parse_error.109   if an array index was not a number
        @throw out_of_range.402  if the array index '-' is used
        @throw out_of_range.404  if the JSON pointer can not be resolved
T
Théo DELRIEU 已提交
13301 13302
        */
        const_reference get_unchecked(const_pointer ptr) const
N
Niels 已提交
13303
        {
T
Théo DELRIEU 已提交
13304
            for (const auto& reference_token : reference_tokens)
N
Niels 已提交
13305
            {
T
Théo DELRIEU 已提交
13306
                switch (ptr->m_type)
13307
                {
T
Théo DELRIEU 已提交
13308
                    case value_t::object:
N
Niels 已提交
13309
                    {
T
Théo DELRIEU 已提交
13310 13311 13312
                        // use unchecked object access
                        ptr = &ptr->operator[](reference_token);
                        break;
N
Niels 已提交
13313 13314
                    }

T
Théo DELRIEU 已提交
13315
                    case value_t::array:
N
Niels 已提交
13316
                    {
T
Théo DELRIEU 已提交
13317 13318 13319
                        if (reference_token == "-")
                        {
                            // "-" cannot be used for const access
13320 13321 13322
                            JSON_THROW(out_of_range::create(402, "array index '-' (" +
                                                            std::to_string(ptr->m_value.array->size()) +
                                                            ") is out of range"));
T
Théo DELRIEU 已提交
13323 13324 13325 13326 13327
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
13328
                            JSON_THROW(parse_error::create(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
13329
                        }
N
Niels 已提交
13330

T
Théo DELRIEU 已提交
13331
                        // use unchecked array access
13332 13333 13334 13335
                        JSON_TRY
                        {
                            ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
                        }
N
Niels Lohmann 已提交
13336
                        JSON_CATCH (std::invalid_argument&)
13337
                        {
13338
                            JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number"));
13339
                        }
T
Théo DELRIEU 已提交
13340 13341
                        break;
                    }
13342

T
Théo DELRIEU 已提交
13343 13344
                    default:
                    {
13345
                        JSON_THROW(out_of_range::create(404, "unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
13346
                    }
N
Niels 已提交
13347 13348 13349
                }
            }

T
Théo DELRIEU 已提交
13350 13351
            return *ptr;
        }
13352

N
Niels Lohmann 已提交
13353 13354 13355 13356 13357 13358
        /*!
        @throw parse_error.106   if an array index begins with '0'
        @throw parse_error.109   if an array index was not a number
        @throw out_of_range.402  if the array index '-' is used
        @throw out_of_range.404  if the JSON pointer can not be resolved
        */
T
Théo DELRIEU 已提交
13359
        const_reference get_checked(const_pointer ptr) const
13360
        {
T
Théo DELRIEU 已提交
13361
            for (const auto& reference_token : reference_tokens)
13362
            {
T
Théo DELRIEU 已提交
13363
                switch (ptr->m_type)
13364
                {
T
Théo DELRIEU 已提交
13365
                    case value_t::object:
N
Niels 已提交
13366
                    {
T
Théo DELRIEU 已提交
13367 13368 13369
                        // note: at performs range check
                        ptr = &ptr->at(reference_token);
                        break;
N
Niels 已提交
13370
                    }
13371

T
Théo DELRIEU 已提交
13372
                    case value_t::array:
N
Niels 已提交
13373
                    {
T
Théo DELRIEU 已提交
13374 13375 13376
                        if (reference_token == "-")
                        {
                            // "-" always fails the range check
13377 13378 13379
                            JSON_THROW(out_of_range::create(402, "array index '-' (" +
                                                            std::to_string(ptr->m_value.array->size()) +
                                                            ") is out of range"));
T
Théo DELRIEU 已提交
13380 13381 13382 13383 13384
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
13385
                            JSON_THROW(parse_error::create(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
13386
                        }
13387

T
Théo DELRIEU 已提交
13388
                        // note: at performs range check
13389 13390 13391 13392
                        JSON_TRY
                        {
                            ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
                        }
N
Niels Lohmann 已提交
13393
                        JSON_CATCH (std::invalid_argument&)
13394
                        {
13395
                            JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number"));
13396
                        }
T
Théo DELRIEU 已提交
13397 13398
                        break;
                    }
13399

T
Théo DELRIEU 已提交
13400 13401
                    default:
                    {
13402
                        JSON_THROW(out_of_range::create(404, "unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
13403
                    }
13404 13405
                }
            }
N
Niels 已提交
13406

T
Théo DELRIEU 已提交
13407
            return *ptr;
13408 13409
        }

N
Niels Lohmann 已提交
13410 13411 13412 13413 13414 13415 13416 13417 13418
        /*!
        @brief split the string input to reference tokens

        @note This function is only called by the json_pointer constructor.
              All exceptions below are documented there.

        @throw parse_error.107  if the pointer is not empty or begins with '/'
        @throw parse_error.108  if character '~' is not followed by '0' or '1'
        */
T
Théo DELRIEU 已提交
13419
        static std::vector<std::string> split(const std::string& reference_string)
13420
        {
T
Théo DELRIEU 已提交
13421 13422 13423 13424 13425 13426 13427 13428 13429 13430 13431
            std::vector<std::string> result;

            // special case: empty reference string -> no reference tokens
            if (reference_string.empty())
            {
                return result;
            }

            // check if nonempty reference string begins with slash
            if (reference_string[0] != '/')
            {
13432
                JSON_THROW(parse_error::create(107, 1, "JSON pointer must be empty or begin with '/' - was: '" + reference_string + "'"));
T
Théo DELRIEU 已提交
13433
            }
N
Niels 已提交
13434

T
Théo DELRIEU 已提交
13435 13436 13437 13438 13439
            // 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 已提交
13440
                size_t slash = reference_string.find_first_of('/', 1),
T
Théo DELRIEU 已提交
13441 13442 13443 13444 13445 13446 13447 13448
                // 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 已提交
13449
                slash = reference_string.find_first_of('/', start))
T
Théo DELRIEU 已提交
13450 13451 13452 13453
            {
                // 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 已提交
13454

T
Théo DELRIEU 已提交
13455
                // check reference tokens are properly escaped
N
Niels Lohmann 已提交
13456
                for (size_t pos = reference_token.find_first_of('~');
T
Théo DELRIEU 已提交
13457
                        pos != std::string::npos;
N
Niels Lohmann 已提交
13458
                        pos = reference_token.find_first_of('~', pos + 1))
13459
                {
T
Théo DELRIEU 已提交
13460 13461 13462 13463 13464 13465 13466
                    assert(reference_token[pos] == '~');

                    // ~ must be followed by 0 or 1
                    if (pos == reference_token.size() - 1 or
                            (reference_token[pos + 1] != '0' and
                             reference_token[pos + 1] != '1'))
                    {
13467
                        JSON_THROW(parse_error::create(108, 0, "escape character '~' must be followed with '0' or '1'"));
T
Théo DELRIEU 已提交
13468
                    }
N
Niels 已提交
13469
                }
T
Théo DELRIEU 已提交
13470 13471 13472 13473

                // finally, store the reference token
                unescape(reference_token);
                result.push_back(reference_token);
13474
            }
N
Niels 已提交
13475

T
Théo DELRIEU 已提交
13476
            return result;
N
Niels 已提交
13477
        }
N
Niels 已提交
13478

T
Théo DELRIEU 已提交
13479 13480
        /*!
        @brief replace all occurrences of a substring by another string
N
Niels 已提交
13481

T
Théo DELRIEU 已提交
13482 13483 13484 13485
        @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 已提交
13486

N
Niels Lohmann 已提交
13487 13488
        @pre The search string @a f must not be empty. **This precondition is
             enforced with an assertion.**
N
Niels 已提交
13489

T
Théo DELRIEU 已提交
13490 13491 13492 13493 13494 13495 13496
        @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 已提交
13497

T
Théo DELRIEU 已提交
13498 13499 13500 13501 13502 13503 13504
            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 已提交
13505

T
Théo DELRIEU 已提交
13506 13507 13508 13509 13510 13511 13512 13513
        /// 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 已提交
13514

T
Théo DELRIEU 已提交
13515 13516 13517 13518 13519 13520 13521 13522
        /// 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 已提交
13523

T
Théo DELRIEU 已提交
13524 13525 13526 13527
        /*!
        @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
13528

T
Théo DELRIEU 已提交
13529 13530 13531 13532 13533
        @note Empty objects or arrays are flattened to `null`.
        */
        static void flatten(const std::string& reference_string,
                            const basic_json& value,
                            basic_json& result)
N
Niels 已提交
13534
        {
T
Théo DELRIEU 已提交
13535
            switch (value.m_type)
N
Niels 已提交
13536
            {
T
Théo DELRIEU 已提交
13537
                case value_t::array:
13538
                {
T
Théo DELRIEU 已提交
13539 13540 13541 13542 13543 13544
                    if (value.m_value.array->empty())
                    {
                        // flatten empty array as null
                        result[reference_string] = nullptr;
                    }
                    else
N
Niels 已提交
13545
                    {
T
Théo DELRIEU 已提交
13546 13547 13548 13549 13550 13551
                        // iterate array and use index as reference string
                        for (size_t i = 0; i < value.m_value.array->size(); ++i)
                        {
                            flatten(reference_string + "/" + std::to_string(i),
                                    value.m_value.array->operator[](i), result);
                        }
N
Niels 已提交
13552
                    }
T
Théo DELRIEU 已提交
13553
                    break;
N
Niels 已提交
13554 13555
                }

T
Théo DELRIEU 已提交
13556
                case value_t::object:
13557
                {
T
Théo DELRIEU 已提交
13558 13559 13560 13561 13562 13563
                    if (value.m_value.object->empty())
                    {
                        // flatten empty object as null
                        result[reference_string] = nullptr;
                    }
                    else
N
Niels 已提交
13564
                    {
T
Théo DELRIEU 已提交
13565 13566 13567 13568 13569 13570
                        // iterate object and use keys as reference string
                        for (const auto& element : *value.m_value.object)
                        {
                            flatten(reference_string + "/" + escape(element.first),
                                    element.second, result);
                        }
N
Niels 已提交
13571
                    }
T
Théo DELRIEU 已提交
13572
                    break;
N
Niels 已提交
13573 13574
                }

T
Théo DELRIEU 已提交
13575 13576 13577 13578 13579 13580
                default:
                {
                    // add primitive value with its reference string
                    result[reference_string] = value;
                    break;
                }
N
Niels 已提交
13581 13582
            }
        }
N
Niels 已提交
13583

T
Théo DELRIEU 已提交
13584 13585
        /*!
        @param[in] value  flattened JSON
N
Niels 已提交
13586

T
Théo DELRIEU 已提交
13587
        @return unflattened JSON
N
Niels Lohmann 已提交
13588 13589 13590 13591 13592

        @throw parse_error.109 if array index is not a number
        @throw type_error.314  if value is not an object
        @throw type_error.315  if object values are not primitive
        @throw type_error.313  if value cannot be unflattened
T
Théo DELRIEU 已提交
13593 13594
        */
        static basic_json unflatten(const basic_json& value)
N
Niels 已提交
13595
        {
T
Théo DELRIEU 已提交
13596 13597
            if (not value.is_object())
            {
13598
                JSON_THROW(type_error::create(314, "only objects can be unflattened"));
T
Théo DELRIEU 已提交
13599
            }
N
Niels 已提交
13600

T
Théo DELRIEU 已提交
13601
            basic_json result;
N
Niels 已提交
13602

T
Théo DELRIEU 已提交
13603 13604
            // iterate the JSON object values
            for (const auto& element : *value.m_value.object)
N
Niels 已提交
13605
            {
T
Théo DELRIEU 已提交
13606 13607
                if (not element.second.is_primitive())
                {
13608
                    JSON_THROW(type_error::create(315, "values in object must be primitive"));
T
Théo DELRIEU 已提交
13609 13610 13611 13612 13613 13614 13615 13616
                }

                // 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 已提交
13617 13618
            }

T
Théo DELRIEU 已提交
13619
            return result;
N
Niels 已提交
13620
        }
N
Niels 已提交
13621

T
Théo DELRIEU 已提交
13622 13623 13624 13625 13626
        friend bool operator==(json_pointer const& lhs,
                               json_pointer const& rhs) noexcept
        {
            return lhs.reference_tokens == rhs.reference_tokens;
        }
13627

T
Théo DELRIEU 已提交
13628 13629 13630 13631 13632
        friend bool operator!=(json_pointer const& lhs,
                               json_pointer const& rhs) noexcept
        {
            return !(lhs == rhs);
        }
13633

T
Théo DELRIEU 已提交
13634 13635
        /// the reference tokens
        std::vector<std::string> reference_tokens {};
13636
    };
N
Niels 已提交
13637

N
Niels 已提交
13638 13639 13640
    //////////////////////////
    // JSON Pointer support //
    //////////////////////////
N
Niels 已提交
13641 13642 13643 13644

    /// @name JSON Pointer functions
    /// @{

N
Niels 已提交
13645 13646 13647 13648
    /*!
    @brief access specified element via JSON Pointer

    Uses a JSON pointer to retrieve a reference to the respective JSON value.
N
Niels 已提交
13649 13650 13651
    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 已提交
13652 13653 13654 13655 13656 13657 13658 13659 13660 13661 13662 13663 13664 13665 13666 13667 13668 13669

    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.

N
Niels Lohmann 已提交
13670 13671 13672
    @throw parse_error.106   if an array index begins with '0'
    @throw parse_error.109   if an array index was not a number
    @throw out_of_range.404  if the JSON pointer can not be resolved
N
Niels 已提交
13673 13674 13675 13676 13677 13678 13679 13680 13681 13682 13683 13684 13685 13686 13687 13688 13689 13690 13691 13692 13693 13694 13695 13696

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

N
Niels Lohmann 已提交
13697 13698 13699 13700
    @throw parse_error.106   if an array index begins with '0'
    @throw parse_error.109   if an array index was not a number
    @throw out_of_range.402  if the array index '-' is used
    @throw out_of_range.404  if the JSON pointer can not be resolved
N
Niels 已提交
13701 13702 13703 13704 13705 13706 13707 13708 13709 13710 13711 13712 13713 13714 13715 13716 13717 13718 13719 13720

    @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

13721
    @throw parse_error.106 if an array index in the passed JSON pointer @a ptr
13722
    begins with '0'. See example below.
N
Niels 已提交
13723

13724
    @throw parse_error.109 if an array index in the passed JSON pointer @a ptr
13725
    is not a number. See example below.
N
Niels 已提交
13726

13727 13728 13729 13730
    @throw out_of_range.401 if an array index in the passed JSON pointer @a ptr
    is out of range. See example below.

    @throw out_of_range.402 if the array index '-' is used in the passed JSON
13731
    pointer @a ptr. As `at` provides checked access (and no elements are
13732 13733 13734 13735
    implicitly inserted), the index '-' is always invalid. See example below.

    @throw out_of_range.404 if the JSON pointer @a ptr can not be resolved.
    See example below.
13736

13737 13738
    @exceptionsafety Strong guarantee: if an exception is thrown, there are no
    changes in the JSON value.
N
Niels 已提交
13739

13740
    @complexity Constant.
N
Niels 已提交
13741 13742

    @since version 2.0.0
13743 13744

    @liveexample{The behavior is shown in the example.,at_json_pointer}
N
Niels 已提交
13745 13746 13747 13748 13749 13750 13751 13752 13753
    */
    reference at(const json_pointer& ptr)
    {
        return ptr.get_checked(this);
    }

    /*!
    @brief access specified element via JSON Pointer

N
Niels 已提交
13754 13755
    Returns a const reference to the element at with specified JSON pointer @a
    ptr, with bounds checking.
N
Niels 已提交
13756 13757 13758 13759 13760

    @param[in] ptr  JSON pointer to the desired element

    @return reference to the element pointed to by @a ptr

13761
    @throw parse_error.106 if an array index in the passed JSON pointer @a ptr
13762
    begins with '0'. See example below.
N
Niels 已提交
13763

13764
    @throw parse_error.109 if an array index in the passed JSON pointer @a ptr
13765
    is not a number. See example below.
N
Niels 已提交
13766

13767 13768
    @throw out_of_range.401 if an array index in the passed JSON pointer @a ptr
    is out of range. See example below.
13769

13770
    @throw out_of_range.402 if the array index '-' is used in the passed JSON
13771
    pointer @a ptr. As `at` provides checked access (and no elements are
13772
    implicitly inserted), the index '-' is always invalid. See example below.
13773

13774 13775
    @throw out_of_range.404 if the JSON pointer @a ptr can not be resolved.
    See example below.
N
Niels 已提交
13776

13777 13778 13779 13780
    @exceptionsafety Strong guarantee: if an exception is thrown, there are no
    changes in the JSON value.

    @complexity Constant.
N
Niels 已提交
13781 13782

    @since version 2.0.0
13783 13784

    @liveexample{The behavior is shown in the example.,at_json_pointer_const}
N
Niels 已提交
13785 13786 13787 13788 13789 13790
    */
    const_reference at(const json_pointer& ptr) const
    {
        return ptr.get_checked(this);
    }

N
Niels 已提交
13791
    /*!
N
Niels 已提交
13792 13793
    @brief return flattened JSON value

N
Niels 已提交
13794 13795 13796 13797
    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 已提交
13798

N
Niels Lohmann 已提交
13799
    @return an object that maps JSON pointers to primitive values
N
Niels 已提交
13800

N
Niels 已提交
13801 13802
    @note Empty objects and arrays are flattened to `null` and will not be
          reconstructed correctly by the @ref unflatten() function.
N
Niels 已提交
13803 13804 13805 13806 13807 13808 13809 13810 13811

    @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 已提交
13812 13813 13814 13815 13816 13817 13818
    */
    basic_json flatten() const
    {
        basic_json result(value_t::object);
        json_pointer::flatten("", *this, result);
        return result;
    }
N
Niels 已提交
13819 13820

    /*!
N
Niels 已提交
13821 13822 13823 13824 13825 13826 13827 13828 13829 13830
    @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 已提交
13831
    @return the original JSON from a flattened version
N
Niels 已提交
13832 13833 13834 13835 13836 13837 13838 13839

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

N
Niels Lohmann 已提交
13840 13841 13842
    @throw type_error.314  if value is not an object
    @throw type_error.315  if object values are not primitve

N
Niels 已提交
13843 13844 13845 13846 13847 13848
    @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 已提交
13849
    */
N
Niels 已提交
13850
    basic_json unflatten() const
N
Niels 已提交
13851
    {
N
Niels 已提交
13852
        return json_pointer::unflatten(*this);
N
Niels 已提交
13853
    }
N
Niels 已提交
13854 13855

    /// @}
13856

N
Niels 已提交
13857 13858 13859 13860 13861 13862 13863
    //////////////////////////
    // JSON Patch functions //
    //////////////////////////

    /// @name JSON Patch functions
    /// @{

13864 13865 13866
    /*!
    @brief applies a JSON patch

N
Niels 已提交
13867 13868
    [JSON Patch](http://jsonpatch.com) defines a JSON document structure for
    expressing a sequence of operations to apply to a JSON) document. With
N
Niels Lohmann 已提交
13869
    this function, a JSON Patch is applied to the current JSON value by
N
Niels 已提交
13870 13871
    executing all operations from the patch.

N
Niels 已提交
13872
    @param[in] json_patch  JSON patch document
13873 13874
    @return patched document

N
Niels 已提交
13875 13876 13877 13878 13879
    @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.

N
Niels Lohmann 已提交
13880 13881 13882 13883
    @throw parse_error.104 if the JSON patch does not consist of an array of
    objects

    @throw parse_error.105 if the JSON patch is malformed (e.g., mandatory
N
Niels 已提交
13884 13885
    attributes are missing); example: `"operation add must have member path"`

N
Niels Lohmann 已提交
13886 13887
    @throw out_of_range.401 if an array index is out of range.

13888 13889 13890
    @throw out_of_range.403 if a JSON pointer inside the patch could not be
    resolved successfully in the current JSON value; example: `"key baz not
    found"`
N
Niels Lohmann 已提交
13891 13892 13893 13894 13895

    @throw out_of_range.405 if JSON pointer has no parent ("add", "remove",
    "move")

    @throw other_error.501 if "test" operation was unsuccessful
N
Niels 已提交
13896 13897 13898 13899

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

N
Niels 已提交
13901 13902 13903 13904 13905 13906 13907 13908 13909
    @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
13910
    */
N
Niels 已提交
13911
    basic_json patch(const basic_json& json_patch) const
13912
    {
N
Niels 已提交
13913
        // make a working copy to apply the patch to
13914 13915
        basic_json result = *this;

N
Niels 已提交
13916 13917 13918
        // the valid JSON Patch operations
        enum class patch_operations {add, remove, replace, move, copy, test, invalid};

N
Niels Lohmann 已提交
13919
        const auto get_op = [](const std::string & op)
N
Niels 已提交
13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940 13941 13942 13943 13944 13945 13946 13947 13948
        {
            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 已提交
13949
        // wrapper for "add" operation; add value at ptr
N
Niels 已提交
13950
        const auto operation_add = [&result](json_pointer & ptr, basic_json val)
N
Niels 已提交
13951
        {
N
Niels 已提交
13952 13953
            // adding to the root of the target document means replacing it
            if (ptr.is_root())
N
Niels 已提交
13954
            {
N
Niels 已提交
13955
                result = val;
N
Niels 已提交
13956
            }
N
Niels 已提交
13957
            else
N
Niels 已提交
13958
            {
N
Niels 已提交
13959 13960 13961
                // make sure the top element of the pointer exists
                json_pointer top_pointer = ptr.top();
                if (top_pointer != ptr)
N
Niels 已提交
13962
                {
N
Niels 已提交
13963
                    result.at(top_pointer);
N
Niels 已提交
13964
                }
N
Niels 已提交
13965 13966 13967 13968 13969 13970

                // 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 已提交
13971
                {
N
Niels 已提交
13972 13973 13974 13975 13976 13977 13978 13979 13980 13981 13982 13983 13984 13985 13986 13987 13988 13989 13990 13991 13992
                    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
13993
                                JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
13994 13995 13996 13997 13998 13999 14000 14001 14002 14003 14004 14005
                            }
                            else
                            {
                                // default case: insert add offset
                                parent.insert(parent.begin() + static_cast<difference_type>(idx), val);
                            }
                        }
                        break;
                    }

                    default:
                    {
N
Niels 已提交
14006 14007
                        // if there exists a parent it cannot be primitive
                        assert(false);  // LCOV_EXCL_LINE
N
Niels 已提交
14008
                    }
N
Niels 已提交
14009 14010 14011 14012
                }
            }
        };

N
Niels 已提交
14013
        // wrapper for "remove" operation; remove value at ptr
N
Niels 已提交
14014 14015
        const auto operation_remove = [&result](json_pointer & ptr)
        {
N
Niels 已提交
14016
            // get reference to parent of JSON pointer ptr
N
Niels 已提交
14017 14018
            const auto last_path = ptr.pop_back();
            basic_json& parent = result.at(ptr);
N
Niels 已提交
14019 14020

            // remove child
N
Niels 已提交
14021 14022
            if (parent.is_object())
            {
N
Niels 已提交
14023 14024 14025 14026 14027 14028 14029 14030
                // perform range check
                auto it = parent.find(last_path);
                if (it != parent.end())
                {
                    parent.erase(it);
                }
                else
                {
14031
                    JSON_THROW(out_of_range::create(403, "key '" + last_path + "' not found"));
N
Niels 已提交
14032
                }
N
Niels 已提交
14033 14034 14035
            }
            else if (parent.is_array())
            {
N
Niels 已提交
14036 14037
                // note erase performs range check
                parent.erase(static_cast<size_type>(std::stoi(last_path)));
N
Niels 已提交
14038 14039 14040
            }
        };

14041
        // type check: top level value must be an array
N
Niels 已提交
14042
        if (not json_patch.is_array())
N
Niels 已提交
14043
        {
14044
            JSON_THROW(parse_error::create(104, 0, "JSON patch must be an array of objects"));
N
Niels 已提交
14045 14046
        }

N
Niels Lohmann 已提交
14047
        // iterate and apply the operations
N
Niels 已提交
14048
        for (const auto& val : json_patch)
14049
        {
N
Niels 已提交
14050 14051 14052
            // wrapper to get a value for an operation
            const auto get_value = [&val](const std::string & op,
                                          const std::string & member,
N
Niels 已提交
14053
                                          bool string_type) -> basic_json&
14054
            {
N
Niels 已提交
14055 14056
                // find value
                auto it = val.m_value.object->find(member);
14057

N
Niels 已提交
14058 14059
                // context-sensitive error message
                const auto error_msg = (op == "op") ? "operation" : "operation '" + op + "'";
14060

N
Niels 已提交
14061 14062 14063
                // check if desired value is present
                if (it == val.m_value.object->end())
                {
14064
                    JSON_THROW(parse_error::create(105, 0, error_msg + " must have member '" + member + "'"));
N
Niels 已提交
14065
                }
14066

N
Niels 已提交
14067 14068 14069
                // check if result is of type string
                if (string_type and not it->second.is_string())
                {
14070
                    JSON_THROW(parse_error::create(105, 0, error_msg + " must have string member '" + member + "'"));
N
Niels 已提交
14071 14072 14073 14074 14075 14076
                }

                // no error: return value
                return it->second;
            };

14077
            // type check: every element of the array must be an object
N
Niels 已提交
14078
            if (not val.is_object())
14079
            {
14080
                JSON_THROW(parse_error::create(104, 0, "JSON patch must be an array of objects"));
14081 14082
            }

N
Niels 已提交
14083 14084 14085
            // collect mandatory members
            const std::string op = get_value("op", "op", true);
            const std::string path = get_value(op, "path", true);
N
oops  
Niels 已提交
14086
            json_pointer ptr(path);
14087

N
Niels 已提交
14088
            switch (get_op(op))
14089
            {
N
Niels 已提交
14090 14091 14092 14093 14094 14095 14096 14097 14098 14099 14100 14101 14102 14103 14104 14105 14106 14107 14108 14109 14110 14111 14112 14113 14114 14115 14116 14117 14118 14119 14120 14121 14122 14123 14124 14125 14126 14127 14128 14129 14130 14131 14132 14133 14134 14135 14136 14137 14138
                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;
14139
                    JSON_TRY
N
Niels 已提交
14140 14141 14142 14143 14144
                    {
                        // check if "value" matches the one at "path"
                        // the "path" location must exist - use at()
                        success = (result.at(ptr) == get_value("test", "value", false));
                    }
14145
                    JSON_CATCH (out_of_range&)
N
Niels 已提交
14146 14147 14148 14149 14150 14151 14152
                    {
                        // ignore out of range errors: success remains false
                    }

                    // throw an exception if test fails
                    if (not success)
                    {
14153
                        JSON_THROW(other_error::create(501, "unsuccessful: " + val.dump()));
N
Niels 已提交
14154 14155 14156 14157 14158 14159 14160 14161 14162
                    }

                    break;
                }

                case patch_operations::invalid:
                {
                    // op must be "add", "remove", "replace", "move", "copy", or
                    // "test"
14163
                    JSON_THROW(parse_error::create(105, 0, "operation value '" + op + "' is invalid"));
N
Niels 已提交
14164
                }
14165
            }
N
Niels 已提交
14166 14167 14168 14169 14170 14171 14172 14173 14174 14175 14176 14177 14178 14179 14180 14181 14182 14183 14184 14185
        }

        return result;
    }

    /*!
    @brief creates a diff as a JSON patch

    Creates a [JSON Patch](http://jsonpatch.com) so that value @a source can
    be changed into the value @a target by calling @ref patch function.

    @invariant For two JSON values @a source and @a target, the following code
    yields always `true`:
    @code {.cpp}
    source.patch(diff(source, target)) == target;
    @endcode

    @note Currently, only `remove`, `add`, and `replace` operations are
          generated.

N
Niels Lohmann 已提交
14186 14187
    @param[in] source  JSON value to compare from
    @param[in] target  JSON value to compare against
N
Niels 已提交
14188 14189 14190 14191 14192 14193 14194 14195 14196 14197 14198 14199 14200 14201 14202 14203 14204
    @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,
14205
                           const std::string& path = "")
N
Niels 已提交
14206 14207 14208 14209 14210 14211 14212 14213 14214 14215 14216 14217 14218 14219
    {
        // 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(
14220
            {
N
Niels 已提交
14221 14222 14223 14224 14225 14226 14227 14228
                {"op", "replace"},
                {"path", path},
                {"value", target}
            });
        }
        else
        {
            switch (source.type())
14229
            {
N
Niels 已提交
14230 14231 14232 14233 14234 14235 14236 14237 14238 14239 14240
                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 已提交
14241

N
Niels 已提交
14242 14243
                    // i now reached the end of at least one array
                    // in a second pass, traverse the remaining elements
N
Niels 已提交
14244

N
Niels 已提交
14245
                    // remove my remaining elements
N
Niels 已提交
14246
                    const auto end_index = static_cast<difference_type>(result.size());
N
Niels 已提交
14247 14248
                    while (i < source.size())
                    {
N
Niels 已提交
14249 14250
                        // add operations in reverse order to avoid invalid
                        // indices
N
Niels 已提交
14251
                        result.insert(result.begin() + end_index, object(
N
Niels 已提交
14252 14253 14254 14255 14256 14257 14258 14259 14260 14261 14262 14263 14264 14265 14266 14267 14268 14269 14270 14271 14272 14273 14274
                        {
                            {"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:
14275
                {
N
Niels 已提交
14276 14277 14278 14279 14280 14281 14282 14283 14284 14285 14286 14287 14288 14289 14290 14291 14292 14293 14294 14295 14296 14297 14298 14299 14300 14301 14302 14303 14304 14305 14306 14307 14308 14309 14310 14311 14312 14313 14314 14315 14316 14317 14318 14319 14320 14321 14322 14323 14324 14325 14326 14327
                    // 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;
14328 14329 14330 14331 14332 14333
                }
            }
        }

        return result;
    }
N
Niels 已提交
14334 14335

    /// @}
N
Niels 已提交
14336 14337 14338 14339 14340 14341
};

/////////////
// presets //
/////////////

N
Niels 已提交
14342 14343 14344
/*!
@brief default JSON class

N
Niels 已提交
14345 14346
This type is the default specialization of the @ref basic_json class which
uses the standard template types.
N
Niels 已提交
14347

N
Niels 已提交
14348
@since version 1.0.0
N
Niels 已提交
14349
*/
N
Niels 已提交
14350
using json = basic_json<>;
N
Niels Lohmann 已提交
14351
} // namespace nlohmann
N
Niels 已提交
14352 14353


N
Niels 已提交
14354 14355 14356
///////////////////////
// nonmember support //
///////////////////////
N
Niels 已提交
14357 14358 14359

// specialization of std::swap, and std::hash
namespace std
T
Théo DELRIEU 已提交
14360 14361 14362 14363 14364 14365 14366 14367 14368 14369 14370 14371 14372 14373 14374 14375 14376 14377 14378
{
/*!
@brief exchanges the values of two JSON objects

@since version 1.0.0
*/
template<>
inline void swap(nlohmann::json& j1,
                 nlohmann::json& j2) noexcept(
                     is_nothrow_move_constructible<nlohmann::json>::value and
                     is_nothrow_move_assignable<nlohmann::json>::value
                 )
{
    j1.swap(j2);
}

/// hash value for JSON objects
template<>
struct hash<nlohmann::json>
N
Niels 已提交
14379
{
N
Niels 已提交
14380
    /*!
T
Théo DELRIEU 已提交
14381
    @brief return a hash value for a JSON object
N
Niels 已提交
14382

N
Niels 已提交
14383
    @since version 1.0.0
N
Niels 已提交
14384
    */
T
Théo DELRIEU 已提交
14385
    std::size_t operator()(const nlohmann::json& j) const
N
Niels 已提交
14386 14387
    {
        // a naive hashing via the string representation
N
Niels 已提交
14388 14389
        const auto& h = hash<nlohmann::json::string_t>();
        return h(j.dump());
N
Niels 已提交
14390
    }
T
Théo DELRIEU 已提交
14391
};
14392 14393 14394 14395 14396 14397 14398 14399 14400 14401 14402 14403 14404 14405 14406 14407

/// specialization for std::less<value_t>
template <>
struct less<::nlohmann::detail::value_t>
{
    /*!
    @brief compare two value_t enum values
    @since version 3.0.0
    */
    bool operator()(nlohmann::detail::value_t lhs,
                    nlohmann::detail::value_t rhs) const noexcept
    {
        return nlohmann::detail::operator<(lhs, rhs);
    }
};

N
Niels Lohmann 已提交
14408
} // namespace std
N
Niels 已提交
14409 14410

/*!
N
Niels 已提交
14411 14412
@brief user-defined string literal for JSON values

N
Niels 已提交
14413
This operator implements a user-defined string literal for JSON objects. It
N
Niels 已提交
14414
can be used by adding `"_json"` to a string literal and returns a JSON object
N
Niels 已提交
14415
if no parse error occurred.
N
Niels 已提交
14416

N
Niels 已提交
14417
@param[in] s  a string representation of a JSON object
14418
@param[in] n  the length of string @a s
N
Niels 已提交
14419
@return a JSON object
N
Niels 已提交
14420

N
Niels 已提交
14421
@since version 1.0.0
N
Niels 已提交
14422
*/
14423
inline nlohmann::json operator "" _json(const char* s, std::size_t n)
N
Niels 已提交
14424
{
14425
    return nlohmann::json::parse(s, s + n);
N
Niels 已提交
14426 14427
}

N
Niels 已提交
14428 14429 14430
/*!
@brief user-defined string literal for JSON pointer

N
Niels 已提交
14431
This operator implements a user-defined string literal for JSON Pointers. It
N
Niels 已提交
14432
can be used by adding `"_json_pointer"` to a string literal and returns a JSON pointer
N
Niels 已提交
14433 14434 14435
object if no parse error occurred.

@param[in] s  a string representation of a JSON Pointer
14436
@param[in] n  the length of string @a s
N
Niels 已提交
14437 14438
@return a JSON pointer object

N
Niels 已提交
14439 14440
@since version 2.0.0
*/
14441
inline nlohmann::json::json_pointer operator "" _json_pointer(const char* s, std::size_t n)
N
Niels 已提交
14442
{
14443
    return nlohmann::json::json_pointer(std::string(s, n));
N
Niels 已提交
14444 14445
}

14446 14447 14448 14449
// restore GCC/clang diagnostic settings
#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
    #pragma GCC diagnostic pop
#endif
L
Lukas Barth 已提交
14450 14451 14452
#if defined(__clang__)
    #pragma GCC diagnostic pop
#endif
14453

14454 14455
// clean up
#undef JSON_CATCH
N
Niels Lohmann 已提交
14456 14457
#undef JSON_THROW
#undef JSON_TRY
N
Niels Lohmann 已提交
14458 14459
#undef JSON_LIKELY
#undef JSON_UNLIKELY
14460
#undef JSON_DEPRECATED
14461

N
Niels 已提交
14462
#endif