| // Tencent is pleased to support the open source community by making RapidJSON available. |
| // |
| // Copyright (C) 2015 THL A29 Limited, a Tencent company, and Milo Yip. |
| // |
| // Licensed under the MIT License (the "License"); you may not use this file except |
| // in compliance with the License. You may obtain a copy of the License at |
| // |
| // http://opensource.org/licenses/MIT |
| // |
| // Unless required by applicable law or agreed to in writing, software distributed |
| // under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR |
| // CONDITIONS OF ANY KIND, either express or implied. See the License for the |
| // specific language governing permissions and limitations under the License. |
| |
| #ifndef RAPIDJSON_RAPIDJSON_H_ |
| #define RAPIDJSON_RAPIDJSON_H_ |
| |
| /*!\file rapidjson.h |
| \brief common definitions and configuration |
| |
| \see RAPIDJSON_CONFIG |
| */ |
| |
| /*! \defgroup RAPIDJSON_CONFIG RapidJSON configuration |
| \brief Configuration macros for library features |
| |
| Some RapidJSON features are configurable to adapt the library to a wide |
| variety of platforms, environments and usage scenarios. Most of the |
| features can be configured in terms of overridden or predefined |
| preprocessor macros at compile-time. |
| |
| Some additional customization is available in the \ref RAPIDJSON_ERRORS APIs. |
| |
| \note These macros should be given on the compiler command-line |
| (where applicable) to avoid inconsistent values when compiling |
| different translation units of a single application. |
| */ |
| |
| #include <cstdlib> // malloc(), realloc(), free(), size_t |
| #include <cstring> // memset(), memcpy(), memmove(), memcmp() |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // RAPIDJSON_VERSION_STRING |
| // |
| // ALWAYS synchronize the following 3 macros with corresponding variables in /CMakeLists.txt. |
| // |
| |
| //!@cond RAPIDJSON_HIDDEN_FROM_DOXYGEN |
| // token stringification |
| #define RAPIDJSON_STRINGIFY(x) RAPIDJSON_DO_STRINGIFY(x) |
| #define RAPIDJSON_DO_STRINGIFY(x) #x |
| |
| // token concatenation |
| #define RAPIDJSON_JOIN(X, Y) RAPIDJSON_DO_JOIN(X, Y) |
| #define RAPIDJSON_DO_JOIN(X, Y) RAPIDJSON_DO_JOIN2(X, Y) |
| #define RAPIDJSON_DO_JOIN2(X, Y) X##Y |
| //!@endcond |
| |
| /*! \def RAPIDJSON_MAJOR_VERSION |
| \ingroup RAPIDJSON_CONFIG |
| \brief Major version of RapidJSON in integer. |
| */ |
| /*! \def RAPIDJSON_MINOR_VERSION |
| \ingroup RAPIDJSON_CONFIG |
| \brief Minor version of RapidJSON in integer. |
| */ |
| /*! \def RAPIDJSON_PATCH_VERSION |
| \ingroup RAPIDJSON_CONFIG |
| \brief Patch version of RapidJSON in integer. |
| */ |
| /*! \def RAPIDJSON_VERSION_STRING |
| \ingroup RAPIDJSON_CONFIG |
| \brief Version of RapidJSON in "<major>.<minor>.<patch>" string format. |
| */ |
| #define RAPIDJSON_MAJOR_VERSION 1 |
| #define RAPIDJSON_MINOR_VERSION 1 |
| #define RAPIDJSON_PATCH_VERSION 0 |
| #define RAPIDJSON_VERSION_STRING \ |
| RAPIDJSON_STRINGIFY(RAPIDJSON_MAJOR_VERSION.RAPIDJSON_MINOR_VERSION.RAPIDJSON_PATCH_VERSION) |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // RAPIDJSON_NAMESPACE_(BEGIN|END) |
| /*! \def RAPIDJSON_NAMESPACE |
| \ingroup RAPIDJSON_CONFIG |
| \brief provide custom rapidjson namespace |
| |
| In order to avoid symbol clashes and/or "One Definition Rule" errors |
| between multiple inclusions of (different versions of) RapidJSON in |
| a single binary, users can customize the name of the main RapidJSON |
| namespace. |
| |
| In case of a single nesting level, defining \c RAPIDJSON_NAMESPACE |
| to a custom name (e.g. \c MyRapidJSON) is sufficient. If multiple |
| levels are needed, both \ref RAPIDJSON_NAMESPACE_BEGIN and \ref |
| RAPIDJSON_NAMESPACE_END need to be defined as well: |
| |
| \code |
| // in some .cpp file |
| #define RAPIDJSON_NAMESPACE my::rapidjson |
| #define RAPIDJSON_NAMESPACE_BEGIN namespace my { namespace rapidjson { |
| #define RAPIDJSON_NAMESPACE_END } } |
| #include "rapidjson/..." |
| \endcode |
| |
| \see rapidjson |
| */ |
| /*! \def RAPIDJSON_NAMESPACE_BEGIN |
| \ingroup RAPIDJSON_CONFIG |
| \brief provide custom rapidjson namespace (opening expression) |
| \see RAPIDJSON_NAMESPACE |
| */ |
| /*! \def RAPIDJSON_NAMESPACE_END |
| \ingroup RAPIDJSON_CONFIG |
| \brief provide custom rapidjson namespace (closing expression) |
| \see RAPIDJSON_NAMESPACE |
| */ |
| #ifndef RAPIDJSON_NAMESPACE |
| #define RAPIDJSON_NAMESPACE rapidjson |
| #endif |
| #ifndef RAPIDJSON_NAMESPACE_BEGIN |
| #define RAPIDJSON_NAMESPACE_BEGIN namespace RAPIDJSON_NAMESPACE { |
| #endif |
| #ifndef RAPIDJSON_NAMESPACE_END |
| #define RAPIDJSON_NAMESPACE_END } |
| #endif |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // __cplusplus macro |
| |
| //!@cond RAPIDJSON_HIDDEN_FROM_DOXYGEN |
| |
| #if defined(_MSC_VER) |
| #define RAPIDJSON_CPLUSPLUS _MSVC_LANG |
| #else |
| #define RAPIDJSON_CPLUSPLUS __cplusplus |
| #endif |
| |
| //!@endcond |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // RAPIDJSON_HAS_STDSTRING |
| |
| #ifndef RAPIDJSON_HAS_STDSTRING |
| #ifdef RAPIDJSON_DOXYGEN_RUNNING |
| #define RAPIDJSON_HAS_STDSTRING 1 // force generation of documentation |
| #else |
| #define RAPIDJSON_HAS_STDSTRING 0 // no std::string support by default |
| #endif |
| /*! \def RAPIDJSON_HAS_STDSTRING |
| \ingroup RAPIDJSON_CONFIG |
| \brief Enable RapidJSON support for \c std::string |
| |
| By defining this preprocessor symbol to \c 1, several convenience functions for using |
| \ref rapidjson::GenericValue with \c std::string are enabled, especially |
| for construction and comparison. |
| |
| \hideinitializer |
| */ |
| #endif // !defined(RAPIDJSON_HAS_STDSTRING) |
| |
| #if RAPIDJSON_HAS_STDSTRING |
| #include <string> |
| #endif // RAPIDJSON_HAS_STDSTRING |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // RAPIDJSON_USE_MEMBERSMAP |
| |
| /*! \def RAPIDJSON_USE_MEMBERSMAP |
| \ingroup RAPIDJSON_CONFIG |
| \brief Enable RapidJSON support for object members handling in a \c std::multimap |
| |
| By defining this preprocessor symbol to \c 1, \ref rapidjson::GenericValue object |
| members are stored in a \c std::multimap for faster lookup and deletion times, a |
| trade off with a slightly slower insertion time and a small object allocat(or)ed |
| memory overhead. |
| |
| \hideinitializer |
| */ |
| #ifndef RAPIDJSON_USE_MEMBERSMAP |
| #define RAPIDJSON_USE_MEMBERSMAP 0 // not by default |
| #endif |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // RAPIDJSON_NO_INT64DEFINE |
| |
| /*! \def RAPIDJSON_NO_INT64DEFINE |
| \ingroup RAPIDJSON_CONFIG |
| \brief Use external 64-bit integer types. |
| |
| RapidJSON requires the 64-bit integer types \c int64_t and \c uint64_t types |
| to be available at global scope. |
| |
| If users have their own definition, define RAPIDJSON_NO_INT64DEFINE to |
| prevent RapidJSON from defining its own types. |
| */ |
| #ifndef RAPIDJSON_NO_INT64DEFINE |
| //!@cond RAPIDJSON_HIDDEN_FROM_DOXYGEN |
| #if defined(_MSC_VER) && (_MSC_VER < 1800) // Visual Studio 2013 |
| #include "msinttypes/stdint.h" |
| #include "msinttypes/inttypes.h" |
| #else |
| // Other compilers should have this. |
| #include <stdint.h> |
| #include <inttypes.h> |
| #endif |
| //!@endcond |
| #ifdef RAPIDJSON_DOXYGEN_RUNNING |
| #define RAPIDJSON_NO_INT64DEFINE |
| #endif |
| #endif // RAPIDJSON_NO_INT64TYPEDEF |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // RAPIDJSON_FORCEINLINE |
| |
| #ifndef RAPIDJSON_FORCEINLINE |
| //!@cond RAPIDJSON_HIDDEN_FROM_DOXYGEN |
| #if defined(_MSC_VER) && defined(NDEBUG) |
| #define RAPIDJSON_FORCEINLINE __forceinline |
| #elif defined(__GNUC__) && __GNUC__ >= 4 && defined(NDEBUG) |
| #define RAPIDJSON_FORCEINLINE __attribute__((always_inline)) |
| #else |
| #define RAPIDJSON_FORCEINLINE |
| #endif |
| //!@endcond |
| #endif // RAPIDJSON_FORCEINLINE |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // RAPIDJSON_ENDIAN |
| #define RAPIDJSON_LITTLEENDIAN 0 //!< Little endian machine |
| #define RAPIDJSON_BIGENDIAN 1 //!< Big endian machine |
| |
| //! Endianness of the machine. |
| /*! |
| \def RAPIDJSON_ENDIAN |
| \ingroup RAPIDJSON_CONFIG |
| |
| GCC 4.6 provided macro for detecting endianness of the target machine. But other |
| compilers may not have this. User can define RAPIDJSON_ENDIAN to either |
| \ref RAPIDJSON_LITTLEENDIAN or \ref RAPIDJSON_BIGENDIAN. |
| |
| Default detection implemented with reference to |
| \li https://gcc.gnu.org/onlinedocs/gcc-4.6.0/cpp/Common-Predefined-Macros.html |
| \li http://www.boost.org/doc/libs/1_42_0/boost/detail/endian.hpp |
| */ |
| #ifndef RAPIDJSON_ENDIAN |
| // Detect with GCC 4.6's macro |
| # ifdef __BYTE_ORDER__ |
| # if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ |
| # define RAPIDJSON_ENDIAN RAPIDJSON_LITTLEENDIAN |
| # elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__ |
| # define RAPIDJSON_ENDIAN RAPIDJSON_BIGENDIAN |
| # else |
| # error Unknown machine endianness detected. User needs to define RAPIDJSON_ENDIAN. |
| # endif // __BYTE_ORDER__ |
| // Detect with GLIBC's endian.h |
| # elif defined(__GLIBC__) |
| # include <endian.h> |
| # if (__BYTE_ORDER == __LITTLE_ENDIAN) |
| # define RAPIDJSON_ENDIAN RAPIDJSON_LITTLEENDIAN |
| # elif (__BYTE_ORDER == __BIG_ENDIAN) |
| # define RAPIDJSON_ENDIAN RAPIDJSON_BIGENDIAN |
| # else |
| # error Unknown machine endianness detected. User needs to define RAPIDJSON_ENDIAN. |
| # endif // __GLIBC__ |
| // Detect with _LITTLE_ENDIAN and _BIG_ENDIAN macro |
| # elif defined(_LITTLE_ENDIAN) && !defined(_BIG_ENDIAN) |
| # define RAPIDJSON_ENDIAN RAPIDJSON_LITTLEENDIAN |
| # elif defined(_BIG_ENDIAN) && !defined(_LITTLE_ENDIAN) |
| # define RAPIDJSON_ENDIAN RAPIDJSON_BIGENDIAN |
| // Detect with architecture macros |
| # elif defined(__sparc) || defined(__sparc__) || defined(_POWER) || defined(__powerpc__) || defined(__ppc__) || defined(__hpux) || defined(__hppa) || defined(_MIPSEB) || defined(_POWER) || defined(__s390__) |
| # define RAPIDJSON_ENDIAN RAPIDJSON_BIGENDIAN |
| # 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__) |
| # define RAPIDJSON_ENDIAN RAPIDJSON_LITTLEENDIAN |
| # elif defined(_MSC_VER) && (defined(_M_ARM) || defined(_M_ARM64)) |
| # define RAPIDJSON_ENDIAN RAPIDJSON_LITTLEENDIAN |
| # elif defined(RAPIDJSON_DOXYGEN_RUNNING) |
| # define RAPIDJSON_ENDIAN |
| # else |
| # error Unknown machine endianness detected. User needs to define RAPIDJSON_ENDIAN. |
| # endif |
| #endif // RAPIDJSON_ENDIAN |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // RAPIDJSON_64BIT |
| |
| //! Whether using 64-bit architecture |
| #ifndef RAPIDJSON_64BIT |
| #if defined(__LP64__) || (defined(__x86_64__) && defined(__ILP32__)) || defined(_WIN64) || defined(__EMSCRIPTEN__) |
| #define RAPIDJSON_64BIT 1 |
| #else |
| #define RAPIDJSON_64BIT 0 |
| #endif |
| #endif // RAPIDJSON_64BIT |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // RAPIDJSON_ALIGN |
| |
| //! Data alignment of the machine. |
| /*! \ingroup RAPIDJSON_CONFIG |
| \param x pointer to align |
| |
| Some machines require strict data alignment. The default is 8 bytes. |
| User can customize by defining the RAPIDJSON_ALIGN function macro. |
| */ |
| #ifndef RAPIDJSON_ALIGN |
| #define RAPIDJSON_ALIGN(x) (((x) + static_cast<size_t>(7u)) & ~static_cast<size_t>(7u)) |
| #endif |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // RAPIDJSON_UINT64_C2 |
| |
| //! Construct a 64-bit literal by a pair of 32-bit integer. |
| /*! |
| 64-bit literal with or without ULL suffix is prone to compiler warnings. |
| UINT64_C() is C macro which cause compilation problems. |
| Use this macro to define 64-bit constants by a pair of 32-bit integer. |
| */ |
| #ifndef RAPIDJSON_UINT64_C2 |
| #define RAPIDJSON_UINT64_C2(high32, low32) ((static_cast<uint64_t>(high32) << 32) | static_cast<uint64_t>(low32)) |
| #endif |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // RAPIDJSON_48BITPOINTER_OPTIMIZATION |
| |
| //! Use only lower 48-bit address for some pointers. |
| /*! |
| \ingroup RAPIDJSON_CONFIG |
| |
| This optimization uses the fact that current X86-64 architecture only implement lower 48-bit virtual address. |
| The higher 16-bit can be used for storing other data. |
| \c GenericValue uses this optimization to reduce its size form 24 bytes to 16 bytes in 64-bit architecture. |
| */ |
| #ifndef RAPIDJSON_48BITPOINTER_OPTIMIZATION |
| #if defined(__amd64__) || defined(__amd64) || defined(__x86_64__) || defined(__x86_64) || defined(_M_X64) || defined(_M_AMD64) |
| #define RAPIDJSON_48BITPOINTER_OPTIMIZATION 1 |
| #else |
| #define RAPIDJSON_48BITPOINTER_OPTIMIZATION 0 |
| #endif |
| #endif // RAPIDJSON_48BITPOINTER_OPTIMIZATION |
| |
| #if RAPIDJSON_48BITPOINTER_OPTIMIZATION == 1 |
| #if RAPIDJSON_64BIT != 1 |
| #error RAPIDJSON_48BITPOINTER_OPTIMIZATION can only be set to 1 when RAPIDJSON_64BIT=1 |
| #endif |
| #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)))) |
| #define RAPIDJSON_GETPOINTER(type, p) (reinterpret_cast<type *>(reinterpret_cast<uintptr_t>(p) & static_cast<uintptr_t>(RAPIDJSON_UINT64_C2(0x0000FFFF, 0xFFFFFFFF)))) |
| #else |
| #define RAPIDJSON_SETPOINTER(type, p, x) (p = (x)) |
| #define RAPIDJSON_GETPOINTER(type, p) (p) |
| #endif |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // RAPIDJSON_SSE2/RAPIDJSON_SSE42/RAPIDJSON_NEON/RAPIDJSON_SIMD |
| |
| /*! \def RAPIDJSON_SIMD |
| \ingroup RAPIDJSON_CONFIG |
| \brief Enable SSE2/SSE4.2/Neon optimization. |
| |
| RapidJSON supports optimized implementations for some parsing operations |
| based on the SSE2, SSE4.2 or NEon SIMD extensions on modern Intel |
| or ARM compatible processors. |
| |
| To enable these optimizations, three different symbols can be defined; |
| \code |
| // Enable SSE2 optimization. |
| #define RAPIDJSON_SSE2 |
| |
| // Enable SSE4.2 optimization. |
| #define RAPIDJSON_SSE42 |
| \endcode |
| |
| // Enable ARM Neon optimization. |
| #define RAPIDJSON_NEON |
| \endcode |
| |
| \c RAPIDJSON_SSE42 takes precedence over SSE2, if both are defined. |
| |
| If any of these symbols is defined, RapidJSON defines the macro |
| \c RAPIDJSON_SIMD to indicate the availability of the optimized code. |
| */ |
| #if defined(RAPIDJSON_SSE2) || defined(RAPIDJSON_SSE42) \ |
| || defined(RAPIDJSON_NEON) || defined(RAPIDJSON_DOXYGEN_RUNNING) |
| #define RAPIDJSON_SIMD |
| #endif |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // RAPIDJSON_NO_SIZETYPEDEFINE |
| |
| #ifndef RAPIDJSON_NO_SIZETYPEDEFINE |
| /*! \def RAPIDJSON_NO_SIZETYPEDEFINE |
| \ingroup RAPIDJSON_CONFIG |
| \brief User-provided \c SizeType definition. |
| |
| In order to avoid using 32-bit size types for indexing strings and arrays, |
| define this preprocessor symbol and provide the type rapidjson::SizeType |
| before including RapidJSON: |
| \code |
| #define RAPIDJSON_NO_SIZETYPEDEFINE |
| namespace rapidjson { typedef ::std::size_t SizeType; } |
| #include "rapidjson/..." |
| \endcode |
| |
| \see rapidjson::SizeType |
| */ |
| #ifdef RAPIDJSON_DOXYGEN_RUNNING |
| #define RAPIDJSON_NO_SIZETYPEDEFINE |
| #endif |
| RAPIDJSON_NAMESPACE_BEGIN |
| //! Size type (for string lengths, array sizes, etc.) |
| /*! RapidJSON uses 32-bit array/string indices even on 64-bit platforms, |
| instead of using \c size_t. Users may override the SizeType by defining |
| \ref RAPIDJSON_NO_SIZETYPEDEFINE. |
| */ |
| typedef unsigned SizeType; |
| RAPIDJSON_NAMESPACE_END |
| #endif |
| |
| // always import std::size_t to rapidjson namespace |
| RAPIDJSON_NAMESPACE_BEGIN |
| using std::size_t; |
| RAPIDJSON_NAMESPACE_END |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // RAPIDJSON_ASSERT |
| |
| //! Assertion. |
| /*! \ingroup RAPIDJSON_CONFIG |
| By default, rapidjson uses C \c assert() for internal assertions. |
| User can override it by defining RAPIDJSON_ASSERT(x) macro. |
| |
| \note Parsing errors are handled and can be customized by the |
| \ref RAPIDJSON_ERRORS APIs. |
| */ |
| #ifndef RAPIDJSON_ASSERT |
| #include <cassert> |
| #define RAPIDJSON_ASSERT(x) assert(x) |
| #endif // RAPIDJSON_ASSERT |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // RAPIDJSON_STATIC_ASSERT |
| |
| // Prefer C++11 static_assert, if available |
| #ifndef RAPIDJSON_STATIC_ASSERT |
| #if RAPIDJSON_CPLUSPLUS >= 201103L || ( defined(_MSC_VER) && _MSC_VER >= 1800 ) |
| #define RAPIDJSON_STATIC_ASSERT(x) \ |
| static_assert(x, RAPIDJSON_STRINGIFY(x)) |
| #endif // C++11 |
| #endif // RAPIDJSON_STATIC_ASSERT |
| |
| // Adopt C++03 implementation from boost |
| #ifndef RAPIDJSON_STATIC_ASSERT |
| #ifndef __clang__ |
| //!@cond RAPIDJSON_HIDDEN_FROM_DOXYGEN |
| #endif |
| RAPIDJSON_NAMESPACE_BEGIN |
| template <bool x> struct STATIC_ASSERTION_FAILURE; |
| template <> struct STATIC_ASSERTION_FAILURE<true> { enum { value = 1 }; }; |
| template <size_t x> struct StaticAssertTest {}; |
| RAPIDJSON_NAMESPACE_END |
| |
| #if defined(__GNUC__) || defined(__clang__) |
| #define RAPIDJSON_STATIC_ASSERT_UNUSED_ATTRIBUTE __attribute__((unused)) |
| #else |
| #define RAPIDJSON_STATIC_ASSERT_UNUSED_ATTRIBUTE |
| #endif |
| #ifndef __clang__ |
| //!@endcond |
| #endif |
| |
| /*! \def RAPIDJSON_STATIC_ASSERT |
| \brief (Internal) macro to check for conditions at compile-time |
| \param x compile-time condition |
| \hideinitializer |
| */ |
| #define RAPIDJSON_STATIC_ASSERT(x) \ |
| typedef ::RAPIDJSON_NAMESPACE::StaticAssertTest< \ |
| sizeof(::RAPIDJSON_NAMESPACE::STATIC_ASSERTION_FAILURE<bool(x) >)> \ |
| RAPIDJSON_JOIN(StaticAssertTypedef, __LINE__) RAPIDJSON_STATIC_ASSERT_UNUSED_ATTRIBUTE |
| #endif // RAPIDJSON_STATIC_ASSERT |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // RAPIDJSON_LIKELY, RAPIDJSON_UNLIKELY |
| |
| //! Compiler branching hint for expression with high probability to be true. |
| /*! |
| \ingroup RAPIDJSON_CONFIG |
| \param x Boolean expression likely to be true. |
| */ |
| #ifndef RAPIDJSON_LIKELY |
| #if defined(__GNUC__) || defined(__clang__) |
| #define RAPIDJSON_LIKELY(x) __builtin_expect(!!(x), 1) |
| #else |
| #define RAPIDJSON_LIKELY(x) (x) |
| #endif |
| #endif |
| |
| //! Compiler branching hint for expression with low probability to be true. |
| /*! |
| \ingroup RAPIDJSON_CONFIG |
| \param x Boolean expression unlikely to be true. |
| */ |
| #ifndef RAPIDJSON_UNLIKELY |
| #if defined(__GNUC__) || defined(__clang__) |
| #define RAPIDJSON_UNLIKELY(x) __builtin_expect(!!(x), 0) |
| #else |
| #define RAPIDJSON_UNLIKELY(x) (x) |
| #endif |
| #endif |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // Helpers |
| |
| //!@cond RAPIDJSON_HIDDEN_FROM_DOXYGEN |
| |
| #define RAPIDJSON_MULTILINEMACRO_BEGIN do { |
| #define RAPIDJSON_MULTILINEMACRO_END \ |
| } while((void)0, 0) |
| |
| // adopted from Boost |
| #define RAPIDJSON_VERSION_CODE(x,y,z) \ |
| (((x)*100000) + ((y)*100) + (z)) |
| |
| #if defined(__has_builtin) |
| #define RAPIDJSON_HAS_BUILTIN(x) __has_builtin(x) |
| #else |
| #define RAPIDJSON_HAS_BUILTIN(x) 0 |
| #endif |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // RAPIDJSON_DIAG_PUSH/POP, RAPIDJSON_DIAG_OFF |
| |
| #if defined(__GNUC__) |
| #define RAPIDJSON_GNUC \ |
| RAPIDJSON_VERSION_CODE(__GNUC__,__GNUC_MINOR__,__GNUC_PATCHLEVEL__) |
| #endif |
| |
| #if defined(__clang__) || (defined(RAPIDJSON_GNUC) && RAPIDJSON_GNUC >= RAPIDJSON_VERSION_CODE(4,2,0)) |
| |
| #define RAPIDJSON_PRAGMA(x) _Pragma(RAPIDJSON_STRINGIFY(x)) |
| #define RAPIDJSON_DIAG_PRAGMA(x) RAPIDJSON_PRAGMA(GCC diagnostic x) |
| #define RAPIDJSON_DIAG_OFF(x) \ |
| RAPIDJSON_DIAG_PRAGMA(ignored RAPIDJSON_STRINGIFY(RAPIDJSON_JOIN(-W,x))) |
| |
| // push/pop support in Clang and GCC>=4.6 |
| #if defined(__clang__) || (defined(RAPIDJSON_GNUC) && RAPIDJSON_GNUC >= RAPIDJSON_VERSION_CODE(4,6,0)) |
| #define RAPIDJSON_DIAG_PUSH RAPIDJSON_DIAG_PRAGMA(push) |
| #define RAPIDJSON_DIAG_POP RAPIDJSON_DIAG_PRAGMA(pop) |
| #else // GCC >= 4.2, < 4.6 |
| #define RAPIDJSON_DIAG_PUSH /* ignored */ |
| #define RAPIDJSON_DIAG_POP /* ignored */ |
| #endif |
| |
| #elif defined(_MSC_VER) |
| |
| // pragma (MSVC specific) |
| #define RAPIDJSON_PRAGMA(x) __pragma(x) |
| #define RAPIDJSON_DIAG_PRAGMA(x) RAPIDJSON_PRAGMA(warning(x)) |
| |
| #define RAPIDJSON_DIAG_OFF(x) RAPIDJSON_DIAG_PRAGMA(disable: x) |
| #define RAPIDJSON_DIAG_PUSH RAPIDJSON_DIAG_PRAGMA(push) |
| #define RAPIDJSON_DIAG_POP RAPIDJSON_DIAG_PRAGMA(pop) |
| |
| #else |
| |
| #define RAPIDJSON_DIAG_OFF(x) /* ignored */ |
| #define RAPIDJSON_DIAG_PUSH /* ignored */ |
| #define RAPIDJSON_DIAG_POP /* ignored */ |
| |
| #endif // RAPIDJSON_DIAG_* |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // C++11 features |
| |
| #ifndef RAPIDJSON_HAS_CXX11 |
| #define RAPIDJSON_HAS_CXX11 (RAPIDJSON_CPLUSPLUS >= 201103L) |
| #endif |
| |
| #ifndef RAPIDJSON_HAS_CXX11_RVALUE_REFS |
| #if RAPIDJSON_HAS_CXX11 |
| #define RAPIDJSON_HAS_CXX11_RVALUE_REFS 1 |
| #elif defined(__clang__) |
| #if __has_feature(cxx_rvalue_references) && \ |
| (defined(_MSC_VER) || defined(_LIBCPP_VERSION) || defined(__GLIBCXX__) && __GLIBCXX__ >= 20080306) |
| #define RAPIDJSON_HAS_CXX11_RVALUE_REFS 1 |
| #else |
| #define RAPIDJSON_HAS_CXX11_RVALUE_REFS 0 |
| #endif |
| #elif (defined(RAPIDJSON_GNUC) && (RAPIDJSON_GNUC >= RAPIDJSON_VERSION_CODE(4,3,0)) && defined(__GXX_EXPERIMENTAL_CXX0X__)) || \ |
| (defined(_MSC_VER) && _MSC_VER >= 1600) || \ |
| (defined(__SUNPRO_CC) && __SUNPRO_CC >= 0x5140 && defined(__GXX_EXPERIMENTAL_CXX0X__)) |
| |
| #define RAPIDJSON_HAS_CXX11_RVALUE_REFS 1 |
| #else |
| #define RAPIDJSON_HAS_CXX11_RVALUE_REFS 0 |
| #endif |
| #endif // RAPIDJSON_HAS_CXX11_RVALUE_REFS |
| |
| #if RAPIDJSON_HAS_CXX11_RVALUE_REFS |
| #include <utility> // std::move |
| #endif |
| |
| #ifndef RAPIDJSON_HAS_CXX11_NOEXCEPT |
| #if RAPIDJSON_HAS_CXX11 |
| #define RAPIDJSON_HAS_CXX11_NOEXCEPT 1 |
| #elif defined(__clang__) |
| #define RAPIDJSON_HAS_CXX11_NOEXCEPT __has_feature(cxx_noexcept) |
| #elif (defined(RAPIDJSON_GNUC) && (RAPIDJSON_GNUC >= RAPIDJSON_VERSION_CODE(4,6,0)) && defined(__GXX_EXPERIMENTAL_CXX0X__)) || \ |
| (defined(_MSC_VER) && _MSC_VER >= 1900) || \ |
| (defined(__SUNPRO_CC) && __SUNPRO_CC >= 0x5140 && defined(__GXX_EXPERIMENTAL_CXX0X__)) |
| #define RAPIDJSON_HAS_CXX11_NOEXCEPT 1 |
| #else |
| #define RAPIDJSON_HAS_CXX11_NOEXCEPT 0 |
| #endif |
| #endif |
| #ifndef RAPIDJSON_NOEXCEPT |
| #if RAPIDJSON_HAS_CXX11_NOEXCEPT |
| #define RAPIDJSON_NOEXCEPT noexcept |
| #else |
| #define RAPIDJSON_NOEXCEPT throw() |
| #endif // RAPIDJSON_HAS_CXX11_NOEXCEPT |
| #endif |
| |
| // no automatic detection, yet |
| #ifndef RAPIDJSON_HAS_CXX11_TYPETRAITS |
| #if (defined(_MSC_VER) && _MSC_VER >= 1700) |
| #define RAPIDJSON_HAS_CXX11_TYPETRAITS 1 |
| #else |
| #define RAPIDJSON_HAS_CXX11_TYPETRAITS 0 |
| #endif |
| #endif |
| |
| #ifndef RAPIDJSON_HAS_CXX11_RANGE_FOR |
| #if defined(__clang__) |
| #define RAPIDJSON_HAS_CXX11_RANGE_FOR __has_feature(cxx_range_for) |
| #elif (defined(RAPIDJSON_GNUC) && (RAPIDJSON_GNUC >= RAPIDJSON_VERSION_CODE(4,6,0)) && defined(__GXX_EXPERIMENTAL_CXX0X__)) || \ |
| (defined(_MSC_VER) && _MSC_VER >= 1700) || \ |
| (defined(__SUNPRO_CC) && __SUNPRO_CC >= 0x5140 && defined(__GXX_EXPERIMENTAL_CXX0X__)) |
| #define RAPIDJSON_HAS_CXX11_RANGE_FOR 1 |
| #else |
| #define RAPIDJSON_HAS_CXX11_RANGE_FOR 0 |
| #endif |
| #endif // RAPIDJSON_HAS_CXX11_RANGE_FOR |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // C++17 features |
| |
| #ifndef RAPIDJSON_HAS_CXX17 |
| #define RAPIDJSON_HAS_CXX17 (RAPIDJSON_CPLUSPLUS >= 201703L) |
| #endif |
| |
| #if RAPIDJSON_HAS_CXX17 |
| # define RAPIDJSON_DELIBERATE_FALLTHROUGH [[fallthrough]] |
| #elif defined(__has_cpp_attribute) |
| # if __has_cpp_attribute(clang::fallthrough) |
| # define RAPIDJSON_DELIBERATE_FALLTHROUGH [[clang::fallthrough]] |
| # elif __has_cpp_attribute(fallthrough) |
| # define RAPIDJSON_DELIBERATE_FALLTHROUGH __attribute__((fallthrough)) |
| # else |
| # define RAPIDJSON_DELIBERATE_FALLTHROUGH |
| # endif |
| #else |
| # define RAPIDJSON_DELIBERATE_FALLTHROUGH |
| #endif |
| |
| //!@endcond |
| |
| //! Assertion (in non-throwing contexts). |
| /*! \ingroup RAPIDJSON_CONFIG |
| Some functions provide a \c noexcept guarantee, if the compiler supports it. |
| In these cases, the \ref RAPIDJSON_ASSERT macro cannot be overridden to |
| throw an exception. This macro adds a separate customization point for |
| such cases. |
| |
| Defaults to C \c assert() (as \ref RAPIDJSON_ASSERT), if \c noexcept is |
| supported, and to \ref RAPIDJSON_ASSERT otherwise. |
| */ |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // RAPIDJSON_NOEXCEPT_ASSERT |
| |
| #ifndef RAPIDJSON_NOEXCEPT_ASSERT |
| #ifdef RAPIDJSON_ASSERT_THROWS |
| #include <cassert> |
| #define RAPIDJSON_NOEXCEPT_ASSERT(x) assert(x) |
| #else |
| #define RAPIDJSON_NOEXCEPT_ASSERT(x) RAPIDJSON_ASSERT(x) |
| #endif // RAPIDJSON_ASSERT_THROWS |
| #endif // RAPIDJSON_NOEXCEPT_ASSERT |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // malloc/realloc/free |
| |
| #ifndef RAPIDJSON_MALLOC |
| ///! customization point for global \c malloc |
| #define RAPIDJSON_MALLOC(size) std::malloc(size) |
| #endif |
| #ifndef RAPIDJSON_REALLOC |
| ///! customization point for global \c realloc |
| #define RAPIDJSON_REALLOC(ptr, new_size) std::realloc(ptr, new_size) |
| #endif |
| #ifndef RAPIDJSON_FREE |
| ///! customization point for global \c free |
| #define RAPIDJSON_FREE(ptr) std::free(ptr) |
| #endif |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // new/delete |
| |
| #ifndef RAPIDJSON_NEW |
| ///! customization point for global \c new |
| #define RAPIDJSON_NEW(TypeName) new TypeName |
| #endif |
| #ifndef RAPIDJSON_DELETE |
| ///! customization point for global \c delete |
| #define RAPIDJSON_DELETE(x) delete x |
| #endif |
| |
| /////////////////////////////////////////////////////////////////////////////// |
| // Type |
| |
| /*! \namespace rapidjson |
| \brief main RapidJSON namespace |
| \see RAPIDJSON_NAMESPACE |
| */ |
| RAPIDJSON_NAMESPACE_BEGIN |
| |
| //! Type of JSON value |
| enum Type { |
| kNullType = 0, //!< null |
| kFalseType = 1, //!< false |
| kTrueType = 2, //!< true |
| kObjectType = 3, //!< object |
| kArrayType = 4, //!< array |
| kStringType = 5, //!< string |
| kNumberType = 6 //!< number |
| }; |
| |
| RAPIDJSON_NAMESPACE_END |
| |
| #endif // RAPIDJSON_RAPIDJSON_H_ |