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

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

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

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

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

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

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

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

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

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

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

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

N
Niels Lohmann 已提交
102
// manual branch prediction
103 104 105 106 107 108 109
#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
    #define JSON_LIKELY(x)      __builtin_expect(!!(x), 1)
    #define JSON_UNLIKELY(x)    __builtin_expect(!!(x), 0)
#else
    #define JSON_LIKELY(x)      x
    #define JSON_UNLIKELY(x)    x
#endif
N
Niels Lohmann 已提交
110

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

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

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

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

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

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

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

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

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

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

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

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

/*!
@brief exception indicating a parse error

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

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

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

Exceptions have ids 1xx.

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

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

    /*!
    @brief byte index of the parse error

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

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

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

/*!
@brief exception indicating errors with iterators

Exceptions have ids 2xx.

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

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

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

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

Exceptions have ids 3xx.

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

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

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

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

Exceptions have ids 4xx.

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

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

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

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

Exceptions have ids 5xx.

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

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

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


380

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

/*!
@brief the JSON type enumeration

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

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

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

@since version 1.0.0
*/
enum class value_t : uint8_t
{
T
Théo DELRIEU 已提交
411 412 413 414 415 416 417 418 419
    null,            ///< null value
    object,          ///< object (unordered set of name/value pairs)
    array,           ///< array (ordered collection of values)
    string,          ///< string value
    boolean,         ///< boolean value
    number_integer,  ///< number value (signed integer)
    number_unsigned, ///< number value (unsigned integer)
    number_float,    ///< number value (floating-point)
    discarded        ///< discarded by the the parser callback function
420 421
};

422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
/*!
@brief comparison operator for JSON types

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

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

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

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

455 456 457 458 459

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

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

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

N
Niels Lohmann 已提交
467
// taken from http://stackoverflow.com/a/26936864/266378
468
template<typename T>
T
Théo DELRIEU 已提交
469 470
using is_unscoped_enum =
    std::integral_constant<bool, std::is_convertible<T, int>::value and
471
    std::is_enum<T>::value>;
T
Théo DELRIEU 已提交
472

473
/*
N
Niels Lohmann 已提交
474
Implementation of two C++17 constructs: conjunction, negation. This is needed
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
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 {};
490

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

493
// dispatch utility (taken from ranges-v3)
494 495
template<unsigned N> struct priority_tag : priority_tag < N - 1 > {};
template<> struct priority_tag<0> {};
496

497 498 499 500

//////////////////
// constructors //
//////////////////
501

502
template<value_t> struct external_constructor;
503

504
template<>
505 506
struct external_constructor<value_t::boolean>
{
507
    template<typename BasicJsonType>
508
    static void construct(BasicJsonType& j, typename BasicJsonType::boolean_t b) noexcept
T
Théo DELRIEU 已提交
509 510 511 512 513
    {
        j.m_type = value_t::boolean;
        j.m_value = b;
        j.assert_invariant();
    }
514
};
515

516
template<>
517 518
struct external_constructor<value_t::string>
{
519
    template<typename BasicJsonType>
520
    static void construct(BasicJsonType& j, const typename BasicJsonType::string_t& s)
T
Théo DELRIEU 已提交
521 522 523 524 525
    {
        j.m_type = value_t::string;
        j.m_value = s;
        j.assert_invariant();
    }
526
};
527

528
template<>
529 530
struct external_constructor<value_t::number_float>
{
531
    template<typename BasicJsonType>
532
    static void construct(BasicJsonType& j, typename BasicJsonType::number_float_t val) noexcept
533
    {
534 535
        j.m_type = value_t::number_float;
        j.m_value = val;
T
Théo DELRIEU 已提交
536
        j.assert_invariant();
537 538 539
    }
};

540
template<>
541 542
struct external_constructor<value_t::number_unsigned>
{
543
    template<typename BasicJsonType>
544
    static void construct(BasicJsonType& j, typename BasicJsonType::number_unsigned_t val) noexcept
T
Théo DELRIEU 已提交
545 546 547 548 549
    {
        j.m_type = value_t::number_unsigned;
        j.m_value = val;
        j.assert_invariant();
    }
550 551
};

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

564
template<>
565 566
struct external_constructor<value_t::array>
{
567
    template<typename BasicJsonType>
568
    static void construct(BasicJsonType& j, const typename BasicJsonType::array_t& arr)
T
Théo DELRIEU 已提交
569 570 571 572 573 574
    {
        j.m_type = value_t::array;
        j.m_value = arr;
        j.assert_invariant();
    }

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

    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();
    }
600 601
};

602
template<>
603 604
struct external_constructor<value_t::object>
{
605
    template<typename BasicJsonType>
606
    static void construct(BasicJsonType& j, const typename BasicJsonType::object_t& obj)
T
Théo DELRIEU 已提交
607 608 609 610 611 612
    {
        j.m_type = value_t::object;
        j.m_value = obj;
        j.assert_invariant();
    }

613 614 615 616
    template<typename BasicJsonType, typename CompatibleObjectType,
             enable_if_t<not std::is_same<CompatibleObjectType,
                                          typename BasicJsonType::object_t>::value,
                         int> = 0>
617
    static void construct(BasicJsonType& j, const CompatibleObjectType& obj)
T
Théo DELRIEU 已提交
618 619 620
    {
        using std::begin;
        using std::end;
621

T
Théo DELRIEU 已提交
622
        j.m_type = value_t::object;
623
        j.m_value.object = j.template create<typename BasicJsonType::object_t>(begin(obj), end(obj));
T
Théo DELRIEU 已提交
624 625
        j.assert_invariant();
    }
626 627
};

628 629 630 631 632

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

633 634
/*!
@brief Helper to determine whether there's a key_type for T.
N
Niels Lohmann 已提交
635 636

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

640
@sa http://stackoverflow.com/a/7728728/266378
N
Niels 已提交
641
@since version 1.0.0, overworked in version 2.0.6
642
*/
N
Niels Lohmann 已提交
643
#define NLOHMANN_JSON_HAS_HELPER(type)                                        \
644
    template<typename T> struct has_##type {                                  \
N
Niels Lohmann 已提交
645
    private:                                                                  \
646
        template<typename U, typename = typename U::type>                     \
N
Niels Lohmann 已提交
647 648 649 650 651
        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 已提交
652
    }
T
Théo Delrieu 已提交
653

N
Niels Lohmann 已提交
654 655 656 657
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 已提交
658 659

#undef NLOHMANN_JSON_HAS_HELPER
660

N
Niels Lohmann 已提交
661

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

665
template<class RealType, class CompatibleObjectType>
T
Théo DELRIEU 已提交
666 667
struct is_compatible_object_type_impl<true, RealType, CompatibleObjectType>
{
668 669 670 671 672
    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 已提交
673 674
};

675
template<class BasicJsonType, class CompatibleObjectType>
T
Théo DELRIEU 已提交
676 677
struct is_compatible_object_type
{
T
Théo DELRIEU 已提交
678 679 680 681
    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,
682
                                  typename BasicJsonType::object_t, CompatibleObjectType >::value;
T
Théo DELRIEU 已提交
683 684
};

685
template<typename BasicJsonType, typename T>
686
struct is_basic_json_nested_type
T
Théo DELRIEU 已提交
687
{
688 689 690 691 692
    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 已提交
693 694
};

695
template<class BasicJsonType, class CompatibleArrayType>
T
Théo DELRIEU 已提交
696 697
struct is_compatible_array_type
{
T
Théo DELRIEU 已提交
698
    static auto constexpr value =
699
        conjunction<negation<std::is_same<void, CompatibleArrayType>>,
T
Théo DELRIEU 已提交
700
        negation<is_compatible_object_type<
701 702
        BasicJsonType, CompatibleArrayType>>,
        negation<std::is_constructible<typename BasicJsonType::string_t,
T
Théo DELRIEU 已提交
703
        CompatibleArrayType>>,
704
        negation<is_basic_json_nested_type<BasicJsonType, CompatibleArrayType>>,
T
Théo DELRIEU 已提交
705 706
        has_value_type<CompatibleArrayType>,
        has_iterator<CompatibleArrayType>>::value;
T
Théo DELRIEU 已提交
707 708
};

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

712
template<typename RealIntegerType, typename CompatibleNumberIntegerType>
713
struct is_compatible_integer_type_impl<true, RealIntegerType, CompatibleNumberIntegerType>
T
Théo DELRIEU 已提交
714
{
T
Théo DELRIEU 已提交
715
    // is there an assert somewhere on overflows?
716 717 718 719 720 721 722 723
    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 已提交
724 725
};

726
template<typename RealIntegerType, typename CompatibleNumberIntegerType>
727 728
struct is_compatible_integer_type
{
729 730 731 732 733
    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;
734 735
};

736

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

748 749
  public:
    static constexpr bool value = std::is_integral<decltype(
750
                                      detect(std::declval<typename BasicJsonType::template json_serializer<T, void>>()))>::value;
751 752 753 754
};

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

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

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

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

786

787 788 789
/////////////
// to_json //
/////////////
790

N
Niels Lohmann 已提交
791
template<typename BasicJsonType, typename T, enable_if_t<
792
             std::is_same<T, typename BasicJsonType::boolean_t>::value, int> = 0>
N
Niels Lohmann 已提交
793
void to_json(BasicJsonType& j, T b) noexcept
794
{
T
Théo DELRIEU 已提交
795
    external_constructor<value_t::boolean>::construct(j, b);
796 797
}

798 799
template<typename BasicJsonType, typename CompatibleString,
         enable_if_t<std::is_constructible<typename BasicJsonType::string_t,
N
Niels Lohmann 已提交
800
                     CompatibleString>::value, int> = 0>
801
void to_json(BasicJsonType& j, const CompatibleString& s)
802
{
T
Théo DELRIEU 已提交
803
    external_constructor<value_t::string>::construct(j, s);
804 805
}

806 807
template<typename BasicJsonType, typename FloatType,
         enable_if_t<std::is_floating_point<FloatType>::value, int> = 0>
808
void to_json(BasicJsonType& j, FloatType val) noexcept
809
{
810
    external_constructor<value_t::number_float>::construct(j, static_cast<typename BasicJsonType::number_float_t>(val));
811 812
}

813
template <
814 815
    typename BasicJsonType, typename CompatibleNumberUnsignedType,
    enable_if_t<is_compatible_integer_type<typename BasicJsonType::number_unsigned_t,
N
Niels Lohmann 已提交
816
                CompatibleNumberUnsignedType>::value, int> = 0 >
817
void to_json(BasicJsonType& j, CompatibleNumberUnsignedType val) noexcept
818
{
819
    external_constructor<value_t::number_unsigned>::construct(j, static_cast<typename BasicJsonType::number_unsigned_t>(val));
820 821
}

822
template <
823 824
    typename BasicJsonType, typename CompatibleNumberIntegerType,
    enable_if_t<is_compatible_integer_type<typename BasicJsonType::number_integer_t,
N
Niels Lohmann 已提交
825
                CompatibleNumberIntegerType>::value, int> = 0 >
826
void to_json(BasicJsonType& j, CompatibleNumberIntegerType val) noexcept
827
{
828
    external_constructor<value_t::number_integer>::construct(j, static_cast<typename BasicJsonType::number_integer_t>(val));
829 830
}

831 832
template<typename BasicJsonType, typename UnscopedEnumType,
         enable_if_t<is_unscoped_enum<UnscopedEnumType>::value, int> = 0>
833
void to_json(BasicJsonType& j, UnscopedEnumType e) noexcept
834
{
T
Théo DELRIEU 已提交
835
    external_constructor<value_t::number_integer>::construct(j, e);
836 837
}

838
template<typename BasicJsonType>
839
void to_json(BasicJsonType& j, const std::vector<bool>& e)
840 841
{
    external_constructor<value_t::array>::construct(j, e);
842 843
}

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

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

T
Théo DELRIEU 已提交
864 865 866 867
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 已提交
868 869 870
void to_json(BasicJsonType& j, T (&arr)[N])
{
    external_constructor<value_t::array>::construct(j, arr);
T
Théo DELRIEU 已提交
871
}
872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906

///////////////
// 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:
        {
907
            JSON_THROW(type_error::create(302, "type must be number, but is " + j.type_name()));
908 909 910 911 912
        }
    }
}

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

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

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

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

944
template<typename BasicJsonType>
945
void from_json(const BasicJsonType& j, typename BasicJsonType::number_integer_t& val)
946
{
T
Théo DELRIEU 已提交
947
    get_arithmetic_value(j, val);
948 949
}

950 951 952
template<typename BasicJsonType, typename UnscopedEnumType,
         enable_if_t<is_unscoped_enum<UnscopedEnumType>::value, int> = 0>
void from_json(const BasicJsonType& j, UnscopedEnumType& e)
953
{
954
    typename std::underlying_type<UnscopedEnumType>::type val;
T
Théo DELRIEU 已提交
955 956
    get_arithmetic_value(j, val);
    e = static_cast<UnscopedEnumType>(val);
957 958
}

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

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

T
Théo DELRIEU 已提交
979 980 981 982
    for (auto it = j.rbegin(), end = j.rend(); it != end; ++it)
    {
        l.push_front(it->template get<T>());
    }
983 984
}

985 986
template<typename BasicJsonType, typename CompatibleArrayType>
void from_json_array_impl(const BasicJsonType& j, CompatibleArrayType& arr, priority_tag<0>)
987
{
T
Théo DELRIEU 已提交
988 989
    using std::begin;
    using std::end;
990

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

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

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

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

T
Théo DELRIEU 已提交
1030
    from_json_array_impl(j, arr, priority_tag<1> {});
1031 1032
}

1033 1034 1035
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)
1036
{
N
Niels Lohmann 已提交
1037
    if (not j.is_object())
T
Théo DELRIEU 已提交
1038
    {
1039
        JSON_THROW(type_error::create(302, "type must be object, but is " + j.type_name()));
T
Théo DELRIEU 已提交
1040 1041
    }

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

N
Niels Lohmann 已提交
1051 1052 1053 1054
// 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?
1055 1056 1057 1058 1059 1060 1061 1062
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>
1063
void from_json(const BasicJsonType& j, ArithmeticType& val)
T
Théo DELRIEU 已提交
1064 1065 1066 1067
{
    switch (static_cast<value_t>(j))
    {
        case value_t::number_unsigned:
N
Niels Lohmann 已提交
1068
        {
1069
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_unsigned_t*>());
T
Théo DELRIEU 已提交
1070
            break;
N
Niels Lohmann 已提交
1071
        }
T
Théo DELRIEU 已提交
1072
        case value_t::number_integer:
N
Niels Lohmann 已提交
1073
        {
1074
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_integer_t*>());
T
Théo DELRIEU 已提交
1075
            break;
N
Niels Lohmann 已提交
1076
        }
T
Théo DELRIEU 已提交
1077
        case value_t::number_float:
N
Niels Lohmann 已提交
1078
        {
1079
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_float_t*>());
T
Théo DELRIEU 已提交
1080
            break;
N
Niels Lohmann 已提交
1081
        }
T
Théo DELRIEU 已提交
1082
        case value_t::boolean:
N
Niels Lohmann 已提交
1083
        {
1084
            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::boolean_t*>());
T
Théo DELRIEU 已提交
1085
            break;
N
Niels Lohmann 已提交
1086
        }
T
Théo DELRIEU 已提交
1087
        default:
N
Niels Lohmann 已提交
1088
        {
1089
            JSON_THROW(type_error::create(302, "type must be number, but is " + j.type_name()));
N
Niels Lohmann 已提交
1090
        }
T
Théo DELRIEU 已提交
1091
    }
1092 1093
}

1094 1095
struct to_json_fn
{
N
Niels Lohmann 已提交
1096
  private:
1097 1098 1099
    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())
1100
    {
1101
        return to_json(j, std::forward<T>(val));
1102
    }
T
Théo DELRIEU 已提交
1103

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

T
Théo DELRIEU 已提交
1111
  public:
1112
    template<typename BasicJsonType, typename T>
1113
    void operator()(BasicJsonType& j, T&& val) const
T
Théo DELRIEU 已提交
1114 1115 1116 1117
    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> {});
    }
1118 1119 1120 1121
};

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

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

  public:
1139 1140
    template<typename BasicJsonType, typename T>
    void operator()(const BasicJsonType& j, T& val) const
T
Théo DELRIEU 已提交
1141 1142 1143 1144
    noexcept(noexcept(std::declval<from_json_fn>().call(j, val, priority_tag<1> {})))
    {
        return call(j, val, priority_tag<1> {});
    }
1145
};
1146

1147
// taken from ranges-v3
1148
template<typename T>
1149 1150 1151 1152 1153
struct static_const
{
    static constexpr T value{};
};

1154
template<typename T>
1155
constexpr T static_const<T>::value;
1156 1157
} // namespace detail

N
Niels 已提交
1158

N
Niels Lohmann 已提交
1159
/// namespace to hold default `to_json` / `from_json` functions
1160
namespace
1161
{
T
Théo DELRIEU 已提交
1162 1163
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;
1164 1165
}

N
Niels Lohmann 已提交
1166 1167 1168 1169 1170 1171 1172 1173

/*!
@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.
*/
1174
template<typename = void, typename = void>
1175 1176
struct adl_serializer
{
N
Niels Lohmann 已提交
1177 1178 1179 1180 1181 1182 1183
    /*!
    @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
1184
    @param[in,out] val  value to write to
N
Niels Lohmann 已提交
1185 1186 1187 1188
    */
    template<typename BasicJsonType, typename ValueType>
    static void from_json(BasicJsonType&& j, ValueType& val) noexcept(
        noexcept(::nlohmann::from_json(std::forward<BasicJsonType>(j), val)))
1189
    {
1190
        ::nlohmann::from_json(std::forward<BasicJsonType>(j), val);
1191 1192
    }

N
Niels Lohmann 已提交
1193 1194 1195 1196 1197 1198
    /*!
    @brief convert any value type to a JSON value

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

1199
    @param[in,out] j  JSON value to write to
N
Niels Lohmann 已提交
1200 1201 1202 1203 1204
    @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))))
1205
    {
N
Niels Lohmann 已提交
1206
        ::nlohmann::to_json(j, std::forward<ValueType>(val));
1207
    }
1208 1209
};

1210

N
Niels 已提交
1211
/*!
N
Niels 已提交
1212
@brief a class to store JSON values
N
Niels 已提交
1213

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

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

1274 1275 1276 1277 1278 1279 1280
@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 已提交
1281
@internal
N
Niels 已提交
1282
@note ObjectType trick from http://stackoverflow.com/a/9860911
N
Niels 已提交
1283
@endinternal
N
Niels 已提交
1284

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

N
Niels 已提交
1288
@since version 1.0.0
N
Niels 已提交
1289 1290

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

  public:
1313
    using value_t = detail::value_t;
N
Niels 已提交
1314
    // forward declarations
N
Niels Lohmann 已提交
1315
    template<typename U> class iter_impl;
N
Niels 已提交
1316 1317
    template<typename Base> class json_reverse_iterator;
    class json_pointer;
1318
    template<typename T, typename SFINAE>
1319
    using json_serializer = JSONSerializer<T, SFINAE>;
1320

1321 1322 1323 1324 1325 1326 1327 1328 1329

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

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

1330 1331
    /// @copydoc detail::exception
    using exception = detail::exception;
1332 1333 1334 1335 1336 1337 1338 1339
    /// @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;
1340 1341
    /// @copydoc detail::other_error
    using other_error = detail::other_error;
1342 1343 1344 1345

    /// @}


N
Niels 已提交
1346 1347 1348 1349
    /////////////////////
    // container types //
    /////////////////////

N
Niels 已提交
1350
    /// @name container types
N
Niels 已提交
1351 1352
    /// The canonic container types to use @ref basic_json like any other STL
    /// container.
N
Niels 已提交
1353 1354
    /// @{

N
Niels 已提交
1355
    /// the type of elements in a basic_json container
N
Niels 已提交
1356
    using value_type = basic_json;
N
Niels 已提交
1357

N
Niels 已提交
1358
    /// the type of an element reference
N
Niels 已提交
1359
    using reference = value_type&;
N
Niels 已提交
1360
    /// the type of an element const reference
N
Niels 已提交
1361
    using const_reference = const value_type&;
N
Niels 已提交
1362

N
Niels 已提交
1363
    /// a type to represent differences between iterators
N
Niels 已提交
1364
    using difference_type = std::ptrdiff_t;
N
Niels 已提交
1365
    /// a type to represent container sizes
N
Niels 已提交
1366 1367 1368
    using size_type = std::size_t;

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

N
Niels 已提交
1371
    /// the type of an element pointer
N
Niels 已提交
1372
    using pointer = typename std::allocator_traits<allocator_type>::pointer;
N
Niels 已提交
1373
    /// the type of an element const pointer
N
Niels 已提交
1374
    using const_pointer = typename std::allocator_traits<allocator_type>::const_pointer;
N
Niels 已提交
1375

N
Niels 已提交
1376
    /// an iterator for a basic_json container
1377
    using iterator = iter_impl<basic_json>;
N
Niels 已提交
1378
    /// a const iterator for a basic_json container
1379
    using const_iterator = iter_impl<const basic_json>;
N
Niels 已提交
1380
    /// a reverse iterator for a basic_json container
N
Niels 已提交
1381
    using reverse_iterator = json_reverse_iterator<typename basic_json::iterator>;
N
Niels 已提交
1382
    /// a const reverse iterator for a basic_json container
N
Niels 已提交
1383
    using const_reverse_iterator = json_reverse_iterator<typename basic_json::const_iterator>;
N
Niels 已提交
1384

N
Niels 已提交
1385 1386 1387
    /// @}


N
Niels 已提交
1388 1389 1390
    /*!
    @brief returns the allocator associated with the container
    */
N
Niels 已提交
1391
    static allocator_type get_allocator()
N
Niels 已提交
1392 1393 1394 1395
    {
        return allocator_type();
    }

1396 1397
    /*!
    @brief returns version information on the library
1398

N
Niels Lohmann 已提交
1399
    This function returns a JSON object with information about the library,
1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417
    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
1418
    */
1419
    static basic_json meta()
1420 1421 1422
    {
        basic_json result;

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

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

N
Niels 已提交
1472 1473 1474 1475
    ///////////////////////////
    // JSON value data types //
    ///////////////////////////

N
Niels 已提交
1476
    /// @name JSON value data types
N
Niels 已提交
1477 1478
    /// The data types to store a JSON value. These types are derived from
    /// the template arguments passed to class @ref basic_json.
N
Niels 已提交
1479 1480
    /// @{

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

    #### Default type

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

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

    #### Storage

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

1552 1553
    @sa @ref array_t -- type for an array value

N
Niels 已提交
1554
    @since version 1.0.0
N
Niels 已提交
1555

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

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

    #### 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 已提交
1602 1603
    runtime environment. A theoretical limit can be queried by calling the
    @ref max_size function of a JSON array.
N
Niels 已提交
1604 1605 1606

    #### Storage

1607
    Arrays are stored as pointers in a @ref basic_json type. That is, for any
N
Niels 已提交
1608
    access to array values, a pointer of type `array_t*` must be dereferenced.
1609 1610 1611

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

N
Niels 已提交
1612
    @since version 1.0.0
N
Niels 已提交
1613
    */
N
Niels 已提交
1614
    using array_t = ArrayType<basic_json, AllocatorType<basic_json>>;
N
Niels 已提交
1615 1616 1617 1618 1619 1620 1621

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

N
Niels 已提交
1626 1627
    @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 已提交
1628 1629 1630 1631 1632 1633 1634 1635 1636 1637

    #### Default type

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

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

1638 1639 1640 1641 1642 1643
    #### 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 已提交
1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660
    #### 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

1661 1662
    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 已提交
1663
    dereferenced.
1664

N
Niels 已提交
1665
    @since version 1.0.0
N
Niels 已提交
1666
    */
N
Niels 已提交
1667
    using string_t = StringType;
N
Niels 已提交
1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688

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

1689 1690
    Boolean values are stored directly inside a @ref basic_json type.

N
Niels 已提交
1691
    @since version 1.0.0
N
Niels 已提交
1692
    */
N
Niels 已提交
1693
    using boolean_t = BooleanType;
N
Niels 已提交
1694 1695 1696 1697 1698

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

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

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

    [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

1757 1758 1759 1760
    Integer number values are stored directly inside a @ref basic_json type.

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

1761 1762
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
1763
    @since version 1.0.0
N
Niels 已提交
1764
    */
N
Niels 已提交
1765
    using number_integer_t = NumberIntegerType;
N
Niels 已提交
1766

1767 1768 1769 1770
    /*!
    @brief a type for a number (unsigned)

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

    #### Default type

N
Niels 已提交
1790 1791
    With the default values for @a NumberUnsignedType (`uint64_t`), the
    default value for @a number_unsigned_t is:
1792 1793 1794 1795 1796 1797 1798 1799 1800 1801

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

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

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

N
Niels 已提交
1838 1839 1840 1841
    /*!
    @brief a type for a number (floating-point)

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

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

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

    #### Storage

1895 1896 1897 1898 1899
    Floating-point number values are stored directly inside a @ref basic_json
    type.

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

1900 1901
    @sa @ref number_unsigned_t -- type for number values (unsigned integer)

N
Niels 已提交
1902
    @since version 1.0.0
N
Niels 已提交
1903
    */
N
Niels 已提交
1904 1905
    using number_float_t = NumberFloatType;

N
Niels 已提交
1906 1907
    /// @}

N
Niels 已提交
1908
  private:
N
Niels 已提交
1909

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

N
Niels 已提交
1925 1926 1927 1928
    ////////////////////////
    // JSON value storage //
    ////////////////////////

1929 1930 1931
    /*!
    @brief a JSON value

N
Niels 已提交
1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949
    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.
1950

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

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

1991
                case value_t::array:
N
Niels 已提交
1992
                {
N
Cleanup  
Niels 已提交
1993
                    array = create<array_t>();
N
Niels 已提交
1994 1995
                    break;
                }
N
Niels 已提交
1996

1997
                case value_t::string:
N
Niels 已提交
1998
                {
N
Cleanup  
Niels 已提交
1999
                    string = create<string_t>("");
N
Niels 已提交
2000 2001
                    break;
                }
N
Niels 已提交
2002

2003
                case value_t::boolean:
N
Niels 已提交
2004 2005 2006 2007 2008
                {
                    boolean = boolean_t(false);
                    break;
                }

2009
                case value_t::number_integer:
N
Niels 已提交
2010 2011 2012 2013
                {
                    number_integer = number_integer_t(0);
                    break;
                }
N
Niels 已提交
2014

2015 2016 2017 2018 2019
                case value_t::number_unsigned:
                {
                    number_unsigned = number_unsigned_t(0);
                    break;
                }
N
Niels 已提交
2020

2021
                case value_t::number_float:
N
Niels 已提交
2022 2023 2024 2025
                {
                    number_float = number_float_t(0.0);
                    break;
                }
2026

2027 2028 2029 2030 2031
                case value_t::null:
                {
                    break;
                }

2032 2033
                default:
                {
N
Niels Lohmann 已提交
2034
                    if (JSON_UNLIKELY(t == value_t::null))
2035
                    {
2036
                        JSON_THROW(other_error::create(500, "961c151d2e87f2686a955a9be24d316f1362bf21 2.1.1")); // LCOV_EXCL_LINE
2037
                    }
2038 2039
                    break;
                }
N
Niels 已提交
2040 2041
            }
        }
N
Niels 已提交
2042 2043

        /// constructor for strings
N
Niels 已提交
2044
        json_value(const string_t& value)
N
Niels 已提交
2045
        {
N
Cleanup  
Niels 已提交
2046
            string = create<string_t>(value);
N
Niels 已提交
2047 2048 2049
        }

        /// constructor for objects
N
Niels 已提交
2050
        json_value(const object_t& value)
N
Niels 已提交
2051
        {
N
Cleanup  
Niels 已提交
2052
            object = create<object_t>(value);
N
Niels 已提交
2053 2054 2055
        }

        /// constructor for arrays
N
Niels 已提交
2056
        json_value(const array_t& value)
N
Niels 已提交
2057
        {
N
Cleanup  
Niels 已提交
2058
            array = create<array_t>(value);
N
Niels 已提交
2059
        }
N
Niels 已提交
2060 2061
    };

2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076
    /*!
    @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 已提交
2077 2078

  public:
N
Niels 已提交
2079 2080 2081 2082
    //////////////////////////
    // JSON parser callback //
    //////////////////////////

N
Niels 已提交
2083 2084 2085 2086 2087
    /*!
    @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.
2088

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

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

N
Niels 已提交
2109 2110 2111 2112
    /*!
    @brief per-element parser callback type

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

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

N
Niels 已提交
2136 2137
    Discarding a value (i.e., returning `false`) has different effects
    depending on the context in which function was called:
N
Niels 已提交
2138 2139 2140

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

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

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

N
Niels 已提交
2159
    @since version 1.0.0
N
Niels 已提交
2160
    */
N
Niels 已提交
2161 2162 2163
    using parser_callback_t = std::function<bool(int depth,
                              parse_event_t event,
                              basic_json& parsed)>;
N
Niels 已提交
2164

N
Niels 已提交
2165 2166 2167 2168 2169

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

N
Niels 已提交
2170
    /// @name constructors and destructors
N
Niels 已提交
2171 2172
    /// Constructors of class @ref basic_json, copy/move constructor, copy
    /// assignment, static functions creating objects, and the destructor.
N
Niels 已提交
2173 2174
    /// @{

N
Niels 已提交
2175 2176 2177
    /*!
    @brief create an empty value with a given type

N
Niels 已提交
2178 2179 2180 2181 2182
    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 已提交
2183 2184 2185 2186 2187 2188
    null        | `null`
    boolean     | `false`
    string      | `""`
    number      | `0`
    object      | `{}`
    array       | `[]`
N
Niels 已提交
2189

2190
    @param[in] value_type  the type of the value to create
N
Niels 已提交
2191 2192 2193 2194 2195

    @complexity Constant.

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

N
Niels 已提交
2197
    @since version 1.0.0
N
Niels 已提交
2198
    */
2199 2200
    basic_json(const value_t value_type)
        : m_type(value_type), m_value(value_type)
2201 2202 2203
    {
        assert_invariant();
    }
N
Niels 已提交
2204

N
Niels 已提交
2205
    /*!
N
Niels 已提交
2206
    @brief create a null object
N
Niels 已提交
2207

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

    @complexity Constant.

N
Niels 已提交
2215 2216 2217
    @exceptionsafety No-throw guarantee: this constructor never throws
    exceptions.

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

N
Niels 已提交
2221
    @since version 1.0.0
N
Niels 已提交
2222
    */
N
Niels 已提交
2223
    basic_json(std::nullptr_t = nullptr) noexcept
N
Niels 已提交
2224
        : basic_json(value_t::null)
2225 2226 2227
    {
        assert_invariant();
    }
N
Niels 已提交
2228

T
Théo DELRIEU 已提交
2229
    /*!
2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267
    @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 已提交
2268 2269 2270

    @param[in] val the value to be forwarded

2271 2272 2273 2274 2275 2276 2277 2278
    @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 已提交
2279 2280 2281

    @since version 2.1.0
    */
2282
    template<typename CompatibleType, typename U = detail::uncvref_t<CompatibleType>,
2283 2284 2285 2286 2287 2288
             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>
2289 2290
    basic_json(CompatibleType && val) noexcept(noexcept(JSONSerializer<U>::to_json(
                std::declval<basic_json_t&>(), std::forward<CompatibleType>(val))))
2291
    {
2292 2293
        JSONSerializer<U>::to_json(*this, std::forward<CompatibleType>(val));
        assert_invariant();
2294
    }
2295

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

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

N
Niels 已提交
2322 2323
    With the rules described above, the following JSON values cannot be
    expressed by an initializer list:
N
Niels 已提交
2324

N
Niels 已提交
2325 2326 2327 2328 2329
    - 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 已提交
2330 2331 2332 2333 2334

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

N
Niels 已提交
2337 2338 2339
    @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 已提交
2340 2341
    used by the functions @ref array(std::initializer_list<basic_json>) and
    @ref object(std::initializer_list<basic_json>).
N
Niels 已提交
2342

N
Niels 已提交
2343 2344
    @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 已提交
2345 2346 2347
    value_t::array and @ref value_t::object are valid); when @a type_deduction
    is set to `true`, this parameter has no effect

2348 2349
    @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
2350 2351 2352 2353
    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 已提交
2354 2355 2356 2357

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

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

N
Niels 已提交
2360
    @sa @ref array(std::initializer_list<basic_json>) -- create a JSON array
2361
    value from an initializer list
N
Niels 已提交
2362
    @sa @ref object(std::initializer_list<basic_json>) -- create a JSON object
2363 2364
    value from an initializer list

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

        // 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)
            {
2385
                is_an_object = false;
N
Niels 已提交
2386 2387 2388
            }

            // if object is wanted but impossible, throw an exception
2389
            if (manual_type == value_t::object and not is_an_object)
N
Niels 已提交
2390
            {
2391
                JSON_THROW(type_error::create(301, "cannot create object from initializer list"));
N
Niels 已提交
2392 2393 2394
            }
        }

2395
        if (is_an_object)
N
Niels 已提交
2396 2397 2398
        {
            // the initializer list is a list of pairs -> create object
            m_type = value_t::object;
N
Niels 已提交
2399
            m_value = value_t::object;
N
Niels 已提交
2400

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

        assert_invariant();
N
Niels 已提交
2414 2415
    }

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

N
Niels 已提交
2433
    @param[in] init  initializer list with JSON values to create an array from
N
Niels 已提交
2434 2435 2436 2437 2438 2439
    (optional)

    @return JSON array value

    @complexity Linear in the size of @a init.

N
Niels 已提交
2440
    @liveexample{The following code shows an example for the `array`
N
Niels 已提交
2441 2442
    function.,array}

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

N
Niels 已提交
2456 2457 2458 2459
    /*!
    @brief explicitly create an object from an initializer list

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

    @note This function is only added for symmetry reasons. In contrast to the
2464 2465 2466
    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
2467
    constructor @ref basic_json(std::initializer_list<basic_json>, bool, value_t).
N
Niels 已提交
2468

N
Niels 已提交
2469
    @param[in] init  initializer list to create an object from (optional)
N
Niels 已提交
2470 2471 2472

    @return JSON object value

2473 2474 2475 2476 2477
    @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 已提交
2478 2479 2480

    @complexity Linear in the size of @a init.

N
Niels 已提交
2481
    @liveexample{The following code shows an example for the `object`
N
Niels 已提交
2482 2483
    function.,object}

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

N
Niels 已提交
2497 2498 2499
    /*!
    @brief construct an array with count copies of given value

N
Niels 已提交
2500 2501
    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,
2502
    `std::distance(begin(),end()) == cnt` holds.
N
Niels 已提交
2503

2504 2505
    @param[in] cnt  the number of JSON copies of @a val to create
    @param[in] val  the JSON value to copy
N
Niels 已提交
2506

2507
    @complexity Linear in @a cnt.
N
Niels 已提交
2508 2509 2510 2511

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

N
Niels 已提交
2513
    @since version 1.0.0
N
Niels 已提交
2514
    */
2515
    basic_json(size_type cnt, const basic_json& val)
N
Niels 已提交
2516 2517
        : m_type(value_t::array)
    {
2518
        m_value.array = create<array_t>(cnt, val);
2519
        assert_invariant();
N
Niels 已提交
2520
    }
N
Niels 已提交
2521

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

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

2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555
    @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 已提交
2556 2557 2558 2559 2560

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

N
Niels 已提交
2562
    @since version 1.0.0
N
Niels 已提交
2563
    */
N
Niels 已提交
2564 2565 2566
    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 已提交
2567
    basic_json(InputIT first, InputIT last)
N
Niels 已提交
2568
    {
N
Niels 已提交
2569 2570 2571
        assert(first.m_object != nullptr);
        assert(last.m_object != nullptr);

N
Niels 已提交
2572
        // make sure iterator fits the current value
N
Niels 已提交
2573
        if (first.m_object != last.m_object)
N
Niels 已提交
2574
        {
2575
            JSON_THROW(invalid_iterator::create(201, "iterators are not compatible"));
N
Niels 已提交
2576 2577
        }

N
Niels 已提交
2578 2579 2580
        // copy type from first iterator
        m_type = first.m_object->m_type;

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

2611 2612 2613 2614 2615
            case value_t::number_unsigned:
            {
                m_value.number_unsigned = first.m_object->m_value.number_unsigned;
                break;
            }
N
Niels 已提交
2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630

            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 已提交
2631
                m_value = *first.m_object->m_value.string;
N
Niels 已提交
2632 2633 2634 2635 2636
                break;
            }

            case value_t::object:
            {
N
Niels Lohmann 已提交
2637 2638
                m_value.object = create<object_t>(first.m_it.object_iterator,
                                                  last.m_it.object_iterator);
N
Niels 已提交
2639 2640 2641 2642 2643
                break;
            }

            case value_t::array:
            {
N
Niels Lohmann 已提交
2644 2645
                m_value.array = create<array_t>(first.m_it.array_iterator,
                                                last.m_it.array_iterator);
N
Niels 已提交
2646 2647 2648 2649 2650
                break;
            }

            default:
            {
2651 2652
                JSON_THROW(invalid_iterator::create(206, "cannot construct with iterators from " +
                                                    first.m_object->type_name()));
N
Niels 已提交
2653 2654
            }
        }
2655 2656

        assert_invariant();
N
Niels 已提交
2657 2658
    }

N
Niels 已提交
2659

N
Niels 已提交
2660 2661 2662 2663
    ///////////////////////////////////////
    // other constructors and destructor //
    ///////////////////////////////////////

