json.hpp 495.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
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.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.
202
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.
203 204 205 206 207 208 209 210

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

    /*!
    @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
232 233
          file. This also holds true when reading a byte vector (CBOR or
          MessagePack).
234 235
    */
    const size_t byte;
236 237

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

/*!
@brief exception indicating errors with iterators

Exceptions have ids 2xx.

248 249 250 251 252 253 254 255 256 257 258 259 260 261
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.
N
Niels Lohmann 已提交
262
json.exception.invalid_iterator.213 | cannot compare order of object iterators | The order of object iterators cannot be compared, because JSON objects are unordered.
263
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().
264 265 266 267 268 269

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

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

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

Exceptions have ids 3xx.

287
name / id                     | example message | description
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
----------------------------- | --------------- | -------------------------
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.
303 304 305 306 307 308

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

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

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

Exceptions have ids 4xx.

326
name / id                       | example message | description
327 328 329 330 331 332
------------------------------- | --------------- | -------------------------
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.
333
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.
334 335 336 337 338 339

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

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

352 353 354 355 356
/*!
@brief exception indicating other errors

Exceptions have ids 5xx.

357
name / id                      | example message | description
358
------------------------------ | --------------- | -------------------------
359
json.exception.other_error.501 | unsuccessful: {"op":"test","path":"/baz", "value":"bar"} | A JSON Patch operation 'test' failed. The unsuccessful operation is also printed.
360
json.exception.other_error.502 | invalid object size for conversion | Some conversions to user-defined types impose constraints on the object size (e.g. std::pair)
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

T
Théo DELRIEU 已提交
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
// implementation of C++14 index_sequence and affiliates
// source: https://stackoverflow.com/a/32223343
template <std::size_t... Ints>
struct index_sequence
{
    using type = index_sequence;
    using value_type = std::size_t;
    static constexpr std::size_t size() noexcept
    {
        return sizeof...(Ints);
    }
};

template <class Sequence1, class Sequence2>
struct merge_and_renumber;

template <std::size_t... I1, std::size_t... I2>
struct merge_and_renumber<index_sequence<I1...>, index_sequence<I2...>>
        : index_sequence < I1..., (sizeof...(I1) + I2)... >
          { };

template <std::size_t N>
struct make_index_sequence
    : merge_and_renumber < typename make_index_sequence < N / 2 >::type,
      typename make_index_sequence < N - N / 2 >::type >
{ };

template<> struct make_index_sequence<0> : index_sequence<> { };
template<> struct make_index_sequence<1> : index_sequence<0> { };

template<typename... Ts>
using index_sequence_for = make_index_sequence<sizeof...(Ts)>;

500
/*
N
Niels Lohmann 已提交
501
Implementation of two C++17 constructs: conjunction, negation. This is needed
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
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 {};
517

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

520
// dispatch utility (taken from ranges-v3)
521 522
template<unsigned N> struct priority_tag : priority_tag < N - 1 > {};
template<> struct priority_tag<0> {};
523

524 525 526 527

//////////////////
// constructors //
//////////////////
528

529
template<value_t> struct external_constructor;
530

531
template<>
532 533
struct external_constructor<value_t::boolean>
{
534
    template<typename BasicJsonType>
535
    static void construct(BasicJsonType& j, typename BasicJsonType::boolean_t b) noexcept
T
Théo DELRIEU 已提交
536 537 538 539 540
    {
        j.m_type = value_t::boolean;
        j.m_value = b;
        j.assert_invariant();
    }
541
};
542

543
template<>
544 545
struct external_constructor<value_t::string>
{
546
    template<typename BasicJsonType>
547
    static void construct(BasicJsonType& j, const typename BasicJsonType::string_t& s)
T
Théo DELRIEU 已提交
548 549 550 551 552
    {
        j.m_type = value_t::string;
        j.m_value = s;
        j.assert_invariant();
    }
553
};
554

555
template<>
556 557
struct external_constructor<value_t::number_float>
{
558
    template<typename BasicJsonType>
559
    static void construct(BasicJsonType& j, typename BasicJsonType::number_float_t val) noexcept
560
    {
561 562
        j.m_type = value_t::number_float;
        j.m_value = val;
T
Théo DELRIEU 已提交
563
        j.assert_invariant();
564 565 566
    }
};

567
template<>
568 569
struct external_constructor<value_t::number_unsigned>
{
570
    template<typename BasicJsonType>
571
    static void construct(BasicJsonType& j, typename BasicJsonType::number_unsigned_t val) noexcept
T
Théo DELRIEU 已提交
572 573 574 575 576
    {
        j.m_type = value_t::number_unsigned;
        j.m_value = val;
        j.assert_invariant();
    }
577 578
};

579
template<>
580 581
struct external_constructor<value_t::number_integer>
{
582
    template<typename BasicJsonType>
583
    static void construct(BasicJsonType& j, typename BasicJsonType::number_integer_t val) noexcept
T
Théo DELRIEU 已提交
584 585 586 587 588
    {
        j.m_type = value_t::number_integer;
        j.m_value = val;
        j.assert_invariant();
    }
589 590
};

591
template<>
592 593
struct external_constructor<value_t::array>
{
594
    template<typename BasicJsonType>
595
    static void construct(BasicJsonType& j, const typename BasicJsonType::array_t& arr)
T
Théo DELRIEU 已提交
596 597 598 599 600 601
    {
        j.m_type = value_t::array;
        j.m_value = arr;
        j.assert_invariant();
    }

602 603 604 605
    template<typename BasicJsonType, typename CompatibleArrayType,
             enable_if_t<not std::is_same<CompatibleArrayType,
                                          typename BasicJsonType::array_t>::value,
                         int> = 0>
606
    static void construct(BasicJsonType& j, const CompatibleArrayType& arr)
T
Théo DELRIEU 已提交
607 608 609 610
    {
        using std::begin;
        using std::end;
        j.m_type = value_t::array;
611
        j.m_value.array = j.template create<typename BasicJsonType::array_t>(begin(arr), end(arr));
T
Théo DELRIEU 已提交
612 613
        j.assert_invariant();
    }
614 615 616 617 618 619 620 621 622 623 624 625 626

    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();
    }
627 628
};

629
template<>
630 631
struct external_constructor<value_t::object>
{
632
    template<typename BasicJsonType>
633
    static void construct(BasicJsonType& j, const typename BasicJsonType::object_t& obj)
T
Théo DELRIEU 已提交
634 635 636 637 638 639
    {
        j.m_type = value_t::object;
        j.m_value = obj;
        j.assert_invariant();
    }

640 641 642 643
    template<typename BasicJsonType, typename CompatibleObjectType,
             enable_if_t<not std::is_same<CompatibleObjectType,
                                          typename BasicJsonType::object_t>::value,
                         int> = 0>
644
    static void construct(BasicJsonType& j, const CompatibleObjectType& obj)
T
Théo DELRIEU 已提交
645 646 647
    {
        using std::begin;
        using std::end;
648

T
Théo DELRIEU 已提交
649
        j.m_type = value_t::object;
650
        j.m_value.object = j.template create<typename BasicJsonType::object_t>(begin(obj), end(obj));
T
Théo DELRIEU 已提交
651 652
        j.assert_invariant();
    }
653 654
};

655 656 657 658 659

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

660 661
/*!
@brief Helper to determine whether there's a key_type for T.
N
Niels Lohmann 已提交
662 663

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

667
@sa http://stackoverflow.com/a/7728728/266378
N
Niels 已提交
668
@since version 1.0.0, overworked in version 2.0.6
669
*/
N
Niels Lohmann 已提交
670
#define NLOHMANN_JSON_HAS_HELPER(type)                                        \
671
    template<typename T> struct has_##type {                                  \
N
Niels Lohmann 已提交
672
    private:                                                                  \
673
        template<typename U, typename = typename U::type>                     \
N
Niels Lohmann 已提交
674 675 676 677 678
        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 已提交
679
    }
T
Théo Delrieu 已提交
680

N
Niels Lohmann 已提交
681 682 683 684
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 已提交
685 686

#undef NLOHMANN_JSON_HAS_HELPER
687

N
Niels Lohmann 已提交
688

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

692
template<class RealType, class CompatibleObjectType>
T
Théo DELRIEU 已提交
693 694
struct is_compatible_object_type_impl<true, RealType, CompatibleObjectType>
{
695 696 697 698 699
    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 已提交
700 701
};

702
template<class BasicJsonType, class CompatibleObjectType>
T
Théo DELRIEU 已提交
703 704
struct is_compatible_object_type
{
T
Théo DELRIEU 已提交
705 706 707 708
    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,
709
                                  typename BasicJsonType::object_t, CompatibleObjectType >::value;
T
Théo DELRIEU 已提交
710 711
};

712
template<typename BasicJsonType, typename T>
713
struct is_basic_json_nested_type
T
Théo DELRIEU 已提交
714
{
715 716 717 718 719
    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 已提交
720 721
};

722
template<class BasicJsonType, class CompatibleArrayType>
T
Théo DELRIEU 已提交
723 724
struct is_compatible_array_type
{
T
Théo DELRIEU 已提交
725
    static auto constexpr value =
726
        conjunction<negation<std::is_same<void, CompatibleArrayType>>,
T
Théo DELRIEU 已提交
727
        negation<is_compatible_object_type<
728 729
        BasicJsonType, CompatibleArrayType>>,
        negation<std::is_constructible<typename BasicJsonType::string_t,
T
Théo DELRIEU 已提交
730
        CompatibleArrayType>>,
731
        negation<is_basic_json_nested_type<BasicJsonType, CompatibleArrayType>>,
T
Théo DELRIEU 已提交
732 733
        has_value_type<CompatibleArrayType>,
        has_iterator<CompatibleArrayType>>::value;
T
Théo DELRIEU 已提交
734 735
};

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

739
template<typename RealIntegerType, typename CompatibleNumberIntegerType>
740
struct is_compatible_integer_type_impl<true, RealIntegerType, CompatibleNumberIntegerType>
T
Théo DELRIEU 已提交
741
{
T
Théo DELRIEU 已提交
742
    // is there an assert somewhere on overflows?
743 744 745 746 747 748 749 750
    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 已提交
751 752
};

753
template<typename RealIntegerType, typename CompatibleNumberIntegerType>
754 755
struct is_compatible_integer_type
{
756 757 758 759 760
    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;
761 762
};

763

N
Niels Lohmann 已提交
764
// trait checking if JSONSerializer<T>::from_json(json const&, udt&) exists
765
template<typename BasicJsonType, typename T>
766 767
struct has_from_json
{
768 769
  private:
    // also check the return type of from_json
770 771
    template<typename U, typename = enable_if_t<std::is_same<void, decltype(uncvref_t<U>::from_json(
                 std::declval<BasicJsonType>(), std::declval<T&>()))>::value>>
772 773
    static int detect(U&&);
    static void detect(...);
774

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

// This trait checks if JSONSerializer<T>::from_json(json const&) exists
// this overload is used for non-default-constructible user-defined-types
782
template<typename BasicJsonType, typename T>
783 784
struct has_non_default_from_json
{
T
Théo DELRIEU 已提交
785 786 787 788
  private:
    template <
        typename U,
        typename = enable_if_t<std::is_same<
789
                                   T, decltype(uncvref_t<U>::from_json(std::declval<BasicJsonType>()))>::value >>
T
Théo DELRIEU 已提交
790 791 792 793 794
    static int detect(U&&);
    static void detect(...);

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

798
// This trait checks if BasicJsonType::json_serializer<T>::to_json exists
799
template<typename BasicJsonType, typename T>
800 801
struct has_to_json
{
T
Théo DELRIEU 已提交
802
  private:
803 804
    template<typename U, typename = decltype(uncvref_t<U>::to_json(
                 std::declval<BasicJsonType&>(), std::declval<T>()))>
T
Théo DELRIEU 已提交
805 806 807 808 809
    static int detect(U&&);
    static void detect(...);

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

813

814 815 816
/////////////
// to_json //
/////////////
817

N
Niels Lohmann 已提交
818
template<typename BasicJsonType, typename T, enable_if_t<
819
             std::is_same<T, typename BasicJsonType::boolean_t>::value, int> = 0>
N
Niels Lohmann 已提交
820
void to_json(BasicJsonType& j, T b) noexcept
821
{
T
Théo DELRIEU 已提交
822
    external_constructor<value_t::boolean>::construct(j, b);
823 824
}

825 826
template<typename BasicJsonType, typename CompatibleString,
         enable_if_t<std::is_constructible<typename BasicJsonType::string_t,
N
Niels Lohmann 已提交
827
                     CompatibleString>::value, int> = 0>
828
void to_json(BasicJsonType& j, const CompatibleString& s)
829
{
T
Théo DELRIEU 已提交
830
    external_constructor<value_t::string>::construct(j, s);
831 832
}

833 834
template<typename BasicJsonType, typename FloatType,
         enable_if_t<std::is_floating_point<FloatType>::value, int> = 0>
835
void to_json(BasicJsonType& j, FloatType val) noexcept
836
{
837
    external_constructor<value_t::number_float>::construct(j, static_cast<typename BasicJsonType::number_float_t>(val));
838 839
}

840
template <
841 842
    typename BasicJsonType, typename CompatibleNumberUnsignedType,
    enable_if_t<is_compatible_integer_type<typename BasicJsonType::number_unsigned_t,
N
Niels Lohmann 已提交
843
                CompatibleNumberUnsignedType>::value, int> = 0 >
844
void to_json(BasicJsonType& j, CompatibleNumberUnsignedType val) noexcept
845
{
846
    external_constructor<value_t::number_unsigned>::construct(j, static_cast<typename BasicJsonType::number_unsigned_t>(val));
847 848
}

849
template <
850 851
    typename BasicJsonType, typename CompatibleNumberIntegerType,
    enable_if_t<is_compatible_integer_type<typename BasicJsonType::number_integer_t,
N
Niels Lohmann 已提交
852
                CompatibleNumberIntegerType>::value, int> = 0 >
853
void to_json(BasicJsonType& j, CompatibleNumberIntegerType val) noexcept
854
{
855
    external_constructor<value_t::number_integer>::construct(j, static_cast<typename BasicJsonType::number_integer_t>(val));
856 857
}

858 859 860
template<typename BasicJsonType, typename EnumType,
         enable_if_t<std::is_enum<EnumType>::value, int> = 0>
void to_json(BasicJsonType& j, EnumType e) noexcept
861
{
862 863
    using underlying_type = typename std::underlying_type<EnumType>::type;
    external_constructor<value_t::number_integer>::construct(j, static_cast<underlying_type>(e));
864 865
}

866
template<typename BasicJsonType>
867
void to_json(BasicJsonType& j, const std::vector<bool>& e)
868 869
{
    external_constructor<value_t::array>::construct(j, e);
870 871
}

872
template <
873
    typename BasicJsonType, typename CompatibleArrayType,
T
Théo DELRIEU 已提交
874
    enable_if_t <
875 876
        is_compatible_array_type<BasicJsonType, CompatibleArrayType>::value or
        std::is_same<typename BasicJsonType::array_t, CompatibleArrayType>::value,
T
Théo DELRIEU 已提交
877
        int > = 0 >
878
void to_json(BasicJsonType& j, const  CompatibleArrayType& arr)
879
{
T
Théo DELRIEU 已提交
880
    external_constructor<value_t::array>::construct(j, arr);
881 882
}

883
template <
884 885
    typename BasicJsonType, typename CompatibleObjectType,
    enable_if_t<is_compatible_object_type<BasicJsonType, CompatibleObjectType>::value,
T
Théo DELRIEU 已提交
886
                int> = 0 >
887
void to_json(BasicJsonType& j, const  CompatibleObjectType& arr)
888
{
T
Théo DELRIEU 已提交
889
    external_constructor<value_t::object>::construct(j, arr);
890 891
}

T
Théo DELRIEU 已提交
892 893 894 895
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 已提交
896 897 898
void to_json(BasicJsonType& j, T (&arr)[N])
{
    external_constructor<value_t::array>::construct(j, arr);
T
Théo DELRIEU 已提交
899
}
900

T
Théo DELRIEU 已提交
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
template <typename BasicJsonType, typename... Args>
void to_json(BasicJsonType& j, const std::pair<Args...>& p)
{
    j = {p.first, p.second};
}

template <typename BasicJsonType, typename Tuple, std::size_t... Idx>
void to_json_tuple_impl(BasicJsonType& j, const Tuple& t, index_sequence<Idx...>)
{
    j = {std::get<Idx>(t)...};
}

template <typename BasicJsonType, typename... Args>
void to_json(BasicJsonType& j, const std::tuple<Args...>& t)
{
    to_json_tuple_impl(j, t, index_sequence_for<Args...> {});
}

919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952
///////////////
// 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:
        {
953
            JSON_THROW(type_error::create(302, "type must be number, but is " + j.type_name()));
954 955 956 957 958
        }
    }
}

template<typename BasicJsonType>
959
void from_json(const BasicJsonType& j, typename BasicJsonType::boolean_t& b)
960
{
N
Niels Lohmann 已提交
961
    if (not j.is_boolean())
T
Théo DELRIEU 已提交
962
    {
963
        JSON_THROW(type_error::create(302, "type must be boolean, but is " + j.type_name()));
T
Théo DELRIEU 已提交
964
    }
965
    b = *j.template get_ptr<const typename BasicJsonType::boolean_t*>();
966 967
}

968
template<typename BasicJsonType>
969
void from_json(const BasicJsonType& j, typename BasicJsonType::string_t& s)
970
{
N
Niels Lohmann 已提交
971
    if (not j.is_string())
T
Théo DELRIEU 已提交
972
    {
973
        JSON_THROW(type_error::create(302, "type must be string, but is " + j.type_name()));
T
Théo DELRIEU 已提交
974
    }
975
    s = *j.template get_ptr<const typename BasicJsonType::string_t*>();
976 977
}

978
template<typename BasicJsonType>
979
void from_json(const BasicJsonType& j, typename BasicJsonType::number_float_t& val)
980
{
T
Théo DELRIEU 已提交
981
    get_arithmetic_value(j, val);
982 983
}

984
template<typename BasicJsonType>
985
void from_json(const BasicJsonType& j, typename BasicJsonType::number_unsigned_t& val)
986
{
T
Théo DELRIEU 已提交
987
    get_arithmetic_value(j, val);
988 989
}

990
template<typename BasicJsonType>
991
void from_json(const BasicJsonType& j, typename BasicJsonType::number_integer_t& val)
992
{
T
Théo DELRIEU 已提交
993
    get_arithmetic_value(j, val);
994 995
}

996 997 998
template<typename BasicJsonType, typename EnumType,
         enable_if_t<std::is_enum<EnumType>::value, int> = 0>
void from_json(const BasicJsonType& j, EnumType& e)
999
{
1000
    typename std::underlying_type<EnumType>::type val;
T
Théo DELRIEU 已提交
1001
    get_arithmetic_value(j, val);
1002
    e = static_cast<EnumType>(val);
1003 1004
}

1005 1006
template<typename BasicJsonType>
void from_json(const BasicJsonType& j, typename BasicJsonType::array_t& arr)
1007
{
N
Niels Lohmann 已提交
1008
    if (not j.is_array())
T
Théo DELRIEU 已提交
1009
    {
1010
        JSON_THROW(type_error::create(302, "type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
1011
    }
1012
    arr = *j.template get_ptr<const typename BasicJsonType::array_t*>();
1013 1014
}

1015
// forward_list doesn't have an insert method
1016 1017
template<typename BasicJsonType, typename T, typename Allocator,
         enable_if_t<std::is_convertible<BasicJsonType, T>::value, int> = 0>
1018
void from_json(const BasicJsonType& j, std::forward_list<T, Allocator>& l)
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 1026 1027 1028
    for (auto it = j.rbegin(), end = j.rend(); it != end; ++it)
    {
        l.push_front(it->template get<T>());
    }
1029 1030
}

1031 1032
template<typename BasicJsonType, typename CompatibleArrayType>
void from_json_array_impl(const BasicJsonType& j, CompatibleArrayType& arr, priority_tag<0>)
1033
{
T
Théo DELRIEU 已提交
1034 1035
    using std::begin;
    using std::end;
1036

1037 1038
    std::transform(j.begin(), j.end(),
                   std::inserter(arr, end(arr)), [](const BasicJsonType & i)
T
Théo DELRIEU 已提交
1039
    {
1040 1041
        // get<BasicJsonType>() returns *this, this won't call a from_json
        // method when value_type is BasicJsonType
1042
        return i.template get<typename CompatibleArrayType::value_type>();
T
Théo DELRIEU 已提交
1043
    });
1044 1045
}

1046 1047
template<typename BasicJsonType, typename CompatibleArrayType>
auto from_json_array_impl(const BasicJsonType& j, CompatibleArrayType& arr, priority_tag<1>)
T
Théo DELRIEU 已提交
1048 1049 1050
-> decltype(
    arr.reserve(std::declval<typename CompatibleArrayType::size_type>()),
    void())
1051
{
T
Théo DELRIEU 已提交
1052 1053
    using std::begin;
    using std::end;
1054

T
Théo DELRIEU 已提交
1055
    arr.reserve(j.size());
1056 1057
    std::transform(j.begin(), j.end(),
                   std::inserter(arr, end(arr)), [](const BasicJsonType & i)
T
Théo DELRIEU 已提交
1058
    {
1059 1060
        // get<BasicJsonType>() returns *this, this won't call a from_json
        // method when value_type is BasicJsonType
1061
        return i.template get<typename CompatibleArrayType::value_type>();
T
Théo DELRIEU 已提交
1062
    });
1063 1064
}

1065 1066 1067 1068 1069 1070 1071 1072 1073
template <typename BasicJsonType, typename T, std::size_t N>
void from_json_array_impl(const BasicJsonType& j, std::array<T, N>& arr, priority_tag<2>)
{
    for (std::size_t i = 0; i < N; ++i)
    {
        arr[i] = j.at(i).template get<T>();
    }
}

1074 1075
template<typename BasicJsonType, typename CompatibleArrayType,
         enable_if_t<is_compatible_array_type<BasicJsonType, CompatibleArrayType>::value and
1076
                     std::is_convertible<BasicJsonType, typename CompatibleArrayType::value_type>::value and
1077 1078
                     not std::is_same<typename BasicJsonType::array_t, CompatibleArrayType>::value, int> = 0>
void from_json(const BasicJsonType& j, CompatibleArrayType& arr)
1079
{
1080
    if (not j.is_array())
T
Théo DELRIEU 已提交
1081
    {
1082
        JSON_THROW(type_error::create(302, "type must be array, but is " + j.type_name()));
T
Théo DELRIEU 已提交
1083
    }
1084

1085
    from_json_array_impl(j, arr, priority_tag<2> {});
1086 1087
}

1088 1089 1090
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)
1091
{
N
Niels Lohmann 已提交
1092
    if (not j.is_object())
T
Théo DELRIEU 已提交
1093
    {
1094
        JSON_THROW(type_error::create(302, "type must be object, but is " + j.type_name()));
T
Théo DELRIEU 已提交
1095 1096
    }

1097
    auto inner_object = j.template get_ptr<const typename BasicJsonType::object_t*>();
T
Théo DELRIEU 已提交
1098 1099
    using std::begin;
    using std::end;
T
Théo DELRIEU 已提交
1100 1101
    using value_type = typename CompatibleObjectType::value_type;
    std::transform(
T
Théo DELRIEU 已提交
1102 1103
        inner_object->begin(), inner_object->end(),
        std::inserter(obj, obj.begin()),
T
Théo DELRIEU 已提交
1104 1105
        [](typename BasicJsonType::object_t::value_type const & p)
    {
T
Théo DELRIEU 已提交
1106 1107 1108 1109
        return value_type(
                   p.first,
                   p.second
                   .template get<typename CompatibleObjectType::mapped_type>());
T
Théo DELRIEU 已提交
1110
    });
1111 1112
}

N
Niels Lohmann 已提交
1113 1114 1115 1116
// 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?
1117 1118 1119 1120 1121 1122 1123 1124
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>
1125
void from_json(const BasicJsonType& j, ArithmeticType& val)
T
Théo DELRIEU 已提交
1126 1127 1128 1129
{
    switch (static_cast<value_t>(j))
    {
        case value_t::number_unsigned:
N
Niels Lohmann 已提交
1130
        {
1131
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_unsigned_t*>());
T
Théo DELRIEU 已提交
1132
            break;
N
Niels Lohmann 已提交
1133
        }
T
Théo DELRIEU 已提交
1134
        case value_t::number_integer:
N
Niels Lohmann 已提交
1135
        {
1136
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_integer_t*>());
T
Théo DELRIEU 已提交
1137
            break;
N
Niels Lohmann 已提交
1138
        }
T
Théo DELRIEU 已提交
1139
        case value_t::number_float:
N
Niels Lohmann 已提交
1140
        {
1141
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_float_t*>());
T
Théo DELRIEU 已提交
1142
            break;
N
Niels Lohmann 已提交
1143
        }
T
Théo DELRIEU 已提交
1144
        case value_t::boolean:
N
Niels Lohmann 已提交
1145
        {
1146
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::boolean_t*>());
T
Théo DELRIEU 已提交
1147
            break;
N
Niels Lohmann 已提交
1148
        }
T
Théo DELRIEU 已提交
1149
        default:
N
Niels Lohmann 已提交
1150
        {
1151
            JSON_THROW(type_error::create(302, "type must be number, but is " + j.type_name()));
N
Niels Lohmann 已提交
1152
        }
T
Théo DELRIEU 已提交
1153
    }
1154 1155
}

T
Théo DELRIEU 已提交
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
template <typename BasicJsonType, typename... Args>
void from_json(const BasicJsonType& j, std::pair<Args...>& p)
{
    p = {j.at(0), j.at(1)};
}

template <typename BasicJsonType, typename Tuple, std::size_t... Idx>
void from_json_tuple_impl(const BasicJsonType& j, Tuple& t, index_sequence<Idx...>)
{
    t = std::make_tuple(j.at(Idx)...);
}

template <typename BasicJsonType, typename... Args>
void from_json(const BasicJsonType& j, std::tuple<Args...>& t)
{
    from_json_tuple_impl(j, t, index_sequence_for<Args...> {});
}

1174 1175
struct to_json_fn
{
N
Niels Lohmann 已提交
1176
  private:
1177 1178 1179
    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())
1180
    {
1181
        return to_json(j, std::forward<T>(val));
1182
    }
T
Théo DELRIEU 已提交
1183

1184
    template<typename BasicJsonType, typename T>
1185
    void call(BasicJsonType&, T&&, priority_tag<0>) const noexcept
T
Théo DELRIEU 已提交
1186
    {
1187 1188
        static_assert(sizeof(BasicJsonType) == 0,
                      "could not find to_json() method in T's namespace");
T
Théo DELRIEU 已提交
1189 1190
    }

T
Théo DELRIEU 已提交
1191
  public:
1192
    template<typename BasicJsonType, typename T>
1193
    void operator()(BasicJsonType& j, T&& val) const
T
Théo DELRIEU 已提交
1194 1195 1196 1197
    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> {});
    }
1198 1199 1200 1201
};

struct from_json_fn
{
T
Théo DELRIEU 已提交
1202
  private:
1203 1204
    template<typename BasicJsonType, typename T>
    auto call(const BasicJsonType& j, T& val, priority_tag<1>) const
T
Théo DELRIEU 已提交
1205 1206 1207 1208 1209 1210
    noexcept(noexcept(from_json(j, val)))
    -> decltype(from_json(j, val), void())
    {
        return from_json(j, val);
    }

1211
    template<typename BasicJsonType, typename T>
1212
    void call(const BasicJsonType&, T&, priority_tag<0>) const noexcept
T
Théo DELRIEU 已提交
1213
    {
1214 1215
        static_assert(sizeof(BasicJsonType) == 0,
                      "could not find from_json() method in T's namespace");
T
Théo DELRIEU 已提交
1216 1217 1218
    }

  public:
1219 1220
    template<typename BasicJsonType, typename T>
    void operator()(const BasicJsonType& j, T& val) const
T
Théo DELRIEU 已提交
1221 1222 1223 1224
    noexcept(noexcept(std::declval<from_json_fn>().call(j, val, priority_tag<1> {})))
    {
        return call(j, val, priority_tag<1> {});
    }
1225
};
1226

1227
// taken from ranges-v3
1228
template<typename T>
1229 1230 1231 1232 1233
struct static_const
{
    static constexpr T value{};
};

1234
template<typename T>
1235
constexpr T static_const<T>::value;
1236 1237
} // namespace detail

N
Niels 已提交
1238

N
Niels Lohmann 已提交
1239
/// namespace to hold default `to_json` / `from_json` functions
1240
namespace
1241
{
T
Théo DELRIEU 已提交
1242 1243
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;
1244 1245
}

N
Niels Lohmann 已提交
1246 1247 1248 1249 1250 1251 1252 1253

/*!
@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.
*/
1254
template<typename = void, typename = void>
1255 1256
struct adl_serializer
{
N
Niels Lohmann 已提交
1257 1258 1259 1260 1261 1262 1263
    /*!
    @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
1264
    @param[in,out] val  value to write to
N
Niels Lohmann 已提交
1265 1266 1267 1268
    */
    template<typename BasicJsonType, typename ValueType>
    static void from_json(BasicJsonType&& j, ValueType& val) noexcept(
        noexcept(::nlohmann::from_json(std::forward<BasicJsonType>(j), val)))
1269
    {
1270
        ::nlohmann::from_json(std::forward<BasicJsonType>(j), val);
1271 1272
    }

N
Niels Lohmann 已提交
1273 1274 1275 1276 1277 1278
    /*!
    @brief convert any value type to a JSON value

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

1279
    @param[in,out] j  JSON value to write to
N
Niels Lohmann 已提交
1280 1281 1282 1283 1284
    @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))))
1285
    {
N
Niels Lohmann 已提交
1286
        ::nlohmann::to_json(j, std::forward<ValueType>(val));
1287
    }
1288 1289
};

1290

N
Niels 已提交
1291
/*!
N
Niels 已提交
1292
@brief a class to store JSON values
N
Niels 已提交
1293

N
Niels 已提交
1294
@tparam ObjectType type for JSON objects (`std::map` by default; will be used
N
Niels 已提交
1295
in @ref object_t)
N
Niels 已提交
1296
@tparam ArrayType type for JSON arrays (`std::vector` by default; will be used
N
Niels 已提交
1297
in @ref array_t)
N
Niels 已提交
1298
@tparam StringType type for JSON strings and object keys (`std::string` by
N
Niels 已提交
1299
default; will be used in @ref string_t)
N
Niels 已提交
1300
@tparam BooleanType type for JSON booleans (`bool` by default; will be used
N
Niels 已提交
1301
in @ref boolean_t)
N
Niels 已提交
1302
@tparam NumberIntegerType type for JSON integer numbers (`int64_t` by
N
Niels 已提交
1303
default; will be used in @ref number_integer_t)
N
Niels 已提交
1304 1305
@tparam NumberUnsignedType type for JSON unsigned integer numbers (@c
`uint64_t` by default; will be used in @ref number_unsigned_t)
N
Niels 已提交
1306
@tparam NumberFloatType type for JSON floating-point numbers (`double` by
N
Niels 已提交
1307
default; will be used in @ref number_float_t)
N
Niels 已提交
1308
@tparam AllocatorType type of the allocator to use (`std::allocator` by
N
Niels 已提交
1309
default)
N
Niels Lohmann 已提交
1310
@tparam JSONSerializer the serializer to resolve internal calls to `to_json()`
N
Niels Lohmann 已提交
1311
and `from_json()` (@ref adl_serializer by default)
N
Niels 已提交
1312

N
Niels 已提交
1313 1314
@requirement The class satisfies the following concept requirements:
- Basic
N
Niels 已提交
1315
 - [DefaultConstructible](http://en.cppreference.com/w/cpp/concept/DefaultConstructible):
N
Niels Lohmann 已提交
1316 1317
   JSON values can be default constructed. The result will be a JSON null
   value.
N
Niels 已提交
1318 1319 1320
 - [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 已提交
1321
   A JSON value can be copy-constructed from an lvalue expression.
N
Niels 已提交
1322 1323 1324 1325 1326 1327
 - [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 已提交
1328
- Layout
N
Niels 已提交
1329 1330 1331
 - [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 已提交
1332 1333
   All non-static data members are private and standard layout types, the
   class has no virtual functions or (virtual) base classes.
N
Niels 已提交
1334
- Library-wide
N
Niels 已提交
1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
 - [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 已提交
1347
- Container
N
Niels 已提交
1348 1349 1350 1351 1352
 - [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 已提交
1353

1354 1355 1356 1357 1358 1359 1360
@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 已提交
1361
@internal
N
Niels 已提交
1362
@note ObjectType trick from http://stackoverflow.com/a/9860911
N
Niels 已提交
1363
@endinternal
N
Niels 已提交
1364

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

N
Niels 已提交
1368
@since version 1.0.0
N
Niels 已提交
1369 1370

@nosubgrouping
N
Niels 已提交
1371 1372 1373 1374 1375 1376
*/
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,
1377 1378
    class NumberIntegerType = std::int64_t,
    class NumberUnsignedType = std::uint64_t,
N
Niels 已提交
1379
    class NumberFloatType = double,
1380
    template<typename U> class AllocatorType = std::allocator,
1381
    template<typename T, typename SFINAE = void> class JSONSerializer = adl_serializer
N
Niels 已提交
1382 1383 1384
    >
class basic_json
{
1385
  private:
1386
    template<detail::value_t> friend struct detail::external_constructor;
1387
    /// workaround type for MSVC
N
Niels 已提交
1388 1389
    using basic_json_t = basic_json<ObjectType, ArrayType, StringType,
          BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType,
1390
          AllocatorType, JSONSerializer>;
1391 1392

  public:
1393
    using value_t = detail::value_t;
N
Niels 已提交
1394
    // forward declarations
N
Niels Lohmann 已提交
1395
    template<typename U> class iter_impl;
N
Niels 已提交
1396 1397
    template<typename Base> class json_reverse_iterator;
    class json_pointer;
1398
    template<typename T, typename SFINAE>
1399
    using json_serializer = JSONSerializer<T, SFINAE>;
1400

1401 1402 1403 1404 1405 1406 1407 1408 1409

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

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

1410 1411
    /// @copydoc detail::exception
    using exception = detail::exception;
1412 1413 1414 1415 1416 1417 1418 1419
    /// @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;
1420 1421
    /// @copydoc detail::other_error
    using other_error = detail::other_error;
1422 1423 1424 1425

    /// @}


N
Niels 已提交
1426 1427 1428 1429
    /////////////////////
    // container types //
    /////////////////////

N
Niels 已提交
1430
    /// @name container types
N
Niels 已提交
1431 1432
    /// The canonic container types to use @ref basic_json like any other STL
    /// container.
N
Niels 已提交
1433 1434
    /// @{

N
Niels 已提交
1435
    /// the type of elements in a basic_json container
N
Niels 已提交
1436
    using value_type = basic_json;
N
Niels 已提交
1437

N
Niels 已提交
1438
    /// the type of an element reference
N
Niels 已提交
1439
    using reference = value_type&;
N
Niels 已提交
1440
    /// the type of an element const reference
N
Niels 已提交
1441
    using const_reference = const value_type&;
N
Niels 已提交
1442

N
Niels 已提交
1443
    /// a type to represent differences between iterators
N
Niels 已提交
1444
    using difference_type = std::ptrdiff_t;
N
Niels 已提交
1445
    /// a type to represent container sizes
N
Niels 已提交
1446 1447 1448
    using size_type = std::size_t;

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

N
Niels 已提交
1451
    /// the type of an element pointer
N
Niels 已提交
1452
    using pointer = typename std::allocator_traits<allocator_type>::pointer;
N
Niels 已提交
1453
    /// the type of an element const pointer
N
Niels 已提交
1454
    using const_pointer = typename std::allocator_traits<allocator_type>::const_pointer;
N
Niels 已提交
1455

N
Niels 已提交
1456
    /// an iterator for a basic_json container
1457
    using iterator = iter_impl<basic_json>;
N
Niels 已提交
1458
    /// a const iterator for a basic_json container
1459
    using const_iterator = iter_impl<const basic_json>;
N
Niels 已提交
1460
    /// a reverse iterator for a basic_json container
N
Niels 已提交
1461
    using reverse_iterator = json_reverse_iterator<typename basic_json::iterator>;
N
Niels 已提交
1462
    /// a const reverse iterator for a basic_json container
N
Niels 已提交
1463
    using const_reverse_iterator = json_reverse_iterator<typename basic_json::const_iterator>;
N
Niels 已提交
1464

N
Niels 已提交
1465 1466 1467
    /// @}


N
Niels 已提交
1468 1469 1470
    /*!
    @brief returns the allocator associated with the container
    */
N
Niels 已提交
1471
    static allocator_type get_allocator()
N
Niels 已提交
1472 1473 1474 1475
    {
        return allocator_type();
    }

1476 1477
    /*!
    @brief returns version information on the library
1478

N
Niels Lohmann 已提交
1479
    This function returns a JSON object with information about the library,
1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497
    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
1498
    */
1499
    static basic_json meta()
1500 1501 1502
    {
        basic_json result;

1503
        result["copyright"] = "(C) 2013-2017 Niels Lohmann";
1504 1505 1506 1507
        result["name"] = "JSON for Modern C++";
        result["url"] = "https://github.com/nlohmann/json";
        result["version"] =
        {
N
Niels Lohmann 已提交
1508
            {"string", "2.1.1"}, {"major", 2}, {"minor", 1}, {"patch", 1}
1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523
        };

#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__)
1524
        result["compiler"] = {{"family", "clang"}, {"version", __clang_version__}};
1525 1526 1527
#elif defined(__ICC) || defined(__INTEL_COMPILER)
        result["compiler"] = {{"family", "icc"}, {"version", __INTEL_COMPILER}};
#elif defined(__GNUC__) || defined(__GNUG__)
1528
        result["compiler"] = {{"family", "gcc"}, {"version", std::to_string(__GNUC__) + "." + std::to_string(__GNUC_MINOR__) + "." + std::to_string(__GNUC_PATCHLEVEL__)}};
1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550
#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 已提交
1551

N
Niels 已提交
1552 1553 1554 1555
    ///////////////////////////
    // JSON value data types //
    ///////////////////////////

N
Niels 已提交
1556
    /// @name JSON value data types
N
Niels 已提交
1557 1558
    /// The data types to store a JSON value. These types are derived from
    /// the template arguments passed to class @ref basic_json.
N
Niels 已提交
1559 1560
    /// @{

N
Niels 已提交
1561 1562 1563 1564 1565 1566 1567 1568
    /*!
    @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 已提交
1569 1570 1571 1572 1573
    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 已提交
1574 1575
    @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 已提交
1576 1577 1578
    inside the container.
    @tparam AllocatorType the allocator to use for objects (e.g.,
    `std::allocator`)
N
Niels 已提交
1579 1580 1581 1582

    #### Default type

    With the default values for @a ObjectType (`std::map`), @a StringType
N
Niels 已提交
1583 1584
    (`std::string`), and @a AllocatorType (`std::allocator`), the default
    value for @a object_t is:
N
Niels 已提交
1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600

    @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 已提交
1601 1602
      that all software implementations receiving that object will agree on
      the name-value mappings.
N
Niels 已提交
1603 1604 1605 1606 1607
    - 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 已提交
1608 1609 1610
      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 已提交
1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622
    - 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 已提交
1623 1624
    runtime environment. A theoretical limit can be queried by calling the
    @ref max_size function of a JSON object.
N
Niels 已提交
1625 1626 1627

    #### Storage

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

1632 1633
    @sa @ref array_t -- type for an array value

N
Niels 已提交
1634
    @since version 1.0.0
N
Niels 已提交
1635

N
Niels 已提交
1636 1637 1638 1639 1640
    @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 已提交
1641 1642
    7159](http://rfc7159.net/rfc7159), because any order implements the
    specified "unordered" nature of JSON objects.
N
Niels 已提交
1643
    */
N
Niels 已提交
1644 1645 1646 1647 1648
    using object_t = ObjectType<StringType,
          basic_json,
          std::less<StringType>,
          AllocatorType<std::pair<const StringType,
          basic_json>>>;
N
Niels 已提交
1649 1650 1651 1652 1653 1654 1655

    /*!
    @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 已提交
1656 1657 1658 1659 1660
    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 已提交
1661
    @tparam AllocatorType allocator to use for arrays (e.g., `std::allocator`)
N
Niels 已提交
1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681

    #### 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 已提交
1682 1683
    runtime environment. A theoretical limit can be queried by calling the
    @ref max_size function of a JSON array.
N
Niels 已提交
1684 1685 1686

    #### Storage

1687
    Arrays are stored as pointers in a @ref basic_json type. That is, for any
N
Niels 已提交
1688
    access to array values, a pointer of type `array_t*` must be dereferenced.
1689 1690 1691

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

N
Niels 已提交
1692
    @since version 1.0.0
N
Niels 已提交
1693
    */
N
Niels 已提交
1694
    using array_t = ArrayType<basic_json, AllocatorType<basic_json>>;
N
Niels 已提交
1695 1696 1697 1698 1699 1700 1701

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

N
Niels 已提交
1706 1707
    @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 已提交
1708 1709 1710 1711 1712 1713 1714 1715 1716 1717

    #### Default type

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

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

1718 1719 1720 1721 1722 1723
    #### 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 已提交
1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740
    #### 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

1741 1742
    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 已提交
1743
    dereferenced.
1744

N
Niels 已提交
1745
    @since version 1.0.0
N
Niels 已提交
1746
    */
N
Niels 已提交
1747
    using string_t = StringType;
N
Niels 已提交
1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768

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

1769 1770
    Boolean values are stored directly inside a @ref basic_json type.

N
Niels 已提交
1771
    @since version 1.0.0
N
Niels 已提交
1772
    */
N
Niels 已提交
1773
    using boolean_t = BooleanType;
N
Niels 已提交
1774 1775 1776 1777 1778

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

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791
    > 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 已提交
1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809

    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 已提交
1810 1811
      instance, the C++ integer literal `010` will be serialized to `8`.
      During deserialization, leading zeros yield an error.
N
Niels 已提交
1812 1813 1814 1815 1816 1817 1818 1819 1820 1821
    - 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 已提交
1822 1823 1824 1825
    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 已提交
1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836

    [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

1837 1838 1839 1840
    Integer number values are stored directly inside a @ref basic_json type.

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

1841 1842
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
1843
    @since version 1.0.0
N
Niels 已提交
1844
    */
N
Niels 已提交
1845
    using number_integer_t = NumberIntegerType;
N
Niels 已提交
1846

1847 1848 1849 1850
    /*!
    @brief a type for a number (unsigned)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866
    > 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.
1867 1868 1869

    #### Default type

N
Niels 已提交
1870 1871
    With the default values for @a NumberUnsignedType (`uint64_t`), the
    default value for @a number_unsigned_t is:
1872 1873 1874 1875 1876 1877 1878 1879 1880 1881

    @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 已提交
1882 1883
      instance, the C++ integer literal `010` will be serialized to `8`.
      During deserialization, leading zeros yield an error.
1884 1885 1886 1887 1888 1889 1890 1891
    - 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 已提交
1892 1893 1894 1895 1896
    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.
1897 1898 1899 1900 1901 1902 1903

    [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 已提交
1904 1905
    number_integer_t type) of the exactly supported range [0, UINT64_MAX],
    this class's integer type is interoperable.
1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916

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

N
Niels 已提交
1918 1919 1920 1921
    /*!
    @brief a type for a number (floating-point)

    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
N
Niels 已提交
1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934
    > 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 已提交
1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950

    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 已提交
1951 1952
      leading zeros in floating-point literals will be ignored. Internally,
      the value will be stored as decimal number. For instance, the C++
N
Niels 已提交
1953 1954 1955 1956 1957 1958 1959 1960 1961 1962
      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 已提交
1963 1964 1965
    > 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 已提交
1966 1967 1968 1969
    > precision.

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

    #### Storage

1975 1976 1977 1978 1979
    Floating-point number values are stored directly inside a @ref basic_json
    type.

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

1980 1981
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
1982
    @since version 1.0.0
N
Niels 已提交
1983
    */
N
Niels 已提交
1984 1985
    using number_float_t = NumberFloatType;

N
Niels 已提交
1986 1987
    /// @}

N
Niels 已提交
1988
  private:
N
Niels 已提交
1989

N
Cleanup  
Niels 已提交
1990 1991
    /// helper for exception-safe object creation
    template<typename T, typename... Args>
N
cleanup  
Niels 已提交
1992
    static T* create(Args&& ... args)
N
Cleanup  
Niels 已提交
1993 1994 1995 1996 1997 1998 1999 2000
    {
        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 已提交
2001
        assert(object != nullptr);
N
Cleanup  
Niels 已提交
2002 2003 2004
        return object.release();
    }

N
Niels 已提交
2005 2006 2007 2008
    ////////////////////////
    // JSON value storage //
    ////////////////////////

2009 2010 2011
    /*!
    @brief a JSON value

N
Niels 已提交
2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029
    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.
2030

N
Niels 已提交
2031
    @since version 1.0.0
2032
    */
N
Niels 已提交
2033 2034 2035 2036 2037 2038 2039 2040
    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 已提交
2041
        /// boolean
N
Niels 已提交
2042 2043 2044
        boolean_t boolean;
        /// number (integer)
        number_integer_t number_integer;
2045 2046
        /// number (unsigned integer)
        number_unsigned_t number_unsigned;
N
Niels 已提交
2047
        /// number (floating-point)
N
Niels 已提交
2048 2049 2050
        number_float_t number_float;

        /// default constructor (for null values)
N
Niels 已提交
2051
        json_value() = default;
N
Niels 已提交
2052
        /// constructor for booleans
N
Niels 已提交
2053
        json_value(boolean_t v) noexcept : boolean(v) {}
N
Niels 已提交
2054
        /// constructor for numbers (integer)
N
Niels 已提交
2055
        json_value(number_integer_t v) noexcept : number_integer(v) {}
2056 2057
        /// constructor for numbers (unsigned)
        json_value(number_unsigned_t v) noexcept : number_unsigned(v) {}
N
Niels 已提交
2058
        /// constructor for numbers (floating-point)
N
Niels 已提交
2059
        json_value(number_float_t v) noexcept : number_float(v) {}
N
Niels 已提交
2060
        /// constructor for empty values of a given type
N
Niels 已提交
2061
        json_value(value_t t)
N
Niels 已提交
2062 2063 2064
        {
            switch (t)
            {
2065
                case value_t::object:
N
Niels 已提交
2066
                {
N
Cleanup  
Niels 已提交
2067
                    object = create<object_t>();
N
Niels 已提交
2068 2069
                    break;
                }
N
Niels 已提交
2070

2071
                case value_t::array:
N
Niels 已提交
2072
                {
N
Cleanup  
Niels 已提交
2073
                    array = create<array_t>();
N
Niels 已提交
2074 2075
                    break;
                }
N
Niels 已提交
2076

2077
                case value_t::string:
N
Niels 已提交
2078
                {
N
Cleanup  
Niels 已提交
2079
                    string = create<string_t>("");
N
Niels 已提交
2080 2081
                    break;
                }
N
Niels 已提交
2082

2083
                case value_t::boolean:
N
Niels 已提交
2084 2085 2086 2087 2088
                {
                    boolean = boolean_t(false);
                    break;
                }

2089
                case value_t::number_integer:
N
Niels 已提交
2090 2091 2092 2093
                {
                    number_integer = number_integer_t(0);
                    break;
                }
N
Niels 已提交
2094

2095 2096 2097 2098 2099
                case value_t::number_unsigned:
                {
                    number_unsigned = number_unsigned_t(0);
                    break;
                }
N
Niels 已提交
2100

2101
                case value_t::number_float:
N
Niels 已提交
2102 2103 2104 2105
                {
                    number_float = number_float_t(0.0);
                    break;
                }
2106

2107 2108 2109 2110 2111
                case value_t::null:
                {
                    break;
                }

2112 2113
                default:
                {
N
Niels Lohmann 已提交
2114
                    if (JSON_UNLIKELY(t == value_t::null))
2115
                    {
2116
                        JSON_THROW(other_error::create(500, "961c151d2e87f2686a955a9be24d316f1362bf21 2.1.1")); // LCOV_EXCL_LINE
2117
                    }
2118 2119
                    break;
                }
N
Niels 已提交
2120 2121
            }
        }
N
Niels 已提交
2122 2123

        /// constructor for strings
N
Niels 已提交
2124
        json_value(const string_t& value)
N
Niels 已提交
2125
        {
N
Cleanup  
Niels 已提交
2126
            string = create<string_t>(value);
N
Niels 已提交
2127 2128 2129
        }

        /// constructor for objects
N
Niels 已提交
2130
        json_value(const object_t& value)
N
Niels 已提交
2131
        {
N
Cleanup  
Niels 已提交
2132
            object = create<object_t>(value);
N
Niels 已提交
2133 2134 2135
        }

        /// constructor for arrays
N
Niels 已提交
2136
        json_value(const array_t& value)
N
Niels 已提交
2137
        {
N
Cleanup  
Niels 已提交
2138
            array = create<array_t>(value);
N
Niels 已提交
2139
        }
N
Niels 已提交
2140 2141
    };

2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156
    /*!
    @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 已提交
2157 2158

  public:
N
Niels 已提交
2159 2160 2161 2162
    //////////////////////////
    // JSON parser callback //
    //////////////////////////

N
Niels 已提交
2163 2164 2165 2166 2167
    /*!
    @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.
2168

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

N
Niels 已提交
2171
    @since version 1.0.0
N
Niels 已提交
2172
    */
N
Niels 已提交
2173 2174
    enum class parse_event_t : uint8_t
    {
N
Niels 已提交
2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186
        /// 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 已提交
2187 2188
    };

N
Niels 已提交
2189 2190 2191 2192
    /*!
    @brief per-element parser callback type

    With a parser callback function, the result of parsing a JSON text can be
N
Niels 已提交
2193
    influenced. When passed to @ref parse(std::istream&, const
2194
    parser_callback_t) or @ref parse(const CharT, const parser_callback_t),
N
Niels 已提交
2195 2196 2197 2198 2199
    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 已提交
2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213

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

N
Niels 已提交
2216 2217
    Discarding a value (i.e., returning `false`) has different effects
    depending on the context in which function was called:
N
Niels 已提交
2218 2219 2220

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

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

N
Niels 已提交
2226
    @param[in] event  an event of type parse_event_t indicating the context in
N
Niels 已提交
2227 2228 2229 2230 2231 2232 2233 2234 2235 2236
    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
2237
    @ref parse(const CharT, const parser_callback_t) for examples
2238

N
Niels 已提交
2239
    @since version 1.0.0
N
Niels 已提交
2240
    */
N
Niels 已提交
2241 2242 2243
    using parser_callback_t = std::function<bool(int depth,
                              parse_event_t event,
                              basic_json& parsed)>;
N
Niels 已提交
2244

N
Niels 已提交
2245 2246 2247 2248 2249

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

N
Niels 已提交
2250
    /// @name constructors and destructors
N
Niels 已提交
2251 2252
    /// Constructors of class @ref basic_json, copy/move constructor, copy
    /// assignment, static functions creating objects, and the destructor.
N
Niels 已提交
2253 2254
    /// @{

N
Niels 已提交
2255 2256 2257
    /*!
    @brief create an empty value with a given type

N
Niels 已提交
2258 2259 2260 2261 2262
    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 已提交
2263 2264 2265 2266 2267 2268
    null        | `null`
    boolean     | `false`
    string      | `""`
    number      | `0`
    object      | `{}`
    array       | `[]`
N
Niels 已提交
2269

2270
    @param[in] v  the type of the value to create
N
Niels 已提交
2271 2272 2273 2274 2275

    @complexity Constant.

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

N
Niels 已提交
2277
    @since version 1.0.0
N
Niels 已提交
2278
    */
2279 2280
    basic_json(const value_t v)
        : m_type(v), m_value(v)
2281 2282 2283
    {
        assert_invariant();
    }
N
Niels 已提交
2284

N
Niels 已提交
2285
    /*!
N
Niels 已提交
2286
    @brief create a null object
N
Niels 已提交
2287

N
Niels 已提交
2288 2289
    Create a `null` JSON value. It either takes a null pointer as parameter
    (explicitly creating `null`) or no parameter (implicitly creating `null`).
N
Niels 已提交
2290 2291
    The passed null pointer itself is not read -- it is only used to choose
    the right constructor.
N
Niels 已提交
2292 2293 2294

    @complexity Constant.

N
Niels 已提交
2295 2296 2297
    @exceptionsafety No-throw guarantee: this constructor never throws
    exceptions.

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

N
Niels 已提交
2301
    @since version 1.0.0
N
Niels 已提交
2302
    */
N
Niels 已提交
2303
    basic_json(std::nullptr_t = nullptr) noexcept
N
Niels 已提交
2304
        : basic_json(value_t::null)
2305 2306 2307
    {
        assert_invariant();
    }
N
Niels 已提交
2308

T
Théo DELRIEU 已提交
2309
    /*!
2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347
    @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 已提交
2348 2349 2350

    @param[in] val the value to be forwarded

2351 2352 2353 2354 2355 2356 2357 2358
    @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 已提交
2359 2360 2361

    @since version 2.1.0
    */
2362
    template<typename CompatibleType, typename U = detail::uncvref_t<CompatibleType>,
2363 2364 2365 2366 2367 2368
             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>
2369 2370
    basic_json(CompatibleType && val) noexcept(noexcept(JSONSerializer<U>::to_json(
                std::declval<basic_json_t&>(), std::forward<CompatibleType>(val))))
2371
    {
2372 2373
        JSONSerializer<U>::to_json(*this, std::forward<CompatibleType>(val));
        assert_invariant();
2374
    }
2375

N
Niels 已提交
2376 2377 2378 2379 2380 2381 2382 2383 2384 2385
    /*!
    @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 已提交
2386 2387
       object value is created where the first elements of the pairs are
       treated as keys and the second elements are as values.
N
Niels 已提交
2388 2389 2390
    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 已提交
2391
    JSON values. The rationale is as follows:
N
Niels 已提交
2392 2393

    1. The empty initializer list is written as `{}` which is exactly an empty
N
Niels 已提交
2394
       JSON object.
N
Niels 已提交
2395
    2. C++ has now way of describing mapped types other than to list a list of
N
Niels 已提交
2396 2397 2398
       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 已提交
2399
    3. In all other cases, the initializer list could not be interpreted as
N
Niels 已提交
2400
       JSON object type, so interpreting it as JSON array type is safe.
N
Niels 已提交
2401

N
Niels 已提交
2402 2403
    With the rules described above, the following JSON values cannot be
    expressed by an initializer list:
N
Niels 已提交
2404

N
Niels 已提交
2405 2406 2407 2408 2409
    - 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 已提交
2410 2411 2412 2413 2414

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

N
Niels 已提交
2417 2418 2419
    @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 已提交
2420 2421
    used by the functions @ref array(std::initializer_list<basic_json>) and
    @ref object(std::initializer_list<basic_json>).
N
Niels 已提交
2422

N
Niels 已提交
2423 2424
    @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 已提交
2425 2426 2427
    value_t::array and @ref value_t::object are valid); when @a type_deduction
    is set to `true`, this parameter has no effect

2428 2429
    @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
2430 2431 2432 2433
    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 已提交
2434 2435 2436 2437

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

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

N
Niels 已提交
2440
    @sa @ref array(std::initializer_list<basic_json>) -- create a JSON array
2441
    value from an initializer list
N
Niels 已提交
2442
    @sa @ref object(std::initializer_list<basic_json>) -- create a JSON object
2443 2444
    value from an initializer list

N
Niels 已提交
2445
    @since version 1.0.0
N
Niels 已提交
2446
    */
N
Niels 已提交
2447 2448
    basic_json(std::initializer_list<basic_json> init,
               bool type_deduction = true,
N
Niels 已提交
2449
               value_t manual_type = value_t::array)
N
Niels 已提交
2450
    {
N
Niels 已提交
2451 2452
        // check if each element is an array with two elements whose first
        // element is a string
N
Niels 已提交
2453 2454
        bool is_an_object = std::all_of(init.begin(), init.end(),
                                        [](const basic_json & element)
N
Niels 已提交
2455
        {
N
Niels 已提交
2456 2457
            return element.is_array() and element.size() == 2 and element[0].is_string();
        });
N
Niels 已提交
2458 2459 2460 2461 2462 2463 2464

        // 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)
            {
2465
                is_an_object = false;
N
Niels 已提交
2466 2467 2468
            }

            // if object is wanted but impossible, throw an exception
2469
            if (manual_type == value_t::object and not is_an_object)
N
Niels 已提交
2470
            {
2471
                JSON_THROW(type_error::create(301, "cannot create object from initializer list"));
N
Niels 已提交
2472 2473 2474
            }
        }

2475
        if (is_an_object)
N
Niels 已提交
2476 2477 2478
        {
            // the initializer list is a list of pairs -> create object
            m_type = value_t::object;
N
Niels 已提交
2479
            m_value = value_t::object;
N
Niels 已提交
2480

N
Niels 已提交
2481
            std::for_each(init.begin(), init.end(), [this](const basic_json & element)
N
Niels 已提交
2482
            {
N
Niels 已提交
2483
                m_value.object->emplace(*(element[0].m_value.string), element[1]);
N
Niels 已提交
2484
            });
N
Niels 已提交
2485 2486 2487 2488 2489
        }
        else
        {
            // the initializer list describes an array -> create array
            m_type = value_t::array;
N
Niels 已提交
2490
            m_value.array = create<array_t>(init);
N
Niels 已提交
2491
        }
2492 2493

        assert_invariant();
N
Niels 已提交
2494 2495
    }

N
Niels 已提交
2496 2497 2498 2499 2500 2501 2502
    /*!
    @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 已提交
2503 2504
    @note This function is only needed to express two edge cases that cannot
    be realized with the initializer list constructor (@ref
N
Niels 已提交
2505 2506
    basic_json(std::initializer_list<basic_json>, bool, value_t)). These cases
    are:
N
Niels 已提交
2507
    1. creating an array whose elements are all pairs whose first element is a
N
Niels 已提交
2508
    string -- in this case, the initializer list constructor would create an
N
Niels 已提交
2509
    object, taking the first elements as keys
N
Niels 已提交
2510
    2. creating an empty array -- passing the empty initializer list to the
N
Niels 已提交
2511 2512
    initializer list constructor yields an empty object

N
Niels 已提交
2513
    @param[in] init  initializer list with JSON values to create an array from
N
Niels 已提交
2514 2515 2516 2517 2518 2519
    (optional)

    @return JSON array value

    @complexity Linear in the size of @a init.

N
Niels 已提交
2520
    @liveexample{The following code shows an example for the `array`
N
Niels 已提交
2521 2522
    function.,array}

2523 2524 2525 2526 2527
    @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 已提交
2528
    @since version 1.0.0
N
Niels 已提交
2529
    */
N
Niels 已提交
2530
    static basic_json array(std::initializer_list<basic_json> init =
T
Théo DELRIEU 已提交
2531
                                std::initializer_list<basic_json>())
N
Niels 已提交
2532
    {
N
Niels 已提交
2533
        return basic_json(init, false, value_t::array);
N
Niels 已提交
2534 2535
    }

N
Niels 已提交
2536 2537 2538 2539
    /*!
    @brief explicitly create an object from an initializer list

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

    @note This function is only added for symmetry reasons. In contrast to the
2544 2545 2546
    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
2547
    constructor @ref basic_json(std::initializer_list<basic_json>, bool, value_t).
N
Niels 已提交
2548

N
Niels 已提交
2549
    @param[in] init  initializer list to create an object from (optional)
N
Niels 已提交
2550 2551 2552

    @return JSON object value

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

    @complexity Linear in the size of @a init.

N
Niels 已提交
2561
    @liveexample{The following code shows an example for the `object`
N
Niels 已提交
2562 2563
    function.,object}

2564 2565 2566 2567 2568
    @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 已提交
2569
    @since version 1.0.0
N
Niels 已提交
2570
    */
N
Niels 已提交
2571
    static basic_json object(std::initializer_list<basic_json> init =
T
Théo DELRIEU 已提交
2572
                                 std::initializer_list<basic_json>())
N
Niels 已提交
2573
    {
N
Niels 已提交
2574
        return basic_json(init, false, value_t::object);
N
Niels 已提交
2575 2576
    }

N
Niels 已提交
2577 2578 2579
    /*!
    @brief construct an array with count copies of given value

N
Niels 已提交
2580 2581
    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,
2582
    `std::distance(begin(),end()) == cnt` holds.
N
Niels 已提交
2583

2584 2585
    @param[in] cnt  the number of JSON copies of @a val to create
    @param[in] val  the JSON value to copy
N
Niels 已提交
2586

2587
    @complexity Linear in @a cnt.
N
Niels 已提交
2588 2589 2590 2591

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

N
Niels 已提交
2593
    @since version 1.0.0
N
Niels 已提交
2594
    */
2595
    basic_json(size_type cnt, const basic_json& val)
N
Niels 已提交
2596 2597
        : m_type(value_t::array)
    {
2598
        m_value.array = create<array_t>(cnt, val);
2599
        assert_invariant();
N
Niels 已提交
2600
    }
N
Niels 已提交
2601

N
Niels 已提交
2602 2603 2604 2605 2606
    /*!
    @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 已提交
2607
    - In case of primitive types (number, boolean, or string), @a first must
N
Niels 已提交
2608
      be `begin()` and @a last must be `end()`. In this case, the value is
2609
      copied. Otherwise, invalid_iterator.204 is thrown.
N
Niels 已提交
2610 2611
    - In case of structured types (array, object), the constructor behaves as
      similar versions for `std::vector`.
2612
    - In case of a null type, invalid_iterator.206 is thrown.
N
Niels 已提交
2613 2614 2615 2616 2617 2618 2619

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

2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635
    @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 已提交
2636 2637 2638 2639 2640

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

N
Niels 已提交
2642
    @since version 1.0.0
N
Niels 已提交
2643
    */
N
Niels 已提交
2644 2645 2646
    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 已提交
2647
    basic_json(InputIT first, InputIT last)
N
Niels 已提交
2648
    {
N
Niels 已提交
2649 2650 2651
        assert(first.m_object != nullptr);
        assert(last.m_object != nullptr);

N
Niels 已提交
2652
        // make sure iterator fits the current value
N
Niels 已提交
2653
        if (first.m_object != last.m_object)
N
Niels 已提交
2654
        {
2655
            JSON_THROW(invalid_iterator::create(201, "iterators are not compatible"));
N
Niels 已提交
2656 2657
        }

N
Niels 已提交
2658 2659 2660
        // copy type from first iterator
        m_type = first.m_object->m_type;

N
Niels 已提交
2661
        // check if iterator range is complete for primitive values
N
Niels 已提交
2662 2663 2664
        switch (m_type)
        {
            case value_t::boolean:
2665 2666
            case value_t::number_float:
            case value_t::number_integer:
2667
            case value_t::number_unsigned:
N
Niels 已提交
2668 2669
            case value_t::string:
            {
2670
                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
N
Niels 已提交
2671
                {
2672
                    JSON_THROW(invalid_iterator::create(204, "iterators out of range"));
N
Niels 已提交
2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689
                }
                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 已提交
2690

2691 2692 2693 2694 2695
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = first.m_object->m_value.number_unsigned;
                break;
            }
N
Niels 已提交
2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710

            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 已提交
2711
                m_value = *first.m_object->m_value.string;
N
Niels 已提交
2712 2713 2714 2715 2716
                break;
            }

            case value_t::object:
            {
N
Niels Lohmann 已提交
2717 2718
                m_value.object = create<object_t>(first.m_it.object_iterator,
                                                  last.m_it.object_iterator);
N
Niels 已提交
2719 2720 2721 2722 2723
                break;
            }

            case value_t::array:
            {
N
Niels Lohmann 已提交
2724 2725
                m_value.array = create<array_t>(first.m_it.array_iterator,
                                                last.m_it.array_iterator);
N
Niels 已提交
2726 2727 2728 2729 2730
                break;
            }

            default:
            {
2731 2732
                JSON_THROW(invalid_iterator::create(206, "cannot construct with iterators from " +
                                                    first.m_object->type_name()));
N
Niels 已提交
2733 2734
            }
        }
2735 2736

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

N
Niels 已提交
2739

N
Niels 已提交
2740 2741 2742 2743
    ///////////////////////////////////////
    // other constructors and destructor //
    ///////////////////////////////////////

N
Niels 已提交
2744 2745
    /*!
    @brief copy constructor
N
Niels 已提交
2746

N
Niels 已提交
2747 2748
    Creates a copy of a given JSON value.

N
Niels 已提交
2749
    @param[in] other  the JSON value to copy
N
Niels 已提交
2750 2751 2752

    @complexity Linear in the size of @a other.

N
Niels 已提交
2753 2754 2755
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2756 2757 2758 2759
    - The complexity is linear.
    - As postcondition, it holds: `other == basic_json(other)`.

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

N
Niels 已提交
2762
    @since version 1.0.0
N
Niels 已提交
2763
    */
N
Niels 已提交
2764
    basic_json(const basic_json& other)
N
Niels 已提交
2765 2766
        : m_type(other.m_type)
    {
2767 2768 2769
        // check of passed value is valid
        other.assert_invariant();

N
Niels 已提交
2770 2771
        switch (m_type)
        {
2772
            case value_t::object:
N
Niels 已提交
2773
            {
N
Niels 已提交
2774
                m_value = *other.m_value.object;
N
Niels 已提交
2775 2776
                break;
            }
N
Niels 已提交
2777

2778
            case value_t::array:
N
Niels 已提交
2779
            {
N
Niels 已提交
2780
                m_value = *other.m_value.array;
N
Niels 已提交
2781 2782
                break;
            }
N
Niels 已提交
2783

2784
            case value_t::string:
N
Niels 已提交
2785
            {
N
Niels 已提交
2786
                m_value = *other.m_value.string;
N
Niels 已提交
2787 2788
                break;
            }
N
Niels 已提交
2789

2790
            case value_t::boolean:
N
Niels 已提交
2791
            {
N
Niels 已提交
2792
                m_value = other.m_value.boolean;
N
Niels 已提交
2793 2794
                break;
            }
N
Niels 已提交
2795

2796
            case value_t::number_integer:
N
Niels 已提交
2797
            {
N
Niels 已提交
2798
                m_value = other.m_value.number_integer;
N
Niels 已提交
2799 2800
                break;
            }
N
Niels 已提交
2801

2802 2803 2804 2805 2806
            case value_t::number_unsigned:
            {
                m_value = other.m_value.number_unsigned;
                break;
            }
N
Niels 已提交
2807

2808
            case value_t::number_float:
N
Niels 已提交
2809
            {
N
Niels 已提交
2810
                m_value = other.m_value.number_float;
N
Niels 已提交
2811 2812
                break;
            }
2813 2814 2815 2816 2817

            default:
            {
                break;
            }
N
Niels 已提交
2818
        }
2819 2820

        assert_invariant();
N
Niels 已提交
2821 2822
    }

N
Niels 已提交
2823 2824 2825 2826 2827 2828 2829
    /*!
    @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 已提交
2830
    @param[in,out] other  value to move to this object
N
Niels 已提交
2831 2832 2833 2834 2835 2836 2837

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

N
Niels 已提交
2839
    @since version 1.0.0
N
Niels 已提交
2840
    */
N
Niels 已提交
2841
    basic_json(basic_json&& other) noexcept
N
Niels 已提交
2842 2843
        : m_type(std::move(other.m_type)),
          m_value(std::move(other.m_value))
N
Niels 已提交
2844
    {
2845 2846 2847
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2848
        // invalidate payload
N
Niels 已提交
2849 2850
        other.m_type = value_t::null;
        other.m_value = {};
2851 2852

        assert_invariant();
N
Niels 已提交
2853 2854
    }

N
Niels 已提交
2855 2856
    /*!
    @brief copy assignment
N
Niels 已提交
2857

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

N
Niels 已提交
2862
    @param[in] other  value to copy from
N
Niels 已提交
2863 2864 2865

    @complexity Linear.

N
Niels 已提交
2866 2867 2868
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2869 2870
    - The complexity is linear.

N
Niels 已提交
2871 2872 2873 2874
    @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 已提交
2875

N
Niels 已提交
2876
    @since version 1.0.0
N
Niels 已提交
2877
    */
N
Niels 已提交
2878
    reference& operator=(basic_json other) noexcept (
N
Niels 已提交
2879 2880 2881 2882
        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 已提交
2883
    )
N
Niels 已提交
2884
    {
2885 2886 2887
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2888
        using std::swap;
N
Cleanup  
Niels 已提交
2889 2890
        swap(m_type, other.m_type);
        swap(m_value, other.m_value);
2891 2892

        assert_invariant();
N
Niels 已提交
2893 2894 2895
        return *this;
    }

2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913
    /*!
    @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 已提交
2914

2915 2916 2917 2918 2919 2920 2921 2922 2923
        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 已提交
2924

2925 2926 2927 2928 2929 2930 2931
            case value_t::array:
            {
                AllocatorType<array_t> alloc;
                alloc.destroy(m_value.array);
                alloc.deallocate(m_value.array, 1);
                break;
            }
2932

2933 2934 2935 2936 2937 2938 2939
            case value_t::string:
            {
                AllocatorType<string_t> alloc;
                alloc.destroy(m_value.string);
                alloc.deallocate(m_value.string, 1);
                break;
            }
2940

2941 2942 2943 2944 2945 2946
            default:
            {
                // all other types need no specific destructor
                break;
            }
        }
N
Niels 已提交
2947 2948
    }

N
Niels 已提交
2949
    /// @}
N
Niels 已提交
2950 2951 2952 2953 2954 2955

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

N
Niels 已提交
2956
    /// @name object inspection
N
Niels 已提交
2957
    /// Functions to inspect the type of a JSON value.
N
Niels 已提交
2958 2959
    /// @{

N
Niels 已提交
2960
    /*!
N
Niels 已提交
2961 2962
    @brief serialization

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

N
Niels 已提交
2967
    @param[in] indent If indent is nonnegative, then array elements and object
N
Niels 已提交
2968
    members will be pretty-printed with that indent level. An indent level of
N
Niels 已提交
2969 2970
    `0` will only insert newlines. `-1` (the default) selects the most compact
    representation.
N
Niels Lohmann 已提交
2971 2972
    @param[in] indent_char The character to use for indentation if @a indent is
    greater than `0`. The default is ` ` (space).
N
Niels 已提交
2973

N
Niels 已提交
2974 2975 2976 2977 2978
    @return string containing the serialization of the JSON value

    @complexity Linear.

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

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

N
Niels Lohmann 已提交
2983
    @since version 1.0.0; indentation character added in version 3.0.0
N
Niels 已提交
2984
    */
2985
    string_t dump(const int indent = -1, const char indent_char = ' ') const
N
Niels 已提交
2986
    {
2987
        string_t result;
2988
        serializer s(output_adapter<char>::create(result), indent_char);
2989

N
Niels 已提交
2990 2991
        if (indent >= 0)
        {
2992
            s.dump(*this, true, static_cast<unsigned int>(indent));
N
Niels 已提交
2993 2994 2995
        }
        else
        {
2996
            s.dump(*this, false, 0);
N
Niels 已提交
2997
        }
N
Niels 已提交
2998

2999
        return result;
N
Niels 已提交
3000 3001
    }

N
Niels 已提交
3002 3003 3004 3005 3006 3007 3008
    /*!
    @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 已提交
3009 3010 3011

    @complexity Constant.

N
Niels 已提交
3012 3013 3014
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3015
    @liveexample{The following code exemplifies `type()` for all JSON
N
Niels 已提交
3016
    types.,type}
N
Niels 已提交
3017

N
Niels 已提交
3018
    @since version 1.0.0
N
Niels 已提交
3019
    */
N
Niels 已提交
3020
    constexpr value_t type() const noexcept
N
Niels 已提交
3021 3022 3023 3024
    {
        return m_type;
    }

N
Niels 已提交
3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035
    /*!
    @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 已提交
3036 3037 3038
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3039
    @liveexample{The following code exemplifies `is_primitive()` for all JSON
N
Niels 已提交
3040
    types.,is_primitive}
N
Niels 已提交
3041

N
Niels 已提交
3042 3043 3044 3045 3046 3047
    @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 已提交
3048
    @since version 1.0.0
N
Niels 已提交
3049
    */
N
Niels 已提交
3050
    constexpr bool is_primitive() const noexcept
N
Niels 已提交
3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064
    {
        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 已提交
3065 3066 3067
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3068
    @liveexample{The following code exemplifies `is_structured()` for all JSON
N
Niels 已提交
3069
    types.,is_structured}
N
Niels 已提交
3070

N
Niels 已提交
3071 3072 3073 3074
    @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 已提交
3075
    @since version 1.0.0
N
Niels 已提交
3076
    */
N
Niels 已提交
3077
    constexpr bool is_structured() const noexcept
N
Niels 已提交
3078 3079 3080 3081
    {
        return is_array() or is_object();
    }

N
Niels 已提交
3082 3083 3084 3085 3086
    /*!
    @brief return whether value is null

    This function returns true iff the JSON value is null.

N
Niels 已提交
3087
    @return `true` if type is null, `false` otherwise.
N
Niels 已提交
3088 3089 3090

    @complexity Constant.

N
Niels 已提交
3091 3092 3093
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3094
    @liveexample{The following code exemplifies `is_null()` for all JSON
N
Niels 已提交
3095
    types.,is_null}
N
Niels 已提交
3096

N
Niels 已提交
3097
    @since version 1.0.0
N
Niels 已提交
3098
    */
N
Niels 已提交
3099
    constexpr bool is_null() const noexcept
N
Niels 已提交
3100 3101 3102 3103
    {
        return m_type == value_t::null;
    }

N
Niels 已提交
3104 3105 3106 3107 3108
    /*!
    @brief return whether value is a boolean

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

N
Niels 已提交
3109
    @return `true` if type is boolean, `false` otherwise.
N
Niels 已提交
3110 3111 3112

    @complexity Constant.

N
Niels 已提交
3113 3114 3115
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3116
    @liveexample{The following code exemplifies `is_boolean()` for all JSON
N
Niels 已提交
3117
    types.,is_boolean}
N
Niels 已提交
3118

N
Niels 已提交
3119
    @since version 1.0.0
N
Niels 已提交
3120
    */
N
Niels 已提交
3121
    constexpr bool is_boolean() const noexcept
N
Niels 已提交
3122 3123 3124 3125
    {
        return m_type == value_t::boolean;
    }

N
Niels 已提交
3126 3127 3128 3129 3130 3131
    /*!
    @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.

3132 3133
    @return `true` if type is number (regardless whether integer, unsigned
    integer or floating-type), `false` otherwise.
N
Niels 已提交
3134 3135 3136

    @complexity Constant.

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

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

N
Niels 已提交
3143
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
3144
    integer number
N
Niels 已提交
3145 3146
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
3147 3148
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
3149
    @since version 1.0.0
N
Niels 已提交
3150
    */
N
Niels 已提交
3151
    constexpr bool is_number() const noexcept
N
Niels 已提交
3152
    {
N
Niels 已提交
3153
        return is_number_integer() or is_number_float();
N
Niels 已提交
3154 3155
    }

N
Niels 已提交
3156 3157 3158
    /*!
    @brief return whether value is an integer number

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

N
Niels 已提交
3162
    @return `true` if type is an integer or unsigned integer number, `false`
3163
    otherwise.
N
Niels 已提交
3164 3165 3166

    @complexity Constant.

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

N
Niels 已提交
3170
    @liveexample{The following code exemplifies `is_number_integer()` for all
N
Niels 已提交
3171
    JSON types.,is_number_integer}
N
Niels 已提交
3172 3173

    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
3174 3175
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
3176 3177
    @sa @ref is_number_float() -- check if value is a floating-point number

N
Niels 已提交
3178
    @since version 1.0.0
N
Niels 已提交
3179
    */
N
Niels 已提交
3180
    constexpr bool is_number_integer() const noexcept
N
Niels 已提交
3181
    {
3182 3183
        return m_type == value_t::number_integer or m_type == value_t::number_unsigned;
    }
N
Niels 已提交
3184

3185 3186 3187
    /*!
    @brief return whether value is an unsigned integer number

N
Niels 已提交
3188 3189
    This function returns true iff the JSON value is an unsigned integer
    number. This excludes floating-point and (signed) integer values.
3190 3191 3192 3193 3194

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

    @complexity Constant.

N
Niels 已提交
3195 3196 3197
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3198
    @liveexample{The following code exemplifies `is_number_unsigned()` for all
N
Niels 已提交
3199 3200
    JSON types.,is_number_unsigned}

3201
    @sa @ref is_number() -- check if value is a number
N
Niels 已提交
3202
    @sa @ref is_number_integer() -- check if value is an integer or unsigned
3203 3204 3205 3206 3207
    integer number
    @sa @ref is_number_float() -- check if value is a floating-point number

    @since version 2.0.0
    */
N
Niels 已提交
3208
    constexpr bool is_number_unsigned() const noexcept
3209 3210
    {
        return m_type == value_t::number_unsigned;
N
Niels 已提交
3211 3212
    }

N
Niels 已提交
3213 3214 3215 3216
    /*!
    @brief return whether value is a floating-point number

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

N
Niels 已提交
3219
    @return `true` if type is a floating-point number, `false` otherwise.
N
Niels 已提交
3220 3221 3222

    @complexity Constant.

N
Niels 已提交
3223 3224 3225
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3226
    @liveexample{The following code exemplifies `is_number_float()` for all
N
Niels 已提交
3227
    JSON types.,is_number_float}
N
Niels 已提交
3228 3229 3230

    @sa @ref is_number() -- check if value is number
    @sa @ref is_number_integer() -- check if value is an integer number
N
Niels 已提交
3231 3232
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
3233

N
Niels 已提交
3234
    @since version 1.0.0
N
Niels 已提交
3235
    */
N
Niels 已提交
3236
    constexpr bool is_number_float() const noexcept
N
Niels 已提交
3237 3238 3239 3240
    {
        return m_type == value_t::number_float;
    }

N
Niels 已提交
3241 3242 3243 3244 3245
    /*!
    @brief return whether value is an object

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

N
Niels 已提交
3246
    @return `true` if type is object, `false` otherwise.
N
Niels 已提交
3247 3248 3249

    @complexity Constant.

N
Niels 已提交
3250 3251 3252
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3253
    @liveexample{The following code exemplifies `is_object()` for all JSON
N
Niels 已提交
3254
    types.,is_object}
N
Niels 已提交
3255

N
Niels 已提交
3256
    @since version 1.0.0
N
Niels 已提交
3257
    */
N
Niels 已提交
3258
    constexpr bool is_object() const noexcept
N
Niels 已提交
3259 3260 3261 3262
    {
        return m_type == value_t::object;
    }

N
Niels 已提交
3263 3264 3265 3266 3267
    /*!
    @brief return whether value is an array

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

N
Niels 已提交
3268
    @return `true` if type is array, `false` otherwise.
N
Niels 已提交
3269 3270 3271

    @complexity Constant.

N
Niels 已提交
3272 3273 3274
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3275
    @liveexample{The following code exemplifies `is_array()` for all JSON
N
Niels 已提交
3276
    types.,is_array}
N
Niels 已提交
3277

N
Niels 已提交
3278
    @since version 1.0.0
N
Niels 已提交
3279
    */
N
Niels 已提交
3280
    constexpr bool is_array() const noexcept
N
Niels 已提交
3281 3282 3283 3284
    {
        return m_type == value_t::array;
    }

N
Niels 已提交
3285 3286 3287 3288 3289
    /*!
    @brief return whether value is a string

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

N
Niels 已提交
3290
    @return `true` if type is string, `false` otherwise.
N
Niels 已提交
3291 3292 3293

    @complexity Constant.

N
Niels 已提交
3294 3295 3296
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3297
    @liveexample{The following code exemplifies `is_string()` for all JSON
N
Niels 已提交
3298
    types.,is_string}
N
Niels 已提交
3299

N
Niels 已提交
3300
    @since version 1.0.0
N
Niels 已提交
3301
    */
N
Niels 已提交
3302
    constexpr bool is_string() const noexcept
N
Niels 已提交
3303 3304 3305 3306
    {
        return m_type == value_t::string;
    }

N
Niels 已提交
3307 3308 3309 3310 3311 3312
    /*!
    @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 已提交
3313 3314 3315 3316
    @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 已提交
3317 3318 3319 3320
    @return `true` if type is discarded, `false` otherwise.

    @complexity Constant.

N
Niels 已提交
3321 3322 3323
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3324
    @liveexample{The following code exemplifies `is_discarded()` for all JSON
N
Niels 已提交
3325
    types.,is_discarded}
N
Niels 已提交
3326

N
Niels 已提交
3327
    @since version 1.0.0
N
Niels 已提交
3328
    */
N
Niels 已提交
3329
    constexpr bool is_discarded() const noexcept
N
Niels 已提交
3330 3331 3332 3333
    {
        return m_type == value_t::discarded;
    }

N
Niels 已提交
3334 3335 3336 3337 3338 3339 3340 3341 3342 3343
    /*!
    @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 已提交
3344 3345 3346
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

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

N
Niels 已提交
3350
    @since version 1.0.0
N
Niels 已提交
3351
    */
N
Niels 已提交
3352
    constexpr operator value_t() const noexcept
N
Niels 已提交
3353 3354 3355 3356
    {
        return m_type;
    }

N
Niels 已提交
3357 3358
    /// @}

N
Niels 已提交
3359
  private:
N
Niels Lohmann 已提交
3360 3361 3362 3363
    //////////////////
    // value access //
    //////////////////

N
Niels 已提交
3364
    /// get a boolean (explicit)
3365
    boolean_t get_impl(boolean_t* /*unused*/) const
N
Niels 已提交
3366
    {
3367 3368 3369 3370
        if (is_boolean())
        {
            return m_value.boolean;
        }
N
Niels Lohmann 已提交
3371

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

N
Niels 已提交
3375
    /// get a pointer to the value (object)
N
Niels Lohmann 已提交
3376
    object_t* get_impl_ptr(object_t* /*unused*/) noexcept
N
Niels 已提交
3377 3378 3379 3380
    {
        return is_object() ? m_value.object : nullptr;
    }

N
Niels 已提交
3381
    /// get a pointer to the value (object)
N
Niels Lohmann 已提交
3382
    constexpr const object_t* get_impl_ptr(const object_t* /*unused*/) const noexcept
N
Niels 已提交
3383 3384 3385 3386 3387
    {
        return is_object() ? m_value.object : nullptr;
    }

    /// get a pointer to the value (array)
N
Niels Lohmann 已提交
3388
    array_t* get_impl_ptr(array_t* /*unused*/) noexcept
N
Niels 已提交
3389 3390 3391 3392
    {
        return is_array() ? m_value.array : nullptr;
    }

N
Niels 已提交
3393
    /// get a pointer to the value (array)
N
Niels Lohmann 已提交
3394
    constexpr const array_t* get_impl_ptr(const array_t* /*unused*/) const noexcept
N
Niels 已提交
3395 3396 3397 3398 3399
    {
        return is_array() ? m_value.array : nullptr;
    }

    /// get a pointer to the value (string)
N
Niels Lohmann 已提交
3400
    string_t* get_impl_ptr(string_t* /*unused*/) noexcept
N
Niels 已提交
3401 3402 3403 3404 3405
    {
        return is_string() ? m_value.string : nullptr;
    }

    /// get a pointer to the value (string)
N
Niels Lohmann 已提交
3406
    constexpr const string_t* get_impl_ptr(const string_t* /*unused*/) const noexcept
N
Niels 已提交
3407 3408 3409 3410 3411
    {
        return is_string() ? m_value.string : nullptr;
    }

    /// get a pointer to the value (boolean)
N
Niels Lohmann 已提交
3412
    boolean_t* get_impl_ptr(boolean_t* /*unused*/) noexcept
N
Niels 已提交
3413 3414 3415 3416 3417
    {
        return is_boolean() ? &m_value.boolean : nullptr;
    }

    /// get a pointer to the value (boolean)
N
Niels Lohmann 已提交
3418
    constexpr const boolean_t* get_impl_ptr(const boolean_t* /*unused*/) const noexcept
N
Niels 已提交
3419 3420 3421 3422 3423
    {
        return is_boolean() ? &m_value.boolean : nullptr;
    }

    /// get a pointer to the value (integer number)
N
Niels Lohmann 已提交
3424
    number_integer_t* get_impl_ptr(number_integer_t* /*unused*/) noexcept
N
Niels 已提交
3425 3426 3427 3428 3429
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }

    /// get a pointer to the value (integer number)
N
Niels Lohmann 已提交
3430
    constexpr const number_integer_t* get_impl_ptr(const number_integer_t* /*unused*/) const noexcept
N
Niels 已提交
3431 3432 3433
    {
        return is_number_integer() ? &m_value.number_integer : nullptr;
    }
N
Niels 已提交
3434

3435
    /// get a pointer to the value (unsigned number)
N
Niels Lohmann 已提交
3436
    number_unsigned_t* get_impl_ptr(number_unsigned_t* /*unused*/) noexcept
3437 3438 3439
    {
        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
    }
N
Niels 已提交
3440

3441
    /// get a pointer to the value (unsigned number)
N
Niels Lohmann 已提交
3442
    constexpr const number_unsigned_t* get_impl_ptr(const number_unsigned_t* /*unused*/) const noexcept
3443 3444 3445
    {
        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
    }
N
Niels 已提交
3446

N
Niels 已提交
3447
    /// get a pointer to the value (floating-point number)
N
Niels Lohmann 已提交
3448
    number_float_t* get_impl_ptr(number_float_t* /*unused*/) noexcept
N
Niels 已提交
3449 3450 3451 3452 3453
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

    /// get a pointer to the value (floating-point number)
N
Niels Lohmann 已提交
3454
    constexpr const number_float_t* get_impl_ptr(const number_float_t* /*unused*/) const noexcept
N
Niels 已提交
3455 3456 3457 3458
    {
        return is_number_float() ? &m_value.number_float : nullptr;
    }

N
Niels 已提交
3459 3460 3461
    /*!
    @brief helper function to implement get_ref()

N
Niels Lohmann 已提交
3462
    This function helps to implement get_ref() without code duplication for
N
Niels 已提交
3463 3464 3465 3466
    const and non-const overloads

    @tparam ThisType will be deduced as `basic_json` or `const basic_json`

3467
    @throw type_error.303 if ReferenceType does not match underlying value
N
Niels 已提交
3468 3469 3470
    type of the current JSON
    */
    template<typename ReferenceType, typename ThisType>
3471
    static ReferenceType get_ref_impl(ThisType& obj)
D
dariomt 已提交
3472
    {
N
Niels 已提交
3473
        // helper type
N
Niels 已提交
3474 3475
        using PointerType = typename std::add_pointer<ReferenceType>::type;

N
Niels 已提交
3476
        // delegate the call to get_ptr<>()
3477 3478 3479 3480 3481 3482
        auto ptr = obj.template get_ptr<PointerType>();

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

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

N
Niels 已提交
3487
  public:
N
Niels Lohmann 已提交
3488 3489 3490 3491
    /// @name value access
    /// Direct access to the stored value of a JSON value.
    /// @{

T
Théo DELRIEU 已提交
3492 3493 3494
    /*!
    @brief get special-case overload

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

N
Niels Lohmann 已提交
3498
    @tparam BasicJsonType == @ref basic_json
T
Théo DELRIEU 已提交
3499 3500 3501 3502 3503 3504 3505

    @return a copy of *this

    @complexity Constant.

    @since version 2.1.0
    */
3506
    template <
N
Niels Lohmann 已提交
3507 3508
        typename BasicJsonType,
        detail::enable_if_t<std::is_same<typename std::remove_const<BasicJsonType>::type,
3509 3510
                                         basic_json_t>::value,
                            int> = 0 >
3511 3512
    basic_json get() const
    {
T
Théo DELRIEU 已提交
3513
        return *this;
3514 3515
    }

T
Théo DELRIEU 已提交
3516
    /*!
N
Niels Lohmann 已提交
3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530
    @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 已提交
3531 3532

    This overloads is chosen if:
N
Niels Lohmann 已提交
3533 3534
    - @a ValueType is not @ref basic_json,
    - @ref json_serializer<ValueType> has a `from_json()` method of the form
郭荣飞 已提交
3535
      `void from_json(const basic_json&, ValueType&)`, and
N
Niels Lohmann 已提交
3536
    - @ref json_serializer<ValueType> does not have a `from_json()` method of
郭荣飞 已提交
3537
      the form `ValueType from_json(const basic_json&)`
N
Niels Lohmann 已提交
3538 3539 3540

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

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

N
Niels Lohmann 已提交
3544 3545 3546 3547 3548 3549 3550 3551
    @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 已提交
3552 3553 3554

    @since version 2.1.0
    */
T
Théo DELRIEU 已提交
3555
    template <
N
Niels Lohmann 已提交
3556 3557
        typename ValueTypeCV,
        typename ValueType = detail::uncvref_t<ValueTypeCV>,
3558
        detail::enable_if_t <
N
Niels Lohmann 已提交
3559 3560 3561
            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 已提交
3562
            int > = 0 >
N
Niels Lohmann 已提交
3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575
    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 已提交
3576
        return ret;
3577
    }
3578

T
Théo DELRIEU 已提交
3579
    /*!
N
Niels Lohmann 已提交
3580 3581 3582 3583 3584 3585 3586
    @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 已提交
3587

N
Niels Lohmann 已提交
3588 3589 3590 3591
    The function is equivalent to executing
    @code {.cpp}
    return JSONSerializer<ValueTypeCV>::from_json(*this);
    @endcode
T
Théo DELRIEU 已提交
3592 3593

    This overloads is chosen if:
N
Niels Lohmann 已提交
3594 3595
    - @a ValueType is not @ref basic_json and
    - @ref json_serializer<ValueType> has a `from_json()` method of the form
郭荣飞 已提交
3596
      `ValueType from_json(const basic_json&)`
N
Niels Lohmann 已提交
3597 3598 3599 3600 3601 3602

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

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

N
Niels Lohmann 已提交
3606
    @throw what @ref json_serializer<ValueType> `from_json()` method throws
T
Théo DELRIEU 已提交
3607 3608 3609

    @since version 2.1.0
    */
3610
    template <
N
Niels Lohmann 已提交
3611 3612 3613
        typename ValueTypeCV,
        typename ValueType = detail::uncvref_t<ValueTypeCV>,
        detail::enable_if_t<not std::is_same<basic_json_t, ValueType>::value and
3614
                            detail::has_non_default_from_json<basic_json_t,
N
Niels Lohmann 已提交
3615 3616 3617
                                    ValueType>::value, int> = 0 >
    ValueType get() const noexcept(noexcept(
                                       JSONSerializer<ValueTypeCV>::from_json(std::declval<const basic_json_t&>())))
3618
    {
N
Niels Lohmann 已提交
3619 3620 3621
        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);
3622 3623
    }

N
Niels 已提交
3624 3625 3626 3627 3628 3629
    /*!
    @brief get a pointer value (explicit)

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

N
Niels 已提交
3630 3631
    @warning The pointer becomes invalid if the underlying JSON object
    changes.
N
Niels 已提交
3632 3633

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

N
Niels 已提交
3637 3638
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
3639 3640 3641 3642 3643 3644 3645 3646 3647

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

N
Niels 已提交
3649
    @since version 1.0.0
N
Niels 已提交
3650
    */
N
Niels 已提交
3651 3652
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3653 3654 3655 3656 3657 3658 3659 3660 3661 3662
    PointerType get() noexcept
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

    /*!
    @brief get a pointer value (explicit)
    @copydoc get()
    */
N
Niels 已提交
3663 3664
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3665
    constexpr const PointerType get() const noexcept
N
Niels 已提交
3666 3667 3668 3669 3670 3671 3672 3673
    {
        // delegate the call to get_ptr
        return get_ptr<PointerType>();
    }

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

N
Niels 已提交
3674
    Implicit pointer access to the internally stored JSON value. No copies are
N
Niels 已提交
3675 3676 3677 3678 3679 3680
    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 已提交
3681
    object_t, @ref string_t, @ref boolean_t, @ref number_integer_t,
N
Niels 已提交
3682 3683
    @ref number_unsigned_t, or @ref number_float_t. Enforced by a static
    assertion.
N
Niels 已提交
3684

N
Niels 已提交
3685 3686
    @return pointer to the internally stored JSON value if the requested
    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
N
Niels 已提交
3687 3688 3689 3690 3691 3692 3693

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

N
Niels 已提交
3695
    @since version 1.0.0
N
Niels 已提交
3696
    */
N
Niels 已提交
3697 3698
    template<typename PointerType, typename std::enable_if<
                 std::is_pointer<PointerType>::value, int>::type = 0>
N
Niels 已提交
3699 3700
    PointerType get_ptr() noexcept
    {
N
Niels 已提交
3701 3702
        // get the type of the PointerType (remove pointer and const)
        using pointee_t = typename std::remove_const<typename
T
Théo DELRIEU 已提交
3703 3704
                          std::remove_pointer<typename
                          std::remove_const<PointerType>::type>::type>::type;
N
Niels 已提交
3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715
        // 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 已提交
3716 3717 3718 3719 3720 3721 3722 3723
        // 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 已提交
3724 3725 3726
    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 已提交
3727
    constexpr const PointerType get_ptr() const noexcept
N
Niels 已提交
3728
    {
N
Niels 已提交
3729 3730
        // get the type of the PointerType (remove pointer and const)
        using pointee_t = typename std::remove_const<typename
T
Théo DELRIEU 已提交
3731 3732
                          std::remove_pointer<typename
                          std::remove_const<PointerType>::type>::type>::type;
N
Niels 已提交
3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743
        // 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 已提交
3744
        // delegate the call to get_impl_ptr<>() const
D
dariomt 已提交
3745
        return get_impl_ptr(static_cast<const PointerType>(nullptr));
D
dariomt 已提交
3746 3747
    }

N
Niels 已提交
3748
    /*!
D
dariomt 已提交
3749 3750
    @brief get a reference value (implicit)

N
Niels Lohmann 已提交
3751
    Implicit reference access to the internally stored JSON value. No copies
N
Niels 已提交
3752
    are made.
D
dariomt 已提交
3753 3754 3755 3756

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

N
Niels 已提交
3757 3758
    @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 已提交
3759
    @ref number_float_t. Enforced by static assertion.
D
dariomt 已提交
3760

N
Niels 已提交
3761 3762
    @return reference to the internally stored JSON value if the requested
    reference type @a ReferenceType fits to the JSON value; throws
3763
    type_error.303 otherwise
D
dariomt 已提交
3764

3765
    @throw type_error.303 in case passed type @a ReferenceType is incompatible
3766
    with the stored JSON value; see example below
D
dariomt 已提交
3767 3768

    @complexity Constant.
N
Niels 已提交
3769 3770 3771

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

N
Niels 已提交
3772
    @since version 1.1.0
D
dariomt 已提交
3773
    */
N
Niels 已提交
3774 3775
    template<typename ReferenceType, typename std::enable_if<
                 std::is_reference<ReferenceType>::value, int>::type = 0>
D
dariomt 已提交
3776 3777
    ReferenceType get_ref()
    {
N
Niels 已提交
3778 3779
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
D
dariomt 已提交
3780 3781 3782 3783 3784 3785
    }

    /*!
    @brief get a reference value (implicit)
    @copydoc get_ref()
    */
N
Niels 已提交
3786 3787 3788
    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>
3789
    ReferenceType get_ref() const
D
dariomt 已提交
3790
    {
N
Niels 已提交
3791 3792
        // delegate call to get_ref_impl
        return get_ref_impl<ReferenceType>(*this);
N
Niels 已提交
3793 3794 3795 3796 3797
    }

    /*!
    @brief get a value (implicit)

N
Niels 已提交
3798 3799
    Implicit type conversion between the JSON value and a compatible value.
    The call is realized by calling @ref get() const.
N
Niels 已提交
3800 3801 3802

    @tparam ValueType non-pointer type compatible to the JSON value, for
    instance `int` for JSON integer numbers, `bool` for JSON booleans, or
N
Niels 已提交
3803 3804 3805
    `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 已提交
3806 3807 3808

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

N
Niels Lohmann 已提交
3809
    @throw type_error.302 in case passed type @a ValueType is incompatible
3810 3811
    to the JSON value type (e.g., the JSON value is of type boolean, but a
    string is requested); see example below
N
Niels 已提交
3812 3813 3814

    @complexity Linear in the size of the JSON value.

N
Niels 已提交
3815
    @liveexample{The example below shows several conversions from JSON values
N
Niels 已提交
3816 3817 3818
    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 已提交
3819
    associative containers such as `std::unordered_map<std::string\,
N
Niels 已提交
3820
    json>`.,operator__ValueType}
N
Niels 已提交
3821

N
Niels 已提交
3822
    @since version 1.0.0
N
Niels 已提交
3823
    */
N
Niels 已提交
3824 3825 3826
    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 已提交
3827
#ifndef _MSC_VER  // fix for issue #167 operator<< ambiguity under VS2015
N
Niels 已提交
3828
                   and not std::is_same<ValueType, std::initializer_list<typename string_t::value_type>>::value
N
Niels Lohmann 已提交
3829
#endif
3830
#if (defined(__cplusplus) && __cplusplus >= 201703L) || (defined(_MSC_VER) && _MSC_VER >1900 && defined(_HAS_CXX17) && _HAS_CXX17 == 1) // fix for issue #464
N
Niels Lohmann 已提交
3831
                   and not std::is_same<ValueType, typename std::string_view>::value
3832
#endif
N
Niels 已提交
3833
                   , int >::type = 0 >
N
Niels 已提交
3834
    operator ValueType() const
N
Niels 已提交
3835
    {
N
Niels 已提交
3836 3837
        // delegate the call to get<>() const
        return get<ValueType>();
N
Niels 已提交
3838 3839
    }

N
Niels 已提交
3840 3841
    /// @}

N
Niels 已提交
3842 3843 3844 3845 3846

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

N
Niels 已提交
3847
    /// @name element access
N
Niels 已提交
3848
    /// Access to the JSON value.
N
Niels 已提交
3849 3850
    /// @{

N
Niels 已提交
3851 3852 3853 3854 3855 3856 3857 3858 3859 3860
    /*!
    @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

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

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

3869
    @complexity Constant.
N
Niels 已提交
3870

N
Niels 已提交
3871
    @since version 1.0.0
3872 3873 3874 3875

    @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 已提交
3876
    */
N
Niels 已提交
3877
    reference at(size_type idx)
N
Niels 已提交
3878 3879
    {
        // at only works for arrays
3880 3881
        if (is_array())
        {
3882
            JSON_TRY
N
Niels 已提交
3883 3884 3885
            {
                return m_value.array->at(idx);
            }
3886
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3887 3888
            {
                // create better exception explanation
3889
                JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
3890
            }
3891 3892
        }
        else
N
Niels 已提交
3893
        {
3894
            JSON_THROW(type_error::create(304, "cannot use at() with " + type_name()));
N
Niels 已提交
3895 3896 3897
        }
    }

N
Niels 已提交
3898 3899 3900
    /*!
    @brief access specified array element with bounds checking

N
Niels 已提交
3901 3902
    Returns a const reference to the element at specified location @a idx,
    with bounds checking.
N
Niels 已提交
3903 3904 3905 3906 3907

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

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

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

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

3916
    @complexity Constant.
N
Niels 已提交
3917

N
Niels 已提交
3918
    @since version 1.0.0
3919 3920 3921 3922

    @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 已提交
3923
    */
N
Niels 已提交
3924
    const_reference at(size_type idx) const
N
Niels 已提交
3925 3926
    {
        // at only works for arrays
3927 3928
        if (is_array())
        {
3929
            JSON_TRY
N
Niels 已提交
3930 3931 3932
            {
                return m_value.array->at(idx);
            }
3933
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3934 3935
            {
                // create better exception explanation
3936
                JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
3937
            }
3938 3939
        }
        else
N
Niels 已提交
3940
        {
3941
            JSON_THROW(type_error::create(304, "cannot use at() with " + type_name()));
N
Niels 已提交
3942
        }
3943 3944
    }

N
Niels 已提交
3945 3946 3947 3948 3949 3950 3951 3952 3953 3954
    /*!
    @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

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

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

3963
    @complexity Logarithmic in the size of the container.
N
Niels 已提交
3964 3965 3966 3967

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

N
Niels 已提交
3969
    @since version 1.0.0
3970 3971 3972 3973

    @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 已提交
3974
    */
N
Niels 已提交
3975
    reference at(const typename object_t::key_type& key)
3976 3977
    {
        // at only works for objects
3978 3979
        if (is_object())
        {
3980
            JSON_TRY
N
Niels 已提交
3981 3982 3983
            {
                return m_value.object->at(key);
            }
3984
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
3985 3986
            {
                // create better exception explanation
3987
                JSON_THROW(out_of_range::create(403, "key '" + key + "' not found"));
N
Niels 已提交
3988
            }
3989 3990
        }
        else
3991
        {
3992
            JSON_THROW(type_error::create(304, "cannot use at() with " + type_name()));
3993 3994 3995
        }
    }

N
Niels 已提交
3996 3997 3998
    /*!
    @brief access specified object element with bounds checking

N
Niels 已提交
3999 4000
    Returns a const reference to the element at with specified key @a key,
    with bounds checking.
N
Niels 已提交
4001 4002 4003 4004 4005

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

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

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

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

4014
    @complexity Logarithmic in the size of the container.
N
Niels 已提交
4015 4016 4017 4018

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

N
Niels 已提交
4020
    @since version 1.0.0
4021 4022 4023 4024

    @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 已提交
4025
    */
N
Niels 已提交
4026
    const_reference at(const typename object_t::key_type& key) const
4027 4028
    {
        // at only works for objects
4029 4030
        if (is_object())
        {
4031
            JSON_TRY
N
Niels 已提交
4032 4033 4034
            {
                return m_value.object->at(key);
            }
4035
            JSON_CATCH (std::out_of_range&)
N
Niels 已提交
4036 4037
            {
                // create better exception explanation
4038
                JSON_THROW(out_of_range::create(403, "key '" + key + "' not found"));
N
Niels 已提交
4039
            }
4040 4041
        }
        else
4042
        {
4043
            JSON_THROW(type_error::create(304, "cannot use at() with " + type_name()));
4044
        }
N
Niels 已提交
4045 4046
    }

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

4060 4061
    @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 已提交
4062 4063 4064 4065 4066

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

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

N
Niels 已提交
4082
        // operator[] only works for arrays
N
cleanup  
Niels 已提交
4083
        if (is_array())
N
Niels 已提交
4084
        {
N
Niels 已提交
4085 4086
            // fill up array with null values if given idx is outside range
            if (idx >= m_value.array->size())
N
cleanup  
Niels 已提交
4087
            {
N
Niels 已提交
4088 4089 4090
                m_value.array->insert(m_value.array->end(),
                                      idx - m_value.array->size() + 1,
                                      basic_json());
N
cleanup  
Niels 已提交
4091
            }
N
Niels 已提交
4092

N
cleanup  
Niels 已提交
4093 4094
            return m_value.array->operator[](idx);
        }
N
Niels Lohmann 已提交
4095

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

N
Niels 已提交
4099 4100 4101 4102 4103 4104 4105 4106 4107
    /*!
    @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

4108 4109
    @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 已提交
4110 4111 4112 4113

    @complexity Constant.

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

N
Niels 已提交
4116
    @since version 1.0.0
N
Niels 已提交
4117
    */
N
Niels 已提交
4118
    const_reference operator[](size_type idx) const
N
Niels 已提交
4119
    {
N
Niels 已提交
4120
        // const operator[] only works for arrays
N
Niels 已提交
4121 4122 4123 4124
        if (is_array())
        {
            return m_value.array->operator[](idx);
        }
N
Niels Lohmann 已提交
4125

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

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

4142 4143
    @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 已提交
4144 4145 4146 4147

    @complexity Logarithmic in the size of the container.

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

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

N
Niels 已提交
4154
    @since version 1.0.0
N
Niels 已提交
4155
    */
N
Niels 已提交
4156
    reference operator[](const typename object_t::key_type& key)
N
Niels 已提交
4157
    {
N
Niels 已提交
4158
        // implicitly convert null value to an empty object
N
cleanup  
Niels 已提交
4159
        if (is_null())
N
Niels 已提交
4160 4161
        {
            m_type = value_t::object;
N
Cleanup  
Niels 已提交
4162
            m_value.object = create<object_t>();
4163
            assert_invariant();
N
Niels 已提交
4164 4165
        }

N
Niels 已提交
4166
        // operator[] only works for objects
N
Niels 已提交
4167 4168 4169 4170
        if (is_object())
        {
            return m_value.object->operator[](key);
        }
N
Niels Lohmann 已提交
4171

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

N
Niels 已提交
4175
    /*!
4176
    @brief read-only access specified object element
N
Niels 已提交
4177

4178 4179 4180 4181 4182
    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 已提交
4183 4184 4185

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

4186
    @return const reference to the element at key @a key
N
Niels 已提交
4187

N
Niels 已提交
4188 4189 4190
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

4191 4192
    @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 已提交
4193 4194 4195 4196

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
4197
    the `[]` operator.,operatorarray__key_type_const}
4198 4199 4200 4201 4202

    @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 已提交
4203
    @since version 1.0.0
N
Niels 已提交
4204
    */
N
Niels 已提交
4205
    const_reference operator[](const typename object_t::key_type& key) const
4206
    {
N
Niels 已提交
4207
        // const operator[] only works for objects
N
Niels 已提交
4208 4209 4210 4211 4212
        if (is_object())
        {
            assert(m_value.object->find(key) != m_value.object->end());
            return m_value.object->find(key)->second;
        }
N
Niels Lohmann 已提交
4213

4214
        JSON_THROW(type_error::create(305, "cannot use operator[] with " + type_name()));
4215 4216
    }

N
Niels 已提交
4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229
    /*!
    @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

4230 4231
    @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 已提交
4232 4233 4234 4235

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read and
N
Niels 已提交
4236
    written using the `[]` operator.,operatorarray__key_type}
N
Niels 已提交
4237 4238

    @sa @ref at(const typename object_t::key_type&) for access by reference
4239 4240 4241
    with range checking
    @sa @ref value() for access by value with a default value

N
Niels 已提交
4242
    @since version 1.1.0
4243 4244 4245
    */
    template<typename T>
    reference operator[](T* key)
N
Niels 已提交
4246
    {
N
Niels 已提交
4247
        // implicitly convert null to object
N
cleanup  
Niels 已提交
4248
        if (is_null())
N
Niels 已提交
4249 4250
        {
            m_type = value_t::object;
N
Niels 已提交
4251
            m_value = value_t::object;
4252
            assert_invariant();
N
Niels 已提交
4253 4254
        }

N
Niels 已提交
4255
        // at only works for objects
N
Niels 已提交
4256 4257 4258 4259
        if (is_object())
        {
            return m_value.object->operator[](key);
        }
N
Niels Lohmann 已提交
4260

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

N
Niels 已提交
4264
    /*!
4265
    @brief read-only access specified object element
N
Niels 已提交
4266

4267 4268 4269 4270 4271
    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 已提交
4272 4273 4274

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

4275
    @return const reference to the element at key @a key
N
Niels 已提交
4276

N
Niels 已提交
4277 4278 4279
    @pre The element with key @a key must exist. **This precondition is
         enforced with an assertion.**

4280 4281
    @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 已提交
4282 4283 4284 4285

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be read using
N
Niels 已提交
4286
    the `[]` operator.,operatorarray__key_type_const}
4287 4288 4289 4290 4291

    @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 已提交
4292
    @since version 1.1.0
N
Niels 已提交
4293
    */
4294 4295
    template<typename T>
    const_reference operator[](T* key) const
4296 4297
    {
        // at only works for objects
N
Niels 已提交
4298 4299 4300 4301 4302
        if (is_object())
        {
            assert(m_value.object->find(key) != m_value.object->end());
            return m_value.object->find(key)->second;
        }
N
Niels Lohmann 已提交
4303

4304
        JSON_THROW(type_error::create(305, "cannot use operator[] with " + type_name()));
4305 4306
    }

N
Niels 已提交
4307 4308 4309
    /*!
    @brief access specified object element with default value

N
Niels 已提交
4310 4311
    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.
4312

N
Niels 已提交
4313
    The function is basically equivalent to executing
4314
    @code {.cpp}
N
Niels 已提交
4315 4316
    try {
        return at(key);
4317
    } catch(out_of_range) {
N
Niels 已提交
4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339
        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

4340 4341
    @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 已提交
4342 4343 4344 4345 4346 4347 4348 4349 4350 4351

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

N
Niels 已提交
4353
    @since version 1.0.0
N
Niels 已提交
4354
    */
N
Niels 已提交
4355 4356
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367
    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 已提交
4368 4369

            return default_value;
N
Niels 已提交
4370 4371 4372
        }
        else
        {
4373
            JSON_THROW(type_error::create(306, "cannot use value() with " + type_name()));
N
Niels 已提交
4374 4375 4376 4377
        }
    }

    /*!
N
Niels 已提交
4378
    @brief overload for a default value of type const char*
N
Niels 已提交
4379
    @copydoc basic_json::value(const typename object_t::key_type&, ValueType) const
N
Niels 已提交
4380 4381 4382 4383
    */
    string_t value(const typename object_t::key_type& key, const char* default_value) const
    {
        return value(key, string_t(default_value));
4384 4385
    }

N
Niels 已提交
4386 4387 4388
    /*!
    @brief access specified object element via JSON Pointer with default value

N
Niels 已提交
4389 4390 4391 4392 4393 4394 4395
    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);
4396
    } catch(out_of_range) {
N
Niels 已提交
4397 4398 4399 4400 4401 4402 4403
        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 已提交
4404 4405 4406 4407 4408 4409 4410 4411
    @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 已提交
4412 4413 4414
    @return copy of the element at key @a key or @a default_value if @a key
    is not found

4415 4416
    @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 已提交
4417 4418 4419 4420 4421 4422

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

N
Niels 已提交
4425 4426
    @since version 2.0.2
    */
N
Niels 已提交
4427 4428
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
4429 4430 4431 4432 4433 4434
    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
4435
            JSON_TRY
N
Niels 已提交
4436 4437 4438
            {
                return ptr.get_checked(this);
            }
4439
            JSON_CATCH (out_of_range&)
N
Niels 已提交
4440 4441 4442 4443
            {
                return default_value;
            }
        }
N
Niels Lohmann 已提交
4444

4445
        JSON_THROW(type_error::create(306, "cannot use value() with " + type_name()));
N
Niels 已提交
4446 4447 4448 4449
    }

    /*!
    @brief overload for a default value of type const char*
N
Niels 已提交
4450
    @copydoc basic_json::value(const json_pointer&, ValueType) const
N
Niels 已提交
4451 4452 4453 4454 4455 4456
    */
    string_t value(const json_pointer& ptr, const char* default_value) const
    {
        return value(ptr, string_t(default_value));
    }

N
Niels 已提交
4457 4458 4459 4460 4461 4462
    /*!
    @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 已提交
4463
    @return In case of a structured type (array or object), a reference to the
4464
    first element is returned. In case of number, string, or boolean values, a
N
Niels 已提交
4465 4466 4467 4468
    reference to the value is returned.

    @complexity Constant.

N
Niels 已提交
4469
    @pre The JSON value must not be `null` (would throw `std::out_of_range`)
N
Niels 已提交
4470 4471
    or an empty array or object (undefined behavior, **guarded by
    assertions**).
N
Niels 已提交
4472 4473
    @post The JSON value remains unchanged.

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

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

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

N
Niels 已提交
4480
    @since version 1.0.0
N
Niels 已提交
4481
    */
N
Niels 已提交
4482
    reference front()
N
Niels 已提交
4483 4484 4485 4486
    {
        return *begin();
    }

N
Niels 已提交
4487 4488 4489
    /*!
    @copydoc basic_json::front()
    */
N
Niels 已提交
4490
    const_reference front() const
N
Niels 已提交
4491 4492 4493 4494
    {
        return *cbegin();
    }

N
Niels 已提交
4495 4496 4497 4498
    /*!
    @brief access the last element

    Returns a reference to the last element in the container. For a JSON
N
Niels 已提交
4499 4500 4501 4502 4503 4504
    container `c`, the expression `c.back()` is equivalent to
    @code {.cpp}
    auto tmp = c.end();
    --tmp;
    return *tmp;
    @endcode
N
Niels 已提交
4505

N
Niels 已提交
4506
    @return In case of a structured type (array or object), a reference to the
4507
    last element is returned. In case of number, string, or boolean values, a
N
Niels 已提交
4508 4509 4510 4511
    reference to the value is returned.

    @complexity Constant.

N
Niels 已提交
4512
    @pre The JSON value must not be `null` (would throw `std::out_of_range`)
N
Niels 已提交
4513 4514
    or an empty array or object (undefined behavior, **guarded by
    assertions**).
N
Niels 已提交
4515
    @post The JSON value remains unchanged.
N
Niels 已提交
4516

4517 4518
    @throw invalid_iterator.214 when called on a `null` value. See example
    below.
N
Niels 已提交
4519

N
Niels 已提交
4520 4521 4522
    @liveexample{The following code shows an example for `back()`.,back}

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

N
Niels 已提交
4524
    @since version 1.0.0
N
Niels 已提交
4525
    */
N
Niels 已提交
4526
    reference back()
N
Niels 已提交
4527 4528 4529 4530 4531 4532
    {
        auto tmp = end();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
4533 4534 4535
    /*!
    @copydoc basic_json::back()
    */
N
Niels 已提交
4536
    const_reference back() const
N
Niels 已提交
4537 4538 4539 4540 4541 4542
    {
        auto tmp = cend();
        --tmp;
        return *tmp;
    }

N
Niels 已提交
4543 4544 4545
    /*!
    @brief remove element given an iterator

N
Niels 已提交
4546 4547 4548
    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 已提交
4549

N
Niels 已提交
4550
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
4551 4552 4553
    will be `null`.

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

4557
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
4558

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

4562 4563
    @throw type_error.307 if called on a `null` value; example: `"cannot use
    erase() with null"`
4564 4565 4566
    @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"`
4567
    @throw invalid_iterator.205 if called on a primitive type with invalid
N
Niels 已提交
4568 4569
    iterator (i.e., any iterator which is not `begin()`); example: `"iterator
    out of range"`
N
Niels 已提交
4570 4571 4572

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

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

4580
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4581
    the given range
N
Niels 已提交
4582
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4583
    from an object at the given key
N
Niels 已提交
4584 4585
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4586

N
Niels 已提交
4587
    @since version 1.0.0
N
Niels 已提交
4588
    */
N
Niels 已提交
4589 4590 4591 4592
    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>
4593
    IteratorType erase(IteratorType pos)
4594 4595
    {
        // make sure iterator fits the current value
N
Niels 已提交
4596
        if (this != pos.m_object)
4597
        {
4598
            JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value"));
4599 4600
        }

4601
        IteratorType result = end();
4602 4603 4604 4605

        switch (m_type)
        {
            case value_t::boolean:
4606 4607
            case value_t::number_float:
            case value_t::number_integer:
4608
            case value_t::number_unsigned:
4609 4610
            case value_t::string:
            {
4611
                if (not pos.m_it.primitive_iterator.is_begin())
4612
                {
4613
                    JSON_THROW(invalid_iterator::create(205, "iterator out of range"));
4614 4615
                }

N
cleanup  
Niels 已提交
4616
                if (is_string())
4617
                {
4618 4619 4620
                    AllocatorType<string_t> alloc;
                    alloc.destroy(m_value.string);
                    alloc.deallocate(m_value.string, 1);
4621 4622 4623 4624
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
4625
                assert_invariant();
4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642
                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:
            {
4643
                JSON_THROW(type_error::create(307, "cannot use erase() with " + type_name()));
4644 4645 4646 4647 4648 4649
            }
        }

        return result;
    }

N
Niels 已提交
4650 4651 4652
    /*!
    @brief remove elements given an iterator range

N
Niels 已提交
4653 4654 4655
    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 已提交
4656

N
Niels 已提交
4657
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
4658 4659 4660 4661 4662
    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 已提交
4663
    second refers to the last element, the `end()` iterator is returned.
N
Niels 已提交
4664

4665
    @tparam IteratorType an @ref iterator or @ref const_iterator
N
Niels 已提交
4666

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

4670 4671
    @throw type_error.307 if called on a `null` value; example: `"cannot use
    erase() with null"`
4672 4673 4674
    @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 已提交
4675 4676
    iterators (i.e., if `first != begin()` and `last != end()`); example:
    `"iterators out of range"`
N
Niels 已提交
4677 4678 4679 4680 4681 4682 4683 4684

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

4688
    @sa @ref erase(IteratorType) -- removes the element at a given position
N
Niels 已提交
4689
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4690
    from an object at the given key
N
Niels 已提交
4691 4692
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4693

N
Niels 已提交
4694
    @since version 1.0.0
N
Niels 已提交
4695
    */
N
Niels 已提交
4696 4697 4698 4699
    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>
4700
    IteratorType erase(IteratorType first, IteratorType last)
4701 4702
    {
        // make sure iterator fits the current value
N
Niels 已提交
4703
        if (this != first.m_object or this != last.m_object)
4704
        {
4705
            JSON_THROW(invalid_iterator::create(203, "iterators do not fit current value"));
4706 4707
        }

4708
        IteratorType result = end();
4709 4710 4711 4712

        switch (m_type)
        {
            case value_t::boolean:
4713 4714
            case value_t::number_float:
            case value_t::number_integer:
4715
            case value_t::number_unsigned:
4716 4717
            case value_t::string:
            {
4718
                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
4719
                {
4720
                    JSON_THROW(invalid_iterator::create(204, "iterators out of range"));
4721 4722
                }

N
cleanup  
Niels 已提交
4723
                if (is_string())
4724
                {
4725 4726 4727
                    AllocatorType<string_t> alloc;
                    alloc.destroy(m_value.string);
                    alloc.deallocate(m_value.string, 1);
4728 4729 4730 4731
                    m_value.string = nullptr;
                }

                m_type = value_t::null;
4732
                assert_invariant();
4733 4734 4735 4736 4737 4738
                break;
            }

            case value_t::object:
            {
                result.m_it.object_iterator = m_value.object->erase(first.m_it.object_iterator,
T
Théo DELRIEU 已提交
4739
                                              last.m_it.object_iterator);
4740 4741 4742 4743 4744 4745
                break;
            }

            case value_t::array:
            {
                result.m_it.array_iterator = m_value.array->erase(first.m_it.array_iterator,
T
Théo DELRIEU 已提交
4746
                                             last.m_it.array_iterator);
4747 4748 4749 4750 4751
                break;
            }

            default:
            {
4752
                JSON_THROW(type_error::create(307, "cannot use erase() with " + type_name()));
4753 4754 4755 4756 4757 4758
            }
        }

        return result;
    }

N
Niels 已提交
4759 4760 4761 4762 4763 4764 4765
    /*!
    @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 已提交
4766
    @return Number of elements removed. If @a ObjectType is the default
N
Niels 已提交
4767 4768
    `std::map` type, the return value will always be `0` (@a key was not
    found) or `1` (@a key was found).
N
Niels 已提交
4769 4770 4771

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

4773
    @throw type_error.307 when called on a type other than JSON object;
N
Niels 已提交
4774
    example: `"cannot use erase() with null"`
N
Niels 已提交
4775 4776 4777

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

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

4780 4781
    @sa @ref erase(IteratorType) -- removes the element at a given position
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4782 4783 4784
    the given range
    @sa @ref erase(const size_type) -- removes the element from an array at
    the given index
N
Niels 已提交
4785

N
Niels 已提交
4786
    @since version 1.0.0
N
Niels 已提交
4787
    */
N
Niels 已提交
4788
    size_type erase(const typename object_t::key_type& key)
4789
    {
N
Niels 已提交
4790
        // this erase only works for objects
N
Niels 已提交
4791 4792 4793 4794
        if (is_object())
        {
            return m_value.object->erase(key);
        }
N
Niels Lohmann 已提交
4795

4796
        JSON_THROW(type_error::create(307, "cannot use erase() with " + type_name()));
4797 4798
    }

N
Niels 已提交
4799 4800 4801 4802 4803 4804 4805
    /*!
    @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

4806
    @throw type_error.307 when called on a type other than JSON object;
N
Niels 已提交
4807
    example: `"cannot use erase() with null"`
N
Niels Lohmann 已提交
4808
    @throw out_of_range.401 when `idx >= size()`; example: `"array index 17
N
Niels 已提交
4809
    is out of range"`
N
Niels 已提交
4810 4811 4812

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

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

4815 4816
    @sa @ref erase(IteratorType) -- removes the element at a given position
    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
N
Niels 已提交
4817
    the given range
N
Niels 已提交
4818
    @sa @ref erase(const typename object_t::key_type&) -- removes the element
N
Niels 已提交
4819 4820
    from an object at the given key

N
Niels 已提交
4821
    @since version 1.0.0
N
Niels 已提交
4822
    */
N
Niels 已提交
4823
    void erase(const size_type idx)
N
Niels 已提交
4824 4825
    {
        // this erase only works for arrays
N
cleanup  
Niels 已提交
4826
        if (is_array())
N
Niels 已提交
4827
        {
N
cleanup  
Niels 已提交
4828 4829
            if (idx >= size())
            {
4830
                JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range"));
N
cleanup  
Niels 已提交
4831
            }
N
Niels 已提交
4832

N
cleanup  
Niels 已提交
4833 4834 4835
            m_value.array->erase(m_value.array->begin() + static_cast<difference_type>(idx));
        }
        else
N
Niels 已提交
4836
        {
4837
            JSON_THROW(type_error::create(307, "cannot use erase() with " + type_name()));
N
Niels 已提交
4838 4839 4840
        }
    }

N
Niels 已提交
4841 4842 4843 4844 4845 4846 4847 4848 4849 4850
    /// @}


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

    /// @name lookup
    /// @{

N
Niels 已提交
4851 4852 4853 4854
    /*!
    @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 已提交
4855 4856
    element is not found or the JSON value is not an object, end() is
    returned.
N
Niels 已提交
4857

4858 4859 4860
    @note This method always returns @ref end() when executed on a JSON type
          that is not an object.

N
Niels 已提交
4861 4862 4863
    @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
4864 4865
    element is found or the JSON value is not an object, past-the-end (see
    @ref end()) iterator is returned.
N
Niels 已提交
4866 4867 4868

    @complexity Logarithmic in the size of the JSON object.

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

N
Niels 已提交
4871
    @since version 1.0.0
N
Niels 已提交
4872
    */
N
Niels 已提交
4873
    iterator find(typename object_t::key_type key)
N
Niels 已提交
4874 4875 4876
    {
        auto result = end();

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

        return result;
    }

N
Niels 已提交
4885 4886 4887 4888
    /*!
    @brief find an element in a JSON object
    @copydoc find(typename object_t::key_type)
    */
N
Niels 已提交
4889
    const_iterator find(typename object_t::key_type key) const
N
Niels 已提交
4890 4891 4892
    {
        auto result = cend();

N
cleanup  
Niels 已提交
4893
        if (is_object())
N
Niels 已提交
4894 4895 4896 4897 4898 4899 4900
        {
            result.m_it.object_iterator = m_value.object->find(key);
        }

        return result;
    }

N
Niels 已提交
4901 4902 4903 4904 4905 4906 4907
    /*!
    @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).

4908 4909 4910
    @note This method always returns `0` when executed on a JSON type that is
          not an object.

N
Niels 已提交
4911 4912 4913 4914 4915 4916 4917
    @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 已提交
4918
    @liveexample{The example shows how `count()` is used.,count}
N
Niels 已提交
4919

N
Niels 已提交
4920
    @since version 1.0.0
N
Niels 已提交
4921
    */
N
Niels 已提交
4922
    size_type count(typename object_t::key_type key) const
4923 4924
    {
        // return 0 for all nonobject types
N
Niels 已提交
4925
        return is_object() ? m_value.object->count(key) : 0;
4926 4927
    }

N
Niels 已提交
4928 4929
    /// @}

N
Niels 已提交
4930

N
Niels 已提交
4931 4932 4933 4934
    ///////////////
    // iterators //
    ///////////////

N
Niels 已提交
4935 4936 4937
    /// @name iterators
    /// @{

N
Niels 已提交
4938 4939
    /*!
    @brief returns an iterator to the first element
N
Niels 已提交
4940 4941 4942 4943 4944 4945 4946 4947 4948

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

N
Niels 已提交
4954 4955 4956 4957 4958
    @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 已提交
4959

N
Niels 已提交
4960
    @since version 1.0.0
N
Niels 已提交
4961
    */
N
Niels 已提交
4962
    iterator begin() noexcept
N
Niels 已提交
4963 4964 4965 4966 4967 4968
    {
        iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
4969
    /*!
N
Niels 已提交
4970
    @copydoc basic_json::cbegin()
N
Niels 已提交
4971
    */
N
Niels 已提交
4972
    const_iterator begin() const noexcept
N
Niels 已提交
4973
    {
N
Niels 已提交
4974
        return cbegin();
N
Niels 已提交
4975 4976
    }

N
Niels 已提交
4977 4978
    /*!
    @brief returns a const iterator to the first element
N
Niels 已提交
4979 4980 4981 4982 4983 4984 4985 4986 4987

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

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

N
Niels 已提交
5000
    @since version 1.0.0
N
Niels 已提交
5001
    */
N
Niels 已提交
5002
    const_iterator cbegin() const noexcept
N
Niels 已提交
5003 5004 5005 5006 5007 5008
    {
        const_iterator result(this);
        result.set_begin();
        return result;
    }

N
Niels 已提交
5009 5010
    /*!
    @brief returns an iterator to one past the last element
N
Niels 已提交
5011 5012 5013 5014 5015 5016 5017 5018 5019

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

N
Niels 已提交
5025 5026 5027 5028 5029
    @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 已提交
5030

N
Niels 已提交
5031
    @since version 1.0.0
N
Niels 已提交
5032
    */
N
Niels 已提交
5033
    iterator end() noexcept
N
Niels 已提交
5034 5035 5036 5037 5038 5039
    {
        iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
5040
    /*!
N
Niels 已提交
5041
    @copydoc basic_json::cend()
N
Niels 已提交
5042
    */
N
Niels 已提交
5043
    const_iterator end() const noexcept
N
Niels 已提交
5044
    {
N
Niels 已提交
5045
        return cend();
N
Niels 已提交
5046 5047
    }

N
Niels 已提交
5048 5049
    /*!
    @brief returns a const iterator to one past the last element
N
Niels 已提交
5050 5051 5052 5053 5054 5055 5056 5057 5058

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

N
Niels 已提交
5065 5066 5067 5068 5069
    @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 已提交
5070

N
Niels 已提交
5071
    @since version 1.0.0
N
Niels 已提交
5072
    */
N
Niels 已提交
5073
    const_iterator cend() const noexcept
N
Niels 已提交
5074 5075 5076 5077 5078 5079
    {
        const_iterator result(this);
        result.set_end();
        return result;
    }

N
Niels 已提交
5080
    /*!
N
Niels 已提交
5081 5082 5083 5084 5085 5086 5087 5088
    @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 已提交
5089 5090 5091
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
5092 5093 5094
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(end())`.

N
Niels 已提交
5095 5096 5097 5098 5099
    @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 已提交
5100

N
Niels 已提交
5101
    @since version 1.0.0
N
Niels 已提交
5102
    */
N
Niels 已提交
5103
    reverse_iterator rbegin() noexcept
N
Niels 已提交
5104 5105 5106 5107
    {
        return reverse_iterator(end());
    }

N
Niels 已提交
5108
    /*!
N
Niels 已提交
5109
    @copydoc basic_json::crbegin()
N
Niels 已提交
5110
    */
N
Niels 已提交
5111
    const_reverse_iterator rbegin() const noexcept
N
Niels 已提交
5112
    {
N
Niels 已提交
5113
        return crbegin();
N
Niels 已提交
5114 5115
    }

N
Niels 已提交
5116
    /*!
N
Niels 已提交
5117 5118 5119 5120 5121 5122 5123 5124 5125
    @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 已提交
5126 5127 5128
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
5129 5130 5131
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(begin())`.

N
Niels 已提交
5132 5133 5134 5135 5136
    @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 已提交
5137

N
Niels 已提交
5138
    @since version 1.0.0
N
Niels 已提交
5139
    */
N
Niels 已提交
5140
    reverse_iterator rend() noexcept
N
Niels 已提交
5141 5142 5143 5144
    {
        return reverse_iterator(begin());
    }

N
Niels 已提交
5145
    /*!
N
Niels 已提交
5146
    @copydoc basic_json::crend()
N
Niels 已提交
5147
    */
N
Niels 已提交
5148
    const_reverse_iterator rend() const noexcept
N
Niels 已提交
5149
    {
N
Niels 已提交
5150
        return crend();
N
Niels 已提交
5151 5152
    }

N
Niels 已提交
5153
    /*!
N
Niels 已提交
5154 5155 5156 5157 5158 5159 5160 5161 5162
    @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 已提交
5163 5164 5165
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
5166 5167 5168
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).rbegin()`.

N
Niels 已提交
5169 5170 5171 5172 5173
    @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 已提交
5174

N
Niels 已提交
5175
    @since version 1.0.0
N
Niels 已提交
5176
    */
N
Niels 已提交
5177
    const_reverse_iterator crbegin() const noexcept
N
Niels 已提交
5178 5179 5180 5181
    {
        return const_reverse_iterator(cend());
    }

N
Niels 已提交
5182
    /*!
N
Niels 已提交
5183 5184 5185 5186 5187 5188 5189 5190 5191
    @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 已提交
5192 5193 5194
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
5195 5196 5197
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).rend()`.

N
Niels 已提交
5198 5199 5200 5201 5202
    @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 已提交
5203

N
Niels 已提交
5204
    @since version 1.0.0
N
Niels 已提交
5205
    */
N
Niels 已提交
5206
    const_reverse_iterator crend() const noexcept
N
Niels 已提交
5207 5208 5209 5210
    {
        return const_reverse_iterator(cbegin());
    }

N
cleanup  
Niels 已提交
5211 5212 5213 5214 5215 5216 5217 5218
  private:
    // forward declaration
    template<typename IteratorType> class iteration_proxy;

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

N
Niels 已提交
5219
    This function allows to access @ref iterator::key() and @ref
N
Niels 已提交
5220 5221 5222
    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 已提交
5223

5224 5225
    @liveexample{The following code shows how the wrapper is used,iterator_wrapper}

N
cleanup  
Niels 已提交
5226 5227
    @note The name of this function is not yet final and may change in the
    future.
N
cleanup  
Niels 已提交
5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241
    */
    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 已提交
5242 5243
    /// @}

N
Niels 已提交
5244 5245 5246 5247 5248

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

N
Niels 已提交
5249 5250 5251
    /// @name capacity
    /// @{

N
Niels 已提交
5252 5253
    /*!
    @brief checks whether the container is empty
N
Niels 已提交
5254 5255 5256

    Checks if a JSON value has no elements.

N
Niels 已提交
5257
    @return The return value depends on the different types and is
N
Niels 已提交
5258 5259 5260
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
5261 5262 5263 5264 5265 5266
            null        | `true`
            boolean     | `false`
            string      | `false`
            number      | `false`
            object      | result of function `object_t::empty()`
            array       | result of function `array_t::empty()`
N
Niels 已提交
5267

N
Niels 已提交
5268 5269 5270 5271
    @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 已提交
5272 5273
    @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 已提交
5274
    complexity.
N
Niels 已提交
5275

N
Niels 已提交
5276 5277 5278
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
5279 5280 5281
    - The complexity is constant.
    - Has the semantics of `begin() == end()`.

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

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

N
Niels 已提交
5287
    @since version 1.0.0
N
Niels 已提交
5288
    */
N
Niels 已提交
5289
    bool empty() const noexcept
N
Niels 已提交
5290 5291 5292
    {
        switch (m_type)
        {
5293
            case value_t::null:
N
Niels 已提交
5294
            {
N
Niels 已提交
5295
                // null values are empty
N
Niels 已提交
5296 5297
                return true;
            }
N
Niels 已提交
5298

5299
            case value_t::array:
N
Niels 已提交
5300
            {
N
Niels 已提交
5301
                // delegate call to array_t::empty()
N
Niels 已提交
5302 5303
                return m_value.array->empty();
            }
N
Niels 已提交
5304

5305
            case value_t::object:
N
Niels 已提交
5306
            {
N
Niels 已提交
5307
                // delegate call to object_t::empty()
N
Niels 已提交
5308 5309
                return m_value.object->empty();
            }
N
Niels 已提交
5310

N
Niels 已提交
5311 5312 5313 5314 5315 5316
            default:
            {
                // all other types are nonempty
                return false;
            }
        }
N
Niels 已提交
5317 5318
    }

N
Niels 已提交
5319 5320
    /*!
    @brief returns the number of elements
N
Niels 已提交
5321 5322 5323

    Returns the number of elements in a JSON value.

N
Niels 已提交
5324
    @return The return value depends on the different types and is
N
Niels 已提交
5325 5326 5327
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
5328 5329 5330 5331
            null        | `0`
            boolean     | `1`
            string      | `1`
            number      | `1`
N
Niels 已提交
5332 5333 5334
            object      | result of function object_t::size()
            array       | result of function array_t::size()

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

N
Niels 已提交
5343 5344 5345
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
5346 5347 5348
    - The complexity is constant.
    - Has the semantics of `std::distance(begin(), end())`.

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

N
Niels 已提交
5352 5353 5354
    @sa @ref empty() -- checks whether the container is empty
    @sa @ref max_size() -- returns the maximal number of elements

N
Niels 已提交
5355
    @since version 1.0.0
N
Niels 已提交
5356
    */
N
Niels 已提交
5357
    size_type size() const noexcept
N
Niels 已提交
5358 5359 5360
    {
        switch (m_type)
        {
5361
            case value_t::null:
N
Niels 已提交
5362
            {
N
Niels 已提交
5363
                // null values are empty
N
Niels 已提交
5364 5365
                return 0;
            }
N
Niels 已提交
5366

5367
            case value_t::array:
N
Niels 已提交
5368
            {
N
Niels 已提交
5369
                // delegate call to array_t::size()
N
Niels 已提交
5370 5371
                return m_value.array->size();
            }
N
Niels 已提交
5372

5373
            case value_t::object:
N
Niels 已提交
5374
            {
N
Niels 已提交
5375
                // delegate call to object_t::size()
N
Niels 已提交
5376 5377
                return m_value.object->size();
            }
N
Niels 已提交
5378

N
Niels 已提交
5379 5380 5381 5382 5383 5384
            default:
            {
                // all other types have size 1
                return 1;
            }
        }
N
Niels 已提交
5385 5386
    }

N
Niels 已提交
5387 5388
    /*!
    @brief returns the maximum possible number of elements
N
Niels 已提交
5389 5390 5391 5392 5393

    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 已提交
5394
    @return The return value depends on the different types and is
N
Niels 已提交
5395 5396 5397
            defined as follows:
            Value type  | return value
            ----------- | -------------
N
Niels 已提交
5398 5399 5400 5401 5402 5403
            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 已提交
5404

N
Niels 已提交
5405 5406
    @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 已提交
5407
    complexity.
N
Niels 已提交
5408

N
Niels 已提交
5409 5410 5411
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
5412 5413 5414 5415
    - The complexity is constant.
    - Has the semantics of returning `b.size()` where `b` is the largest
      possible JSON value.

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

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

N
Niels 已提交
5421
    @since version 1.0.0
N
Niels 已提交
5422
    */
N
Niels 已提交
5423
    size_type max_size() const noexcept
N
Niels 已提交
5424 5425 5426
    {
        switch (m_type)
        {
5427
            case value_t::array:
N
Niels 已提交
5428
            {
N
Niels 已提交
5429
                // delegate call to array_t::max_size()
N
Niels 已提交
5430 5431
                return m_value.array->max_size();
            }
N
Niels 已提交
5432

5433
            case value_t::object:
N
Niels 已提交
5434
            {
N
Niels 已提交
5435
                // delegate call to object_t::max_size()
N
Niels 已提交
5436 5437
                return m_value.object->max_size();
            }
N
Niels 已提交
5438

N
Niels 已提交
5439 5440
            default:
            {
5441 5442
                // all other types have max_size() == size()
                return size();
N
Niels 已提交
5443 5444
            }
        }
N
Niels 已提交
5445 5446
    }

N
Niels 已提交
5447 5448
    /// @}

N
Niels 已提交
5449 5450 5451 5452 5453

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

N
Niels 已提交
5454 5455 5456
    /// @name modifiers
    /// @{

N
Niels 已提交
5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473
    /*!
    @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 已提交
5474
    @liveexample{The example below shows the effect of `clear()` to different
N
Niels 已提交
5475
    JSON types.,clear}
N
Niels 已提交
5476

N
Niels 已提交
5477
    @since version 1.0.0
N
Niels 已提交
5478
    */
N
Niels 已提交
5479
    void clear() noexcept
N
Niels 已提交
5480 5481 5482
    {
        switch (m_type)
        {
5483
            case value_t::number_integer:
N
Niels 已提交
5484
            {
N
Niels 已提交
5485
                m_value.number_integer = 0;
N
Niels 已提交
5486 5487
                break;
            }
N
Niels 已提交
5488

5489 5490 5491 5492 5493 5494
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = 0;
                break;
            }

5495
            case value_t::number_float:
N
Niels 已提交
5496
            {
N
Niels 已提交
5497
                m_value.number_float = 0.0;
N
Niels 已提交
5498 5499
                break;
            }
N
Niels 已提交
5500

5501
            case value_t::boolean:
N
Niels 已提交
5502
            {
N
Niels 已提交
5503
                m_value.boolean = false;
N
Niels 已提交
5504 5505
                break;
            }
N
Niels 已提交
5506

5507
            case value_t::string:
N
Niels 已提交
5508 5509 5510 5511
            {
                m_value.string->clear();
                break;
            }
N
Niels 已提交
5512

5513
            case value_t::array:
N
Niels 已提交
5514 5515 5516 5517
            {
                m_value.array->clear();
                break;
            }
N
Niels 已提交
5518

5519
            case value_t::object:
N
Niels 已提交
5520 5521 5522 5523
            {
                m_value.object->clear();
                break;
            }
5524 5525 5526 5527 5528

            default:
            {
                break;
            }
N
Niels 已提交
5529 5530 5531
        }
    }

5532 5533 5534
    /*!
    @brief add an object to an array

5535
    Appends the given element @a val to the end of the JSON value. If the
5536
    function is called on a JSON null value, an empty array is created before
5537
    appending @a val.
5538

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

5541
    @throw type_error.308 when called on a type other than JSON array or
N
Niels 已提交
5542
    null; example: `"cannot use push_back() with number"`
5543 5544 5545

    @complexity Amortized constant.

N
Niels 已提交
5546 5547 5548
    @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 已提交
5549

N
Niels 已提交
5550
    @since version 1.0.0
5551
    */
5552
    void push_back(basic_json&& val)
N
Niels 已提交
5553 5554
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
5555
        if (not(is_null() or is_array()))
N
Niels 已提交
5556
        {
5557
            JSON_THROW(type_error::create(308, "cannot use push_back() with " + type_name()));
N
Niels 已提交
5558 5559 5560
        }

        // transform null object into an array
N
cleanup  
Niels 已提交
5561
        if (is_null())
N
Niels 已提交
5562 5563
        {
            m_type = value_t::array;
N
Niels 已提交
5564
            m_value = value_t::array;
5565
            assert_invariant();
N
Niels 已提交
5566 5567 5568
        }

        // add element to array (move semantics)
5569
        m_value.array->push_back(std::move(val));
N
Niels 已提交
5570
        // invalidate object
5571
        val.m_type = value_t::null;
N
Niels 已提交
5572 5573
    }

5574 5575 5576 5577
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5578
    reference operator+=(basic_json&& val)
N
Niels 已提交
5579
    {
5580
        push_back(std::move(val));
N
Niels 已提交
5581 5582 5583
        return *this;
    }

5584 5585 5586 5587
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5588
    void push_back(const basic_json& val)
N
Niels 已提交
5589 5590
    {
        // push_back only works for null objects or arrays
N
cleanup  
Niels 已提交
5591
        if (not(is_null() or is_array()))
N
Niels 已提交
5592
        {
5593
            JSON_THROW(type_error::create(308, "cannot use push_back() with " + type_name()));
N
Niels 已提交
5594 5595 5596
        }

        // transform null object into an array
N
cleanup  
Niels 已提交
5597
        if (is_null())
N
Niels 已提交
5598 5599
        {
            m_type = value_t::array;
N
Niels 已提交
5600
            m_value = value_t::array;
5601
            assert_invariant();
N
Niels 已提交
5602 5603 5604
        }

        // add element to array
5605
        m_value.array->push_back(val);
N
Niels 已提交
5606 5607
    }

5608 5609 5610 5611
    /*!
    @brief add an object to an array
    @copydoc push_back(basic_json&&)
    */
5612
    reference operator+=(const basic_json& val)
N
Niels 已提交
5613
    {
5614
        push_back(val);
N
Niels 已提交
5615 5616 5617
        return *this;
    }

5618 5619 5620
    /*!
    @brief add an object to an object

5621
    Inserts the given element @a val to the JSON object. If the function is
N
Niels 已提交
5622 5623
    called on a JSON null value, an empty object is created before inserting
    @a val.
5624

5625
    @param[in] val the value to add to the JSON object
5626

5627
    @throw type_error.308 when called on a type other than JSON object or
N
Niels 已提交
5628
    null; example: `"cannot use push_back() with number"`
5629 5630 5631

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

N
Niels 已提交
5632 5633 5634
    @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 已提交
5635

N
Niels 已提交
5636
    @since version 1.0.0
5637
    */
5638
    void push_back(const typename object_t::value_type& val)
N
Niels 已提交
5639 5640
    {
        // push_back only works for null objects or objects
N
cleanup  
Niels 已提交
5641
        if (not(is_null() or is_object()))
N
Niels 已提交
5642
        {
5643
            JSON_THROW(type_error::create(308, "cannot use push_back() with " + type_name()));
N
Niels 已提交
5644 5645 5646
        }

        // transform null object into an object
N
cleanup  
Niels 已提交
5647
        if (is_null())
N
Niels 已提交
5648 5649
        {
            m_type = value_t::object;
N
Niels 已提交
5650
            m_value = value_t::object;
5651
            assert_invariant();
N
Niels 已提交
5652 5653 5654
        }

        // add element to array
5655
        m_value.object->insert(val);
N
Niels 已提交
5656 5657
    }

5658 5659 5660 5661
    /*!
    @brief add an object to an object
    @copydoc push_back(const typename object_t::value_type&)
    */
5662
    reference operator+=(const typename object_t::value_type& val)
N
Niels 已提交
5663
    {
5664
        push_back(val);
N
Niels 已提交
5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680
        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 已提交
5681
    @param[in] init  an initializer list
N
Niels 已提交
5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713

    @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 已提交
5714 5715
    }

N
Niels 已提交
5716 5717 5718 5719 5720 5721 5722 5723 5724 5725
    /*!
    @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

5726
    @throw type_error.311 when called on a type other than JSON array or
N
Niels 已提交
5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742
    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()))
        {
5743
            JSON_THROW(type_error::create(311, "cannot use emplace_back() with " + type_name()));
N
Niels 已提交
5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758
        }

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

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

N
Niels Lohmann 已提交
5761 5762
    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
5763 5764
    function is called on a JSON null value, an empty object is created before
    appending the value created from @a args.
N
Niels 已提交
5765 5766 5767 5768

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

5769 5770 5771 5772
    @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.

5773
    @throw type_error.311 when called on a type other than JSON object or
N
Niels 已提交
5774 5775 5776 5777 5778 5779
    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
5780 5781
    JSON object. Further note how no value is added if there was already one
    value stored with the same key.,emplace}
N
Niels 已提交
5782 5783 5784 5785

    @since version 2.0.8
    */
    template<class... Args>
5786
    std::pair<iterator, bool> emplace(Args&& ... args)
N
Niels 已提交
5787 5788 5789 5790
    {
        // emplace only works for null objects or arrays
        if (not(is_null() or is_object()))
        {
5791
            JSON_THROW(type_error::create(311, "cannot use emplace() with " + type_name()));
N
Niels 已提交
5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802
        }

        // 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)
5803 5804 5805 5806 5807 5808 5809
        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 已提交
5810 5811
    }

N
Niels 已提交
5812 5813 5814
    /*!
    @brief inserts element

5815
    Inserts element @a val before iterator @a pos.
N
Niels 已提交
5816 5817 5818

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

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

N
Niels Lohmann 已提交
5827
    @complexity Constant plus linear in the distance between @a pos and end of
N
Niels Lohmann 已提交
5828
    the container.
N
Niels 已提交
5829

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

N
Niels 已提交
5832
    @since version 1.0.0
N
Niels 已提交
5833
    */
5834
    iterator insert(const_iterator pos, const basic_json& val)
N
Niels 已提交
5835 5836
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5837
        if (is_array())
N
Niels 已提交
5838
        {
N
cleanup  
Niels 已提交
5839 5840 5841
            // check if iterator pos fits to this JSON value
            if (pos.m_object != this)
            {
5842
                JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value"));
N
cleanup  
Niels 已提交
5843
            }
N
Niels 已提交
5844

N
cleanup  
Niels 已提交
5845 5846
            // insert to array and return iterator
            iterator result(this);
5847
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, val);
N
cleanup  
Niels 已提交
5848 5849
            return result;
        }
N
Niels Lohmann 已提交
5850

5851
        JSON_THROW(type_error::create(309, "cannot use insert() with " + type_name()));
N
Niels 已提交
5852 5853 5854 5855 5856 5857
    }

    /*!
    @brief inserts element
    @copydoc insert(const_iterator, const basic_json&)
    */
5858
    iterator insert(const_iterator pos, basic_json&& val)
N
Niels 已提交
5859
    {
5860
        return insert(pos, val);
N
Niels 已提交
5861 5862 5863 5864 5865
    }

    /*!
    @brief inserts elements

5866
    Inserts @a cnt copies of @a val before iterator @a pos.
N
Niels 已提交
5867 5868 5869

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

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

5880
    @complexity Linear in @a cnt plus linear in the distance between @a pos
N
Niels 已提交
5881 5882
    and end of the container.

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

N
Niels 已提交
5885
    @since version 1.0.0
N
Niels 已提交
5886
    */
5887
    iterator insert(const_iterator pos, size_type cnt, const basic_json& val)
N
Niels 已提交
5888 5889
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5890
        if (is_array())
N
Niels 已提交
5891
        {
N
cleanup  
Niels 已提交
5892 5893 5894
            // check if iterator pos fits to this JSON value
            if (pos.m_object != this)
            {
5895
                JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value"));
N
cleanup  
Niels 已提交
5896
            }
N
Niels 已提交
5897

N
cleanup  
Niels 已提交
5898 5899
            // insert to array and return iterator
            iterator result(this);
5900
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, cnt, val);
N
cleanup  
Niels 已提交
5901 5902
            return result;
        }
N
Niels Lohmann 已提交
5903

5904
        JSON_THROW(type_error::create(309, "cannot use insert() with " + type_name()));
N
Niels 已提交
5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916
    }

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

5917 5918
    @throw type_error.309 if called on JSON values other than arrays; example:
    `"cannot use insert() with string"`
5919 5920
    @throw invalid_iterator.202 if @a pos is not an iterator of *this;
    example: `"iterator does not fit current value"`
5921 5922 5923
    @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 已提交
5924 5925 5926
    container for which insert is called; example: `"passed iterators may not
    belong to container"`

N
Niels 已提交
5927 5928 5929 5930 5931 5932
    @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 已提交
5933
    @liveexample{The example shows how `insert()` is used.,insert__range}
N
Niels 已提交
5934

N
Niels 已提交
5935
    @since version 1.0.0
N
Niels 已提交
5936 5937 5938 5939
    */
    iterator insert(const_iterator pos, const_iterator first, const_iterator last)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5940
        if (not is_array())
N
Niels 已提交
5941
        {
5942
            JSON_THROW(type_error::create(309, "cannot use insert() with " + type_name()));
N
Niels 已提交
5943 5944 5945 5946 5947
        }

        // check if iterator pos fits to this JSON value
        if (pos.m_object != this)
        {
5948
            JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value"));
N
Niels 已提交
5949 5950
        }

N
Niels 已提交
5951
        // check if range iterators belong to the same JSON object
N
Niels 已提交
5952 5953
        if (first.m_object != last.m_object)
        {
5954
            JSON_THROW(invalid_iterator::create(210, "iterators do not fit"));
N
Niels 已提交
5955 5956 5957 5958
        }

        if (first.m_object == this or last.m_object == this)
        {
5959
            JSON_THROW(invalid_iterator::create(211, "passed iterators may not belong to container"));
N
Niels 已提交
5960 5961 5962 5963
        }

        // insert to array and return iterator
        iterator result(this);
N
Niels 已提交
5964
        result.m_it.array_iterator = m_value.array->insert(
T
Théo DELRIEU 已提交
5965 5966 5967
                                         pos.m_it.array_iterator,
                                         first.m_it.array_iterator,
                                         last.m_it.array_iterator);
N
Niels 已提交
5968 5969 5970
        return result;
    }

N
Niels 已提交
5971 5972 5973 5974 5975 5976 5977 5978 5979
    /*!
    @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

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

N
Niels 已提交
5985 5986 5987
    @return iterator pointing to the first element inserted, or @a pos if
    `ilist` is empty

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

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

N
Niels 已提交
5993
    @since version 1.0.0
N
Niels 已提交
5994 5995 5996 5997
    */
    iterator insert(const_iterator pos, std::initializer_list<basic_json> ilist)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5998
        if (not is_array())
N
Niels 已提交
5999
        {
6000
            JSON_THROW(type_error::create(309, "cannot use insert() with " + type_name()));
N
Niels 已提交
6001 6002 6003 6004 6005
        }

        // check if iterator pos fits to this JSON value
        if (pos.m_object != this)
        {
6006
            JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value"));
N
Niels 已提交
6007 6008 6009 6010 6011 6012 6013 6014
        }

        // 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 已提交
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 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060
    /*!
    @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 已提交
6061 6062
    /*!
    @brief exchanges the values
N
Niels 已提交
6063 6064 6065 6066 6067 6068 6069 6070 6071 6072

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

N
Niels 已提交
6076
    @since version 1.0.0
N
Niels 已提交
6077
    */
N
Niels 已提交
6078
    void swap(reference other) noexcept (
N
Niels 已提交
6079 6080 6081 6082
        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 已提交
6083
    )
N
Niels 已提交
6084 6085 6086
    {
        std::swap(m_type, other.m_type);
        std::swap(m_value, other.m_value);
6087
        assert_invariant();
N
Niels 已提交
6088 6089
    }

N
Niels 已提交
6090 6091 6092 6093 6094 6095 6096 6097 6098 6099
    /*!
    @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

6100 6101
    @throw type_error.310 when JSON value is not an array; example: `"cannot
    use swap() with string"`
N
Niels 已提交
6102 6103 6104

    @complexity Constant.

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

N
Niels 已提交
6108
    @since version 1.0.0
N
Niels 已提交
6109
    */
N
Niels 已提交
6110
    void swap(array_t& other)
N
Niels 已提交
6111 6112
    {
        // swap only works for arrays
N
cleanup  
Niels 已提交
6113 6114 6115 6116 6117
        if (is_array())
        {
            std::swap(*(m_value.array), other);
        }
        else
N
Niels 已提交
6118
        {
6119
            JSON_THROW(type_error::create(310, "cannot use swap() with " + type_name()));
N
Niels 已提交
6120 6121 6122
        }
    }

6123 6124 6125 6126 6127 6128 6129 6130 6131 6132
    /*!
    @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

6133
    @throw type_error.310 when JSON value is not an object; example:
N
Niels 已提交
6134
    `"cannot use swap() with string"`
6135 6136 6137

    @complexity Constant.

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

N
Niels 已提交
6141
    @since version 1.0.0
6142
    */
N
Niels 已提交
6143
    void swap(object_t& other)
N
Niels 已提交
6144 6145
    {
        // swap only works for objects
N
cleanup  
Niels 已提交
6146 6147 6148 6149 6150
        if (is_object())
        {
            std::swap(*(m_value.object), other);
        }
        else
N
Niels 已提交
6151
        {
6152
            JSON_THROW(type_error::create(310, "cannot use swap() with " + type_name()));
N
Niels 已提交
6153 6154 6155
        }
    }

6156 6157 6158 6159 6160 6161 6162 6163 6164 6165
    /*!
    @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

6166
    @throw type_error.310 when JSON value is not a string; example: `"cannot
N
Niels 已提交
6167
    use swap() with boolean"`
6168 6169 6170

    @complexity Constant.

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

N
Niels 已提交
6174
    @since version 1.0.0
6175
    */
N
Niels 已提交
6176
    void swap(string_t& other)
N
Niels 已提交
6177 6178
    {
        // swap only works for strings
N
cleanup  
Niels 已提交
6179 6180 6181 6182 6183
        if (is_string())
        {
            std::swap(*(m_value.string), other);
        }
        else
N
Niels 已提交
6184
        {
6185
            JSON_THROW(type_error::create(310, "cannot use swap() with " + type_name()));
N
Niels 已提交
6186 6187 6188
        }
    }

N
Niels 已提交
6189 6190
    /// @}

N
Niels 已提交
6191
  public:
6192 6193 6194 6195 6196 6197 6198
    //////////////////////////////////////////
    // lexicographical comparison operators //
    //////////////////////////////////////////

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

N
Niels 已提交
6199 6200
    /*!
    @brief comparison: equal
N
Niels 已提交
6201 6202 6203

    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 已提交
6204 6205
      their stored values are the same according to their respective
      `operator==`.
N
Niels 已提交
6206
    - Integer and floating-point numbers are automatically converted before
N
Niels Lohmann 已提交
6207
      comparison. Note than two NaN values are always treated as unequal.
N
Niels 已提交
6208 6209
    - Two JSON null values are equal.

N
Niels Lohmann 已提交
6210 6211
    @note NaN values never compare equal to themselves or to other NaN values.

N
Niels 已提交
6212 6213 6214 6215 6216 6217
    @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.

6218 6219
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__equal}
N
Niels 已提交
6220

N
Niels 已提交
6221
    @since version 1.0.0
N
Niels 已提交
6222
    */
N
Niels 已提交
6223
    friend bool operator==(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6224
    {
F
Florian Weber 已提交
6225 6226
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
6227

F
Florian Weber 已提交
6228
        if (lhs_type == rhs_type)
N
Niels 已提交
6229
        {
F
Florian Weber 已提交
6230
            switch (lhs_type)
N
Niels 已提交
6231
            {
6232
                case value_t::array:
N
Niels 已提交
6233
                {
N
Niels 已提交
6234
                    return *lhs.m_value.array == *rhs.m_value.array;
N
Niels 已提交
6235
                }
6236
                case value_t::object:
N
Niels 已提交
6237
                {
N
Niels 已提交
6238
                    return *lhs.m_value.object == *rhs.m_value.object;
N
Niels 已提交
6239
                }
6240
                case value_t::null:
N
Niels 已提交
6241
                {
N
Niels 已提交
6242
                    return true;
N
Niels 已提交
6243
                }
6244
                case value_t::string:
N
Niels 已提交
6245
                {
N
Niels 已提交
6246
                    return *lhs.m_value.string == *rhs.m_value.string;
N
Niels 已提交
6247
                }
6248
                case value_t::boolean:
N
Niels 已提交
6249
                {
N
Niels 已提交
6250
                    return lhs.m_value.boolean == rhs.m_value.boolean;
N
Niels 已提交
6251
                }
6252
                case value_t::number_integer:
N
Niels 已提交
6253
                {
N
Niels 已提交
6254
                    return lhs.m_value.number_integer == rhs.m_value.number_integer;
N
Niels 已提交
6255
                }
6256 6257 6258 6259
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned == rhs.m_value.number_unsigned;
                }
6260
                case value_t::number_float:
N
Niels 已提交
6261
                {
6262
                    return lhs.m_value.number_float == rhs.m_value.number_float;
N
Niels 已提交
6263
                }
6264
                default:
N
Niels 已提交
6265
                {
N
Niels 已提交
6266
                    return false;
N
Niels 已提交
6267
                }
N
Niels 已提交
6268 6269
            }
        }
F
Florian Weber 已提交
6270 6271
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
N
Niels 已提交
6272
            return static_cast<number_float_t>(lhs.m_value.number_integer) == rhs.m_value.number_float;
F
Florian Weber 已提交
6273 6274 6275
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
6276
            return lhs.m_value.number_float == static_cast<number_float_t>(rhs.m_value.number_integer);
F
Florian Weber 已提交
6277
        }
6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292
        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 已提交
6293
        }
6294

N
Niels 已提交
6295 6296 6297
        return false;
    }

N
Niels 已提交
6298 6299
    /*!
    @brief comparison: equal
M
Mihai STAN 已提交
6300
    @copydoc operator==(const_reference, const_reference)
N
Niels 已提交
6301
    */
M
Mihai STAN 已提交
6302
    template<typename ScalarType, typename std::enable_if<
6303 6304
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator==(const_reference lhs, const ScalarType rhs) noexcept
N
Niels 已提交
6305
    {
M
Mihai STAN 已提交
6306
        return (lhs == basic_json(rhs));
N
Niels 已提交
6307 6308 6309 6310
    }

    /*!
    @brief comparison: equal
M
Mihai STAN 已提交
6311
    @copydoc operator==(const_reference, const_reference)
N
Niels 已提交
6312
    */
M
Mihai STAN 已提交
6313
    template<typename ScalarType, typename std::enable_if<
6314 6315
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator==(const ScalarType lhs, const_reference rhs) noexcept
N
Niels 已提交
6316
    {
M
Mihai STAN 已提交
6317
        return (basic_json(lhs) == rhs);
N
Niels 已提交
6318 6319
    }

N
Niels 已提交
6320 6321
    /*!
    @brief comparison: not equal
N
Niels 已提交
6322 6323 6324 6325 6326 6327 6328 6329 6330

    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.

6331 6332
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__notequal}
N
Niels 已提交
6333

N
Niels 已提交
6334
    @since version 1.0.0
N
Niels 已提交
6335
    */
N
Niels 已提交
6336
    friend bool operator!=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6337 6338 6339 6340
    {
        return not (lhs == rhs);
    }

N
Niels 已提交
6341 6342
    /*!
    @brief comparison: not equal
M
Mihai STAN 已提交
6343
    @copydoc operator!=(const_reference, const_reference)
N
Niels 已提交
6344
    */
M
Mihai STAN 已提交
6345 6346 6347
    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 已提交
6348
    {
M
Mihai STAN 已提交
6349
        return (lhs != basic_json(rhs));
N
Niels 已提交
6350 6351 6352 6353
    }

    /*!
    @brief comparison: not equal
M
Mihai STAN 已提交
6354
    @copydoc operator!=(const_reference, const_reference)
N
Niels 已提交
6355
    */
M
Mihai STAN 已提交
6356 6357 6358
    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 已提交
6359
    {
M
Mihai STAN 已提交
6360
        return (basic_json(lhs) != rhs);
N
Niels 已提交
6361 6362
    }

N
Niels 已提交
6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381
    /*!
    @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.

6382 6383
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__less}
N
Niels 已提交
6384

N
Niels 已提交
6385
    @since version 1.0.0
N
Niels 已提交
6386
    */
N
Niels 已提交
6387
    friend bool operator<(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6388
    {
F
Florian Weber 已提交
6389 6390
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
6391

F
Florian Weber 已提交
6392
        if (lhs_type == rhs_type)
N
Niels 已提交
6393
        {
F
Florian Weber 已提交
6394
            switch (lhs_type)
N
Niels 已提交
6395
            {
6396
                case value_t::array:
N
Niels 已提交
6397
                {
6398
                    return (*lhs.m_value.array) < (*rhs.m_value.array);
N
Niels 已提交
6399
                }
6400
                case value_t::object:
N
Niels 已提交
6401
                {
N
Niels 已提交
6402
                    return *lhs.m_value.object < *rhs.m_value.object;
N
Niels 已提交
6403
                }
6404
                case value_t::null:
N
Niels 已提交
6405
                {
N
Niels 已提交
6406
                    return false;
N
Niels 已提交
6407
                }
6408
                case value_t::string:
N
Niels 已提交
6409
                {
N
Niels 已提交
6410
                    return *lhs.m_value.string < *rhs.m_value.string;
N
Niels 已提交
6411
                }
6412
                case value_t::boolean:
N
Niels 已提交
6413
                {
N
Niels 已提交
6414
                    return lhs.m_value.boolean < rhs.m_value.boolean;
N
Niels 已提交
6415
                }
6416
                case value_t::number_integer:
N
Niels 已提交
6417
                {
N
Niels 已提交
6418
                    return lhs.m_value.number_integer < rhs.m_value.number_integer;
N
Niels 已提交
6419
                }
6420 6421 6422 6423
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned < rhs.m_value.number_unsigned;
                }
6424
                case value_t::number_float:
N
Niels 已提交
6425
                {
N
Niels 已提交
6426
                    return lhs.m_value.number_float < rhs.m_value.number_float;
N
Niels 已提交
6427
                }
6428
                default:
N
Niels 已提交
6429
                {
N
Niels 已提交
6430
                    return false;
N
Niels 已提交
6431
                }
N
Niels 已提交
6432 6433
            }
        }
F
Florian Weber 已提交
6434 6435
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
6436
            return static_cast<number_float_t>(lhs.m_value.number_integer) < rhs.m_value.number_float;
F
Florian Weber 已提交
6437 6438 6439
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456
            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 已提交
6457
        }
N
Niels 已提交
6458

N
Niels 已提交
6459
        // We only reach this line if we cannot compare values. In that case,
N
Niels 已提交
6460 6461 6462
        // we compare types. Note we have to call the operator explicitly,
        // because MSVC has problems otherwise.
        return operator<(lhs_type, rhs_type);
N
Niels 已提交
6463 6464
    }

N
Niels Lohmann 已提交
6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486
    /*!
    @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 已提交
6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498
    /*!
    @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.

6499 6500
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greater}
N
Niels 已提交
6501

N
Niels 已提交
6502
    @since version 1.0.0
N
Niels 已提交
6503
    */
N
Niels 已提交
6504
    friend bool operator<=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6505 6506 6507 6508
    {
        return not (rhs < lhs);
    }

N
Niels Lohmann 已提交
6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530
    /*!
    @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 已提交
6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542
    /*!
    @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.

6543 6544
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__lessequal}
N
Niels 已提交
6545

N
Niels 已提交
6546
    @since version 1.0.0
N
Niels 已提交
6547
    */
N
Niels 已提交
6548
    friend bool operator>(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6549 6550 6551 6552
    {
        return not (lhs <= rhs);
    }

N
Niels Lohmann 已提交
6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574
    /*!
    @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 已提交
6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586
    /*!
    @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.

6587 6588
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greaterequal}
N
Niels 已提交
6589

N
Niels 已提交
6590
    @since version 1.0.0
N
Niels 已提交
6591
    */
N
Niels 已提交
6592
    friend bool operator>=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6593 6594 6595 6596
    {
        return not (lhs < rhs);
    }

N
Niels Lohmann 已提交
6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618
    /*!
    @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 已提交
6619 6620
    /// @}

6621 6622 6623 6624 6625
  private:
    /////////////////////
    // output adapters //
    /////////////////////

N
Niels Lohmann 已提交
6626
    /// abstract output adapter interface
6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650
    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 已提交
6651
    /// a type to simplify interfaces
6652 6653 6654
    template<typename CharType>
    using output_adapter_t = std::shared_ptr<output_adapter<CharType>>;

N
Niels Lohmann 已提交
6655
    /// output adapter for byte vectors
6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677
    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 已提交
6678
    /// putput adapter for output streams
6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700
    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 已提交
6701
    /// output adapter for basic_string
6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723
    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 已提交
6724 6725 6726 6727 6728

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

N
Niels 已提交
6729 6730 6731
    /// @name serialization
    /// @{

6732
  private:
6733 6734 6735
    /*!
    @brief wrapper around the serialization functions
    */
6736 6737 6738
    class serializer
    {
      public:
N
Niels Lohmann 已提交
6739 6740
        /*!
        @param[in] s  output stream to serialize to
6741
        @param[in] ichar  indentation character to use
N
Niels Lohmann 已提交
6742
        */
6743
        serializer(output_adapter_t<char> s, const char ichar)
6744 6745
            : o(s), loc(std::localeconv()),
              thousands_sep(!loc->thousands_sep ? '\0' : loc->thousands_sep[0]),
6746 6747
              decimal_point(!loc->decimal_point ? '\0' : loc->decimal_point[0]),
              indent_char(ichar), indent_string(512, indent_char)
6748 6749
        {}

6750 6751 6752 6753
        // delete because of pointer members
        serializer(const serializer&) = delete;
        serializer& operator=(const serializer&) = delete;

6754 6755 6756
        /*!
        @brief internal implementation of the serialization function

N
Niels Lohmann 已提交
6757 6758 6759 6760
        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.
6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773

        - 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,
6774
                  const unsigned int current_indent = 0)
6775 6776 6777 6778 6779 6780 6781
        {
            switch (val.m_type)
            {
                case value_t::object:
                {
                    if (val.m_value.object->empty())
                    {
6782
                        o->write_characters("{}", 2);
6783 6784 6785 6786 6787
                        return;
                    }

                    if (pretty_print)
                    {
6788
                        o->write_characters("{\n", 2);
6789 6790 6791

                        // variable to hold indentation for recursive calls
                        const auto new_indent = current_indent + indent_step;
6792
                        if (JSON_UNLIKELY(indent_string.size() < new_indent))
6793
                        {
6794
                            indent_string.resize(indent_string.size() * 2, ' ');
6795
                        }
6796 6797 6798 6799 6800

                        // 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)
                        {
6801 6802
                            o->write_characters(indent_string.c_str(), new_indent);
                            o->write_character('\"');
6803
                            dump_escaped(i->first);
6804
                            o->write_characters("\": ", 3);
6805
                            dump(i->second, true, indent_step, new_indent);
6806
                            o->write_characters(",\n", 2);
6807 6808 6809 6810
                        }

                        // last element
                        assert(i != val.m_value.object->cend());
6811 6812
                        o->write_characters(indent_string.c_str(), new_indent);
                        o->write_character('\"');
6813
                        dump_escaped(i->first);
6814
                        o->write_characters("\": ", 3);
6815 6816
                        dump(i->second, true, indent_step, new_indent);

6817 6818 6819
                        o->write_character('\n');
                        o->write_characters(indent_string.c_str(), current_indent);
                        o->write_character('}');
6820 6821 6822
                    }
                    else
                    {
6823
                        o->write_character('{');
6824 6825 6826 6827 6828

                        // 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)
                        {
6829
                            o->write_character('\"');
6830
                            dump_escaped(i->first);
6831
                            o->write_characters("\":", 2);
6832
                            dump(i->second, false, indent_step, current_indent);
6833
                            o->write_character(',');
6834 6835 6836 6837
                        }

                        // last element
                        assert(i != val.m_value.object->cend());
6838
                        o->write_character('\"');
6839
                        dump_escaped(i->first);
6840
                        o->write_characters("\":", 2);
6841 6842
                        dump(i->second, false, indent_step, current_indent);

6843
                        o->write_character('}');
6844 6845 6846 6847 6848 6849 6850 6851 6852
                    }

                    return;
                }

                case value_t::array:
                {
                    if (val.m_value.array->empty())
                    {
6853
                        o->write_characters("[]", 2);
6854 6855 6856 6857 6858
                        return;
                    }

                    if (pretty_print)
                    {
6859
                        o->write_characters("[\n", 2);
6860 6861 6862

                        // variable to hold indentation for recursive calls
                        const auto new_indent = current_indent + indent_step;
6863 6864 6865 6866
                        if (indent_string.size() < new_indent)
                        {
                            indent_string.resize(new_indent, ' ');
                        }
6867 6868 6869 6870

                        // first n-1 elements
                        for (auto i = val.m_value.array->cbegin(); i != val.m_value.array->cend() - 1; ++i)
                        {
6871
                            o->write_characters(indent_string.c_str(), new_indent);
6872
                            dump(*i, true, indent_step, new_indent);
6873
                            o->write_characters(",\n", 2);
6874 6875 6876 6877
                        }

                        // last element
                        assert(not val.m_value.array->empty());
6878
                        o->write_characters(indent_string.c_str(), new_indent);
6879 6880
                        dump(val.m_value.array->back(), true, indent_step, new_indent);

6881 6882 6883
                        o->write_character('\n');
                        o->write_characters(indent_string.c_str(), current_indent);
                        o->write_character(']');
6884 6885 6886
                    }
                    else
                    {
6887
                        o->write_character('[');
6888 6889 6890 6891 6892

                        // 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);
6893
                            o->write_character(',');
6894 6895 6896 6897 6898 6899
                        }

                        // last element
                        assert(not val.m_value.array->empty());
                        dump(val.m_value.array->back(), false, indent_step, current_indent);

6900
                        o->write_character(']');
6901 6902 6903 6904 6905 6906 6907
                    }

                    return;
                }

                case value_t::string:
                {
6908
                    o->write_character('\"');
6909
                    dump_escaped(*val.m_value.string);
6910
                    o->write_character('\"');
6911 6912 6913 6914 6915 6916 6917
                    return;
                }

                case value_t::boolean:
                {
                    if (val.m_value.boolean)
                    {
6918
                        o->write_characters("true", 4);
6919 6920 6921
                    }
                    else
                    {
6922
                        o->write_characters("false", 5);
6923 6924 6925 6926 6927 6928
                    }
                    return;
                }

                case value_t::number_integer:
                {
6929
                    dump_integer(val.m_value.number_integer);
6930 6931 6932 6933 6934
                    return;
                }

                case value_t::number_unsigned:
                {
6935
                    dump_integer(val.m_value.number_unsigned);
6936 6937 6938 6939 6940
                    return;
                }

                case value_t::number_float:
                {
6941
                    dump_float(val.m_value.number_float);
6942 6943 6944 6945 6946
                    return;
                }

                case value_t::discarded:
                {
6947
                    o->write_characters("<discarded>", 11);
6948 6949 6950 6951 6952
                    return;
                }

                case value_t::null:
                {
6953
                    o->write_characters("null", 4);
6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986
                    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;
                    }

6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013
                    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:
7014
                    {
7015 7016 7017
                        // from c (1 byte) to \uxxxx (6 bytes)
                        return res + 5;
                    }
7018

7019 7020
                    default:
                    {
7021 7022 7023 7024 7025 7026 7027
                        return res;
                    }
                }
            });
        }

        /*!
N
Niels Lohmann 已提交
7028
        @brief dump escaped string
7029

N
Niels Lohmann 已提交
7030 7031 7032 7033
        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.
7034 7035 7036 7037 7038

        @param[in] s  the string to escape

        @complexity Linear in the length of string @a s.
        */
7039
        void dump_escaped(const string_t& s) const
7040 7041 7042 7043
        {
            const auto space = extra_space(s);
            if (space == 0)
            {
7044
                o->write_characters(s.c_str(), s.size());
7045
                return;
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 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111
            }

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

7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138
                    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:
7139
                    {
7140 7141 7142
                        // convert a number 0..15 to its hex representation
                        // (0..f)
                        static const char hexify[16] =
7143
                        {
7144 7145 7146 7147 7148 7149 7150 7151
                            '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]
                        })
7152
                        {
7153
                            result[++pos] = m;
7154
                        }
7155 7156 7157 7158 7159 7160 7161 7162 7163

                        ++pos;
                        break;
                    }

                    default:
                    {
                        // all other characters are added as-is
                        result[pos++] = c;
7164 7165 7166 7167 7168
                        break;
                    }
                }
            }

7169
            assert(pos == s.size() + space);
7170
            o->write_characters(result.c_str(), result.size());
7171 7172
        }

N
Niels Lohmann 已提交
7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184
        /*!
        @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>
7185
        void dump_integer(NumberType x)
7186
        {
7187 7188
            // special case for "0"
            if (x == 0)
7189
            {
7190
                o->write_character('0');
7191
                return;
7192 7193
            }

7194 7195 7196 7197
            const bool is_negative = x < 0;
            size_t i = 0;

            // spare 1 byte for '\0'
N
Niels Lohmann 已提交
7198
            while (x != 0 and i < number_buffer.size() - 1)
7199
            {
7200
                const auto digit = std::labs(static_cast<long>(x % 10));
N
Niels Lohmann 已提交
7201
                number_buffer[i++] = static_cast<char>('0' + digit);
7202
                x /= 10;
7203 7204
            }

7205 7206
            // make sure the number has been processed completely
            assert(x == 0);
7207

7208
            if (is_negative)
7209
            {
7210
                // make sure there is capacity for the '-'
N
Niels Lohmann 已提交
7211 7212
                assert(i < number_buffer.size() - 2);
                number_buffer[i++] = '-';
7213
            }
7214

N
Niels Lohmann 已提交
7215
            std::reverse(number_buffer.begin(), number_buffer.begin() + i);
7216
            o->write_characters(number_buffer.data(), i);
7217
        }
7218

N
Niels Lohmann 已提交
7219 7220 7221 7222 7223 7224 7225 7226
        /*!
        @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
        */
7227
        void dump_float(number_float_t x)
7228
        {
7229 7230 7231
            // NaN / inf
            if (not std::isfinite(x) or std::isnan(x))
            {
7232
                o->write_characters("null", 4);
7233 7234 7235
                return;
            }

7236 7237 7238 7239
            // special case for 0.0 and -0.0
            if (x == 0)
            {
                if (std::signbit(x))
7240
                {
7241
                    o->write_characters("-0.0", 4);
7242
                }
7243
                else
7244
                {
7245
                    o->write_characters("0.0", 3);
7246
                }
7247
                return;
7248 7249
            }

7250 7251
            // get number of digits for a text -> float -> text round-trip
            static constexpr auto d = std::numeric_limits<number_float_t>::digits10;
7252

7253
            // the actual conversion
7254 7255
            std::ptrdiff_t len = snprintf(number_buffer.data(), number_buffer.size(),
                                          "%.*g", d, x);
7256

7257
            // negative value indicates an error
N
Niels Lohmann 已提交
7258
            assert(len > 0);
7259
            // check if buffer was large enough
N
Niels Lohmann 已提交
7260
            assert(static_cast<size_t>(len) < number_buffer.size());
7261

7262 7263 7264
            // erase thousands separator
            if (thousands_sep != '\0')
            {
N
Niels Lohmann 已提交
7265 7266 7267 7268 7269 7270
                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());
7271
            }
7272

7273 7274 7275
            // convert decimal point to '.'
            if (decimal_point != '\0' and decimal_point != '.')
            {
N
Niels Lohmann 已提交
7276
                for (auto& c : number_buffer)
7277
                {
7278
                    if (c == decimal_point)
7279
                    {
7280 7281
                        c = '.';
                        break;
7282 7283
                    }
                }
7284
            }
7285

7286
            o->write_characters(number_buffer.data(), static_cast<size_t>(len));
N
Niels Lohmann 已提交
7287

7288
            // determine if need to append ".0"
N
Niels Lohmann 已提交
7289 7290 7291
            const bool value_is_int_like = std::none_of(number_buffer.begin(),
                                           number_buffer.begin() + len + 1,
                                           [](char c)
7292
            {
N
Niels Lohmann 已提交
7293 7294
                return c == '.' or c == 'e';
            });
7295

7296 7297
            if (value_is_int_like)
            {
7298
                o->write_characters(".0", 2);
7299
            }
7300
        }
7301 7302

      private:
N
Niels Lohmann 已提交
7303
        /// the output of the serializer
7304
        output_adapter_t<char> o = nullptr;
7305 7306

        /// a (hopefully) large enough character buffer
N
Niels Lohmann 已提交
7307
        std::array<char, 64> number_buffer{{}};
7308

N
Niels Lohmann 已提交
7309
        /// the locale
7310
        const std::lconv* loc = nullptr;
N
Niels Lohmann 已提交
7311
        /// the locale's thousand separator character
7312
        const char thousands_sep = '\0';
N
Niels Lohmann 已提交
7313
        /// the locale's decimal point character
7314 7315
        const char decimal_point = '\0';

7316 7317 7318
        /// the indentation character
        const char indent_char;

N
Niels Lohmann 已提交
7319
        /// the indentation string
7320
        string_t indent_string;
7321 7322 7323
    };

  public:
N
Niels 已提交
7324 7325 7326 7327
    /*!
    @brief serialize to stream

    Serialize the given JSON value @a j to the output stream @a o. The JSON
7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338
    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 已提交
7339 7340 7341 7342 7343 7344 7345 7346

    @param[in,out] o  stream to serialize to
    @param[in] j  JSON value to serialize

    @return the stream @a o

    @complexity Linear.

N
Niels 已提交
7347 7348
    @liveexample{The example below shows the serialization with different
    parameters to `width` to adjust the indentation level.,operator_serialize}
N
Niels 已提交
7349

7350
    @since version 1.0.0; indentaction character added in version 3.0.0
N
Niels 已提交
7351
    */
N
Niels 已提交
7352 7353
    friend std::ostream& operator<<(std::ostream& o, const basic_json& j)
    {
N
Niels 已提交
7354
        // read width member and use it as indentation parameter if nonzero
N
Niels 已提交
7355 7356
        const bool pretty_print = (o.width() > 0);
        const auto indentation = (pretty_print ? o.width() : 0);
N
Niels 已提交
7357

N
Niels 已提交
7358 7359
        // reset width to 0 for subsequent calls to this stream
        o.width(0);
7360

N
Niels 已提交
7361
        // do the actual serialization
7362
        serializer s(output_adapter<char>::create(o), o.fill());
7363
        s.dump(j, pretty_print, static_cast<unsigned int>(indentation));
N
Niels 已提交
7364 7365 7366
        return o;
    }

N
Niels 已提交
7367 7368
    /*!
    @brief serialize to stream
7369 7370 7371 7372
    @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 已提交
7373
    */
7374
    JSON_DEPRECATED
N
Niels 已提交
7375 7376
    friend std::ostream& operator>>(const basic_json& j, std::ostream& o)
    {
N
Niels 已提交
7377
        return o << j;
N
Niels 已提交
7378 7379
    }

N
Niels 已提交
7380 7381
    /// @}

N
Niels 已提交
7382 7383 7384 7385 7386

    /////////////////////
    // deserialization //
    /////////////////////

N
Niels 已提交
7387 7388 7389
    /// @name deserialization
    /// @{

N
Niels 已提交
7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405
    /*!
    @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

7406 7407
    @throw parse_error.101 if a parse error occurs; example: `""unexpected end
    of input; expected string literal""`
N
Niels Lohmann 已提交
7408 7409
    @throw parse_error.102 if to_unicode fails or surrogate error
    @throw parse_error.103 if to_unicode fails
7410

N
Niels 已提交
7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429
    @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);
    }

7430 7431 7432 7433 7434 7435 7436
    template<class T, std::size_t N>
    static bool accept(T (&array)[N])
    {
        // delegate the call to the iterator-range accept overload
        return accept(std::begin(array), std::end(array));
    }

N
Niels 已提交
7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447
    /*!
    @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 已提交
7448 7449 7450 7451
    @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 已提交
7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467
    @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)
    */
7468 7469 7470 7471 7472
    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 已提交
7473 7474
                            const parser_callback_t cb = nullptr)
    {
7475
        return parser(input_adapter::create(s), cb).parse(true);
N
Niels 已提交
7476 7477
    }

7478 7479 7480 7481 7482 7483 7484 7485 7486
    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 bool accept(const CharT s)
    {
        return parser(input_adapter::create(s)).accept(true);
    }

N
Niels 已提交
7487 7488 7489 7490
    /*!
    @brief deserialize from stream

    @param[in,out] i  stream to read a serialized JSON value from
N
Niels 已提交
7491 7492 7493
    @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 已提交
7494 7495 7496

    @return result of the deserialization

N
Niels Lohmann 已提交
7497 7498 7499 7500
    @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 已提交
7501 7502 7503 7504
    @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 已提交
7505 7506
    @note A UTF-8 byte order mark is silently ignored.

N
Niels 已提交
7507 7508
    @liveexample{The example below demonstrates the `parse()` function with
    and without callback function.,parse__istream__parser_callback_t}
N
Niels 已提交
7509

7510
    @sa @ref parse(const CharT, const parser_callback_t) for a version
N
Niels 已提交
7511
    that reads from a string
N
Niels 已提交
7512

N
Niels 已提交
7513
    @since version 1.0.0
N
Niels 已提交
7514
    */
N
Niels 已提交
7515 7516
    static basic_json parse(std::istream& i,
                            const parser_callback_t cb = nullptr)
N
Niels 已提交
7517
    {
7518
        return parser(input_adapter::create(i), cb).parse(true);
N
Niels 已提交
7519 7520
    }

7521 7522 7523 7524 7525
    static bool accept(std::istream& i)
    {
        return parser(input_adapter::create(i)).accept(true);
    }

N
Niels 已提交
7526
    /*!
N
Niels 已提交
7527
    @copydoc parse(std::istream&, const parser_callback_t)
N
Niels 已提交
7528
    */
N
Niels 已提交
7529 7530
    static basic_json parse(std::istream&& i,
                            const parser_callback_t cb = nullptr)
N
Cleanup  
Niels 已提交
7531
    {
7532
        return parser(input_adapter::create(i), cb).parse(true);
N
Cleanup  
Niels 已提交
7533 7534
    }

7535 7536 7537 7538 7539
    static bool accept(std::istream&& i)
    {
        return parser(input_adapter::create(i)).accept(true);
    }

7540
    /*!
N
Niels 已提交
7541
    @brief deserialize from an iterator range with contiguous storage
7542

7543 7544
    This function reads from an iterator range of a container with contiguous
    storage of 1-byte values. Compatible container types include
7545 7546 7547 7548 7549 7550 7551 7552 7553
    `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
7554
    with a static assertion.**
7555

N
Niels 已提交
7556 7557 7558 7559
    @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.
7560

N
Niels 已提交
7561
    @tparam IteratorType iterator of container with contiguous storage
N
Niels 已提交
7562 7563 7564
    @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
7565 7566 7567 7568 7569
    which is used to control the deserialization by filtering unwanted values
    (optional)

    @return result of the deserialization

N
Niels Lohmann 已提交
7570 7571 7572 7573
    @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

7574 7575 7576 7577 7578 7579
    @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 已提交
7580 7581
    @liveexample{The example below demonstrates the `parse()` function reading
    from an iterator range.,parse__iteratortype__parser_callback_t}
7582 7583 7584

    @since version 2.0.3
    */
N
Niels 已提交
7585 7586 7587 7588
    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>
7589 7590 7591
    static basic_json parse(IteratorType first, IteratorType last,
                            const parser_callback_t cb = nullptr)
    {
7592
        return parser(input_adapter::create(first, last), cb).parse(true);
7593 7594
    }

7595 7596 7597 7598 7599 7600 7601 7602 7603
    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>
    static bool accept(IteratorType first, IteratorType last)
    {
        return parser(input_adapter::create(first, last)).accept(true);
    }

N
Niels 已提交
7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624
    /*!
    @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 已提交
7625
    @tparam ContiguousContainer container type with contiguous storage
N
Niels 已提交
7626 7627 7628 7629 7630 7631 7632
    @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 已提交
7633 7634 7635 7636
    @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 已提交
7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647
    @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 已提交
7648
    template<class ContiguousContainer, typename std::enable_if<
N
Niels 已提交
7649
                 not std::is_pointer<ContiguousContainer>::value and
7650 7651
                 std::is_base_of<
                     std::random_access_iterator_tag,
N
Niels 已提交
7652
                     typename std::iterator_traits<decltype(std::begin(std::declval<ContiguousContainer const>()))>::iterator_category>::value
7653 7654 7655 7656 7657 7658 7659 7660
                 , 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);
    }

7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672
    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 bool accept(const ContiguousContainer& c)
    {
        // delegate the call to the iterator-range accept overload
        return accept(std::begin(c), std::end(c));
    }

7673 7674 7675 7676 7677 7678 7679 7680 7681 7682
    /*!
    @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 已提交
7683
        j = parser(input_adapter::create(i)).parse(false);
7684 7685 7686
        return i;
    }

N
Niels 已提交
7687 7688 7689 7690 7691 7692 7693 7694
    /*!
    @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 已提交
7695 7696 7697
    @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 已提交
7698 7699 7700 7701

    @complexity Linear in the length of the input. The parser is a predictive
    LL(1) parser.

N
Niels 已提交
7702 7703
    @note A UTF-8 byte order mark is silently ignored.

N
Niels 已提交
7704 7705 7706
    @liveexample{The example below shows how a JSON value is constructed by
    reading a serialization from a stream.,operator_deserialize}

N
Niels 已提交
7707 7708
    @sa parse(std::istream&, const parser_callback_t) for a variant with a
    parser callback function to filter values while parsing
N
Niels 已提交
7709

N
Niels 已提交
7710
    @since version 1.0.0
N
Niels 已提交
7711 7712
    */
    friend std::istream& operator>>(std::istream& i, basic_json& j)
N
Niels 已提交
7713
    {
N
Niels Lohmann 已提交
7714
        j = parser(input_adapter::create(i)).parse(false);
N
Niels 已提交
7715 7716 7717
        return i;
    }

N
Niels 已提交
7718 7719
    /// @}

N
Niels 已提交
7720 7721 7722 7723
    ///////////////////////////
    // convenience functions //
    ///////////////////////////

N
Niels 已提交
7724 7725 7726 7727 7728 7729
    /*!
    @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 已提交
7730
    @return basically a string representation of a the @a m_type member
N
Niels 已提交
7731 7732 7733

    @complexity Constant.

7734
    @liveexample{The following code exemplifies `type_name()` for all JSON
7735
    types.,type_name}
7736

7737
    @since version 1.0.0, public since 2.1.0
N
Niels 已提交
7738
    */
T
Théo DELRIEU 已提交
7739 7740
    std::string type_name() const
    {
T
Théo DELRIEU 已提交
7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759
        {
            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 已提交
7760
    }
N
Niels 已提交
7761 7762 7763 7764 7765 7766 7767 7768


  private:
    //////////////////////
    // member variables //
    //////////////////////

    /// the type of the current element
N
Niels 已提交
7769
    value_t m_type = value_t::null;
N
Niels 已提交
7770 7771 7772 7773

    /// the value of the current element
    json_value m_value = {};

N
Niels 已提交
7774

N
Niels 已提交
7775
  private:
N
Niels 已提交
7776 7777 7778 7779
    ///////////////
    // iterators //
    ///////////////

7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790
    /*!
    @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 已提交
7791
      public:
T
Théo Delrieu 已提交
7792 7793

        difference_type get_value() const noexcept
T
Théo DELRIEU 已提交
7794 7795 7796 7797 7798 7799 7800 7801
        {
            return m_it;
        }
        /// set iterator to a defined beginning
        void set_begin() noexcept
        {
            m_it = begin_value;
        }
7802

T
Théo DELRIEU 已提交
7803 7804 7805 7806 7807
        /// set iterator to a defined past the end
        void set_end() noexcept
        {
            m_it = end_value;
        }
7808

T
Théo DELRIEU 已提交
7809 7810 7811 7812 7813
        /// return whether the iterator can be dereferenced
        constexpr bool is_begin() const noexcept
        {
            return (m_it == begin_value);
        }
7814

T
Théo DELRIEU 已提交
7815 7816 7817 7818 7819
        /// return whether the iterator is at end
        constexpr bool is_end() const noexcept
        {
            return (m_it == end_value);
        }
7820

T
Théo DELRIEU 已提交
7821 7822 7823 7824
        friend constexpr bool operator==(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it == rhs.m_it;
        }
T
Théo Delrieu 已提交
7825

T
Théo DELRIEU 已提交
7826 7827 7828 7829
        friend constexpr bool operator!=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return !(lhs == rhs);
        }
T
Théo Delrieu 已提交
7830

T
Théo DELRIEU 已提交
7831 7832 7833 7834
        friend constexpr bool operator<(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it < rhs.m_it;
        }
T
Théo Delrieu 已提交
7835

T
Théo DELRIEU 已提交
7836 7837 7838 7839
        friend constexpr bool operator<=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it <= rhs.m_it;
        }
T
Théo Delrieu 已提交
7840

T
Théo DELRIEU 已提交
7841 7842 7843 7844
        friend constexpr bool operator>(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it > rhs.m_it;
        }
T
Théo Delrieu 已提交
7845

T
Théo DELRIEU 已提交
7846 7847 7848 7849
        friend constexpr bool operator>=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it >= rhs.m_it;
        }
T
Théo Delrieu 已提交
7850

T
Théo DELRIEU 已提交
7851 7852 7853 7854 7855 7856
        primitive_iterator_t operator+(difference_type i)
        {
            auto result = *this;
            result += i;
            return result;
        }
T
Théo Delrieu 已提交
7857

T
Théo DELRIEU 已提交
7858 7859 7860 7861
        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 已提交
7862

T
Théo DELRIEU 已提交
7863 7864 7865 7866
        friend std::ostream& operator<<(std::ostream& os, primitive_iterator_t it)
        {
            return os << it.m_it;
        }
T
Théo Delrieu 已提交
7867

T
Théo DELRIEU 已提交
7868 7869 7870 7871 7872
        primitive_iterator_t& operator++()
        {
            ++m_it;
            return *this;
        }
T
Théo Delrieu 已提交
7873

N
Niels Lohmann 已提交
7874
        primitive_iterator_t operator++(int)
T
Théo DELRIEU 已提交
7875
        {
N
Niels Lohmann 已提交
7876
            auto result = *this;
T
Théo DELRIEU 已提交
7877
            m_it++;
N
Niels Lohmann 已提交
7878
            return result;
T
Théo DELRIEU 已提交
7879
        }
T
Théo Delrieu 已提交
7880

T
Théo DELRIEU 已提交
7881 7882 7883 7884 7885
        primitive_iterator_t& operator--()
        {
            --m_it;
            return *this;
        }
T
Théo Delrieu 已提交
7886

N
Niels Lohmann 已提交
7887
        primitive_iterator_t operator--(int)
T
Théo DELRIEU 已提交
7888
        {
N
Niels Lohmann 已提交
7889
            auto result = *this;
T
Théo DELRIEU 已提交
7890
            m_it--;
N
Niels Lohmann 已提交
7891
            return result;
T
Théo DELRIEU 已提交
7892
        }
T
Théo Delrieu 已提交
7893

T
Théo DELRIEU 已提交
7894 7895 7896 7897 7898
        primitive_iterator_t& operator+=(difference_type n)
        {
            m_it += n;
            return *this;
        }
7899

T
Théo DELRIEU 已提交
7900 7901 7902 7903 7904
        primitive_iterator_t& operator-=(difference_type n)
        {
            m_it -= n;
            return *this;
        }
7905

T
Théo DELRIEU 已提交
7906 7907 7908
      private:
        static constexpr difference_type begin_value = 0;
        static constexpr difference_type end_value = begin_value + 1;
7909

T
Théo DELRIEU 已提交
7910 7911 7912
        /// iterator as signed integer type
        difference_type m_it = std::numeric_limits<std::ptrdiff_t>::denorm_min();
    };
7913

N
Niels 已提交
7914 7915 7916 7917 7918 7919 7920 7921
    /*!
    @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 已提交
7922 7923
    {
        /// iterator for JSON objects
N
Niels 已提交
7924
        typename object_t::iterator object_iterator;
N
Niels 已提交
7925
        /// iterator for JSON arrays
N
Niels 已提交
7926
        typename array_t::iterator array_iterator;
N
Niels 已提交
7927
        /// generic iterator for all other types
N
Niels 已提交
7928 7929 7930
        primitive_iterator_t primitive_iterator;

        /// create an uninitialized internal_iterator
N
Niels 已提交
7931
        internal_iterator() noexcept
T
Théo DELRIEU 已提交
7932 7933
            : object_iterator(), array_iterator(), primitive_iterator()
        {}
N
Niels 已提交
7934 7935
    };

N
cleanup  
Niels 已提交
7936 7937 7938 7939
    /// proxy class for the iterator_wrapper functions
    template<typename IteratorType>
    class iteration_proxy
    {
T
Théo DELRIEU 已提交
7940
      private:
N
cleanup  
Niels 已提交
7941 7942 7943
        /// helper class for iteration
        class iteration_proxy_internal
        {
T
Théo DELRIEU 已提交
7944
          private:
N
cleanup  
Niels 已提交
7945 7946 7947 7948 7949
            /// the iterator
            IteratorType anchor;
            /// an index for arrays (used to create key names)
            size_t array_index = 0;

T
Théo DELRIEU 已提交
7950
          public:
N
Niels 已提交
7951
            explicit iteration_proxy_internal(IteratorType it) noexcept
7952
                : anchor(it)
T
Théo DELRIEU 已提交
7953
            {}
N
cleanup  
Niels 已提交
7954

T
Théo DELRIEU 已提交
7955 7956 7957 7958 7959
            /// dereference operator (needed for range-based for)
            iteration_proxy_internal& operator*()
            {
                return *this;
            }
7960

T
Théo DELRIEU 已提交
7961 7962 7963 7964 7965
            /// increment operator (needed for range-based for)
            iteration_proxy_internal& operator++()
            {
                ++anchor;
                ++array_index;
7966

T
Théo DELRIEU 已提交
7967 7968
                return *this;
            }
N
cleanup  
Niels 已提交
7969

T
Théo DELRIEU 已提交
7970 7971
            /// inequality operator (needed for range-based for)
            bool operator!= (const iteration_proxy_internal& o) const
N
cleanup  
Niels 已提交
7972
            {
T
Théo DELRIEU 已提交
7973
                return anchor != o.anchor;
N
cleanup  
Niels 已提交
7974 7975
            }

T
Théo DELRIEU 已提交
7976 7977
            /// return key of the iterator
            typename basic_json::string_t key() const
N
cleanup  
Niels 已提交
7978
            {
T
Théo DELRIEU 已提交
7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000
                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 已提交
8001 8002
            }

T
Théo DELRIEU 已提交
8003 8004
            /// return value of the iterator
            typename IteratorType::reference value() const
N
cleanup  
Niels 已提交
8005
            {
T
Théo DELRIEU 已提交
8006
                return anchor.value();
N
cleanup  
Niels 已提交
8007 8008 8009
            }
        };

T
Théo DELRIEU 已提交
8010 8011
        /// the container to iterate
        typename IteratorType::reference container;
N
cleanup  
Niels 已提交
8012

T
Théo DELRIEU 已提交
8013 8014 8015 8016 8017
      public:
        /// construct iteration proxy from a container
        explicit iteration_proxy(typename IteratorType::reference cont)
            : container(cont)
        {}
N
cleanup  
Niels 已提交
8018

T
Théo DELRIEU 已提交
8019 8020 8021 8022 8023
        /// return iterator begin (needed for range-based for)
        iteration_proxy_internal begin() noexcept
        {
            return iteration_proxy_internal(container.begin());
        }
N
cleanup  
Niels 已提交
8024

T
Théo DELRIEU 已提交
8025 8026 8027 8028 8029 8030
        /// return iterator end (needed for range-based for)
        iteration_proxy_internal end() noexcept
        {
            return iteration_proxy_internal(container.end());
        }
    };
N
cleanup  
Niels 已提交
8031

N
Niels 已提交
8032
  public:
N
Niels 已提交
8033
    /*!
8034
    @brief a template for a random access iterator for the @ref basic_json class
N
Niels 已提交
8035

N
Niels Lohmann 已提交
8036 8037
    This class implements a both iterators (iterator and const_iterator) for the
    @ref basic_json class.
N
Niels 已提交
8038

N
Niels 已提交
8039 8040 8041
    @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 已提交
8042 8043
          methods are undefined. **The library uses assertions to detect calls
          on uninitialized iterators.**
N
Niels 已提交
8044

N
Niels 已提交
8045 8046 8047 8048
    @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 已提交
8049

N
Niels Lohmann 已提交
8050
    @since version 1.0.0, simplified in version 2.0.9
N
Niels 已提交
8051
    */
N
Niels Lohmann 已提交
8052
    template<typename U>
T
Théo DELRIEU 已提交
8053
    class iter_impl : public std::iterator<std::random_access_iterator_tag, U>
N
Niels 已提交
8054
    {
N
Niels 已提交
8055
        /// allow basic_json to access private members
8056 8057
        friend class basic_json;

8058 8059 8060 8061 8062
        // 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 已提交
8063
      public:
N
Niels 已提交
8064
        /// the type of the values when the iterator is dereferenced
N
Niels 已提交
8065
        using value_type = typename basic_json::value_type;
N
Niels 已提交
8066
        /// a type to represent differences between iterators
N
Niels 已提交
8067
        using difference_type = typename basic_json::difference_type;
N
Niels 已提交
8068
        /// defines a pointer to the type iterated over (value_type)
8069
        using pointer = typename std::conditional<std::is_const<U>::value,
T
Théo DELRIEU 已提交
8070 8071
              typename basic_json::const_pointer,
              typename basic_json::pointer>::type;
N
Niels 已提交
8072
        /// defines a reference to the type iterated over (value_type)
8073
        using reference = typename std::conditional<std::is_const<U>::value,
T
Théo DELRIEU 已提交
8074 8075
              typename basic_json::const_reference,
              typename basic_json::reference>::type;
N
Niels 已提交
8076
        /// the category of the iterator
8077
        using iterator_category = std::bidirectional_iterator_tag;
N
Niels 已提交
8078

8079
        /// default constructor
8080
        iter_impl() = default;
8081

N
Niels 已提交
8082 8083 8084 8085 8086 8087
        /*!
        @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`.
        */
8088
        explicit iter_impl(pointer object) noexcept
T
Théo DELRIEU 已提交
8089
            : m_object(object)
8090
        {
T
Théo DELRIEU 已提交
8091
            assert(m_object != nullptr);
8092

T
Théo DELRIEU 已提交
8093
            switch (m_object->m_type)
8094
            {
T
Théo DELRIEU 已提交
8095 8096 8097 8098 8099
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = typename object_t::iterator();
                    break;
                }
8100

T
Théo DELRIEU 已提交
8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111
                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 已提交
8112 8113
            }
        }
N
Niels 已提交
8114

8115
        /*!
8116 8117
        @note The conventional copy constructor and copy assignment are
              implicitly defined.
N
Niels Lohmann 已提交
8118
              Combined with the following converting constructor and assignment,
H
HenryLee 已提交
8119 8120
              they support: copy from iterator to iterator,
                            copy from const iterator to const iterator,
8121
                            and conversion from iterator to const iterator.
8122
              However conversion from const iterator to iterator is not defined.
T
Théo DELRIEU 已提交
8123
        */
N
Niels 已提交
8124

T
Théo DELRIEU 已提交
8125
        /*!
8126 8127
        @brief converting constructor
        @param[in] other  non-const iterator to copy from
T
Théo DELRIEU 已提交
8128 8129
        @note It is not checked whether @a other is initialized.
        */
8130
        iter_impl(const iter_impl<basic_json>& other) noexcept
T
Théo DELRIEU 已提交
8131 8132
            : m_object(other.m_object), m_it(other.m_it)
        {}
N
Niels 已提交
8133

T
Théo DELRIEU 已提交
8134
        /*!
8135
        @brief converting assignment
8136
        @param[in,out] other  non-const iterator to copy from
H
HenryLee 已提交
8137
        @return const/non-const iterator
T
Théo DELRIEU 已提交
8138 8139
        @note It is not checked whether @a other is initialized.
        */
8140 8141 8142 8143
        iter_impl& operator=(const iter_impl<basic_json>& other) noexcept
        {
            m_object = other.m_object;
            m_it = other.m_it;
T
Théo DELRIEU 已提交
8144 8145
            return *this;
        }
N
Niels 已提交
8146

T
Théo DELRIEU 已提交
8147 8148 8149 8150 8151 8152
      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 已提交
8153
        {
T
Théo DELRIEU 已提交
8154
            assert(m_object != nullptr);
N
Niels 已提交
8155

T
Théo DELRIEU 已提交
8156
            switch (m_object->m_type)
N
Niels 已提交
8157
            {
T
Théo DELRIEU 已提交
8158 8159 8160 8161 8162
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = m_object->m_value.object->begin();
                    break;
                }
N
Niels 已提交
8163

T
Théo DELRIEU 已提交
8164 8165 8166 8167 8168
                case basic_json::value_t::array:
                {
                    m_it.array_iterator = m_object->m_value.array->begin();
                    break;
                }
N
Niels 已提交
8169

T
Théo DELRIEU 已提交
8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181
                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 已提交
8182 8183 8184
            }
        }

T
Théo DELRIEU 已提交
8185 8186 8187 8188 8189
        /*!
        @brief set the iterator past the last value
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        void set_end() noexcept
8190
        {
T
Théo DELRIEU 已提交
8191
            assert(m_object != nullptr);
N
Niels 已提交
8192

T
Théo DELRIEU 已提交
8193
            switch (m_object->m_type)
8194
            {
T
Théo DELRIEU 已提交
8195 8196 8197 8198 8199
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = m_object->m_value.object->end();
                    break;
                }
N
Niels 已提交
8200

T
Théo DELRIEU 已提交
8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211
                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 已提交
8212 8213
            }
        }
N
Niels 已提交
8214

T
Théo DELRIEU 已提交
8215 8216 8217 8218 8219 8220
      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
8221
        {
T
Théo DELRIEU 已提交
8222
            assert(m_object != nullptr);
N
Niels 已提交
8223

T
Théo DELRIEU 已提交
8224
            switch (m_object->m_type)
8225
            {
T
Théo DELRIEU 已提交
8226 8227 8228 8229 8230
                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 已提交
8231

T
Théo DELRIEU 已提交
8232 8233 8234 8235 8236
                case basic_json::value_t::array:
                {
                    assert(m_it.array_iterator != m_object->m_value.array->end());
                    return *m_it.array_iterator;
                }
N
Niels 已提交
8237

T
Théo DELRIEU 已提交
8238
                case basic_json::value_t::null:
N
Niels 已提交
8239
                {
8240
                    JSON_THROW(invalid_iterator::create(214, "cannot get value"));
N
Niels 已提交
8241 8242
                }

T
Théo DELRIEU 已提交
8243 8244 8245 8246 8247 8248 8249
                default:
                {
                    if (m_it.primitive_iterator.is_begin())
                    {
                        return *m_object;
                    }

8250
                    JSON_THROW(invalid_iterator::create(214, "cannot get value"));
T
Théo DELRIEU 已提交
8251
                }
N
Niels 已提交
8252 8253 8254
            }
        }

T
Théo DELRIEU 已提交
8255 8256 8257 8258 8259
        /*!
        @brief dereference the iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        pointer operator->() const
N
Niels 已提交
8260
        {
T
Théo DELRIEU 已提交
8261
            assert(m_object != nullptr);
N
Niels 已提交
8262

T
Théo DELRIEU 已提交
8263
            switch (m_object->m_type)
N
Niels 已提交
8264
            {
T
Théo DELRIEU 已提交
8265 8266 8267 8268 8269
                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 已提交
8270

T
Théo DELRIEU 已提交
8271
                case basic_json::value_t::array:
N
Niels 已提交
8272
                {
T
Théo DELRIEU 已提交
8273 8274
                    assert(m_it.array_iterator != m_object->m_value.array->end());
                    return &*m_it.array_iterator;
N
Niels 已提交
8275 8276
                }

T
Théo DELRIEU 已提交
8277 8278 8279 8280 8281 8282 8283
                default:
                {
                    if (m_it.primitive_iterator.is_begin())
                    {
                        return m_object;
                    }

8284
                    JSON_THROW(invalid_iterator::create(214, "cannot get value"));
T
Théo DELRIEU 已提交
8285
                }
N
Niels 已提交
8286 8287 8288
            }
        }

T
Théo DELRIEU 已提交
8289 8290 8291 8292 8293 8294 8295 8296 8297 8298
        /*!
        @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 已提交
8299

T
Théo DELRIEU 已提交
8300 8301 8302 8303 8304
        /*!
        @brief pre-increment (++it)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator++()
8305
        {
T
Théo DELRIEU 已提交
8306
            assert(m_object != nullptr);
N
Niels 已提交
8307

T
Théo DELRIEU 已提交
8308
            switch (m_object->m_type)
8309
            {
T
Théo DELRIEU 已提交
8310 8311 8312 8313 8314
                case basic_json::value_t::object:
                {
                    std::advance(m_it.object_iterator, 1);
                    break;
                }
N
Niels 已提交
8315

T
Théo DELRIEU 已提交
8316 8317 8318 8319 8320
                case basic_json::value_t::array:
                {
                    std::advance(m_it.array_iterator, 1);
                    break;
                }
N
Niels 已提交
8321

T
Théo DELRIEU 已提交
8322 8323 8324 8325 8326 8327
                default:
                {
                    ++m_it.primitive_iterator;
                    break;
                }
            }
8328

T
Théo DELRIEU 已提交
8329 8330
            return *this;
        }
8331

T
Théo DELRIEU 已提交
8332 8333 8334 8335 8336 8337 8338 8339 8340 8341
        /*!
        @brief post-decrement (it--)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl operator--(int)
        {
            auto result = *this;
            --(*this);
            return result;
        }
8342

T
Théo DELRIEU 已提交
8343 8344 8345 8346 8347
        /*!
        @brief pre-decrement (--it)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator--()
N
Niels 已提交
8348
        {
T
Théo DELRIEU 已提交
8349 8350 8351
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
8352
            {
T
Théo DELRIEU 已提交
8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369
                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 已提交
8370 8371
            }

T
Théo DELRIEU 已提交
8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382
            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 已提交
8383
            {
8384
                JSON_THROW(invalid_iterator::create(212, "cannot compare iterators of different containers"));
8385
            }
N
Niels 已提交
8386

T
Théo DELRIEU 已提交
8387 8388 8389
            assert(m_object != nullptr);

            switch (m_object->m_type)
8390
            {
T
Théo DELRIEU 已提交
8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404
                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 已提交
8405 8406 8407
            }
        }

T
Théo DELRIEU 已提交
8408 8409 8410 8411 8412
        /*!
        @brief  comparison: not equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator!=(const iter_impl& other) const
N
Niels 已提交
8413
        {
T
Théo DELRIEU 已提交
8414
            return not operator==(other);
N
Niels 已提交
8415 8416
        }

T
Théo DELRIEU 已提交
8417 8418 8419 8420 8421
        /*!
        @brief  comparison: smaller
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator<(const iter_impl& other) const
N
Niels 已提交
8422
        {
T
Théo DELRIEU 已提交
8423 8424
            // if objects are not the same, the comparison is undefined
            if (m_object != other.m_object)
N
Niels 已提交
8425
            {
8426
                JSON_THROW(invalid_iterator::create(212, "cannot compare iterators of different containers"));
N
Niels 已提交
8427 8428
            }

T
Théo DELRIEU 已提交
8429
            assert(m_object != nullptr);
N
Niels 已提交
8430

T
Théo DELRIEU 已提交
8431
            switch (m_object->m_type)
8432
            {
T
Théo DELRIEU 已提交
8433 8434
                case basic_json::value_t::object:
                {
8435
                    JSON_THROW(invalid_iterator::create(213, "cannot compare order of object iterators"));
T
Théo DELRIEU 已提交
8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446
                }

                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 已提交
8447 8448 8449
            }
        }

T
Théo DELRIEU 已提交
8450 8451 8452 8453 8454
        /*!
        @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 已提交
8455
        {
T
Théo DELRIEU 已提交
8456
            return not other.operator < (*this);
N
Niels 已提交
8457 8458
        }

T
Théo DELRIEU 已提交
8459 8460 8461 8462 8463
        /*!
        @brief  comparison: greater than
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator>(const iter_impl& other) const
N
Niels 已提交
8464
        {
T
Théo DELRIEU 已提交
8465
            return not operator<=(other);
N
Niels 已提交
8466
        }
8467

T
Théo DELRIEU 已提交
8468 8469 8470 8471 8472 8473 8474 8475
        /*!
        @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);
        }
8476

T
Théo DELRIEU 已提交
8477 8478 8479 8480 8481
        /*!
        @brief  add to iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator+=(difference_type i)
N
Niels 已提交
8482
        {
T
Théo DELRIEU 已提交
8483 8484 8485
            assert(m_object != nullptr);

            switch (m_object->m_type)
8486
            {
T
Théo DELRIEU 已提交
8487 8488
                case basic_json::value_t::object:
                {
8489
                    JSON_THROW(invalid_iterator::create(209, "cannot use offsets with object iterators"));
T
Théo DELRIEU 已提交
8490
                }
8491

T
Théo DELRIEU 已提交
8492 8493 8494 8495 8496
                case basic_json::value_t::array:
                {
                    std::advance(m_it.array_iterator, i);
                    break;
                }
8497

T
Théo DELRIEU 已提交
8498 8499 8500 8501 8502
                default:
                {
                    m_it.primitive_iterator += i;
                    break;
                }
8503 8504
            }

T
Théo DELRIEU 已提交
8505 8506
            return *this;
        }
8507

T
Théo DELRIEU 已提交
8508 8509 8510 8511 8512 8513 8514 8515
        /*!
        @brief  subtract from iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator-=(difference_type i)
        {
            return operator+=(-i);
        }
8516

T
Théo DELRIEU 已提交
8517 8518 8519 8520
        /*!
        @brief  add to iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
8521
        iter_impl operator+(difference_type i) const
T
Théo DELRIEU 已提交
8522 8523 8524 8525 8526
        {
            auto result = *this;
            result += i;
            return result;
        }
8527

8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538
        /*!
        @brief  addition of distance and iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        friend iter_impl operator+(difference_type i, const iter_impl& it)
        {
            auto result = it;
            result += i;
            return result;
        }

T
Théo DELRIEU 已提交
8539 8540 8541 8542
        /*!
        @brief  subtract from iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
8543
        iter_impl operator-(difference_type i) const
T
Théo DELRIEU 已提交
8544 8545 8546 8547 8548
        {
            auto result = *this;
            result -= i;
            return result;
        }
N
Niels 已提交
8549

T
Théo DELRIEU 已提交
8550 8551 8552 8553 8554
        /*!
        @brief  return difference
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        difference_type operator-(const iter_impl& other) const
8555
        {
T
Théo DELRIEU 已提交
8556 8557 8558
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
8559
            {
T
Théo DELRIEU 已提交
8560 8561
                case basic_json::value_t::object:
                {
8562
                    JSON_THROW(invalid_iterator::create(209, "cannot use offsets with object iterators"));
T
Théo DELRIEU 已提交
8563
                }
N
Niels 已提交
8564

T
Théo DELRIEU 已提交
8565 8566 8567 8568
                case basic_json::value_t::array:
                {
                    return m_it.array_iterator - other.m_it.array_iterator;
                }
N
Niels 已提交
8569

T
Théo DELRIEU 已提交
8570 8571 8572 8573
                default:
                {
                    return m_it.primitive_iterator - other.m_it.primitive_iterator;
                }
N
Niels 已提交
8574 8575
            }
        }
N
Niels 已提交
8576

T
Théo DELRIEU 已提交
8577 8578 8579 8580 8581
        /*!
        @brief  access to successor
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        reference operator[](difference_type n) const
8582
        {
T
Théo DELRIEU 已提交
8583 8584 8585
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
8586
            {
T
Théo DELRIEU 已提交
8587 8588
                case basic_json::value_t::object:
                {
8589
                    JSON_THROW(invalid_iterator::create(208, "cannot use operator[] for object iterators"));
T
Théo DELRIEU 已提交
8590
                }
N
Niels 已提交
8591

T
Théo DELRIEU 已提交
8592 8593 8594 8595
                case basic_json::value_t::array:
                {
                    return *std::next(m_it.array_iterator, n);
                }
N
Niels 已提交
8596

T
Théo DELRIEU 已提交
8597 8598
                case basic_json::value_t::null:
                {
8599
                    JSON_THROW(invalid_iterator::create(214, "cannot get value"));
T
Théo DELRIEU 已提交
8600
                }
N
Niels 已提交
8601

T
Théo DELRIEU 已提交
8602
                default:
N
Niels 已提交
8603
                {
T
Théo DELRIEU 已提交
8604 8605 8606 8607
                    if (m_it.primitive_iterator.get_value() == -n)
                    {
                        return *m_object;
                    }
N
Niels Lohmann 已提交
8608

8609
                    JSON_THROW(invalid_iterator::create(214, "cannot get value"));
T
Théo DELRIEU 已提交
8610
                }
N
Niels 已提交
8611 8612
            }
        }
N
Niels 已提交
8613

T
Théo DELRIEU 已提交
8614 8615 8616 8617 8618
        /*!
        @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
8619
        {
T
Théo DELRIEU 已提交
8620 8621 8622 8623 8624 8625
            assert(m_object != nullptr);

            if (m_object->is_object())
            {
                return m_it.object_iterator->first;
            }
N
Niels Lohmann 已提交
8626

8627
            JSON_THROW(invalid_iterator::create(207, "cannot use key() for non-object iterators"));
T
Théo DELRIEU 已提交
8628
        }
N
Niels 已提交
8629

T
Théo DELRIEU 已提交
8630 8631 8632 8633 8634 8635 8636 8637
        /*!
        @brief  return the value of an iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        reference value() const
        {
            return operator*();
        }
N
Niels 已提交
8638

T
Théo DELRIEU 已提交
8639 8640 8641 8642
      private:
        /// associated JSON instance
        pointer m_object = nullptr;
        /// the actual iterator of the associated instance
8643
        struct internal_iterator m_it = internal_iterator();
T
Théo DELRIEU 已提交
8644
    };
N
Niels 已提交
8645

N
Niels 已提交
8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659
    /*!
    @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 已提交
8660

N
Niels 已提交
8661
    @since version 1.0.0
N
Niels 已提交
8662
    */
N
Niels 已提交
8663
    template<typename Base>
T
Théo DELRIEU 已提交
8664
    class json_reverse_iterator : public std::reverse_iterator<Base>
8665
    {
T
Théo DELRIEU 已提交
8666
      public:
8667
        /// shortcut to the reverse iterator adaptor
N
Niels 已提交
8668
        using base_iterator = std::reverse_iterator<Base>;
N
Niels 已提交
8669
        /// the reference type for the pointed-to element
N
Niels 已提交
8670
        using reference = typename Base::reference;
8671

8672
        /// create reverse iterator from iterator
8673
        json_reverse_iterator(const typename base_iterator::iterator_type& it) noexcept
T
Théo DELRIEU 已提交
8674 8675
            : base_iterator(it)
        {}
8676

T
Théo DELRIEU 已提交
8677 8678 8679 8680
        /// create reverse iterator from base class
        json_reverse_iterator(const base_iterator& it) noexcept
            : base_iterator(it)
        {}
8681

T
Théo DELRIEU 已提交
8682 8683 8684
        /// post-increment (it++)
        json_reverse_iterator operator++(int)
        {
8685
            return static_cast<json_reverse_iterator>(base_iterator::operator++(1));
T
Théo DELRIEU 已提交
8686
        }
8687

T
Théo DELRIEU 已提交
8688 8689 8690
        /// pre-increment (++it)
        json_reverse_iterator& operator++()
        {
8691
            return static_cast<json_reverse_iterator&>(base_iterator::operator++());
T
Théo DELRIEU 已提交
8692
        }
8693

T
Théo DELRIEU 已提交
8694 8695 8696
        /// post-decrement (it--)
        json_reverse_iterator operator--(int)
        {
8697
            return static_cast<json_reverse_iterator>(base_iterator::operator--(1));
T
Théo DELRIEU 已提交
8698
        }
8699

T
Théo DELRIEU 已提交
8700 8701 8702
        /// pre-decrement (--it)
        json_reverse_iterator& operator--()
        {
8703
            return static_cast<json_reverse_iterator&>(base_iterator::operator--());
T
Théo DELRIEU 已提交
8704
        }
8705

T
Théo DELRIEU 已提交
8706 8707 8708
        /// add to iterator
        json_reverse_iterator& operator+=(difference_type i)
        {
8709
            return static_cast<json_reverse_iterator&>(base_iterator::operator+=(i));
T
Théo DELRIEU 已提交
8710
        }
8711

T
Théo DELRIEU 已提交
8712 8713 8714
        /// add to iterator
        json_reverse_iterator operator+(difference_type i) const
        {
8715
            return static_cast<json_reverse_iterator>(base_iterator::operator+(i));
T
Théo DELRIEU 已提交
8716
        }
8717

T
Théo DELRIEU 已提交
8718 8719 8720
        /// subtract from iterator
        json_reverse_iterator operator-(difference_type i) const
        {
8721
            return static_cast<json_reverse_iterator>(base_iterator::operator-(i));
T
Théo DELRIEU 已提交
8722
        }
8723

T
Théo DELRIEU 已提交
8724 8725 8726
        /// return difference
        difference_type operator-(const json_reverse_iterator& other) const
        {
8727
            return base_iterator(*this) - base_iterator(other);
T
Théo DELRIEU 已提交
8728
        }
8729

T
Théo DELRIEU 已提交
8730 8731 8732
        /// access to successor
        reference operator[](difference_type n) const
        {
8733
            return *(this->operator+(n));
T
Théo DELRIEU 已提交
8734
        }
N
Niels 已提交
8735

T
Théo DELRIEU 已提交
8736 8737 8738 8739 8740 8741
        /// return the key of an object iterator
        typename object_t::key_type key() const
        {
            auto it = --this->base();
            return it.key();
        }
8742

T
Théo DELRIEU 已提交
8743 8744 8745 8746 8747 8748 8749
        /// return the value of an iterator
        reference value() const
        {
            auto it = --this->base();
            return it.operator * ();
        }
    };
8750

N
Niels 已提交
8751

N
Niels 已提交
8752
  private:
N
Niels Lohmann 已提交
8753 8754 8755
    ////////////////////
    // input adapters //
    ////////////////////
N
Niels 已提交
8756

N
Niels Lohmann 已提交
8757 8758 8759 8760 8761 8762 8763
    /// 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() {}
8764 8765 8766 8767

        // native support

        /// input adapter for input stream
8768
        static std::shared_ptr<input_adapter> create(std::istream& i)
8769
        {
8770
            return std::shared_ptr<input_adapter>(new cached_input_stream_adapter<16384>(i));
8771 8772 8773
        }

        /// input adapter for input stream
8774
        static std::shared_ptr<input_adapter> create(std::istream&& i)
8775
        {
8776
            return std::shared_ptr<input_adapter>(new cached_input_stream_adapter<16384>(i));
8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817
        }

        /// 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");

8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828
            const auto len = static_cast<size_t>(std::distance(first, last));
            if (JSON_LIKELY(len > 0))
            {
                // there is at least one element: use the address of first
                return create(reinterpret_cast<const char*>(&(*first)), len);
            }
            else
            {
                // the address of first cannot be used - use nullptr
                return create(nullptr, len);
            }
8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850
        }

        /// 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 已提交
8851
    };
N
Niels 已提交
8852

N
Niels Lohmann 已提交
8853
    /// a type to simplify interfaces
N
Niels Lohmann 已提交
8854 8855
    using input_adapter_t = std::shared_ptr<input_adapter>;

N
Niels Lohmann 已提交
8856
    /// input adapter for cached stream input
8857
    template<std::size_t N>
N
Niels Lohmann 已提交
8858
    class cached_input_stream_adapter : public input_adapter
N
Niels 已提交
8859
    {
N
Niels Lohmann 已提交
8860
      public:
8861 8862
        cached_input_stream_adapter(std::istream& i)
            : is(i), start_position(is.tellg())
N
Niels Lohmann 已提交
8863
        {
8864
            fill_buffer();
N
Niels Lohmann 已提交
8865

8866
            // skip byte order mark
N
Niels Lohmann 已提交
8867
            if (fill_size >= 3 and buffer[0] == '\xEF' and buffer[1] == '\xBB' and buffer[2] == '\xBF')
N
Niels Lohmann 已提交
8868 8869 8870 8871 8872 8873 8874 8875 8876 8877
            {
                buffer_pos += 3;
                processed_chars += 3;
            }
        }

        ~cached_input_stream_adapter() override
        {
            // clear stream flags
            is.clear();
8878 8879 8880
            // 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.
N
Niels Lohmann 已提交
8881
            is.seekg(start_position);
N
Niels Lohmann 已提交
8882
            is.ignore(static_cast<std::streamsize>(processed_chars));
N
Niels Lohmann 已提交
8883 8884
            // clear stream flags
            is.clear();
N
Niels Lohmann 已提交
8885 8886 8887 8888
        }

        int get_character() override
        {
N
Niels Lohmann 已提交
8889 8890
            // check if refilling is necessary and possible
            if (buffer_pos == fill_size and not eof)
N
Niels Lohmann 已提交
8891
            {
8892
                fill_buffer();
8893

8894
                // check and remember that filling did not yield new input
N
Niels Lohmann 已提交
8895 8896 8897
                if (fill_size == 0)
                {
                    eof = true;
8898
                    return std::char_traits<char>::eof();
N
Niels Lohmann 已提交
8899
                }
8900 8901 8902

                // the buffer is ready
                buffer_pos = 0;
N
Niels Lohmann 已提交
8903 8904 8905
            }

            ++processed_chars;
8906 8907
            assert(buffer_pos < buffer.size());
            return buffer[buffer_pos++] & 0xFF;
N
Niels Lohmann 已提交
8908 8909 8910 8911 8912 8913 8914 8915
        }

        std::string read(size_t offset, size_t length) override
        {
            // create buffer
            std::string result(length, '\0');

            // save stream position
8916
            const auto current_pos = is.tellg();
N
Niels Lohmann 已提交
8917
            // save stream flags
8918
            const auto flags = is.rdstate();
N
Niels Lohmann 已提交
8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934

            // 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 已提交
8935
      private:
8936 8937 8938 8939 8940 8941 8942 8943
        void fill_buffer()
        {
            // fill
            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());
        }

N
Niels Lohmann 已提交
8944 8945 8946 8947 8948 8949 8950 8951
        /// 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 已提交
8952 8953 8954 8955 8956
        /// 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 已提交
8957 8958 8959 8960
        /// position of the stream when we started
        const std::streampos start_position;

        /// internal buffer
N
Niels Lohmann 已提交
8961
        std::array<char, N> buffer{{}};
N
Niels Lohmann 已提交
8962 8963 8964 8965 8966 8967 8968 8969
    };

    /// 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)
8970 8971 8972 8973 8974 8975 8976
        {
            // skip byte order mark
            if (l >= 3 and b[0] == '\xEF' and b[1] == '\xBB' and b[2] == '\xBF')
            {
                cursor += 3;
            }
        }
N
Niels 已提交
8977

N
Niels Lohmann 已提交
8978 8979 8980 8981
        // delete because of pointer members
        input_buffer_adapter(const input_buffer_adapter&) = delete;
        input_buffer_adapter& operator=(input_buffer_adapter&) = delete;

8982
        int get_character() noexcept override
T
Théo DELRIEU 已提交
8983
        {
N
Niels Lohmann 已提交
8984 8985 8986 8987 8988 8989 8990 8991 8992
            if (JSON_LIKELY(cursor < limit))
            {
                return *(cursor++) & 0xFF;
            }
            else
            {
                return std::char_traits<char>::eof();
            }
        }
N
Niels 已提交
8993

N
Niels Lohmann 已提交
8994
        std::string read(size_t offset, size_t length) override
N
Niels 已提交
8995
        {
N
Niels Lohmann 已提交
8996 8997
            // avoid reading too many characters
            const size_t max_length = static_cast<size_t>(limit - start);
8998
            return std::string(start + offset, (std::min)(length, max_length - offset));
N
Niels Lohmann 已提交
8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009
        }

      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;
    };

9010 9011 9012 9013 9014 9015
    //////////////////////////////////////////
    // binary serialization/deserialization //
    //////////////////////////////////////////

    /// @name binary serialization/deserialization support
    /// @{
N
Niels Lohmann 已提交
9016 9017

  private:
N
Niels Lohmann 已提交
9018 9019 9020
    /*!
    @brief deserialization of CBOR and MessagePack values
    */
N
Niels Lohmann 已提交
9021 9022 9023
    class binary_reader
    {
      public:
N
Niels Lohmann 已提交
9024 9025 9026 9027 9028
        /*!
        @brief create a binary reader

        @param[in] adapter  input adapter to read from
        */
N
Niels Lohmann 已提交
9029 9030
        explicit binary_reader(input_adapter_t adapter)
            : ia(adapter), is_little_endian(little_endianess())
N
Niels Lohmann 已提交
9031 9032 9033
        {
            assert(ia);
        }
N
Niels Lohmann 已提交
9034 9035

        /*!
N
Niels Lohmann 已提交
9036 9037
        @brief create a JSON value from CBOR input

N
Niels Lohmann 已提交
9038 9039 9040
        @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 已提交
9041 9042 9043 9044 9045

        @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 已提交
9046 9047 9048 9049
        */
        basic_json parse_cbor(const bool get_char = true)
        {
            switch (get_char ? get() : current)
T
Théo DELRIEU 已提交
9050
            {
N
Niels Lohmann 已提交
9051 9052
                // EOF
                case std::char_traits<char>::eof():
N
Niels Lohmann 已提交
9053
                {
N
Niels Lohmann 已提交
9054
                    JSON_THROW(parse_error::create(110, chars_read, "unexpected end of input"));
N
Niels Lohmann 已提交
9055 9056
                }

N
Niels Lohmann 已提交
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
                // 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 已提交
9085

N
Niels Lohmann 已提交
9086
                case 0x18: // Unsigned integer (one-byte uint8_t follows)
N
Niels Lohmann 已提交
9087
                {
N
Niels Lohmann 已提交
9088
                    return get_number<uint8_t>();
N
Niels Lohmann 已提交
9089
                }
N
Niels 已提交
9090

N
Niels Lohmann 已提交
9091 9092 9093 9094
                case 0x19: // Unsigned integer (two-byte uint16_t follows)
                {
                    return get_number<uint16_t>();
                }
N
Niels 已提交
9095

N
Niels Lohmann 已提交
9096
                case 0x1a: // Unsigned integer (four-byte uint32_t follows)
N
Niels Lohmann 已提交
9097
                {
N
Niels Lohmann 已提交
9098
                    return get_number<uint32_t>();
N
Niels Lohmann 已提交
9099 9100
                }

N
Niels Lohmann 已提交
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 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216
                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 已提交
9217
                    const auto len = static_cast<size_t>(current & 0x1f);
N
Niels Lohmann 已提交
9218 9219 9220 9221 9222 9223
                    for (size_t i = 0; i < len; ++i)
                    {
                        result.push_back(parse_cbor());
                    }
                    return result;
                }
N
Niels 已提交
9224

N
Niels Lohmann 已提交
9225 9226 9227 9228 9229 9230 9231 9232 9233 9234
                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 已提交
9235

N
Niels Lohmann 已提交
9236 9237 9238 9239 9240 9241 9242 9243 9244 9245
                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 已提交
9246

N
Niels Lohmann 已提交
9247 9248 9249 9250 9251 9252 9253 9254 9255 9256
                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 已提交
9257

N
Niels Lohmann 已提交
9258 9259 9260 9261 9262 9263 9264 9265 9266 9267
                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 已提交
9268

N
Niels Lohmann 已提交
9269 9270 9271 9272 9273 9274 9275 9276 9277
                case 0x9f: // array (indefinite length)
                {
                    basic_json result = value_t::array;
                    while (get() != 0xff)
                    {
                        result.push_back(parse_cbor(false));
                    }
                    return result;
                }
N
Niels 已提交
9278

N
Niels Lohmann 已提交
9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305
                // 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 已提交
9306
                    const auto len = static_cast<size_t>(current & 0x1f);
N
Niels Lohmann 已提交
9307 9308 9309
                    for (size_t i = 0; i < len; ++i)
                    {
                        get();
9310 9311
                        auto key = get_cbor_string();
                        result[key] = parse_cbor();
N
Niels Lohmann 已提交
9312 9313 9314
                    }
                    return result;
                }
N
Niels 已提交
9315

N
Niels Lohmann 已提交
9316 9317 9318 9319 9320 9321 9322
                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();
9323 9324
                        auto key = get_cbor_string();
                        result[key] = parse_cbor();
N
Niels Lohmann 已提交
9325 9326 9327
                    }
                    return result;
                }
N
Niels 已提交
9328

N
Niels Lohmann 已提交
9329 9330 9331 9332 9333 9334 9335
                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();
9336 9337
                        auto key = get_cbor_string();
                        result[key] = parse_cbor();
N
Niels Lohmann 已提交
9338 9339 9340
                    }
                    return result;
                }
N
Niels 已提交
9341

N
Niels Lohmann 已提交
9342 9343 9344 9345 9346 9347 9348
                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();
9349 9350
                        auto key = get_cbor_string();
                        result[key] = parse_cbor();
N
Niels Lohmann 已提交
9351 9352 9353
                    }
                    return result;
                }
T
Théo DELRIEU 已提交
9354

N
Niels Lohmann 已提交
9355
                case 0xbb: // map (eight-byte uint64_t for n follow)
T
Théo DELRIEU 已提交
9356
                {
N
Niels Lohmann 已提交
9357 9358 9359 9360 9361
                    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();
9362 9363
                        auto key = get_cbor_string();
                        result[key] = parse_cbor();
N
Niels Lohmann 已提交
9364 9365
                    }
                    return result;
T
Théo DELRIEU 已提交
9366
                }
N
Niels 已提交
9367

N
Niels Lohmann 已提交
9368 9369 9370 9371 9372
                case 0xbf: // map (indefinite length)
                {
                    basic_json result = value_t::object;
                    while (get() != 0xff)
                    {
9373 9374
                        auto key = get_cbor_string();
                        result[key] = parse_cbor();
N
Niels Lohmann 已提交
9375 9376 9377
                    }
                    return result;
                }
N
Niels Lohmann 已提交
9378

N
Niels Lohmann 已提交
9379 9380 9381 9382
                case 0xf4: // false
                {
                    return false;
                }
N
Niels Lohmann 已提交
9383

N
Niels Lohmann 已提交
9384 9385 9386 9387
                case 0xf5: // true
                {
                    return true;
                }
N
Niels Lohmann 已提交
9388

N
Niels Lohmann 已提交
9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401
                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 已提交
9402 9403 9404 9405 9406 9407 9408
                    // 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 已提交
9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422
                    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
                    {
9423
                        val = (mant == 0)
N
Niels Lohmann 已提交
9424 9425 9426 9427 9428
                              ? std::numeric_limits<double>::infinity()
                              : std::numeric_limits<double>::quiet_NaN();
                    }
                    return (half & 0x8000) != 0 ? -val : val;
                }
N
Niels Lohmann 已提交
9429

N
Niels Lohmann 已提交
9430 9431 9432 9433
                case 0xfa: // Single-Precision Float (four-byte IEEE 754)
                {
                    return get_number<float>();
                }
N
Niels Lohmann 已提交
9434

N
Niels Lohmann 已提交
9435 9436 9437 9438 9439 9440 9441 9442
                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 已提交
9443
                    ss << std::setw(2) << std::setfill('0') << std::hex << current;
N
Niels Lohmann 已提交
9444 9445
                    JSON_THROW(parse_error::create(112, chars_read, "error reading CBOR; last byte: 0x" + ss.str()));
                }
T
Théo DELRIEU 已提交
9446
            }
N
Niels Lohmann 已提交
9447
        }
N
Niels Lohmann 已提交
9448

N
Niels Lohmann 已提交
9449 9450 9451 9452 9453 9454 9455 9456
        /*!
        @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
        */
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 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852
        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 已提交
9853
                    ss << std::setw(2) << std::setfill('0') << std::hex << current;
9854 9855 9856 9857 9858
                    JSON_THROW(parse_error::create(112, chars_read, "error reading MessagePack; last byte: 0x" + ss.str()));
                }
            }
        }

N
Niels Lohmann 已提交
9859 9860 9861 9862 9863 9864 9865 9866
        /*!
        @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 已提交
9867 9868 9869 9870 9871
        {
            int num = 1;
            return (*reinterpret_cast<char*>(&num) == 1);
        }

N
Niels Lohmann 已提交
9872 9873 9874 9875 9876 9877 9878 9879 9880 9881
      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 已提交
9882 9883 9884 9885 9886
        int get()
        {
            ++chars_read;
            return (current = ia->get_character());
        }
N
Niels Lohmann 已提交
9887

N
Niels Lohmann 已提交
9888 9889 9890
        /*
        @brief read a number from the input

N
Niels Lohmann 已提交
9891
        @tparam NumberType the type of the number
N
Niels Lohmann 已提交
9892

N
Niels Lohmann 已提交
9893
        @return number of type @a NumberType
N
Niels Lohmann 已提交
9894 9895 9896 9897 9898

        @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.

N
Niels Lohmann 已提交
9899 9900
        @throw parse_error.110 if input has less than `sizeof(NumberType)`
                               bytes
N
Niels Lohmann 已提交
9901
        */
N
Niels Lohmann 已提交
9902 9903
        template<typename NumberType>
        NumberType get_number()
N
Niels Lohmann 已提交
9904
        {
N
Niels Lohmann 已提交
9905
            // step 1: read input into array with system's byte order
N
Niels Lohmann 已提交
9906 9907
            std::array<uint8_t, sizeof(NumberType)> vec;
            for (size_t i = 0; i < sizeof(NumberType); ++i)
N
Niels Lohmann 已提交
9908 9909 9910
            {
                get();
                check_eof();
N
Niels Lohmann 已提交
9911 9912 9913 9914

                // reverse byte order prior to conversion if necessary
                if (is_little_endian)
                {
N
Niels Lohmann 已提交
9915
                    vec[sizeof(NumberType) - i - 1] = static_cast<uint8_t>(current);
N
Niels Lohmann 已提交
9916 9917 9918
                }
                else
                {
9919
                    vec[i] = static_cast<uint8_t>(current);  // LCOV_EXCL_LINE
N
Niels Lohmann 已提交
9920
                }
N
Niels Lohmann 已提交
9921 9922
            }

N
Niels Lohmann 已提交
9923
            // step 2: convert array into number of type T and return
N
Niels Lohmann 已提交
9924 9925
            NumberType result;
            std::memcpy(&result, vec.data(), sizeof(NumberType));
N
Niels Lohmann 已提交
9926 9927 9928
            return result;
        }

N
Niels Lohmann 已提交
9929 9930 9931 9932 9933
        /*!
        @brief create a string by reading characters from the input

        @param[in] len number of bytes to read

N
Niels Lohmann 已提交
9934 9935 9936 9937
        @note We can not reserve @a len bytes for the result, because @a len
              may be too large. Usually, @ref check_eof() detects the end of
              the input before we run out of string memory.

N
Niels Lohmann 已提交
9938 9939 9940 9941
        @return string created by reading @a len bytes

        @throw parse_error.110 if input has less than @a len bytes
        */
N
Niels Lohmann 已提交
9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952
        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 已提交
9953

N
Niels Lohmann 已提交
9954 9955 9956 9957 9958 9959 9960 9961 9962 9963
        /*!
        @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
N
Niels Lohmann 已提交
9964
        @throw parse_error.113 if an unexpected byte is read
N
Niels Lohmann 已提交
9965
        */
N
Niels Lohmann 已提交
9966 9967 9968
        std::string get_cbor_string()
        {
            check_eof();
N
Niels Lohmann 已提交
9969

N
Niels Lohmann 已提交
9970
            switch (current)
T
Théo DELRIEU 已提交
9971
            {
N
Niels Lohmann 已提交
9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996
                // 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 已提交
9997
                {
N
Niels Lohmann 已提交
9998
                    const auto len = static_cast<size_t>(current & 0x1f);
N
Niels Lohmann 已提交
9999
                    return get_string(len);
N
Niels Lohmann 已提交
10000
                }
N
Niels Lohmann 已提交
10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037

                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 已提交
10038
                {
N
Niels Lohmann 已提交
10039
                    std::stringstream ss;
N
Niels Lohmann 已提交
10040
                    ss << std::setw(2) << std::setfill('0') << std::hex << current;
N
Niels Lohmann 已提交
10041
                    JSON_THROW(parse_error::create(113, chars_read, "expected a CBOR string; last byte: 0x" + ss.str()));
N
Niels Lohmann 已提交
10042
                }
T
Théo DELRIEU 已提交
10043
            }
N
Niels Lohmann 已提交
10044
        }
N
Niels Lohmann 已提交
10045

N
Niels Lohmann 已提交
10046 10047 10048 10049 10050 10051 10052 10053 10054
        /*!
        @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
N
Niels Lohmann 已提交
10055
        @throw parse_error.113 if an unexpected byte is read
N
Niels Lohmann 已提交
10056
        */
10057 10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096
        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:
                {
10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127
                    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 已提交
10128 10129 10130 10131 10132
        /*!
        @brief check if input ended
        @throw parse_error.110 if input ended
        */
        void check_eof() const
10133 10134 10135 10136 10137 10138 10139 10140 10141
        {
            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 已提交
10142
        input_adapter_t ia = nullptr;
10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153

        /// 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 已提交
10154 10155 10156
    /*!
    @brief serialization to CBOR and MessagePack values
    */
10157 10158 10159
    class binary_writer
    {
      public:
N
Niels Lohmann 已提交
10160 10161
        /*!
        @brief create a binary writer
10162

N
Niels Lohmann 已提交
10163 10164
        @param[in] adapter  output adapter to write to
        */
10165
        explicit binary_writer(output_adapter_t<uint8_t> adapter)
N
Niels Lohmann 已提交
10166 10167 10168 10169
            : is_little_endian(binary_reader::little_endianess()), oa(adapter)
        {
            assert(oa);
        }
10170

N
Niels Lohmann 已提交
10171 10172 10173
        /*!
        @brief[in] j  JSON value to serialize
        */
10174
        void write_cbor(const basic_json& j)
10175 10176 10177 10178 10179
        {
            switch (j.type())
            {
                case value_t::null:
                {
10180
                    oa->write_character(0xf6);
10181 10182 10183 10184 10185
                    break;
                }

                case value_t::boolean:
                {
10186
                    oa->write_character(j.m_value.boolean ? 0xf5 : 0xf4);
10187 10188 10189 10190 10191 10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202
                    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)())
                        {
10203
                            oa->write_character(0x18);
10204 10205 10206 10207
                            write_number(static_cast<uint8_t>(j.m_value.number_integer));
                        }
                        else if (j.m_value.number_integer <= (std::numeric_limits<uint16_t>::max)())
                        {
10208
                            oa->write_character(0x19);
10209 10210 10211 10212
                            write_number(static_cast<uint16_t>(j.m_value.number_integer));
                        }
                        else if (j.m_value.number_integer <= (std::numeric_limits<uint32_t>::max)())
                        {
10213
                            oa->write_character(0x1a);
10214 10215 10216 10217
                            write_number(static_cast<uint32_t>(j.m_value.number_integer));
                        }
                        else
                        {
10218
                            oa->write_character(0x1b);
10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232
                            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)())
                        {
10233
                            oa->write_character(0x38);
10234 10235 10236 10237
                            write_number(static_cast<uint8_t>(positive_number));
                        }
                        else if (positive_number <= (std::numeric_limits<uint16_t>::max)())
                        {
10238
                            oa->write_character(0x39);
10239 10240 10241 10242
                            write_number(static_cast<uint16_t>(positive_number));
                        }
                        else if (positive_number <= (std::numeric_limits<uint32_t>::max)())
                        {
10243
                            oa->write_character(0x3a);
10244 10245 10246 10247
                            write_number(static_cast<uint32_t>(positive_number));
                        }
                        else
                        {
10248
                            oa->write_character(0x3b);
10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262
                            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)())
                    {
10263
                        oa->write_character(0x18);
10264 10265 10266 10267
                        write_number(static_cast<uint8_t>(j.m_value.number_unsigned));
                    }
                    else if (j.m_value.number_unsigned <= (std::numeric_limits<uint16_t>::max)())
                    {
10268
                        oa->write_character(0x19);
10269 10270 10271 10272
                        write_number(static_cast<uint16_t>(j.m_value.number_unsigned));
                    }
                    else if (j.m_value.number_unsigned <= (std::numeric_limits<uint32_t>::max)())
                    {
10273
                        oa->write_character(0x1a);
10274 10275 10276 10277
                        write_number(static_cast<uint32_t>(j.m_value.number_unsigned));
                    }
                    else
                    {
10278
                        oa->write_character(0x1b);
10279 10280 10281 10282 10283 10284 10285 10286
                        write_number(static_cast<uint64_t>(j.m_value.number_unsigned));
                    }
                    break;
                }

                case value_t::number_float:
                {
                    // Double-Precision Float
10287
                    oa->write_character(0xfb);
10288 10289 10290 10291 10292 10293
                    write_number(j.m_value.number_float);
                    break;
                }

                case value_t::string:
                {
N
Niels Lohmann 已提交
10294
                    // step 1: write control byte and the string length
10295 10296 10297 10298 10299 10300 10301
                    const auto N = j.m_value.string->size();
                    if (N <= 0x17)
                    {
                        write_number(static_cast<uint8_t>(0x60 + N));
                    }
                    else if (N <= 0xff)
                    {
10302
                        oa->write_character(0x78);
10303 10304 10305 10306
                        write_number(static_cast<uint8_t>(N));
                    }
                    else if (N <= 0xffff)
                    {
10307
                        oa->write_character(0x79);
10308 10309 10310 10311
                        write_number(static_cast<uint16_t>(N));
                    }
                    else if (N <= 0xffffffff)
                    {
10312
                        oa->write_character(0x7a);
10313 10314 10315 10316 10317
                        write_number(static_cast<uint32_t>(N));
                    }
                    // LCOV_EXCL_START
                    else if (N <= 0xffffffffffffffff)
                    {
10318
                        oa->write_character(0x7b);
10319 10320 10321 10322
                        write_number(static_cast<uint64_t>(N));
                    }
                    // LCOV_EXCL_STOP

N
Niels Lohmann 已提交
10323
                    // step 2: write the string
10324 10325
                    oa->write_characters(reinterpret_cast<const uint8_t*>(j.m_value.string->c_str()),
                                         j.m_value.string->size());
10326 10327 10328 10329 10330
                    break;
                }

                case value_t::array:
                {
N
Niels Lohmann 已提交
10331
                    // step 1: write control byte and the array size
10332 10333 10334 10335 10336 10337 10338
                    const auto N = j.m_value.array->size();
                    if (N <= 0x17)
                    {
                        write_number(static_cast<uint8_t>(0x80 + N));
                    }
                    else if (N <= 0xff)
                    {
10339
                        oa->write_character(0x98);
10340 10341 10342 10343
                        write_number(static_cast<uint8_t>(N));
                    }
                    else if (N <= 0xffff)
                    {
10344
                        oa->write_character(0x99);
10345 10346 10347 10348
                        write_number(static_cast<uint16_t>(N));
                    }
                    else if (N <= 0xffffffff)
                    {
10349
                        oa->write_character(0x9a);
10350 10351 10352 10353 10354
                        write_number(static_cast<uint32_t>(N));
                    }
                    // LCOV_EXCL_START
                    else if (N <= 0xffffffffffffffff)
                    {
10355
                        oa->write_character(0x9b);
10356 10357 10358 10359
                        write_number(static_cast<uint64_t>(N));
                    }
                    // LCOV_EXCL_STOP

N
Niels Lohmann 已提交
10360
                    // step 2: write each element
10361 10362
                    for (const auto& el : *j.m_value.array)
                    {
10363
                        write_cbor(el);
10364 10365 10366 10367 10368 10369
                    }
                    break;
                }

                case value_t::object:
                {
N
Niels Lohmann 已提交
10370
                    // step 1: write control byte and the object size
10371 10372 10373 10374 10375 10376 10377
                    const auto N = j.m_value.object->size();
                    if (N <= 0x17)
                    {
                        write_number(static_cast<uint8_t>(0xa0 + N));
                    }
                    else if (N <= 0xff)
                    {
10378
                        oa->write_character(0xb8);
10379 10380 10381 10382
                        write_number(static_cast<uint8_t>(N));
                    }
                    else if (N <= 0xffff)
                    {
10383
                        oa->write_character(0xb9);
10384 10385 10386 10387
                        write_number(static_cast<uint16_t>(N));
                    }
                    else if (N <= 0xffffffff)
                    {
10388
                        oa->write_character(0xba);
10389 10390 10391 10392 10393
                        write_number(static_cast<uint32_t>(N));
                    }
                    // LCOV_EXCL_START
                    else if (N <= 0xffffffffffffffff)
                    {
10394
                        oa->write_character(0xbb);
10395 10396 10397 10398
                        write_number(static_cast<uint64_t>(N));
                    }
                    // LCOV_EXCL_STOP

N
Niels Lohmann 已提交
10399
                    // step 2: write each element
10400 10401
                    for (const auto& el : *j.m_value.object)
                    {
10402 10403
                        write_cbor(el.first);
                        write_cbor(el.second);
10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414
                    }
                    break;
                }

                default:
                {
                    break;
                }
            }
        }

N
Niels Lohmann 已提交
10415 10416 10417
        /*!
        @brief[in] j  JSON value to serialize
        */
10418
        void write_msgpack(const basic_json& j)
10419 10420 10421 10422 10423 10424
        {
            switch (j.type())
            {
                case value_t::null:
                {
                    // nil
10425
                    oa->write_character(0xc0);
10426 10427 10428 10429 10430 10431
                    break;
                }

                case value_t::boolean:
                {
                    // true and false
10432
                    oa->write_character(j.m_value.boolean ? 0xc3 : 0xc2);
10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451
                    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
10452
                            oa->write_character(0xcc);
10453 10454 10455 10456 10457
                            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
10458
                            oa->write_character(0xcd);
10459 10460 10461 10462 10463
                            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
10464
                            oa->write_character(0xce);
10465 10466 10467 10468 10469
                            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
10470
                            oa->write_character(0xcf);
10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483
                            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
10484
                            oa->write_character(0xd0);
10485 10486 10487 10488 10489
                            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
10490
                            oa->write_character(0xd1);
10491 10492 10493 10494 10495
                            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
10496
                            oa->write_character(0xd2);
10497 10498 10499 10500 10501
                            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
10502
                            oa->write_character(0xd3);
10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518
                            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
10519
                        oa->write_character(0xcc);
10520 10521 10522 10523 10524
                        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
10525
                        oa->write_character(0xcd);
10526 10527 10528 10529 10530
                        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
10531
                        oa->write_character(0xce);
10532 10533 10534 10535 10536
                        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
10537
                        oa->write_character(0xcf);
10538 10539 10540 10541 10542 10543 10544 10545
                        write_number(static_cast<uint64_t>(j.m_value.number_integer));
                    }
                    break;
                }

                case value_t::number_float:
                {
                    // float 64
10546
                    oa->write_character(0xcb);
10547 10548
                    write_number(j.m_value.number_float);
                    break;
10549 10550
                }

10551
                case value_t::string:
10552
                {
N
Niels Lohmann 已提交
10553
                    // step 1: write control byte and the string length
10554 10555 10556 10557 10558 10559 10560 10561 10562
                    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
10563
                        oa->write_character(0xd9);
10564 10565 10566 10567 10568
                        write_number(static_cast<uint8_t>(N));
                    }
                    else if (N <= 65535)
                    {
                        // str 16
10569
                        oa->write_character(0xda);
10570 10571 10572 10573 10574
                        write_number(static_cast<uint16_t>(N));
                    }
                    else if (N <= 4294967295)
                    {
                        // str 32
10575
                        oa->write_character(0xdb);
10576 10577 10578
                        write_number(static_cast<uint32_t>(N));
                    }

N
Niels Lohmann 已提交
10579
                    // step 2: write the string
10580 10581
                    oa->write_characters(reinterpret_cast<const uint8_t*>(j.m_value.string->c_str()),
                                         j.m_value.string->size());
10582
                    break;
10583 10584
                }

10585
                case value_t::array:
10586
                {
N
Niels Lohmann 已提交
10587
                    // step 1: write control byte and the array size
10588 10589 10590 10591 10592 10593 10594 10595 10596
                    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
10597
                        oa->write_character(0xdc);
10598 10599 10600 10601 10602
                        write_number(static_cast<uint16_t>(N));
                    }
                    else if (N <= 0xffffffff)
                    {
                        // array 32
10603
                        oa->write_character(0xdd);
10604 10605 10606
                        write_number(static_cast<uint32_t>(N));
                    }

N
Niels Lohmann 已提交
10607
                    // step 2: write each element
10608 10609
                    for (const auto& el : *j.m_value.array)
                    {
10610
                        write_msgpack(el);
10611 10612
                    }
                    break;
10613 10614
                }

10615
                case value_t::object:
10616
                {
N
Niels Lohmann 已提交
10617
                    // step 1: write control byte and the object size
10618 10619 10620 10621 10622 10623 10624 10625 10626
                    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
10627
                        oa->write_character(0xde);
10628 10629 10630 10631 10632
                        write_number(static_cast<uint16_t>(N));
                    }
                    else if (N <= 4294967295)
                    {
                        // map 32
10633
                        oa->write_character(0xdf);
10634 10635 10636
                        write_number(static_cast<uint32_t>(N));
                    }

N
Niels Lohmann 已提交
10637
                    // step 2: write each element
10638 10639
                    for (const auto& el : *j.m_value.object)
                    {
10640 10641
                        write_msgpack(el.first);
                        write_msgpack(el.second);
10642 10643
                    }
                    break;
10644 10645 10646 10647
                }

                default:
                {
10648
                    break;
10649 10650 10651 10652
                }
            }
        }

10653
      private:
N
Niels Lohmann 已提交
10654 10655 10656
        /*
        @brief write a number to output input

N
Niels Lohmann 已提交
10657 10658
        @param[in] n number of type @a NumberType
        @tparam NumberType the type of the number
N
Niels Lohmann 已提交
10659 10660 10661 10662 10663

        @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.
        */
N
Niels Lohmann 已提交
10664 10665
        template<typename NumberType>
        void write_number(NumberType n)
N
Niels Lohmann 已提交
10666
        {
N
Niels Lohmann 已提交
10667 10668 10669
            // step 1: write number to array of length NumberType
            std::array<uint8_t, sizeof(NumberType)> vec;
            std::memcpy(vec.data(), &n, sizeof(NumberType));
10670

N
Niels Lohmann 已提交
10671
            // step 2: write array to output (with possible reordering)
N
Niels Lohmann 已提交
10672
            if (is_little_endian)
T
Théo DELRIEU 已提交
10673
            {
10674
                // reverse byte order prior to conversion if necessary
N
Niels Lohmann 已提交
10675
                std::reverse(vec.begin(), vec.end());
T
Théo DELRIEU 已提交
10676
            }
N
Niels Lohmann 已提交
10677 10678

            oa->write_characters(vec.data(), sizeof(NumberType));
N
Niels Lohmann 已提交
10679
        }
10680

10681
      private:
N
Niels Lohmann 已提交
10682 10683
        /// whether we can assume little endianess
        const bool is_little_endian = true;
10684

10685
        /// the output
10686
        output_adapter_t<uint8_t> oa = nullptr;
N
Niels Lohmann 已提交
10687 10688 10689
    };

  public:
10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 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
    /*!
    @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)
    {
10774
        std::vector<uint8_t> result;
10775
        binary_writer bw(output_adapter<uint8_t>::create(result));
10776 10777
        bw.write_cbor(j);
        return result;
10778 10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796
    }

    /*!
    @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
C
Chocobo1 已提交
10797
    number_integer  | -32768..-129                      | int16            | 0xd1
10798 10799 10800
    number_integer  | -128..-33                         | int8             | 0xd0
    number_integer  | -32..-1                           | negative fixint  | 0xe0..0xff
    number_integer  | 0..127                            | positive fixint  | 0x00..0x7f
C
Chocobo1 已提交
10801
    number_integer  | 128..255                          | uint 8           | 0xcc
10802 10803 10804 10805
    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
C
Chocobo1 已提交
10806
    number_unsigned | 128..255                          | uint 8           | 0xcc
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
    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)
    {
10856
        std::vector<uint8_t> result;
10857
        binary_writer bw(output_adapter<uint8_t>::create(result));
10858 10859
        bw.write_msgpack(j);
        return result;
10860
    }
N
Niels Lohmann 已提交
10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901

    /*!
    @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
C
Chocobo1 已提交
10902
    True                   | `true`          | 0xf5
N
Niels Lohmann 已提交
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
    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 已提交
10949 10950 10951
    static basic_json from_cbor(const std::vector<uint8_t>& v,
                                const size_t start_index = 0)
    {
10952
        binary_reader br(input_adapter::create(v.begin() + static_cast<difference_type>(start_index), v.end()));
N
Niels Lohmann 已提交
10953 10954
        return br.parse_cbor();
    }
N
Niels Lohmann 已提交
10955

10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004 11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026

    /*!
    @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)
    {
11027
        binary_reader br(input_adapter::create(v.begin() + static_cast<difference_type>(start_index), v.end()));
11028 11029 11030
        return br.parse_msgpack();
    }

11031 11032
    /// @}

N
Niels Lohmann 已提交
11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044
    //////////////////////
    // lexer and parser //
    //////////////////////

  private:
    /*!
    @brief lexical analysis

    This class organizes the lexical analysis during JSON deserialization.
    */
    class lexer
    {
N
Niels Lohmann 已提交
11045 11046 11047 11048 11049 11050 11051 11052 11053
      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 已提交
11054 11055 11056
            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 已提交
11057 11058 11059 11060 11061 11062 11063
            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
11064 11065
            end_of_input,    ///< indicating the end of the input buffer
            literal_or_value ///< a literal or the begin of a value (only for diagnostics)
N
Niels Lohmann 已提交
11066
        };
11067

T
Théo DELRIEU 已提交
11068
        /// return name of values of type token_type (only used for errors)
N
Niels Lohmann 已提交
11069
        static const char* token_type_name(const token_type t) noexcept
T
Théo DELRIEU 已提交
11070 11071
        {
            switch (t)
N
cleanup  
Niels 已提交
11072
            {
T
Théo DELRIEU 已提交
11073 11074 11075 11076 11077 11078 11079 11080 11081 11082
                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 已提交
11083 11084
                case lexer::token_type::value_unsigned:
                case lexer::token_type::value_integer:
11085
                case lexer::token_type::value_float:
T
Théo DELRIEU 已提交
11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102
                    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";
11103 11104
                case token_type::literal_or_value:
                    return "'[', '{', or a literal";
T
Théo DELRIEU 已提交
11105 11106 11107 11108 11109
                default:
                {
                    // catch non-enum values
                    return "unknown token"; // LCOV_EXCL_LINE
                }
N
cleanup  
Niels 已提交
11110 11111 11112
            }
        }

N
Niels Lohmann 已提交
11113 11114
        explicit lexer(input_adapter_t adapter)
            : ia(adapter), decimal_point_char(get_decimal_point())
N
Niels Lohmann 已提交
11115 11116
        {}

11117 11118 11119 11120
        // delete because of pointer members
        lexer(const lexer&) = delete;
        lexer& operator=(lexer&) = delete;

N
Niels Lohmann 已提交
11121
      private:
11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133
        /////////////////////
        // 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 已提交
11134 11135 11136
        /////////////////////
        // scan functions
        /////////////////////
N
Niels 已提交
11137

N
Niels Lohmann 已提交
11138 11139 11140 11141 11142 11143
        /*!
        @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 已提交
11144 11145
        int get_codepoint()
        {
N
Niels Lohmann 已提交
11146
            // this function only makes sense after reading `\u`
11147
            assert(current == 'u');
N
Niels Lohmann 已提交
11148 11149
            int codepoint = 0;

N
Niels Lohmann 已提交
11150
            // byte 1: \uXxxx
11151
            switch (get())
N
Niels Lohmann 已提交
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 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206
                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 已提交
11207
                    return -1;
11208
            }
N
Niels Lohmann 已提交
11209

N
Niels Lohmann 已提交
11210
            // byte 2: \uxXxx
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 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269
            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 已提交
11270
            // byte 3: \uxxXx
11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329
            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 已提交
11330
            // byte 4: \uxxxX
11331 11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371 11372 11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387
            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 已提交
11388
            }
N
Niels Lohmann 已提交
11389 11390

            return codepoint;
N
Niels Lohmann 已提交
11391 11392
        }

N
Niels Lohmann 已提交
11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406
        /*!
        @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 已提交
11407
        token_type scan_string()
N
Niels 已提交
11408
        {
N
Niels Lohmann 已提交
11409 11410 11411
            // reset yytext (ignore opening quote)
            reset();

11412
            // we entered the function by reading an open quote
N
Niels Lohmann 已提交
11413
            assert(current == '\"');
11414

T
Théo DELRIEU 已提交
11415 11416
            while (true)
            {
11417
                // get next character
N
Niels Lohmann 已提交
11418
                switch (get())
N
Niels Lohmann 已提交
11419
                {
11420 11421
                    // end of file while parsing string
                    case std::char_traits<char>::eof():
11422
                    {
11423 11424
                        error_message = "invalid string: missing closing quote";
                        return token_type::parse_error;
11425 11426
                    }

11427 11428
                    // closing quote
                    case '\"':
11429
                    {
11430 11431 11432 11433
                        // terminate yytext
                        add('\0');
                        --yylen;
                        return token_type::value_string;
11434 11435
                    }

11436 11437
                    // escapes
                    case '\\':
N
Niels Lohmann 已提交
11438
                    {
N
Niels Lohmann 已提交
11439
                        switch (get())
N
Niels Lohmann 已提交
11440
                        {
N
Niels Lohmann 已提交
11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475
                            // 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 已提交
11476
                            {
N
Niels Lohmann 已提交
11477 11478 11479 11480
                                int codepoint;
                                int codepoint1 = get_codepoint();

                                if (JSON_UNLIKELY(codepoint1 == -1))
N
Niels Lohmann 已提交
11481
                                {
N
Niels Lohmann 已提交
11482 11483
                                    error_message = "invalid string: '\\u' must be followed by 4 hex digits";
                                    return token_type::parse_error;
N
Niels Lohmann 已提交
11484
                                }
N
Niels Lohmann 已提交
11485 11486

                                // check if code point is a high surrogate
N
Niels Lohmann 已提交
11487
                                if (0xD800 <= codepoint1 and codepoint1 <= 0xDBFF)
N
Niels Lohmann 已提交
11488
                                {
N
Niels Lohmann 已提交
11489 11490 11491
                                    // expect next \uxxxx entry
                                    if (JSON_LIKELY(get() == '\\' and get() == 'u'))
                                    {
11492
                                        const int codepoint2 = get_codepoint();
N
Niels Lohmann 已提交
11493 11494 11495 11496 11497 11498 11499 11500

                                        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 已提交
11501
                                        if (JSON_LIKELY(0xDC00 <= codepoint2 and codepoint2 <= 0xDFFF))
N
Niels Lohmann 已提交
11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514
                                        {
                                            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
                                        {
11515
                                            error_message = "invalid string: surrogate U+DC00..U+DFFF must be followed by U+DC00..U+DFFF";
N
Niels Lohmann 已提交
11516 11517 11518 11519 11520
                                            return token_type::parse_error;
                                        }
                                    }
                                    else
                                    {
11521
                                        error_message = "invalid string: surrogate U+DC00..U+DFFF must be followed by U+DC00..U+DFFF";
N
Niels Lohmann 已提交
11522 11523
                                        return token_type::parse_error;
                                    }
N
Niels Lohmann 已提交
11524
                                }
N
Niels Lohmann 已提交
11525
                                else
N
Niels Lohmann 已提交
11526
                                {
N
Niels Lohmann 已提交
11527
                                    if (JSON_UNLIKELY(0xDC00 <= codepoint1 and codepoint1 <= 0xDFFF))
N
Niels Lohmann 已提交
11528
                                    {
11529
                                        error_message = "invalid string: surrogate U+DC00..U+DFFF must follow U+D800..U+DBFF";
N
Niels Lohmann 已提交
11530 11531 11532 11533 11534
                                        return token_type::parse_error;
                                    }

                                    // only work with first code point
                                    codepoint = codepoint1;
N
Niels Lohmann 已提交
11535
                                }
N
Niels Lohmann 已提交
11536

N
Niels Lohmann 已提交
11537 11538 11539
                                // result of the above calculation yields a proper codepoint
                                assert(0x00 <= codepoint and codepoint <= 0x10FFFF);

N
Niels Lohmann 已提交
11540 11541
                                // translate code point to bytes
                                if (codepoint < 0x80)
N
Niels Lohmann 已提交
11542
                                {
N
Niels Lohmann 已提交
11543 11544
                                    // 1-byte characters: 0xxxxxxx (ASCII)
                                    add(codepoint);
N
Niels Lohmann 已提交
11545
                                }
N
Niels Lohmann 已提交
11546
                                else if (codepoint <= 0x7ff)
N
Niels Lohmann 已提交
11547
                                {
N
Niels Lohmann 已提交
11548 11549 11550
                                    // 2-byte characters: 110xxxxx 10xxxxxx
                                    add(0xC0 | (codepoint >> 6));
                                    add(0x80 | (codepoint & 0x3F));
N
Niels Lohmann 已提交
11551
                                }
N
Niels Lohmann 已提交
11552
                                else if (codepoint <= 0xffff)
N
Niels Lohmann 已提交
11553
                                {
N
Niels Lohmann 已提交
11554 11555 11556 11557
                                    // 3-byte characters: 1110xxxx 10xxxxxx 10xxxxxx
                                    add(0xE0 | (codepoint >> 12));
                                    add(0x80 | ((codepoint >> 6) & 0x3F));
                                    add(0x80 | (codepoint & 0x3F));
N
Niels Lohmann 已提交
11558
                                }
N
Niels Lohmann 已提交
11559
                                else
N
Niels Lohmann 已提交
11560
                                {
N
Niels Lohmann 已提交
11561 11562 11563 11564 11565
                                    // 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 已提交
11566
                                }
N
Niels Lohmann 已提交
11567 11568

                                break;
N
Niels Lohmann 已提交
11569
                            }
N
Niels Lohmann 已提交
11570 11571 11572

                            // other characters after escape
                            default:
11573
                                error_message = "invalid string: forbidden character after backslash";
N
Niels Lohmann 已提交
11574
                                return token_type::parse_error;
N
Niels Lohmann 已提交
11575
                        }
N
Niels Lohmann 已提交
11576

N
Niels Lohmann 已提交
11577 11578
                        break;
                    }
N
Niels Lohmann 已提交
11579

11580
                    // invalid control characters
N
Niels Lohmann 已提交
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
                    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:
11613
                    {
11614
                        error_message = "invalid string: control character must be escaped";
11615 11616 11617 11618
                        return token_type::parse_error;
                    }

                    // U+0020..U+007F (except U+0022 (quote) and U+005C (backspace))
N
Niels Lohmann 已提交
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 11647 11648 11649 11650 11651 11652 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 11683 11684 11685 11686 11687 11688 11689 11690 11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711 11712
                    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:
11713 11714 11715 11716 11717 11718
                    {
                        add(current);
                        break;
                    }

                    // U+0080..U+07FF: bytes C2..DF 80..BF
N
Niels Lohmann 已提交
11719 11720 11721 11722 11723 11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735 11736 11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748
                    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:
11749 11750 11751
                    {
                        add(current);
                        get();
N
Niels Lohmann 已提交
11752
                        if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11753 11754 11755 11756 11757
                        {
                            add(current);
                            continue;
                        }

11758
                        error_message = "invalid string: ill-formed UTF-8 byte";
11759 11760 11761 11762
                        return token_type::parse_error;
                    }

                    // U+0800..U+0FFF: bytes E0 A0..BF 80..BF
N
Niels Lohmann 已提交
11763
                    case 0xe0:
11764 11765 11766
                    {
                        add(current);
                        get();
N
Niels Lohmann 已提交
11767
                        if (JSON_LIKELY(0xa0 <= current and current <= 0xbf))
11768 11769 11770
                        {
                            add(current);
                            get();
N
Niels Lohmann 已提交
11771
                            if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11772 11773 11774 11775 11776 11777
                            {
                                add(current);
                                continue;
                            }
                        }

11778
                        error_message = "invalid string: ill-formed UTF-8 byte";
11779 11780 11781 11782 11783
                        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 已提交
11784 11785 11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796 11797
                    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:
11798 11799 11800
                    {
                        add(current);
                        get();
N
Niels Lohmann 已提交
11801
                        if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11802 11803 11804
                        {
                            add(current);
                            get();
N
Niels Lohmann 已提交
11805
                            if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11806 11807 11808 11809 11810 11811
                            {
                                add(current);
                                continue;
                            }
                        }

11812
                        error_message = "invalid string: ill-formed UTF-8 byte";
11813 11814 11815 11816
                        return token_type::parse_error;
                    }

                    // U+D000..U+D7FF: bytes ED 80..9F 80..BF
N
Niels Lohmann 已提交
11817
                    case 0xed:
11818 11819 11820
                    {
                        add(current);
                        get();
N
Niels Lohmann 已提交
11821
                        if (JSON_LIKELY(0x80 <= current and current <= 0x9f))
11822 11823 11824
                        {
                            add(current);
                            get();
N
Niels Lohmann 已提交
11825
                            if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11826 11827 11828 11829 11830 11831
                            {
                                add(current);
                                continue;
                            }
                        }

11832
                        error_message = "invalid string: ill-formed UTF-8 byte";
11833
                        return token_type::parse_error;
11834 11835
                    }

11836
                    // U+10000..U+3FFFF F0 90..BF 80..BF 80..BF
N
Niels Lohmann 已提交
11837
                    case 0xf0:
11838 11839 11840
                    {
                        add(current);
                        get();
N
Niels Lohmann 已提交
11841
                        if (JSON_LIKELY(0x90 <= current and current <= 0xbf))
11842 11843 11844
                        {
                            add(current);
                            get();
N
Niels Lohmann 已提交
11845
                            if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11846 11847 11848
                            {
                                add(current);
                                get();
N
Niels Lohmann 已提交
11849
                                if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11850 11851 11852 11853 11854 11855 11856
                                {
                                    add(current);
                                    continue;
                                }
                            }
                        }

11857
                        error_message = "invalid string: ill-formed UTF-8 byte";
11858 11859 11860 11861
                        return token_type::parse_error;
                    }

                    // U+40000..U+FFFFF F1..F3 80..BF 80..BF 80..BF
N
Niels Lohmann 已提交
11862 11863 11864
                    case 0xf1:
                    case 0xf2:
                    case 0xf3:
11865 11866 11867
                    {
                        add(current);
                        get();
N
Niels Lohmann 已提交
11868
                        if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11869 11870 11871
                        {
                            add(current);
                            get();
N
Niels Lohmann 已提交
11872
                            if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11873 11874 11875
                            {
                                add(current);
                                get();
N
Niels Lohmann 已提交
11876
                                if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11877 11878 11879 11880 11881 11882 11883
                                {
                                    add(current);
                                    continue;
                                }
                            }
                        }

11884
                        error_message = "invalid string: ill-formed UTF-8 byte";
11885 11886 11887
                        return token_type::parse_error;
                    }

11888
                    // U+100000..U+10FFFF F4 80..8F 80..BF 80..BF
N
Niels Lohmann 已提交
11889
                    case 0xf4:
11890
                    {
11891 11892
                        add(current);
                        get();
N
Niels Lohmann 已提交
11893
                        if (JSON_LIKELY(0x80 <= current and current <= 0x8f))
11894 11895 11896
                        {
                            add(current);
                            get();
N
Niels Lohmann 已提交
11897
                            if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11898 11899 11900
                            {
                                add(current);
                                get();
N
Niels Lohmann 已提交
11901
                                if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11902 11903 11904 11905 11906 11907 11908
                                {
                                    add(current);
                                    continue;
                                }
                            }
                        }

11909
                        error_message = "invalid string: ill-formed UTF-8 byte";
11910 11911 11912
                        return token_type::parse_error;
                    }

11913
                    // remaining bytes (80..C1 and F5..FF) are ill-formed
N
Niels Lohmann 已提交
11914
                    default:
N
Niels Lohmann 已提交
11915
                    {
11916
                        error_message = "invalid string: ill-formed UTF-8 byte";
11917
                        return token_type::parse_error;
N
Niels Lohmann 已提交
11918
                    }
N
Niels Lohmann 已提交
11919 11920 11921 11922
                }
            }
        }

11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937
        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);
        }

11938
        /*!
N
Niels Lohmann 已提交
11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949
        @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.

11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960
        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 已提交
11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977

        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.
11978
        */
N
Niels Lohmann 已提交
11979 11980
        token_type scan_number()
        {
N
Niels Lohmann 已提交
11981
            // reset yytext to store the number's bytes
11982 11983
            reset();

N
Niels Lohmann 已提交
11984 11985
            // the type of the parsed number; initially set to unsigned; will be
            // changed if minus sign, decimal point or exponent is read
11986 11987
            token_type number_type = token_type::value_unsigned;

11988
            // state (init): we just found out we need to scan a number
11989
            switch (current)
N
Niels Lohmann 已提交
11990
            {
11991 11992 11993 11994 11995
                case '-':
                {
                    add(current);
                    goto scan_number_minus;
                }
N
Niels Lohmann 已提交
11996

11997 11998 11999 12000 12001
                case '0':
                {
                    add(current);
                    goto scan_number_zero;
                }
N
Niels Lohmann 已提交
12002

12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015
                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 已提交
12016

12017 12018 12019 12020 12021 12022
                default:
                {
                    // all other characters are rejected outside scan_number()
                    assert(false);  // LCOV_EXCL_LINE
                }
            }
N
Niels Lohmann 已提交
12023

12024 12025 12026 12027
scan_number_minus:
            // state: we just parsed a leading minus sign
            number_type = token_type::value_integer;
            switch (get())
N
Niels Lohmann 已提交
12028
            {
12029 12030 12031 12032 12033 12034 12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047
                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 已提交
12048

12049
                default:
N
Niels Lohmann 已提交
12050
                {
12051
                    error_message = "invalid number; expected digit after '-'";
N
Niels Lohmann 已提交
12052
                    return token_type::parse_error;
N
Niels Lohmann 已提交
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 12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214 12215 12216 12217 12218 12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235 12236 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251 12252 12253 12254 12255 12256 12257 12258
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 已提交
12259
            }
12260

12261
scan_number_done:
N
Niels Lohmann 已提交
12262 12263
            // unget the character after the number (we only read it to know
            // that we are done scanning a number)
12264 12265
            --chars_read;
            next_unget = true;
N
Niels Lohmann 已提交
12266

N
Niels Lohmann 已提交
12267 12268 12269
            // terminate token
            add('\0');
            --yylen;
N
Niels 已提交
12270

N
Niels Lohmann 已提交
12271
            // try to parse integers first and fall back to floats
12272
            if (number_type == token_type::value_unsigned)
12273
            {
12274
                char* endptr = nullptr;
N
Niels Lohmann 已提交
12275
                errno = 0;
12276 12277 12278 12279 12280 12281
                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 已提交
12282
                {
12283 12284
                    value_unsigned = static_cast<number_unsigned_t>(x);
                    if (value_unsigned == x)
N
Niels Lohmann 已提交
12285
                    {
12286
                        return token_type::value_unsigned;
N
Niels Lohmann 已提交
12287 12288
                    }
                }
12289 12290 12291 12292 12293 12294 12295 12296 12297 12298 12299
            }
            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 已提交
12300
                {
12301 12302
                    value_integer = static_cast<number_integer_t>(x);
                    if (value_integer == x)
N
Niels Lohmann 已提交
12303
                    {
12304
                        return token_type::value_integer;
N
Niels Lohmann 已提交
12305 12306
                    }
                }
12307
            }
N
Niels Lohmann 已提交
12308

12309 12310
            // this code is reached if we parse a floating-point number or if
            // an integer conversion above failed
12311
            strtof(value_float, yytext.data(), nullptr);
N
Niels Lohmann 已提交
12312
            return token_type::value_float;
N
Niels 已提交
12313 12314
        }

N
Niels Lohmann 已提交
12315 12316 12317 12318 12319 12320 12321
        /*!
        @param[in] literal_text  the literal text to expect
        @param[in] length        the length of the passed literal text
        @param[in] return_type   the token type to return on success
        */
        token_type scan_literal(const char* literal_text, const size_t length,
                                token_type return_type)
N
Niels Lohmann 已提交
12322
        {
N
Niels Lohmann 已提交
12323 12324
            assert(current == literal_text[0]);
            for (size_t i = 1; i < length; ++i)
N
Niels Lohmann 已提交
12325
            {
N
Niels Lohmann 已提交
12326 12327 12328 12329 12330
                if (JSON_UNLIKELY(get() != literal_text[i]))
                {
                    error_message = "invalid literal";
                    return token_type::parse_error;
                }
N
Niels Lohmann 已提交
12331
            }
N
Niels Lohmann 已提交
12332
            return return_type;
N
Niels Lohmann 已提交
12333
        }
12334

N
Niels Lohmann 已提交
12335 12336 12337
        /////////////////////
        // input management
        /////////////////////
12338

N
Niels Lohmann 已提交
12339 12340
        /// reset yytext
        void reset() noexcept
T
Théo DELRIEU 已提交
12341
        {
N
Niels Lohmann 已提交
12342 12343 12344
            yylen = 0;
            start_pos = chars_read - 1;
        }
12345

N
Niels Lohmann 已提交
12346
        /// get a character from the input
N
Niels Lohmann 已提交
12347 12348 12349
        int get()
        {
            ++chars_read;
12350 12351 12352
            return next_unget
                   ? (next_unget = false, current)
                   : (current = ia->get_character());
N
Niels Lohmann 已提交
12353
        }
N
Niels 已提交
12354

N
Niels Lohmann 已提交
12355
        /// add a character to yytext
N
Niels Lohmann 已提交
12356 12357
        void add(int c)
        {
12358 12359
            // resize yytext if necessary; this condition is deemed unlikely,
            // because we start with a 1024-byte buffer
N
Niels Lohmann 已提交
12360
            if (JSON_UNLIKELY((yylen + 1 > yytext.capacity())))
T
Théo DELRIEU 已提交
12361
            {
N
Niels Lohmann 已提交
12362 12363
                yytext.resize(2 * yytext.capacity(), '\0');
            }
N
Niels Lohmann 已提交
12364
            assert(yylen < yytext.size());
N
Niels Lohmann 已提交
12365 12366
            yytext[yylen++] = static_cast<char>(c);
        }
12367

N
Niels Lohmann 已提交
12368
      public:
N
Niels Lohmann 已提交
12369 12370 12371
        /////////////////////
        // value getters
        /////////////////////
12372

N
Niels Lohmann 已提交
12373
        /// return integer value
N
Niels Lohmann 已提交
12374 12375 12376 12377 12378
        constexpr number_integer_t get_number_integer() const noexcept
        {
            return value_integer;
        }

N
Niels Lohmann 已提交
12379
        /// return unsigned integer value
N
Niels Lohmann 已提交
12380 12381 12382 12383 12384
        constexpr number_unsigned_t get_number_unsigned() const noexcept
        {
            return value_unsigned;
        }

N
Niels Lohmann 已提交
12385
        /// return floating-point value
N
Niels Lohmann 已提交
12386 12387 12388 12389 12390
        constexpr number_float_t get_number_float() const noexcept
        {
            return value_float;
        }

N
Niels Lohmann 已提交
12391
        /// return string value
N
Niels Lohmann 已提交
12392 12393
        const std::string get_string()
        {
N
Niels Lohmann 已提交
12394
            // yytext cannot be returned as char*, because it may contain a
N
Niels Lohmann 已提交
12395
            // null byte (parsed as "\u0000")
N
Niels Lohmann 已提交
12396 12397
            return std::string(yytext.data(), yylen);
        }
12398

N
Niels Lohmann 已提交
12399 12400 12401 12402 12403 12404 12405 12406 12407 12408 12409
        /////////////////////
        // 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 已提交
12410 12411
        std::string get_token_string() const
        {
N
Niels Lohmann 已提交
12412
            // get the raw byte sequence of the last token
N
Niels Lohmann 已提交
12413
            std::string s = ia->read(start_pos, chars_read - start_pos);
12414

N
Niels Lohmann 已提交
12415
            // escape control characters
12416
            std::string result;
N
Niels Lohmann 已提交
12417 12418 12419
            for (auto c : s)
            {
                if (c == '\0' or c == std::char_traits<char>::eof())
T
Théo DELRIEU 已提交
12420
                {
N
Niels Lohmann 已提交
12421
                    // ignore EOF
N
Niels Lohmann 已提交
12422
                    continue;
T
Théo DELRIEU 已提交
12423
                }
N
Niels Lohmann 已提交
12424
                else if ('\x00' <= c and c <= '\x1f')
A
Alex Astashyn 已提交
12425
                {
N
Niels Lohmann 已提交
12426
                    // escape control characters
N
Niels Lohmann 已提交
12427 12428 12429
                    std::stringstream ss;
                    ss << "<U+" << std::setw(4) << std::uppercase << std::setfill('0') << std::hex << static_cast<int>(c) << ">";
                    result += ss.str();
N
Niels Lohmann 已提交
12430 12431 12432
                }
                else
                {
N
Niels Lohmann 已提交
12433
                    // add character as is
12434
                    result.append(1, c);
N
Niels 已提交
12435
                }
12436
            }
N
Niels 已提交
12437

12438
            return result;
N
Niels Lohmann 已提交
12439
        }
12440

N
Niels Lohmann 已提交
12441
        /// return syntax error message
N
Niels Lohmann 已提交
12442
        constexpr const char* get_error_message() const noexcept
N
Niels Lohmann 已提交
12443 12444 12445
        {
            return error_message;
        }
12446

N
Niels Lohmann 已提交
12447 12448 12449 12450
        /////////////////////
        // actual scanner
        /////////////////////

N
Niels Lohmann 已提交
12451
        token_type scan()
12452
        {
N
Niels Lohmann 已提交
12453 12454 12455 12456 12457 12458 12459 12460 12461 12462 12463 12464 12465 12466 12467 12468 12469 12470 12471 12472 12473 12474 12475 12476 12477
            // 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':
N
Niels Lohmann 已提交
12478
                    return scan_literal("true", 4, token_type::literal_true);
N
Niels Lohmann 已提交
12479
                case 'f':
N
Niels Lohmann 已提交
12480
                    return scan_literal("false", 5, token_type::literal_false);
N
Niels Lohmann 已提交
12481
                case 'n':
N
Niels Lohmann 已提交
12482
                    return scan_literal("null", 4, token_type::literal_null);
N
Niels Lohmann 已提交
12483 12484 12485 12486 12487 12488 12489 12490 12491 12492 12493 12494 12495 12496 12497 12498 12499 12500 12501

                // 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();

12502 12503
                // end of input (the null byte is needed when parsing from
                // string literals)
N
Niels Lohmann 已提交
12504 12505 12506 12507 12508 12509 12510 12511 12512
                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;
            }
12513 12514
        }

T
Théo DELRIEU 已提交
12515
      private:
N
Niels Lohmann 已提交
12516
        /// input adapter
N
Niels Lohmann 已提交
12517
        input_adapter_t ia = nullptr;
N
Niels Lohmann 已提交
12518 12519 12520 12521 12522 12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535

        /// 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
12536
        const char* error_message = "";
N
Niels Lohmann 已提交
12537 12538

        // number values
12539 12540 12541
        number_integer_t value_integer = 0;
        number_unsigned_t value_unsigned = 0;
        number_float_t value_float = 0;
12542

N
Niels Lohmann 已提交
12543
        /// the decimal point
N
Niels Lohmann 已提交
12544
        const char decimal_point_char = '.';
T
Théo DELRIEU 已提交
12545
    };
N
Niels 已提交
12546

N
Niels 已提交
12547 12548
    /*!
    @brief syntax analysis
N
Niels 已提交
12549 12550

    This class implements a recursive decent parser.
N
Niels 已提交
12551
    */
N
Niels 已提交
12552 12553
    class parser
    {
T
Théo DELRIEU 已提交
12554
      public:
12555
        /// a parser reading from an input adapter
N
Niels Lohmann 已提交
12556
        explicit parser(input_adapter_t adapter,
12557
                        const parser_callback_t cb = nullptr)
N
Niels Lohmann 已提交
12558
            : callback(cb), m_lexer(adapter)
T
Théo DELRIEU 已提交
12559
        {}
N
cleanup  
Niels 已提交
12560

N
Niels Lohmann 已提交
12561 12562
        /*!
        @brief public parser interface
12563 12564

        @param[in] strict  whether to expect the last token to be EOF
12565
        @return parsed JSON value
12566

N
Niels Lohmann 已提交
12567 12568 12569 12570
        @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
        */
12571
        basic_json parse(const bool strict = true)
T
Théo DELRIEU 已提交
12572 12573 12574
        {
            // read first token
            get_token();
N
Niels 已提交
12575

T
Théo DELRIEU 已提交
12576 12577
            basic_json result = parse_internal(true);
            result.assert_invariant();
N
Niels 已提交
12578

12579 12580
            if (strict)
            {
N
Niels Lohmann 已提交
12581
                get_token();
12582 12583
                expect(lexer::token_type::end_of_input);
            }
N
Niels 已提交
12584

T
Théo DELRIEU 已提交
12585 12586 12587 12588
            // 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 已提交
12589

12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605
        /*!
        @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;
            }

12606
            if (strict and get_token() != lexer::token_type::end_of_input)
12607 12608 12609 12610 12611 12612 12613
            {
                return false;
            }

            return true;
        }

T
Théo DELRIEU 已提交
12614
      private:
N
Niels Lohmann 已提交
12615 12616 12617 12618 12619 12620
        /*!
        @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 已提交
12621
        basic_json parse_internal(bool keep)
12622
        {
T
Théo DELRIEU 已提交
12623 12624 12625
            auto result = basic_json(value_t::discarded);

            switch (last_token)
N
Niels 已提交
12626
            {
T
Théo DELRIEU 已提交
12627
                case lexer::token_type::begin_object:
N
Niels 已提交
12628
                {
T
Théo DELRIEU 已提交
12629 12630 12631 12632 12633 12634 12635
                    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 已提交
12636

T
Théo DELRIEU 已提交
12637 12638
                    // read next token
                    get_token();
N
Niels 已提交
12639

T
Théo DELRIEU 已提交
12640 12641 12642 12643 12644 12645 12646 12647 12648 12649
                    // 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;
                    }

12650 12651
                    // parse values
                    while (true)
T
Théo DELRIEU 已提交
12652 12653 12654 12655 12656 12657 12658 12659 12660 12661 12662 12663 12664 12665 12666 12667 12668 12669 12670 12671 12672 12673 12674 12675 12676 12677 12678 12679 12680 12681
                    {
                        // 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);
                        }
12682 12683

                        // comma -> next value
N
Niels Lohmann 已提交
12684
                        get_token();
12685 12686 12687 12688 12689 12690 12691 12692 12693
                        if (last_token == lexer::token_type::value_separator)
                        {
                            get_token();
                            continue;
                        }

                        // closing }
                        expect(lexer::token_type::end_object);
                        break;
T
Théo DELRIEU 已提交
12694 12695
                    }

N
Niels 已提交
12696
                    if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
N
Niels 已提交
12697 12698 12699
                    {
                        result = basic_json(value_t::discarded);
                    }
T
Théo DELRIEU 已提交
12700

N
Niels 已提交
12701
                    return result;
N
Niels 已提交
12702 12703
                }

T
Théo DELRIEU 已提交
12704
                case lexer::token_type::begin_array:
12705
                {
T
Théo DELRIEU 已提交
12706 12707 12708 12709 12710 12711 12712 12713 12714 12715 12716 12717 12718
                    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 已提交
12719
                    {
T
Théo DELRIEU 已提交
12720 12721 12722 12723 12724
                        if (callback and not callback(--depth, parse_event_t::array_end, result))
                        {
                            result = basic_json(value_t::discarded);
                        }
                        return result;
N
Niels 已提交
12725 12726
                    }

12727 12728
                    // parse values
                    while (true)
N
Niels 已提交
12729
                    {
T
Théo DELRIEU 已提交
12730 12731 12732
                        // parse value
                        auto value = parse_internal(keep);
                        if (keep and not value.is_discarded())
N
Niels 已提交
12733
                        {
T
Théo DELRIEU 已提交
12734
                            result.push_back(std::move(value));
N
Niels 已提交
12735
                        }
12736 12737

                        // comma -> next value
N
Niels Lohmann 已提交
12738
                        get_token();
12739 12740 12741 12742 12743 12744 12745 12746 12747
                        if (last_token == lexer::token_type::value_separator)
                        {
                            get_token();
                            continue;
                        }

                        // closing ]
                        expect(lexer::token_type::end_array);
                        break;
N
Niels 已提交
12748 12749
                    }

T
Théo DELRIEU 已提交
12750
                    if (keep and callback and not callback(--depth, parse_event_t::array_end, result))
N
Niels 已提交
12751
                    {
T
Théo DELRIEU 已提交
12752
                        result = basic_json(value_t::discarded);
N
Niels 已提交
12753
                    }
T
Théo DELRIEU 已提交
12754 12755

                    return result;
N
Niels 已提交
12756 12757
                }

T
Théo DELRIEU 已提交
12758
                case lexer::token_type::literal_null:
N
Niels 已提交
12759
                {
T
Théo DELRIEU 已提交
12760 12761
                    result.m_type = value_t::null;
                    break;
N
Niels 已提交
12762 12763
                }

T
Théo DELRIEU 已提交
12764
                case lexer::token_type::value_string:
N
Niels 已提交
12765
                {
N
Niels Lohmann 已提交
12766
                    result = basic_json(m_lexer.get_string());
T
Théo DELRIEU 已提交
12767
                    break;
N
Niels 已提交
12768 12769
                }

T
Théo DELRIEU 已提交
12770
                case lexer::token_type::literal_true:
N
Niels 已提交
12771
                {
T
Théo DELRIEU 已提交
12772 12773 12774
                    result.m_type = value_t::boolean;
                    result.m_value = true;
                    break;
N
Niels 已提交
12775 12776
                }

T
Théo DELRIEU 已提交
12777
                case lexer::token_type::literal_false:
N
Niels 已提交
12778
                {
T
Théo DELRIEU 已提交
12779 12780 12781
                    result.m_type = value_t::boolean;
                    result.m_value = false;
                    break;
N
Niels 已提交
12782 12783
                }

N
Niels Lohmann 已提交
12784
                case lexer::token_type::value_unsigned:
N
Niels Lohmann 已提交
12785 12786 12787 12788 12789 12790
                {
                    result.m_type = value_t::number_unsigned;
                    result.m_value = m_lexer.get_number_unsigned();
                    break;
                }

N
Niels Lohmann 已提交
12791
                case lexer::token_type::value_integer:
N
Niels Lohmann 已提交
12792 12793 12794 12795 12796 12797
                {
                    result.m_type = value_t::number_integer;
                    result.m_value = m_lexer.get_number_integer();
                    break;
                }

12798
                case lexer::token_type::value_float:
N
Niels 已提交
12799
                {
N
Niels Lohmann 已提交
12800 12801 12802 12803 12804 12805 12806 12807 12808
                    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 已提交
12809
                    break;
N
Niels 已提交
12810
                }
12811

12812 12813 12814 12815
                case lexer::token_type::parse_error:
                {
                    // using "uninitialized" to avoid "expected" message
                    expect(lexer::token_type::uninitialized);
12816
                    break;  // LCOV_EXCL_LINE
12817 12818
                }

T
Théo DELRIEU 已提交
12819 12820
                default:
                {
12821
                    // the last token was unexpected; we expected a value
12822
                    expect(lexer::token_type::literal_or_value);
12823
                    break;  // LCOV_EXCL_LINE
T
Théo DELRIEU 已提交
12824
                }
12825 12826
            }

T
Théo DELRIEU 已提交
12827
            if (keep and callback and not callback(depth, parse_event_t::value, result))
12828
            {
T
Théo DELRIEU 已提交
12829
                result = basic_json(value_t::discarded);
N
Niels 已提交
12830
            }
T
Théo DELRIEU 已提交
12831
            return result;
N
Niels 已提交
12832 12833
        }

12834 12835
        /*!
        @brief the acutal acceptor
12836 12837 12838 12839 12840 12841 12842 12843

        @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".
12844 12845 12846 12847 12848 12849 12850 12851 12852 12853 12854 12855 12856 12857 12858 12859 12860 12861 12862 12863 12864 12865 12866 12867 12868 12869 12870 12871 12872 12873 12874 12875 12876 12877 12878 12879 12880 12881 12882 12883
        */
        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
12884
                        get_token();
12885 12886 12887 12888 12889 12890 12891 12892 12893 12894 12895 12896 12897 12898 12899 12900 12901 12902 12903 12904 12905 12906 12907 12908 12909 12910 12911 12912 12913 12914 12915 12916 12917 12918 12919 12920 12921
                        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
12922
                        get_token();
12923 12924 12925 12926 12927 12928 12929 12930 12931 12932 12933 12934 12935 12936 12937 12938
                        if (last_token == lexer::token_type::value_separator)
                        {
                            get_token();
                            continue;
                        }

                        // closing ]
                        if (last_token != lexer::token_type::end_array)
                        {
                            return false;
                        }

                        return true;
                    }
                }

12939
                case lexer::token_type::literal_false:
12940 12941 12942
                case lexer::token_type::literal_null:
                case lexer::token_type::literal_true:
                case lexer::token_type::value_float:
12943 12944 12945
                case lexer::token_type::value_integer:
                case lexer::token_type::value_string:
                case lexer::token_type::value_unsigned:
12946 12947 12948 12949 12950 12951 12952 12953 12954 12955 12956 12957
                {
                    return true;
                }

                default:
                {
                    // the last token was unexpected
                    return false;
                }
            }
        }

T
Théo DELRIEU 已提交
12958 12959
        /// get next token from lexer
        typename lexer::token_type get_token()
N
Niels 已提交
12960
        {
12961
            return (last_token = m_lexer.scan());
N
Niels 已提交
12962 12963
        }

N
Niels Lohmann 已提交
12964 12965 12966
        /*!
        @throw parse_error.101 if expected token did not occur
        */
12967
        void expect(typename lexer::token_type t)
N
Niels 已提交
12968
        {
12969
            if (JSON_UNLIKELY(t != last_token))
T
Théo DELRIEU 已提交
12970
            {
12971 12972 12973
                errored = true;
                expected = t;
                throw_exception();
T
Théo DELRIEU 已提交
12974
            }
N
Niels 已提交
12975 12976
        }

12977 12978 12979 12980
        [[noreturn]] void throw_exception() const
        {
            std::string error_msg = "syntax error - ";
            if (last_token == lexer::token_type::parse_error)
T
Théo DELRIEU 已提交
12981
            {
12982 12983 12984 12985 12986 12987
                error_msg += std::string(m_lexer.get_error_message()) + "; last read: '" + m_lexer.get_token_string() + "'";
            }
            else
            {
                error_msg += "unexpected " + std::string(lexer::token_type_name(last_token));
            }
N
Niels Lohmann 已提交
12988

12989 12990 12991
            if (expected != lexer::token_type::uninitialized)
            {
                error_msg += "; expected " + std::string(lexer::token_type_name(expected));
T
Théo DELRIEU 已提交
12992
            }
12993 12994

            JSON_THROW(parse_error::create(101, m_lexer.get_position(), error_msg));
N
Niels 已提交
12995 12996
        }

T
Théo DELRIEU 已提交
12997 12998 12999 13000 13001 13002 13003 13004 13005
      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;
13006 13007 13008 13009
        /// whether a syntax error occurred
        bool errored = false;
        /// possible reason for the syntax error
        typename lexer::token_type expected = lexer::token_type::uninitialized;
T
Théo DELRIEU 已提交
13010
    };
N
Niels 已提交
13011 13012

  public:
N
Niels 已提交
13013 13014 13015
    /*!
    @brief JSON Pointer

N
Niels 已提交
13016 13017 13018 13019
    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 已提交
13020
    @sa [RFC 6901](https://tools.ietf.org/html/rfc6901)
N
Niels 已提交
13021 13022

    @since version 2.0.0
N
Niels 已提交
13023
    */
N
Niels 已提交
13024 13025
    class json_pointer
    {
N
Niels 已提交
13026 13027 13028
        /// allow basic_json to access private members
        friend class basic_json;

T
Théo DELRIEU 已提交
13029
      public:
N
Niels 已提交
13030 13031 13032 13033 13034 13035 13036 13037 13038 13039
        /*!
        @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 已提交
13040 13041 13042 13043 13044 13045
        @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 已提交
13046 13047 13048

        @liveexample{The example shows the construction several valid JSON
        pointers as well as the exceptional behavior.,json_pointer}
N
Niels 已提交
13049

N
Niels 已提交
13050 13051 13052
        @since version 2.0.0
        */
        explicit json_pointer(const std::string& s = "")
T
Théo DELRIEU 已提交
13053 13054
            : reference_tokens(split(s))
        {}
N
Niels 已提交
13055

T
Théo DELRIEU 已提交
13056 13057
        /*!
        @brief return a string representation of the JSON pointer
N
Niels 已提交
13058

T
Théo DELRIEU 已提交
13059 13060 13061 13062
        @invariant For each JSON pointer `ptr`, it holds:
        @code {.cpp}
        ptr == json_pointer(ptr.to_string());
        @endcode
N
Niels 已提交
13063

T
Théo DELRIEU 已提交
13064
        @return a string representation of the JSON pointer
N
Niels 已提交
13065

T
Théo DELRIEU 已提交
13066 13067
        @liveexample{The example shows the result of `to_string`.,
        json_pointer__to_string}
N
Niels 已提交
13068

T
Théo DELRIEU 已提交
13069 13070 13071
        @since version 2.0.0
        */
        std::string to_string() const noexcept
N
Niels 已提交
13072
        {
T
Théo DELRIEU 已提交
13073 13074 13075 13076 13077 13078 13079
            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 已提交
13080

T
Théo DELRIEU 已提交
13081 13082
        /// @copydoc to_string()
        operator std::string() const
N
Niels 已提交
13083
        {
T
Théo DELRIEU 已提交
13084
            return to_string();
N
Niels 已提交
13085 13086
        }

T
Théo DELRIEU 已提交
13087
      private:
N
Niels Lohmann 已提交
13088 13089 13090 13091
        /*!
        @brief remove and return last reference pointer
        @throw out_of_range.405 if JSON pointer has no parent
        */
T
Théo DELRIEU 已提交
13092 13093 13094 13095
        std::string pop_back()
        {
            if (is_root())
            {
13096
                JSON_THROW(out_of_range::create(405, "JSON pointer has no parent"));
T
Théo DELRIEU 已提交
13097
            }
13098

T
Théo DELRIEU 已提交
13099 13100 13101 13102
            auto last = reference_tokens.back();
            reference_tokens.pop_back();
            return last;
        }
N
Niels 已提交
13103

T
Théo DELRIEU 已提交
13104 13105
        /// return whether pointer points to the root document
        bool is_root() const
N
Niels 已提交
13106
        {
T
Théo DELRIEU 已提交
13107
            return reference_tokens.empty();
N
Niels 已提交
13108 13109
        }

T
Théo DELRIEU 已提交
13110 13111 13112 13113
        json_pointer top() const
        {
            if (is_root())
            {
13114
                JSON_THROW(out_of_range::create(405, "JSON pointer has no parent"));
T
Théo DELRIEU 已提交
13115
            }
N
Niels 已提交
13116

T
Théo DELRIEU 已提交
13117 13118 13119 13120
            json_pointer result = *this;
            result.reference_tokens = {reference_tokens[0]};
            return result;
        }
N
Niels 已提交
13121

T
Théo DELRIEU 已提交
13122 13123
        /*!
        @brief create and return a reference to the pointed to value
13124

T
Théo DELRIEU 已提交
13125
        @complexity Linear in the number of reference tokens.
N
Niels Lohmann 已提交
13126 13127 13128

        @throw parse_error.109 if array index is not a number
        @throw type_error.313 if value cannot be unflattened
T
Théo DELRIEU 已提交
13129 13130
        */
        reference get_and_create(reference j) const
13131
        {
T
Théo DELRIEU 已提交
13132 13133 13134 13135 13136
            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 已提交
13137
            {
T
Théo DELRIEU 已提交
13138
                switch (result->m_type)
N
Niels 已提交
13139
                {
T
Théo DELRIEU 已提交
13140
                    case value_t::null:
N
Niels 已提交
13141
                    {
T
Théo DELRIEU 已提交
13142 13143 13144 13145 13146 13147 13148 13149 13150 13151 13152
                        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 已提交
13153
                    }
T
Théo DELRIEU 已提交
13154 13155

                    case value_t::object:
N
Niels 已提交
13156
                    {
T
Théo DELRIEU 已提交
13157
                        // create an entry in the object
N
Niels 已提交
13158
                        result = &result->operator[](reference_token);
T
Théo DELRIEU 已提交
13159
                        break;
N
Niels 已提交
13160
                    }
N
Niels 已提交
13161

T
Théo DELRIEU 已提交
13162 13163 13164
                    case value_t::array:
                    {
                        // create an entry in the array
13165 13166 13167 13168
                        JSON_TRY
                        {
                            result = &result->operator[](static_cast<size_type>(std::stoi(reference_token)));
                        }
N
Niels Lohmann 已提交
13169
                        JSON_CATCH (std::invalid_argument&)
13170
                        {
13171
                            JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number"));
13172
                        }
T
Théo DELRIEU 已提交
13173 13174
                        break;
                    }
13175

T
Théo DELRIEU 已提交
13176 13177 13178 13179 13180 13181 13182 13183 13184
                    /*
                    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:
                    {
13185
                        JSON_THROW(type_error::create(313, "invalid value to unflatten"));
T
Théo DELRIEU 已提交
13186
                    }
N
Niels 已提交
13187 13188
                }
            }
13189

T
Théo DELRIEU 已提交
13190 13191
            return *result;
        }
13192

T
Théo DELRIEU 已提交
13193 13194
        /*!
        @brief return a reference to the pointed to value
13195

T
Théo DELRIEU 已提交
13196 13197 13198 13199 13200
        @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 已提交
13201

T
Théo DELRIEU 已提交
13202
        @param[in] ptr  a JSON value
N
Niels 已提交
13203

T
Théo DELRIEU 已提交
13204
        @return reference to the JSON value pointed to by the JSON pointer
N
Niels 已提交
13205

T
Théo DELRIEU 已提交
13206
        @complexity Linear in the length of the JSON pointer.
13207

N
Niels Lohmann 已提交
13208 13209 13210
        @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 已提交
13211 13212
        */
        reference get_unchecked(pointer ptr) const
13213
        {
T
Théo DELRIEU 已提交
13214
            for (const auto& reference_token : reference_tokens)
13215
            {
T
Théo DELRIEU 已提交
13216 13217
                // convert null values to arrays or objects before continuing
                if (ptr->m_type == value_t::null)
13218
                {
T
Théo DELRIEU 已提交
13219 13220 13221 13222
                    // check if reference token is a number
                    const bool nums = std::all_of(reference_token.begin(),
                                                  reference_token.end(),
                                                  [](const char x)
N
Niels 已提交
13223
                    {
13224
                        return (x >= '0' and x <= '9');
T
Théo DELRIEU 已提交
13225
                    });
N
Niels 已提交
13226

T
Théo DELRIEU 已提交
13227 13228 13229
                    // change value to array for numbers or "-" or to object
                    // otherwise
                    if (nums or reference_token == "-")
N
Niels 已提交
13230
                    {
T
Théo DELRIEU 已提交
13231
                        *ptr = value_t::array;
N
Niels 已提交
13232 13233 13234
                    }
                    else
                    {
T
Théo DELRIEU 已提交
13235
                        *ptr = value_t::object;
N
Niels 已提交
13236
                    }
N
Niels 已提交
13237 13238
                }

T
Théo DELRIEU 已提交
13239
                switch (ptr->m_type)
N
Niels 已提交
13240
                {
T
Théo DELRIEU 已提交
13241 13242 13243 13244 13245 13246 13247 13248 13249 13250 13251 13252
                    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')
                        {
13253
                            JSON_THROW(parse_error::create(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
13254 13255 13256 13257
                        }

                        if (reference_token == "-")
                        {
N
Niels Lohmann 已提交
13258
                            // explicitly treat "-" as index beyond the end
T
Théo DELRIEU 已提交
13259 13260 13261 13262 13263
                            ptr = &ptr->operator[](ptr->m_value.array->size());
                        }
                        else
                        {
                            // convert array index to number; unchecked access
13264 13265 13266 13267
                            JSON_TRY
                            {
                                ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
                            }
N
Niels Lohmann 已提交
13268
                            JSON_CATCH (std::invalid_argument&)
13269
                            {
13270
                                JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number"));
13271
                            }
T
Théo DELRIEU 已提交
13272 13273 13274 13275 13276 13277
                        }
                        break;
                    }

                    default:
                    {
13278
                        JSON_THROW(out_of_range::create(404, "unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
13279
                    }
N
Niels 已提交
13280 13281
                }
            }
N
Niels 已提交
13282

T
Théo DELRIEU 已提交
13283 13284
            return *ptr;
        }
13285

N
Niels Lohmann 已提交
13286 13287 13288 13289 13290 13291
        /*!
        @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 已提交
13292
        reference get_checked(pointer ptr) const
N
Niels 已提交
13293
        {
T
Théo DELRIEU 已提交
13294
            for (const auto& reference_token : reference_tokens)
N
Niels 已提交
13295
            {
T
Théo DELRIEU 已提交
13296
                switch (ptr->m_type)
13297
                {
T
Théo DELRIEU 已提交
13298
                    case value_t::object:
N
Niels 已提交
13299
                    {
T
Théo DELRIEU 已提交
13300 13301 13302
                        // note: at performs range check
                        ptr = &ptr->at(reference_token);
                        break;
N
Niels 已提交
13303 13304
                    }

T
Théo DELRIEU 已提交
13305
                    case value_t::array:
N
Niels 已提交
13306
                    {
T
Théo DELRIEU 已提交
13307 13308 13309
                        if (reference_token == "-")
                        {
                            // "-" always fails the range check
13310 13311 13312
                            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 已提交
13313 13314 13315 13316 13317
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
13318
                            JSON_THROW(parse_error::create(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
13319
                        }
N
Niels 已提交
13320

T
Théo DELRIEU 已提交
13321
                        // note: at performs range check
13322 13323 13324 13325
                        JSON_TRY
                        {
                            ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
                        }
N
Niels Lohmann 已提交
13326
                        JSON_CATCH (std::invalid_argument&)
13327
                        {
13328
                            JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number"));
13329
                        }
T
Théo DELRIEU 已提交
13330 13331
                        break;
                    }
13332

T
Théo DELRIEU 已提交
13333 13334
                    default:
                    {
13335
                        JSON_THROW(out_of_range::create(404, "unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
13336
                    }
N
Niels 已提交
13337 13338 13339
                }
            }

T
Théo DELRIEU 已提交
13340 13341
            return *ptr;
        }
N
Niels 已提交
13342

T
Théo DELRIEU 已提交
13343 13344
        /*!
        @brief return a const reference to the pointed to value
N
Niels 已提交
13345

T
Théo DELRIEU 已提交
13346
        @param[in] ptr  a JSON value
13347

T
Théo DELRIEU 已提交
13348 13349
        @return const reference to the JSON value pointed to by the JSON
                pointer
N
Niels Lohmann 已提交
13350 13351 13352 13353 13354

        @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 已提交
13355 13356
        */
        const_reference get_unchecked(const_pointer ptr) const
N
Niels 已提交
13357
        {
T
Théo DELRIEU 已提交
13358
            for (const auto& reference_token : reference_tokens)
N
Niels 已提交
13359
            {
T
Théo DELRIEU 已提交
13360
                switch (ptr->m_type)
13361
                {
T
Théo DELRIEU 已提交
13362
                    case value_t::object:
N
Niels 已提交
13363
                    {
T
Théo DELRIEU 已提交
13364 13365 13366
                        // use unchecked object access
                        ptr = &ptr->operator[](reference_token);
                        break;
N
Niels 已提交
13367 13368
                    }

T
Théo DELRIEU 已提交
13369
                    case value_t::array:
N
Niels 已提交
13370
                    {
T
Théo DELRIEU 已提交
13371 13372 13373
                        if (reference_token == "-")
                        {
                            // "-" cannot be used for const access
13374 13375 13376
                            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 已提交
13377 13378 13379 13380 13381
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
13382
                            JSON_THROW(parse_error::create(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
13383
                        }
N
Niels 已提交
13384

T
Théo DELRIEU 已提交
13385
                        // use unchecked array access
13386 13387 13388 13389
                        JSON_TRY
                        {
                            ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
                        }
N
Niels Lohmann 已提交
13390
                        JSON_CATCH (std::invalid_argument&)
13391
                        {
13392
                            JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number"));
13393
                        }
T
Théo DELRIEU 已提交
13394 13395
                        break;
                    }
13396

T
Théo DELRIEU 已提交
13397 13398
                    default:
                    {
13399
                        JSON_THROW(out_of_range::create(404, "unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
13400
                    }
N
Niels 已提交
13401 13402 13403
                }
            }

T
Théo DELRIEU 已提交
13404 13405
            return *ptr;
        }
13406

N
Niels Lohmann 已提交
13407 13408 13409 13410 13411 13412
        /*!
        @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 已提交
13413
        const_reference get_checked(const_pointer ptr) const
13414
        {
T
Théo DELRIEU 已提交
13415
            for (const auto& reference_token : reference_tokens)
13416
            {
T
Théo DELRIEU 已提交
13417
                switch (ptr->m_type)
13418
                {
T
Théo DELRIEU 已提交
13419
                    case value_t::object:
N
Niels 已提交
13420
                    {
T
Théo DELRIEU 已提交
13421 13422 13423
                        // note: at performs range check
                        ptr = &ptr->at(reference_token);
                        break;
N
Niels 已提交
13424
                    }
13425

T
Théo DELRIEU 已提交
13426
                    case value_t::array:
N
Niels 已提交
13427
                    {
T
Théo DELRIEU 已提交
13428 13429 13430
                        if (reference_token == "-")
                        {
                            // "-" always fails the range check
13431 13432 13433
                            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 已提交
13434 13435 13436 13437 13438
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
13439
                            JSON_THROW(parse_error::create(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
13440
                        }
13441

T
Théo DELRIEU 已提交
13442
                        // note: at performs range check
13443 13444 13445 13446
                        JSON_TRY
                        {
                            ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
                        }
N
Niels Lohmann 已提交
13447
                        JSON_CATCH (std::invalid_argument&)
13448
                        {
13449
                            JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number"));
13450
                        }
T
Théo DELRIEU 已提交
13451 13452
                        break;
                    }
13453

T
Théo DELRIEU 已提交
13454 13455
                    default:
                    {
13456
                        JSON_THROW(out_of_range::create(404, "unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
13457
                    }
13458 13459
                }
            }
N
Niels 已提交
13460

T
Théo DELRIEU 已提交
13461
            return *ptr;
13462 13463
        }

N
Niels Lohmann 已提交
13464 13465 13466 13467 13468 13469 13470 13471 13472
        /*!
        @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 已提交
13473
        static std::vector<std::string> split(const std::string& reference_string)
13474
        {
T
Théo DELRIEU 已提交
13475 13476 13477 13478 13479 13480 13481 13482 13483 13484 13485
            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] != '/')
            {
13486
                JSON_THROW(parse_error::create(107, 1, "JSON pointer must be empty or begin with '/' - was: '" + reference_string + "'"));
T
Théo DELRIEU 已提交
13487
            }
N
Niels 已提交
13488

T
Théo DELRIEU 已提交
13489 13490 13491 13492 13493
            // 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 已提交
13494
                size_t slash = reference_string.find_first_of('/', 1),
T
Théo DELRIEU 已提交
13495 13496 13497 13498 13499 13500 13501 13502
                // 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 已提交
13503
                slash = reference_string.find_first_of('/', start))
T
Théo DELRIEU 已提交
13504 13505 13506 13507
            {
                // 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 已提交
13508

T
Théo DELRIEU 已提交
13509
                // check reference tokens are properly escaped
N
Niels Lohmann 已提交
13510
                for (size_t pos = reference_token.find_first_of('~');
T
Théo DELRIEU 已提交
13511
                        pos != std::string::npos;
N
Niels Lohmann 已提交
13512
                        pos = reference_token.find_first_of('~', pos + 1))
13513
                {
T
Théo DELRIEU 已提交
13514 13515 13516 13517 13518 13519 13520
                    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'))
                    {
13521
                        JSON_THROW(parse_error::create(108, 0, "escape character '~' must be followed with '0' or '1'"));
T
Théo DELRIEU 已提交
13522
                    }
N
Niels 已提交
13523
                }
T
Théo DELRIEU 已提交
13524 13525 13526 13527

                // finally, store the reference token
                unescape(reference_token);
                result.push_back(reference_token);
13528
            }
N
Niels 已提交
13529

T
Théo DELRIEU 已提交
13530
            return result;
N
Niels 已提交
13531
        }
N
Niels 已提交
13532

T
Théo DELRIEU 已提交
13533 13534
        /*!
        @brief replace all occurrences of a substring by another string
N
Niels 已提交
13535

T
Théo DELRIEU 已提交
13536 13537 13538 13539
        @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 已提交
13540

N
Niels Lohmann 已提交
13541 13542
        @pre The search string @a f must not be empty. **This precondition is
             enforced with an assertion.**
N
Niels 已提交
13543

T
Théo DELRIEU 已提交
13544 13545 13546 13547 13548 13549 13550
        @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 已提交
13551

T
Théo DELRIEU 已提交
13552 13553 13554 13555 13556 13557 13558
            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 已提交
13559

T
Théo DELRIEU 已提交
13560 13561 13562 13563 13564 13565 13566 13567
        /// 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 已提交
13568

T
Théo DELRIEU 已提交
13569 13570 13571 13572 13573 13574 13575 13576
        /// 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 已提交
13577

T
Théo DELRIEU 已提交
13578 13579 13580 13581
        /*!
        @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
13582

T
Théo DELRIEU 已提交
13583 13584 13585 13586 13587
        @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 已提交
13588
        {
T
Théo DELRIEU 已提交
13589
            switch (value.m_type)
N
Niels 已提交
13590
            {
T
Théo DELRIEU 已提交
13591
                case value_t::array:
13592
                {
T
Théo DELRIEU 已提交
13593 13594 13595 13596 13597 13598
                    if (value.m_value.array->empty())
                    {
                        // flatten empty array as null
                        result[reference_string] = nullptr;
                    }
                    else
N
Niels 已提交
13599
                    {
T
Théo DELRIEU 已提交
13600 13601 13602 13603 13604 13605
                        // 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 已提交
13606
                    }
T
Théo DELRIEU 已提交
13607
                    break;
N
Niels 已提交
13608 13609
                }

T
Théo DELRIEU 已提交
13610
                case value_t::object:
13611
                {
T
Théo DELRIEU 已提交
13612 13613 13614 13615 13616 13617
                    if (value.m_value.object->empty())
                    {
                        // flatten empty object as null
                        result[reference_string] = nullptr;
                    }
                    else
N
Niels 已提交
13618
                    {
T
Théo DELRIEU 已提交
13619 13620 13621 13622 13623 13624
                        // 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 已提交
13625
                    }
T
Théo DELRIEU 已提交
13626
                    break;
N
Niels 已提交
13627 13628
                }

T
Théo DELRIEU 已提交
13629 13630 13631 13632 13633 13634
                default:
                {
                    // add primitive value with its reference string
                    result[reference_string] = value;
                    break;
                }
N
Niels 已提交
13635 13636
            }
        }
N
Niels 已提交
13637

T
Théo DELRIEU 已提交
13638 13639
        /*!
        @param[in] value  flattened JSON
N
Niels 已提交
13640

T
Théo DELRIEU 已提交
13641
        @return unflattened JSON
N
Niels Lohmann 已提交
13642 13643 13644 13645 13646

        @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 已提交
13647 13648
        */
        static basic_json unflatten(const basic_json& value)
N
Niels 已提交
13649
        {
T
Théo DELRIEU 已提交
13650 13651
            if (not value.is_object())
            {
13652
                JSON_THROW(type_error::create(314, "only objects can be unflattened"));
T
Théo DELRIEU 已提交
13653
            }
N
Niels 已提交
13654

T
Théo DELRIEU 已提交
13655
            basic_json result;
N
Niels 已提交
13656

T
Théo DELRIEU 已提交
13657 13658
            // iterate the JSON object values
            for (const auto& element : *value.m_value.object)
N
Niels 已提交
13659
            {
T
Théo DELRIEU 已提交
13660 13661
                if (not element.second.is_primitive())
                {
13662
                    JSON_THROW(type_error::create(315, "values in object must be primitive"));
T
Théo DELRIEU 已提交
13663 13664 13665 13666 13667 13668 13669 13670
                }

                // 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 已提交
13671 13672
            }

T
Théo DELRIEU 已提交
13673
            return result;
N
Niels 已提交
13674
        }
N
Niels 已提交
13675

T
Théo DELRIEU 已提交
13676 13677 13678 13679 13680
        friend bool operator==(json_pointer const& lhs,
                               json_pointer const& rhs) noexcept
        {
            return lhs.reference_tokens == rhs.reference_tokens;
        }
13681

T
Théo DELRIEU 已提交
13682 13683 13684 13685 13686
        friend bool operator!=(json_pointer const& lhs,
                               json_pointer const& rhs) noexcept
        {
            return !(lhs == rhs);
        }
13687

T
Théo DELRIEU 已提交
13688 13689
        /// the reference tokens
        std::vector<std::string> reference_tokens {};
13690
    };
N
Niels 已提交
13691

N
Niels 已提交
13692 13693 13694
    //////////////////////////
    // JSON Pointer support //
    //////////////////////////
N
Niels 已提交
13695 13696 13697 13698

    /// @name JSON Pointer functions
    /// @{

N
Niels 已提交
13699 13700 13701 13702
    /*!
    @brief access specified element via JSON Pointer

    Uses a JSON pointer to retrieve a reference to the respective JSON value.
N
Niels 已提交
13703 13704 13705
    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 已提交
13706 13707 13708 13709 13710 13711 13712 13713 13714 13715 13716 13717 13718 13719 13720 13721 13722 13723

    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 已提交
13724 13725 13726
    @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 已提交
13727 13728 13729 13730 13731 13732 13733 13734 13735 13736 13737 13738 13739 13740 13741 13742 13743 13744 13745 13746 13747 13748 13749 13750

    @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 已提交
13751 13752 13753 13754
    @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 已提交
13755 13756 13757 13758 13759 13760 13761 13762 13763 13764 13765 13766 13767 13768 13769 13770 13771 13772 13773 13774

    @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

13775
    @throw parse_error.106 if an array index in the passed JSON pointer @a ptr
13776
    begins with '0'. See example below.
N
Niels 已提交
13777

13778
    @throw parse_error.109 if an array index in the passed JSON pointer @a ptr
13779
    is not a number. See example below.
N
Niels 已提交
13780

13781 13782 13783 13784
    @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
13785
    pointer @a ptr. As `at` provides checked access (and no elements are
13786 13787 13788 13789
    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.
13790

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

13794
    @complexity Constant.
N
Niels 已提交
13795 13796

    @since version 2.0.0
13797 13798

    @liveexample{The behavior is shown in the example.,at_json_pointer}
N
Niels 已提交
13799 13800 13801 13802 13803 13804 13805 13806 13807
    */
    reference at(const json_pointer& ptr)
    {
        return ptr.get_checked(this);
    }

    /*!
    @brief access specified element via JSON Pointer

N
Niels 已提交
13808 13809
    Returns a const reference to the element at with specified JSON pointer @a
    ptr, with bounds checking.
N
Niels 已提交
13810 13811 13812 13813 13814

    @param[in] ptr  JSON pointer to the desired element

    @return reference to the element pointed to by @a ptr

13815
    @throw parse_error.106 if an array index in the passed JSON pointer @a ptr
13816
    begins with '0'. See example below.
N
Niels 已提交
13817

13818
    @throw parse_error.109 if an array index in the passed JSON pointer @a ptr
13819
    is not a number. See example below.
N
Niels 已提交
13820

13821 13822
    @throw out_of_range.401 if an array index in the passed JSON pointer @a ptr
    is out of range. See example below.
13823

13824
    @throw out_of_range.402 if the array index '-' is used in the passed JSON
13825
    pointer @a ptr. As `at` provides checked access (and no elements are
13826
    implicitly inserted), the index '-' is always invalid. See example below.
13827

13828 13829
    @throw out_of_range.404 if the JSON pointer @a ptr can not be resolved.
    See example below.
N
Niels 已提交
13830

13831 13832 13833 13834
    @exceptionsafety Strong guarantee: if an exception is thrown, there are no
    changes in the JSON value.

    @complexity Constant.
N
Niels 已提交
13835 13836

    @since version 2.0.0
13837 13838

    @liveexample{The behavior is shown in the example.,at_json_pointer_const}
N
Niels 已提交
13839 13840 13841 13842 13843 13844
    */
    const_reference at(const json_pointer& ptr) const
    {
        return ptr.get_checked(this);
    }

N
Niels 已提交
13845
    /*!
N
Niels 已提交
13846 13847
    @brief return flattened JSON value

N
Niels 已提交
13848 13849 13850 13851
    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 已提交
13852

N
Niels Lohmann 已提交
13853
    @return an object that maps JSON pointers to primitive values
N
Niels 已提交
13854

N
Niels 已提交
13855 13856
    @note Empty objects and arrays are flattened to `null` and will not be
          reconstructed correctly by the @ref unflatten() function.
N
Niels 已提交
13857 13858 13859 13860 13861 13862 13863 13864 13865

    @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 已提交
13866 13867 13868 13869 13870 13871 13872
    */
    basic_json flatten() const
    {
        basic_json result(value_t::object);
        json_pointer::flatten("", *this, result);
        return result;
    }
N
Niels 已提交
13873 13874

    /*!
N
Niels 已提交
13875 13876 13877 13878 13879 13880 13881 13882 13883 13884
    @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 已提交
13885
    @return the original JSON from a flattened version
N
Niels 已提交
13886 13887 13888 13889 13890 13891 13892 13893

    @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 已提交
13894
    @throw type_error.314  if value is not an object
N
Niels Lohmann 已提交
13895
    @throw type_error.315  if object values are not primitive
N
Niels Lohmann 已提交
13896

N
Niels 已提交
13897 13898 13899 13900 13901 13902
    @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 已提交
13903
    */
N
Niels 已提交
13904
    basic_json unflatten() const
N
Niels 已提交
13905
    {
N
Niels 已提交
13906
        return json_pointer::unflatten(*this);
N
Niels 已提交
13907
    }
N
Niels 已提交
13908 13909

    /// @}
13910

N
Niels 已提交
13911 13912 13913 13914 13915 13916 13917
    //////////////////////////
    // JSON Patch functions //
    //////////////////////////

    /// @name JSON Patch functions
    /// @{

13918 13919 13920
    /*!
    @brief applies a JSON patch

N
Niels 已提交
13921 13922
    [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 已提交
13923
    this function, a JSON Patch is applied to the current JSON value by
N
Niels 已提交
13924 13925
    executing all operations from the patch.

N
Niels 已提交
13926
    @param[in] json_patch  JSON patch document
13927 13928
    @return patched document

N
Niels 已提交
13929 13930 13931 13932 13933
    @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 已提交
13934 13935 13936 13937
    @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 已提交
13938 13939
    attributes are missing); example: `"operation add must have member path"`

N
Niels Lohmann 已提交
13940 13941
    @throw out_of_range.401 if an array index is out of range.

13942 13943 13944
    @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 已提交
13945 13946 13947 13948 13949

    @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 已提交
13950 13951 13952 13953

    @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.
13954

N
Niels 已提交
13955 13956 13957 13958 13959 13960 13961 13962 13963
    @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
13964
    */
N
Niels 已提交
13965
    basic_json patch(const basic_json& json_patch) const
13966
    {
N
Niels 已提交
13967
        // make a working copy to apply the patch to
13968 13969
        basic_json result = *this;

N
Niels 已提交
13970 13971 13972
        // the valid JSON Patch operations
        enum class patch_operations {add, remove, replace, move, copy, test, invalid};

N
Niels Lohmann 已提交
13973
        const auto get_op = [](const std::string & op)
N
Niels 已提交
13974 13975 13976 13977 13978 13979 13980 13981 13982 13983 13984 13985 13986 13987 13988 13989 13990 13991 13992 13993 13994 13995 13996 13997 13998 13999 14000 14001 14002
        {
            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 已提交
14003
        // wrapper for "add" operation; add value at ptr
N
Niels 已提交
14004
        const auto operation_add = [&result](json_pointer & ptr, basic_json val)
N
Niels 已提交
14005
        {
N
Niels 已提交
14006 14007
            // adding to the root of the target document means replacing it
            if (ptr.is_root())
N
Niels 已提交
14008
            {
N
Niels 已提交
14009
                result = val;
N
Niels 已提交
14010
            }
N
Niels 已提交
14011
            else
N
Niels 已提交
14012
            {
N
Niels 已提交
14013 14014 14015
                // make sure the top element of the pointer exists
                json_pointer top_pointer = ptr.top();
                if (top_pointer != ptr)
N
Niels 已提交
14016
                {
N
Niels 已提交
14017
                    result.at(top_pointer);
N
Niels 已提交
14018
                }
N
Niels 已提交
14019 14020 14021 14022 14023 14024

                // 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 已提交
14025
                {
N
Niels 已提交
14026 14027 14028 14029 14030 14031 14032 14033 14034 14035 14036 14037 14038 14039 14040 14041 14042 14043 14044 14045 14046
                    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
14047
                                JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
14048 14049 14050 14051 14052 14053 14054 14055 14056 14057 14058 14059
                            }
                            else
                            {
                                // default case: insert add offset
                                parent.insert(parent.begin() + static_cast<difference_type>(idx), val);
                            }
                        }
                        break;
                    }

                    default:
                    {
N
Niels 已提交
14060 14061
                        // if there exists a parent it cannot be primitive
                        assert(false);  // LCOV_EXCL_LINE
N
Niels 已提交
14062
                    }
N
Niels 已提交
14063 14064 14065 14066
                }
            }
        };

N
Niels 已提交
14067
        // wrapper for "remove" operation; remove value at ptr
N
Niels 已提交
14068 14069
        const auto operation_remove = [&result](json_pointer & ptr)
        {
N
Niels 已提交
14070
            // get reference to parent of JSON pointer ptr
N
Niels 已提交
14071 14072
            const auto last_path = ptr.pop_back();
            basic_json& parent = result.at(ptr);
N
Niels 已提交
14073 14074

            // remove child
N
Niels 已提交
14075 14076
            if (parent.is_object())
            {
N
Niels 已提交
14077 14078 14079 14080 14081 14082 14083 14084
                // perform range check
                auto it = parent.find(last_path);
                if (it != parent.end())
                {
                    parent.erase(it);
                }
                else
                {
14085
                    JSON_THROW(out_of_range::create(403, "key '" + last_path + "' not found"));
N
Niels 已提交
14086
                }
N
Niels 已提交
14087 14088 14089
            }
            else if (parent.is_array())
            {
N
Niels 已提交
14090 14091
                // note erase performs range check
                parent.erase(static_cast<size_type>(std::stoi(last_path)));
N
Niels 已提交
14092 14093 14094
            }
        };

14095
        // type check: top level value must be an array
N
Niels 已提交
14096
        if (not json_patch.is_array())
N
Niels 已提交
14097
        {
14098
            JSON_THROW(parse_error::create(104, 0, "JSON patch must be an array of objects"));
N
Niels 已提交
14099 14100
        }

N
Niels Lohmann 已提交
14101
        // iterate and apply the operations
N
Niels 已提交
14102
        for (const auto& val : json_patch)
14103
        {
N
Niels 已提交
14104 14105 14106
            // wrapper to get a value for an operation
            const auto get_value = [&val](const std::string & op,
                                          const std::string & member,
N
Niels 已提交
14107
                                          bool string_type) -> basic_json&
14108
            {
N
Niels 已提交
14109 14110
                // find value
                auto it = val.m_value.object->find(member);
14111

N
Niels 已提交
14112 14113
                // context-sensitive error message
                const auto error_msg = (op == "op") ? "operation" : "operation '" + op + "'";
14114

N
Niels 已提交
14115 14116 14117
                // check if desired value is present
                if (it == val.m_value.object->end())
                {
14118
                    JSON_THROW(parse_error::create(105, 0, error_msg + " must have member '" + member + "'"));
N
Niels 已提交
14119
                }
14120

N
Niels 已提交
14121 14122 14123
                // check if result is of type string
                if (string_type and not it->second.is_string())
                {
14124
                    JSON_THROW(parse_error::create(105, 0, error_msg + " must have string member '" + member + "'"));
N
Niels 已提交
14125 14126 14127 14128 14129 14130
                }

                // no error: return value
                return it->second;
            };

14131
            // type check: every element of the array must be an object
N
Niels 已提交
14132
            if (not val.is_object())
14133
            {
14134
                JSON_THROW(parse_error::create(104, 0, "JSON patch must be an array of objects"));
14135 14136
            }

N
Niels 已提交
14137 14138 14139
            // collect mandatory members
            const std::string op = get_value("op", "op", true);
            const std::string path = get_value(op, "path", true);
N
oops  
Niels 已提交
14140
            json_pointer ptr(path);
14141

N
Niels 已提交
14142
            switch (get_op(op))
14143
            {
N
Niels 已提交
14144 14145 14146 14147 14148 14149 14150 14151 14152 14153 14154 14155 14156 14157 14158 14159 14160 14161 14162 14163 14164 14165 14166 14167 14168 14169 14170 14171 14172 14173 14174 14175 14176 14177 14178 14179 14180 14181
                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:
                {
14182
                    const std::string from_path = get_value("copy", "from", true);
N
Niels 已提交
14183 14184 14185 14186 14187 14188 14189 14190 14191 14192
                    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;
14193
                    JSON_TRY
N
Niels 已提交
14194 14195 14196 14197 14198
                    {
                        // check if "value" matches the one at "path"
                        // the "path" location must exist - use at()
                        success = (result.at(ptr) == get_value("test", "value", false));
                    }
14199
                    JSON_CATCH (out_of_range&)
N
Niels 已提交
14200 14201 14202 14203 14204 14205 14206
                    {
                        // ignore out of range errors: success remains false
                    }

                    // throw an exception if test fails
                    if (not success)
                    {
14207
                        JSON_THROW(other_error::create(501, "unsuccessful: " + val.dump()));
N
Niels 已提交
14208 14209 14210 14211 14212 14213 14214 14215 14216
                    }

                    break;
                }

                case patch_operations::invalid:
                {
                    // op must be "add", "remove", "replace", "move", "copy", or
                    // "test"
14217
                    JSON_THROW(parse_error::create(105, 0, "operation value '" + op + "' is invalid"));
N
Niels 已提交
14218
                }
14219
            }
N
Niels 已提交
14220 14221 14222 14223 14224 14225 14226 14227 14228 14229 14230 14231 14232 14233 14234 14235 14236 14237 14238 14239
        }

        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 已提交
14240 14241
    @param[in] source  JSON value to compare from
    @param[in] target  JSON value to compare against
N
Niels 已提交
14242 14243 14244 14245 14246 14247 14248 14249 14250 14251 14252 14253 14254 14255 14256 14257 14258
    @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,
14259
                           const std::string& path = "")
N
Niels 已提交
14260 14261 14262 14263 14264 14265 14266 14267 14268 14269 14270 14271 14272 14273
    {
        // 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(
14274
            {
N
Niels 已提交
14275 14276 14277 14278 14279 14280 14281 14282
                {"op", "replace"},
                {"path", path},
                {"value", target}
            });
        }
        else
        {
            switch (source.type())
14283
            {
N
Niels 已提交
14284 14285 14286 14287 14288 14289 14290 14291 14292 14293 14294
                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 已提交
14295

N
Niels 已提交
14296 14297
                    // i now reached the end of at least one array
                    // in a second pass, traverse the remaining elements
N
Niels 已提交
14298

N
Niels 已提交
14299
                    // remove my remaining elements
N
Niels 已提交
14300
                    const auto end_index = static_cast<difference_type>(result.size());
N
Niels 已提交
14301 14302
                    while (i < source.size())
                    {
N
Niels 已提交
14303 14304
                        // add operations in reverse order to avoid invalid
                        // indices
N
Niels 已提交
14305
                        result.insert(result.begin() + end_index, object(
N
Niels 已提交
14306 14307 14308 14309 14310 14311 14312 14313 14314 14315 14316 14317 14318 14319 14320 14321 14322 14323 14324 14325 14326 14327 14328
                        {
                            {"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:
14329
                {
N
Niels 已提交
14330 14331 14332 14333 14334 14335 14336 14337 14338 14339 14340 14341 14342 14343 14344 14345 14346 14347 14348 14349 14350 14351 14352 14353 14354 14355 14356 14357 14358 14359 14360 14361 14362 14363 14364 14365 14366 14367 14368 14369 14370 14371 14372 14373 14374 14375 14376 14377 14378 14379 14380 14381
                    // 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;
14382 14383 14384 14385 14386 14387
                }
            }
        }

        return result;
    }
N
Niels 已提交
14388 14389

    /// @}
N
Niels 已提交
14390 14391 14392 14393 14394 14395
};

/////////////
// presets //
/////////////

N
Niels 已提交
14396 14397 14398
/*!
@brief default JSON class

N
Niels 已提交
14399 14400
This type is the default specialization of the @ref basic_json class which
uses the standard template types.
N
Niels 已提交
14401

N
Niels 已提交
14402
@since version 1.0.0
N
Niels 已提交
14403
*/
N
Niels 已提交
14404
using json = basic_json<>;
N
Niels Lohmann 已提交
14405
} // namespace nlohmann
N
Niels 已提交
14406 14407


N
Niels 已提交
14408 14409 14410
///////////////////////
// nonmember support //
///////////////////////
N
Niels 已提交
14411 14412 14413

// specialization of std::swap, and std::hash
namespace std
T
Théo DELRIEU 已提交
14414 14415 14416 14417 14418 14419 14420 14421 14422 14423 14424 14425 14426 14427 14428 14429 14430 14431 14432
{
/*!
@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 已提交
14433
{
N
Niels 已提交
14434
    /*!
T
Théo DELRIEU 已提交
14435
    @brief return a hash value for a JSON object
N
Niels 已提交
14436

N
Niels 已提交
14437
    @since version 1.0.0
N
Niels 已提交
14438
    */
T
Théo DELRIEU 已提交
14439
    std::size_t operator()(const nlohmann::json& j) const
N
Niels 已提交
14440 14441
    {
        // a naive hashing via the string representation
N
Niels 已提交
14442 14443
        const auto& h = hash<nlohmann::json::string_t>();
        return h(j.dump());
N
Niels 已提交
14444
    }
T
Théo DELRIEU 已提交
14445
};
14446 14447 14448 14449 14450 14451 14452 14453 14454 14455 14456 14457 14458 14459 14460 14461

/// 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 已提交
14462
} // namespace std
N
Niels 已提交
14463 14464

/*!
N
Niels 已提交
14465 14466
@brief user-defined string literal for JSON values

N
Niels 已提交
14467
This operator implements a user-defined string literal for JSON objects. It
N
Niels 已提交
14468
can be used by adding `"_json"` to a string literal and returns a JSON object
N
Niels 已提交
14469
if no parse error occurred.
N
Niels 已提交
14470

N
Niels 已提交
14471
@param[in] s  a string representation of a JSON object
14472
@param[in] n  the length of string @a s
N
Niels 已提交
14473
@return a JSON object
N
Niels 已提交
14474

N
Niels 已提交
14475
@since version 1.0.0
N
Niels 已提交
14476
*/
14477
inline nlohmann::json operator "" _json(const char* s, std::size_t n)
N
Niels 已提交
14478
{
14479
    return nlohmann::json::parse(s, s + n);
N
Niels 已提交
14480 14481
}

N
Niels 已提交
14482 14483 14484
/*!
@brief user-defined string literal for JSON pointer

N
Niels 已提交
14485
This operator implements a user-defined string literal for JSON Pointers. It
N
Niels 已提交
14486
can be used by adding `"_json_pointer"` to a string literal and returns a JSON pointer
N
Niels 已提交
14487 14488 14489
object if no parse error occurred.

@param[in] s  a string representation of a JSON Pointer
14490
@param[in] n  the length of string @a s
N
Niels 已提交
14491 14492
@return a JSON pointer object

N
Niels 已提交
14493 14494
@since version 2.0.0
*/
14495
inline nlohmann::json::json_pointer operator "" _json_pointer(const char* s, std::size_t n)
N
Niels 已提交
14496
{
14497
    return nlohmann::json::json_pointer(std::string(s, n));
N
Niels 已提交
14498 14499
}

14500 14501 14502 14503
// restore GCC/clang diagnostic settings
#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
    #pragma GCC diagnostic pop
#endif
L
Lukas Barth 已提交
14504 14505 14506
#if defined(__clang__)
    #pragma GCC diagnostic pop
#endif
14507

14508 14509
// clean up
#undef JSON_CATCH
N
Niels Lohmann 已提交
14510 14511
#undef JSON_THROW
#undef JSON_TRY
N
Niels Lohmann 已提交
14512 14513
#undef JSON_LIKELY
#undef JSON_UNLIKELY
14514
#undef JSON_DEPRECATED
14515

N
Niels 已提交
14516
#endif