RapidJSON configuration#
Configuration macros for library features. More...
Macros | |
| #define | RAPIDJSON_ALLOCATOR_DEFAULT_CHUNK_CAPACITY (64 * 1024) |
| User-defined kDefaultChunkCapacity definition. | |
| #define | RAPIDJSON_DEFAULT_ALLOCATOR ::RAPIDJSON_NAMESPACE::MemoryPoolAllocator<::RAPIDJSON_NAMESPACE::CrtAllocator> |
| Allows to choose default allocator. | |
| #define | RAPIDJSON_DEFAULT_STACK_ALLOCATOR ::RAPIDJSON_NAMESPACE::CrtAllocator |
| Allows to choose default stack allocator for Document. | |
| #define | RAPIDJSON_VALUE_DEFAULT_OBJECT_CAPACITY 16 |
| User defined kDefaultObjectCapacity value. | |
| #define | RAPIDJSON_VALUE_DEFAULT_ARRAY_CAPACITY 16 |
| User defined kDefaultArrayCapacity value. | |
| #define | RAPIDJSON_MAJOR_VERSION 1 |
| Major version of RapidJSON in integer. | |
| #define | RAPIDJSON_MINOR_VERSION 1 |
| Minor version of RapidJSON in integer. | |
| #define | RAPIDJSON_PATCH_VERSION 0 |
| Patch version of RapidJSON in integer. | |
| #define | RAPIDJSON_VERSION_STRING RAPIDJSON_STRINGIFY(RAPIDJSON_MAJOR_VERSION.RAPIDJSON_MINOR_VERSION.RAPIDJSON_PATCH_VERSION) |
| Version of RapidJSON in "<major>.<minor>.<patch>" string format. | |
| #define | RAPIDJSON_NAMESPACE rapidjson |
| provide custom rapidjson namespace | |
| #define | RAPIDJSON_NAMESPACE_BEGIN namespace RAPIDJSON_NAMESPACE { |
| provide custom rapidjson namespace (opening expression) | |
| #define | RAPIDJSON_NAMESPACE_END } |
| provide custom rapidjson namespace (closing expression) | |
| #define | RAPIDJSON_HAS_STDSTRING |
Enable RapidJSON support for std::string. | |
| #define | RAPIDJSON_USE_MEMBERSMAP |
Enable RapidJSON support for object members handling in a std::multimap. | |
| #define | RAPIDJSON_ALIGN(x) |
| Data alignment of the machine. | |
| #define | RAPIDJSON_48BITPOINTER_OPTIMIZATION 0 |
| Use only lower 48-bit address for some pointers. | |
| #define | RAPIDJSON_ASSERT(x) |
| Assertion. | |
| #define | RAPIDJSON_LIKELY(x) |
| Compiler branching hint for expression with high probability to be true. | |
| #define | RAPIDJSON_UNLIKELY(x) |
| Compiler branching hint for expression with low probability to be true. | |
| #define | RAPIDJSON_NOEXCEPT_ASSERT(x) |
| Assertion (in non-throwing contexts). | |
| #define | RAPIDJSON_VALIDATE_DEFAULT_FLAGS kValidateNoFlags |
| User-defined kValidateDefaultFlags definition. | |
Detailed Description
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.
- 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.
Macro Definition Documentation
◆ RAPIDJSON_48BITPOINTER_OPTIMIZATION
| #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.
◆ RAPIDJSON_ALIGN
| #define RAPIDJSON_ALIGN | ( | x | ) |
Data alignment of the machine.
- Parameters
-
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.
◆ RAPIDJSON_ALLOCATOR_DEFAULT_CHUNK_CAPACITY
| #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.
◆ RAPIDJSON_ASSERT
| #define RAPIDJSON_ASSERT | ( | x | ) |
Assertion.
By default, rapidjson uses 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 RapidJSON error handling APIs.
◆ RAPIDJSON_DEFAULT_ALLOCATOR
| #define RAPIDJSON_DEFAULT_ALLOCATOR ::RAPIDJSON_NAMESPACE::MemoryPoolAllocator<::RAPIDJSON_NAMESPACE::CrtAllocator> |
Allows to choose default allocator.
User can define this to use CrtAllocator or MemoryPoolAllocator.
◆ RAPIDJSON_DEFAULT_STACK_ALLOCATOR
| #define RAPIDJSON_DEFAULT_STACK_ALLOCATOR ::RAPIDJSON_NAMESPACE::CrtAllocator |
Allows to choose default stack allocator for Document.
User can define this to use CrtAllocator or MemoryPoolAllocator.
◆ RAPIDJSON_HAS_STDSTRING
| #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.
◆ RAPIDJSON_LIKELY
| #define RAPIDJSON_LIKELY | ( | x | ) |
Compiler branching hint for expression with high probability to be true.
- Parameters
-
x Boolean expression likely to be true.
◆ RAPIDJSON_MAJOR_VERSION
| #define RAPIDJSON_MAJOR_VERSION 1 |
Major version of RapidJSON in integer.
◆ RAPIDJSON_MINOR_VERSION
| #define RAPIDJSON_MINOR_VERSION 1 |
Minor version of RapidJSON in integer.
◆ RAPIDJSON_NAMESPACE
| #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:
- See also
- rapidjson
◆ RAPIDJSON_NAMESPACE_BEGIN
| #define RAPIDJSON_NAMESPACE_BEGIN namespace RAPIDJSON_NAMESPACE { |
provide custom rapidjson namespace (opening expression)
- See also
- RAPIDJSON_NAMESPACE
◆ RAPIDJSON_NAMESPACE_END
| #define RAPIDJSON_NAMESPACE_END } |
provide custom rapidjson namespace (closing expression)
- See also
- RAPIDJSON_NAMESPACE
◆ RAPIDJSON_NOEXCEPT_ASSERT
| #define RAPIDJSON_NOEXCEPT_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.
◆ RAPIDJSON_PATCH_VERSION
| #define RAPIDJSON_PATCH_VERSION 0 |
Patch version of RapidJSON in integer.
◆ RAPIDJSON_UNLIKELY
| #define RAPIDJSON_UNLIKELY | ( | x | ) |
Compiler branching hint for expression with low probability to be true.
- Parameters
-
x Boolean expression unlikely to be true.
◆ RAPIDJSON_USE_MEMBERSMAP
| #define RAPIDJSON_USE_MEMBERSMAP |
Enable RapidJSON support for object members handling in a std::multimap.
By defining this preprocessor symbol to 1, rapidjson::GenericValue object members are stored in a 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.
◆ RAPIDJSON_VALIDATE_DEFAULT_FLAGS
| #define RAPIDJSON_VALIDATE_DEFAULT_FLAGS kValidateNoFlags |
User-defined kValidateDefaultFlags definition.
User can define this as any ValidateFlag combinations.
◆ RAPIDJSON_VALUE_DEFAULT_ARRAY_CAPACITY
| #define RAPIDJSON_VALUE_DEFAULT_ARRAY_CAPACITY 16 |
User defined kDefaultArrayCapacity value.
User can define this as any natural number.
◆ RAPIDJSON_VALUE_DEFAULT_OBJECT_CAPACITY
| #define RAPIDJSON_VALUE_DEFAULT_OBJECT_CAPACITY 16 |
User defined kDefaultObjectCapacity value.
User can define this as any natural number.
◆ RAPIDJSON_VERSION_STRING
| #define RAPIDJSON_VERSION_STRING RAPIDJSON_STRINGIFY(RAPIDJSON_MAJOR_VERSION.RAPIDJSON_MINOR_VERSION.RAPIDJSON_PATCH_VERSION) |
Version of RapidJSON in "<major>.<minor>.<patch>" string format.