N
Niels 已提交
2664 2665
    /*!
    @brief copy constructor
N
Niels 已提交
2666

N
Niels 已提交
2667 2668
    Creates a copy of a given JSON value.

N
Niels 已提交
2669
    @param[in] other  the JSON value to copy
N
Niels 已提交
2670 2671 2672

    @complexity Linear in the size of @a other.

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

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

N
Niels 已提交
2682
    @since version 1.0.0
N
Niels 已提交
2683
    */
N
Niels 已提交
2684
    basic_json(const basic_json& other)
N
Niels 已提交
2685 2686
        : m_type(other.m_type)
    {
2687 2688 2689
        // check of passed value is valid
        other.assert_invariant();

N
Niels 已提交
2690 2691
        switch (m_type)
        {
2692
            case value_t::object:
N
Niels 已提交
2693
            {
N
Niels 已提交
2694
                m_value = *other.m_value.object;
N
Niels 已提交
2695 2696
                break;
            }
N
Niels 已提交
2697

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

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

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

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

2722 2723 2724 2725 2726
            case value_t::number_unsigned:
            {
                m_value = other.m_value.number_unsigned;
                break;
            }
N
Niels 已提交
2727

2728
            case value_t::number_float:
N
Niels 已提交
2729
            {
N
Niels 已提交
2730
                m_value = other.m_value.number_float;
N
Niels 已提交
2731 2732
                break;
            }
2733 2734 2735 2736 2737

            default:
            {
                break;
            }
N
Niels 已提交
2738
        }
2739 2740

        assert_invariant();
N
Niels 已提交
2741 2742
    }

N
Niels 已提交
2743 2744 2745 2746 2747 2748 2749
    /*!
    @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 已提交
2750
    @param[in,out] other  value to move to this object
N
Niels 已提交
2751 2752 2753 2754 2755 2756 2757

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

N
Niels 已提交
2759
    @since version 1.0.0
N
Niels 已提交
2760
    */
N
Niels 已提交
2761
    basic_json(basic_json&& other) noexcept
N
Niels 已提交
2762 2763
        : m_type(std::move(other.m_type)),
          m_value(std::move(other.m_value))
N
Niels 已提交
2764
    {
2765 2766 2767
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2768
        // invalidate payload
N
Niels 已提交
2769 2770
        other.m_type = value_t::null;
        other.m_value = {};
2771 2772

        assert_invariant();
N
Niels 已提交
2773 2774
    }

N
Niels 已提交
2775 2776
    /*!
    @brief copy assignment
N
Niels 已提交
2777

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

N
Niels 已提交
2782
    @param[in] other  value to copy from
N
Niels 已提交
2783 2784 2785

    @complexity Linear.

N
Niels 已提交
2786 2787 2788
    @requirement This function helps `basic_json` satisfying the
    [Container](http://en.cppreference.com/w/cpp/concept/Container)
    requirements:
N
Niels 已提交
2789 2790
    - The complexity is linear.

N
Niels 已提交
2791 2792 2793 2794
    @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 已提交
2795

N
Niels 已提交
2796
    @since version 1.0.0
N
Niels 已提交
2797
    */
N
Niels 已提交
2798
    reference& operator=(basic_json other) noexcept (
N
Niels 已提交
2799 2800 2801 2802
        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 已提交
2803
    )
N
Niels 已提交
2804
    {
2805 2806 2807
        // check that passed value is valid
        other.assert_invariant();

N
Niels 已提交
2808
        using std::swap;
N
Cleanup  
Niels 已提交
2809 2810
        swap(m_type, other.m_type);
        swap(m_value, other.m_value);
2811 2812

        assert_invariant();
N
Niels 已提交
2813 2814 2815
        return *this;
    }

2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833
    /*!
    @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 已提交
2834

2835 2836 2837 2838 2839 2840 2841 2842 2843
        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 已提交
2844

2845 2846 2847 2848 2849 2850 2851
            case value_t::array:
            {
                AllocatorType<array_t> alloc;
                alloc.destroy(m_value.array);
                alloc.deallocate(m_value.array, 1);
                break;
            }
2852

2853 2854 2855 2856 2857 2858 2859
            case value_t::string:
            {
                AllocatorType<string_t> alloc;
                alloc.destroy(m_value.string);
                alloc.deallocate(m_value.string, 1);
                break;
            }
2860

2861 2862 2863 2864 2865 2866
            default:
            {
                // all other types need no specific destructor
                break;
            }
        }
N
Niels 已提交
2867 2868
    }

N
Niels 已提交
2869
    /// @}
N
Niels 已提交
2870 2871 2872 2873 2874 2875

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

N
Niels 已提交
2876
    /// @name object inspection
N
Niels 已提交
2877
    /// Functions to inspect the type of a JSON value.
N
Niels 已提交
2878 2879
    /// @{

N
Niels 已提交
2880
    /*!
N
Niels 已提交
2881 2882
    @brief serialization

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

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

N
Niels 已提交
2892 2893 2894 2895 2896
    @return string containing the serialization of the JSON value

    @complexity Linear.

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

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

N
Niels 已提交
2901
    @since version 1.0.0
N
Niels 已提交
2902
    */
N
Niels 已提交
2903
    string_t dump(const int indent = -1) const
N
Niels 已提交
2904
    {
N
Niels 已提交
2905
        std::stringstream ss;
2906
        serializer s(ss);
2907

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

        return ss.str();
N
Niels 已提交
2918 2919
    }

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

    @complexity Constant.

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

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

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

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

N
Niels 已提交
2957
    @liveexample{The following code exemplifies `is_primitive()` for all JSON
N
Niels 已提交
2958
    types.,is_primitive}
N
Niels 已提交
2959

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

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

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

N
Niels 已提交
3000 3001 3002 3003 3004
    /*!
    @brief return whether value is null

    This function returns true iff the JSON value is null.

N
Niels 已提交
3005
    @return `true` if type is null, `false` otherwise.
N
Niels 已提交
3006 3007 3008

    @complexity Constant.

N
Niels 已提交
3009 3010 3011
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3012
    @liveexample{The following code exemplifies `is_null()` for all JSON
N
Niels 已提交
3013
    types.,is_null}
N
Niels 已提交
3014

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

N
Niels 已提交
3022 3023 3024 3025 3026
    /*!
    @brief return whether value is a boolean

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

N
Niels 已提交
3027
    @return `true` if type is boolean, `false` otherwise.
N
Niels 已提交
3028 3029 3030

    @complexity Constant.

N
Niels 已提交
3031 3032 3033
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3034
    @liveexample{The following code exemplifies `is_boolean()` for all JSON
N
Niels 已提交
3035
    types.,is_boolean}
N
Niels 已提交
3036

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

N
Niels 已提交
3044 3045 3046 3047 3048 3049
    /*!
    @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.

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

    @complexity Constant.

N
Niels 已提交
3055 3056 3057
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3058
    @liveexample{The following code exemplifies `is_number()` for all JSON
N
Niels 已提交
3059
    types.,is_number}
N
Niels 已提交
3060

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

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

N
Niels 已提交
3074 3075 3076
    /*!
    @brief return whether value is an integer number

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

N
Niels 已提交
3080
    @return `true` if type is an integer or unsigned integer number, `false`
3081
    otherwise.
N
Niels 已提交
3082 3083 3084

    @complexity Constant.

N
Niels 已提交
3085 3086 3087
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

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

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

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

3103 3104 3105
    /*!
    @brief return whether value is an unsigned integer number

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

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

    @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_number_unsigned()` for all
N
Niels 已提交
3117 3118
    JSON types.,is_number_unsigned}

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

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

N
Niels 已提交
3131 3132 3133 3134
    /*!
    @brief return whether value is a floating-point number

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

N
Niels 已提交
3137
    @return `true` if type is a floating-point number, `false` otherwise.
N
Niels 已提交
3138 3139 3140

    @complexity Constant.

N
Niels 已提交
3141 3142 3143
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

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

    @sa @ref is_number() -- check if value is number
    @sa @ref is_number_integer() -- check if value is an integer number
N
Niels 已提交
3149 3150
    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
    number
N
Niels 已提交
3151

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

N
Niels 已提交
3159 3160 3161 3162 3163
    /*!
    @brief return whether value is an object

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

N
Niels 已提交
3164
    @return `true` if type is object, `false` otherwise.
N
Niels 已提交
3165 3166 3167

    @complexity Constant.

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

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

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

N
Niels 已提交
3181 3182 3183 3184 3185
    /*!
    @brief return whether value is an array

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

N
Niels 已提交
3186
    @return `true` if type is array, `false` otherwise.
N
Niels 已提交
3187 3188 3189

    @complexity Constant.

N
Niels 已提交
3190 3191 3192
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3193
    @liveexample{The following code exemplifies `is_array()` for all JSON
N
Niels 已提交
3194
    types.,is_array}
N
Niels 已提交
3195

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

N
Niels 已提交
3203 3204 3205 3206 3207
    /*!
    @brief return whether value is a string

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

N
Niels 已提交
3208
    @return `true` if type is string, `false` otherwise.
N
Niels 已提交
3209 3210 3211

    @complexity Constant.

N
Niels 已提交
3212 3213 3214
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3215
    @liveexample{The following code exemplifies `is_string()` for all JSON
N
Niels 已提交
3216
    types.,is_string}
N
Niels 已提交
3217

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

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

    @complexity Constant.

N
Niels 已提交
3239 3240 3241
    @exceptionsafety No-throw guarantee: this member function never throws
    exceptions.

N
Niels 已提交
3242
    @liveexample{The following code exemplifies `is_discarded()` for all JSON
N
Niels 已提交
3243
    types.,is_discarded}
N
Niels 已提交
3244

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

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

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

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

N
Niels 已提交
3275 3276
    /// @}

N
Niels 已提交
3277
  private:
N
Niels Lohmann 已提交
3278 3279 3280 3281
    //////////////////
    // value access //
    //////////////////

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

N
Niels 已提交
3377 3378 3379 3380 3381 3382 3383 3384
    /*!
    @brief helper function to implement get_ref()

    This funcion helps to implement get_ref() without code duplication for
    const and non-const overloads

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

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

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

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

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

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

T
Théo DELRIEU 已提交
3410 3411 3412
    /*!
    @brief get special-case overload

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

N
Niels Lohmann 已提交
3416
    @tparam BasicJsonType == @ref basic_json
T
Théo DELRIEU 已提交
3417 3418 3419 3420 3421 3422 3423

    @return a copy of *this

    @complexity Constant.

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

T
Théo DELRIEU 已提交
3434
    /*!
N
Niels Lohmann 已提交
3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448
    @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 已提交
3449 3450

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

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

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

N
Niels Lohmann 已提交
3462 3463 3464 3465 3466 3467 3468 3469
    @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 已提交
3470 3471 3472

    @since version 2.1.0
    */
T
Théo DELRIEU 已提交
3473
    template <
N
Niels Lohmann 已提交
3474 3475
        typename ValueTypeCV,
        typename ValueType = detail::uncvref_t<ValueTypeCV>,
3476
        detail::enable_if_t <
N
Niels Lohmann 已提交
3477 3478 3479
            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 已提交
3480
            int > = 0 >
N
Niels Lohmann 已提交
3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493
    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 已提交
3494
        return ret;
3495
    }
3496

T
Théo DELRIEU 已提交
3497
    /*!
N
Niels Lohmann 已提交
3498 3499 3500 3501 3502 3503 3504
    @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 已提交
3505

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

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

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

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

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

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

    @since version 2.1.0
    */
3528
    template <
N
Niels Lohmann 已提交
3529 3530 3531
        typename ValueTypeCV,
        typename ValueType = detail::uncvref_t<ValueTypeCV>,
        detail::enable_if_t<not std::is_same<basic_json_t, ValueType>::value and
3532
                            detail::has_non_default_from_json<basic_json_t,
N
Niels Lohmann 已提交
3533 3534 3535
                                    ValueType>::value, int> = 0 >
    ValueType get() const noexcept(noexcept(
                                       JSONSerializer<ValueTypeCV>::from_json(std::declval<const basic_json_t&>())))
3536
    {
N
Niels Lohmann 已提交
3537 3538 3539
        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);
3540 3541
    }

N
Niels 已提交
3542 3543 3544 3545 3546 3547
    /*!
    @brief get a pointer value (explicit)

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

N
Niels 已提交
3548 3549
    @warning The pointer becomes invalid if the underlying JSON object
    changes.
N
Niels 已提交
3550 3551

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

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

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

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

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

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

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

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

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

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

N
Niels 已提交
3666
    /*!
D
dariomt 已提交
3667 3668
    @brief get a reference value (implicit)

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

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

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

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

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

    @complexity Constant.
N
Niels 已提交
3687 3688 3689

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

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

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

    /*!
    @brief get a value (implicit)

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

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

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

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

    @complexity Linear in the size of the JSON value.

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

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

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

N
Niels 已提交
3757 3758 3759 3760 3761

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

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

N
Niels 已提交
3766 3767 3768 3769 3770 3771 3772 3773 3774 3775
    /*!
    @brief access specified array element with bounds checking

    Returns a reference to the element at specified location @a idx, with
    bounds checking.

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

    @return reference to the element at index @a idx

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

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

3784
    @complexity Constant.
N
Niels 已提交
3785

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

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

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

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

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

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

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

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

3831
    @complexity Constant.
N
Niels 已提交
3832

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

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

N
Niels 已提交
3860 3861 3862 3863 3864 3865 3866 3867 3868 3869
    /*!
    @brief access specified object element with bounds checking

    Returns a reference to the element at with specified key @a key, with
    bounds checking.

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

    @return reference to the element at key @a key

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

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

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

    @sa @ref operator[](const typename object_t::key_type&) for unchecked
    access by reference
    @sa @ref value() for access by value with a default value
N
Niels 已提交
3883

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

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

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

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

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

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

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

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

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

    @sa @ref operator[](const typename object_t::key_type&) for unchecked
    access by reference
    @sa @ref value() for access by value with a default value
N
Niels 已提交
3934

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

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

N
Niels 已提交
3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974
    /*!
    @brief access specified array element

    Returns a reference to the element at specified location @a idx.

    @note If @a idx is beyond the range of the array (i.e., `idx >= size()`),
    then the array is silently filled up with `null` values to make `idx` a
    valid reference to the last stored element.

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

    @return reference to the element at index @a idx

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

    @complexity Constant if @a idx is in the range of the array. Otherwise
    linear in `idx - size()`.

    @liveexample{The example below shows how array elements can be read and
N
Niels 已提交
3982
    written using `[]` operator. Note the addition of `null`
N
Niels 已提交
3983
    values.,operatorarray__size_type}
N
Niels 已提交
3984

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

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

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

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

N
Niels 已提交
4014 4015 4016 4017 4018 4019 4020 4021 4022
    /*!
    @brief access specified array element

    Returns a const reference to the element at specified location @a idx.

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

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

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

    @complexity Constant.

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

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

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

N
Niels 已提交
4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056
    /*!
    @brief access specified object element

    Returns a reference to the element at with specified key @a key.

    @note If @a key is not found in the object, then it is silently added to
    the object and filled with a `null` value to make `key` a valid reference.
    In case the value was `null` before, it is converted to an object.

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

    @return reference to the element at key @a key

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

    @complexity Logarithmic in the size of the container.

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

    @sa @ref at(const typename object_t::key_type&) for access by reference
    with range checking
    @sa @ref value() for access by value with a default value
N
Niels 已提交
4068

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

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

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

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

4093 4094 4095 4096 4097
    Returns a const reference to the element at with specified key @a key. No
    bounds checking is performed.

    @warning If the element with key @a key does not exist, the behavior is
    undefined.
N
Niels 已提交
4098 4099 4100

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

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

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

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

    @complexity Logarithmic in the size of the container.

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

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

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

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

N
Niels 已提交
4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144
    /*!
    @brief access specified object element

    Returns a reference to the element at with specified key @a key.

    @note If @a key is not found in the object, then it is silently added to
    the object and filled with a `null` value to make `key` a valid reference.
    In case the value was `null` before, it is converted to an object.

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

    @return reference to the element at key @a key

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

    @complexity Logarithmic in the size of the container.

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

    @sa @ref at(const typename object_t::key_type&) for access by reference
    with range checking
    @sa @ref value() for access by value with a default value
N
Niels 已提交
4156

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

    /*!
    @brief read-only access specified object element

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

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

    @note This function is required for compatibility reasons with Clang.

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

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

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

    @complexity Logarithmic in the size of the container.

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

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

    @since version 1.0.0
    */
    template<typename T, std::size_t n>
N
Niels 已提交
4195
    const_reference operator[](T * (&key)[n]) const
4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212
    {
        return operator[](static_cast<const T>(key));
    }

    /*!
    @brief access specified object element

    Returns a reference to the element at with specified key @a key.

    @note If @a key is not found in the object, then it is silently added to
    the object and filled with a `null` value to make `key` a valid reference.
    In case the value was `null` before, it is converted to an object.

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

    @return reference to the element at key @a key

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

    @complexity Logarithmic in the size of the container.

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

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

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

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

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

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

4250 4251 4252 4253 4254
    Returns a const reference to the element at with specified key @a key. No
    bounds checking is performed.

    @warning If the element with key @a key does not exist, the behavior is
    undefined.
N
Niels 已提交
4255 4256 4257

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

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

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

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

    @complexity Logarithmic in the size of the container.

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

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

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

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

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

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

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

    @note Unlike @ref at(const typename object_t::key_type&), this function
    does not throw if the given key @a key was not found.

    @note Unlike @ref operator[](const typename object_t::key_type& key), this
    function does not implicitly add an element to the position defined by @a
    key. This function is furthermore also applicable to const objects.

    @param[in] key  key of the element to access
    @param[in] default_value  the value to return if @a key is not found

    @tparam ValueType type compatible to JSON values, for instance `int` for
    JSON integer numbers, `bool` for JSON booleans, or `std::vector` types for
    JSON arrays. Note the type of the expected value at @a key and the default
    value @a default_value must be compatible.

    @return copy of the element at key @a key or @a default_value if @a key
    is not found

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

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be queried
    with a default value.,basic_json__value}

    @sa @ref at(const typename object_t::key_type&) for access by reference
    with range checking
    @sa @ref operator[](const typename object_t::key_type&) for unchecked
    access by reference
N
Niels 已提交
4335

N
Niels 已提交
4336
    @since version 1.0.0
N
Niels 已提交
4337
    */
N
Niels 已提交
4338 4339
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350
    ValueType value(const typename object_t::key_type& key, ValueType default_value) const
    {
        // at only works for objects
        if (is_object())
        {
            // if key is found, return value and given default value otherwise
            const auto it = find(key);
            if (it != end())
            {
                return *it;
            }
N
Niels Lohmann 已提交
4351 4352

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

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

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

N
Niels 已提交
4372 4373 4374 4375 4376 4377 4378
    Returns either a copy of an object's element at the specified key @a key
    or a given default value if no element with key @a key exists.

    The function is basically equivalent to executing
    @code {.cpp}
    try {
        return at(ptr);
4379
    } catch(out_of_range) {
N
Niels 已提交
4380 4381 4382 4383 4384 4385 4386
        return default_value;
    }
    @endcode

    @note Unlike @ref at(const json_pointer&), this function does not throw
    if the given key @a key was not found.

N
Niels 已提交
4387 4388 4389 4390 4391 4392 4393 4394
    @param[in] ptr  a JSON pointer to the element to access
    @param[in] default_value  the value to return if @a ptr found no value

    @tparam ValueType type compatible to JSON values, for instance `int` for
    JSON integer numbers, `bool` for JSON booleans, or `std::vector` types for
    JSON arrays. Note the type of the expected value at @a key and the default
    value @a default_value must be compatible.

N
Niels 已提交
4395 4396 4397
    @return copy of the element at key @a key or @a default_value if @a key
    is not found

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

    @complexity Logarithmic in the size of the container.

    @liveexample{The example below shows how object elements can be queried
    with a default value.,basic_json__value_ptr}

N
Niels 已提交
4406
    @sa @ref operator[](const json_pointer&) for unchecked access by reference
N
Niels 已提交
4407

N
Niels 已提交
4408 4409
    @since version 2.0.2
    */
N
Niels 已提交
4410 4411
    template<class ValueType, typename std::enable_if<
                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
N
Niels 已提交
4412 4413 4414 4415 4416 4417
    ValueType value(const json_pointer& ptr, ValueType default_value) const
    {
        // at only works for objects
        if (is_object())
        {
            // if pointer resolves a value, return it or use default value
4418
            JSON_TRY
N
Niels 已提交
4419 4420 4421
            {
                return ptr.get_checked(this);
            }
4422
            JSON_CATCH (out_of_range&)
N
Niels 已提交
4423 4424 4425 4426
            {
                return default_value;
            }
        }
N
Niels Lohmann 已提交
4427

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

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

N
Niels 已提交
4440 4441 4442 4443 4444 4445
    /*!
    @brief access the first element

    Returns a reference to the first element in the container. For a JSON
    container `c`, the expression `c.front()` is equivalent to `*c.begin()`.

N
Niels 已提交
4446
    @return In case of a structured type (array or object), a reference to the
4447
    first element is returned. In case of number, string, or boolean values, a
N
Niels 已提交
4448 4449 4450 4451
    reference to the value is returned.

    @complexity Constant.

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

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

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

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

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

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

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

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

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

    @complexity Constant.

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

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

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

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

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

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

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

N
Niels 已提交
4529 4530 4531
    Removes the element specified by iterator @a pos. The iterator @a pos must
    be valid and dereferenceable. Thus the `end()` iterator (which is valid,
    but is not dereferenceable) cannot be used as a value for @a pos.
N
Niels 已提交
4532

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

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

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

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

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

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

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

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

N
Niels 已提交
4570
    @since version 1.0.0
N
Niels 已提交
4571
    */
N
Niels 已提交
4572 4573 4574 4575
    template<class IteratorType, typename std::enable_if<
                 std::is_same<IteratorType, typename basic_json_t::iterator>::value or
                 std::is_same<IteratorType, typename basic_json_t::const_iterator>::value, int>::type
             = 0>
4576
    IteratorType erase(IteratorType pos)
4577 4578
    {
        // make sure iterator fits the current value
N
Niels 已提交
4579
        if (this != pos.m_object)
4580
        {
4581
            JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value"));
4582 4583
        }

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

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

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

                m_type = value_t::null;
4608
                assert_invariant();
4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625
                break;
            }

            case value_t::object:
            {
                result.m_it.object_iterator = m_value.object->erase(pos.m_it.object_iterator);
                break;
            }

            case value_t::array:
            {
                result.m_it.array_iterator = m_value.array->erase(pos.m_it.array_iterator);
                break;
            }

            default:
            {
4626
                JSON_THROW(type_error::create(307, "cannot use erase() with " + type_name()));
4627 4628 4629 4630 4631 4632
            }
        }

        return result;
    }

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

N
Niels 已提交
4636 4637 4638
    Removes the element specified by the range `[first; last)`. The iterator
    @a first does not need to be dereferenceable if `first == last`: erasing
    an empty range is a no-op.
N
Niels 已提交
4639

N
Niels 已提交
4640
    If called on a primitive type other than `null`, the resulting JSON value
N
Niels 已提交
4641 4642 4643 4644 4645
    will be `null`.

    @param[in] first iterator to the beginning of the range to remove
    @param[in] last iterator past the end of the range to remove
    @return Iterator following the last removed element. If the iterator @a
N
Niels 已提交
4646
    second refers to the last element, the `end()` iterator is returned.
N
Niels 已提交
4647

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

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

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

    @complexity The complexity depends on the type:
    - objects: `log(size()) + std::distance(first, last)`
    - arrays: linear in the distance between @a first and @a last, plus linear
      in the distance between @a last and end of the container
    - strings: linear in the length of the string
    - other types: constant

N
Niels 已提交
4668
    @liveexample{The example shows the result of `erase()` for different JSON
N
Niels 已提交
4669
    types.,erase__IteratorType_IteratorType}
N
Niels 已提交
4670

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

N
Niels 已提交
4677
    @since version 1.0.0
N
Niels 已提交
4678
    */
N
Niels 已提交
4679 4680 4681 4682
    template<class IteratorType, typename std::enable_if<
                 std::is_same<IteratorType, typename basic_json_t::iterator>::value or
                 std::is_same<IteratorType, typename basic_json_t::const_iterator>::value, int>::type
             = 0>
4683
    IteratorType erase(IteratorType first, IteratorType last)
4684 4685
    {
        // make sure iterator fits the current value
N
Niels 已提交
4686
        if (this != first.m_object or this != last.m_object)
4687
        {
4688
            JSON_THROW(invalid_iterator::create(203, "iterators do not fit current value"));
4689 4690
        }

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

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

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

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

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

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

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

        return result;
    }

N
Niels 已提交
4742 4743 4744 4745 4746 4747 4748
    /*!
    @brief remove element from a JSON object given a key

    Removes elements from a JSON object with the key value @a key.

    @param[in] key value of the elements to remove

N
Niels 已提交
4749
    @return Number of elements removed. If @a ObjectType is the default
N
Niels 已提交
4750 4751
    `std::map` type, the return value will always be `0` (@a key was not
    found) or `1` (@a key was found).
N
Niels 已提交
4752 4753 4754

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

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

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

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

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

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

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

N
Niels 已提交
4782 4783 4784 4785 4786 4787 4788
    /*!
    @brief remove element from a JSON array given an index

    Removes element from a JSON array at the index @a idx.

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

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

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

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

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

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

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

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


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

    /// @name lookup
    /// @{

N
Niels 已提交
4834 4835 4836 4837
    /*!
    @brief find an element in a JSON object

    Finds an element in a JSON object with key equivalent to @a key. If the
N
Niels 已提交
4838 4839
    element is not found or the JSON value is not an object, end() is
    returned.
N
Niels 已提交
4840

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

N
Niels 已提交
4844 4845 4846
    @param[in] key key value of the element to search for

    @return Iterator to an element with key equivalent to @a key. If no such
4847 4848
    element is found or the JSON value is not an object, past-the-end (see
    @ref end()) iterator is returned.
N
Niels 已提交
4849 4850 4851

    @complexity Logarithmic in the size of the JSON object.

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

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

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

        return result;
    }

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

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

        return result;
    }

N
Niels 已提交
4884 4885 4886 4887 4888 4889 4890
    /*!
    @brief returns the number of occurrences of a key in a JSON object

    Returns the number of elements with key @a key. If ObjectType is the
    default `std::map` type, the return value will always be `0` (@a key was
    not found) or `1` (@a key was found).

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

N
Niels 已提交
4894 4895 4896 4897 4898 4899 4900
    @param[in] key key value of the element to count

    @return Number of elements with key @a key. If the JSON value is not an
    object, the return value will be `0`.

    @complexity Logarithmic in the size of the JSON object.

N
Niels 已提交
4901
    @liveexample{The example shows how `count()` is used.,count}
N
Niels 已提交
4902

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

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

N
Niels 已提交
4913

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

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

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

    Returns an iterator to the first element.

    @image html range-begin-end.svg "Illustration from cppreference.com"

    @return iterator to the first element

    @complexity Constant.

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

N
Niels 已提交
4937 4938 4939 4940 4941
    @liveexample{The following code shows an example for `begin()`.,begin}

    @sa @ref cbegin() -- returns a const iterator to the beginning
    @sa @ref end() -- returns an iterator to the end
    @sa @ref cend() -- returns a const iterator to the end
N
Niels 已提交
4942

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

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

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

    Returns a const iterator to the first element.

    @image html range-begin-end.svg "Illustration from cppreference.com"

    @return const iterator to the first element

    @complexity Constant.

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

N
Niels 已提交
4977 4978 4979 4980 4981
    @liveexample{The following code shows an example for `cbegin()`.,cbegin}

    @sa @ref begin() -- returns an iterator to the beginning
    @sa @ref end() -- returns an iterator to the end
    @sa @ref cend() -- returns a const iterator to the end
N
Niels 已提交
4982

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

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

    Returns an iterator to one past the last element.

    @image html range-begin-end.svg "Illustration from cppreference.com"

    @return iterator one past the last element

    @complexity Constant.

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

N
Niels 已提交
5008 5009 5010 5011 5012
    @liveexample{The following code shows an example for `end()`.,end}

    @sa @ref cend() -- returns a const iterator to the end
    @sa @ref begin() -- returns an iterator to the beginning
    @sa @ref cbegin() -- returns a const iterator to the beginning
N
Niels 已提交
5013

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

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

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

    Returns a const iterator to one past the last element.

    @image html range-begin-end.svg "Illustration from cppreference.com"

    @return const iterator one past the last element

    @complexity Constant.

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

N
Niels 已提交
5048 5049 5050 5051 5052
    @liveexample{The following code shows an example for `cend()`.,cend}

    @sa @ref end() -- returns an iterator to the end
    @sa @ref begin() -- returns an iterator to the beginning
    @sa @ref cbegin() -- returns a const iterator to the beginning
N
Niels 已提交
5053

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

N
Niels 已提交
5063
    /*!
N
Niels 已提交
5064 5065 5066 5067 5068 5069 5070 5071
    @brief returns an iterator to the reverse-beginning

    Returns an iterator to the reverse-beginning; that is, the last element.

    @image html range-rbegin-rend.svg "Illustration from cppreference.com"

    @complexity Constant.

N
Niels 已提交
5072 5073 5074
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
5075 5076 5077
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(end())`.

N
Niels 已提交
5078 5079 5080 5081 5082
    @liveexample{The following code shows an example for `rbegin()`.,rbegin}

    @sa @ref crbegin() -- returns a const reverse iterator to the beginning
    @sa @ref rend() -- returns a reverse iterator to the end
    @sa @ref crend() -- returns a const reverse iterator to the end
N
Niels 已提交
5083

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

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

N
Niels 已提交
5099
    /*!
N
Niels 已提交
5100 5101 5102 5103 5104 5105 5106 5107 5108
    @brief returns an iterator to the reverse-end

    Returns an iterator to the reverse-end; that is, one before the first
    element.

    @image html range-rbegin-rend.svg "Illustration from cppreference.com"

    @complexity Constant.

N
Niels 已提交
5109 5110 5111
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
5112 5113 5114
    - The complexity is constant.
    - Has the semantics of `reverse_iterator(begin())`.

N
Niels 已提交
5115 5116 5117 5118 5119
    @liveexample{The following code shows an example for `rend()`.,rend}

    @sa @ref crend() -- returns a const reverse iterator to the end
    @sa @ref rbegin() -- returns a reverse iterator to the beginning
    @sa @ref crbegin() -- returns a const reverse iterator to the beginning
N
Niels 已提交
5120

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

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

N
Niels 已提交
5136
    /*!
N
Niels 已提交
5137 5138 5139 5140 5141 5142 5143 5144 5145
    @brief returns a const reverse iterator to the last element

    Returns a const iterator to the reverse-beginning; that is, the last
    element.

    @image html range-rbegin-rend.svg "Illustration from cppreference.com"

    @complexity Constant.

N
Niels 已提交
5146 5147 5148
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
5149 5150 5151
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).rbegin()`.

N
Niels 已提交
5152 5153 5154 5155 5156
    @liveexample{The following code shows an example for `crbegin()`.,crbegin}

    @sa @ref rbegin() -- returns a reverse iterator to the beginning
    @sa @ref rend() -- returns a reverse iterator to the end
    @sa @ref crend() -- returns a const reverse iterator to the end
N
Niels 已提交
5157

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

N
Niels 已提交
5165
    /*!
N
Niels 已提交
5166 5167 5168 5169 5170 5171 5172 5173 5174
    @brief returns a const reverse iterator to one before the first

    Returns a const reverse iterator to the reverse-end; that is, one before
    the first element.

    @image html range-rbegin-rend.svg "Illustration from cppreference.com"

    @complexity Constant.

N
Niels 已提交
5175 5176 5177
    @requirement This function helps `basic_json` satisfying the
    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
    requirements:
N
Niels 已提交
5178 5179 5180
    - The complexity is constant.
    - Has the semantics of `const_cast<const basic_json&>(*this).rend()`.

N
Niels 已提交
5181 5182 5183 5184 5185
    @liveexample{The following code shows an example for `crend()`.,crend}

    @sa @ref rend() -- returns a reverse iterator to the end
    @sa @ref rbegin() -- returns a reverse iterator to the beginning
    @sa @ref crbegin() -- returns a const reverse iterator to the beginning
N
Niels 已提交
5186

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

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

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

N
Niels 已提交
5202
    This function allows to access @ref iterator::key() and @ref
N
Niels 已提交
5203 5204 5205
    iterator::value() during range-based for loops. In these loops, a
    reference to the JSON values is returned, so there is no access to the
    underlying iterator.
N
cleanup  
Niels 已提交
5206 5207 5208

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

N
Niels 已提交
5225 5226 5227 5228 5229

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

N
Niels 已提交
5230 5231 5232
    /// @name capacity
    /// @{

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

    Checks if a JSON value has no elements.

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

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

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

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

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

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

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

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

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

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

    Returns the number of elements in a JSON value.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

N
Niels 已提交
5428 5429
    /// @}

N
Niels 已提交
5430 5431 5432 5433 5434

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

N
Niels 已提交
5435 5436 5437
    /// @name modifiers
    /// @{

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

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

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

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

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

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

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

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

            default:
            {
                break;
            }
N
Niels 已提交
5510 5511 5512
        }
    }

5513 5514 5515
    /*!
    @brief add an object to an array

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

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

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

    @complexity Amortized constant.

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

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

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

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

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

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

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

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

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

5599 5600 5601
    /*!
    @brief add an object to an object

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

5606
    @param[in] val the value to add to the JSON object
5607

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

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

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

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

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

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

5639 5640 5641 5642
    /*!
    @brief add an object to an object
    @copydoc push_back(const typename object_t::value_type&)
    */
5643
    reference operator+=(const typename object_t::value_type& val)
N
Niels 已提交
5644
    {
5645
        push_back(val);
N
Niels 已提交
5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661
        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 已提交
5662
    @param[in] init  an initializer list
N
Niels 已提交
5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694

    @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 已提交
5695 5696
    }

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

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

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

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

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

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

5750 5751 5752 5753
    @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.

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

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

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

N
Niels 已提交
5793 5794 5795
    /*!
    @brief inserts element

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

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

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

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

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

N
Niels 已提交
5813
    @since version 1.0.0
N
Niels 已提交
5814
    */
5815
    iterator insert(const_iterator pos, const basic_json& val)
N
Niels 已提交
5816 5817
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5818
        if (is_array())
N
Niels 已提交
5819
        {
N
cleanup  
Niels 已提交
5820 5821 5822
            // check if iterator pos fits to this JSON value
            if (pos.m_object != this)
            {
5823
                JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value"));
N
cleanup  
Niels 已提交
5824
            }
N
Niels 已提交
5825

N
cleanup  
Niels 已提交
5826 5827
            // insert to array and return iterator
            iterator result(this);
5828
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, val);
N
cleanup  
Niels 已提交
5829 5830
            return result;
        }
N
Niels Lohmann 已提交
5831

5832
        JSON_THROW(type_error::create(309, "cannot use insert() with " + type_name()));
N
Niels 已提交
5833 5834 5835 5836 5837 5838
    }

    /*!
    @brief inserts element
    @copydoc insert(const_iterator, const basic_json&)
    */
5839
    iterator insert(const_iterator pos, basic_json&& val)
N
Niels 已提交
5840
    {
5841
        return insert(pos, val);
N
Niels 已提交
5842 5843 5844 5845 5846
    }

    /*!
    @brief inserts elements

5847
    Inserts @a cnt copies of @a val before iterator @a pos.
N
Niels 已提交
5848 5849 5850

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

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

5861
    @complexity Linear in @a cnt plus linear in the distance between @a pos
N
Niels 已提交
5862 5863
    and end of the container.

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

N
Niels 已提交
5866
    @since version 1.0.0
N
Niels 已提交
5867
    */
5868
    iterator insert(const_iterator pos, size_type cnt, const basic_json& val)
N
Niels 已提交
5869 5870
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5871
        if (is_array())
N
Niels 已提交
5872
        {
N
cleanup  
Niels 已提交
5873 5874 5875
            // check if iterator pos fits to this JSON value
            if (pos.m_object != this)
            {
5876
                JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value"));
N
cleanup  
Niels 已提交
5877
            }
N
Niels 已提交
5878

N
cleanup  
Niels 已提交
5879 5880
            // insert to array and return iterator
            iterator result(this);
5881
            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, cnt, val);
N
cleanup  
Niels 已提交
5882 5883
            return result;
        }
N
Niels Lohmann 已提交
5884

5885
        JSON_THROW(type_error::create(309, "cannot use insert() with " + type_name()));
N
Niels 已提交
5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897
    }

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

5898 5899
    @throw type_error.309 if called on JSON values other than arrays; example:
    `"cannot use insert() with string"`
5900 5901
    @throw invalid_iterator.202 if @a pos is not an iterator of *this;
    example: `"iterator does not fit current value"`
5902 5903 5904
    @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 已提交
5905 5906 5907
    container for which insert is called; example: `"passed iterators may not
    belong to container"`

N
Niels 已提交
5908 5909 5910 5911 5912 5913
    @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 已提交
5914
    @liveexample{The example shows how `insert()` is used.,insert__range}
N
Niels 已提交
5915

N
Niels 已提交
5916
    @since version 1.0.0
N
Niels 已提交
5917 5918 5919 5920
    */
    iterator insert(const_iterator pos, const_iterator first, const_iterator last)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5921
        if (not is_array())
N
Niels 已提交
5922
        {
5923
            JSON_THROW(type_error::create(309, "cannot use insert() with " + type_name()));
N
Niels 已提交
5924 5925 5926 5927 5928
        }

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

N
Niels 已提交
5932
        // check if range iterators belong to the same JSON object
