Default memory allocator used by the parser and DOM. More...

#include <allocators.h>

Collaboration diagram for MemoryPoolAllocator< BaseAllocator >:

Classes
struct	ChunkHeader
	Chunk header for perpending to each chunk. More...

Public Member Functions
	MemoryPoolAllocator (size_t chunkSize=kDefaultChunkCapacity, BaseAllocator *baseAllocator=0)
	Constructor with chunkSize. More...

	MemoryPoolAllocator (void buffer, size_t size, size_t chunkSize=kDefaultChunkCapacity, BaseAllocator baseAllocator=0)
	Constructor with user-supplied buffer. More...

	~MemoryPoolAllocator ()
	Destructor. More...

void	Clear ()
	Deallocates all memory chunks, excluding the user-supplied buffer. More...

size_t	Capacity () const
	Computes the total capacity of allocated memory chunks. More...

size_t	Size () const
	Computes the memory blocks allocated. More...

void *	Malloc (size_t size)
	Allocates a memory block. (concept Allocator) More...

void *	Realloc (void *originalPtr, size_t originalSize, size_t newSize)
	Resizes a memory block (concept Allocator) More...

Static Public Member Functions
static void	Free (void *ptr)
	Frees a memory block (concept Allocator) More...

Static Public Attributes
static const bool	kNeedFree = false
	Tell users that no need to call Free() with this allocator. (concept Allocator) More...

Private Member Functions
	MemoryPoolAllocator (const MemoryPoolAllocator &rhs)
	Copy constructor is not permitted. More...

MemoryPoolAllocator &	operator= (const MemoryPoolAllocator &rhs)
	Copy assignment operator is not permitted. More...

void	AddChunk (size_t capacity)
	Creates a new chunk. More...

Private Attributes
ChunkHeader *	chunkHead_
	Head of the chunk linked-list. Only the head chunk serves allocation. More...

size_t	chunk_capacity_
	The minimum capacity of chunk when they are allocated. More...

void *	userBuffer_
	User supplied buffer. More...

BaseAllocator *	baseAllocator_
	base allocator for allocating memory chunks. More...

BaseAllocator *	ownBaseAllocator_
	base allocator created by this object. More...

Static Private Attributes
static const int	kDefaultChunkCapacity = 64 * 1024
	Default chunk capacity. More...

Detailed Description

template<typename BaseAllocator = CrtAllocator>
class MemoryPoolAllocator< BaseAllocator >

Default memory allocator used by the parser and DOM.

This allocator allocate memory blocks from pre-allocated memory chunks.

It does not free memory blocks. And Realloc() only allocate new memory.

The memory chunks are allocated by BaseAllocator, which is CrtAllocator by default.

User may also supply a buffer as the first chunk.

If the user-buffer is full then additional chunks are allocated by BaseAllocator.

The user-buffer is not deallocated by this allocator.

Template Parameters

BaseAllocator the allocator type for allocating memory chunks. Default is CrtAllocator.

Note: implements Allocator concept

Definition at line 102 of file allocators.h.

Constructor & Destructor Documentation

template<typename BaseAllocator = CrtAllocator>

MemoryPoolAllocator< BaseAllocator >::MemoryPoolAllocator	(	size_t	chunkSize = `kDefaultChunkCapacity`,
		BaseAllocator *	baseAllocator = `0`
	)

inline

Constructor with chunkSize.

Parameters

chunkSize	The size of memory chunk. The default is kDefaultChunkSize.
baseAllocator	The allocator for allocating memory chunks.

Definition at line 110 of file allocators.h.

template<typename BaseAllocator = CrtAllocator>

MemoryPoolAllocator< BaseAllocator >::MemoryPoolAllocator	(	void *	buffer,
		size_t	size,
		size_t	chunkSize = `kDefaultChunkCapacity`,
		BaseAllocator *	baseAllocator = `0`
	)

inline

Constructor with user-supplied buffer.

The user buffer will be used firstly. When it is full, memory pool allocates new chunk with chunk size.

The user buffer will not be deallocated when this allocator is destructed.

Parameters

buffer	User supplied buffer.
size	Size of the buffer in bytes. It must at least larger than sizeof(ChunkHeader).
chunkSize	The size of memory chunk. The default is kDefaultChunkSize.
baseAllocator	The allocator for allocating memory chunks.

Definition at line 125 of file allocators.h.

References MemoryPoolAllocator< BaseAllocator >::ChunkHeader::capacity, and RAPIDJSON_ASSERT.

template<typename BaseAllocator = CrtAllocator>

MemoryPoolAllocator< BaseAllocator >::~MemoryPoolAllocator ( )

inline

Destructor.

This deallocates all memory chunks, excluding the user-supplied buffer.

Definition at line 139 of file allocators.h.

References RAPIDJSON_DELETE.

template<typename BaseAllocator = CrtAllocator>

MemoryPoolAllocator< BaseAllocator >::MemoryPoolAllocator ( const MemoryPoolAllocator< BaseAllocator > & rhs )

