docs/wsar_html/wmem__array_8h_source.html

#ifndef __WMEM_ARRAY_H__

#define __WMEM_ARRAY_H__


#include <string.h>

#include <glib.h>


#include "wmem_core.h"


#ifdef __cplusplus

extern "C" {

#endif /* __cplusplus */


struct _wmem_array_t;


typedef struct _wmem_array_t wmem_array_t;


WS_DLL_PUBLIC

wmem_array_t *

wmem_array_sized_new(wmem_allocator_t *allocator, size_t elem_size,

                     unsigned alloc_count);


WS_DLL_PUBLIC

wmem_array_t *

wmem_array_new(wmem_allocator_t *allocator, const size_t elem_size);


WS_DLL_PUBLIC

bool

wmem_array_grow(wmem_array_t *array, const unsigned to_add);


WS_DLL_PUBLIC

void

wmem_array_set_null_terminator(wmem_array_t *array);


WS_DLL_PUBLIC

void

wmem_array_bzero(wmem_array_t *array);


WS_DLL_PUBLIC

bool

wmem_array_append(wmem_array_t *array, const void *in, unsigned count);


#define wmem_array_append_one(ARRAY, VAL) \

    wmem_array_append((ARRAY), &(VAL), 1)


WS_DLL_PUBLIC

void *

wmem_array_index(const wmem_array_t *array, unsigned array_index);


WS_DLL_PUBLIC

int

wmem_array_try_index(const wmem_array_t *array, unsigned array_index, void *val);


WS_DLL_PUBLIC

void

wmem_array_sort(wmem_array_t *array, int (*compar)(const void*,const void*));


WS_DLL_PUBLIC

void *

wmem_array_get_raw(const wmem_array_t *array);


WS_DLL_PUBLIC

unsigned

wmem_array_get_count(const wmem_array_t *array);


WS_DLL_PUBLIC

wmem_allocator_t*

wmem_array_get_allocator(const wmem_array_t* array);


WS_DLL_PUBLIC

void *

wmem_array_finalize(wmem_array_t *array);


WS_DLL_PUBLIC

void

wmem_destroy_array(wmem_array_t *array);


#ifdef __cplusplus

}

#endif /* __cplusplus */


#endif /* __WMEM_ARRAY_H__ */


/*

 * Editor modelines  -  https://www.wireshark.org/tools/modelines.html

 *

 * Local variables:

 * c-basic-offset: 4

 * tab-width: 8

 * indent-tabs-mode: nil

 * End:

 *

 * vi: set shiftwidth=4 tabstop=8 expandtab:

 * :indentSize=4:tabSize=8:noTabs=true:

 */

wmem_array_get_allocator
WS_DLL_PUBLIC wmem_allocator_t * wmem_array_get_allocator(const wmem_array_t *array)
Retrieve the memory allocator associated with a dynamic array.
Definition wmem_array.c:195

wmem_array_new
WS_DLL_PUBLIC wmem_array_t * wmem_array_new(wmem_allocator_t *allocator, const size_t elem_size)
Create a new dynamically sized array with default initial capacity.
Definition wmem_array.c:63

wmem_destroy_array
WS_DLL_PUBLIC void wmem_destroy_array(wmem_array_t *array)
Destroy a dynamic array and free its associated memory.
Definition wmem_array.c:218

wmem_array_index
WS_DLL_PUBLIC void * wmem_array_index(const wmem_array_t *array, unsigned array_index)
Retrieve a pointer to an element in a dynamic array by index.
Definition wmem_array.c:158

wmem_array_bzero
WS_DLL_PUBLIC void wmem_array_bzero(wmem_array_t *array)
Zero out the contents of a dynamic array.
Definition wmem_array.c:137

wmem_array_get_count
WS_DLL_PUBLIC unsigned wmem_array_get_count(const wmem_array_t *array)
Get the number of elements currently stored in a dynamic array.
Definition wmem_array.c:186

wmem_array_get_raw
WS_DLL_PUBLIC void * wmem_array_get_raw(const wmem_array_t *array)
Retrieve a raw pointer to the internal buffer of a dynamic array.
Definition wmem_array.c:180

wmem_array_sized_new
WS_DLL_PUBLIC wmem_array_t * wmem_array_sized_new(wmem_allocator_t *allocator, size_t elem_size, unsigned alloc_count)
Create a new dynamically sized array with a specified element size and initial capacity.
Definition wmem_array.c:43

wmem_array_try_index
WS_DLL_PUBLIC int wmem_array_try_index(const wmem_array_t *array, unsigned array_index, void *val)
Safely retrieve an element from a dynamic array by index.
Definition wmem_array.c:165

wmem_array_sort
WS_DLL_PUBLIC void wmem_array_sort(wmem_array_t *array, int(*compar)(const void *, const void *))
Sort the elements of a dynamic array.
Definition wmem_array.c:174

wmem_array_set_null_terminator
WS_DLL_PUBLIC void wmem_array_set_null_terminator(wmem_array_t *array)
Set a null terminator at the end of a dynamic array.
Definition wmem_array.c:130

wmem_array_finalize
WS_DLL_PUBLIC void * wmem_array_finalize(wmem_array_t *array)
Finalize a dynamic array and retrieve its underlying buffer.
Definition wmem_array.c:204

wmem_array_append
WS_DLL_PUBLIC bool wmem_array_append(wmem_array_t *array, const void *in, unsigned count)
Append elements to a dynamic array.
Definition wmem_array.c:143

wmem_array_grow
WS_DLL_PUBLIC bool wmem_array_grow(wmem_array_t *array, const unsigned to_add)
Increase the capacity of a dynamic array by a specified number of elements.
Definition wmem_array.c:73

_wmem_allocator_t
Internal memory allocator interface used by the wmem subsystem.
Definition wmem_allocator.h:34

_wmem_array_t
Definition wmem_array.c:29

wmem_core.h