N
Niels 已提交
5933 5934
        if (first.m_object != last.m_object)
        {
5935
            JSON_THROW(invalid_iterator::create(210, "iterators do not fit"));
N
Niels 已提交
5936 5937 5938 5939
        }

        if (first.m_object == this or last.m_object == this)
        {
5940
            JSON_THROW(invalid_iterator::create(211, "passed iterators may not belong to container"));
N
Niels 已提交
5941 5942 5943 5944
        }

        // insert to array and return iterator
        iterator result(this);
N
Niels 已提交
5945
        result.m_it.array_iterator = m_value.array->insert(
T
Théo DELRIEU 已提交
5946 5947 5948
                                         pos.m_it.array_iterator,
                                         first.m_it.array_iterator,
                                         last.m_it.array_iterator);
N
Niels 已提交
5949 5950 5951
        return result;
    }

N
Niels 已提交
5952 5953 5954 5955 5956 5957 5958 5959 5960
    /*!
    @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

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

N
Niels 已提交
5966 5967 5968
    @return iterator pointing to the first element inserted, or @a pos if
    `ilist` is empty

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

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

N
Niels 已提交
5974
    @since version 1.0.0
N
Niels 已提交
5975 5976 5977 5978
    */
    iterator insert(const_iterator pos, std::initializer_list<basic_json> ilist)
    {
        // insert only works for arrays
N
cleanup  
Niels 已提交
5979
        if (not is_array())
N
Niels 已提交
5980
        {
5981
            JSON_THROW(type_error::create(309, "cannot use insert() with " + type_name()));
N
Niels 已提交
5982 5983 5984 5985 5986
        }

        // check if iterator pos fits to this JSON value
        if (pos.m_object != this)
        {
5987
            JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value"));
N
Niels 已提交
5988 5989 5990 5991 5992 5993 5994 5995
        }

        // 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 已提交
5996 5997
    /*!
    @brief exchanges the values
N
Niels 已提交
5998 5999 6000 6001 6002 6003 6004 6005 6006 6007

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

N
Niels 已提交
6011
    @since version 1.0.0
N
Niels 已提交
6012
    */
N
Niels 已提交
6013
    void swap(reference other) noexcept (
N
Niels 已提交
6014 6015 6016 6017
        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 已提交
6018
    )
N
Niels 已提交
6019 6020 6021
    {
        std::swap(m_type, other.m_type);
        std::swap(m_value, other.m_value);
6022
        assert_invariant();
N
Niels 已提交
6023 6024
    }

N
Niels 已提交
6025 6026 6027 6028 6029 6030 6031 6032 6033 6034
    /*!
    @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

6035 6036
    @throw type_error.310 when JSON value is not an array; example: `"cannot
    use swap() with string"`
N
Niels 已提交
6037 6038 6039

    @complexity Constant.

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

N
Niels 已提交
6043
    @since version 1.0.0
N
Niels 已提交
6044
    */
N
Niels 已提交
6045
    void swap(array_t& other)
N
Niels 已提交
6046 6047
    {
        // swap only works for arrays
N
cleanup  
Niels 已提交
6048 6049 6050 6051 6052
        if (is_array())
        {
            std::swap(*(m_value.array), other);
        }
        else
N
Niels 已提交
6053
        {
6054
            JSON_THROW(type_error::create(310, "cannot use swap() with " + type_name()));
N
Niels 已提交
6055 6056 6057
        }
    }

6058 6059 6060 6061 6062 6063 6064 6065 6066 6067
    /*!
    @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

6068
    @throw type_error.310 when JSON value is not an object; example:
N
Niels 已提交
6069
    `"cannot use swap() with string"`
6070 6071 6072

    @complexity Constant.

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

N
Niels 已提交
6076
    @since version 1.0.0
6077
    */
N
Niels 已提交
6078
    void swap(object_t& other)
N
Niels 已提交
6079 6080
    {
        // swap only works for objects
N
cleanup  
Niels 已提交
6081 6082 6083 6084 6085
        if (is_object())
        {
            std::swap(*(m_value.object), other);
        }
        else
N
Niels 已提交
6086
        {
6087
            JSON_THROW(type_error::create(310, "cannot use swap() with " + type_name()));
N
Niels 已提交
6088 6089 6090
        }
    }

6091 6092 6093 6094 6095 6096 6097 6098 6099 6100
    /*!
    @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

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

    @complexity Constant.

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

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

N
Niels 已提交
6124 6125
    /// @}

N
Niels 已提交
6126
  public:
6127 6128 6129 6130 6131 6132 6133
    //////////////////////////////////////////
    // lexicographical comparison operators //
    //////////////////////////////////////////

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

N
Niels 已提交
6134 6135
    /*!
    @brief comparison: equal
N
Niels 已提交
6136 6137 6138

    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 已提交
6139 6140
      their stored values are the same according to their respective
      `operator==`.
N
Niels 已提交
6141 6142 6143
    - Integer and floating-point numbers are automatically converted before
      comparison. Floating-point numbers are compared indirectly: two
      floating-point numbers `f1` and `f2` are considered equal if neither
N
Niels Lohmann 已提交
6144 6145
      `f1 > f2` nor `f2 > f1` holds. Note than two NaN values are always
      treated as unequal.
N
Niels 已提交
6146 6147
    - Two JSON null values are equal.

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

N
Niels 已提交
6150 6151 6152 6153 6154 6155
    @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.

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

N
Niels 已提交
6159
    @since version 1.0.0
N
Niels 已提交
6160
    */
N
Niels 已提交
6161
    friend bool operator==(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6162
    {
F
Florian Weber 已提交
6163 6164
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
6165

F
Florian Weber 已提交
6166
        if (lhs_type == rhs_type)
N
Niels 已提交
6167
        {
F
Florian Weber 已提交
6168
            switch (lhs_type)
N
Niels 已提交
6169
            {
6170
                case value_t::array:
N
Niels 已提交
6171
                {
N
Niels 已提交
6172
                    return *lhs.m_value.array == *rhs.m_value.array;
N
Niels 已提交
6173
                }
6174
                case value_t::object:
N
Niels 已提交
6175
                {
N
Niels 已提交
6176
                    return *lhs.m_value.object == *rhs.m_value.object;
N
Niels 已提交
6177
                }
6178
                case value_t::null:
N
Niels 已提交
6179
                {
N
Niels 已提交
6180
                    return true;
N
Niels 已提交
6181
                }
6182
                case value_t::string:
N
Niels 已提交
6183
                {
N
Niels 已提交
6184
                    return *lhs.m_value.string == *rhs.m_value.string;
N
Niels 已提交
6185
                }
6186
                case value_t::boolean:
N
Niels 已提交
6187
                {
N
Niels 已提交
6188
                    return lhs.m_value.boolean == rhs.m_value.boolean;
N
Niels 已提交
6189
                }
6190
                case value_t::number_integer:
N
Niels 已提交
6191
                {
N
Niels 已提交
6192
                    return lhs.m_value.number_integer == rhs.m_value.number_integer;
N
Niels 已提交
6193
                }
6194 6195 6196 6197
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned == rhs.m_value.number_unsigned;
                }
6198
                case value_t::number_float:
N
Niels 已提交
6199
                {
6200
                    return lhs.m_value.number_float == rhs.m_value.number_float;
N
Niels 已提交
6201
                }
6202
                default:
N
Niels 已提交
6203
                {
N
Niels 已提交
6204
                    return false;
N
Niels 已提交
6205
                }
N
Niels 已提交
6206 6207
            }
        }
F
Florian Weber 已提交
6208 6209
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
N
Niels 已提交
6210
            return static_cast<number_float_t>(lhs.m_value.number_integer) == rhs.m_value.number_float;
F
Florian Weber 已提交
6211 6212 6213
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
6214
            return lhs.m_value.number_float == static_cast<number_float_t>(rhs.m_value.number_integer);
F
Florian Weber 已提交
6215
        }
6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230
        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 已提交
6231
        }
6232

N
Niels 已提交
6233 6234 6235
        return false;
    }

N
Niels 已提交
6236 6237
    /*!
    @brief comparison: equal
M
Mihai STAN 已提交
6238
    @copydoc operator==(const_reference, const_reference)
N
Niels 已提交
6239
    */
M
Mihai STAN 已提交
6240
    template<typename ScalarType, typename std::enable_if<
6241 6242
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator==(const_reference lhs, const ScalarType rhs) noexcept
N
Niels 已提交
6243
    {
M
Mihai STAN 已提交
6244
        return (lhs == basic_json(rhs));
N
Niels 已提交
6245 6246 6247 6248
    }

    /*!
    @brief comparison: equal
M
Mihai STAN 已提交
6249
    @copydoc operator==(const_reference, const_reference)
N
Niels 已提交
6250
    */
M
Mihai STAN 已提交
6251
    template<typename ScalarType, typename std::enable_if<
6252 6253
                 std::is_scalar<ScalarType>::value, int>::type = 0>
    friend bool operator==(const ScalarType lhs, const_reference rhs) noexcept
N
Niels 已提交
6254
    {
M
Mihai STAN 已提交
6255
        return (basic_json(lhs) == rhs);
N
Niels 已提交
6256 6257
    }

N
Niels 已提交
6258 6259
    /*!
    @brief comparison: not equal
N
Niels 已提交
6260 6261 6262 6263 6264 6265 6266 6267 6268

    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.

6269 6270
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__notequal}
N
Niels 已提交
6271

N
Niels 已提交
6272
    @since version 1.0.0
N
Niels 已提交
6273
    */
N
Niels 已提交
6274
    friend bool operator!=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6275 6276 6277 6278
    {
        return not (lhs == rhs);
    }

N
Niels 已提交
6279 6280
    /*!
    @brief comparison: not equal
M
Mihai STAN 已提交
6281
    @copydoc operator!=(const_reference, const_reference)
N
Niels 已提交
6282
    */
M
Mihai STAN 已提交
6283 6284 6285
    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 已提交
6286
    {
M
Mihai STAN 已提交
6287
        return (lhs != basic_json(rhs));
N
Niels 已提交
6288 6289 6290 6291
    }

    /*!
    @brief comparison: not equal
M
Mihai STAN 已提交
6292
    @copydoc operator!=(const_reference, const_reference)
N
Niels 已提交
6293
    */
M
Mihai STAN 已提交
6294 6295 6296
    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 已提交
6297
    {
M
Mihai STAN 已提交
6298
        return (basic_json(lhs) != rhs);
N
Niels 已提交
6299 6300
    }

N
Niels 已提交
6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319
    /*!
    @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.

6320 6321
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__less}
N
Niels 已提交
6322

N
Niels 已提交
6323
    @since version 1.0.0
N
Niels 已提交
6324
    */
N
Niels 已提交
6325
    friend bool operator<(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6326
    {
F
Florian Weber 已提交
6327 6328
        const auto lhs_type = lhs.type();
        const auto rhs_type = rhs.type();
N
Niels 已提交
6329

F
Florian Weber 已提交
6330
        if (lhs_type == rhs_type)
N
Niels 已提交
6331
        {
F
Florian Weber 已提交
6332
            switch (lhs_type)
N
Niels 已提交
6333
            {
6334
                case value_t::array:
N
Niels 已提交
6335
                {
N
Niels 已提交
6336
                    return *lhs.m_value.array < *rhs.m_value.array;
N
Niels 已提交
6337
                }
6338
                case value_t::object:
N
Niels 已提交
6339
                {
N
Niels 已提交
6340
                    return *lhs.m_value.object < *rhs.m_value.object;
N
Niels 已提交
6341
                }
6342
                case value_t::null:
N
Niels 已提交
6343
                {
N
Niels 已提交
6344
                    return false;
N
Niels 已提交
6345
                }
6346
                case value_t::string:
N
Niels 已提交
6347
                {
N
Niels 已提交
6348
                    return *lhs.m_value.string < *rhs.m_value.string;
N
Niels 已提交
6349
                }
6350
                case value_t::boolean:
N
Niels 已提交
6351
                {
N
Niels 已提交
6352
                    return lhs.m_value.boolean < rhs.m_value.boolean;
N
Niels 已提交
6353
                }
6354
                case value_t::number_integer:
N
Niels 已提交
6355
                {
N
Niels 已提交
6356
                    return lhs.m_value.number_integer < rhs.m_value.number_integer;
N
Niels 已提交
6357
                }
6358 6359 6360 6361
                case value_t::number_unsigned:
                {
                    return lhs.m_value.number_unsigned < rhs.m_value.number_unsigned;
                }
6362
                case value_t::number_float:
N
Niels 已提交
6363
                {
N
Niels 已提交
6364
                    return lhs.m_value.number_float < rhs.m_value.number_float;
N
Niels 已提交
6365
                }
6366
                default:
N
Niels 已提交
6367
                {
N
Niels 已提交
6368
                    return false;
N
Niels 已提交
6369
                }
N
Niels 已提交
6370 6371
            }
        }
F
Florian Weber 已提交
6372 6373
        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
        {
6374
            return static_cast<number_float_t>(lhs.m_value.number_integer) < rhs.m_value.number_float;
F
Florian Weber 已提交
6375 6376 6377
        }
        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
        {
6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394
            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 已提交
6395
        }
N
Niels 已提交
6396

N
Niels 已提交
6397
        // We only reach this line if we cannot compare values. In that case,
N
Niels 已提交
6398 6399 6400
        // we compare types. Note we have to call the operator explicitly,
        // because MSVC has problems otherwise.
        return operator<(lhs_type, rhs_type);
N
Niels 已提交
6401 6402
    }

N
Niels 已提交
6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414
    /*!
    @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.

6415 6416
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greater}
N
Niels 已提交
6417

N
Niels 已提交
6418
    @since version 1.0.0
N
Niels 已提交
6419
    */
N
Niels 已提交
6420
    friend bool operator<=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6421 6422 6423 6424
    {
        return not (rhs < lhs);
    }

N
Niels 已提交
6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436
    /*!
    @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.

6437 6438
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__lessequal}
N
Niels 已提交
6439

N
Niels 已提交
6440
    @since version 1.0.0
N
Niels 已提交
6441
    */
N
Niels 已提交
6442
    friend bool operator>(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6443 6444 6445 6446
    {
        return not (lhs <= rhs);
    }

N
Niels 已提交
6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458
    /*!
    @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.

6459 6460
    @liveexample{The example demonstrates comparing several JSON
    types.,operator__greaterequal}
N
Niels 已提交
6461

N
Niels 已提交
6462
    @since version 1.0.0
N
Niels 已提交
6463
    */
N
Niels 已提交
6464
    friend bool operator>=(const_reference lhs, const_reference rhs) noexcept
N
Niels 已提交
6465 6466 6467 6468
    {
        return not (lhs < rhs);
    }

N
Niels 已提交
6469 6470
    /// @}

N
Niels 已提交
6471 6472 6473 6474 6475

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

N
Niels 已提交
6476 6477 6478
    /// @name serialization
    /// @{

6479
  private:
6480 6481 6482
    /*!
    @brief wrapper around the serialization functions
    */
6483 6484
    class serializer
    {
T
Ted Lyngmo 已提交
6485 6486 6487 6488
      private:
        serializer(const serializer&) = delete;
        serializer& operator=(const serializer&) = delete;

6489
      public:
N
Niels Lohmann 已提交
6490 6491 6492
        /*!
        @param[in] s  output stream to serialize to
        */
6493
        serializer(std::ostream& s)
6494 6495 6496
            : o(s), loc(std::localeconv()),
              thousands_sep(!loc->thousands_sep ? '\0' : loc->thousands_sep[0]),
              decimal_point(!loc->decimal_point ? '\0' : loc->decimal_point[0])
6497 6498 6499 6500 6501
        {}

        /*!
        @brief internal implementation of the serialization function

N
Niels Lohmann 已提交
6502 6503 6504 6505
        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.
6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518

        - 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,
6519
                  const unsigned int current_indent = 0)
6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536
        {
            switch (val.m_type)
            {
                case value_t::object:
                {
                    if (val.m_value.object->empty())
                    {
                        o.write("{}", 2);
                        return;
                    }

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

                        // variable to hold indentation for recursive calls
                        const auto new_indent = current_indent + indent_step;
6537 6538 6539 6540
                        if (indent_string.size() < new_indent)
                        {
                            indent_string.resize(new_indent, ' ');
                        }
6541 6542 6543 6544 6545

                        // 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)
                        {
6546
                            o.write(indent_string.c_str(), static_cast<std::streamsize>(new_indent));
6547
                            o.put('\"');
6548
                            dump_escaped(i->first);
6549 6550 6551 6552 6553 6554 6555
                            o.write("\": ", 3);
                            dump(i->second, true, indent_step, new_indent);
                            o.write(",\n", 2);
                        }

                        // last element
                        assert(i != val.m_value.object->cend());
6556
                        o.write(indent_string.c_str(), static_cast<std::streamsize>(new_indent));
6557
                        o.put('\"');
6558
                        dump_escaped(i->first);
6559 6560 6561 6562
                        o.write("\": ", 3);
                        dump(i->second, true, indent_step, new_indent);

                        o.put('\n');
6563
                        o.write(indent_string.c_str(), static_cast<std::streamsize>(current_indent));
6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574
                        o.put('}');
                    }
                    else
                    {
                        o.put('{');

                        // first n-1 elements
                        auto i = val.m_value.object->cbegin();
                        for (size_t cnt = 0; cnt < val.m_value.object->size() - 1; ++cnt, ++i)
                        {
                            o.put('\"');
6575
                            dump_escaped(i->first);
6576 6577 6578 6579 6580 6581 6582 6583
                            o.write("\":", 2);
                            dump(i->second, false, indent_step, current_indent);
                            o.put(',');
                        }

                        // last element
                        assert(i != val.m_value.object->cend());
                        o.put('\"');
6584
                        dump_escaped(i->first);
6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607
                        o.write("\":", 2);
                        dump(i->second, false, indent_step, current_indent);

                        o.put('}');
                    }

                    return;
                }

                case value_t::array:
                {
                    if (val.m_value.array->empty())
                    {
                        o.write("[]", 2);
                        return;
                    }

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

                        // variable to hold indentation for recursive calls
                        const auto new_indent = current_indent + indent_step;
6608 6609 6610 6611
                        if (indent_string.size() < new_indent)
                        {
                            indent_string.resize(new_indent, ' ');
                        }
6612 6613 6614 6615

                        // first n-1 elements
                        for (auto i = val.m_value.array->cbegin(); i != val.m_value.array->cend() - 1; ++i)
                        {
6616
                            o.write(indent_string.c_str(), static_cast<std::streamsize>(new_indent));
6617 6618 6619 6620 6621 6622
                            dump(*i, true, indent_step, new_indent);
                            o.write(",\n", 2);
                        }

                        // last element
                        assert(not val.m_value.array->empty());
6623
                        o.write(indent_string.c_str(), static_cast<std::streamsize>(new_indent));
6624 6625 6626
                        dump(val.m_value.array->back(), true, indent_step, new_indent);

                        o.put('\n');
6627
                        o.write(indent_string.c_str(), static_cast<std::streamsize>(current_indent));
6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653
                        o.put(']');
                    }
                    else
                    {
                        o.put('[');

                        // first n-1 elements
                        for (auto i = val.m_value.array->cbegin(); i != val.m_value.array->cend() - 1; ++i)
                        {
                            dump(*i, false, indent_step, current_indent);
                            o.put(',');
                        }

                        // last element
                        assert(not val.m_value.array->empty());
                        dump(val.m_value.array->back(), false, indent_step, current_indent);

                        o.put(']');
                    }

                    return;
                }

                case value_t::string:
                {
                    o.put('\"');
6654
                    dump_escaped(*val.m_value.string);
6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673
                    o.put('\"');
                    return;
                }

                case value_t::boolean:
                {
                    if (val.m_value.boolean)
                    {
                        o.write("true", 4);
                    }
                    else
                    {
                        o.write("false", 5);
                    }
                    return;
                }

                case value_t::number_integer:
                {
6674
                    dump_integer(val.m_value.number_integer);
6675 6676 6677 6678 6679
                    return;
                }

                case value_t::number_unsigned:
                {
6680
                    dump_integer(val.m_value.number_unsigned);
6681 6682 6683 6684 6685
                    return;
                }

                case value_t::number_float:
                {
6686
                    dump_float(val.m_value.number_float);
6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731
                    return;
                }

                case value_t::discarded:
                {
                    o.write("<discarded>", 11);
                    return;
                }

                case value_t::null:
                {
                    o.write("null", 4);
                    return;
                }
            }
        }

      private:
        /*!
        @brief calculates the extra space to escape a JSON string

        @param[in] s  the string to escape
        @return the number of characters required to escape string @a s

        @complexity Linear in the length of string @a s.
        */
        static std::size_t extra_space(const string_t& s) noexcept
        {
            return std::accumulate(s.begin(), s.end(), size_t{},
                                   [](size_t res, typename string_t::value_type c)
            {
                switch (c)
                {
                    case '"':
                    case '\\':
                    case '\b':
                    case '\f':
                    case '\n':
                    case '\r':
                    case '\t':
                    {
                        // from c (1 byte) to \x (2 bytes)
                        return res + 1;
                    }

6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758
                    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:
6759
                    {
6760 6761 6762
                        // from c (1 byte) to \uxxxx (6 bytes)
                        return res + 5;
                    }
6763

6764 6765
                    default:
                    {
6766 6767 6768 6769 6770 6771 6772
                        return res;
                    }
                }
            });
        }

        /*!
N
Niels Lohmann 已提交
6773
        @brief dump escaped string
6774

N
Niels Lohmann 已提交
6775 6776 6777 6778
        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.
6779 6780 6781 6782 6783

        @param[in] s  the string to escape

        @complexity Linear in the length of string @a s.
        */
6784
        void dump_escaped(const string_t& s) const
6785 6786 6787 6788
        {
            const auto space = extra_space(s);
            if (space == 0)
            {
6789 6790
                o.write(s.c_str(), static_cast<std::streamsize>(s.size()));
                return;
6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856
            }

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

6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883
                    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:
6884
                    {
6885 6886 6887
                        // convert a number 0..15 to its hex representation
                        // (0..f)
                        static const char hexify[16] =
6888
                        {
6889 6890 6891 6892 6893 6894 6895 6896
                            '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]
                        })
6897
                        {
6898
                            result[++pos] = m;
6899
                        }
6900 6901 6902 6903 6904 6905 6906 6907 6908

                        ++pos;
                        break;
                    }

                    default:
                    {
                        // all other characters are added as-is
                        result[pos++] = c;
6909 6910 6911 6912 6913
                        break;
                    }
                }
            }

6914 6915
            assert(pos == s.size() + space);
            o.write(result.c_str(), static_cast<std::streamsize>(result.size()));
6916 6917
        }

N
Niels Lohmann 已提交
6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929
        /*!
        @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>
6930
        void dump_integer(NumberType x)
6931
        {
6932 6933
            // special case for "0"
            if (x == 0)
6934
            {
6935 6936
                o.put('0');
                return;
6937 6938
            }

6939 6940 6941 6942
            const bool is_negative = x < 0;
            size_t i = 0;

            // spare 1 byte for '\0'
N
Niels Lohmann 已提交
6943
            while (x != 0 and i < number_buffer.size() - 1)
6944
            {
6945
                const auto digit = std::labs(static_cast<long>(x % 10));
N
Niels Lohmann 已提交
6946
                number_buffer[i++] = static_cast<char>('0' + digit);
6947
                x /= 10;
6948 6949
            }

6950 6951
            // make sure the number has been processed completely
            assert(x == 0);
6952

6953
            if (is_negative)
6954
            {
6955
                // make sure there is capacity for the '-'
N
Niels Lohmann 已提交
6956 6957
                assert(i < number_buffer.size() - 2);
                number_buffer[i++] = '-';
6958
            }
6959

N
Niels Lohmann 已提交
6960 6961
            std::reverse(number_buffer.begin(), number_buffer.begin() + i);
            o.write(number_buffer.data(), static_cast<std::streamsize>(i));
6962
        }
6963

N
Niels Lohmann 已提交
6964 6965 6966 6967 6968 6969 6970 6971
        /*!
        @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
        */
6972
        void dump_float(number_float_t x)
6973
        {
6974 6975 6976 6977 6978 6979 6980
            // NaN / inf
            if (not std::isfinite(x) or std::isnan(x))
            {
                o.write("null", 4);
                return;
            }

6981 6982 6983 6984
            // special case for 0.0 and -0.0
            if (x == 0)
            {
                if (std::signbit(x))
6985
                {
6986
                    o.write("-0.0", 4);
6987
                }
6988
                else
6989
                {
6990
                    o.write("0.0", 3);
6991
                }
6992
                return;
6993 6994
            }

6995 6996
            // get number of digits for a text -> float -> text round-trip
            static constexpr auto d = std::numeric_limits<number_float_t>::digits10;
6997

6998
            // the actual conversion
6999 7000
            std::ptrdiff_t len = snprintf(number_buffer.data(), number_buffer.size(),
                                          "%.*g", d, x);
7001

7002
            // negative value indicates an error
N
Niels Lohmann 已提交
7003
            assert(len > 0);
7004
            // check if buffer was large enough
N
Niels Lohmann 已提交
7005
            assert(static_cast<size_t>(len) < number_buffer.size());
7006

7007 7008 7009
            // erase thousands separator
            if (thousands_sep != '\0')
            {
N
Niels Lohmann 已提交
7010 7011 7012 7013 7014 7015
                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());
7016
            }
7017

7018 7019 7020
            // convert decimal point to '.'
            if (decimal_point != '\0' and decimal_point != '.')
            {
N
Niels Lohmann 已提交
7021
                for (auto& c : number_buffer)
7022
                {
7023
                    if (c == decimal_point)
7024
                    {
7025 7026
                        c = '.';
                        break;
7027 7028
                    }
                }
7029
            }
7030

N
Niels Lohmann 已提交
7031 7032
            o.write(number_buffer.data(), static_cast<std::streamsize>(len));

7033
            // determine if need to append ".0"
N
Niels Lohmann 已提交
7034 7035 7036
            const bool value_is_int_like = std::none_of(number_buffer.begin(),
                                           number_buffer.begin() + len + 1,
                                           [](char c)
7037
            {
N
Niels Lohmann 已提交
7038 7039
                return c == '.' or c == 'e';
            });
7040

7041 7042 7043
            if (value_is_int_like)
            {
                o.write(".0", 2);
7044
            }
7045
        }
7046 7047

      private:
N
Niels Lohmann 已提交
7048
        /// the output of the serializer
7049
        std::ostream& o;
7050 7051

        /// a (hopefully) large enough character buffer
N
Niels Lohmann 已提交
7052
        std::array<char, 64> number_buffer{{}};
7053

N
Niels Lohmann 已提交
7054
        /// the locale
7055
        const std::lconv* loc = nullptr;
N
Niels Lohmann 已提交
7056
        /// the locale's thousand separator character
7057
        const char thousands_sep = '\0';
N
Niels Lohmann 已提交
7058
        /// the locale's decimal point character
7059 7060
        const char decimal_point = '\0';

N
Niels Lohmann 已提交
7061
        /// the indentation string
7062
        string_t indent_string = string_t(512, ' ');
7063 7064 7065
    };

  public:
N
Niels 已提交
7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082
    /*!
    @brief serialize to stream

    Serialize the given JSON value @a j to the output stream @a o. The JSON
    value will be serialized using the @ref dump member function. The
    indentation of the output can be controlled with the member variable
    `width` of the output stream @a o. For instance, using the manipulator
    `std::setw(4)` on @a o sets the indentation level to `4` and the
    serialization result is the same as calling `dump(4)`.

    @param[in,out] o  stream to serialize to
    @param[in] j  JSON value to serialize

    @return the stream @a o

    @complexity Linear.

N
Niels 已提交
7083 7084
    @liveexample{The example below shows the serialization with different
    parameters to `width` to adjust the indentation level.,operator_serialize}
N
Niels 已提交
7085

N
Niels 已提交
7086
    @since version 1.0.0
N
Niels 已提交
7087
    */
N
Niels 已提交
7088 7089
    friend std::ostream& operator<<(std::ostream& o, const basic_json& j)
    {
N
Niels 已提交
7090
        // read width member and use it as indentation parameter if nonzero
N
Niels 已提交
7091 7092
        const bool pretty_print = (o.width() > 0);
        const auto indentation = (pretty_print ? o.width() : 0);
N
Niels 已提交
7093

N
Niels 已提交
7094 7095
        // reset width to 0 for subsequent calls to this stream
        o.width(0);
7096

N
Niels 已提交
7097
        // do the actual serialization
7098 7099
        serializer s(o);
        s.dump(j, pretty_print, static_cast<unsigned int>(indentation));
N
Niels 已提交
7100 7101 7102
        return o;
    }

N
Niels 已提交
7103 7104
    /*!
    @brief serialize to stream
7105 7106 7107 7108
    @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 已提交
7109
    */
7110
    JSON_DEPRECATED
N
Niels 已提交
7111 7112
    friend std::ostream& operator>>(const basic_json& j, std::ostream& o)
    {
N
Niels 已提交
7113
        return o << j;
N
Niels 已提交
7114 7115
    }

N
Niels 已提交
7116 7117
    /// @}

N
Niels 已提交
7118 7119 7120 7121 7122

    /////////////////////
    // deserialization //
    /////////////////////

N
Niels 已提交
7123 7124 7125
    /// @name deserialization
    /// @{

N
Niels 已提交
7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141
    /*!
    @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

7142 7143
    @throw parse_error.101 if a parse error occurs; example: `""unexpected end
    of input; expected string literal""`
N
Niels Lohmann 已提交
7144 7145
    @throw parse_error.102 if to_unicode fails or surrogate error
    @throw parse_error.103 if to_unicode fails
7146

N
Niels 已提交
7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176
    @complexity Linear in the length of the input. The parser is a predictive
    LL(1) parser. The complexity can be higher if the parser callback function
    @a cb has a super-linear complexity.

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

    @liveexample{The example below demonstrates the `parse()` function reading
    from an array.,parse__array__parser_callback_t}

    @since version 2.0.3
    */
    template<class T, std::size_t N>
    static basic_json parse(T (&array)[N],
                            const parser_callback_t cb = nullptr)
    {
        // delegate the call to the iterator-range parse overload
        return parse(std::begin(array), std::end(array), cb);
    }

    /*!
    @brief deserialize from string literal

    @tparam CharT character/literal type with size of 1 byte
    @param[in] s  string literal to read a serialized JSON value from
    @param[in] cb a parser callback function of type @ref parser_callback_t
    which is used to control the deserialization by filtering unwanted values
    (optional)

    @return result of the deserialization

N
Niels Lohmann 已提交
7177 7178 7179 7180
    @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 已提交
7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196
    @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)
    */
7197 7198 7199 7200 7201
    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 已提交
7202 7203
                            const parser_callback_t cb = nullptr)
    {
7204
        return parser(reinterpret_cast<const char*>(s), cb).parse(true);
N
Niels 已提交
7205 7206
    }

N
Niels 已提交
7207 7208 7209 7210
    /*!
    @brief deserialize from stream

    @param[in,out] i  stream to read a serialized JSON value from
N
Niels 已提交
7211 7212 7213
    @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 已提交
7214 7215 7216

    @return result of the deserialization

N
Niels Lohmann 已提交
7217 7218 7219 7220 7221
    @throw parse_error.101 in case of an unexpected token
    @throw parse_error.102 if to_unicode fails or surrogate error
    @throw parse_error.103 if to_unicode fails
    @throw parse_error.111 if input stream is in a bad state

N
Niels 已提交
7222 7223 7224 7225
    @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 已提交
7226 7227
    @note A UTF-8 byte order mark is silently ignored.

N
Niels 已提交
7228 7229
    @liveexample{The example below demonstrates the `parse()` function with
    and without callback function.,parse__istream__parser_callback_t}
N
Niels 已提交
7230

7231
    @sa @ref parse(const CharT, const parser_callback_t) for a version
N
Niels 已提交
7232
    that reads from a string
N
Niels 已提交
7233

N
Niels 已提交
7234
    @since version 1.0.0
N
Niels 已提交
7235
    */
N
Niels 已提交
7236 7237
    static basic_json parse(std::istream& i,
                            const parser_callback_t cb = nullptr)
N
Niels 已提交
7238
    {
7239
        return parser(i, cb).parse(true);
N
Niels 已提交
7240 7241
    }

N
Niels 已提交
7242
    /*!
N
Niels 已提交
7243
    @copydoc parse(std::istream&, const parser_callback_t)
N
Niels 已提交
7244
    */
N
Niels 已提交
7245 7246
    static basic_json parse(std::istream&& i,
                            const parser_callback_t cb = nullptr)
N
Cleanup  
Niels 已提交
7247
    {
7248
        return parser(i, cb).parse(true);
N
Cleanup  
Niels 已提交
7249 7250
    }

7251
    /*!
N
Niels 已提交
7252
    @brief deserialize from an iterator range with contiguous storage
7253

7254 7255
    This function reads from an iterator range of a container with contiguous
    storage of 1-byte values. Compatible container types include
7256 7257 7258 7259 7260 7261 7262 7263 7264
    `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
7265
    with a static assertion.**
7266

N
Niels 已提交
7267 7268 7269 7270
    @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.
7271

N
Niels 已提交
7272
    @tparam IteratorType iterator of container with contiguous storage
N
Niels 已提交
7273 7274 7275
    @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
7276 7277 7278 7279 7280
    which is used to control the deserialization by filtering unwanted values
    (optional)

    @return result of the deserialization

N
Niels Lohmann 已提交
7281 7282 7283 7284
    @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

7285 7286 7287 7288 7289 7290
    @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 已提交
7291 7292
    @liveexample{The example below demonstrates the `parse()` function reading
    from an iterator range.,parse__iteratortype__parser_callback_t}
7293 7294 7295

    @since version 2.0.3
    */
N
Niels 已提交
7296 7297 7298 7299
    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>
