summaryrefslogtreecommitdiffstats
path: root/include/zix
diff options
context:
space:
mode:
Diffstat (limited to 'include/zix')
-rw-r--r--include/zix/allocator.h87
-rw-r--r--include/zix/btree.h2
-rw-r--r--include/zix/hash.h8
-rw-r--r--include/zix/ring.h2
-rw-r--r--include/zix/tree.h12
5 files changed, 54 insertions, 57 deletions
diff --git a/include/zix/allocator.h b/include/zix/allocator.h
index 55bbe9b..aa7d820 100644
--- a/include/zix/allocator.h
+++ b/include/zix/allocator.h
@@ -19,8 +19,16 @@ extern "C" {
@{
*/
-/// Opaque user data for allocation functions
-typedef void ZixAllocatorHandle;
+/**
+ A memory allocator.
+
+ This object-like structure provides an interface like the standard C
+ functions malloc(), calloc(), realloc(), and free(). It contains function
+ pointers that differ from their standard counterparts by taking a context
+ parameter (a pointer to this struct), which allows the user to implement
+ custom stateful allocators.
+*/
+typedef struct ZixAllocatorImpl ZixAllocator;
/**
General malloc-like memory allocation function.
@@ -29,7 +37,7 @@ typedef void ZixAllocatorHandle;
parameter for implementing stateful allocators without static data.
*/
typedef void* ZIX_ALLOCATED (
- *ZixMallocFunc)(ZixAllocatorHandle* ZIX_NULLABLE handle, size_t size);
+ *ZixMallocFunc)(ZixAllocator* ZIX_NULLABLE allocator, size_t size);
/**
General calloc-like memory allocation function.
@@ -37,8 +45,8 @@ typedef void* ZIX_ALLOCATED (
This works like the standard C calloc(), except has an additional handle
parameter for implementing stateful allocators without static data.
*/
-typedef void* ZIX_ALLOCATED (*ZixCallocFunc)(ZixAllocatorHandle* ZIX_NULLABLE
- handle,
+typedef void* ZIX_ALLOCATED (*ZixCallocFunc)(ZixAllocator* ZIX_NULLABLE
+ allocator,
size_t nmemb,
size_t size);
@@ -48,8 +56,8 @@ typedef void* ZIX_ALLOCATED (*ZixCallocFunc)(ZixAllocatorHandle* ZIX_NULLABLE
This works like the standard C remalloc(), except has an additional handle
parameter for implementing stateful allocators without static data.
*/
-typedef void* ZIX_ALLOCATED (*ZixReallocFunc)(ZixAllocatorHandle* ZIX_NULLABLE
- handle,
+typedef void* ZIX_ALLOCATED (*ZixReallocFunc)(ZixAllocator* ZIX_NULLABLE
+ allocator,
void* ZIX_NULLABLE ptr,
size_t size);
@@ -59,72 +67,61 @@ typedef void* ZIX_ALLOCATED (*ZixReallocFunc)(ZixAllocatorHandle* ZIX_NULLABLE
This works like the standard C remalloc(), except has an additional handle
parameter for implementing stateful allocators without static data.
*/
-typedef void (*ZixFreeFunc)(ZixAllocatorHandle* ZIX_NULLABLE handle,
- void* ZIX_NULLABLE ptr);
+typedef void (*ZixFreeFunc)(ZixAllocator* ZIX_NULLABLE allocator,
+ void* ZIX_NULLABLE ptr);
-/**
- A memory allocator.
-
- This object-like structure provides an interface like the standard C
- functions malloc(), calloc(), realloc(), and free(). It allows the user to
- pass a custom allocator to be used by data structures.
-*/
-typedef struct {
- ZixAllocatorHandle* ZIX_NULLABLE handle;
- ZixMallocFunc ZIX_NONNULL malloc;
- ZixCallocFunc ZIX_NONNULL calloc;
- ZixReallocFunc ZIX_NONNULL realloc;
- ZixFreeFunc ZIX_NONNULL free;
-} ZixAllocator;
+/// Definition of ZixAllocator
+struct ZixAllocatorImpl {
+ ZixMallocFunc ZIX_NONNULL malloc;
+ ZixCallocFunc ZIX_NONNULL calloc;
+ ZixReallocFunc ZIX_NONNULL realloc;
+ ZixFreeFunc ZIX_NONNULL free;
+};
/// Return the default allocator which simply uses the system allocator
ZIX_CONST_API
-const ZixAllocator* ZIX_NONNULL
+ZixAllocator* ZIX_NONNULL
zix_default_allocator(void);
/// Convenience wrapper that defers to malloc() if allocator is null
static inline void* ZIX_ALLOCATED
-zix_malloc(const ZixAllocator* const ZIX_NULLABLE allocator, const size_t size)
+zix_malloc(ZixAllocator* const ZIX_NULLABLE allocator, const size_t size)
{
- const ZixAllocator* const actual =
- allocator ? allocator : zix_default_allocator();
+ ZixAllocator* const actual = allocator ? allocator : zix_default_allocator();
- return actual->malloc(actual->handle, size);
+ return actual->malloc(actual, size);
}
/// Convenience wrapper that defers to calloc() if allocator is null
static inline void* ZIX_ALLOCATED
-zix_calloc(const ZixAllocator* const ZIX_NULLABLE allocator,
- const size_t nmemb,
- const size_t size)
+zix_calloc(ZixAllocator* const ZIX_NULLABLE allocator,
+ const size_t nmemb,
+ const size_t size)
{
- const ZixAllocator* const actual =
- allocator ? allocator : zix_default_allocator();
+ ZixAllocator* const actual = allocator ? allocator : zix_default_allocator();
- return actual->calloc(actual->handle, nmemb, size);
+ return actual->calloc(actual, nmemb, size);
}
/// Convenience wrapper that defers to realloc() if allocator is null
static inline void* ZIX_ALLOCATED
-zix_realloc(const ZixAllocator* const ZIX_NULLABLE allocator,
- void* const ZIX_NULLABLE ptr,
- const size_t size)
+zix_realloc(ZixAllocator* const ZIX_NULLABLE allocator,
+ void* const ZIX_NULLABLE ptr,
+ const size_t size)
{
- const ZixAllocator* const actual =
- allocator ? allocator : zix_default_allocator();
+ ZixAllocator* const actual = allocator ? allocator : zix_default_allocator();
- return actual->realloc(actual->handle, ptr, size);
+ return actual->realloc(actual, ptr, size);
}
/// Convenience wrapper that defers to free() if allocator is null
static inline void
-zix_free(const ZixAllocator* const ZIX_NULLABLE allocator,
- void* const ZIX_NULLABLE ptr)
+zix_free(ZixAllocator* const ZIX_NULLABLE allocator,
+ void* const ZIX_NULLABLE ptr)
{
- const ZixAllocator* const actual =
- allocator ? allocator : zix_default_allocator();
+ ZixAllocator* const actual = allocator ? allocator : zix_default_allocator();
- actual->free(actual->handle, ptr);
+ actual->free(actual, ptr);
}
/**
diff --git a/include/zix/btree.h b/include/zix/btree.h
index 9a661d6..9c86a44 100644
--- a/include/zix/btree.h
+++ b/include/zix/btree.h
@@ -76,7 +76,7 @@ static const ZixBTreeIter zix_btree_end_iter = {
*/
ZIX_API
ZixBTree* ZIX_ALLOCATED
-zix_btree_new(const ZixAllocator* ZIX_NULLABLE allocator,
+zix_btree_new(ZixAllocator* ZIX_NULLABLE allocator,
ZixComparator ZIX_NONNULL cmp,
const void* ZIX_NULLABLE cmp_data);
diff --git a/include/zix/hash.h b/include/zix/hash.h
index 7ec9f92..9716123 100644
--- a/include/zix/hash.h
+++ b/include/zix/hash.h
@@ -121,10 +121,10 @@ typedef struct {
*/
ZIX_API
ZixHash* ZIX_ALLOCATED
-zix_hash_new(const ZixAllocator* ZIX_NULLABLE allocator,
- ZixKeyFunc ZIX_NONNULL key_func,
- ZixHashFunc ZIX_NONNULL hash_func,
- ZixKeyEqualFunc ZIX_NONNULL equal_func);
+zix_hash_new(ZixAllocator* ZIX_NULLABLE allocator,
+ ZixKeyFunc ZIX_NONNULL key_func,
+ ZixHashFunc ZIX_NONNULL hash_func,
+ ZixKeyEqualFunc ZIX_NONNULL equal_func);
/// Free `hash`
ZIX_API
diff --git a/include/zix/ring.h b/include/zix/ring.h
index a060697..d7d9713 100644
--- a/include/zix/ring.h
+++ b/include/zix/ring.h
@@ -36,7 +36,7 @@ typedef struct ZixRingImpl ZixRing;
*/
ZIX_MALLOC_API
ZixRing* ZIX_ALLOCATED
-zix_ring_new(const ZixAllocator* ZIX_NULLABLE allocator, uint32_t size);
+zix_ring_new(ZixAllocator* ZIX_NULLABLE allocator, uint32_t size);
/// Destroy a ring
ZIX_API
diff --git a/include/zix/tree.h b/include/zix/tree.h
index aaa0f25..53cb375 100644
--- a/include/zix/tree.h
+++ b/include/zix/tree.h
@@ -31,12 +31,12 @@ typedef struct ZixTreeNodeImpl ZixTreeIter;
/// Create a new (empty) tree
ZIX_API
ZixTree* ZIX_ALLOCATED
-zix_tree_new(const ZixAllocator* ZIX_NULLABLE allocator,
- bool allow_duplicates,
- ZixComparator ZIX_NONNULL cmp,
- void* ZIX_NULLABLE cmp_data,
- ZixDestroyFunc ZIX_NULLABLE destroy,
- const void* ZIX_NULLABLE destroy_user_data);
+zix_tree_new(ZixAllocator* ZIX_NULLABLE allocator,
+ bool allow_duplicates,
+ ZixComparator ZIX_NONNULL cmp,
+ void* ZIX_NULLABLE cmp_data,
+ ZixDestroyFunc ZIX_NULLABLE destroy,
+ const void* ZIX_NULLABLE destroy_user_data);
/// Free `t`
ZIX_API
generated by cgit v1.2.1 (git 2.18.0) at 2024-11-05 18:37:48 +0000