Configuration macros for library features. More...
Macros | |
| #define | RAPIDJSON_48BITPOINTER_OPTIMIZATION 0 |
| Use only lower 48-bit address for some pointers. More... | |
| #define | RAPIDJSON_ALIGN(x) (((x) + static_cast<size_t>(7u)) & ~static_cast<size_t>(7u)) |
| Data alignment of the machine. More... | |
| #define | RAPIDJSON_ALLOCATOR_DEFAULT_CHUNK_CAPACITY (64 * 1024) |
| User-defined kDefaultChunkCapacity definition. More... | |
| #define | RAPIDJSON_ASSERT(x) assert(x) |
| Assertion. More... | |
| #define | RAPIDJSON_HAS_STDSTRING |
Enable RapidJSON support for std::string. More... | |
| #define | RAPIDJSON_LIKELY(x) (x) |
| Compiler branching hint for expression with high probability to be true. More... | |
| #define | RAPIDJSON_MAJOR_VERSION 1 |
| Major version of RapidJSON in integer. More... | |
| #define | RAPIDJSON_MINOR_VERSION 1 |
| Minor version of RapidJSON in integer. More... | |
| #define | RAPIDJSON_NAMESPACE rapidjson |
| provide custom rapidjson namespace More... | |
| #define | RAPIDJSON_NAMESPACE_BEGIN namespace RAPIDJSON_NAMESPACE { |
| provide custom rapidjson namespace (opening expression) More... | |
| #define | RAPIDJSON_NAMESPACE_END } |
| provide custom rapidjson namespace (closing expression) More... | |
| #define | RAPIDJSON_NOEXCEPT_ASSERT(x) RAPIDJSON_ASSERT(x) |
| Assertion (in non-throwing contexts). More... | |
| #define | RAPIDJSON_PATCH_VERSION 0 |
| Patch version of RapidJSON in integer. More... | |
| #define | RAPIDJSON_UNLIKELY(x) (x) |
| Compiler branching hint for expression with low probability to be true. More... | |
| #define | RAPIDJSON_VERSION_STRING |
| Version of RapidJSON in "<major>.<minor>.<patch>" string format. More... | |
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 RapidJSON error handling APIs.
| #define RAPIDJSON_48BITPOINTER_OPTIMIZATION 0 |
Use only lower 48-bit address for some pointers.
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. GenericValue uses this optimization to reduce its size form 24 bytes to 16 bytes in 64-bit architecture.
Definition at line 327 of file rapidjson.h.
Data alignment of the machine.
| 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.
Definition at line 292 of file rapidjson.h.
| #define RAPIDJSON_ALLOCATOR_DEFAULT_CHUNK_CAPACITY (64 * 1024) |
User-defined kDefaultChunkCapacity definition.
User can define this as any size that is a power of 2.
Definition at line 70 of file allocators.h.
Assertion.
By default, rapidjson uses C assert() for internal assertions. User can override it by defining RAPIDJSON_ASSERT(x) macro.
Definition at line 433 of file rapidjson.h.
| #define RAPIDJSON_HAS_STDSTRING |
Enable RapidJSON support for std::string.
By defining this preprocessor symbol to 1, several convenience functions for using rapidjson::GenericValue with std::string are enabled, especially for construction and comparison.
Compiler branching hint for expression with high probability to be true.
| x | Boolean expression likely to be true. |
Definition at line 495 of file rapidjson.h.
| #define RAPIDJSON_MAJOR_VERSION 1 |
Major version of RapidJSON in integer.
Definition at line 81 of file rapidjson.h.
| #define RAPIDJSON_MINOR_VERSION 1 |
Minor version of RapidJSON in integer.
Definition at line 82 of file rapidjson.h.
| #define RAPIDJSON_NAMESPACE rapidjson |
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 RAPIDJSON_NAMESPACE to a custom name (e.g. MyRapidJSON) is sufficient. If multiple levels are needed, both RAPIDJSON_NAMESPACE_BEGIN and RAPIDJSON_NAMESPACE_END need to be defined as well:
Definition at line 125 of file rapidjson.h.
| #define RAPIDJSON_NAMESPACE_BEGIN namespace RAPIDJSON_NAMESPACE { |
provide custom rapidjson namespace (opening expression)
Definition at line 128 of file rapidjson.h.
| #define RAPIDJSON_NAMESPACE_END } |
provide custom rapidjson namespace (closing expression)
Definition at line 131 of file rapidjson.h.
| #define RAPIDJSON_NOEXCEPT_ASSERT | ( | x | ) | RAPIDJSON_ASSERT(x) |
Assertion (in non-throwing contexts).
Some functions provide a noexcept guarantee, if the compiler supports it. In these cases, the RAPIDJSON_ASSERT macro cannot be overridden to throw an exception. This macro adds a separate customization point for such cases.
Defaults to C assert() (as RAPIDJSON_ASSERT), if noexcept is supported, and to RAPIDJSON_ASSERT otherwise.
Definition at line 681 of file rapidjson.h.
| #define RAPIDJSON_PATCH_VERSION 0 |
Patch version of RapidJSON in integer.
Definition at line 83 of file rapidjson.h.
Compiler branching hint for expression with low probability to be true.
| x | Boolean expression unlikely to be true. |
Definition at line 508 of file rapidjson.h.
| #define RAPIDJSON_VERSION_STRING |
Version of RapidJSON in "<major>.<minor>.<patch>" string format.
Definition at line 84 of file rapidjson.h.