7300 7301 7302 7303 7304
    static basic_json parse(IteratorType first, IteratorType last,
                            const parser_callback_t cb = nullptr)
    {
        // assertion to check that the iterator range is indeed contiguous,
        // see http://stackoverflow.com/a/35008842/266378 for more discussion
N
Niels Lohmann 已提交
7305
        assert(std::accumulate(first, last, std::pair<bool, int>(true, 0),
7306 7307 7308 7309 7310 7311 7312
                               [&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
7313 7314
        static_assert(sizeof(typename std::iterator_traits<IteratorType>::value_type) == 1,
                      "each element in the iterator range must have the size of 1 byte");
7315

7316 7317 7318 7319
        // if iterator range is empty, create a parser with an empty string
        // to generate "unexpected EOF" error message
        if (std::distance(first, last) <= 0)
        {
7320
            return parser("").parse(true);
7321
        }
7322

7323
        return parser(first, last, cb).parse(true);
7324 7325
    }

N
Niels 已提交
7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346
    /*!
    @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 已提交
7347
    @tparam ContiguousContainer container type with contiguous storage
N
Niels 已提交
7348 7349 7350 7351 7352 7353 7354
    @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 已提交
7355 7356 7357 7358
    @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 已提交
7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369
    @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 已提交
7370
    template<class ContiguousContainer, typename std::enable_if<
N
Niels 已提交
7371
                 not std::is_pointer<ContiguousContainer>::value and
7372 7373
                 std::is_base_of<
                     std::random_access_iterator_tag,
N
Niels 已提交
7374
                     typename std::iterator_traits<decltype(std::begin(std::declval<ContiguousContainer const>()))>::iterator_category>::value
7375 7376 7377 7378 7379 7380 7381 7382
                 , 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);
    }

7383 7384 7385 7386 7387 7388 7389 7390 7391 7392
    /*!
    @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)
    {
7393
        j = parser(i).parse(true);
7394 7395 7396
        return i;
    }

N
Niels 已提交
7397 7398 7399 7400 7401 7402 7403 7404
    /*!
    @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 已提交
7405 7406 7407 7408
    @throw parse_error.101 in case of an unexpected token
    @throw parse_error.102 if to_unicode fails or surrogate error
    @throw parse_error.103 if to_unicode fails
    @throw parse_error.111 if input stream is in a bad state
N
Niels 已提交
7409 7410 7411 7412

    @complexity Linear in the length of the input. The parser is a predictive
    LL(1) parser.

N
Niels 已提交
7413 7414
    @note A UTF-8 byte order mark is silently ignored.

N
Niels 已提交
7415 7416 7417
    @liveexample{The example below shows how a JSON value is constructed by
    reading a serialization from a stream.,operator_deserialize}

N
Niels 已提交
7418 7419
    @sa parse(std::istream&, const parser_callback_t) for a variant with a
    parser callback function to filter values while parsing
N
Niels 已提交
7420

N
Niels 已提交
7421
    @since version 1.0.0
N
Niels 已提交
7422 7423
    */
    friend std::istream& operator>>(std::istream& i, basic_json& j)
N
Niels 已提交
7424
    {
7425
        j = parser(i).parse(true);
N
Niels 已提交
7426 7427 7428
        return i;
    }

N
Niels 已提交
7429 7430
    /// @}

N
Niels Lohmann 已提交
7431 7432 7433
    //////////////////////////////////////////
    // binary serialization/deserialization //
    //////////////////////////////////////////
N
Niels 已提交
7434

N
Niels Lohmann 已提交
7435
    /// @name binary serialization/deserialization support
N
Niels 已提交
7436 7437 7438
    /// @{

  private:
7439 7440 7441 7442 7443
    /*!
    @note Some code in the switch cases has been copied, because otherwise
          copilers would complain about implicit fallthrough and there is no
          portable attribute to mute such warnings.
    */
7444 7445 7446 7447 7448 7449 7450 7451 7452
    template<typename T>
    static void add_to_vector(std::vector<uint8_t>& vec, size_t bytes, const T number)
    {
        assert(bytes == 1 or bytes == 2 or bytes == 4 or bytes == 8);

        switch (bytes)
        {
            case 8:
            {
7453 7454 7455 7456
                vec.push_back(static_cast<uint8_t>((static_cast<uint64_t>(number) >> 070) & 0xff));
                vec.push_back(static_cast<uint8_t>((static_cast<uint64_t>(number) >> 060) & 0xff));
                vec.push_back(static_cast<uint8_t>((static_cast<uint64_t>(number) >> 050) & 0xff));
                vec.push_back(static_cast<uint8_t>((static_cast<uint64_t>(number) >> 040) & 0xff));
7457 7458 7459 7460 7461
                vec.push_back(static_cast<uint8_t>((number >> 030) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 020) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 010) & 0xff));
                vec.push_back(static_cast<uint8_t>(number & 0xff));
                break;
7462 7463 7464 7465 7466 7467
            }

            case 4:
            {
                vec.push_back(static_cast<uint8_t>((number >> 030) & 0xff));
                vec.push_back(static_cast<uint8_t>((number >> 020) & 0xff));
7468 7469 7470
                vec.push_back(static_cast<uint8_t>((number >> 010) & 0xff));
                vec.push_back(static_cast<uint8_t>(number & 0xff));
                break;
7471 7472 7473 7474 7475
            }

            case 2:
            {
                vec.push_back(static_cast<uint8_t>((number >> 010) & 0xff));
7476 7477
                vec.push_back(static_cast<uint8_t>(number & 0xff));
                break;
7478 7479 7480 7481 7482 7483 7484 7485 7486 7487
            }

            case 1:
            {
                vec.push_back(static_cast<uint8_t>(number & 0xff));
                break;
            }
        }
    }

7488 7489 7490 7491 7492 7493 7494 7495
    /*!
    @brief take sufficient bytes from a vector to fill an integer variable

    In the context of binary serialization formats, we need to read several
    bytes from a byte vector and combine them to multi-byte integral data
    types.

    @param[in] vec  byte vector to read from
7496
    @param[in] current_index  the position in the vector after which to read
7497 7498 7499 7500 7501

    @return the next sizeof(T) bytes from @a vec, in reverse order as T

    @tparam T the integral return type

7502
    @throw parse_error.110 if there are less than sizeof(T)+1 bytes in the
7503 7504
           vector @a vec to read

7505 7506 7507 7508
    In the for loop, the bytes from the vector are copied in reverse order into
    the return value. In the figures below, let sizeof(T)=4 and `i` be the loop
    variable.

7509 7510
    Precondition:

7511 7512 7513
    vec:   |   |   | a | b | c | d |      T: |   |   |   |   |
                 ^               ^             ^                ^
           current_index         i            ptr        sizeof(T)
7514 7515 7516

    Postcondition:

7517 7518 7519
    vec:   |   |   | a | b | c | d |      T: | d | c | b | a |
                 ^   ^                                     ^
                 |   i                                    ptr
7520 7521
           current_index

7522
    @sa Code adapted from <http://stackoverflow.com/a/41031865/266378>.
7523 7524 7525
    */
    template<typename T>
    static T get_from_vector(const std::vector<uint8_t>& vec, const size_t current_index)
7526
    {
7527
        // check if we can read sizeof(T) bytes starting the next index
N
Niels Lohmann 已提交
7528
        check_length(vec.size(), sizeof(T), current_index + 1);
7529

7530
        T result;
N
Niels Lohmann 已提交
7531
        auto* ptr = reinterpret_cast<uint8_t*>(&result);
7532
        for (size_t i = 0; i < sizeof(T); ++i)
7533
        {
7534
            *ptr++ = vec[current_index + sizeof(T) - i];
7535 7536
        }
        return result;
7537 7538
    }

7539 7540 7541 7542 7543 7544 7545 7546 7547 7548
    /*!
    @brief create a MessagePack serialization of a given JSON value

    This is a straightforward implementation of the MessagePack specification.

    @param[in] j  JSON value to serialize
    @param[in,out] v  byte vector to write the serialization to

    @sa https://github.com/msgpack/msgpack/blob/master/spec.md
    */
N
Niels 已提交
7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568
    static void to_msgpack_internal(const basic_json& j, std::vector<uint8_t>& v)
    {
        switch (j.type())
        {
            case value_t::null:
            {
                // nil
                v.push_back(0xc0);
                break;
            }

            case value_t::boolean:
            {
                // true and false
                v.push_back(j.m_value.boolean ? 0xc3 : 0xc2);
                break;
            }

            case value_t::number_integer:
            {
7569
                if (j.m_value.number_integer >= 0)
N
Niels 已提交
7570
                {
7571
                    // MessagePack does not differentiate between positive
N
Niels Lohmann 已提交
7572 7573 7574
                    // signed integers and unsigned integers. Therefore, we
                    // used the code from the value_t::number_unsigned case
                    // here.
7575 7576 7577 7578 7579
                    if (j.m_value.number_unsigned < 128)
                    {
                        // positive fixnum
                        add_to_vector(v, 1, j.m_value.number_unsigned);
                    }
7580
                    else if (j.m_value.number_unsigned <= (std::numeric_limits<uint8_t>::max)())
7581 7582 7583 7584 7585
                    {
                        // uint 8
                        v.push_back(0xcc);
                        add_to_vector(v, 1, j.m_value.number_unsigned);
                    }
7586
                    else if (j.m_value.number_unsigned <= (std::numeric_limits<uint16_t>::max)())
7587 7588 7589 7590 7591
                    {
                        // uint 16
                        v.push_back(0xcd);
                        add_to_vector(v, 2, j.m_value.number_unsigned);
                    }
7592
                    else if (j.m_value.number_unsigned <= (std::numeric_limits<uint32_t>::max)())
7593 7594 7595 7596 7597
                    {
                        // uint 32
                        v.push_back(0xce);
                        add_to_vector(v, 4, j.m_value.number_unsigned);
                    }
7598
                    else if (j.m_value.number_unsigned <= (std::numeric_limits<uint64_t>::max)())
7599 7600 7601 7602 7603
                    {
                        // uint 64
                        v.push_back(0xcf);
                        add_to_vector(v, 8, j.m_value.number_unsigned);
                    }
N
Niels 已提交
7604
                }
7605
                else
N
Niels 已提交
7606
                {
7607 7608 7609 7610 7611
                    if (j.m_value.number_integer >= -32)
                    {
                        // negative fixnum
                        add_to_vector(v, 1, j.m_value.number_integer);
                    }
7612
                    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)())
7613 7614 7615 7616 7617
                    {
                        // int 8
                        v.push_back(0xd0);
                        add_to_vector(v, 1, j.m_value.number_integer);
                    }
7618
                    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)())
7619 7620 7621 7622 7623
                    {
                        // int 16
                        v.push_back(0xd1);
                        add_to_vector(v, 2, j.m_value.number_integer);
                    }
7624
                    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)())
7625 7626 7627 7628 7629
                    {
                        // int 32
                        v.push_back(0xd2);
                        add_to_vector(v, 4, j.m_value.number_integer);
                    }
7630
                    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)())
7631 7632 7633 7634 7635
                    {
                        // int 64
                        v.push_back(0xd3);
                        add_to_vector(v, 8, j.m_value.number_integer);
                    }
N
Niels 已提交
7636 7637 7638 7639 7640 7641 7642 7643 7644
                }
                break;
            }

            case value_t::number_unsigned:
            {
                if (j.m_value.number_unsigned < 128)
                {
                    // positive fixnum
7645
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels 已提交
7646
                }
7647
                else if (j.m_value.number_unsigned <= (std::numeric_limits<uint8_t>::max)())
N
Niels 已提交
7648 7649 7650
                {
                    // uint 8
                    v.push_back(0xcc);
7651
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels 已提交
7652
                }
7653
                else if (j.m_value.number_unsigned <= (std::numeric_limits<uint16_t>::max)())
N
Niels 已提交
7654 7655 7656
                {
                    // uint 16
                    v.push_back(0xcd);
7657
                    add_to_vector(v, 2, j.m_value.number_unsigned);
N
Niels 已提交
7658
                }
7659
                else if (j.m_value.number_unsigned <= (std::numeric_limits<uint32_t>::max)())
N
Niels 已提交
7660 7661 7662
                {
                    // uint 32
                    v.push_back(0xce);
7663
                    add_to_vector(v, 4, j.m_value.number_unsigned);
N
Niels 已提交
7664
                }
7665
                else if (j.m_value.number_unsigned <= (std::numeric_limits<uint64_t>::max)())
N
Niels 已提交
7666 7667 7668
                {
                    // uint 64
                    v.push_back(0xcf);
7669
                    add_to_vector(v, 8, j.m_value.number_unsigned);
N
Niels 已提交
7670 7671 7672 7673 7674 7675 7676 7677
                }
                break;
            }

            case value_t::number_float:
            {
                // float 64
                v.push_back(0xcb);
N
Niels Lohmann 已提交
7678
                const auto* helper = reinterpret_cast<const uint8_t*>(&(j.m_value.number_float));
N
Niels 已提交
7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697
                for (size_t i = 0; i < 8; ++i)
                {
                    v.push_back(helper[7 - i]);
                }
                break;
            }

            case value_t::string:
            {
                const auto N = j.m_value.string->size();
                if (N <= 31)
                {
                    // fixstr
                    v.push_back(static_cast<uint8_t>(0xa0 | N));
                }
                else if (N <= 255)
                {
                    // str 8
                    v.push_back(0xd9);
7698
                    add_to_vector(v, 1, N);
N
Niels 已提交
7699 7700 7701 7702 7703
                }
                else if (N <= 65535)
                {
                    // str 16
                    v.push_back(0xda);
7704
                    add_to_vector(v, 2, N);
N
Niels 已提交
7705 7706 7707 7708 7709
                }
                else if (N <= 4294967295)
                {
                    // str 32
                    v.push_back(0xdb);
7710
                    add_to_vector(v, 4, N);
N
Niels 已提交
7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730
                }

                // append string
                std::copy(j.m_value.string->begin(), j.m_value.string->end(),
                          std::back_inserter(v));
                break;
            }

            case value_t::array:
            {
                const auto N = j.m_value.array->size();
                if (N <= 15)
                {
                    // fixarray
                    v.push_back(static_cast<uint8_t>(0x90 | N));
                }
                else if (N <= 0xffff)
                {
                    // array 16
                    v.push_back(0xdc);
7731
                    add_to_vector(v, 2, N);
N
Niels 已提交
7732 7733 7734 7735 7736
                }
                else if (N <= 0xffffffff)
                {
                    // array 32
                    v.push_back(0xdd);
7737
                    add_to_vector(v, 4, N);
N
Niels 已提交
7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759
                }

                // append each element
                for (const auto& el : *j.m_value.array)
                {
                    to_msgpack_internal(el, v);
                }
                break;
            }

            case value_t::object:
            {
                const auto N = j.m_value.object->size();
                if (N <= 15)
                {
                    // fixmap
                    v.push_back(static_cast<uint8_t>(0x80 | (N & 0xf)));
                }
                else if (N <= 65535)
                {
                    // map 16
                    v.push_back(0xde);
7760
                    add_to_vector(v, 2, N);
N
Niels 已提交
7761 7762 7763 7764 7765
                }
                else if (N <= 4294967295)
                {
                    // map 32
                    v.push_back(0xdf);
7766
                    add_to_vector(v, 4, N);
N
Niels 已提交
7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784
                }

                // append each element
                for (const auto& el : *j.m_value.object)
                {
                    to_msgpack_internal(el.first, v);
                    to_msgpack_internal(el.second, v);
                }
                break;
            }

            default:
            {
                break;
            }
        }
    }

7785 7786 7787 7788 7789 7790 7791 7792 7793 7794
    /*!
    @brief create a CBOR serialization of a given JSON value

    This is a straightforward implementation of the CBOR specification.

    @param[in] j  JSON value to serialize
    @param[in,out] v  byte vector to write the serialization to

    @sa https://tools.ietf.org/html/rfc7049
    */
