Provides macros to work with dynamic arrays. More...

#include "attributes.h"

Data Structures
struct	_private_container
	Private container type for the arrays. More...

Macros
#define	ARRAY_SENTINEL 0x15bada55

#define	array_create(basic_type) ((basic_type *)(_array_create_helper(sizeof(basic_type), 1)))
	Creates a new dynamic array of ‘basic_type’. More...

#define	array_create_size(basic_type, capacity) ((basic_type *)(_array_create_helper(sizeof(basic_type), capacity)))
	Creates a new dynamic array of ‘basic_type’ with an initial capacity. More...

#define	array_resize(ptr_array, new_size) (_array_resize_helper((void **)(ptr_array), sizeof((ptr_array)[0][0]), new_size))
	Resizes the array to accomodate new_size elements. More...

#define	array_grow(ptr_array) ((__typeof__((ptr_array)[0]))_array_grow_helper((void *)(ptr_array), sizeof((ptr_array)[0][0])))
	Increases the number of elements by one and returns the last element. More...

#define	array_push_back(ptr_array, element) do array_grow(ptr_array) = element; while (0)
	Adds a new element at the end of the array. More...

#define	array_erase(ptr_array, first, last) (_array_erase_helper((void *)(ptr_array), sizeof((ptr_array)[0][0]), (void )(first), (void *)(last)))
	Erases elements in interval [first, last). More...

#define	array_shrink(ptr_array) (_array_shrink_helper((void **)(ptr_array), sizeof((ptr_array)[0][0])))
	Shrinks memory to fit only ‘size’ elements. More...

#define	array_free(ptr_array) _array_free_helper((void *)(ptr_array))
	Frees memory allocated and sets array to NULL. More...

#define	array_reserved(array) (_array_private_container(array)->_reserved)
	Returns number of elements reserved. More...

#define	array_begin(array) (array)
	Returns a pointer to the beginning of the reserved memory space. More...

#define	array_end(array) ((array) + array_size(array))
	Returns a pointer to the end of the reserved memory space. More...

#define	array_front(ptr_array) (*array_begin(ptr_array))
	Returns the first element in the array. More...

#define	array_back(ptr_array) (*(array_end(ptr_array) - 1))
	Returns the last element in the array. More...

#define	array_copy(basic_type, ptr_array) ((basic_type )(_array_copy_helper(sizeof(basic_type), (void )(ptr_array))))
	Returns a shallow copy of the input array. More...

Functions
void *	_array_create_helper (size_t e_size, size_t initial_size)

void *	_array_grow_helper (void **a, size_t e_size)

void	_array_resize_helper (void **a, size_t e_size, size_t new_size)

void	_array_erase_helper (void *a, size_t e_size, void first, void *last)

void	_array_shrink_helper (void **a, size_t e_size)

void	_array_free_helper (void *a)

void *	_array_copy_helper (size_t e_size, void *a)

static _private_container *	_array_private_container (void *a)
	Gets the container of an array. More...

static ALWAYS_INLINE int	array_size (const void *array)
	Returns number of elements in the array. More...

Detailed Description

Provides macros to work with dynamic arrays.

Note: Except were noted, macros do not have side effects from expansions.

Usage example:

static my_type *my_array = NULL;
 
// Create array
my_array = array_create( my_type );
 
// Fill array
while (need_fill)
   need_fill = fill_array_member( &array_grow( &my_array ) );
 
// Shrink to minimum (if static it's a good idea).
array_shrink( &my_array );
 
// Do stuff
for (i=0; i<array_size( my_array ); i++)
   do_stuff( &my_array[i] );
 
// Clean up
array_free( my_array );
my_array = NULL;

Definition in file array.h.

Macro Definition Documentation

◆ array_back

#define array_back ( ptr_array ) (*(array_end(ptr_array) - 1))

Returns the last element in the array.

Parameters

ptr_array Array being manipulated.

Returns: The last element in the array.

Definition at line 216 of file array.h.

◆ array_begin

#define array_begin ( array ) (array)

Returns a pointer to the beginning of the reserved memory space.

Parameters

array Array being manipulated.

Returns: Beginning of memory space.

Definition at line 194 of file array.h.

◆ array_copy

#define array_copy	(	basic_type,
		ptr_array
	)	((basic_type )(_array_copy_helper(sizeof(basic_type), (void )(ptr_array))))

Returns a shallow copy of the input array.

Definition at line 218 of file array.h.

◆ array_create

#define array_create ( basic_type ) ((basic_type *)(_array_create_helper(sizeof(basic_type), 1)))

Creates a new dynamic array of ‘basic_type’.

Parameters

basic_type Type of the array to create.

Definition at line 93 of file array.h.

◆ array_create_size

#define array_create_size	(	basic_type,
		capacity
	)	((basic_type *)(_array_create_helper(sizeof(basic_type), capacity)))

Creates a new dynamic array of ‘basic_type’ with an initial capacity.

Parameters

basic_type	Type of the array to create.
capacity	Initial size.

Definition at line 102 of file array.h.

◆ array_end

#define array_end ( array ) ((array) + array_size(array))