private

Copy constructor is not permitted.

Member Function Documentation

template<typename BaseAllocator = CrtAllocator>

void MemoryPoolAllocator< BaseAllocator >::AddChunk ( size_t capacity )

inlineprivate

Creates a new chunk.

Parameters

capacity Capacity of the chunk in bytes.

Definition at line 231 of file allocators.h.

References MemoryPoolAllocator< BaseAllocator >::ChunkHeader::capacity, MemoryPoolAllocator< BaseAllocator >::ChunkHeader::next, RAPIDJSON_ALIGN, RAPIDJSON_NEW, and MemoryPoolAllocator< BaseAllocator >::ChunkHeader::size.

template<typename BaseAllocator = CrtAllocator>

size_t MemoryPoolAllocator< BaseAllocator >::Capacity ( ) const

inline

Computes the total capacity of allocated memory chunks.

Returns: total capacity in bytes.

Definition at line 158 of file allocators.h.

References MemoryPoolAllocator< BaseAllocator >::ChunkHeader::next.

template<typename BaseAllocator = CrtAllocator>

void MemoryPoolAllocator< BaseAllocator >::Clear ( )

inline

Deallocates all memory chunks, excluding the user-supplied buffer.

Definition at line 145 of file allocators.h.

References MemoryPoolAllocator< BaseAllocator >::ChunkHeader::next, and MemoryPoolAllocator< BaseAllocator >::ChunkHeader::size.

template<typename BaseAllocator = CrtAllocator>

static void MemoryPoolAllocator< BaseAllocator >::Free ( void * ptr )

inlinestatic

Frees a memory block (concept Allocator)

Definition at line 220 of file allocators.h.

References void().

Here is the call graph for this function:

template<typename BaseAllocator = CrtAllocator>

void* MemoryPoolAllocator< BaseAllocator >::Malloc ( size_t size )

inline

Allocates a memory block. (concept Allocator)

Definition at line 176 of file allocators.h.

References RAPIDJSON_ALIGN.

template<typename BaseAllocator = CrtAllocator>

MemoryPoolAllocator& MemoryPoolAllocator< BaseAllocator >::operator= ( const MemoryPoolAllocator< BaseAllocator > & rhs )

private

Copy assignment operator is not permitted.

template<typename BaseAllocator = CrtAllocator>

void* MemoryPoolAllocator< BaseAllocator >::Realloc	(	void *	originalPtr,
		size_t	originalSize,
		size_t	newSize
	)

inline

Resizes a memory block (concept Allocator)

Definition at line 190 of file allocators.h.

References CrtAllocator::Malloc(), RAPIDJSON_ALIGN, and RAPIDJSON_ASSERT.

Here is the call graph for this function:

template<typename BaseAllocator = CrtAllocator>

size_t MemoryPoolAllocator< BaseAllocator >::Size ( ) const

inline

Computes the memory blocks allocated.

Returns: total used bytes.

Definition at line 168 of file allocators.h.

References MemoryPoolAllocator< BaseAllocator >::ChunkHeader::next.

Member Data Documentation

template<typename BaseAllocator = CrtAllocator>

BaseAllocator* MemoryPoolAllocator< BaseAllocator >::baseAllocator_

private

base allocator for allocating memory chunks.

Definition at line 255 of file allocators.h.

template<typename BaseAllocator = CrtAllocator>

size_t MemoryPoolAllocator< BaseAllocator >::chunk_capacity_

private

The minimum capacity of chunk when they are allocated.

Definition at line 253 of file allocators.h.

template<typename BaseAllocator = CrtAllocator>

ChunkHeader* MemoryPoolAllocator< BaseAllocator >::chunkHead_

private

Head of the chunk linked-list. Only the head chunk serves allocation.

Definition at line 252 of file allocators.h.

template<typename BaseAllocator = CrtAllocator>

const int MemoryPoolAllocator< BaseAllocator >::kDefaultChunkCapacity = 64 * 1024

staticprivate

Default chunk capacity.

Definition at line 241 of file allocators.h.

template<typename BaseAllocator = CrtAllocator>

const bool MemoryPoolAllocator< BaseAllocator >::kNeedFree = false

static

Tell users that no need to call Free() with this allocator. (concept Allocator)

Definition at line 104 of file allocators.h.

template<typename BaseAllocator = CrtAllocator>

BaseAllocator* MemoryPoolAllocator< BaseAllocator >::ownBaseAllocator_

private

base allocator created by this object.

Definition at line 256 of file allocators.h.

template<typename BaseAllocator = CrtAllocator>

void* MemoryPoolAllocator< BaseAllocator >::userBuffer_

private

User supplied buffer.

Definition at line 254 of file allocators.h.

The documentation for this class was generated from the following file:

allocators.h

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

template<typename BaseAllocator = CrtAllocator> class MemoryPoolAllocator< BaseAllocator >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename BaseAllocator = CrtAllocator>
class MemoryPoolAllocator< BaseAllocator >