N
Niels Lohmann 已提交
7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817
    static void to_cbor_internal(const basic_json& j, std::vector<uint8_t>& v)
    {
        switch (j.type())
        {
            case value_t::null:
            {
                v.push_back(0xf6);
                break;
            }

            case value_t::boolean:
            {
                v.push_back(j.m_value.boolean ? 0xf5 : 0xf4);
                break;
            }

            case value_t::number_integer:
            {
                if (j.m_value.number_integer >= 0)
                {
                    // CBOR does not differentiate between positive signed
                    // integers and unsigned integers. Therefore, we used the
                    // code from the value_t::number_unsigned case here.
7818
                    if (j.m_value.number_integer <= 0x17)
N
Niels Lohmann 已提交
7819
                    {
7820
                        add_to_vector(v, 1, j.m_value.number_integer);
N
Niels Lohmann 已提交
7821
                    }
7822
                    else if (j.m_value.number_integer <= (std::numeric_limits<uint8_t>::max)())
N
Niels Lohmann 已提交
7823 7824 7825
                    {
                        v.push_back(0x18);
                        // one-byte uint8_t
7826
                        add_to_vector(v, 1, j.m_value.number_integer);
N
Niels Lohmann 已提交
7827
                    }
7828
                    else if (j.m_value.number_integer <= (std::numeric_limits<uint16_t>::max)())
N
Niels Lohmann 已提交
7829 7830 7831
                    {
                        v.push_back(0x19);
                        // two-byte uint16_t
7832
                        add_to_vector(v, 2, j.m_value.number_integer);
N
Niels Lohmann 已提交
7833
                    }
7834
                    else if (j.m_value.number_integer <= (std::numeric_limits<uint32_t>::max)())
N
Niels Lohmann 已提交
7835 7836 7837
                    {
                        v.push_back(0x1a);
                        // four-byte uint32_t
7838
                        add_to_vector(v, 4, j.m_value.number_integer);
N
Niels Lohmann 已提交
7839
                    }
7840
                    else
N
Niels Lohmann 已提交
7841
                    {
N
Niels Lohmann 已提交
7842
                        v.push_back(0x1b);
N
Niels Lohmann 已提交
7843
                        // eight-byte uint64_t
7844
                        add_to_vector(v, 8, j.m_value.number_integer);
N
Niels Lohmann 已提交
7845 7846 7847 7848
                    }
                }
                else
                {
N
Niels Lohmann 已提交
7849 7850
                    // The conversions below encode the sign in the first
                    // byte, and the value is converted to a positive number.
N
Niels Lohmann 已提交
7851
                    const auto positive_number = -1 - j.m_value.number_integer;
7852
                    if (j.m_value.number_integer >= -24)
N
Niels Lohmann 已提交
7853 7854 7855
                    {
                        v.push_back(static_cast<uint8_t>(0x20 + positive_number));
                    }
7856
                    else if (positive_number <= (std::numeric_limits<uint8_t>::max)())
N
Niels Lohmann 已提交
7857 7858 7859
                    {
                        // int 8
                        v.push_back(0x38);
7860
                        add_to_vector(v, 1, positive_number);
N
Niels Lohmann 已提交
7861
                    }
7862
                    else if (positive_number <= (std::numeric_limits<uint16_t>::max)())
N
Niels Lohmann 已提交
7863 7864 7865
                    {
                        // int 16
                        v.push_back(0x39);
7866
                        add_to_vector(v, 2, positive_number);
N
Niels Lohmann 已提交
7867
                    }
7868
                    else if (positive_number <= (std::numeric_limits<uint32_t>::max)())
N
Niels Lohmann 已提交
7869 7870 7871
                    {
                        // int 32
                        v.push_back(0x3a);
7872
                        add_to_vector(v, 4, positive_number);
N
Niels Lohmann 已提交
7873
                    }
7874
                    else
N
Niels Lohmann 已提交
7875 7876 7877
                    {
                        // int 64
                        v.push_back(0x3b);
7878
                        add_to_vector(v, 8, positive_number);
N
Niels Lohmann 已提交
7879 7880
                    }
                }
7881
                break;
N
Niels Lohmann 已提交
7882 7883 7884 7885
            }

            case value_t::number_unsigned:
            {
7886
                if (j.m_value.number_unsigned <= 0x17)
N
Niels Lohmann 已提交
7887 7888 7889 7890 7891 7892 7893
                {
                    v.push_back(static_cast<uint8_t>(j.m_value.number_unsigned));
                }
                else if (j.m_value.number_unsigned <= 0xff)
                {
                    v.push_back(0x18);
                    // one-byte uint8_t
7894
                    add_to_vector(v, 1, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7895 7896 7897 7898 7899
                }
                else if (j.m_value.number_unsigned <= 0xffff)
                {
                    v.push_back(0x19);
                    // two-byte uint16_t
7900
                    add_to_vector(v, 2, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7901 7902 7903 7904 7905
                }
                else if (j.m_value.number_unsigned <= 0xffffffff)
                {
                    v.push_back(0x1a);
                    // four-byte uint32_t
7906
                    add_to_vector(v, 4, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7907 7908 7909
                }
                else if (j.m_value.number_unsigned <= 0xffffffffffffffff)
                {
N
Niels Lohmann 已提交
7910
                    v.push_back(0x1b);
N
Niels Lohmann 已提交
7911
                    // eight-byte uint64_t
7912
                    add_to_vector(v, 8, j.m_value.number_unsigned);
N
Niels Lohmann 已提交
7913 7914 7915 7916 7917 7918 7919 7920
                }
                break;
            }

            case value_t::number_float:
            {
                // Double-Precision Float
                v.push_back(0xfb);
N
Niels Lohmann 已提交
7921
                const auto* helper = reinterpret_cast<const uint8_t*>(&(j.m_value.number_float));
N
Niels Lohmann 已提交
7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933
                for (size_t i = 0; i < 8; ++i)
                {
                    v.push_back(helper[7 - i]);
                }
                break;
            }

            case value_t::string:
            {
                const auto N = j.m_value.string->size();
                if (N <= 0x17)
                {
7934
                    v.push_back(static_cast<uint8_t>(0x60 + N));  // 1 byte for string + size
N
Niels Lohmann 已提交
7935 7936 7937
                }
                else if (N <= 0xff)
                {
7938
                    v.push_back(0x78);  // one-byte uint8_t for N
7939
                    add_to_vector(v, 1, N);
N
Niels Lohmann 已提交
7940 7941 7942
                }
                else if (N <= 0xffff)
                {
7943
                    v.push_back(0x79);  // two-byte uint16_t for N
7944
                    add_to_vector(v, 2, N);
N
Niels Lohmann 已提交
7945 7946 7947
                }
                else if (N <= 0xffffffff)
                {
7948
                    v.push_back(0x7a); // four-byte uint32_t for N
7949
                    add_to_vector(v, 4, N);
N
Niels Lohmann 已提交
7950
                }
7951
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
7952 7953
                else if (N <= 0xffffffffffffffff)
                {
7954
                    v.push_back(0x7b);  // eight-byte uint64_t for N
7955
                    add_to_vector(v, 8, N);
N
Niels Lohmann 已提交
7956
                }
7957
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969

                // append string
                std::copy(j.m_value.string->begin(), j.m_value.string->end(),
                          std::back_inserter(v));
                break;
            }

            case value_t::array:
            {
                const auto N = j.m_value.array->size();
                if (N <= 0x17)
                {
7970
                    v.push_back(static_cast<uint8_t>(0x80 + N));  // 1 byte for array + size
N
Niels Lohmann 已提交
7971 7972 7973
                }
                else if (N <= 0xff)
                {
7974
                    v.push_back(0x98);  // one-byte uint8_t for N
7975
                    add_to_vector(v, 1, N);
N
Niels Lohmann 已提交
7976 7977 7978
                }
                else if (N <= 0xffff)
                {
7979
                    v.push_back(0x99);  // two-byte uint16_t for N
7980
                    add_to_vector(v, 2, N);
N
Niels Lohmann 已提交
7981 7982 7983
                }
                else if (N <= 0xffffffff)
                {
7984
                    v.push_back(0x9a);  // four-byte uint32_t for N
7985
                    add_to_vector(v, 4, N);
N
Niels Lohmann 已提交
7986
                }
7987
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
7988 7989
                else if (N <= 0xffffffffffffffff)
                {
7990
                    v.push_back(0x9b);  // eight-byte uint64_t for N
7991
                    add_to_vector(v, 8, N);
N
Niels Lohmann 已提交
7992
                }
7993
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007

                // append each element
                for (const auto& el : *j.m_value.array)
                {
                    to_cbor_internal(el, v);
                }
                break;
            }

            case value_t::object:
            {
                const auto N = j.m_value.object->size();
                if (N <= 0x17)
                {
8008
                    v.push_back(static_cast<uint8_t>(0xa0 + N));  // 1 byte for object + size
N
Niels Lohmann 已提交
8009 8010 8011 8012
                }
                else if (N <= 0xff)
                {
                    v.push_back(0xb8);
8013
                    add_to_vector(v, 1, N);  // one-byte uint8_t for N
N
Niels Lohmann 已提交
8014 8015 8016 8017
                }
                else if (N <= 0xffff)
                {
                    v.push_back(0xb9);
8018
                    add_to_vector(v, 2, N);  // two-byte uint16_t for N
N
Niels Lohmann 已提交
8019 8020 8021 8022
                }
                else if (N <= 0xffffffff)
                {
                    v.push_back(0xba);
8023
                    add_to_vector(v, 4, N);  // four-byte uint32_t for N
N
Niels Lohmann 已提交
8024
                }
8025
                // LCOV_EXCL_START
N
Niels Lohmann 已提交
8026 8027 8028
                else if (N <= 0xffffffffffffffff)
                {
                    v.push_back(0xbb);
8029
                    add_to_vector(v, 8, N);  // eight-byte uint64_t for N
N
Niels Lohmann 已提交
8030
                }
8031
                // LCOV_EXCL_STOP
N
Niels Lohmann 已提交
8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048

                // append each element
                for (const auto& el : *j.m_value.object)
                {
                    to_cbor_internal(el.first, v);
                    to_cbor_internal(el.second, v);
                }
                break;
            }

            default:
            {
                break;
            }
        }
    }

8049 8050 8051 8052 8053 8054

    /*
    @brief checks if given lengths do not exceed the size of a given vector

    To secure the access to the byte vector during CBOR/MessagePack
    deserialization, bytes are copied from the vector into buffers. This
N
Niels Lohmann 已提交
8055 8056 8057
    function checks if the number of bytes to copy (@a len) does not exceed
    the size @s size of the vector. Additionally, an @a offset is given from
    where to start reading the bytes.
8058

N
Niels Lohmann 已提交
8059 8060
    This function checks whether reading the bytes is safe; that is, offset is
    a valid index in the vector, offset+len
8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076

    @param[in] size    size of the byte vector
    @param[in] len     number of bytes to read
    @param[in] offset  offset where to start reading

    vec:  x x x x x X X X X X
          ^         ^         ^
          0         offset    len

    @throws out_of_range if `len > v.size()`
    */
    static void check_length(const size_t size, const size_t len, const size_t offset)
    {
        // simple case: requested length is greater than the vector's length
        if (len > size or offset > size)
        {
8077
            JSON_THROW(parse_error::create(110, offset + 1, "cannot read " + std::to_string(len) + " bytes from vector"));
8078 8079 8080
        }

        // second case: adding offset would result in overflow
8081
        if ((size > ((std::numeric_limits<size_t>::max)() - offset)))
8082
        {
8083
            JSON_THROW(parse_error::create(110, offset + 1, "cannot read " + std::to_string(len) + " bytes from vector"));
8084
        }
N
Niels Lohmann 已提交
8085 8086 8087 8088

        // last case: reading past the end of the vector
        if (len + offset > size)
        {
8089
            JSON_THROW(parse_error::create(110, offset + 1, "cannot read " + std::to_string(len) + " bytes from vector"));
N
Niels Lohmann 已提交
8090
        }
8091 8092
    }

8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106
    /*!
    @brief check if the next byte belongs to a string

    While parsing a map, the keys must be strings. This function checks if the
    current byte is one of the start bytes for a string in MessagePack:

    - 0xa0 - 0xbf: fixstr
    - 0xd9: str 8
    - 0xda: str 16
    - 0xdb: str 32

    @param[in] v  MessagePack serialization
    @param[in] idx  byte index in @a v to check for a string

8107
    @throw parse_error.113 if `v[idx]` does not belong to a string
8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118
    */
    static void msgpack_expect_string(const std::vector<uint8_t>& v, size_t idx)
    {
        check_length(v.size(), 1, idx);

        const auto byte = v[idx];
        if ((byte >= 0xa0 and byte <= 0xbf) or (byte >= 0xd9 and byte <= 0xdb))
        {
            return;
        }

8119 8120
        std::stringstream ss;
        ss << std::hex << static_cast<int>(v[idx]);
8121
        JSON_THROW(parse_error::create(113, idx + 1, "expected a MessagePack string; last byte: 0x" + ss.str()));
8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150
    }

    /*!
    @brief check if the next byte belongs to a string

    While parsing a map, the keys must be strings. This function checks if the
    current byte is one of the start bytes for a string in CBOR:

    - 0x60 - 0x77: fixed length
    - 0x78 - 0x7b: variable length
    - 0x7f: indefinity length

    @param[in] v  CBOR serialization
    @param[in] idx  byte index in @a v to check for a string

    @throw parse_error.113 if `v[idx]` does not belong to a string
    */
    static void cbor_expect_string(const std::vector<uint8_t>& v, size_t idx)
    {
        check_length(v.size(), 1, idx);

        const auto byte = v[idx];
        if ((byte >= 0x60 and byte <= 0x7b) or byte == 0x7f)
        {
            return;
        }

        std::stringstream ss;
        ss << std::hex << static_cast<int>(v[idx]);
8151
        JSON_THROW(parse_error::create(113, idx + 1, "expected a CBOR string; last byte: 0x" + ss.str()));
8152 8153
    }

N
Niels 已提交
8154
    /*!
8155 8156
    @brief create a JSON value from a given MessagePack vector

N
Niels 已提交
8157 8158
    @param[in] v  MessagePack serialization
    @param[in] idx  byte index to start reading from @a v
8159 8160 8161

    @return deserialized JSON value

N
Niels Lohmann 已提交
8162 8163
    @throw parse_error.110 if the given vector ends prematurely
    @throw parse_error.112 if unsupported features from MessagePack were
8164
    used in the given vector @a v or if the input is not valid MessagePack
8165
    @throw parse_error.113 if a string was expected as map key, but not found
8166 8167

    @sa https://github.com/msgpack/msgpack/blob/master/spec.md
N
Niels 已提交
8168 8169 8170 8171 8172 8173
    */
    static basic_json from_msgpack_internal(const std::vector<uint8_t>& v, size_t& idx)
    {
        // store and increment index
        const size_t current_idx = idx++;

8174 8175 8176
        // make sure reading 1 byte is safe
        check_length(v.size(), 1, current_idx);

N
Niels Lohmann 已提交
8177
        if (v[current_idx] <= 0xbf)
N
Niels 已提交
8178
        {
N
Niels Lohmann 已提交
8179
            if (v[current_idx] <= 0x7f) // positive fixint
N
Niels 已提交
8180
            {
N
Niels Lohmann 已提交
8181
                return v[current_idx];
N
Niels 已提交
8182
            }
N
Niels Lohmann 已提交
8183
            if (v[current_idx] <= 0x8f) // fixmap
N
Niels 已提交
8184
            {
N
Niels Lohmann 已提交
8185 8186 8187 8188
                basic_json result = value_t::object;
                const size_t len = v[current_idx] & 0x0f;
                for (size_t i = 0; i < len; ++i)
                {
8189
                    msgpack_expect_string(v, idx);
N
Niels Lohmann 已提交
8190 8191 8192 8193
                    std::string key = from_msgpack_internal(v, idx);
                    result[key] = from_msgpack_internal(v, idx);
                }
                return result;
N
Niels 已提交
8194
            }
N
Niels Lohmann 已提交
8195
            else if (v[current_idx] <= 0x9f) // fixarray
N
Niels 已提交
8196
            {
N
Niels Lohmann 已提交
8197 8198 8199 8200 8201 8202 8203
                basic_json result = value_t::array;
                const size_t len = v[current_idx] & 0x0f;
                for (size_t i = 0; i < len; ++i)
                {
                    result.push_back(from_msgpack_internal(v, idx));
                }
                return result;
N
Niels 已提交
8204
            }
N
Niels Lohmann 已提交
8205
            else // fixstr
N
Niels 已提交
8206
            {
N
Niels Lohmann 已提交
8207 8208 8209
                const size_t len = v[current_idx] & 0x1f;
                const size_t offset = current_idx + 1;
                idx += len; // skip content bytes
8210
                check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
8211
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels 已提交
8212 8213
            }
        }
N
Niels Lohmann 已提交
8214
        else if (v[current_idx] >= 0xe0) // negative fixint
N
Niels 已提交
8215
        {
N
Niels Lohmann 已提交
8216
            return static_cast<int8_t>(v[current_idx]);
N
Niels 已提交
8217
        }
N
Niels Lohmann 已提交
8218
        else
N
Niels 已提交
8219
        {
N
Niels Lohmann 已提交
8220
            switch (v[current_idx])
N
Niels 已提交
8221
            {
N
Niels Lohmann 已提交
8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240
                case 0xc0: // nil
                {
                    return value_t::null;
                }

                case 0xc2: // false
                {
                    return false;
                }

                case 0xc3: // true
                {
                    return true;
                }

                case 0xca: // float 32
                {
                    // copy bytes in reverse order into the double variable
                    float res;
8241
                    check_length(v.size(), sizeof(float), current_idx + 1);
N
Niels Lohmann 已提交
8242 8243
                    for (size_t byte = 0; byte < sizeof(float); ++byte)
                    {
8244
                        reinterpret_cast<uint8_t*>(&res)[sizeof(float) - byte - 1] = v[current_idx + 1 + byte];
N
Niels Lohmann 已提交
8245 8246 8247 8248 8249 8250 8251 8252 8253
                    }
                    idx += sizeof(float); // skip content bytes
                    return res;
                }

                case 0xcb: // float 64
                {
                    // copy bytes in reverse order into the double variable
                    double res;
8254
                    check_length(v.size(), sizeof(double), current_idx + 1);
N
Niels Lohmann 已提交
8255 8256
                    for (size_t byte = 0; byte < sizeof(double); ++byte)
                    {
8257
                        reinterpret_cast<uint8_t*>(&res)[sizeof(double) - byte - 1] = v[current_idx + 1 + byte];
N
Niels Lohmann 已提交
8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312
                    }
                    idx += sizeof(double); // skip content bytes
                    return res;
                }

                case 0xcc: // uint 8
                {
                    idx += 1; // skip content byte
                    return get_from_vector<uint8_t>(v, current_idx);
                }

                case 0xcd: // uint 16
                {
                    idx += 2; // skip 2 content bytes
                    return get_from_vector<uint16_t>(v, current_idx);
                }

                case 0xce: // uint 32
                {
                    idx += 4; // skip 4 content bytes
                    return get_from_vector<uint32_t>(v, current_idx);
                }

                case 0xcf: // uint 64
                {
                    idx += 8; // skip 8 content bytes
                    return get_from_vector<uint64_t>(v, current_idx);
                }

                case 0xd0: // int 8
                {
                    idx += 1; // skip content byte
                    return get_from_vector<int8_t>(v, current_idx);
                }

                case 0xd1: // int 16
                {
                    idx += 2; // skip 2 content bytes
                    return get_from_vector<int16_t>(v, current_idx);
                }

                case 0xd2: // int 32
                {
                    idx += 4; // skip 4 content bytes
                    return get_from_vector<int32_t>(v, current_idx);
                }

                case 0xd3: // int 64
                {
                    idx += 8; // skip 8 content bytes
                    return get_from_vector<int64_t>(v, current_idx);
                }

                case 0xd9: // str 8
                {
8313
                    const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
N
Niels Lohmann 已提交
8314 8315
                    const size_t offset = current_idx + 2;
                    idx += len + 1; // skip size byte + content bytes
8316
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
8317 8318 8319 8320 8321
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xda: // str 16
                {
8322
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
8323 8324
                    const size_t offset = current_idx + 3;
                    idx += len + 2; // skip 2 size bytes + content bytes
8325
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
8326 8327 8328 8329 8330
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xdb: // str 32
                {
8331
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
8332 8333
                    const size_t offset = current_idx + 5;
                    idx += len + 4; // skip 4 size bytes + content bytes
8334
                    check_length(v.size(), len, offset);
N
Niels Lohmann 已提交
8335 8336 8337 8338 8339 8340
                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
                }

                case 0xdc: // array 16
                {
                    basic_json result = value_t::array;
8341
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352
                    idx += 2; // skip 2 size bytes
                    for (size_t i = 0; i < len; ++i)
                    {
                        result.push_back(from_msgpack_internal(v, idx));
                    }
                    return result;
                }

                case 0xdd: // array 32
                {
                    basic_json result = value_t::array;
8353
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364
                    idx += 4; // skip 4 size bytes
                    for (size_t i = 0; i < len; ++i)
                    {
                        result.push_back(from_msgpack_internal(v, idx));
                    }
                    return result;
                }

                case 0xde: // map 16
                {
                    basic_json result = value_t::object;
8365
                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
N
Niels Lohmann 已提交
8366 8367 8368
                    idx += 2; // skip 2 size bytes
                    for (size_t i = 0; i < len; ++i)
                    {
8369
                        msgpack_expect_string(v, idx);
N
Niels Lohmann 已提交
8370 8371 8372 8373 8374 8375 8376 8377 8378
                        std::string key = from_msgpack_internal(v, idx);
                        result[key] = from_msgpack_internal(v, idx);
                    }
                    return result;
                }

                case 0xdf: // map 32
                {
                    basic_json result = value_t::object;
8379
                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
N
Niels Lohmann 已提交
8380 8381 8382
                    idx += 4; // skip 4 size bytes
                    for (size_t i = 0; i < len; ++i)
                    {
8383
                        msgpack_expect_string(v, idx);
N
Niels Lohmann 已提交
8384 8385 8386 8387 8388 8389 8390 8391
                        std::string key = from_msgpack_internal(v, idx);
                        result[key] = from_msgpack_internal(v, idx);
                    }
                    return result;
                }

                default:
                {
8392 8393
                    std::stringstream ss;
                    ss << std::hex << static_cast<int>(v[current_idx]);
8394
                    JSON_THROW(parse_error::create(112, current_idx + 1, "error reading MessagePack; last byte: 0x" + ss.str()));
N
Niels Lohmann 已提交
8395
                }
N
Niels 已提交
8396 8397 8398 8399
            }
        }
    }

8400 8401 8402 8403 8404 8405 8406 8407
    /*!
    @brief create a JSON value from a given CBOR vector

    @param[in] v  CBOR serialization
    @param[in] idx  byte index to start reading from @a v

    @return deserialized JSON value

N
Niels Lohmann 已提交
8408 8409 8410
    @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
8411
    @throw parse_error.113 if a string was expected as map key, but not found
8412 8413 8414

    @sa https://tools.ietf.org/html/rfc7049
    */
N
Niels Lohmann 已提交
8415 8416 8417 8418 8419
    static basic_json from_cbor_internal(const std::vector<uint8_t>& v, size_t& idx)
    {
        // store and increment index
        const size_t current_idx = idx++;

8420 8421 8422 8423
        // make sure reading 1 byte is safe
        check_length(v.size(), 1, current_idx);

        switch (v[current_idx])
8424
        {
N
Niels Lohmann 已提交
8425
            // Integer 0x00..0x17 (0..23)
8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449
            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:
8450
            {
8451
                return v[current_idx];
8452
            }
8453

N
Niels Lohmann 已提交
8454
            case 0x18: // Unsigned integer (one-byte uint8_t follows)
N
Niels Lohmann 已提交
8455
            {
8456 8457
                idx += 1; // skip content byte
                return get_from_vector<uint8_t>(v, current_idx);
N
Niels Lohmann 已提交
8458
            }
8459

N
Niels Lohmann 已提交
8460
            case 0x19: // Unsigned integer (two-byte uint16_t follows)
N
Niels Lohmann 已提交
8461
            {
8462 8463
                idx += 2; // skip 2 content bytes
                return get_from_vector<uint16_t>(v, current_idx);
N
Niels Lohmann 已提交
8464
            }
8465

N
Niels Lohmann 已提交
8466
            case 0x1a: // Unsigned integer (four-byte uint32_t follows)
N
Niels Lohmann 已提交
8467
            {
8468 8469
                idx += 4; // skip 4 content bytes
                return get_from_vector<uint32_t>(v, current_idx);
N
Niels Lohmann 已提交
8470
            }
8471

N
Niels Lohmann 已提交
8472
            case 0x1b: // Unsigned integer (eight-byte uint64_t follows)
N
Niels Lohmann 已提交
8473
            {
8474 8475
                idx += 8; // skip 8 content bytes
                return get_from_vector<uint64_t>(v, current_idx);
N
Niels Lohmann 已提交
8476
            }
8477

N
Niels Lohmann 已提交
8478
            // Negative integer -1-0x00..-1-0x17 (-1..-24)
8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502
            case 0x20:
            case 0x21:
            case 0x22:
            case 0x23:
            case 0x24:
            case 0x25:
            case 0x26:
            case 0x27:
            case 0x28:
            case 0x29:
            case 0x2a:
            case 0x2b:
            case 0x2c:
            case 0x2d:
            case 0x2e:
            case 0x2f:
            case 0x30:
            case 0x31:
            case 0x32:
            case 0x33:
            case 0x34:
            case 0x35:
            case 0x36:
            case 0x37:
N
Niels Lohmann 已提交
8503
            {
8504
                return static_cast<int8_t>(0x20 - 1 - v[current_idx]);
N
Niels Lohmann 已提交
8505
            }
8506

N
Niels Lohmann 已提交
8507
            case 0x38: // Negative integer (one-byte uint8_t follows)
8508
            {
8509 8510
                idx += 1; // skip content byte
                // must be uint8_t !
8511
                return static_cast<number_integer_t>(-1) - get_from_vector<uint8_t>(v, current_idx);
8512
            }
8513

N
Niels Lohmann 已提交
8514
            case 0x39: // Negative integer -1-n (two-byte uint16_t follows)
N
Niels Lohmann 已提交
8515
            {
8516
                idx += 2; // skip 2 content bytes
8517
                return static_cast<number_integer_t>(-1) - get_from_vector<uint16_t>(v, current_idx);
N
Niels Lohmann 已提交
8518
            }
8519

N
Niels Lohmann 已提交
8520
            case 0x3a: // Negative integer -1-n (four-byte uint32_t follows)
N
Niels Lohmann 已提交
8521
            {
8522
                idx += 4; // skip 4 content bytes
8523
                return static_cast<number_integer_t>(-1) - get_from_vector<uint32_t>(v, current_idx);
N
Niels Lohmann 已提交
8524
            }
8525

N
Niels Lohmann 已提交
8526
            case 0x3b: // Negative integer -1-n (eight-byte uint64_t follows)
N
Niels Lohmann 已提交
8527
            {
8528
                idx += 8; // skip 8 content bytes
8529
                return static_cast<number_integer_t>(-1) - static_cast<number_integer_t>(get_from_vector<uint64_t>(v, current_idx));
N
Niels Lohmann 已提交
8530
            }
8531

N
Niels Lohmann 已提交
8532
            // UTF-8 string (0x00..0x17 bytes follow)
8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556
            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 已提交
8557
            {
8558
                const auto len = static_cast<size_t>(v[current_idx] - 0x60);
8559 8560
                const size_t offset = current_idx + 1;
                idx += len; // skip content bytes
8561
                check_length(v.size(), len, offset);
8562
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels Lohmann 已提交
8563
            }
8564

N
Niels Lohmann 已提交
8565
            case 0x78: // UTF-8 string (one-byte uint8_t for n follows)
N
Niels Lohmann 已提交
8566
            {
8567
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
8568 8569
                const size_t offset = current_idx + 2;
                idx += len + 1; // skip size byte + content bytes
8570
                check_length(v.size(), len, offset);
8571
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
N
Niels Lohmann 已提交
8572
            }
8573

N
Niels Lohmann 已提交
8574
            case 0x79: // UTF-8 string (two-byte uint16_t for n follow)
8575
            {
8576
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
8577 8578
                const size_t offset = current_idx + 3;
                idx += len + 2; // skip 2 size bytes + content bytes
8579
                check_length(v.size(), len, offset);
8580
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
8581
            }
8582

N
Niels Lohmann 已提交
8583
            case 0x7a: // UTF-8 string (four-byte uint32_t for n follow)
8584
            {
8585
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
8586 8587
                const size_t offset = current_idx + 5;
                idx += len + 4; // skip 4 size bytes + content bytes
8588
                check_length(v.size(), len, offset);
8589
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
8590
            }
8591

N
Niels Lohmann 已提交
8592
            case 0x7b: // UTF-8 string (eight-byte uint64_t for n follow)
8593
            {
8594
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
8595 8596
                const size_t offset = current_idx + 9;
                idx += len + 8; // skip 8 size bytes + content bytes
8597
                check_length(v.size(), len, offset);
8598
                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
8599
            }
8600 8601

            case 0x7f: // UTF-8 string (indefinite length)
8602
            {
8603
                std::string result;
N
Niels Lohmann 已提交
8604
                while (static_cast<void>(check_length(v.size(), 1, idx)), v[idx] != 0xff)
8605 8606 8607 8608 8609 8610 8611
                {
                    string_t s = from_cbor_internal(v, idx);
                    result += s;
                }
                // skip break byte (0xFF)
                idx += 1;
                return result;
8612
            }
8613

N
Niels Lohmann 已提交
8614
            // array (0x00..0x17 data items follow)
8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638
            case 0x80:
            case 0x81:
            case 0x82:
            case 0x83:
            case 0x84:
            case 0x85:
            case 0x86:
            case 0x87:
            case 0x88:
            case 0x89:
            case 0x8a:
            case 0x8b:
            case 0x8c:
            case 0x8d:
            case 0x8e:
            case 0x8f:
            case 0x90:
            case 0x91:
            case 0x92:
            case 0x93:
            case 0x94:
            case 0x95:
            case 0x96:
            case 0x97:
N
Niels Lohmann 已提交
8639
            {
8640
                basic_json result = value_t::array;
8641
                const auto len = static_cast<size_t>(v[current_idx] - 0x80);
8642 8643 8644 8645 8646
                for (size_t i = 0; i < len; ++i)
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                return result;
N
Niels Lohmann 已提交
8647
            }
8648

N
Niels Lohmann 已提交
8649
            case 0x98: // array (one-byte uint8_t for n follows)
N
Niels Lohmann 已提交
8650
            {
8651
                basic_json result = value_t::array;
8652
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
8653 8654 8655 8656 8657 8658
                idx += 1; // skip 1 size byte
                for (size_t i = 0; i < len; ++i)
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                return result;
N
Niels Lohmann 已提交
8659 8660
            }

N
Niels Lohmann 已提交
8661
            case 0x99: // array (two-byte uint16_t for n follow)
8662 8663
            {
                basic_json result = value_t::array;
8664
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
8665 8666 8667 8668 8669 8670 8671 8672
                idx += 2; // skip 4 size bytes
                for (size_t i = 0; i < len; ++i)
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                return result;
            }

N
Niels Lohmann 已提交
8673
            case 0x9a: // array (four-byte uint32_t for n follow)
8674 8675
            {
                basic_json result = value_t::array;
8676
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
8677 8678 8679 8680 8681 8682 8683 8684
                idx += 4; // skip 4 size bytes
                for (size_t i = 0; i < len; ++i)
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                return result;
            }

N
Niels Lohmann 已提交
8685
            case 0x9b: // array (eight-byte uint64_t for n follow)
8686 8687
            {
                basic_json result = value_t::array;
8688
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699
                idx += 8; // skip 8 size bytes
                for (size_t i = 0; i < len; ++i)
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                return result;
            }

            case 0x9f: // array (indefinite length)
            {
                basic_json result = value_t::array;
N
Niels Lohmann 已提交
8700
                while (static_cast<void>(check_length(v.size(), 1, idx)), v[idx] != 0xff)
8701 8702 8703 8704 8705 8706 8707 8708
                {
                    result.push_back(from_cbor_internal(v, idx));
                }
                // skip break byte (0xFF)
                idx += 1;
                return result;
            }

N
Niels Lohmann 已提交
8709
            // map (0x00..0x17 pairs of data items follow)
8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735
            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;
8736
                const auto len = static_cast<size_t>(v[current_idx] - 0xa0);
8737 8738
                for (size_t i = 0; i < len; ++i)
                {
8739
                    cbor_expect_string(v, idx);
8740 8741 8742 8743 8744 8745
                    std::string key = from_cbor_internal(v, idx);
                    result[key] = from_cbor_internal(v, idx);
                }
                return result;
            }

N
Niels Lohmann 已提交
8746
            case 0xb8: // map (one-byte uint8_t for n follows)
8747 8748
            {
                basic_json result = value_t::object;
8749
                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
8750 8751 8752
                idx += 1; // skip 1 size byte
                for (size_t i = 0; i < len; ++i)
                {
8753
                    cbor_expect_string(v, idx);
8754 8755 8756 8757 8758 8759
                    std::string key = from_cbor_internal(v, idx);
                    result[key] = from_cbor_internal(v, idx);
                }
                return result;
            }

N
Niels Lohmann 已提交
8760
            case 0xb9: // map (two-byte uint16_t for n follow)
8761 8762
            {
                basic_json result = value_t::object;
8763
                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
8764 8765 8766
                idx += 2; // skip 2 size bytes
                for (size_t i = 0; i < len; ++i)
                {
8767
                    cbor_expect_string(v, idx);
8768 8769 8770 8771 8772 8773
                    std::string key = from_cbor_internal(v, idx);
                    result[key] = from_cbor_internal(v, idx);
                }
                return result;
            }

N
Niels Lohmann 已提交
8774
            case 0xba: // map (four-byte uint32_t for n follow)
8775 8776
            {
                basic_json result = value_t::object;
8777
                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
8778 8779 8780
                idx += 4; // skip 4 size bytes
                for (size_t i = 0; i < len; ++i)
                {
8781
                    cbor_expect_string(v, idx);
8782 8783 8784 8785 8786 8787
                    std::string key = from_cbor_internal(v, idx);
                    result[key] = from_cbor_internal(v, idx);
                }
                return result;
            }

N
Niels Lohmann 已提交
8788
            case 0xbb: // map (eight-byte uint64_t for n follow)
8789 8790
            {
                basic_json result = value_t::object;
8791
                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
8792 8793 8794
                idx += 8; // skip 8 size bytes
                for (size_t i = 0; i < len; ++i)
                {
8795
                    cbor_expect_string(v, idx);
8796 8797 8798 8799 8800 8801 8802 8803 8804
                    std::string key = from_cbor_internal(v, idx);
                    result[key] = from_cbor_internal(v, idx);
                }
                return result;
            }

            case 0xbf: // map (indefinite length)
            {
                basic_json result = value_t::object;
N
Niels Lohmann 已提交
8805
                while (static_cast<void>(check_length(v.size(), 1, idx)), v[idx] != 0xff)
8806
                {
8807
                    cbor_expect_string(v, idx);
8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830
                    std::string key = from_cbor_internal(v, idx);
                    result[key] = from_cbor_internal(v, idx);
                }
                // skip break byte (0xFF)
                idx += 1;
                return result;
            }

            case 0xf4: // false
            {
                return false;
            }

            case 0xf5: // true
            {
                return true;
            }

            case 0xf6: // null
            {
                return value_t::null;
            }

N
Niels Lohmann 已提交
8831
            case 0xf9: // Half-Precision Float (two-byte IEEE 754)
8832 8833 8834 8835
            {
                idx += 2; // skip two content bytes

                // code from RFC 7049, Appendix D, Figure 3:
N
Niels Lohmann 已提交
8836 8837 8838 8839 8840 8841
                // 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.
8842 8843
                check_length(v.size(), 2, current_idx + 1);
                const int half = (v[current_idx + 1] << 8) + v[current_idx + 2];
8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856
                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
                {
8857 8858 8859
                    val = mant == 0
                          ? std::numeric_limits<double>::infinity()
                          : std::numeric_limits<double>::quiet_NaN();
8860
                }
N
Niels Lohmann 已提交
8861
                return (half & 0x8000) != 0 ? -val : val;
8862 8863
            }

N
Niels Lohmann 已提交
8864
            case 0xfa: // Single-Precision Float (four-byte IEEE 754)
8865 8866 8867
            {
                // copy bytes in reverse order into the float variable
                float res;
8868
                check_length(v.size(), sizeof(float), current_idx + 1);
8869 8870
                for (size_t byte = 0; byte < sizeof(float); ++byte)
                {
8871
                    reinterpret_cast<uint8_t*>(&res)[sizeof(float) - byte - 1] = v[current_idx + 1 + byte];
8872 8873 8874 8875 8876
                }
                idx += sizeof(float); // skip content bytes
                return res;
            }

N
Niels Lohmann 已提交
8877
            case 0xfb: // Double-Precision Float (eight-byte IEEE 754)
8878 8879 8880
            {
                // copy bytes in reverse order into the double variable
                double res;
8881
                check_length(v.size(), sizeof(double), current_idx + 1);
8882 8883
                for (size_t byte = 0; byte < sizeof(double); ++byte)
                {
8884
                    reinterpret_cast<uint8_t*>(&res)[sizeof(double) - byte - 1] = v[current_idx + 1 + byte];
8885 8886 8887 8888 8889
                }
                idx += sizeof(double); // skip content bytes
                return res;
            }

N
Niels Lohmann 已提交
8890
            default: // anything else (0xFF is handled inside the other types)
8891
            {
8892 8893
                std::stringstream ss;
                ss << std::hex << static_cast<int>(v[current_idx]);
8894
                JSON_THROW(parse_error::create(112, current_idx + 1, "error reading CBOR; last byte: 0x" + ss.str()));
8895 8896
            }
        }
N
Niels Lohmann 已提交
8897 8898
    }

N
Niels 已提交
8899 8900
  public:
    /*!
8901 8902 8903 8904 8905 8906
    @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.

8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955
    The library uses the following mapping from JSON values types to
    MessagePack types according to the MessagePack specification:

    JSON value type | value/range                       | MessagePack type | first byte
    --------------- | --------------------------------- | ---------------- | ----------
    null            | `null`                            | nil              | 0xc0
    boolean         | `true`                            | true             | 0xc3
    boolean         | `false`                           | false            | 0xc2
    number_integer  | -9223372036854775808..-2147483649 | int64            | 0xd3
    number_integer  | -2147483648..-32769               | int32            | 0xd2
    number_integer  | -32768..-129                      | int16            | 0xd1
    number_integer  | -128..-33                         | int8             | 0xd0
    number_integer  | -32..-1                           | negative fixint  | 0xe0..0xff
    number_integer  | 0..127                            | positive fixint  | 0x00..0x7f
    number_integer  | 128..255                          | uint 8           | 0xcc
    number_integer  | 256..65535                        | uint 16          | 0xcd
    number_integer  | 65536..4294967295                 | uint 32          | 0xce
    number_integer  | 4294967296..18446744073709551615  | uint 64          | 0xcf
    number_unsigned | 0..127                            | positive fixint  | 0x00..0x7f
    number_unsigned | 128..255                          | uint 8           | 0xcc
    number_unsigned | 256..65535                        | uint 16          | 0xcd
    number_unsigned | 65536..4294967295                 | uint 32          | 0xce
    number_unsigned | 4294967296..18446744073709551615  | uint 64          | 0xcf
    number_float    | *any value*                       | float 64         | 0xcb
    string          | *length*: 0..31                   | fixstr           | 0xa0..0xbf
    string          | *length*: 32..255                 | str 8            | 0xd9
    string          | *length*: 256..65535              | str 16           | 0xda
    string          | *length*: 65536..4294967295       | str 32           | 0xdb
    array           | *size*: 0..15                     | fixarray         | 0x90..0x9f
    array           | *size*: 16..65535                 | array 16         | 0xdc
    array           | *size*: 65536..4294967295         | array 32         | 0xdd
    object          | *size*: 0..15                     | fix map          | 0x80..0x8f
    object          | *size*: 16..65535                 | map 16           | 0xde
    object          | *size*: 65536..4294967295         | map 32           | 0xdf

    @note The mapping is **complete** in the sense that any JSON value type
          can be converted to a MessagePack value.

    @note The following values can **not** be converted to a MessagePack value:
          - strings with more than 4294967295 bytes
          - arrays with more than 4294967295 elements
          - objects with more than 4294967295 elements

    @note The following MessagePack types are not used in the conversion:
          - bin 8 - bin 32 (0xc4..0xc6)
          - ext 8 - ext 32 (0xc7..0xc9)
          - float 32 (0xca)
          - fixext 1 - fixext 16 (0xd4..0xd8)

8956 8957 8958
    @note Any MessagePack output created @ref to_msgpack can be successfully
          parsed by @ref from_msgpack.

N
Niels 已提交
8959
    @param[in] j  JSON value to serialize
8960 8961 8962 8963 8964 8965 8966 8967
    @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
8968 8969
    @sa @ref from_msgpack(const std::vector<uint8_t>&, const size_t) for the
        analogous deserialization
8970
    @sa @ref to_cbor(const basic_json& for the related CBOR format
8971 8972

    @since version 2.0.9
N
Niels 已提交
8973 8974 8975 8976 8977 8978 8979 8980
    */
    static std::vector<uint8_t> to_msgpack(const basic_json& j)
    {
        std::vector<uint8_t> result;
        to_msgpack_internal(j, result);
        return result;
    }

8981 8982 8983 8984 8985 8986
    /*!
    @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.

8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026
    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.

9027
    @param[in] v  a byte vector in MessagePack format
9028
    @param[in] start_index the index to start reading from @a v (0 by default)
9029 9030
    @return deserialized JSON value

N
Niels Lohmann 已提交
9031 9032
    @throw parse_error.110 if the given vector ends prematurely
    @throw parse_error.112 if unsupported features from MessagePack were
9033
    used in the given vector @a v or if the input is not valid MessagePack
9034
    @throw parse_error.113 if a string was expected as map key, but not found
9035 9036 9037 9038 9039 9040 9041 9042

    @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
9043 9044 9045
    @sa @ref from_cbor(const std::vector<uint8_t>&, const size_t) for the
        related CBOR format

N
Niels Lohmann 已提交
9046
    @since version 2.0.9, parameter @a start_index since 2.1.1
9047
    */
9048 9049
    static basic_json from_msgpack(const std::vector<uint8_t>& v,
                                   const size_t start_index = 0)
N
Niels 已提交
9050
    {
9051
        size_t i = start_index;
N
Niels 已提交
9052 9053 9054
        return from_msgpack_internal(v, i);
    }

N
Niels Lohmann 已提交
9055
    /*!
9056 9057 9058 9059 9060 9061 9062
    @brief create a MessagePack serialization of a given JSON value

    Serializes a given JSON value @a j to a byte vector using the CBOR (Concise
    Binary Object Representation) serialization format. CBOR is a binary
    serialization format which aims to be more compact than JSON itself, yet
    more efficient to parse.

9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121
    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)

N
Niels Lohmann 已提交
9122
    @param[in] j  JSON value to serialize
9123 9124 9125 9126 9127 9128 9129 9130
    @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
9131 9132
    @sa @ref from_cbor(const std::vector<uint8_t>&, const size_t) for the
        analogous deserialization
9133
    @sa @ref to_msgpack(const basic_json& for the related MessagePack format
9134 9135

    @since version 2.0.9
N
Niels Lohmann 已提交
9136 9137 9138 9139 9140 9141 9142 9143
    */
    static std::vector<uint8_t> to_cbor(const basic_json& j)
    {
        std::vector<uint8_t> result;
        to_cbor_internal(j, result);
        return result;
    }

9144 9145 9146 9147 9148 9149
    /*!
    @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.

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
    The library maps CBOR types to JSON value types as follows:

    CBOR type              | JSON value type | first byte
    ---------------------- | --------------- | ----------
    Integer                | number_unsigned | 0x00..0x17
    Unsigned integer       | number_unsigned | 0x18
    Unsigned integer       | number_unsigned | 0x19
    Unsigned integer       | number_unsigned | 0x1a
    Unsigned integer       | number_unsigned | 0x1b
    Negative integer       | number_integer  | 0x20..0x37
    Negative integer       | number_integer  | 0x38
    Negative integer       | number_integer  | 0x39
    Negative integer       | number_integer  | 0x3a
    Negative integer       | number_integer  | 0x3b
    Negative integer       | number_integer  | 0x40..0x57
    UTF-8 string           | string          | 0x60..0x77
    UTF-8 string           | string          | 0x78
    UTF-8 string           | string          | 0x79
    UTF-8 string           | string          | 0x7a
    UTF-8 string           | string          | 0x7b
    UTF-8 string           | string          | 0x7f
    array                  | array           | 0x80..0x97
    array                  | array           | 0x98
    array                  | array           | 0x99
    array                  | array           | 0x9a
    array                  | array           | 0x9b
    array                  | array           | 0x9f
    map                    | object          | 0xa0..0xb7
    map                    | object          | 0xb8
    map                    | object          | 0xb9
    map                    | object          | 0xba
    map                    | object          | 0xbb
    map                    | object          | 0xbf
    False                  | `false`         | 0xf4
    True                   | `true`          | 0xf5
    Nill                   | `null`          | 0xf6
    Half-Precision Float   | number_float    | 0xf9
    Single-Precision Float | number_float    | 0xfa
    Double-Precision Float | number_float    | 0xfb

    @warning The mapping is **incomplete** in the sense that not all CBOR
             types can be converted to a JSON value. The following CBOR types
             are not supported and will yield parse errors (parse_error.112):
             - byte strings (0x40..0x5f)
             - date/time (0xc0..0xc1)
             - bignum (0xc2..0xc3)
             - decimal fraction (0xc4)
             - bigfloat (0xc5)
             - tagged items (0xc6..0xd4, 0xd8..0xdb)
             - expected conversions (0xd5..0xd7)
             - simple values (0xe0..0xf3, 0xf8)
             - undefined (0xf7)

    @warning CBOR allows map keys of any type, whereas JSON only allows
             strings as keys in object values. Therefore, CBOR maps with keys
             other than UTF-8 strings are rejected (parse_error.113).

    @note Any CBOR output created @ref to_cbor can be successfully parsed by
          @ref from_cbor.

9210
    @param[in] v  a byte vector in CBOR format
9211
    @param[in] start_index the index to start reading from @a v (0 by default)
9212 9213
    @return deserialized JSON value

N
Niels Lohmann 已提交
9214 9215 9216
    @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
9217
    @throw parse_error.113 if a string was expected as map key, but not found
9218 9219 9220 9221 9222 9223 9224 9225

    @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
9226 9227 9228
    @sa @ref from_msgpack(const std::vector<uint8_t>&, const size_t) for the
        related MessagePack format

N
Niels Lohmann 已提交
9229
    @since version 2.0.9, parameter @a start_index since 2.1.1
9230
    */
N
Niels Lohmann 已提交
9231 9232 9233 9234 9235 9236
    //static basic_json from_cbor(const std::vector<uint8_t>& v,
    //                            const size_t start_index = 0)
    //{
    //    size_t i = start_index;
    //    return from_cbor_internal(v, i);
    //}
N
Niels Lohmann 已提交
9237

N
Niels 已提交
9238
    /// @}
N
Niels 已提交
9239 9240 9241 9242 9243

    ///////////////////////////
    // convenience functions //
    ///////////////////////////

N
Niels 已提交
9244 9245 9246 9247 9248 9249
    /*!
    @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 已提交
9250
    @return basically a string representation of a the @a m_type member
N
Niels 已提交
9251 9252 9253

    @complexity Constant.

9254
    @liveexample{The following code exemplifies `type_name()` for all JSON
9255
    types.,type_name}
9256

9257
    @since version 1.0.0, public since 2.1.0
N
Niels 已提交
9258
    */
T
Théo DELRIEU 已提交
9259 9260
    std::string type_name() const
    {
T
Théo DELRIEU 已提交
9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279
        {
            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 已提交
9280
    }
N
Niels 已提交
9281 9282 9283 9284 9285 9286 9287 9288


  private:
    //////////////////////
    // member variables //
    //////////////////////

    /// the type of the current element
N
Niels 已提交
9289
    value_t m_type = value_t::null;
N
Niels 已提交
9290 9291 9292 9293

    /// the value of the current element
    json_value m_value = {};

N
Niels 已提交
9294

N
Niels 已提交
9295
  private:
N
Niels 已提交
9296 9297 9298 9299
    ///////////////
    // iterators //
    ///////////////

9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310
    /*!
    @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 已提交
9311
      public:
T
Théo Delrieu 已提交
9312 9313

        difference_type get_value() const noexcept
T
Théo DELRIEU 已提交
9314 9315 9316 9317 9318 9319 9320 9321
        {
            return m_it;
        }
        /// set iterator to a defined beginning
        void set_begin() noexcept
        {
            m_it = begin_value;
        }
9322

T
Théo DELRIEU 已提交
9323 9324 9325 9326 9327
        /// set iterator to a defined past the end
        void set_end() noexcept
        {
            m_it = end_value;
        }
9328

T
Théo DELRIEU 已提交
9329 9330 9331 9332 9333
        /// return whether the iterator can be dereferenced
        constexpr bool is_begin() const noexcept
        {
            return (m_it == begin_value);
        }
9334

T
Théo DELRIEU 已提交
9335 9336 9337 9338 9339
        /// return whether the iterator is at end
        constexpr bool is_end() const noexcept
        {
            return (m_it == end_value);
        }
9340

T
Théo DELRIEU 已提交
9341 9342 9343 9344
        friend constexpr bool operator==(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it == rhs.m_it;
        }
T
Théo Delrieu 已提交
9345

T
Théo DELRIEU 已提交
9346 9347 9348 9349
        friend constexpr bool operator!=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return !(lhs == rhs);
        }
T
Théo Delrieu 已提交
9350

T
Théo DELRIEU 已提交
9351 9352 9353 9354
        friend constexpr bool operator<(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it < rhs.m_it;
        }
T
Théo Delrieu 已提交
9355

T
Théo DELRIEU 已提交
9356 9357 9358 9359
        friend constexpr bool operator<=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it <= rhs.m_it;
        }
T
Théo Delrieu 已提交
9360

T
Théo DELRIEU 已提交
9361 9362 9363 9364
        friend constexpr bool operator>(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it > rhs.m_it;
        }
T
Théo Delrieu 已提交
9365

T
Théo DELRIEU 已提交
9366 9367 9368 9369
        friend constexpr bool operator>=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
        {
            return lhs.m_it >= rhs.m_it;
        }
T
Théo Delrieu 已提交
9370

T
Théo DELRIEU 已提交
9371 9372 9373 9374 9375 9376
        primitive_iterator_t operator+(difference_type i)
        {
            auto result = *this;
            result += i;
            return result;
        }
T
Théo Delrieu 已提交
9377

T
Théo DELRIEU 已提交
9378 9379 9380 9381
        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 已提交
9382

T
Théo DELRIEU 已提交
9383 9384 9385 9386
        friend std::ostream& operator<<(std::ostream& os, primitive_iterator_t it)
        {
            return os << it.m_it;
        }
T
Théo Delrieu 已提交
9387

T
Théo DELRIEU 已提交
9388 9389 9390 9391 9392
        primitive_iterator_t& operator++()
        {
            ++m_it;
            return *this;
        }
T
Théo Delrieu 已提交
9393

N
Niels Lohmann 已提交
9394
        primitive_iterator_t operator++(int)
T
Théo DELRIEU 已提交
9395
        {
N
Niels Lohmann 已提交
9396
            auto result = *this;
T
Théo DELRIEU 已提交
9397
            m_it++;
N
Niels Lohmann 已提交
9398
            return result;
T
Théo DELRIEU 已提交
9399
        }
T
Théo Delrieu 已提交
9400

T
Théo DELRIEU 已提交
9401 9402 9403 9404 9405
        primitive_iterator_t& operator--()
        {
            --m_it;
            return *this;
        }
T
Théo Delrieu 已提交
9406

N
Niels Lohmann 已提交
9407
        primitive_iterator_t operator--(int)
T
Théo DELRIEU 已提交
9408
        {
N
Niels Lohmann 已提交
9409
            auto result = *this;
T
Théo DELRIEU 已提交
9410
            m_it--;
N
Niels Lohmann 已提交
9411
            return result;
T
Théo DELRIEU 已提交
9412
        }
T
Théo Delrieu 已提交
9413

T
Théo DELRIEU 已提交
9414 9415 9416 9417 9418
        primitive_iterator_t& operator+=(difference_type n)
        {
            m_it += n;
            return *this;
        }
9419

T
Théo DELRIEU 已提交
9420 9421 9422 9423 9424
        primitive_iterator_t& operator-=(difference_type n)
        {
            m_it -= n;
            return *this;
        }
9425

T
Théo DELRIEU 已提交
9426 9427 9428
      private:
        static constexpr difference_type begin_value = 0;
        static constexpr difference_type end_value = begin_value + 1;
9429

T
Théo DELRIEU 已提交
9430 9431 9432
        /// iterator as signed integer type
        difference_type m_it = std::numeric_limits<std::ptrdiff_t>::denorm_min();
    };
9433

N
Niels 已提交
9434 9435 9436 9437 9438 9439 9440 9441
    /*!
    @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 已提交
9442 9443
    {
        /// iterator for JSON objects
N
Niels 已提交
9444
        typename object_t::iterator object_iterator;
N
Niels 已提交
9445
        /// iterator for JSON arrays
N
Niels 已提交
9446
        typename array_t::iterator array_iterator;
N
Niels 已提交
9447
        /// generic iterator for all other types
N
Niels 已提交
9448 9449 9450
        primitive_iterator_t primitive_iterator;

        /// create an uninitialized internal_iterator
N
Niels 已提交
9451
        internal_iterator() noexcept
T
Théo DELRIEU 已提交
9452 9453
            : object_iterator(), array_iterator(), primitive_iterator()
        {}
N
Niels 已提交
9454 9455
    };

N
cleanup  
Niels 已提交
9456 9457 9458 9459
    /// proxy class for the iterator_wrapper functions
    template<typename IteratorType>
    class iteration_proxy
    {
T
Théo DELRIEU 已提交
9460
      private:
N
cleanup  
Niels 已提交
9461 9462 9463
        /// helper class for iteration
        class iteration_proxy_internal
        {
T
Théo DELRIEU 已提交
9464
          private:
N
cleanup  
Niels 已提交
9465 9466 9467 9468 9469
            /// the iterator
            IteratorType anchor;
            /// an index for arrays (used to create key names)
            size_t array_index = 0;

T
Théo DELRIEU 已提交
9470
          public:
N
Niels 已提交
9471
            explicit iteration_proxy_internal(IteratorType it) noexcept
T
Théo DELRIEU 已提交
9472 9473
                : anchor(it)
            {}
N
cleanup  
Niels 已提交
9474

T
Théo DELRIEU 已提交
9475 9476 9477 9478 9479
            /// dereference operator (needed for range-based for)
            iteration_proxy_internal& operator*()
            {
                return *this;
            }
9480

T
Théo DELRIEU 已提交
9481 9482 9483 9484 9485
            /// increment operator (needed for range-based for)
            iteration_proxy_internal& operator++()
            {
                ++anchor;
                ++array_index;
9486

T
Théo DELRIEU 已提交
9487 9488
                return *this;
            }
N
cleanup  
Niels 已提交
9489

T
Théo DELRIEU 已提交
9490 9491
            /// inequality operator (needed for range-based for)
            bool operator!= (const iteration_proxy_internal& o) const
N
cleanup  
Niels 已提交
9492
            {
T
Théo DELRIEU 已提交
9493
                return anchor != o.anchor;
N
cleanup  
Niels 已提交
9494 9495
            }

T
Théo DELRIEU 已提交
9496 9497
            /// return key of the iterator
            typename basic_json::string_t key() const
N
cleanup  
Niels 已提交
9498
            {
T
Théo DELRIEU 已提交
9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520
                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 已提交
9521 9522
            }

T
Théo DELRIEU 已提交
9523 9524
            /// return value of the iterator
            typename IteratorType::reference value() const
N
cleanup  
Niels 已提交
9525
            {
T
Théo DELRIEU 已提交
9526
                return anchor.value();
N
cleanup  
Niels 已提交
9527 9528 9529
            }
        };

T
Théo DELRIEU 已提交
9530 9531
        /// the container to iterate
        typename IteratorType::reference container;
N
cleanup  
Niels 已提交
9532

T
Théo DELRIEU 已提交
9533 9534 9535 9536 9537
      public:
        /// construct iteration proxy from a container
        explicit iteration_proxy(typename IteratorType::reference cont)
            : container(cont)
        {}
N
cleanup  
Niels 已提交
9538

T
Théo DELRIEU 已提交
9539 9540 9541 9542 9543
        /// return iterator begin (needed for range-based for)
        iteration_proxy_internal begin() noexcept
        {
            return iteration_proxy_internal(container.begin());
        }
N
cleanup  
Niels 已提交
9544

T
Théo DELRIEU 已提交
9545 9546 9547 9548 9549 9550
        /// return iterator end (needed for range-based for)
        iteration_proxy_internal end() noexcept
        {
            return iteration_proxy_internal(container.end());
        }
    };
N
cleanup  
Niels 已提交
9551

N
Niels 已提交
9552
  public:
N
Niels 已提交
9553
    /*!
9554
    @brief a template for a random access iterator for the @ref basic_json class
N
Niels 已提交
9555

N
Niels Lohmann 已提交
9556 9557
    This class implements a both iterators (iterator and const_iterator) for the
    @ref basic_json class.
N
Niels 已提交
9558

N
Niels 已提交
9559 9560 9561
    @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 已提交
9562 9563
          methods are undefined. **The library uses assertions to detect calls
          on uninitialized iterators.**
N
Niels 已提交
9564

N
Niels 已提交
9565 9566 9567 9568
    @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 已提交
9569

N
Niels Lohmann 已提交
9570
    @since version 1.0.0, simplified in version 2.0.9
N
Niels 已提交
9571
    */
N
Niels Lohmann 已提交
9572
    template<typename U>
T
Théo DELRIEU 已提交
9573
    class iter_impl : public std::iterator<std::random_access_iterator_tag, U>
N
Niels 已提交
9574
    {
N
Niels 已提交
9575
        /// allow basic_json to access private members
9576 9577
        friend class basic_json;

9578 9579 9580 9581 9582
        // 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 已提交
9583
      public:
N
Niels 已提交
9584
        /// the type of the values when the iterator is dereferenced
N
Niels 已提交
9585
        using value_type = typename basic_json::value_type;
N
Niels 已提交
9586
        /// a type to represent differences between iterators
N
Niels 已提交
9587
        using difference_type = typename basic_json::difference_type;
N
Niels 已提交
9588
        /// defines a pointer to the type iterated over (value_type)
9589
        using pointer = typename std::conditional<std::is_const<U>::value,
T
Théo DELRIEU 已提交
9590 9591
              typename basic_json::const_pointer,
              typename basic_json::pointer>::type;
N
Niels 已提交
9592
        /// defines a reference to the type iterated over (value_type)
9593
        using reference = typename std::conditional<std::is_const<U>::value,
T
Théo DELRIEU 已提交
9594 9595
              typename basic_json::const_reference,
              typename basic_json::reference>::type;
N
Niels 已提交
9596
        /// the category of the iterator
N
Niels 已提交
9597
        using iterator_category = std::bidirectional_iterator_tag;
N
Niels 已提交
9598

9599
        /// default constructor
9600
        iter_impl() = default;
9601

N
Niels 已提交
9602 9603 9604 9605 9606 9607
        /*!
        @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`.
        */
9608
        explicit iter_impl(pointer object) noexcept
T
Théo DELRIEU 已提交
9609
            : m_object(object)
9610
        {
T
Théo DELRIEU 已提交
9611
            assert(m_object != nullptr);
9612

T
Théo DELRIEU 已提交
9613
            switch (m_object->m_type)
9614
            {
T
Théo DELRIEU 已提交
9615 9616 9617 9618 9619
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = typename object_t::iterator();
                    break;
                }
9620

T
Théo DELRIEU 已提交
9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631
                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 已提交
9632 9633
            }
        }
N
Niels 已提交
9634

T
Théo DELRIEU 已提交
9635 9636 9637 9638
        /*
        Use operator `const_iterator` instead of `const_iterator(const iterator&
        other) noexcept` to avoid two class definitions for @ref iterator and
        @ref const_iterator.
9639

T
Théo DELRIEU 已提交
9640 9641 9642 9643
        This function is only called if this class is an @ref iterator. If this
        class is a @ref const_iterator this function is not called.
        */
        operator const_iterator() const
N
Niels Lohmann 已提交
9644
        {
T
Théo DELRIEU 已提交
9645
            const_iterator ret;
N
Niels 已提交
9646

T
Théo DELRIEU 已提交
9647 9648 9649 9650 9651
            if (m_object)
            {
                ret.m_object = m_object;
                ret.m_it = m_it;
            }
9652

T
Théo DELRIEU 已提交
9653 9654
            return ret;
        }
N
Niels 已提交
9655

T
Théo DELRIEU 已提交
9656 9657 9658 9659 9660 9661 9662 9663
        /*!
        @brief copy constructor
        @param[in] other  iterator to copy from
        @note It is not checked whether @a other is initialized.
        */
        iter_impl(const iter_impl& other) noexcept
            : m_object(other.m_object), m_it(other.m_it)
        {}
N
Niels 已提交
9664

T
Théo DELRIEU 已提交
9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680
        /*!
        @brief copy assignment
        @param[in,out] other  iterator to copy from
        @note It is not checked whether @a other is initialized.
        */
        iter_impl& operator=(iter_impl other) noexcept(
            std::is_nothrow_move_constructible<pointer>::value and
            std::is_nothrow_move_assignable<pointer>::value and
            std::is_nothrow_move_constructible<internal_iterator>::value and
            std::is_nothrow_move_assignable<internal_iterator>::value
        )
        {
            std::swap(m_object, other.m_object);
            std::swap(m_it, other.m_it);
            return *this;
        }
N
Niels 已提交
9681

T
Théo DELRIEU 已提交
9682 9683 9684 9685 9686 9687
      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 已提交
9688
        {
T
Théo DELRIEU 已提交
9689
            assert(m_object != nullptr);
N
Niels 已提交
9690

T
Théo DELRIEU 已提交
9691
            switch (m_object->m_type)
N
Niels 已提交
9692
            {
T
Théo DELRIEU 已提交
9693 9694 9695 9696 9697
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = m_object->m_value.object->begin();
                    break;
                }
N
Niels 已提交
9698

T
Théo DELRIEU 已提交
9699 9700 9701 9702 9703
                case basic_json::value_t::array:
                {
                    m_it.array_iterator = m_object->m_value.array->begin();
                    break;
                }
N
Niels 已提交
9704

T
Théo DELRIEU 已提交
9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716
                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 已提交
9717 9718 9719
            }
        }

T
Théo DELRIEU 已提交
9720 9721 9722 9723 9724
        /*!
        @brief set the iterator past the last value
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        void set_end() noexcept
9725
        {
T
Théo DELRIEU 已提交
9726
            assert(m_object != nullptr);
N
Niels 已提交
9727

T
Théo DELRIEU 已提交
9728
            switch (m_object->m_type)
9729
            {
T
Théo DELRIEU 已提交
9730 9731 9732 9733 9734
                case basic_json::value_t::object:
                {
                    m_it.object_iterator = m_object->m_value.object->end();
                    break;
                }
N
Niels 已提交
9735

T
Théo DELRIEU 已提交
9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746
                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 已提交
9747 9748
            }
        }
N
Niels 已提交
9749

T
Théo DELRIEU 已提交
9750 9751 9752 9753 9754 9755
      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
9756
        {
T
Théo DELRIEU 已提交
9757
            assert(m_object != nullptr);
N
Niels 已提交
9758

T
Théo DELRIEU 已提交
9759
            switch (m_object->m_type)
9760
            {
T
Théo DELRIEU 已提交
9761 9762 9763 9764 9765
                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 已提交
9766

T
Théo DELRIEU 已提交
9767 9768 9769 9770 9771
                case basic_json::value_t::array:
                {
                    assert(m_it.array_iterator != m_object->m_value.array->end());
                    return *m_it.array_iterator;
                }
N
Niels 已提交
9772

T
Théo DELRIEU 已提交
9773
                case basic_json::value_t::null:
N
Niels 已提交
9774
                {
9775
                    JSON_THROW(invalid_iterator::create(214, "cannot get value"));
N
Niels 已提交
9776 9777
                }

T
Théo DELRIEU 已提交
9778 9779 9780 9781 9782 9783 9784
                default:
                {
                    if (m_it.primitive_iterator.is_begin())
                    {
                        return *m_object;
                    }

9785
                    JSON_THROW(invalid_iterator::create(214, "cannot get value"));
T
Théo DELRIEU 已提交
9786
                }
N
Niels 已提交
9787 9788 9789
            }
        }

T
Théo DELRIEU 已提交
9790 9791 9792 9793 9794
        /*!
        @brief dereference the iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        pointer operator->() const
N
Niels 已提交
9795
        {
T
Théo DELRIEU 已提交
9796
            assert(m_object != nullptr);
N
Niels 已提交
9797

T
Théo DELRIEU 已提交
9798
            switch (m_object->m_type)
N
Niels 已提交
9799
            {
T
Théo DELRIEU 已提交
9800 9801 9802 9803 9804
                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 已提交
9805

T
Théo DELRIEU 已提交
9806
                case basic_json::value_t::array:
N
Niels 已提交
9807
                {
T
Théo DELRIEU 已提交
9808 9809
                    assert(m_it.array_iterator != m_object->m_value.array->end());
                    return &*m_it.array_iterator;
N
Niels 已提交
9810 9811
                }

T
Théo DELRIEU 已提交
9812 9813 9814 9815 9816 9817 9818
                default:
                {
                    if (m_it.primitive_iterator.is_begin())
                    {
                        return m_object;
                    }

9819
                    JSON_THROW(invalid_iterator::create(214, "cannot get value"));
T
Théo DELRIEU 已提交
9820
                }
N
Niels 已提交
9821 9822 9823
            }
        }

T
Théo DELRIEU 已提交
9824 9825 9826 9827 9828 9829 9830 9831 9832 9833
        /*!
        @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 已提交
9834

T
Théo DELRIEU 已提交
9835 9836 9837 9838 9839
        /*!
        @brief pre-increment (++it)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator++()
9840
        {
T
Théo DELRIEU 已提交
9841
            assert(m_object != nullptr);
N
Niels 已提交
9842

T
Théo DELRIEU 已提交
9843
            switch (m_object->m_type)
9844
            {
T
Théo DELRIEU 已提交
9845 9846 9847 9848 9849
                case basic_json::value_t::object:
                {
                    std::advance(m_it.object_iterator, 1);
                    break;
                }
N
Niels 已提交
9850

T
Théo DELRIEU 已提交
9851 9852 9853 9854 9855
                case basic_json::value_t::array:
                {
                    std::advance(m_it.array_iterator, 1);
                    break;
                }
N
Niels 已提交
9856

T
Théo DELRIEU 已提交
9857 9858 9859 9860 9861 9862
                default:
                {
                    ++m_it.primitive_iterator;
                    break;
                }
            }
9863

T
Théo DELRIEU 已提交
9864 9865
            return *this;
        }
9866

T
Théo DELRIEU 已提交
9867 9868 9869 9870 9871 9872 9873 9874 9875 9876
        /*!
        @brief post-decrement (it--)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl operator--(int)
        {
            auto result = *this;
            --(*this);
            return result;
        }
9877

T
Théo DELRIEU 已提交
9878 9879 9880 9881 9882
        /*!
        @brief pre-decrement (--it)
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator--()
N
Niels 已提交
9883
        {
T
Théo DELRIEU 已提交
9884 9885 9886
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
9887
            {
T
Théo DELRIEU 已提交
9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904
                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 已提交
9905 9906
            }

T
Théo DELRIEU 已提交
9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917
            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 已提交
9918
            {
9919
                JSON_THROW(invalid_iterator::create(212, "cannot compare iterators of different containers"));
9920
            }
N
Niels 已提交
9921

T
Théo DELRIEU 已提交
9922 9923 9924
            assert(m_object != nullptr);

            switch (m_object->m_type)
9925
            {
T
Théo DELRIEU 已提交
9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939
                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 已提交
9940 9941 9942
            }
        }

T
Théo DELRIEU 已提交
9943 9944 9945 9946 9947
        /*!
        @brief  comparison: not equal
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator!=(const iter_impl& other) const
N
Niels 已提交
9948
        {
T
Théo DELRIEU 已提交
9949
            return not operator==(other);
N
Niels 已提交
9950 9951
        }

T
Théo DELRIEU 已提交
9952 9953 9954 9955 9956
        /*!
        @brief  comparison: smaller
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator<(const iter_impl& other) const
N
Niels 已提交
9957
        {
T
Théo DELRIEU 已提交
9958 9959
            // if objects are not the same, the comparison is undefined
            if (m_object != other.m_object)
N
Niels 已提交
9960
            {
9961
                JSON_THROW(invalid_iterator::create(212, "cannot compare iterators of different containers"));
N
Niels 已提交
9962 9963
            }

T
Théo DELRIEU 已提交
9964
            assert(m_object != nullptr);
N
Niels 已提交
9965

T
Théo DELRIEU 已提交
9966
            switch (m_object->m_type)
9967
            {
T
Théo DELRIEU 已提交
9968 9969
                case basic_json::value_t::object:
                {
9970
                    JSON_THROW(invalid_iterator::create(213, "cannot compare order of object iterators"));
T
Théo DELRIEU 已提交
9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981
                }

                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 已提交
9982 9983 9984
            }
        }

T
Théo DELRIEU 已提交
9985 9986 9987 9988 9989
        /*!
        @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 已提交
9990
        {
T
Théo DELRIEU 已提交
9991
            return not other.operator < (*this);
N
Niels 已提交
9992 9993
        }

T
Théo DELRIEU 已提交
9994 9995 9996 9997 9998
        /*!
        @brief  comparison: greater than
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        bool operator>(const iter_impl& other) const
N
Niels 已提交
9999
        {
T
Théo DELRIEU 已提交
10000
            return not operator<=(other);
N
Niels 已提交
10001
        }
10002

T
Théo DELRIEU 已提交
10003 10004 10005 10006 10007 10008 10009 10010
        /*!
        @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);
        }
10011

T
Théo DELRIEU 已提交
10012 10013 10014 10015 10016
        /*!
        @brief  add to iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator+=(difference_type i)
N
Niels 已提交
10017
        {
T
Théo DELRIEU 已提交
10018 10019 10020
            assert(m_object != nullptr);

            switch (m_object->m_type)
10021
            {
T
Théo DELRIEU 已提交
10022 10023
                case basic_json::value_t::object:
                {
10024
                    JSON_THROW(invalid_iterator::create(209, "cannot use offsets with object iterators"));
T
Théo DELRIEU 已提交
10025
                }
10026

T
Théo DELRIEU 已提交
10027 10028 10029 10030 10031
                case basic_json::value_t::array:
                {
                    std::advance(m_it.array_iterator, i);
                    break;
                }
10032

T
Théo DELRIEU 已提交
10033 10034 10035 10036 10037
                default:
                {
                    m_it.primitive_iterator += i;
                    break;
                }
10038 10039
            }

T
Théo DELRIEU 已提交
10040 10041
            return *this;
        }
10042

T
Théo DELRIEU 已提交
10043 10044 10045 10046 10047 10048 10049 10050
        /*!
        @brief  subtract from iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl& operator-=(difference_type i)
        {
            return operator+=(-i);
        }
10051

T
Théo DELRIEU 已提交
10052 10053 10054 10055 10056 10057 10058 10059 10060 10061
        /*!
        @brief  add to iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl operator+(difference_type i)
        {
            auto result = *this;
            result += i;
            return result;
        }
10062

T
Théo DELRIEU 已提交
10063 10064 10065 10066 10067 10068 10069 10070 10071 10072
        /*!
        @brief  subtract from iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        iter_impl operator-(difference_type i)
        {
            auto result = *this;
            result -= i;
            return result;
        }
N
Niels 已提交
10073

T
Théo DELRIEU 已提交
10074 10075 10076 10077 10078
        /*!
        @brief  return difference
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        difference_type operator-(const iter_impl& other) const
10079
        {
T
Théo DELRIEU 已提交
10080 10081 10082
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
10083
            {
T
Théo DELRIEU 已提交
10084 10085
                case basic_json::value_t::object:
                {
10086
                    JSON_THROW(invalid_iterator::create(209, "cannot use offsets with object iterators"));
T
Théo DELRIEU 已提交
10087
                }
N
Niels 已提交
10088

T
Théo DELRIEU 已提交
10089 10090 10091 10092
                case basic_json::value_t::array:
                {
                    return m_it.array_iterator - other.m_it.array_iterator;
                }
N
Niels 已提交
10093

T
Théo DELRIEU 已提交
10094 10095 10096 10097
                default:
                {
                    return m_it.primitive_iterator - other.m_it.primitive_iterator;
                }
N
Niels 已提交
10098 10099
            }
        }
N
Niels 已提交
10100

T
Théo DELRIEU 已提交
10101 10102 10103 10104 10105
        /*!
        @brief  access to successor
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        reference operator[](difference_type n) const
10106
        {
T
Théo DELRIEU 已提交
10107 10108 10109
            assert(m_object != nullptr);

            switch (m_object->m_type)
N
Niels 已提交
10110
            {
T
Théo DELRIEU 已提交
10111 10112
                case basic_json::value_t::object:
                {
10113
                    JSON_THROW(invalid_iterator::create(208, "cannot use operator[] for object iterators"));
T
Théo DELRIEU 已提交
10114
                }
N
Niels 已提交
10115

T
Théo DELRIEU 已提交
10116 10117 10118 10119
                case basic_json::value_t::array:
                {
                    return *std::next(m_it.array_iterator, n);
                }
N
Niels 已提交
10120

T
Théo DELRIEU 已提交
10121 10122
                case basic_json::value_t::null:
                {
10123
                    JSON_THROW(invalid_iterator::create(214, "cannot get value"));
T
Théo DELRIEU 已提交
10124
                }
N
Niels 已提交
10125

T
Théo DELRIEU 已提交
10126
                default:
N
Niels 已提交
10127
                {
T
Théo DELRIEU 已提交
10128 10129 10130 10131
                    if (m_it.primitive_iterator.get_value() == -n)
                    {
                        return *m_object;
                    }
N
Niels Lohmann 已提交
10132

10133
                    JSON_THROW(invalid_iterator::create(214, "cannot get value"));
T
Théo DELRIEU 已提交
10134
                }
N
Niels 已提交
10135 10136
            }
        }
N
Niels 已提交
10137

T
Théo DELRIEU 已提交
10138 10139 10140 10141 10142
        /*!
        @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
10143
        {
T
Théo DELRIEU 已提交
10144 10145 10146 10147 10148 10149
            assert(m_object != nullptr);

            if (m_object->is_object())
            {
                return m_it.object_iterator->first;
            }
N
Niels Lohmann 已提交
10150

10151
            JSON_THROW(invalid_iterator::create(207, "cannot use key() for non-object iterators"));
T
Théo DELRIEU 已提交
10152
        }
N
Niels 已提交
10153

T
Théo DELRIEU 已提交
10154 10155 10156 10157 10158 10159 10160 10161
        /*!
        @brief  return the value of an iterator
        @pre The iterator is initialized; i.e. `m_object != nullptr`.
        */
        reference value() const
        {
            return operator*();
        }
N
Niels 已提交
10162

T
Théo DELRIEU 已提交
10163 10164 10165 10166 10167 10168
      private:
        /// associated JSON instance
        pointer m_object = nullptr;
        /// the actual iterator of the associated instance
        internal_iterator m_it = internal_iterator();
    };
N
Niels 已提交
10169

N
Niels 已提交
10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183
    /*!
    @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 已提交
10184

N
Niels 已提交
10185
    @since version 1.0.0
N
Niels 已提交
10186
    */
N
Niels 已提交
10187
    template<typename Base>
T
Théo DELRIEU 已提交
10188
    class json_reverse_iterator : public std::reverse_iterator<Base>
10189
    {
T
Théo DELRIEU 已提交
10190
      public:
10191
        /// shortcut to the reverse iterator adaptor
N
Niels 已提交
10192
        using base_iterator = std::reverse_iterator<Base>;
N
Niels 已提交
10193
        /// the reference type for the pointed-to element
N
Niels 已提交
10194
        using reference = typename Base::reference;
10195

10196
        /// create reverse iterator from iterator
N
Niels 已提交
10197
        json_reverse_iterator(const typename base_iterator::iterator_type& it) noexcept
T
Théo DELRIEU 已提交
10198 10199
            : base_iterator(it)
        {}
10200

T
Théo DELRIEU 已提交
10201 10202 10203 10204
        /// create reverse iterator from base class
        json_reverse_iterator(const base_iterator& it) noexcept
            : base_iterator(it)
        {}
10205

T
Théo DELRIEU 已提交
10206 10207 10208 10209 10210
        /// post-increment (it++)
        json_reverse_iterator operator++(int)
        {
            return base_iterator::operator++(1);
        }
10211

T
Théo DELRIEU 已提交
10212 10213 10214 10215 10216 10217
        /// pre-increment (++it)
        json_reverse_iterator& operator++()
        {
            base_iterator::operator++();
            return *this;
        }
10218

T
Théo DELRIEU 已提交
10219 10220 10221 10222 10223
        /// post-decrement (it--)
        json_reverse_iterator operator--(int)
        {
            return base_iterator::operator--(1);
        }
10224

T
Théo DELRIEU 已提交
10225 10226 10227 10228 10229 10230
        /// pre-decrement (--it)
        json_reverse_iterator& operator--()
        {
            base_iterator::operator--();
            return *this;
        }
10231

T
Théo DELRIEU 已提交
10232 10233 10234 10235 10236 10237
        /// add to iterator
        json_reverse_iterator& operator+=(difference_type i)
        {
            base_iterator::operator+=(i);
            return *this;
        }
10238

T
Théo DELRIEU 已提交
10239 10240 10241 10242 10243 10244 10245
        /// add to iterator
        json_reverse_iterator operator+(difference_type i) const
        {
            auto result = *this;
            result += i;
            return result;
        }
10246

T
Théo DELRIEU 已提交
10247 10248 10249 10250 10251 10252 10253
        /// subtract from iterator
        json_reverse_iterator operator-(difference_type i) const
        {
            auto result = *this;
            result -= i;
            return result;
        }
10254

T
Théo DELRIEU 已提交
10255 10256 10257 10258 10259
        /// return difference
        difference_type operator-(const json_reverse_iterator& other) const
        {
            return this->base() - other.base();
        }
10260

T
Théo DELRIEU 已提交
10261 10262 10263 10264 10265
        /// access to successor
        reference operator[](difference_type n) const
        {
            return *(this->operator+(n));
        }
N
Niels 已提交
10266

T
Théo DELRIEU 已提交
10267 10268 10269 10270 10271 10272
        /// return the key of an object iterator
        typename object_t::key_type key() const
        {
            auto it = --this->base();
            return it.key();
        }
10273

T
Théo DELRIEU 已提交
10274 10275 10276 10277 10278 10279 10280
        /// return the value of an iterator
        reference value() const
        {
            auto it = --this->base();
            return it.operator * ();
        }
    };
10281

N
Niels 已提交
10282

N
Niels 已提交
10283
  private:
N
Niels Lohmann 已提交
10284 10285 10286
    ////////////////////
    // input adapters //
    ////////////////////
N
Niels 已提交
10287

N
Niels Lohmann 已提交
10288 10289 10290 10291 10292 10293 10294 10295
    /// 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() {}
    };
N
Niels 已提交
10296

N
Niels Lohmann 已提交
10297 10298
    /// input adapter for cached stream input
    class cached_input_stream_adapter : public input_adapter
N
Niels 已提交
10299
    {
N
Niels Lohmann 已提交
10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375
      public:
        cached_input_stream_adapter(std::istream& i, const size_t buffer_size)
            : is(i), start_position(is.tellg()),
              buffer(buffer_size, std::char_traits<char>::eof())
        {
            // immediately abort if stream is erroneous
            if (JSON_UNLIKELY(i.fail()))
            {
                JSON_THROW(parse_error::create(111, 0, "bad input stream"));
            }

            // initial fill; unfilled buffer characters remain EOF
            is.read(buffer.data(), static_cast<std::streamsize>(buffer.size()));

            // skip byte-order mark
            assert(buffer.size() >= 3);
            if (buffer[0] == '\xEF' and buffer[1] == '\xBB' and buffer[2] == '\xBF')
            {
                buffer_pos += 3;
                processed_chars += 3;
            }
        }

        ~cached_input_stream_adapter() override
        {
            // clear stream flags
            is.clear();
            // set stream after last processed char
            is.seekg(start_position + static_cast<std::streamoff>(processed_chars - 1));
        }

        int get_character() override
        {
            // check if refilling is necessary
            if (JSON_UNLIKELY(buffer_pos == buffer.size()))
            {
                // refill
                is.read(reinterpret_cast<char*>(buffer.data()), static_cast<std::streamsize>(buffer.size()));
                // set unfilled characters to EOF
                std::fill_n(buffer.begin() + static_cast<int>(is.gcount()),
                            buffer.size() - static_cast<size_t>(is.gcount()),
                            std::char_traits<char>::eof());
                // the buffer is ready
                buffer_pos = 0;
            }

            ++processed_chars;
            const int res = buffer[buffer_pos++];
            return (res == std::char_traits<char>::eof()) ? res : res & 0xFF;
        }

        std::string read(size_t offset, size_t length) override
        {
            // create buffer
            std::string result(length, '\0');

            // save stream position
            auto current_pos = is.tellg();
            // save stream flags
            auto flags = is.rdstate();

            // clear stream flags
            is.clear();
            // set stream position
            is.seekg(static_cast<std::streamoff>(offset));
            // read bytes
            is.read(&result[0], static_cast<std::streamsize>(length));

            // reset stream position
            is.seekg(current_pos);
            // reset stream flags
            is.setstate(flags);

            return result;
        }

N
Niels Lohmann 已提交
10376
      private:
N
Niels Lohmann 已提交
10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397 10398
        /// 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;

        /// position of the stream when we started
        const std::streampos start_position;

        /// internal buffer
        std::vector<char> buffer;
    };

    /// input adapter for buffer input
    class input_buffer_adapter : public input_adapter
    {
      public:
        input_buffer_adapter(const char* b, size_t l)
            : input_adapter(), cursor(b), limit(b + l), start(b)
        {}
N
Niels 已提交
10399

N
Niels Lohmann 已提交
10400 10401 10402 10403 10404
        // delete because of pointer members
        input_buffer_adapter(const input_buffer_adapter&) = delete;
        input_buffer_adapter& operator=(input_buffer_adapter&) = delete;

        int get_character() override
T
Théo DELRIEU 已提交
10405
        {
N
Niels Lohmann 已提交
10406 10407 10408 10409 10410 10411 10412 10413 10414
            if (JSON_LIKELY(cursor < limit))
            {
                return *(cursor++) & 0xFF;
            }
            else
            {
                return std::char_traits<char>::eof();
            }
        }
N
Niels 已提交
10415

N
Niels Lohmann 已提交
10416
        std::string read(size_t offset, size_t length) override
N
Niels 已提交
10417
        {
N
Niels Lohmann 已提交
10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464
            // avoid reading too many characters
            const size_t max_length = static_cast<size_t>(limit - start);
            return std::string(start + offset, std::min({length, max_length}));
        }

      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;
    };

    ////////////////////
    // binary formats //
    ////////////////////

  private:
    class binary_reader
    {
      public:
        explicit binary_reader(std::istream& i)
            : ia(new cached_input_stream_adapter(i, 16384))
        {}

        binary_reader(const char* buff, const size_t len)
            : ia(new input_buffer_adapter(buff, len))
        {}

        ~binary_reader()
        {
            delete ia;
        }

        // switch off unwanted functions (due to pointer members)
        binary_reader(const binary_reader&) = delete;
        binary_reader operator=(const binary_reader&) = delete;

        /*!
        @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
        */
        basic_json parse_cbor(const bool get_char = true)
        {
            switch (get_char ? get() : current)
T
Théo DELRIEU 已提交
10465
            {
N
Niels Lohmann 已提交
10466 10467
                // EOF
                case std::char_traits<char>::eof():
N
Niels Lohmann 已提交
10468
                {
N
Niels Lohmann 已提交
10469
                    JSON_THROW(parse_error::create(110, chars_read, "unexpected end of input"));
N
Niels Lohmann 已提交
10470 10471
                }

N
Niels Lohmann 已提交
10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499
                // 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 已提交
10500

N
Niels Lohmann 已提交
10501
                case 0x18: // Unsigned integer (one-byte uint8_t follows)
N
Niels Lohmann 已提交
10502
                {
N
Niels Lohmann 已提交
10503
                    return get_number<uint8_t>();
N
Niels Lohmann 已提交
10504
                }
N
Niels 已提交
10505

N
Niels Lohmann 已提交
10506 10507 10508 10509
                case 0x19: // Unsigned integer (two-byte uint16_t follows)
                {
                    return get_number<uint16_t>();
                }
N
Niels 已提交
10510

N
Niels Lohmann 已提交
10511
                case 0x1a: // Unsigned integer (four-byte uint32_t follows)
N
Niels Lohmann 已提交
10512
                {
N
Niels Lohmann 已提交
10513
                    return get_number<uint32_t>();
N
Niels Lohmann 已提交
10514 10515
                }

N
Niels Lohmann 已提交
10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611 10612 10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638
                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;
                    const auto len = static_cast<size_t>(current - 0x80);
                    for (size_t i = 0; i < len; ++i)
                    {
                        result.push_back(parse_cbor());
                    }
                    return result;
                }
N
Niels 已提交
10639

N
Niels Lohmann 已提交
10640 10641 10642 10643 10644 10645 10646 10647 10648 10649
                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 已提交
10650

N
Niels Lohmann 已提交
10651 10652 10653 10654 10655 10656 10657 10658 10659 10660
                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 已提交
10661

N
Niels Lohmann 已提交
10662 10663 10664 10665 10666 10667 10668 10669 10670 10671
                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 已提交
10672

N
Niels Lohmann 已提交
10673 10674 10675 10676 10677 10678 10679 10680 10681 10682
                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 已提交
10683

N
Niels Lohmann 已提交
10684 10685 10686 10687 10688 10689 10690 10691 10692
                case 0x9f: // array (indefinite length)
                {
                    basic_json result = value_t::array;
                    while (get() != 0xff)
                    {
                        result.push_back(parse_cbor(false));
                    }
                    return result;
                }
N
Niels 已提交
10693

N
Niels Lohmann 已提交
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
                // 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;
                    const auto len = static_cast<size_t>(current - 0xa0);
                    for (size_t i = 0; i < len; ++i)
                    {
                        get();
10725 10726
                        auto key = get_cbor_string();
                        result[key] = parse_cbor();
N
Niels Lohmann 已提交
10727 10728 10729
                    }
                    return result;
                }
N
Niels 已提交
10730

N
Niels Lohmann 已提交
10731 10732 10733 10734 10735 10736 10737
                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();
10738 10739
                        auto key = get_cbor_string();
                        result[key] = parse_cbor();
N
Niels Lohmann 已提交
10740 10741 10742
                    }
                    return result;
                }
N
Niels 已提交
10743

N
Niels Lohmann 已提交
10744 10745 10746 10747 10748 10749 10750
                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();
10751 10752
                        auto key = get_cbor_string();
                        result[key] = parse_cbor();
N
Niels Lohmann 已提交
10753 10754 10755
                    }
                    return result;
                }
