array.h

Go to the documentation of this file.

/*
 * See Licensing and Copyright notice in naev.h
 */
#pragma once
 
#include <assert.h>
#include <stddef.h>
#include <stdalign.h>
#include <stdint.h>
#include "attributes.h"
 
#define ARRAY_SENTINEL 0x15bada55 
typedef struct {
#if DEBUG_ARRAYS
   int _sentinel;         
#endif /* DEBUG_ARRAYS */
   size_t _reserved;      
   size_t _size;          
   char alignas(max_align_t) _array[];  
} _private_container;
 
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 inline _private_container *_array_private_container(void *a)
{
   assert("NULL array!" && (a != NULL));
 
   _private_container *c = (_private_container *)a - 1;
 
#if DEBUG_ARRAYS
   assert("Sentinel not found. Use array_create() to create the array." && (c->_sentinel == ARRAY_SENTINEL));
#endif /* DEBUG_ARRAYS */
 
   return c;
}
 
#define array_create(basic_type) \
      ((basic_type *)(_array_create_helper(sizeof(basic_type), 1)))
 
#define array_create_size(basic_type, capacity) \
      ((basic_type *)(_array_create_helper(sizeof(basic_type), capacity)))
#define array_resize(ptr_array, new_size) \
   (_array_resize_helper((void **)(ptr_array), sizeof((ptr_array)[0][0]), new_size))
#define array_grow(ptr_array) \
      (*(__typeof__((ptr_array)[0]))_array_grow_helper((void **)(ptr_array), sizeof((ptr_array)[0][0]))) // NOLINT (bugprone-sizeof-expression)
#define array_push_back(ptr_array, element) \
   do array_grow(ptr_array) = element; while (0)
#define array_erase(ptr_array, first, last) \
      (_array_erase_helper((void **)(ptr_array), sizeof((ptr_array)[0][0]), (void *)(first), (void *)(last))) // NOLINT
#define array_shrink(ptr_array) \
      (_array_shrink_helper((void **)(ptr_array), sizeof((ptr_array)[0][0]))) // NOLINT
#define array_free(ptr_array) \
      _array_free_helper((void *)(ptr_array))
 
ALWAYS_INLINE static inline int array_size(const void *array)
{
   const _private_container *c1 = array;
 
   if (c1 == NULL)
      return 0;
 
#if DEBUG_ARRAYS
   assert("Sentinel not found. Use array_create() to create the array." && (c1[-1]._sentinel == ARRAY_SENTINEL));
#endif /* DEBUG_ARRAYS */
 
   return c1[-1]._size;
}
#define array_reserved(array) (_array_private_container(array)->_reserved)
#define array_begin(array) (array)
#define array_end(array) ((array) + array_size(array))
#define array_front(ptr_array) (*array_begin(ptr_array))
#define array_back(ptr_array) (*(array_end(ptr_array) - 1))
#define array_copy(basic_type, ptr_array) \
      ((basic_type *)(_array_copy_helper(sizeof(basic_type), (void *)(ptr_array))))