Allocator.h File Reference

#include <Zycore/Status.h>
#include <Zycore/Types.h>

Include dependency graph for Allocator.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ZyanAllocator_
	Defines the ZyanAllocator struct. More...

Typedefs
typedef ZyanStatus(*	ZyanAllocatorAllocate) (struct ZyanAllocator_ *allocator, void **p, ZyanUSize element_size, ZyanUSize n)
	Defines the ZyanAllocatorAllocate function prototype.
typedef ZyanStatus(*	ZyanAllocatorDeallocate) (struct ZyanAllocator_ *allocator, void *p, ZyanUSize element_size, ZyanUSize n)
	Defines the ZyanAllocatorDeallocate function prototype.
typedef struct ZyanAllocator_	ZyanAllocator
	Defines the ZyanAllocator struct.

Functions
ZyanStatus	ZyanAllocatorInit (ZyanAllocator *allocator, ZyanAllocatorAllocate allocate, ZyanAllocatorAllocate reallocate, ZyanAllocatorDeallocate deallocate)
	Initializes the given ZyanAllocator instance.
ZyanAllocator *	ZyanAllocatorDefault (void)
	Returns the default ZyanAllocator instance.

Typedef Documentation

ZyanAllocator

typedef struct ZyanAllocator_ ZyanAllocator

Defines the ZyanAllocator struct.

This is the base class for all custom allocator implementations.

All fields in this struct should be considered as "private". Any changes may lead to unexpected behavior.

ZyanAllocatorAllocate

typedef ZyanStatus(* ZyanAllocatorAllocate) (struct ZyanAllocator_ *allocator, void **p, ZyanUSize element_size, ZyanUSize n)

Defines the ZyanAllocatorAllocate function prototype.

Parameters

allocator	A pointer to the ZyanAllocator instance.
p	Receives a pointer to the first memory block sufficient to hold an array of n elements with a size of element_size.
element_size	The size of a single element.
n	The number of elements to allocate storage for.

Returns

A zyan status code.

This prototype is used for the allocate() and reallocate() functions.

The result of the reallocate() function is undefined, if p does not point to a memory block previously obtained by (re-)allocate().

ZyanAllocatorDeallocate

typedef ZyanStatus(* ZyanAllocatorDeallocate) (struct ZyanAllocator_ *allocator, void *p, ZyanUSize element_size, ZyanUSize n)

Defines the ZyanAllocatorDeallocate function prototype.

Parameters

allocator	A pointer to the ZyanAllocator instance.
p	The pointer obtained from (re-)allocate().
element_size	The size of a single element.
n	The number of elements earlier passed to (re-)allocate().

Returns

A zyan status code.

Function Documentation

ZyanAllocatorDefault()

ZyanAllocator * ZyanAllocatorDefault

(

void

)

Returns the default ZyanAllocator instance.

Returns

A pointer to the default ZyanAllocator instance.

The default allocator uses the default memory manager to allocate memory on the heap.

You should in no case modify the returned allocator instance to avoid unexpected behavior.

ZyanAllocatorInit()

ZyanStatus ZyanAllocatorInit	(	ZyanAllocator *	allocator,
		ZyanAllocatorAllocate	allocate,
		ZyanAllocatorAllocate	reallocate,
		ZyanAllocatorDeallocate	deallocate )

Initializes the given ZyanAllocator instance.

Parameters

allocator	A pointer to the ZyanAllocator instance.
allocate	The allocate function.
reallocate	The reallocate function.
deallocate	The deallocate function.

Returns

A zyan status code.