N
Niels 已提交
10756

N
Niels Lohmann 已提交
10757 10758 10759 10760 10761 10762 10763
                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();
10764 10765
                        auto key = get_cbor_string();
                        result[key] = parse_cbor();
N
Niels Lohmann 已提交
10766 10767 10768
                    }
                    return result;
                }
T
Théo DELRIEU 已提交
10769

N
Niels Lohmann 已提交
10770
                case 0xbb: // map (eight-byte uint64_t for n follow)
T
Théo DELRIEU 已提交
10771
                {
N
Niels Lohmann 已提交
10772 10773 10774 10775 10776
                    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();
10777 10778
                        auto key = get_cbor_string();
                        result[key] = parse_cbor();
N
Niels Lohmann 已提交
10779 10780
                    }
                    return result;
T
Théo DELRIEU 已提交
10781
                }
N
Niels 已提交
10782

N
Niels Lohmann 已提交
10783 10784 10785 10786 10787
                case 0xbf: // map (indefinite length)
                {
                    basic_json result = value_t::object;
                    while (get() != 0xff)
                    {
10788 10789
                        auto key = get_cbor_string();
                        result[key] = parse_cbor();
N
Niels Lohmann 已提交
10790 10791 10792
                    }
                    return result;
                }
N
Niels Lohmann 已提交
10793

N
Niels Lohmann 已提交
10794 10795 10796 10797
                case 0xf4: // false
                {
                    return false;
                }
N
Niels Lohmann 已提交
10798

N
Niels Lohmann 已提交
10799 10800 10801 10802
                case 0xf5: // true
                {
                    return true;
                }
N
Niels Lohmann 已提交
10803

N
Niels Lohmann 已提交
10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842
                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:
                    // 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.
                    const int half = (byte1 << 8) + byte2;
                    const int exp = (half >> 10) & 0x1f;
                    const int mant = half & 0x3ff;
                    double val;
                    if (exp == 0)
                    {
                        val = std::ldexp(mant, -24);
                    }
                    else if (exp != 31)
                    {
                        val = std::ldexp(mant + 1024, exp - 25);
                    }
                    else
                    {
                        val = mant == 0
                              ? std::numeric_limits<double>::infinity()
                              : std::numeric_limits<double>::quiet_NaN();
                    }
                    return (half & 0x8000) != 0 ? -val : val;
                }
N
Niels Lohmann 已提交
10843

N
Niels Lohmann 已提交
10844 10845 10846 10847
                case 0xfa: // Single-Precision Float (four-byte IEEE 754)
                {
                    return get_number<float>();
                }
N
Niels Lohmann 已提交
10848

N
Niels Lohmann 已提交
10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859
                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;
                    ss << std::hex << current;
                    JSON_THROW(parse_error::create(112, chars_read, "error reading CBOR; last byte: 0x" + ss.str()));
                }
T
Théo DELRIEU 已提交
10860
            }
N
Niels Lohmann 已提交
10861
        }
N
Niels Lohmann 已提交
10862

N
Niels Lohmann 已提交
10863 10864 10865 10866 10867 10868
      private:
        int get()
        {
            ++chars_read;
            return (current = ia->get_character());
        }
N
Niels Lohmann 已提交
10869

N
Niels Lohmann 已提交
10870 10871 10872
        // todo: check if this breaks with endianess
        template<typename T>
        T get_number()
N
Niels Lohmann 已提交
10873
        {
N
Niels Lohmann 已提交
10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897
            std::array<uint8_t, sizeof(T)> vec;
            for (size_t i = 0; i < sizeof(T); ++i)
            {
                get();
                check_eof();
                vec[sizeof(T) - i - 1] = static_cast<uint8_t>(current);
            }

            T result;
            std::memcpy(&result, vec.data(), sizeof(T));
            return result;
        }

        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 已提交
10898

N
Niels Lohmann 已提交
10899 10900 10901
        std::string get_cbor_string()
        {
            check_eof();
N
Niels Lohmann 已提交
10902

N
Niels Lohmann 已提交
10903
            switch (current)
T
Théo DELRIEU 已提交
10904
            {
N
Niels Lohmann 已提交
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
                // 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 已提交
10930
                {
N
Niels Lohmann 已提交
10931 10932
                    const auto len = static_cast<size_t>(current - 0x60);
                    return get_string(len);
N
Niels Lohmann 已提交
10933
                }
N
Niels Lohmann 已提交
10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970

                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 已提交
10971
                {
N
Niels Lohmann 已提交
10972 10973 10974
                    std::stringstream ss;
                    ss << std::hex << current;
                    JSON_THROW(parse_error::create(113, chars_read, "expected a CBOR string; last byte: 0x" + ss.str()));
N
Niels Lohmann 已提交
10975
                }
T
Théo DELRIEU 已提交
10976
            }
N
Niels Lohmann 已提交
10977
        }
N
Niels Lohmann 已提交
10978

N
Niels Lohmann 已提交
10979 10980 10981
        void check_eof()
        {
            if (JSON_UNLIKELY(current == std::char_traits<char>::eof()))
T
Théo DELRIEU 已提交
10982
            {
N
Niels Lohmann 已提交
10983
                JSON_THROW(parse_error::create(110, chars_read, "unexpected end of input"));
T
Théo DELRIEU 已提交
10984
            }
N
Niels Lohmann 已提交
10985
        }
10986

N
Niels Lohmann 已提交
10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004
      private:
        /// input adapter
        input_adapter* ia = nullptr;

        /// the current character
        int current = std::char_traits<char>::eof();

        /// the number of characters read
        size_t chars_read = 0;
    };

  public:
    static basic_json from_cbor(const std::vector<uint8_t>& v,
                                const size_t start_index = 0)
    {
        binary_reader br(reinterpret_cast<const char*>(v.data() + start_index), v.size() - start_index);
        return br.parse_cbor();
    }
N
Niels Lohmann 已提交
11005

N
Niels Lohmann 已提交
11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017
    //////////////////////
    // lexer and parser //
    //////////////////////

  private:
    /*!
    @brief lexical analysis

    This class organizes the lexical analysis during JSON deserialization.
    */
    class lexer
    {
N
Niels Lohmann 已提交
11018 11019 11020 11021 11022 11023 11024 11025 11026
      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 已提交
11027 11028 11029
            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 已提交
11030 11031 11032 11033 11034 11035 11036 11037 11038
            begin_array,     ///< the character for array begin `[`
            begin_object,    ///< the character for object begin `{`
            end_array,       ///< the character for array end `]`
            end_object,      ///< the character for object end `}`
            name_separator,  ///< the name separator `:`
            value_separator, ///< the value separator `,`
            parse_error,     ///< indicating a parse error
            end_of_input     ///< indicating the end of the input buffer
        };
11039

T
Théo DELRIEU 已提交
11040
        /// return name of values of type token_type (only used for errors)
N
Niels Lohmann 已提交
11041
        static const char* token_type_name(const token_type t) noexcept
T
Théo DELRIEU 已提交
11042 11043
        {
            switch (t)
N
cleanup  
Niels 已提交
11044
            {
T
Théo DELRIEU 已提交
11045 11046 11047 11048 11049 11050 11051 11052 11053 11054
                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 已提交
11055 11056
                case lexer::token_type::value_unsigned:
                case lexer::token_type::value_integer:
11057
                case lexer::token_type::value_float:
T
Théo DELRIEU 已提交
11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079
                    return "number literal";
                case token_type::begin_array:
                    return "'['";
                case token_type::begin_object:
                    return "'{'";
                case token_type::end_array:
                    return "']'";
                case token_type::end_object:
                    return "'}'";
                case token_type::name_separator:
                    return "':'";
                case token_type::value_separator:
                    return "','";
                case token_type::parse_error:
                    return "<parse error>";
                case token_type::end_of_input:
                    return "end of input";
                default:
                {
                    // catch non-enum values
                    return "unknown token"; // LCOV_EXCL_LINE
                }
N
cleanup  
Niels 已提交
11080 11081 11082
            }
        }

N
Niels Lohmann 已提交
11083
        explicit lexer(std::istream& i)
11084
            : ia(new cached_input_stream_adapter(i, 16384)),
11085
              decimal_point_char(get_decimal_point())
N
Niels Lohmann 已提交
11086
        {}
N
fixes  
Niels 已提交
11087

N
Niels Lohmann 已提交
11088
        lexer(const char* buff, const size_t len)
11089 11090
            : ia(new input_buffer_adapter(buff, len)),
              decimal_point_char(get_decimal_point())
N
Niels Lohmann 已提交
11091 11092 11093 11094 11095 11096
        {}

        ~lexer()
        {
            delete ia;
        }
N
Niels 已提交
11097

N
Niels Lohmann 已提交
11098 11099 11100 11101
        // switch off unwanted functions (due to pointer members)
        lexer() = delete;
        lexer(const lexer&) = delete;
        lexer operator=(const lexer&) = delete;
N
Niels 已提交
11102

N
Niels Lohmann 已提交
11103
      private:
11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115
        /////////////////////
        // 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 已提交
11116 11117 11118
        /////////////////////
        // scan functions
        /////////////////////
N
Niels 已提交
11119

N
Niels Lohmann 已提交
11120 11121 11122
        // must be called after \u was read; returns following xxxx as hex or -1 when error
        int get_codepoint()
        {
11123
            assert(current == 'u');
N
Niels Lohmann 已提交
11124 11125
            int codepoint = 0;

11126
            switch (get())
N
Niels Lohmann 已提交
11127
            {
11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181
                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 已提交
11182
                    return -1;
11183
            }
N
Niels Lohmann 已提交
11184

11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 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
            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;
            }

            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;
            }

            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 已提交
11360
            }
N
Niels Lohmann 已提交
11361 11362

            return codepoint;
N
Niels Lohmann 已提交
11363 11364 11365
        }

        token_type scan_string()
