min_array/src/min_array.h

79 lines
3.3 KiB
C

/** X-macro for a minimal dynamic array. `MIN_ARRAY(name, type)`, where `name`
is an identifier prefix that satisfies `C` naming conventions when mangled and
`type` is defined tag-type associated therewith. When expanding the array,
resizing may be necessary and incurs amortised cost; any pointers to this
memory may become stale. */
#include <stdlib.h> /* size_t realloc free */
#include <string.h> /* memmove strcmp memcpy */
#include <errno.h> /* errno */
#include <assert.h> /* assert */
#define MIN_ARRAY_IDLE { 0, 0, 0 }
#define MIN_ARRAY(name, type) \
struct name##_array { type *data; size_t size, capacity; }; \
/** Initialises `a` to idle. */ \
static void name##_array(struct name##_array *const a) \
{ assert(a), a->data = 0, a->capacity = a->size = 0; } \
/** Destroys `a` and returns it to idle. */ \
static void name##_array_(struct name##_array *const a) \
{ assert(a), free(a->data), name##_array(a); } \
/** Ensures `min_capacity` of `a`. @param[min_capacity] If zero, does nothing.
@return Success; otherwise, `errno` will be set.
@throws[ERANGE] Tried allocating more then can fit in `size_t` or `realloc`
doesn't follow POSIX. @throws[realloc, ERANGE] */ \
static int name##_array_reserve(struct name##_array *const a, \
const size_t min_capacity) { \
size_t c0; \
type *data; \
const size_t max_size = (size_t)-1 / sizeof *a->data; \
assert(a); \
if(a->data) { \
if(min_capacity <= a->capacity) return 1; \
c0 = a->capacity; \
} else { /* Idle. */ \
if(!min_capacity) return 1; \
c0 = 1; \
} \
if(min_capacity > max_size) return errno = ERANGE, 0; \
/* `c_n = a1.625^n`, approximation golden ratio `\phi ~ 1.618`. */ \
while(c0 < min_capacity) { \
size_t c1 = c0 + (c0 >> 1) + (c0 >> 3) + 1; \
if(c0 > c1) { c0 = max_size; break; } \
c0 = c1; \
} \
if(!(data = realloc(a->data, sizeof *a->data * c0))) \
{ if(!errno) errno = ERANGE; return 0; } \
a->data = data, a->capacity = c0; \
return 1; \
} \
/** Adds at least `buffer` un-initialised and uncounted elements at the back of
`a`. @return A pointer to the start of `buffer` elements, namely
`data + size`. If `a` is idle and `buffer` is zero, a null pointer is
returned, otherwise this indicates an error. @throws[realloc, ERANGE] */ \
static type *name##_array_buffer(struct name##_array *const a, \
const size_t buffer) { \
assert(a); \
if(a->size > (size_t)-1 - buffer) \
{ errno = ERANGE; return 0; } /* Unlikely. */ \
if(!name##_array_reserve(a, a->size + buffer)) return 0; \
return a->data ? a->data + a->size : 0; \
} \
/** Emplaces `n` elements on `a`. `n` must be smaller than or equal to the
highest remaining <fn:<name>_array_buffer>. */ \
static void name##_array_emplace(struct name##_array *const a, \
const size_t n) { \
assert(a && a->capacity >= a->size && n <= a->capacity - a->size); \
a->size += n; \
} \
/** @return Push back a new un-initialized datum of `a`.
@throws[realloc, ERANGE] */ \
static type *name##_array_new(struct name##_array *const a) { \
type *const data = name##_array_buffer(a, 1); \
return data ? name##_array_emplace(a, 1), data : 0; \
} \
/* They don't have to all be used, (destructor is important.) */ \
static void name##_unused_coda(void); static void name##_unused(void) { \
name##_array(0); name##_array_new(0); name##_unused_coda(); } \
static void name##_unused_coda(void) { name##_unused(); }