Returns a pointer to the end of the reserved memory space.

Warning: macro, may evaluate argument twice.

Parameters

array Array being manipulated.

Returns: End of memory space.

Definition at line 202 of file array.h.

◆ array_erase

#define array_erase	(	ptr_array,
		first,
		last
	)	(_array_erase_helper((void *)(ptr_array), sizeof((ptr_array)[0][0]), (void )(first), (void *)(last)))

Erases elements in interval [first, last).

Note: Invalidates all iterators.

Parameters

ptr_array	Array being manipulated.
first	First iterator to erase.
last	Last iterator in erase section but is not erased.

Definition at line 140 of file array.h.

◆ array_free

#define array_free ( ptr_array ) _array_free_helper((void *)(ptr_array))

Frees memory allocated and sets array to NULL.

Note: Invalidates all iterators.

Parameters

ptr_array Array being manipulated.

Definition at line 158 of file array.h.

◆ array_front

#define array_front ( ptr_array ) (*array_begin(ptr_array))

Returns the first element in the array.

Parameters

ptr_array Array being manipulated.

Returns: The first element in the array.

Definition at line 209 of file array.h.

◆ array_grow

#define array_grow ( ptr_array ) (*(__typeof__((ptr_array)[0]))_array_grow_helper((void **)(ptr_array), sizeof((ptr_array)[0][0])))

Increases the number of elements by one and returns the last element.

Note: Invalidates all iterators.

Definition at line 119 of file array.h.

◆ array_push_back

#define array_push_back	(	ptr_array,
		element
	)	do array_grow(ptr_array) = element; while (0)

Adds a new element at the end of the array.

Note: Invalidates all iterators.

Parameters

ptr_array	Array being manipulated.
element	Element being pushed to the back.

Definition at line 129 of file array.h.

◆ array_reserved

#define array_reserved ( array ) (_array_private_container(array)->_reserved)

Returns number of elements reserved.

Parameters

array Array being manipulated.

Returns: The size of the array (memory usage).

Definition at line 187 of file array.h.

◆ array_resize

#define array_resize	(	ptr_array,
		new_size
	)	(_array_resize_helper((void **)(ptr_array), sizeof((ptr_array)[0][0]), new_size))

Resizes the array to accomodate new_size elements.

Note: Invalidates all iterators.

Parameters

ptr_array	Array being manipulated.
new_size	New size to grow to (in number of elements).

Definition at line 112 of file array.h.

◆ ARRAY_SENTINEL

#define ARRAY_SENTINEL 0x15bada55

Badass sentinel.

Definition at line 47 of file array.h.

◆ array_shrink

#define array_shrink ( ptr_array ) (_array_shrink_helper((void **)(ptr_array), sizeof((ptr_array)[0][0])))

Shrinks memory to fit only ‘size’ elements.

Note: Invalidates all iterators.

Parameters

ptr_array Array being manipulated.

Definition at line 149 of file array.h.

Function Documentation

◆ _array_copy_helper()

void * _array_copy_helper	(	size_t	e_size,
		void *	a
	)

Definition at line 103 of file array.c.

◆ _array_create_helper()

void * _array_create_helper	(	size_t	e_size,
		size_t	initial_size
	)

Definition at line 15 of file array.c.

◆ _array_erase_helper()

void _array_erase_helper	(	void **	a,
		size_t	e_size,
		void *	first,
		void *	last
	)

Definition at line 67 of file array.c.

◆ _array_free_helper()

void _array_free_helper ( void * a )

Definition at line 96 of file array.c.

◆ _array_grow_helper()

void * _array_grow_helper	(	void **	a,
		size_t	e_size
	)

Definition at line 54 of file array.c.

◆ _array_private_container()

static _private_container * _array_private_container ( void * a )

inlinestatic

Gets the container of an array.

Parameters

a	Array to get container of.

Returns: The container of the array a.

Definition at line 75 of file array.h.

◆ _array_resize_helper()

void _array_resize_helper	(	void **	a,
		size_t	e_size,
		size_t	new_size
	)

Definition at line 47 of file array.c.

◆ _array_shrink_helper()

void _array_shrink_helper	(	void **	a,
		size_t	e_size
	)

Definition at line 83 of file array.c.

◆ array_size()

static ALWAYS_INLINE int array_size ( const void * array )

inlinestatic

Returns number of elements in the array.

Warning: macro, may evaluate argument twice.

Parameters

array Array being manipulated.

Returns: The size of the array (number of elements).

Definition at line 168 of file array.h.

Data Structures

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ array_back

◆ array_begin

◆ array_copy

◆ array_create

◆ array_create_size

◆ array_end

◆ array_erase

◆ array_free

◆ array_front

◆ array_grow

◆ array_push_back

◆ array_reserved

◆ array_resize

◆ ARRAY_SENTINEL

◆ array_shrink

Function Documentation

◆ _array_copy_helper()

◆ _array_create_helper()

◆ _array_erase_helper()

◆ _array_free_helper()

◆ _array_grow_helper()

◆ _array_private_container()

◆ _array_resize_helper()

◆ _array_shrink_helper()

◆ array_size()