N
Niels 已提交
11366
        {
N
Niels Lohmann 已提交
11367 11368 11369
            // reset yytext (ignore opening quote)
            reset();

11370
            // we entered the function by reading an open quote
N
Niels Lohmann 已提交
11371
            assert(current == '\"');
11372

T
Théo DELRIEU 已提交
11373 11374
            while (true)
            {
11375
                // get next character
N
Niels Lohmann 已提交
11376
                get();
N
Niels 已提交
11377

11378
                switch (current)
N
Niels Lohmann 已提交
11379
                {
11380 11381
                    // end of file while parsing string
                    case std::char_traits<char>::eof():
11382
                    {
11383 11384
                        error_message = "invalid string: missing closing quote";
                        return token_type::parse_error;
11385 11386
                    }

11387 11388
                    // closing quote
                    case '\"':
11389
                    {
11390 11391 11392 11393
                        // terminate yytext
                        add('\0');
                        --yylen;
                        return token_type::value_string;
11394 11395
                    }

11396 11397
                    // escapes
                    case '\\':
N
Niels Lohmann 已提交
11398
                    {
N
Niels Lohmann 已提交
11399
                        switch (get())
N
Niels Lohmann 已提交
11400
                        {
N
Niels Lohmann 已提交
11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435
                            // 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 已提交
11436
                            {
N
Niels Lohmann 已提交
11437 11438 11439 11440
                                int codepoint;
                                int codepoint1 = get_codepoint();

                                if (JSON_UNLIKELY(codepoint1 == -1))
N
Niels Lohmann 已提交
11441
                                {
N
Niels Lohmann 已提交
11442 11443
                                    error_message = "invalid string: '\\u' must be followed by 4 hex digits";
                                    return token_type::parse_error;
N
Niels Lohmann 已提交
11444
                                }
N
Niels Lohmann 已提交
11445 11446

                                // check if code point is a high surrogate
N
Niels Lohmann 已提交
11447
                                if (0xD800 <= codepoint1 and codepoint1 <= 0xDBFF)
N
Niels Lohmann 已提交
11448
                                {
N
Niels Lohmann 已提交
11449 11450 11451
                                    // expect next \uxxxx entry
                                    if (JSON_LIKELY(get() == '\\' and get() == 'u'))
                                    {
11452
                                        const int codepoint2 = get_codepoint();
N
Niels Lohmann 已提交
11453 11454 11455 11456 11457 11458 11459 11460

                                        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 已提交
11461
                                        if (JSON_LIKELY(0xDC00 <= codepoint2 and codepoint2 <= 0xDFFF))
N
Niels Lohmann 已提交
11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479 11480 11481 11482 11483
                                        {
                                            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
                                        {
                                            error_message = "invalid string: invalid low surrogate";
                                            return token_type::parse_error;
                                        }
                                    }
                                    else
                                    {
                                        error_message = "invalid string: missing low surrogate";
                                        return token_type::parse_error;
                                    }
N
Niels Lohmann 已提交
11484
                                }
N
Niels Lohmann 已提交
11485
                                else
N
Niels Lohmann 已提交
11486
                                {
N
Niels Lohmann 已提交
11487
                                    if (JSON_UNLIKELY(0xDC00 <= codepoint1 and codepoint1 <= 0xDFFF))
N
Niels Lohmann 已提交
11488 11489 11490 11491 11492 11493 11494
                                    {
                                        error_message = "invalid string: missing high surrogate";
                                        return token_type::parse_error;
                                    }

                                    // only work with first code point
                                    codepoint = codepoint1;
N
Niels Lohmann 已提交
11495
                                }
N
Niels Lohmann 已提交
11496

N
Niels Lohmann 已提交
11497 11498 11499
                                // result of the above calculation yields a proper codepoint
                                assert(0x00 <= codepoint and codepoint <= 0x10FFFF);

N
Niels Lohmann 已提交
11500 11501
                                // translate code point to bytes
                                if (codepoint < 0x80)
N
Niels Lohmann 已提交
11502
                                {
N
Niels Lohmann 已提交
11503 11504
                                    // 1-byte characters: 0xxxxxxx (ASCII)
                                    add(codepoint);
N
Niels Lohmann 已提交
11505
                                }
N
Niels Lohmann 已提交
11506
                                else if (codepoint <= 0x7ff)
N
Niels Lohmann 已提交
11507
                                {
N
Niels Lohmann 已提交
11508 11509 11510
                                    // 2-byte characters: 110xxxxx 10xxxxxx
                                    add(0xC0 | (codepoint >> 6));
                                    add(0x80 | (codepoint & 0x3F));
N
Niels Lohmann 已提交
11511
                                }
N
Niels Lohmann 已提交
11512
                                else if (codepoint <= 0xffff)
N
Niels Lohmann 已提交
11513
                                {
N
Niels Lohmann 已提交
11514 11515 11516 11517
                                    // 3-byte characters: 1110xxxx 10xxxxxx 10xxxxxx
                                    add(0xE0 | (codepoint >> 12));
                                    add(0x80 | ((codepoint >> 6) & 0x3F));
                                    add(0x80 | (codepoint & 0x3F));
N
Niels Lohmann 已提交
11518
                                }
N
Niels Lohmann 已提交
11519
                                else
N
Niels Lohmann 已提交
11520
                                {
N
Niels Lohmann 已提交
11521 11522 11523 11524 11525
                                    // 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 已提交
11526
                                }
N
Niels Lohmann 已提交
11527 11528

                                break;
N
Niels Lohmann 已提交
11529
                            }
N
Niels Lohmann 已提交
11530 11531 11532 11533 11534

                            // other characters after escape
                            default:
                                error_message = "invalid string: forbidden character after backspace";
                                return token_type::parse_error;
N
Niels Lohmann 已提交
11535
                        }
N
Niels Lohmann 已提交
11536

N
Niels Lohmann 已提交
11537 11538
                        break;
                    }
N
Niels Lohmann 已提交
11539

11540
                    // invalid control characters
N
Niels Lohmann 已提交
11541 11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561 11562 11563 11564 11565 11566 11567 11568 11569 11570 11571 11572
                    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:
11573
                    {
11574 11575 11576 11577 11578
                        error_message = "invalid string: control characters (U+0000 through U+001f) must be escaped";
                        return token_type::parse_error;
                    }

                    // U+0020..U+007F (except U+0022 (quote) and U+005C (backspace))
N
Niels Lohmann 已提交
11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 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
                    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:
11673 11674 11675 11676 11677 11678
                    {
                        add(current);
                        break;
                    }

                    // U+0080..U+07FF: bytes C2..DF 80..BF
N
Niels Lohmann 已提交
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
                    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:
11709 11710 11711
                    {
                        add(current);
                        get();
N
Niels Lohmann 已提交
11712
                        if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11713 11714 11715 11716 11717 11718 11719 11720 11721 11722
                        {
                            add(current);
                            continue;
                        }

                        error_message = "invalid string: not well-formed UTF-8 byte";
                        return token_type::parse_error;
                    }

                    // U+0800..U+0FFF: bytes E0 A0..BF 80..BF
N
Niels Lohmann 已提交
11723
                    case 0xe0:
11724 11725 11726
                    {
                        add(current);
                        get();
N
Niels Lohmann 已提交
11727
                        if (JSON_LIKELY(0xa0 <= current and current <= 0xbf))
11728 11729 11730
                        {
                            add(current);
                            get();
N
Niels Lohmann 已提交
11731
                            if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11732 11733 11734 11735 11736 11737 11738 11739 11740 11741 11742 11743
                            {
                                add(current);
                                continue;
                            }
                        }

                        error_message = "invalid string: not well-formed UTF-8 byte";
                        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 已提交
11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757
                    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:
11758 11759 11760
                    {
                        add(current);
                        get();
N
Niels Lohmann 已提交
11761
                        if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11762 11763 11764
                        {
                            add(current);
                            get();
N
Niels Lohmann 已提交
11765
                            if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11766 11767 11768 11769 11770 11771 11772 11773 11774 11775 11776
                            {
                                add(current);
                                continue;
                            }
                        }

                        error_message = "invalid string: not well-formed UTF-8 byte";
                        return token_type::parse_error;
                    }

                    // U+D000..U+D7FF: bytes ED 80..9F 80..BF
N
Niels Lohmann 已提交
11777
                    case 0xed:
11778 11779 11780
                    {
                        add(current);
                        get();
N
Niels Lohmann 已提交
11781
                        if (JSON_LIKELY(0x80 <= current and current <= 0x9f))
11782 11783 11784
                        {
                            add(current);
                            get();
N
Niels Lohmann 已提交
11785
                            if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11786 11787 11788 11789 11790 11791 11792 11793
                            {
                                add(current);
                                continue;
                            }
                        }

                        error_message = "invalid string: not well-formed UTF-8 byte";
                        return token_type::parse_error;
11794 11795
                    }

11796
                    // U+10000..U+3FFFF F0 90..BF 80..BF 80..BF
N
Niels Lohmann 已提交
11797
                    case 0xf0:
11798 11799 11800
                    {
                        add(current);
                        get();
N
Niels Lohmann 已提交
11801
                        if (JSON_LIKELY(0x90 <= 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
                            {
                                add(current);
                                get();
N
Niels Lohmann 已提交
11809
                                if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821
                                {
                                    add(current);
                                    continue;
                                }
                            }
                        }

                        error_message = "invalid string: not well-formed UTF-8 byte";
                        return token_type::parse_error;
                    }

                    // U+40000..U+FFFFF F1..F3 80..BF 80..BF 80..BF
N
Niels Lohmann 已提交
11822 11823 11824
                    case 0xf1:
                    case 0xf2:
                    case 0xf3:
11825 11826 11827
                    {
                        add(current);
                        get();
N
Niels Lohmann 已提交
11828
                        if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11829 11830 11831
                        {
                            add(current);
                            get();
N
Niels Lohmann 已提交
11832
                            if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11833 11834 11835
                            {
                                add(current);
                                get();
N
Niels Lohmann 已提交
11836
                                if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11837 11838 11839 11840 11841 11842 11843 11844
                                {
                                    add(current);
                                    continue;
                                }
                            }
                        }

                        error_message = "invalid string: not well-formed UTF-8 byte";
11845 11846 11847
                        return token_type::parse_error;
                    }

11848
                    // U+100000..U+10FFFF F4 80..8F 80..BF 80..BF
N
Niels Lohmann 已提交
11849
                    case 0xf4:
11850
                    {
11851 11852
                        add(current);
                        get();
N
Niels Lohmann 已提交
11853
                        if (JSON_LIKELY(0x80 <= current and current <= 0x8f))
11854 11855 11856
                        {
                            add(current);
                            get();
N
Niels Lohmann 已提交
11857
                            if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11858 11859 11860
                            {
                                add(current);
                                get();
N
Niels Lohmann 已提交
11861
                                if (JSON_LIKELY(0x80 <= current and current <= 0xbf))
11862 11863 11864 11865 11866 11867 11868
                                {
                                    add(current);
                                    continue;
                                }
                            }
                        }

11869 11870 11871 11872
                        error_message = "invalid string: not well-formed UTF-8 byte";
                        return token_type::parse_error;
                    }

11873
                    // remaining bytes (80..C1 and F5..FF) are not well-formed
N
Niels Lohmann 已提交
11874
                    default:
N
Niels Lohmann 已提交
11875
                    {
11876 11877
                        error_message = "invalid string: not well-formed UTF-8 byte";
                        return token_type::parse_error;
N
Niels Lohmann 已提交
11878
                    }
N
Niels Lohmann 已提交
11879 11880 11881 11882
                }
            }
        }

11883 11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897
        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);
        }

11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910
        /*!
        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 已提交
11911 11912
        token_type scan_number()
        {
11913 11914 11915 11916 11917 11918 11919 11920
            reset();

            // the type of the parsed number; initially set to unsigned; will
            // be changed if minus sign, decimal point or exponent is read
            token_type number_type = token_type::value_unsigned;

            // state: we just found out we need to scan a number
            switch (current)
N
Niels Lohmann 已提交
11921
            {
11922 11923 11924 11925 11926
                case '-':
                {
                    add(current);
                    goto scan_number_minus;
                }
N
Niels Lohmann 已提交
11927

11928 11929 11930 11931 11932
                case '0':
                {
                    add(current);
                    goto scan_number_zero;
                }
N
Niels Lohmann 已提交
11933

11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946
                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 已提交
11947

11948 11949 11950 11951 11952 11953
                default:
                {
                    // all other characters are rejected outside scan_number()
                    assert(false);  // LCOV_EXCL_LINE
                }
            }
N
Niels Lohmann 已提交
11954

11955 11956 11957 11958
scan_number_minus:
            // state: we just parsed a leading minus sign
            number_type = token_type::value_integer;
            switch (get())
N
Niels Lohmann 已提交
11959
            {
11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978
                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 已提交
11979

11980
                default:
N
Niels Lohmann 已提交
11981
                {
11982
                    error_message = "invalid number; expected digit after '-'";
N
Niels Lohmann 已提交
11983
                    return token_type::parse_error;
N
Niels Lohmann 已提交
11984
                }
11985
            }
11986

11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083 12084 12085 12086 12087 12088 12089 12090 12091 12092 12093 12094 12095 12096 12097 12098 12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132 12133 12134 12135 12136 12137 12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152 12153 12154 12155 12156 12157 12158 12159 12160 12161 12162 12163 12164 12165 12166 12167 12168 12169 12170 12171 12172 12173 12174 12175 12176 12177 12178 12179 12180 12181 12182 12183 12184 12185 12186 12187 12188 12189
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 已提交
12190
            }
12191

12192
scan_number_done:
N
Niels Lohmann 已提交
12193
            // unget the character after the number
12194 12195
            --chars_read;
            next_unget = true;
N
Niels Lohmann 已提交
12196

N
Niels Lohmann 已提交
12197 12198 12199
            // terminate token
            add('\0');
            --yylen;
N
Niels 已提交
12200

N
Niels Lohmann 已提交
12201
            // try to parse integers first and fall back to floats
12202
            if (number_type == token_type::value_unsigned)
12203
            {
12204
                char* endptr = nullptr;
N
Niels Lohmann 已提交
12205
                errno = 0;
12206 12207 12208 12209 12210 12211
                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 已提交
12212
                {
12213 12214
                    value_unsigned = static_cast<number_unsigned_t>(x);
                    if (value_unsigned == x)
N
Niels Lohmann 已提交
12215
                    {
12216
                        return token_type::value_unsigned;
N
Niels Lohmann 已提交
12217 12218
                    }
                }
12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229
            }
            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 已提交
12230
                {
12231 12232
                    value_integer = static_cast<number_integer_t>(x);
                    if (value_integer == x)
N
Niels Lohmann 已提交
12233
                    {
12234
                        return token_type::value_integer;
N
Niels Lohmann 已提交
12235 12236
                    }
                }
12237
            }
N
Niels Lohmann 已提交
12238

12239
            strtof(value_float, yytext.data(), nullptr);
N
Niels Lohmann 已提交
12240
            return token_type::value_float;
N
Niels 已提交
12241 12242
        }

N
Niels Lohmann 已提交
12243
        token_type scan_true()
T
Théo DELRIEU 已提交
12244
        {
N
Niels Lohmann 已提交
12245
            assert(current == 't');
N
Niels Lohmann 已提交
12246 12247 12248 12249 12250 12251 12252
            if (JSON_LIKELY((get() == 'r' and get() == 'u' and get() == 'e')))
            {
                return token_type::literal_true;
            }

            error_message = "invalid literal; expected 'true'";
            return token_type::parse_error;
T
Théo DELRIEU 已提交
12253
        }
12254

N
Niels Lohmann 已提交
12255
        token_type scan_false()
T
Théo DELRIEU 已提交
12256
        {
N
Niels Lohmann 已提交
12257
            assert(current == 'f');
N
Niels Lohmann 已提交
12258
            if (JSON_LIKELY((get() == 'a' and get() == 'l' and get() == 's' and get() == 'e')))
N
Niels 已提交
12259
            {
N
Niels Lohmann 已提交
12260
                return token_type::literal_false;
N
Niels 已提交
12261
            }
T
Théo DELRIEU 已提交
12262

N
Niels Lohmann 已提交
12263 12264
            error_message = "invalid literal; expected 'false'";
            return token_type::parse_error;
N
Niels 已提交
12265 12266
        }

N
Niels Lohmann 已提交
12267 12268
        token_type scan_null()
        {
N
Niels Lohmann 已提交
12269
            assert(current == 'n');
N
Niels Lohmann 已提交
12270 12271 12272 12273
            if (JSON_LIKELY((get() == 'u' and get() == 'l' and get() == 'l')))
            {
                return token_type::literal_null;
            }
12274

N
Niels Lohmann 已提交
12275 12276 12277
            error_message = "invalid literal; expected 'null'";
            return token_type::parse_error;
        }
12278

N
Niels Lohmann 已提交
12279 12280 12281
        /////////////////////
        // input management
        /////////////////////
12282

N
Niels Lohmann 已提交
12283 12284
        /// reset yytext
        void reset() noexcept
T
Théo DELRIEU 已提交
12285
        {
N
Niels Lohmann 已提交
12286 12287 12288
            yylen = 0;
            start_pos = chars_read - 1;
        }
12289

N
Niels Lohmann 已提交
12290
        /// get a character from the input
N
Niels Lohmann 已提交
12291 12292 12293
        int get()
        {
            ++chars_read;
12294 12295 12296
            return next_unget
                   ? (next_unget = false, current)
                   : (current = ia->get_character());
N
Niels Lohmann 已提交
12297
        }
N
Niels 已提交
12298

N
Niels Lohmann 已提交
12299
        /// add a character to yytext
N
Niels Lohmann 已提交
12300 12301 12302 12303
        void add(int c)
        {
            // resize yytext if necessary
            if (JSON_UNLIKELY((yylen + 1 > yytext.capacity())))
T
Théo DELRIEU 已提交
12304
            {
N
Niels Lohmann 已提交
12305 12306 12307 12308
                yytext.resize(2 * yytext.capacity(), '\0');
            }
            yytext[yylen++] = static_cast<char>(c);
        }
12309

N
Niels Lohmann 已提交
12310
      public:
N
Niels Lohmann 已提交
12311 12312 12313
        /////////////////////
        // value getters
        /////////////////////
12314

N
Niels Lohmann 已提交
12315
        /// return integer value
N
Niels Lohmann 已提交
12316 12317 12318 12319 12320
        constexpr number_integer_t get_number_integer() const noexcept
        {
            return value_integer;
        }

N
Niels Lohmann 已提交
12321
        /// return unsigned integer value
N
Niels Lohmann 已提交
12322 12323 12324 12325 12326
        constexpr number_unsigned_t get_number_unsigned() const noexcept
        {
            return value_unsigned;
        }

N
Niels Lohmann 已提交
12327
        /// return floating-point value
N
Niels Lohmann 已提交
12328 12329 12330 12331 12332
        constexpr number_float_t get_number_float() const noexcept
        {
            return value_float;
        }

N
Niels Lohmann 已提交
12333
        /// return string value
N
Niels Lohmann 已提交
12334 12335
        const std::string get_string()
        {
N
Niels Lohmann 已提交
12336 12337
            // yytext cannot be returned as char*, because it may contain a
            // null byte
N
Niels Lohmann 已提交
12338 12339
            return std::string(yytext.data(), yylen);
        }
12340

N
Niels Lohmann 已提交
12341 12342 12343 12344 12345 12346 12347 12348 12349 12350 12351
        /////////////////////
        // 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 已提交
12352 12353
        std::string get_token_string() const
        {
N
Niels Lohmann 已提交
12354
            // get the raw byte sequence of the last token
N
Niels Lohmann 已提交
12355
            std::string s = ia->read(start_pos, chars_read - start_pos);
12356

N
Niels Lohmann 已提交
12357 12358
            // escape control characters
            std::stringstream ss;
N
Niels Lohmann 已提交
12359 12360 12361
            for (auto c : s)
            {
                if (c == '\0' or c == std::char_traits<char>::eof())
T
Théo DELRIEU 已提交
12362
                {
N
Niels Lohmann 已提交
12363
                    // ignore EOF
N
Niels Lohmann 已提交
12364
                    continue;
T
Théo DELRIEU 已提交
12365
                }
N
Niels Lohmann 已提交
12366
                else if ('\x00' <= c and c <= '\x1f')
A
Alex Astashyn 已提交
12367
                {
N
Niels Lohmann 已提交
12368
                    // escape control characters
N
Niels Lohmann 已提交
12369 12370 12371 12372
                    ss << "<U+" << std::setw(4) << std::setfill('0') << std::hex << int(c) << ">";
                }
                else
                {
N
Niels Lohmann 已提交
12373
                    // add character as is
N
Niels Lohmann 已提交
12374
                    ss << c;
N
Niels 已提交
12375
                }
12376
            }
N
Niels 已提交
12377

N
Niels Lohmann 已提交
12378 12379
            return ss.str();
        }
12380

N
Niels Lohmann 已提交
12381
        /// return syntax error message
N
Niels Lohmann 已提交
12382
        const std::string& get_error_message() const noexcept
N
Niels Lohmann 已提交
12383 12384 12385
        {
            return error_message;
        }
12386

N
Niels Lohmann 已提交
12387 12388 12389 12390
        /////////////////////
        // actual scanner
        /////////////////////

N
Niels Lohmann 已提交
12391
        token_type scan()
12392
        {
N
Niels Lohmann 已提交
12393 12394 12395 12396 12397 12398 12399 12400 12401 12402 12403 12404 12405 12406 12407 12408 12409 12410 12411 12412 12413 12414 12415 12416 12417 12418 12419 12420 12421 12422 12423 12424 12425 12426 12427 12428 12429 12430 12431 12432 12433 12434 12435 12436 12437 12438 12439 12440 12441 12442 12443 12444 12445 12446 12447 12448 12449 12450 12451
            // read next character and ignore whitespace
            do
            {
                get();
            }
            while (current == ' ' or current == '\t' or current == '\n' or current == '\r');

            switch (current)
            {
                // structural characters
                case '[':
                    return token_type::begin_array;
                case ']':
                    return token_type::end_array;
                case '{':
                    return token_type::begin_object;
                case '}':
                    return token_type::end_object;
                case ':':
                    return token_type::name_separator;
                case ',':
                    return token_type::value_separator;

                // literals
                case 't':
                    return scan_true();
                case 'f':
                    return scan_false();
                case 'n':
                    return scan_null();

                // string
                case '\"':
                    return scan_string();

                // number
                case '-':
                case '0':
                case '1':
                case '2':
                case '3':
                case '4':
                case '5':
                case '6':
                case '7':
                case '8':
                case '9':
                    return scan_number();

                // end of input
                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;
            }
12452 12453
        }

T
Théo DELRIEU 已提交
12454
      private:
N
Niels Lohmann 已提交
12455 12456 12457 12458 12459 12460 12461 12462 12463 12464 12465 12466 12467 12468 12469 12470 12471 12472 12473 12474 12475 12476 12477
        /// input adapter
        input_adapter* ia = nullptr;

        /// the current character
        int current = std::char_traits<char>::eof();

        /// whether get() should return the last character again
        bool next_unget = false;

        /// the number of characters read
        size_t chars_read = 0;
        /// the start position of the current token
        size_t start_pos = 0;

        /// buffer for variable-length tokens (numbers, strings)
        std::vector<char> yytext = std::vector<char>(1024, '\0');
        /// current index in yytext
        size_t yylen = 0;

        /// a description of occurred lexer errors
        std::string error_message = "";

        // number values
12478 12479 12480
        number_integer_t value_integer = 0;
        number_unsigned_t value_unsigned = 0;
        number_float_t value_float = 0;
12481

N
Niels Lohmann 已提交
12482
        /// the decimal point
12483
        const char decimal_point_char = '\0';
T
Théo DELRIEU 已提交
12484
    };
N
Niels 已提交
12485

N
Niels 已提交
12486 12487
    /*!
    @brief syntax analysis
N
Niels 已提交
12488 12489

    This class implements a recursive decent parser.
N
Niels 已提交
12490
    */
N
Niels 已提交
12491 12492
    class parser
    {
T
Théo DELRIEU 已提交
12493
      public:
12494
        /// a parser reading from a string literal
N
Niels 已提交
12495
        parser(const char* buff, const parser_callback_t cb = nullptr)
12496
            : callback(cb), m_lexer(buff, std::strlen(buff))
T
Théo DELRIEU 已提交
12497
        {}
12498

N
Niels Lohmann 已提交
12499 12500 12501 12502
        /*!
        @brief a parser reading from an input stream
        @throw parse_error.111 if input stream is in a bad state
        */
T
Théo DELRIEU 已提交
12503 12504 12505
        parser(std::istream& is, const parser_callback_t cb = nullptr)
            : callback(cb), m_lexer(is)
        {}
12506

T
Théo DELRIEU 已提交
12507 12508 12509 12510 12511 12512 12513
        /// a parser reading from an iterator range with contiguous storage
        template<class IteratorType, typename std::enable_if<
                     std::is_same<typename std::iterator_traits<IteratorType>::iterator_category, std::random_access_iterator_tag>::value
                     , int>::type
                 = 0>
        parser(IteratorType first, IteratorType last, const parser_callback_t cb = nullptr)
            : callback(cb),
N
Niels Lohmann 已提交
12514
              m_lexer(reinterpret_cast<const char*>(&(*first)),
T
Théo DELRIEU 已提交
12515 12516
                      static_cast<size_t>(std::distance(first, last)))
        {}
N
cleanup  
Niels 已提交
12517

N
Niels Lohmann 已提交
12518 12519
        /*!
        @brief public parser interface
12520 12521 12522

        @param[in] strict  whether to expect the last token to be EOF

N
Niels Lohmann 已提交
12523 12524 12525 12526
        @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
        */
12527
        basic_json parse(const bool strict = true)
T
Théo DELRIEU 已提交
12528 12529 12530
        {
            // read first token
            get_token();
N
Niels 已提交
12531

T
Théo DELRIEU 已提交
12532 12533
            basic_json result = parse_internal(true);
            result.assert_invariant();
N
Niels 已提交
12534

12535 12536 12537 12538
            if (strict)
            {
                expect(lexer::token_type::end_of_input);
            }
N
Niels 已提交
12539

T
Théo DELRIEU 已提交
12540 12541 12542 12543
            // 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 已提交
12544

T
Théo DELRIEU 已提交
12545
      private:
N
Niels Lohmann 已提交
12546 12547 12548 12549 12550 12551
        /*!
        @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 已提交
12552
        basic_json parse_internal(bool keep)
12553
        {
T
Théo DELRIEU 已提交
12554 12555 12556
            auto result = basic_json(value_t::discarded);

            switch (last_token)
N
Niels 已提交
12557
            {
T
Théo DELRIEU 已提交
12558
                case lexer::token_type::begin_object:
N
Niels 已提交
12559
                {
T
Théo DELRIEU 已提交
12560 12561 12562 12563 12564 12565 12566
                    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 已提交
12567

T
Théo DELRIEU 已提交
12568 12569
                    // read next token
                    get_token();
N
Niels 已提交
12570

T
Théo DELRIEU 已提交
12571 12572 12573 12574 12575 12576 12577 12578 12579 12580 12581
                    // closing } -> we are done
                    if (last_token == lexer::token_type::end_object)
                    {
                        get_token();
                        if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
                        {
                            result = basic_json(value_t::discarded);
                        }
                        return result;
                    }

12582 12583
                    // parse values
                    while (true)
T
Théo DELRIEU 已提交
12584 12585 12586 12587 12588 12589 12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605 12606 12607 12608 12609 12610 12611 12612 12613
                    {
                        // 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);
                        }
12614 12615 12616 12617 12618 12619 12620 12621 12622 12623 12624 12625

                        // comma -> next value
                        if (last_token == lexer::token_type::value_separator)
                        {
                            get_token();
                            continue;
                        }

                        // closing }
                        expect(lexer::token_type::end_object);
                        get_token();
                        break;
T
Théo DELRIEU 已提交
12626 12627
                    }

N
Niels 已提交
12628
                    if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
N
Niels 已提交
12629 12630 12631
                    {
                        result = basic_json(value_t::discarded);
                    }
T
Théo DELRIEU 已提交
12632

N
Niels 已提交
12633
                    return result;
N
Niels 已提交
12634 12635
                }

T
Théo DELRIEU 已提交
12636
                case lexer::token_type::begin_array:
12637
                {
T
Théo DELRIEU 已提交
12638 12639 12640 12641 12642 12643 12644 12645 12646 12647 12648 12649 12650
                    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 已提交
12651
                    {
N
Niels 已提交
12652
                        get_token();
T
Théo DELRIEU 已提交
12653 12654 12655 12656 12657
                        if (callback and not callback(--depth, parse_event_t::array_end, result))
                        {
                            result = basic_json(value_t::discarded);
                        }
                        return result;
N
Niels 已提交
12658 12659
                    }

12660 12661
                    // parse values
                    while (true)
N
Niels 已提交
12662
                    {
T
Théo DELRIEU 已提交
12663 12664 12665
                        // parse value
                        auto value = parse_internal(keep);
                        if (keep and not value.is_discarded())
N
Niels 已提交
12666
                        {
T
Théo DELRIEU 已提交
12667
                            result.push_back(std::move(value));
N
Niels 已提交
12668
                        }
12669 12670 12671 12672 12673 12674 12675 12676 12677 12678 12679 12680

                        // comma -> next value
                        if (last_token == lexer::token_type::value_separator)
                        {
                            get_token();
                            continue;
                        }

                        // closing ]
                        expect(lexer::token_type::end_array);
                        get_token();
                        break;
N
Niels 已提交
12681 12682
                    }

T
Théo DELRIEU 已提交
12683
                    if (keep and callback and not callback(--depth, parse_event_t::array_end, result))
N
Niels 已提交
12684
                    {
T
Théo DELRIEU 已提交
12685
                        result = basic_json(value_t::discarded);
N
Niels 已提交
12686
                    }
T
Théo DELRIEU 已提交
12687 12688

                    return result;
N
Niels 已提交
12689 12690
                }

T
Théo DELRIEU 已提交
12691
                case lexer::token_type::literal_null:
N
Niels 已提交
12692
                {
T
Théo DELRIEU 已提交
12693
                    result.m_type = value_t::null;
N
Niels Lohmann 已提交
12694
                    get_token();
T
Théo DELRIEU 已提交
12695
                    break;
N
Niels 已提交
12696 12697
                }

T
Théo DELRIEU 已提交
12698
                case lexer::token_type::value_string:
N
Niels 已提交
12699
                {
N
Niels Lohmann 已提交
12700
                    result = basic_json(m_lexer.get_string());
T
Théo DELRIEU 已提交
12701 12702
                    get_token();
                    break;
N
Niels 已提交
12703 12704
                }

T
Théo DELRIEU 已提交
12705
                case lexer::token_type::literal_true:
N
Niels 已提交
12706
                {
T
Théo DELRIEU 已提交
12707 12708
                    result.m_type = value_t::boolean;
                    result.m_value = true;
N
Niels Lohmann 已提交
12709
                    get_token();
T
Théo DELRIEU 已提交
12710
                    break;
N
Niels 已提交
12711 12712
                }

T
Théo DELRIEU 已提交
12713
                case lexer::token_type::literal_false:
N
Niels 已提交
12714
                {
T
Théo DELRIEU 已提交
12715 12716
                    result.m_type = value_t::boolean;
                    result.m_value = false;
N
Niels Lohmann 已提交
12717
                    get_token();
T
Théo DELRIEU 已提交
12718
                    break;
N
Niels 已提交
12719 12720
                }

N
Niels Lohmann 已提交
12721
                case lexer::token_type::value_unsigned:
N
Niels Lohmann 已提交
12722 12723 12724 12725 12726 12727 12728
                {
                    result.m_type = value_t::number_unsigned;
                    result.m_value = m_lexer.get_number_unsigned();
                    get_token();
                    break;
                }

N
Niels Lohmann 已提交
12729
                case lexer::token_type::value_integer:
N
Niels Lohmann 已提交
12730 12731 12732 12733 12734 12735 12736
                {
                    result.m_type = value_t::number_integer;
                    result.m_value = m_lexer.get_number_integer();
                    get_token();
                    break;
                }

12737
                case lexer::token_type::value_float:
N
Niels 已提交
12738
                {
N
Niels Lohmann 已提交
12739 12740 12741 12742 12743 12744 12745 12746 12747
                    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 已提交
12748 12749
                    get_token();
                    break;
N
Niels 已提交
12750
                }
12751

T
Théo DELRIEU 已提交
12752 12753 12754 12755 12756
                default:
                {
                    // the last token was unexpected
                    unexpect(last_token);
                }
12757 12758
            }

T
Théo DELRIEU 已提交
12759
            if (keep and callback and not callback(depth, parse_event_t::value, result))
12760
            {
T
Théo DELRIEU 已提交
12761
                result = basic_json(value_t::discarded);
N
Niels 已提交
12762
            }
T
Théo DELRIEU 已提交
12763
            return result;
N
Niels 已提交
12764 12765
        }

T
Théo DELRIEU 已提交
12766 12767
        /// get next token from lexer
        typename lexer::token_type get_token()
N
Niels 已提交
12768
        {
T
Théo DELRIEU 已提交
12769 12770
            last_token = m_lexer.scan();
            return last_token;
N
Niels 已提交
12771 12772
        }

N
Niels Lohmann 已提交
12773 12774 12775
        /*!
        @throw parse_error.101 if expected token did not occur
        */
T
Théo DELRIEU 已提交
12776
        void expect(typename lexer::token_type t) const
N
Niels 已提交
12777
        {
12778
            if (JSON_UNLIKELY(t != last_token))
T
Théo DELRIEU 已提交
12779
            {
N
Niels Lohmann 已提交
12780 12781 12782 12783 12784 12785 12786
                std::string error_msg = "syntax error - ";
                if (last_token == lexer::token_type::parse_error)
                {
                    error_msg += m_lexer.get_error_message() + "; last read: '" + m_lexer.get_token_string() + "'";
                }
                else
                {
N
Niels Lohmann 已提交
12787
                    error_msg += "unexpected " + std::string(lexer::token_type_name(last_token));
N
Niels Lohmann 已提交
12788 12789
                }

N
Niels Lohmann 已提交
12790
                error_msg += "; expected " + std::string(lexer::token_type_name(t));
12791
                JSON_THROW(parse_error::create(101, m_lexer.get_position(), error_msg));
T
Théo DELRIEU 已提交
12792
            }
N
Niels 已提交
12793 12794
        }

N
Niels Lohmann 已提交
12795 12796 12797
        /*!
        @throw parse_error.101 if unexpected token occurred
        */
T
Théo DELRIEU 已提交
12798
        void unexpect(typename lexer::token_type t) const
N
Niels 已提交
12799
        {
12800
            if (JSON_UNLIKELY(t == last_token))
T
Théo DELRIEU 已提交
12801
            {
N
Niels Lohmann 已提交
12802 12803 12804 12805 12806 12807 12808
                std::string error_msg = "syntax error - ";
                if (last_token == lexer::token_type::parse_error)
                {
                    error_msg += m_lexer.get_error_message() + "; last read '" + m_lexer.get_token_string() + "'";
                }
                else
                {
N
Niels Lohmann 已提交
12809
                    error_msg += "unexpected " + std::string(lexer::token_type_name(last_token));
N
Niels Lohmann 已提交
12810 12811
                }

12812
                JSON_THROW(parse_error::create(101, m_lexer.get_position(), error_msg));
T
Théo DELRIEU 已提交
12813
            }
N
Niels 已提交
12814 12815
        }

T
Théo DELRIEU 已提交
12816 12817 12818 12819 12820 12821 12822 12823 12824 12825
      private:
        /// current level of recursion
        int depth = 0;
        /// callback function
        const parser_callback_t callback = nullptr;
        /// the type of the last read token
        typename lexer::token_type last_token = lexer::token_type::uninitialized;
        /// the lexer
        lexer m_lexer;
    };
N
Niels 已提交
12826 12827

  public:
N
Niels 已提交
12828 12829 12830
    /*!
    @brief JSON Pointer

N
Niels 已提交
12831 12832 12833 12834
    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 已提交
12835
    @sa [RFC 6901](https://tools.ietf.org/html/rfc6901)
N
Niels 已提交
12836 12837

    @since version 2.0.0
N
Niels 已提交
12838
    */
N
Niels 已提交
12839 12840
    class json_pointer
    {
N
Niels 已提交
12841 12842 12843
        /// allow basic_json to access private members
        friend class basic_json;

T
Théo DELRIEU 已提交
12844
      public:
N
Niels 已提交
12845 12846 12847 12848 12849 12850 12851 12852 12853 12854
        /*!
        @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 已提交
12855 12856 12857 12858 12859 12860
        @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 已提交
12861 12862 12863

        @liveexample{The example shows the construction several valid JSON
        pointers as well as the exceptional behavior.,json_pointer}
N
Niels 已提交
12864

N
Niels 已提交
12865 12866 12867
        @since version 2.0.0
        */
        explicit json_pointer(const std::string& s = "")
T
Théo DELRIEU 已提交
12868 12869
            : reference_tokens(split(s))
        {}
N
Niels 已提交
12870

T
Théo DELRIEU 已提交
12871 12872
        /*!
        @brief return a string representation of the JSON pointer
N
Niels 已提交
12873

T
Théo DELRIEU 已提交
12874 12875 12876 12877
        @invariant For each JSON pointer `ptr`, it holds:
        @code {.cpp}
        ptr == json_pointer(ptr.to_string());
        @endcode
N
Niels 已提交
12878

T
Théo DELRIEU 已提交
12879
        @return a string representation of the JSON pointer
N
Niels 已提交
12880

T
Théo DELRIEU 已提交
12881 12882
        @liveexample{The example shows the result of `to_string`.,
        json_pointer__to_string}
N
Niels 已提交
12883

T
Théo DELRIEU 已提交
12884 12885 12886
        @since version 2.0.0
        */
        std::string to_string() const noexcept
N
Niels 已提交
12887
        {
T
Théo DELRIEU 已提交
12888 12889 12890 12891 12892 12893 12894
            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 已提交
12895

T
Théo DELRIEU 已提交
12896 12897
        /// @copydoc to_string()
        operator std::string() const
N
Niels 已提交
12898
        {
T
Théo DELRIEU 已提交
12899
            return to_string();
N
Niels 已提交
12900 12901
        }

T
Théo DELRIEU 已提交
12902
      private:
N
Niels Lohmann 已提交
12903 12904 12905 12906
        /*!
        @brief remove and return last reference pointer
        @throw out_of_range.405 if JSON pointer has no parent
        */
T
Théo DELRIEU 已提交
12907 12908 12909 12910
        std::string pop_back()
        {
            if (is_root())
            {
12911
                JSON_THROW(out_of_range::create(405, "JSON pointer has no parent"));
T
Théo DELRIEU 已提交
12912
            }
12913

T
Théo DELRIEU 已提交
12914 12915 12916 12917
            auto last = reference_tokens.back();
            reference_tokens.pop_back();
            return last;
        }
N
Niels 已提交
12918

T
Théo DELRIEU 已提交
12919 12920
        /// return whether pointer points to the root document
        bool is_root() const
N
Niels 已提交
12921
        {
T
Théo DELRIEU 已提交
12922
            return reference_tokens.empty();
N
Niels 已提交
12923 12924
        }

T
Théo DELRIEU 已提交
12925 12926 12927 12928
        json_pointer top() const
        {
            if (is_root())
            {
12929
                JSON_THROW(out_of_range::create(405, "JSON pointer has no parent"));
T
Théo DELRIEU 已提交
12930
            }
N
Niels 已提交
12931

T
Théo DELRIEU 已提交
12932 12933 12934 12935
            json_pointer result = *this;
            result.reference_tokens = {reference_tokens[0]};
            return result;
        }
N
Niels 已提交
12936

T
Théo DELRIEU 已提交
12937 12938
        /*!
        @brief create and return a reference to the pointed to value
12939

T
Théo DELRIEU 已提交
12940
        @complexity Linear in the number of reference tokens.
N
Niels Lohmann 已提交
12941 12942 12943

        @throw parse_error.109 if array index is not a number
        @throw type_error.313 if value cannot be unflattened
T
Théo DELRIEU 已提交
12944 12945
        */
        reference get_and_create(reference j) const
12946
        {
T
Théo DELRIEU 已提交
12947 12948 12949 12950 12951
            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 已提交
12952
            {
T
Théo DELRIEU 已提交
12953
                switch (result->m_type)
N
Niels 已提交
12954
                {
T
Théo DELRIEU 已提交
12955
                    case value_t::null:
N
Niels 已提交
12956
                    {
T
Théo DELRIEU 已提交
12957 12958 12959 12960 12961 12962 12963 12964 12965 12966 12967
                        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 已提交
12968
                    }
T
Théo DELRIEU 已提交
12969 12970

                    case value_t::object:
N
Niels 已提交
12971
                    {
T
Théo DELRIEU 已提交
12972
                        // create an entry in the object
N
Niels 已提交
12973
                        result = &result->operator[](reference_token);
T
Théo DELRIEU 已提交
12974
                        break;
N
Niels 已提交
12975
                    }
N
Niels 已提交
12976

T
Théo DELRIEU 已提交
12977 12978 12979
                    case value_t::array:
                    {
                        // create an entry in the array
12980 12981 12982 12983
                        JSON_TRY
                        {
                            result = &result->operator[](static_cast<size_type>(std::stoi(reference_token)));
                        }
N
Niels Lohmann 已提交
12984
                        JSON_CATCH (std::invalid_argument&)
12985
                        {
12986
                            JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number"));
12987
                        }
T
Théo DELRIEU 已提交
12988 12989
                        break;
                    }
12990

T
Théo DELRIEU 已提交
12991 12992 12993 12994 12995 12996 12997 12998 12999
                    /*
                    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:
                    {
13000
                        JSON_THROW(type_error::create(313, "invalid value to unflatten"));
T
Théo DELRIEU 已提交
13001
                    }
N
Niels 已提交
13002 13003
                }
            }
13004

T
Théo DELRIEU 已提交
13005 13006
            return *result;
        }
13007

T
Théo DELRIEU 已提交
13008 13009
        /*!
        @brief return a reference to the pointed to value
13010

T
Théo DELRIEU 已提交
13011 13012 13013 13014 13015
        @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 已提交
13016

T
Théo DELRIEU 已提交
13017
        @param[in] ptr  a JSON value
N
Niels 已提交
13018

T
Théo DELRIEU 已提交
13019
        @return reference to the JSON value pointed to by the JSON pointer
N
Niels 已提交
13020

T
Théo DELRIEU 已提交
13021
        @complexity Linear in the length of the JSON pointer.
13022

N
Niels Lohmann 已提交
13023 13024 13025
        @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 已提交
13026 13027
        */
        reference get_unchecked(pointer ptr) const
13028
        {
T
Théo DELRIEU 已提交
13029
            for (const auto& reference_token : reference_tokens)
13030
            {
T
Théo DELRIEU 已提交
13031 13032
                // convert null values to arrays or objects before continuing
                if (ptr->m_type == value_t::null)
13033
                {
T
Théo DELRIEU 已提交
13034 13035 13036 13037
                    // check if reference token is a number
                    const bool nums = std::all_of(reference_token.begin(),
                                                  reference_token.end(),
                                                  [](const char x)
N
Niels 已提交
13038
                    {
13039
                        return (x >= '0' and x <= '9');
T
Théo DELRIEU 已提交
13040
                    });
N
Niels 已提交
13041

T
Théo DELRIEU 已提交
13042 13043 13044
                    // change value to array for numbers or "-" or to object
                    // otherwise
                    if (nums or reference_token == "-")
N
Niels 已提交
13045
                    {
T
Théo DELRIEU 已提交
13046
                        *ptr = value_t::array;
N
Niels 已提交
13047 13048 13049
                    }
                    else
                    {
T
Théo DELRIEU 已提交
13050
                        *ptr = value_t::object;
N
Niels 已提交
13051
                    }
N
Niels 已提交
13052 13053
                }

T
Théo DELRIEU 已提交
13054
                switch (ptr->m_type)
N
Niels 已提交
13055
                {
T
Théo DELRIEU 已提交
13056 13057 13058 13059 13060 13061 13062 13063 13064 13065 13066 13067
                    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')
                        {
13068
                            JSON_THROW(parse_error::create(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
13069 13070 13071 13072
                        }

                        if (reference_token == "-")
                        {
N
Niels Lohmann 已提交
13073
                            // explicitly treat "-" as index beyond the end
T
Théo DELRIEU 已提交
13074 13075 13076 13077 13078
                            ptr = &ptr->operator[](ptr->m_value.array->size());
                        }
                        else
                        {
                            // convert array index to number; unchecked access
13079 13080 13081 13082
                            JSON_TRY
                            {
                                ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
                            }
N
Niels Lohmann 已提交
13083
                            JSON_CATCH (std::invalid_argument&)
13084
                            {
13085
                                JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number"));
13086
                            }
T
Théo DELRIEU 已提交
13087 13088 13089 13090 13091 13092
                        }
                        break;
                    }

                    default:
                    {
13093
                        JSON_THROW(out_of_range::create(404, "unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
13094
                    }
N
Niels 已提交
13095 13096
                }
            }
N
Niels 已提交
13097

T
Théo DELRIEU 已提交
13098 13099
            return *ptr;
        }
13100

N
Niels Lohmann 已提交
13101 13102 13103 13104 13105 13106
        /*!
        @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 已提交
13107
        reference get_checked(pointer ptr) const
N
Niels 已提交
13108
        {
T
Théo DELRIEU 已提交
13109
            for (const auto& reference_token : reference_tokens)
N
Niels 已提交
13110
            {
T
Théo DELRIEU 已提交
13111
                switch (ptr->m_type)
13112
                {
T
Théo DELRIEU 已提交
13113
                    case value_t::object:
N
Niels 已提交
13114
                    {
T
Théo DELRIEU 已提交
13115 13116 13117
                        // note: at performs range check
                        ptr = &ptr->at(reference_token);
                        break;
N
Niels 已提交
13118 13119
                    }

T
Théo DELRIEU 已提交
13120
                    case value_t::array:
N
Niels 已提交
13121
                    {
T
Théo DELRIEU 已提交
13122 13123 13124
                        if (reference_token == "-")
                        {
                            // "-" always fails the range check
13125 13126 13127
                            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 已提交
13128 13129 13130 13131 13132
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
13133
                            JSON_THROW(parse_error::create(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
13134
                        }
N
Niels 已提交
13135

T
Théo DELRIEU 已提交
13136
                        // note: at performs range check
13137 13138 13139 13140
                        JSON_TRY
                        {
                            ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
                        }
N
Niels Lohmann 已提交
13141
                        JSON_CATCH (std::invalid_argument&)
13142
                        {
13143
                            JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number"));
13144
                        }
T
Théo DELRIEU 已提交
13145 13146
                        break;
                    }
13147

T
Théo DELRIEU 已提交
13148 13149
                    default:
                    {
13150
                        JSON_THROW(out_of_range::create(404, "unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
13151
                    }
N
Niels 已提交
13152 13153 13154
                }
            }

T
Théo DELRIEU 已提交
13155 13156
            return *ptr;
        }
N
Niels 已提交
13157

T
Théo DELRIEU 已提交
13158 13159
        /*!
        @brief return a const reference to the pointed to value
N
Niels 已提交
13160

T
Théo DELRIEU 已提交
13161
        @param[in] ptr  a JSON value
13162

T
Théo DELRIEU 已提交
13163 13164
        @return const reference to the JSON value pointed to by the JSON
                pointer
N
Niels Lohmann 已提交
13165 13166 13167 13168 13169

        @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 已提交
13170 13171
        */
        const_reference get_unchecked(const_pointer ptr) const
N
Niels 已提交
13172
        {
T
Théo DELRIEU 已提交
13173
            for (const auto& reference_token : reference_tokens)
N
Niels 已提交
13174
            {
T
Théo DELRIEU 已提交
13175
                switch (ptr->m_type)
13176
                {
T
Théo DELRIEU 已提交
13177
                    case value_t::object:
N
Niels 已提交
13178
                    {
T
Théo DELRIEU 已提交
13179 13180 13181
                        // use unchecked object access
                        ptr = &ptr->operator[](reference_token);
                        break;
N
Niels 已提交
13182 13183
                    }

T
Théo DELRIEU 已提交
13184
                    case value_t::array:
N
Niels 已提交
13185
                    {
T
Théo DELRIEU 已提交
13186 13187 13188
                        if (reference_token == "-")
                        {
                            // "-" cannot be used for const access
13189 13190 13191
                            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 已提交
13192 13193 13194 13195 13196
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
13197
                            JSON_THROW(parse_error::create(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
13198
                        }
N
Niels 已提交
13199

T
Théo DELRIEU 已提交
13200
                        // use unchecked array access
13201 13202 13203 13204
                        JSON_TRY
                        {
                            ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
                        }
N
Niels Lohmann 已提交
13205
                        JSON_CATCH (std::invalid_argument&)
13206
                        {
13207
                            JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number"));
13208
                        }
T
Théo DELRIEU 已提交
13209 13210
                        break;
                    }
13211

T
Théo DELRIEU 已提交
13212 13213
                    default:
                    {
13214
                        JSON_THROW(out_of_range::create(404, "unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
13215
                    }
N
Niels 已提交
13216 13217 13218
                }
            }

T
Théo DELRIEU 已提交
13219 13220
            return *ptr;
        }
13221

N
Niels Lohmann 已提交
13222 13223 13224 13225 13226 13227
        /*!
        @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 已提交
13228
        const_reference get_checked(const_pointer ptr) const
13229
        {
T
Théo DELRIEU 已提交
13230
            for (const auto& reference_token : reference_tokens)
13231
            {
T
Théo DELRIEU 已提交
13232
                switch (ptr->m_type)
13233
                {
T
Théo DELRIEU 已提交
13234
                    case value_t::object:
N
Niels 已提交
13235
                    {
T
Théo DELRIEU 已提交
13236 13237 13238
                        // note: at performs range check
                        ptr = &ptr->at(reference_token);
                        break;
N
Niels 已提交
13239
                    }
13240

T
Théo DELRIEU 已提交
13241
                    case value_t::array:
N
Niels 已提交
13242
                    {
T
Théo DELRIEU 已提交
13243 13244 13245
                        if (reference_token == "-")
                        {
                            // "-" always fails the range check
13246 13247 13248
                            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 已提交
13249 13250 13251 13252 13253
                        }

                        // error condition (cf. RFC 6901, Sect. 4)
                        if (reference_token.size() > 1 and reference_token[0] == '0')
                        {
13254
                            JSON_THROW(parse_error::create(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
T
Théo DELRIEU 已提交
13255
                        }
13256

T
Théo DELRIEU 已提交
13257
                        // note: at performs range check
13258 13259 13260 13261
                        JSON_TRY
                        {
                            ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
                        }
N
Niels Lohmann 已提交
13262
                        JSON_CATCH (std::invalid_argument&)
13263
                        {
13264
                            JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number"));
13265
                        }
T
Théo DELRIEU 已提交
13266 13267
                        break;
                    }
13268

T
Théo DELRIEU 已提交
13269 13270
                    default:
                    {
13271
                        JSON_THROW(out_of_range::create(404, "unresolved reference token '" + reference_token + "'"));
T
Théo DELRIEU 已提交
13272
                    }
13273 13274
                }
            }
N
Niels 已提交
13275

T
Théo DELRIEU 已提交
13276
            return *ptr;
13277 13278
        }

N
Niels Lohmann 已提交
13279 13280 13281 13282 13283 13284 13285 13286 13287
        /*!
        @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 已提交
13288
        static std::vector<std::string> split(const std::string& reference_string)
13289
        {
T
Théo DELRIEU 已提交
13290 13291 13292 13293 13294 13295 13296 13297 13298 13299 13300
            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] != '/')
            {
13301
                JSON_THROW(parse_error::create(107, 1, "JSON pointer must be empty or begin with '/' - was: '" + reference_string + "'"));
T
Théo DELRIEU 已提交
13302
            }
N
Niels 已提交
13303

T
Théo DELRIEU 已提交
13304 13305 13306 13307 13308
            // 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 已提交
13309
                size_t slash = reference_string.find_first_of('/', 1),
T
Théo DELRIEU 已提交
13310 13311 13312 13313 13314 13315 13316 13317
                // 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 已提交
13318
                slash = reference_string.find_first_of('/', start))
T
Théo DELRIEU 已提交
13319 13320 13321 13322
            {
                // 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 已提交
13323

T
Théo DELRIEU 已提交
13324
                // check reference tokens are properly escaped
N
Niels Lohmann 已提交
13325
                for (size_t pos = reference_token.find_first_of('~');
T
Théo DELRIEU 已提交
13326
                        pos != std::string::npos;
N
Niels Lohmann 已提交
13327
                        pos = reference_token.find_first_of('~', pos + 1))
13328
                {
T
Théo DELRIEU 已提交
13329 13330 13331 13332 13333 13334 13335
                    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'))
                    {
13336
                        JSON_THROW(parse_error::create(108, 0, "escape character '~' must be followed with '0' or '1'"));
T
Théo DELRIEU 已提交
13337
                    }
N
Niels 已提交
13338
                }
T
Théo DELRIEU 已提交
13339 13340 13341 13342

                // finally, store the reference token
                unescape(reference_token);
                result.push_back(reference_token);
13343
            }
N
Niels 已提交
13344

T
Théo DELRIEU 已提交
13345
            return result;
N
Niels 已提交
13346
        }
N
Niels 已提交
13347

T
Théo DELRIEU 已提交
13348 13349
        /*!
        @brief replace all occurrences of a substring by another string
N
Niels 已提交
13350

T
Théo DELRIEU 已提交
13351 13352 13353 13354
        @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 已提交
13355

N
Niels Lohmann 已提交
13356 13357
        @pre The search string @a f must not be empty. **This precondition is
             enforced with an assertion.**
N
Niels 已提交
13358

T
Théo DELRIEU 已提交
13359 13360 13361 13362 13363 13364 13365
        @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 已提交
13366

T
Théo DELRIEU 已提交
13367 13368 13369 13370 13371 13372 13373
            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 已提交
13374

T
Théo DELRIEU 已提交
13375 13376 13377 13378 13379 13380 13381 13382
        /// 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 已提交
13383

T
Théo DELRIEU 已提交
13384 13385 13386 13387 13388 13389 13390 13391
        /// 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 已提交
13392

T
Théo DELRIEU 已提交
13393 13394 13395 13396
        /*!
        @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
13397

T
Théo DELRIEU 已提交
13398 13399 13400 13401 13402
        @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 已提交
13403
        {
T
Théo DELRIEU 已提交
13404
            switch (value.m_type)
N
Niels 已提交
13405
            {
T
Théo DELRIEU 已提交
13406
                case value_t::array:
13407
                {
T
Théo DELRIEU 已提交
13408 13409 13410 13411 13412 13413
                    if (value.m_value.array->empty())
                    {
                        // flatten empty array as null
                        result[reference_string] = nullptr;
                    }
                    else
N
Niels 已提交
13414
                    {
T
Théo DELRIEU 已提交
13415 13416 13417 13418 13419 13420
                        // 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 已提交
13421
                    }
T
Théo DELRIEU 已提交
13422
                    break;
N
Niels 已提交
13423 13424
                }

T
Théo DELRIEU 已提交
13425
                case value_t::object:
13426
                {
T
Théo DELRIEU 已提交
13427 13428 13429 13430 13431 13432
                    if (value.m_value.object->empty())
                    {
                        // flatten empty object as null
                        result[reference_string] = nullptr;
                    }
                    else
N
Niels 已提交
13433
                    {
T
Théo DELRIEU 已提交
13434 13435 13436 13437 13438 13439
                        // 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 已提交
13440
                    }
T
Théo DELRIEU 已提交
13441
                    break;
N
Niels 已提交
13442 13443
                }

T
Théo DELRIEU 已提交
13444 13445 13446 13447 13448 13449
                default:
                {
                    // add primitive value with its reference string
                    result[reference_string] = value;
                    break;
                }
N
Niels 已提交
13450 13451
            }
        }
N
Niels 已提交
13452

T
Théo DELRIEU 已提交
13453 13454
        /*!
        @param[in] value  flattened JSON
N
Niels 已提交
13455

T
Théo DELRIEU 已提交
13456
        @return unflattened JSON
N
Niels Lohmann 已提交
13457 13458 13459 13460 13461

        @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 已提交
13462 13463
        */
        static basic_json unflatten(const basic_json& value)
N
Niels 已提交
13464
        {
T
Théo DELRIEU 已提交
13465 13466
            if (not value.is_object())
            {
13467
                JSON_THROW(type_error::create(314, "only objects can be unflattened"));
T
Théo DELRIEU 已提交
13468
            }
N
Niels 已提交
13469

T
Théo DELRIEU 已提交
13470
            basic_json result;
N
Niels 已提交
13471

T
Théo DELRIEU 已提交
13472 13473
            // iterate the JSON object values
            for (const auto& element : *value.m_value.object)
N
Niels 已提交
13474
            {
T
Théo DELRIEU 已提交
13475 13476
                if (not element.second.is_primitive())
                {
13477
                    JSON_THROW(type_error::create(315, "values in object must be primitive"));
T
Théo DELRIEU 已提交
13478 13479 13480 13481 13482 13483 13484 13485
                }

                // 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 已提交
13486 13487
            }

T
Théo DELRIEU 已提交
13488
            return result;
N
Niels 已提交
13489
        }
N
Niels 已提交
13490

T
Théo DELRIEU 已提交
13491 13492 13493 13494 13495
        friend bool operator==(json_pointer const& lhs,
                               json_pointer const& rhs) noexcept
        {
            return lhs.reference_tokens == rhs.reference_tokens;
        }
13496

T
Théo DELRIEU 已提交
13497 13498 13499 13500 13501
        friend bool operator!=(json_pointer const& lhs,
                               json_pointer const& rhs) noexcept
        {
            return !(lhs == rhs);
        }
13502

T
Théo DELRIEU 已提交
13503 13504
        /// the reference tokens
        std::vector<std::string> reference_tokens {};
13505
    };
N
Niels 已提交
13506

N
Niels 已提交
13507 13508 13509
    //////////////////////////
    // JSON Pointer support //
    //////////////////////////
N
Niels 已提交
13510 13511 13512 13513

    /// @name JSON Pointer functions
    /// @{

N
Niels 已提交
13514 13515 13516 13517
    /*!
    @brief access specified element via JSON Pointer

    Uses a JSON pointer to retrieve a reference to the respective JSON value.
N
Niels 已提交
13518 13519 13520
    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 已提交
13521 13522 13523 13524 13525 13526 13527 13528 13529 13530 13531 13532 13533 13534 13535 13536 13537 13538

    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 已提交
13539 13540 13541
    @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 已提交
13542 13543 13544 13545 13546 13547 13548 13549 13550 13551 13552 13553 13554 13555 13556 13557 13558 13559 13560 13561 13562 13563 13564 13565

    @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 已提交
13566 13567 13568 13569
    @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 已提交
13570 13571 13572 13573 13574 13575 13576 13577 13578 13579 13580 13581 13582 13583 13584 13585 13586 13587 13588 13589

    @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

13590
    @throw parse_error.106 if an array index in the passed JSON pointer @a ptr
13591
    begins with '0'. See example below.
N
Niels 已提交
13592

13593
    @throw parse_error.109 if an array index in the passed JSON pointer @a ptr
13594
    is not a number. See example below.
N
Niels 已提交
13595

13596 13597 13598 13599
    @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
13600
    pointer @a ptr. As `at` provides checked access (and no elements are
13601 13602 13603 13604
    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.
13605

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

13609
    @complexity Constant.
N
Niels 已提交
13610 13611

    @since version 2.0.0
13612 13613

    @liveexample{The behavior is shown in the example.,at_json_pointer}
N
Niels 已提交
13614 13615 13616 13617 13618 13619 13620 13621 13622
    */
    reference at(const json_pointer& ptr)
    {
        return ptr.get_checked(this);
    }

    /*!
    @brief access specified element via JSON Pointer

N
Niels 已提交
13623 13624
    Returns a const reference to the element at with specified JSON pointer @a
    ptr, with bounds checking.
N
Niels 已提交
13625 13626 13627 13628 13629

    @param[in] ptr  JSON pointer to the desired element

    @return reference to the element pointed to by @a ptr

13630
    @throw parse_error.106 if an array index in the passed JSON pointer @a ptr
13631
    begins with '0'. See example below.
N
Niels 已提交
13632

13633
    @throw parse_error.109 if an array index in the passed JSON pointer @a ptr
13634
    is not a number. See example below.
N
Niels 已提交
13635

13636 13637
    @throw out_of_range.401 if an array index in the passed JSON pointer @a ptr
    is out of range. See example below.
13638

13639
    @throw out_of_range.402 if the array index '-' is used in the passed JSON
13640
    pointer @a ptr. As `at` provides checked access (and no elements are
13641
    implicitly inserted), the index '-' is always invalid. See example below.
13642

13643 13644
    @throw out_of_range.404 if the JSON pointer @a ptr can not be resolved.
    See example below.
N
Niels 已提交
13645

13646 13647 13648 13649
    @exceptionsafety Strong guarantee: if an exception is thrown, there are no
    changes in the JSON value.

    @complexity Constant.
N
Niels 已提交
13650 13651

    @since version 2.0.0
13652 13653

    @liveexample{The behavior is shown in the example.,at_json_pointer_const}
N
Niels 已提交
13654 13655 13656 13657 13658 13659
    */
    const_reference at(const json_pointer& ptr) const
    {
        return ptr.get_checked(this);
    }

N
Niels 已提交
13660
    /*!
N
Niels 已提交
13661 13662
    @brief return flattened JSON value

N
Niels 已提交
13663 13664 13665 13666
    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 已提交
13667

N
Niels Lohmann 已提交
13668
    @return an object that maps JSON pointers to primitive values
N
Niels 已提交
13669

N
Niels 已提交
13670 13671
    @note Empty objects and arrays are flattened to `null` and will not be
          reconstructed correctly by the @ref unflatten() function.
N
Niels 已提交
13672 13673 13674 13675 13676 13677 13678 13679 13680

    @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 已提交
13681 13682 13683 13684 13685 13686 13687
    */
    basic_json flatten() const
    {
        basic_json result(value_t::object);
        json_pointer::flatten("", *this, result);
        return result;
    }
N
Niels 已提交
13688 13689

    /*!
N
Niels 已提交
13690 13691 13692 13693 13694 13695 13696 13697 13698 13699
    @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 已提交
13700
    @return the original JSON from a flattened version
N
Niels 已提交
13701 13702 13703 13704 13705 13706 13707 13708

    @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 已提交
13709 13710 13711
    @throw type_error.314  if value is not an object
    @throw type_error.315  if object values are not primitve

N
Niels 已提交
13712 13713 13714 13715 13716 13717
    @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 已提交
13718
    */
N
Niels 已提交
13719
    basic_json unflatten() const
N
Niels 已提交
13720
    {
N
Niels 已提交
13721
        return json_pointer::unflatten(*this);
N
Niels 已提交
13722
    }
N
Niels 已提交
13723 13724

    /// @}
13725

N
Niels 已提交
13726 13727 13728 13729 13730 13731 13732
    //////////////////////////
    // JSON Patch functions //
    //////////////////////////

    /// @name JSON Patch functions
    /// @{

13733 13734 13735
    /*!
    @brief applies a JSON patch

N
Niels 已提交
13736 13737
    [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 已提交
13738
    this function, a JSON Patch is applied to the current JSON value by
N
Niels 已提交
13739 13740
    executing all operations from the patch.

N
Niels 已提交
13741
    @param[in] json_patch  JSON patch document
13742 13743
    @return patched document

N
Niels 已提交
13744 13745 13746 13747 13748
    @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 已提交
13749 13750 13751 13752
    @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 已提交
13753 13754
    attributes are missing); example: `"operation add must have member path"`

N
Niels Lohmann 已提交
13755 13756
    @throw out_of_range.401 if an array index is out of range.

13757 13758 13759
    @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 已提交
13760 13761 13762 13763 13764

    @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 已提交
13765 13766 13767 13768

    @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.
13769

N
Niels 已提交
13770 13771 13772 13773 13774 13775 13776 13777 13778
    @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
13779
    */
N
Niels 已提交
13780
    basic_json patch(const basic_json& json_patch) const
13781
    {
N
Niels 已提交
13782
        // make a working copy to apply the patch to
13783 13784
        basic_json result = *this;

N
Niels 已提交
13785 13786 13787
        // the valid JSON Patch operations
        enum class patch_operations {add, remove, replace, move, copy, test, invalid};

N
Niels Lohmann 已提交
13788
        const auto get_op = [](const std::string & op)
N
Niels 已提交
13789 13790 13791 13792 13793 13794 13795 13796 13797 13798 13799 13800 13801 13802 13803 13804 13805 13806 13807 13808 13809 13810 13811 13812 13813 13814 13815 13816 13817
        {
            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 已提交
13818
        // wrapper for "add" operation; add value at ptr
N
Niels 已提交
13819
        const auto operation_add = [&result](json_pointer & ptr, basic_json val)
N
Niels 已提交
13820
        {
N
Niels 已提交
13821 13822
            // adding to the root of the target document means replacing it
            if (ptr.is_root())
N
Niels 已提交
13823
            {
N
Niels 已提交
13824
                result = val;
N
Niels 已提交
13825
            }
N
Niels 已提交
13826
            else
N
Niels 已提交
13827
            {
N
Niels 已提交
13828 13829 13830
                // make sure the top element of the pointer exists
                json_pointer top_pointer = ptr.top();
                if (top_pointer != ptr)
N
Niels 已提交
13831
                {
N
Niels 已提交
13832
                    result.at(top_pointer);
N
Niels 已提交
13833
                }
N
Niels 已提交
13834 13835 13836 13837 13838 13839

                // 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 已提交
13840
                {
N
Niels 已提交
13841 13842 13843 13844 13845 13846 13847 13848 13849 13850 13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861
                    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
13862
                                JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range"));
N
Niels 已提交
13863 13864 13865 13866 13867 13868 13869 13870 13871 13872 13873 13874
                            }
                            else
                            {
                                // default case: insert add offset
                                parent.insert(parent.begin() + static_cast<difference_type>(idx), val);
                            }
                        }
                        break;
                    }

                    default:
                    {
N
Niels 已提交
13875 13876
                        // if there exists a parent it cannot be primitive
                        assert(false);  // LCOV_EXCL_LINE
N
Niels 已提交
13877
                    }
N
Niels 已提交
13878 13879 13880 13881
                }
            }
        };

N
Niels 已提交
13882
        // wrapper for "remove" operation; remove value at ptr
N
Niels 已提交
13883 13884
        const auto operation_remove = [&result](json_pointer & ptr)
        {
N
Niels 已提交
13885
            // get reference to parent of JSON pointer ptr
N
Niels 已提交
13886 13887
            const auto last_path = ptr.pop_back();
            basic_json& parent = result.at(ptr);
N
Niels 已提交
13888 13889

            // remove child
N
Niels 已提交
13890 13891
            if (parent.is_object())
            {
N
Niels 已提交
13892 13893 13894 13895 13896 13897 13898 13899
                // perform range check
                auto it = parent.find(last_path);
                if (it != parent.end())
                {
                    parent.erase(it);
                }
                else
                {
13900
                    JSON_THROW(out_of_range::create(403, "key '" + last_path + "' not found"));
N
Niels 已提交
13901
                }
N
Niels 已提交
13902 13903 13904
            }
            else if (parent.is_array())
            {
N
Niels 已提交
13905 13906
                // note erase performs range check
                parent.erase(static_cast<size_type>(std::stoi(last_path)));
N
Niels 已提交
13907 13908 13909
            }
        };

13910
        // type check: top level value must be an array
N
Niels 已提交
13911
        if (not json_patch.is_array())
N
Niels 已提交
13912
        {
13913
            JSON_THROW(parse_error::create(104, 0, "JSON patch must be an array of objects"));
N
Niels 已提交
13914 13915
        }

N
Niels Lohmann 已提交
13916
        // iterate and apply the operations
N
Niels 已提交
13917
        for (const auto& val : json_patch)
13918
        {
N
Niels 已提交
13919 13920 13921
            // wrapper to get a value for an operation
            const auto get_value = [&val](const std::string & op,
                                          const std::string & member,
N
Niels 已提交
13922
                                          bool string_type) -> basic_json&
13923
            {
N
Niels 已提交
13924 13925
                // find value
                auto it = val.m_value.object->find(member);
13926

N
Niels 已提交
13927 13928
                // context-sensitive error message
                const auto error_msg = (op == "op") ? "operation" : "operation '" + op + "'";
13929

N
Niels 已提交
13930 13931 13932
                // check if desired value is present
                if (it == val.m_value.object->end())
                {
13933
                    JSON_THROW(parse_error::create(105, 0, error_msg + " must have member '" + member + "'"));
N
Niels 已提交
13934
                }
13935

N
Niels 已提交
13936 13937 13938
                // check if result is of type string
                if (string_type and not it->second.is_string())
                {
13939
                    JSON_THROW(parse_error::create(105, 0, error_msg + " must have string member '" + member + "'"));
N
Niels 已提交
13940 13941 13942 13943 13944 13945
                }

                // no error: return value
                return it->second;
            };

13946
            // type check: every element of the array must be an object
N
Niels 已提交
13947
            if (not val.is_object())
13948
            {
13949
                JSON_THROW(parse_error::create(104, 0, "JSON patch must be an array of objects"));
13950 13951
            }

N
Niels 已提交
13952 13953 13954
            // collect mandatory members
            const std::string op = get_value("op", "op", true);
            const std::string path = get_value(op, "path", true);
N
oops  
Niels 已提交
13955
            json_pointer ptr(path);
13956

N
Niels 已提交
13957
            switch (get_op(op))
13958
            {
N
Niels 已提交
13959 13960 13961 13962 13963 13964 13965 13966 13967 13968 13969 13970 13971 13972 13973 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 14003 14004 14005 14006 14007
                case patch_operations::add:
                {
                    operation_add(ptr, get_value("add", "value", false));
                    break;
                }

                case patch_operations::remove:
                {
                    operation_remove(ptr);
                    break;
                }

                case patch_operations::replace:
                {
                    // the "path" location must exist - use at()
                    result.at(ptr) = get_value("replace", "value", false);
                    break;
                }

                case patch_operations::move:
                {
                    const std::string from_path = get_value("move", "from", true);
                    json_pointer from_ptr(from_path);

                    // the "from" location must exist - use at()
                    basic_json v = result.at(from_ptr);

                    // The move operation is functionally identical to a
                    // "remove" operation on the "from" location, followed
                    // immediately by an "add" operation at the target
                    // location with the value that was just removed.
                    operation_remove(from_ptr);
                    operation_add(ptr, v);
                    break;
                }

                case patch_operations::copy:
                {
                    const std::string from_path = get_value("copy", "from", true);;
                    const json_pointer from_ptr(from_path);

                    // the "from" location must exist - use at()
                    result[ptr] = result.at(from_ptr);
                    break;
                }

                case patch_operations::test:
                {
                    bool success = false;
14008
                    JSON_TRY
N
Niels 已提交
14009 14010 14011 14012 14013
                    {
                        // check if "value" matches the one at "path"
                        // the "path" location must exist - use at()
                        success = (result.at(ptr) == get_value("test", "value", false));
                    }
14014
                    JSON_CATCH (out_of_range&)
N
Niels 已提交
14015 14016 14017 14018 14019 14020 14021
                    {
                        // ignore out of range errors: success remains false
                    }

                    // throw an exception if test fails
                    if (not success)
                    {
14022
                        JSON_THROW(other_error::create(501, "unsuccessful: " + val.dump()));
N
Niels 已提交
14023 14024 14025 14026 14027 14028 14029 14030 14031
                    }

                    break;
                }

                case patch_operations::invalid:
                {
                    // op must be "add", "remove", "replace", "move", "copy", or
                    // "test"
14032
                    JSON_THROW(parse_error::create(105, 0, "operation value '" + op + "' is invalid"));
N
Niels 已提交
14033
                }
14034
            }
N
Niels 已提交
14035 14036 14037 14038 14039 14040 14041 14042 14043 14044 14045 14046 14047 14048 14049 14050 14051 14052 14053 14054
        }

        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 已提交
14055 14056
    @param[in] source  JSON value to compare from
    @param[in] target  JSON value to compare against
N
Niels 已提交
14057 14058 14059 14060 14061 14062 14063 14064 14065 14066 14067 14068 14069 14070 14071 14072 14073
    @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,
14074
                           const std::string& path = "")
N
Niels 已提交
14075 14076 14077 14078 14079 14080 14081 14082 14083 14084 14085 14086 14087 14088
    {
        // 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(
14089
            {
N
Niels 已提交
14090 14091 14092 14093 14094 14095 14096 14097
                {"op", "replace"},
                {"path", path},
                {"value", target}
            });
        }
        else
        {
            switch (source.type())
14098
            {
N
Niels 已提交
14099 14100 14101 14102 14103 14104 14105 14106 14107 14108 14109
                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 已提交
14110

N
Niels 已提交
14111 14112
                    // i now reached the end of at least one array
                    // in a second pass, traverse the remaining elements
N
Niels 已提交
14113

N
Niels 已提交
14114
                    // remove my remaining elements
N
Niels 已提交
14115
                    const auto end_index = static_cast<difference_type>(result.size());
N
Niels 已提交
14116 14117
                    while (i < source.size())
                    {
N
Niels 已提交
14118 14119
                        // add operations in reverse order to avoid invalid
                        // indices
N
Niels 已提交
14120
                        result.insert(result.begin() + end_index, object(
N
Niels 已提交
14121 14122 14123 14124 14125 14126 14127 14128 14129 14130 14131 14132 14133 14134 14135 14136 14137 14138 14139 14140 14141 14142 14143
                        {
                            {"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:
14144
                {
N
Niels 已提交
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 14182 14183 14184 14185 14186 14187 14188 14189 14190 14191 14192 14193 14194 14195 14196
                    // 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;
14197 14198 14199 14200 14201 14202
                }
            }
        }

        return result;
    }
N
Niels 已提交
14203 14204

    /// @}
N
Niels 已提交
14205 14206 14207 14208 14209 14210
};

/////////////
// presets //
/////////////

N
Niels 已提交
14211 14212 14213
/*!
@brief default JSON class

N
Niels 已提交
14214 14215
This type is the default specialization of the @ref basic_json class which
uses the standard template types.
N
Niels 已提交
14216

N
Niels 已提交
14217
@since version 1.0.0
N
Niels 已提交
14218
*/
N
Niels 已提交
14219
using json = basic_json<>;
N
Niels Lohmann 已提交
14220
} // namespace nlohmann
N
Niels 已提交
14221 14222


N
Niels 已提交
14223 14224 14225
///////////////////////
// nonmember support //
///////////////////////
N
Niels 已提交
14226 14227 14228

// specialization of std::swap, and std::hash
namespace std
T
Théo DELRIEU 已提交
14229 14230 14231 14232 14233 14234 14235 14236 14237 14238 14239 14240 14241 14242 14243 14244 14245 14246 14247
{
/*!
@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 已提交
14248
{
N
Niels 已提交
14249
    /*!
T
Théo DELRIEU 已提交
14250
    @brief return a hash value for a JSON object
N
Niels 已提交
14251

N
Niels 已提交
14252
    @since version 1.0.0
N
Niels 已提交
14253
    */
T
Théo DELRIEU 已提交
14254
    std::size_t operator()(const nlohmann::json& j) const
N
Niels 已提交
14255 14256
    {
        // a naive hashing via the string representation
N
Niels 已提交
14257 14258
        const auto& h = hash<nlohmann::json::string_t>();
        return h(j.dump());
N
Niels 已提交
14259
    }
T
Théo DELRIEU 已提交
14260
};
14261 14262 14263 14264 14265 14266 14267 14268 14269 14270 14271 14272 14273 14274 14275 14276

/// 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 已提交
14277
} // namespace std
N
Niels 已提交
14278 14279

/*!
N
Niels 已提交
14280 14281
@brief user-defined string literal for JSON values

N
Niels 已提交
14282
This operator implements a user-defined string literal for JSON objects. It
N
Niels 已提交
14283
can be used by adding `"_json"` to a string literal and returns a JSON object
N
Niels 已提交
14284
if no parse error occurred.
N
Niels 已提交
14285

N
Niels 已提交
14286
@param[in] s  a string representation of a JSON object
14287
@param[in] n  the length of string @a s
N
Niels 已提交
14288
@return a JSON object
N
Niels 已提交
14289

N
Niels 已提交
14290
@since version 1.0.0
N
Niels 已提交
14291
*/
14292
inline nlohmann::json operator "" _json(const char* s, std::size_t n)
N
Niels 已提交
14293
{
14294
    return nlohmann::json::parse(s, s + n);
N
Niels 已提交
14295 14296
}

N
Niels 已提交
14297 14298 14299
/*!
@brief user-defined string literal for JSON pointer

N
Niels 已提交
14300
This operator implements a user-defined string literal for JSON Pointers. It
N
Niels 已提交
14301
can be used by adding `"_json_pointer"` to a string literal and returns a JSON pointer
N
Niels 已提交
14302 14303 14304
object if no parse error occurred.

@param[in] s  a string representation of a JSON Pointer
14305
@param[in] n  the length of string @a s
N
Niels 已提交
14306 14307
@return a JSON pointer object

N
Niels 已提交
14308 14309
@since version 2.0.0
*/
14310
inline nlohmann::json::json_pointer operator "" _json_pointer(const char* s, std::size_t n)
N
Niels 已提交
14311
{
14312
    return nlohmann::json::json_pointer(std::string(s, n));
N
Niels 已提交
14313 14314
}

14315 14316 14317 14318
// restore GCC/clang diagnostic settings
#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
    #pragma GCC diagnostic pop
#endif
L
Lukas Barth 已提交
14319 14320 14321
#if defined(__clang__)
    #pragma GCC diagnostic pop
#endif
14322

14323 14324
// clean up
#undef JSON_CATCH
N
Niels Lohmann 已提交
14325 14326
#undef JSON_THROW
#undef JSON_TRY
N
Niels Lohmann 已提交
14327 14328
#undef JSON_LIKELY
#undef JSON_UNLIKELY
14329
#undef JSON_DEPRECATED
14330

N
Niels 已提交
14331
#endif