memory.h

Go to the documentation of this file.

#pragma once
 
#include <banjo/api.h>

typedef void* (*bj_malloc_fn)(
    void* p_user_data, //< General purpose context data.
    size_t size         //< Allocation size in bytes requested by the caller.
);

typedef void* (*bj_realloc_fn)(
    void* p_user_data, //< General purpose context data.
    void* p_original,  //< Initial object to reallocate.
    size_t size         //< Allocation size in bytes requested by the caller.
);

typedef void (*bj_free_fn)(
    void* p_user_data, //< General purpose context data.
    void* p_memory     //< Object memory to dispose.
);

typedef struct bj_memory_callbacks {
    void*                      p_user_data;     
    bj_malloc_fn    fn_allocation;   
    bj_realloc_fn  fn_reallocation; 
    bj_free_fn          fn_free;         
} bj_memory_callbacks;

BANJO_EXPORT void* bj_malloc(
    size_t size
);

BANJO_EXPORT void* bj_calloc(
    size_t size
);

BANJO_EXPORT void* bj_realloc(
    void*                        p_memory,
    size_t                        size
);

BANJO_EXPORT void bj_free(
    void*                         p_memory
);

BANJO_EXPORT void bj_memory_set_defaults(
    const bj_memory_callbacks* p_allocator
);

BANJO_EXPORT void bj_memory_unset_defaults(void);

BANJO_EXPORT void* bj_memcpy(
    void*       p_dest,
    const void* p_src,
    size_t      mem_size
);
 
BANJO_EXPORT void* bj_memmove(
    void*       p_dest,
    const void* p_src,
    size_t      mem_size
);
 
 
BANJO_EXPORT int bj_memcmp(
    const void* p_block_a,
    const void* p_block_b,
    size_t size
);

BANJO_EXPORT void bj_memset(
    void*   p_dest,
    uint8_t value,
    size_t  mem_size
);

BANJO_EXPORT void bj_memzero(
    void*  p_dest,
    size_t mem_size
);