bes  Updated for version 3.20.8
rapidjson.h
Go to the documentation of this file.
1 // Tencent is pleased to support the open source community by making RapidJSON available.
2 //
3 // Copyright (C) 2015 THL A29 Limited, a Tencent company, and Milo Yip. All rights reserved.
4 //
5 // Licensed under the MIT License (the "License"); you may not use this file except
6 // in compliance with the License. You may obtain a copy of the License at
7 //
8 // http://opensource.org/licenses/MIT
9 //
10 // Unless required by applicable law or agreed to in writing, software distributed
11 // under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
12 // CONDITIONS OF ANY KIND, either express or implied. See the License for the
13 // specific language governing permissions and limitations under the License.
14 
15 #ifndef RAPIDJSON_RAPIDJSON_H_
16 #define RAPIDJSON_RAPIDJSON_H_
17 
39 #include <cstdlib> // malloc(), realloc(), free(), size_t
40 #include <cstring> // memset(), memcpy(), memmove(), memcmp()
41 
43 // RAPIDJSON_VERSION_STRING
44 //
45 // ALWAYS synchronize the following 3 macros with corresponding variables in /CMakeLists.txt.
46 //
47 
49 // token stringification
50 #define RAPIDJSON_STRINGIFY(x) RAPIDJSON_DO_STRINGIFY(x)
51 #define RAPIDJSON_DO_STRINGIFY(x) #x
52 
53 // token concatenation
54 #define RAPIDJSON_JOIN(X, Y) RAPIDJSON_DO_JOIN(X, Y)
55 #define RAPIDJSON_DO_JOIN(X, Y) RAPIDJSON_DO_JOIN2(X, Y)
56 #define RAPIDJSON_DO_JOIN2(X, Y) X##Y
58 
75 #define RAPIDJSON_MAJOR_VERSION 1
76 #define RAPIDJSON_MINOR_VERSION 1
77 #define RAPIDJSON_PATCH_VERSION 0
78 #define RAPIDJSON_VERSION_STRING \
79  RAPIDJSON_STRINGIFY(RAPIDJSON_MAJOR_VERSION.RAPIDJSON_MINOR_VERSION.RAPIDJSON_PATCH_VERSION)
80 
82 // RAPIDJSON_NAMESPACE_(BEGIN|END)
117 #ifndef RAPIDJSON_NAMESPACE
118 #define RAPIDJSON_NAMESPACE rapidjson
119 #endif
120 #ifndef RAPIDJSON_NAMESPACE_BEGIN
121 #define RAPIDJSON_NAMESPACE_BEGIN namespace RAPIDJSON_NAMESPACE {
122 #endif
123 #ifndef RAPIDJSON_NAMESPACE_END
124 #define RAPIDJSON_NAMESPACE_END }
125 #endif
126 
128 // RAPIDJSON_HAS_STDSTRING
129 
130 #ifndef RAPIDJSON_HAS_STDSTRING
131 #ifdef RAPIDJSON_DOXYGEN_RUNNING
132 #define RAPIDJSON_HAS_STDSTRING 1 // force generation of documentation
133 #else
134 #define RAPIDJSON_HAS_STDSTRING 0 // no std::string support by default
135 #endif
146 #endif // !defined(RAPIDJSON_HAS_STDSTRING)
147 
148 #if RAPIDJSON_HAS_STDSTRING
149 #include <string>
150 #endif // RAPIDJSON_HAS_STDSTRING
151 
153 // RAPIDJSON_NO_INT64DEFINE
154 
165 #ifndef RAPIDJSON_NO_INT64DEFINE
167 #if defined(_MSC_VER) && (_MSC_VER < 1800) // Visual Studio 2013
168 #include "msinttypes/stdint.h"
169 #include "msinttypes/inttypes.h"
170 #else
171 // Other compilers should have this.
172 #include <stdint.h>
173 #include <inttypes.h>
174 #endif
176 #ifdef RAPIDJSON_DOXYGEN_RUNNING
177 #define RAPIDJSON_NO_INT64DEFINE
178 #endif
179 #endif // RAPIDJSON_NO_INT64TYPEDEF
180 
182 // RAPIDJSON_FORCEINLINE
183 
184 #ifndef RAPIDJSON_FORCEINLINE
186 #if defined(_MSC_VER) && defined(NDEBUG)
187 #define RAPIDJSON_FORCEINLINE __forceinline
188 #elif defined(__GNUC__) && __GNUC__ >= 4 && defined(NDEBUG)
189 #define RAPIDJSON_FORCEINLINE __attribute__((always_inline))
190 #else
191 #define RAPIDJSON_FORCEINLINE
192 #endif
194 #endif // RAPIDJSON_FORCEINLINE
195 
197 // RAPIDJSON_ENDIAN
198 #define RAPIDJSON_LITTLEENDIAN 0
199 #define RAPIDJSON_BIGENDIAN 1
200 
202 
214 #ifndef RAPIDJSON_ENDIAN
215 // Detect with GCC 4.6's macro
216 # ifdef __BYTE_ORDER__
217 # if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
218 # define RAPIDJSON_ENDIAN RAPIDJSON_LITTLEENDIAN
219 # elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
220 # define RAPIDJSON_ENDIAN RAPIDJSON_BIGENDIAN
221 # else
222 # error Unknown machine endianness detected. User needs to define RAPIDJSON_ENDIAN.
223 # endif // __BYTE_ORDER__
224 // Detect with GLIBC's endian.h
225 # elif defined(__GLIBC__)
226 # include <endian.h>
227 # if (__BYTE_ORDER == __LITTLE_ENDIAN)
228 # define RAPIDJSON_ENDIAN RAPIDJSON_LITTLEENDIAN
229 # elif (__BYTE_ORDER == __BIG_ENDIAN)
230 # define RAPIDJSON_ENDIAN RAPIDJSON_BIGENDIAN
231 # else
232 # error Unknown machine endianness detected. User needs to define RAPIDJSON_ENDIAN.
233 # endif // __GLIBC__
234 // Detect with _LITTLE_ENDIAN and _BIG_ENDIAN macro
235 # elif defined(_LITTLE_ENDIAN) && !defined(_BIG_ENDIAN)
236 # define RAPIDJSON_ENDIAN RAPIDJSON_LITTLEENDIAN
237 # elif defined(_BIG_ENDIAN) && !defined(_LITTLE_ENDIAN)
238 # define RAPIDJSON_ENDIAN RAPIDJSON_BIGENDIAN
239 // Detect with architecture macros
240 # elif defined(__sparc) || defined(__sparc__) || defined(_POWER) || defined(__powerpc__) || defined(__ppc__) || defined(__hpux) || defined(__hppa) || defined(_MIPSEB) || defined(_POWER) || defined(__s390__)
241 # define RAPIDJSON_ENDIAN RAPIDJSON_BIGENDIAN
242 # elif defined(__i386__) || defined(__alpha__) || defined(__ia64) || defined(__ia64__) || defined(_M_IX86) || defined(_M_IA64) || defined(_M_ALPHA) || defined(__amd64) || defined(__amd64__) || defined(_M_AMD64) || defined(__x86_64) || defined(__x86_64__) || defined(_M_X64) || defined(__bfin__)
243 # define RAPIDJSON_ENDIAN RAPIDJSON_LITTLEENDIAN
244 # elif defined(_MSC_VER) && (defined(_M_ARM) || defined(_M_ARM64))
245 # define RAPIDJSON_ENDIAN RAPIDJSON_LITTLEENDIAN
246 # elif defined(RAPIDJSON_DOXYGEN_RUNNING)
247 # define RAPIDJSON_ENDIAN
248 # else
249 # error Unknown machine endianness detected. User needs to define RAPIDJSON_ENDIAN.
250 # endif
251 #endif // RAPIDJSON_ENDIAN
252 
254 // RAPIDJSON_64BIT
255 
257 #ifndef RAPIDJSON_64BIT
258 #if defined(__LP64__) || (defined(__x86_64__) && defined(__ILP32__)) || defined(_WIN64) || defined(__EMSCRIPTEN__)
259 #define RAPIDJSON_64BIT 1
260 #else
261 #define RAPIDJSON_64BIT 0
262 #endif
263 #endif // RAPIDJSON_64BIT
264 
266 // RAPIDJSON_ALIGN
267 
269 
275 #ifndef RAPIDJSON_ALIGN
276 #define RAPIDJSON_ALIGN(x) (((x) + static_cast<size_t>(7u)) & ~static_cast<size_t>(7u))
277 #endif
278 
280 // RAPIDJSON_UINT64_C2
281 
283 
288 #ifndef RAPIDJSON_UINT64_C2
289 #define RAPIDJSON_UINT64_C2(high32, low32) ((static_cast<uint64_t>(high32) << 32) | static_cast<uint64_t>(low32))
290 #endif
291 
293 // RAPIDJSON_48BITPOINTER_OPTIMIZATION
294 
296 
303 #ifndef RAPIDJSON_48BITPOINTER_OPTIMIZATION
304 #if defined(__amd64__) || defined(__amd64) || defined(__x86_64__) || defined(__x86_64) || defined(_M_X64) || defined(_M_AMD64)
305 #define RAPIDJSON_48BITPOINTER_OPTIMIZATION 1
306 #else
307 #define RAPIDJSON_48BITPOINTER_OPTIMIZATION 0
308 #endif
309 #endif // RAPIDJSON_48BITPOINTER_OPTIMIZATION
310 
311 #if RAPIDJSON_48BITPOINTER_OPTIMIZATION == 1
312 #if RAPIDJSON_64BIT != 1
313 #error RAPIDJSON_48BITPOINTER_OPTIMIZATION can only be set to 1 when RAPIDJSON_64BIT=1
314 #endif
315 #define RAPIDJSON_SETPOINTER(type, p, x) (p = reinterpret_cast<type *>((reinterpret_cast<uintptr_t>(p) & static_cast<uintptr_t>(RAPIDJSON_UINT64_C2(0xFFFF0000, 0x00000000))) | reinterpret_cast<uintptr_t>(reinterpret_cast<const void*>(x))))
316 #define RAPIDJSON_GETPOINTER(type, p) (reinterpret_cast<type *>(reinterpret_cast<uintptr_t>(p) & static_cast<uintptr_t>(RAPIDJSON_UINT64_C2(0x0000FFFF, 0xFFFFFFFF))))
317 #else
318 #define RAPIDJSON_SETPOINTER(type, p, x) (p = (x))
319 #define RAPIDJSON_GETPOINTER(type, p) (p)
320 #endif
321 
323 // RAPIDJSON_SSE2/RAPIDJSON_SSE42/RAPIDJSON_NEON/RAPIDJSON_SIMD
324 
351 #if defined(RAPIDJSON_SSE2) || defined(RAPIDJSON_SSE42) \
352  || defined(RAPIDJSON_NEON) || defined(RAPIDJSON_DOXYGEN_RUNNING)
353 #define RAPIDJSON_SIMD
354 #endif
355 
357 // RAPIDJSON_NO_SIZETYPEDEFINE
358 
359 #ifndef RAPIDJSON_NO_SIZETYPEDEFINE
375 #ifdef RAPIDJSON_DOXYGEN_RUNNING
376 #define RAPIDJSON_NO_SIZETYPEDEFINE
377 #endif
380 
384 typedef unsigned SizeType;
386 #endif
387 
388 // always import std::size_t to rapidjson namespace
390 using std::size_t;
392 
394 // RAPIDJSON_ASSERT
395 
397 
404 #ifndef RAPIDJSON_ASSERT
405 #include <cassert>
406 #define RAPIDJSON_ASSERT(x) assert(x)
407 #endif // RAPIDJSON_ASSERT
408 
410 // RAPIDJSON_STATIC_ASSERT
411 
412 // Prefer C++11 static_assert, if available
413 #ifndef RAPIDJSON_STATIC_ASSERT
414 #if __cplusplus >= 201103L || ( defined(_MSC_VER) && _MSC_VER >= 1800 )
415 #define RAPIDJSON_STATIC_ASSERT(x) \
416  static_assert(x, RAPIDJSON_STRINGIFY(x))
417 #endif // C++11
418 #endif // RAPIDJSON_STATIC_ASSERT
419 
420 // Adopt C++03 implementation from boost
421 #ifndef RAPIDJSON_STATIC_ASSERT
422 #ifndef __clang__
424 #endif
426 template <bool x> struct STATIC_ASSERTION_FAILURE;
427 template <> struct STATIC_ASSERTION_FAILURE<true> { enum { value = 1 }; };
428 template <size_t x> struct StaticAssertTest {};
430 
431 #if defined(__GNUC__) || defined(__clang__)
432 #define RAPIDJSON_STATIC_ASSERT_UNUSED_ATTRIBUTE __attribute__((unused))
433 #else
434 #define RAPIDJSON_STATIC_ASSERT_UNUSED_ATTRIBUTE
435 #endif
436 #ifndef __clang__
438 #endif
439 
445 #define RAPIDJSON_STATIC_ASSERT(x) \
446  typedef ::RAPIDJSON_NAMESPACE::StaticAssertTest< \
447  sizeof(::RAPIDJSON_NAMESPACE::STATIC_ASSERTION_FAILURE<bool(x) >)> \
448  RAPIDJSON_JOIN(StaticAssertTypedef, __LINE__) RAPIDJSON_STATIC_ASSERT_UNUSED_ATTRIBUTE
449 #endif // RAPIDJSON_STATIC_ASSERT
450 
452 // RAPIDJSON_LIKELY, RAPIDJSON_UNLIKELY
453 
455 
459 #ifndef RAPIDJSON_LIKELY
460 #if defined(__GNUC__) || defined(__clang__)
461 #define RAPIDJSON_LIKELY(x) __builtin_expect(!!(x), 1)
462 #else
463 #define RAPIDJSON_LIKELY(x) (x)
464 #endif
465 #endif
466 
468 
472 #ifndef RAPIDJSON_UNLIKELY
473 #if defined(__GNUC__) || defined(__clang__)
474 #define RAPIDJSON_UNLIKELY(x) __builtin_expect(!!(x), 0)
475 #else
476 #define RAPIDJSON_UNLIKELY(x) (x)
477 #endif
478 #endif
479 
481 // Helpers
482 
484 
485 #define RAPIDJSON_MULTILINEMACRO_BEGIN do {
486 #define RAPIDJSON_MULTILINEMACRO_END \
487 } while((void)0, 0)
488 
489 // adopted from Boost
490 #define RAPIDJSON_VERSION_CODE(x,y,z) \
491  (((x)*100000) + ((y)*100) + (z))
492 
493 #if defined(__has_builtin)
494 #define RAPIDJSON_HAS_BUILTIN(x) __has_builtin(x)
495 #else
496 #define RAPIDJSON_HAS_BUILTIN(x) 0
497 #endif
498 
500 // RAPIDJSON_DIAG_PUSH/POP, RAPIDJSON_DIAG_OFF
501 
502 #if defined(__GNUC__)
503 #define RAPIDJSON_GNUC \
504  RAPIDJSON_VERSION_CODE(__GNUC__,__GNUC_MINOR__,__GNUC_PATCHLEVEL__)
505 #endif
506 
507 #if defined(__clang__) || (defined(RAPIDJSON_GNUC) && RAPIDJSON_GNUC >= RAPIDJSON_VERSION_CODE(4,2,0))
508 
509 #define RAPIDJSON_PRAGMA(x) _Pragma(RAPIDJSON_STRINGIFY(x))
510 #define RAPIDJSON_DIAG_PRAGMA(x) RAPIDJSON_PRAGMA(GCC diagnostic x)
511 #define RAPIDJSON_DIAG_OFF(x) \
512  RAPIDJSON_DIAG_PRAGMA(ignored RAPIDJSON_STRINGIFY(RAPIDJSON_JOIN(-W,x)))
513 
514 // push/pop support in Clang and GCC>=4.6
515 #if defined(__clang__) || (defined(RAPIDJSON_GNUC) && RAPIDJSON_GNUC >= RAPIDJSON_VERSION_CODE(4,6,0))
516 #define RAPIDJSON_DIAG_PUSH RAPIDJSON_DIAG_PRAGMA(push)
517 #define RAPIDJSON_DIAG_POP RAPIDJSON_DIAG_PRAGMA(pop)
518 #else // GCC >= 4.2, < 4.6
519 #define RAPIDJSON_DIAG_PUSH /* ignored */
520 #define RAPIDJSON_DIAG_POP /* ignored */
521 #endif
522 
523 #elif defined(_MSC_VER)
524 
525 // pragma (MSVC specific)
526 #define RAPIDJSON_PRAGMA(x) __pragma(x)
527 #define RAPIDJSON_DIAG_PRAGMA(x) RAPIDJSON_PRAGMA(warning(x))
528 
529 #define RAPIDJSON_DIAG_OFF(x) RAPIDJSON_DIAG_PRAGMA(disable: x)
530 #define RAPIDJSON_DIAG_PUSH RAPIDJSON_DIAG_PRAGMA(push)
531 #define RAPIDJSON_DIAG_POP RAPIDJSON_DIAG_PRAGMA(pop)
532 
533 #else
534 
535 #define RAPIDJSON_DIAG_OFF(x) /* ignored */
536 #define RAPIDJSON_DIAG_PUSH /* ignored */
537 #define RAPIDJSON_DIAG_POP /* ignored */
538 
539 #endif // RAPIDJSON_DIAG_*
540 
542 // C++11 features
543 
544 #ifndef RAPIDJSON_HAS_CXX11_RVALUE_REFS
545 #if defined(__clang__)
546 #if __has_feature(cxx_rvalue_references) && \
547  (defined(_MSC_VER) || defined(_LIBCPP_VERSION) || defined(__GLIBCXX__) && __GLIBCXX__ >= 20080306)
548 #define RAPIDJSON_HAS_CXX11_RVALUE_REFS 1
549 #else
550 #define RAPIDJSON_HAS_CXX11_RVALUE_REFS 0
551 #endif
552 #elif (defined(RAPIDJSON_GNUC) && (RAPIDJSON_GNUC >= RAPIDJSON_VERSION_CODE(4,3,0)) && defined(__GXX_EXPERIMENTAL_CXX0X__)) || \
553  (defined(_MSC_VER) && _MSC_VER >= 1600) || \
554  (defined(__SUNPRO_CC) && __SUNPRO_CC >= 0x5140 && defined(__GXX_EXPERIMENTAL_CXX0X__))
555 
556 #define RAPIDJSON_HAS_CXX11_RVALUE_REFS 1
557 #else
558 #define RAPIDJSON_HAS_CXX11_RVALUE_REFS 0
559 #endif
560 #endif // RAPIDJSON_HAS_CXX11_RVALUE_REFS
561 
562 #ifndef RAPIDJSON_HAS_CXX11_NOEXCEPT
563 #if defined(__clang__)
564 #define RAPIDJSON_HAS_CXX11_NOEXCEPT __has_feature(cxx_noexcept)
565 #elif (defined(RAPIDJSON_GNUC) && (RAPIDJSON_GNUC >= RAPIDJSON_VERSION_CODE(4,6,0)) && defined(__GXX_EXPERIMENTAL_CXX0X__)) || \
566  (defined(_MSC_VER) && _MSC_VER >= 1900) || \
567  (defined(__SUNPRO_CC) && __SUNPRO_CC >= 0x5140 && defined(__GXX_EXPERIMENTAL_CXX0X__))
568 #define RAPIDJSON_HAS_CXX11_NOEXCEPT 1
569 #else
570 #define RAPIDJSON_HAS_CXX11_NOEXCEPT 0
571 #endif
572 #endif
573 #if RAPIDJSON_HAS_CXX11_NOEXCEPT
574 #define RAPIDJSON_NOEXCEPT noexcept
575 #else
576 #define RAPIDJSON_NOEXCEPT /* noexcept */
577 #endif // RAPIDJSON_HAS_CXX11_NOEXCEPT
578 
579 // no automatic detection, yet
580 #ifndef RAPIDJSON_HAS_CXX11_TYPETRAITS
581 #if (defined(_MSC_VER) && _MSC_VER >= 1700)
582 #define RAPIDJSON_HAS_CXX11_TYPETRAITS 1
583 #else
584 #define RAPIDJSON_HAS_CXX11_TYPETRAITS 0
585 #endif
586 #endif
587 
588 #ifndef RAPIDJSON_HAS_CXX11_RANGE_FOR
589 #if defined(__clang__)
590 #define RAPIDJSON_HAS_CXX11_RANGE_FOR __has_feature(cxx_range_for)
591 #elif (defined(RAPIDJSON_GNUC) && (RAPIDJSON_GNUC >= RAPIDJSON_VERSION_CODE(4,6,0)) && defined(__GXX_EXPERIMENTAL_CXX0X__)) || \
592  (defined(_MSC_VER) && _MSC_VER >= 1700) || \
593  (defined(__SUNPRO_CC) && __SUNPRO_CC >= 0x5140 && defined(__GXX_EXPERIMENTAL_CXX0X__))
594 #define RAPIDJSON_HAS_CXX11_RANGE_FOR 1
595 #else
596 #define RAPIDJSON_HAS_CXX11_RANGE_FOR 0
597 #endif
598 #endif // RAPIDJSON_HAS_CXX11_RANGE_FOR
599 
601 // C++17 features
602 
603 #if defined(__has_cpp_attribute)
604 # if __has_cpp_attribute(fallthrough)
605 # define RAPIDJSON_DELIBERATE_FALLTHROUGH [[fallthrough]]
606 # else
607 # define RAPIDJSON_DELIBERATE_FALLTHROUGH
608 # endif
609 #else
610 # define RAPIDJSON_DELIBERATE_FALLTHROUGH
611 #endif
612 
614 
616 
627 // RAPIDJSON_NOEXCEPT_ASSERT
628 
629 #ifndef RAPIDJSON_NOEXCEPT_ASSERT
630 #ifdef RAPIDJSON_ASSERT_THROWS
631 #if RAPIDJSON_HAS_CXX11_NOEXCEPT
632 #define RAPIDJSON_NOEXCEPT_ASSERT(x)
633 #else
634 #include <cassert>
635 #define RAPIDJSON_NOEXCEPT_ASSERT(x) assert(x)
636 #endif // RAPIDJSON_HAS_CXX11_NOEXCEPT
637 #else
638 #define RAPIDJSON_NOEXCEPT_ASSERT(x) RAPIDJSON_ASSERT(x)
639 #endif // RAPIDJSON_ASSERT_THROWS
640 #endif // RAPIDJSON_NOEXCEPT_ASSERT
641 
643 // new/delete
644 
645 #ifndef RAPIDJSON_NEW
647 #define RAPIDJSON_NEW(TypeName) new TypeName
648 #endif
649 #ifndef RAPIDJSON_DELETE
651 #define RAPIDJSON_DELETE(x) delete x
652 #endif
653 
655 // Type
656 
662 
664 enum Type {
665  kNullType = 0,
667  kTrueType = 2,
671  kNumberType = 6
672 };
673 
675 
676 #endif // RAPIDJSON_RAPIDJSON_H_
#define RAPIDJSON_NAMESPACE_BEGIN
provide custom rapidjson namespace (opening expression)
Definition: rapidjson.h:121
#define RAPIDJSON_NAMESPACE_END
provide custom rapidjson namespace (closing expression)
Definition: rapidjson.h:124
Type
Type of JSON value.
Definition: rapidjson.h:664
@ kFalseType
false
Definition: rapidjson.h:666
@ kObjectType
object
Definition: rapidjson.h:668
@ kTrueType
true
Definition: rapidjson.h:667
@ kStringType
string
Definition: rapidjson.h:670
@ kNullType
null
Definition: rapidjson.h:665
@ kArrayType
array
Definition: rapidjson.h:669
@ kNumberType
number
Definition: rapidjson.h:671
RAPIDJSON_NAMESPACE_BEGIN typedef unsigned SizeType
Size type (for string lengths, array sizes, etc.)
Definition: rapidjson.h:384