template.h File Reference

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include <derive-c/core.h>
#include <derive-c/panic.h>
#include <derive-c/self.h>
#include <derive-c/allocs/std.h>

Include dependency graph for template.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	SELF

Macros
#define	ALLOC   stdalloc
	A simple vector.
#define	T   derive_c_parameter_t
#define	T_DELETE   derive_c_parameter_t_delete

Functions
static SELF	new (ALLOC *alloc)
static SELF	new_with_capacity (size_t capacity, ALLOC *alloc)
static SELF	new_with_defaults (size_t size, T default_value, ALLOC *alloc)
static SELF	shallow_clone (SELF const *self)
static T const *	try_read (SELF const *self, size_t index)
static T const *	read (SELF const *self, size_t index)
static T *	try_write (SELF *self, size_t index)
static T *	write (SELF *self, size_t index)
static T *	push (SELF *self, T value)
static bool	try_pop (SELF *self, T *destination)
static T	pop (SELF *self)
static size_t	size (SELF const *self)
static void	delete (SELF *self)
static T *	next (ITER *iter)
static size_t	position (ITER const *iter)
static bool	empty (ITER const *iter)
static ITER	get_iter (SELF *self)
static T const *	next (ITER_CONST *iter)
static size_t	position (ITER_CONST const *iter)
static bool	empty (ITER_CONST const *iter)
static ITER_CONST	get_iter_const (SELF const *self)

Macro Definition Documentation

ALLOC

#define ALLOC   stdalloc

A simple vector.

Definition at line 15 of file template.h.

T

#define T   derive_c_parameter_t

Definition at line 25 of file template.h.

T_DELETE

#define T_DELETE   derive_c_parameter_t_delete

Definition at line 27 of file template.h.

Function Documentation

delete()

void delete ( SELF * self )

static

Definition at line 170 of file template.h.

                                           {
    DEBUG_ASSERT(self);
    if (self->data) {
        for (size_t i = 0; i < self->size; i++) {
            T_DELETE(&self->data[i]);
        }
        NAME(ALLOC, free)(self->alloc, self->data);
    }
}

Here is the call graph for this function:

empty() [1/2]

bool empty ( ITER const * iter )

static

Definition at line 202 of file template.h.

                                                {
    DEBUG_ASSERT(iter);
    return iter->pos >= iter->vec->size;
}

Here is the call graph for this function:

empty() [2/2]

bool empty ( ITER_CONST const * iter )

static

Definition at line 238 of file template.h.

                                                            {
    DEBUG_ASSERT(iter);
    return iter->pos >= iter->vec->size;
}

Here is the call graph for this function:

get_iter()

ITER get_iter ( SELF * self )

static

Definition at line 207 of file template.h.

                                             {
    DEBUG_ASSERT(self);
    return (ITER){
        .vec = self,
        .pos = 0,
    };
}

Here is the call graph for this function:

get_iter_const()

ITER_CONST get_iter_const ( SELF const * self )

static

Definition at line 243 of file template.h.

                                                               {
    DEBUG_ASSERT(self);
    return (ITER_CONST){
        .vec = self,
        .pos = 0,
    };
}

Here is the call graph for this function:

new()

SELF new ( ALLOC * alloc )

static

Definition at line 42 of file template.h.

                                          {
    SELF temp = (SELF){
        .size = 0,
        .capacity = 0,
        .data = NULL,
        .alloc = alloc,
    };
    return temp;
}

new_with_capacity()

SELF new_with_capacity ( size_t capacity, ALLOC * alloc )

static

Definition at line 52 of file template.h.

                                                                         {
    DEBUG_ASSERT(capacity > 0);
    T* data = (T*)NAME(ALLOC, malloc)(alloc, capacity * sizeof(T));
    ASSERT(LIKELY(data));
    return (SELF){
        .size = 0,
        .capacity = capacity,
        .data = data,
        .alloc = alloc,
    };
}

Here is the call graph for this function:

Here is the caller graph for this function:

new_with_defaults()

SELF new_with_defaults ( size_t size, T default_value, ALLOC * alloc )

static

Definition at line 64 of file template.h.

                                                                                      {
    T* data = (T*)NAME(ALLOC, malloc)(alloc, size * sizeof(T));
    for (size_t i = 0; i < size; i++) {
        data[i] = default_value;
    }
    ASSERT(LIKELY(data));
    return (SELF){
        .size = size,
        .capacity = size,
        .data = data,
        .alloc = alloc,
    };
}

Here is the call graph for this function:

Here is the caller graph for this function:

next() [1/2]

T * next ( ITER * iter )

static

Definition at line 187 of file template.h.

                                       {
    DEBUG_ASSERT(iter);
    if (iter->pos < iter->vec->size) {
        T* item = &iter->vec->data[iter->pos];
        iter->pos++;
        return item;
    }
    return NULL;
}

Here is the call graph for this function:

next() [2/2]

T const * next ( ITER_CONST * iter )

static

Definition at line 223 of file template.h.

                                                         {
    DEBUG_ASSERT(iter);
    if (iter->pos < iter->vec->size) {
        T const* item = &iter->vec->data[iter->pos];
        iter->pos++;
        return item;
    }
    return NULL;
}

Here is the call graph for this function:

pop()

T pop ( SELF * self )

static

Definition at line 159 of file template.h.

                                     {
    T entry;
    ASSERT(NAME(SELF, try_pop)(self, &entry));
    return entry;
}

Here is the call graph for this function:

position() [1/2]

size_t position ( ITER const * iter )

static

Definition at line 197 of file template.h.

                                                     {
    DEBUG_ASSERT(iter);
    return iter->pos;
}

Here is the call graph for this function:

position() [2/2]

size_t position ( ITER_CONST const * iter )

static

Definition at line 233 of file template.h.

                                                                 {
    DEBUG_ASSERT(iter);
    return iter->pos;
}

Here is the call graph for this function:

push()

T * push ( SELF * self, T value )

static

Definition at line 119 of file template.h.

                                                {
    DEBUG_ASSERT(self);
    if (self->size == self->capacity) {
        T* new_data;
        size_t new_capacity;
        if (self->data == NULL) {
            DEBUG_ASSERT(self->capacity == 0);
            // JUSTIFY: Allocating capacity of 4
            //           - Avoid repeat reallocations on growing a vector from
            //             size sero (from new)
            //           Otherwise an arbitrary choice (given we do not know the size of T)
            new_capacity = 8;
            new_data = (T*)NAME(ALLOC, malloc)(self->alloc, new_capacity * sizeof(T));
        } else {
            // JUSTIFY: Growth factor of 2
            //           - Simple arithmetic (for debugging)
            //           - Same as used by GCC's std::vector implementation
            new_capacity = self->capacity * 2;
            new_data = (T*)NAME(ALLOC, realloc)(self->alloc, self->data, new_capacity * sizeof(T));
        }
        ASSERT(new_data);
        self->capacity = new_capacity;
        self->data = new_data;
    }
    T* entry = &self->data[self->size];
    *entry = value;
    self->size++;
    return entry;
}

Here is the call graph for this function:

read()

T const * read ( SELF const * self, size_t index )

static

Definition at line 99 of file template.h.

                                                                 {
    T const* value = NAME(SELF, try_read)(self, index);
    ASSERT(value);
    return value;
}

Here is the call graph for this function:

shallow_clone()

SELF shallow_clone ( SELF const * self )

static

Definition at line 78 of file template.h.

                                                        {
    DEBUG_ASSERT(self);
    T* data = (T*)NAME(ALLOC, malloc)(self->alloc, self->capacity * sizeof(T));
    ASSERT(data);
    memcpy(data, self->data, self->size * sizeof(T));
    return (SELF){
        .size = self->size,
        .capacity = self->capacity,
        .data = data,
        .alloc = self->alloc,
    };
}

Here is the call graph for this function:

size()

size_t size ( SELF const * self )

static

Definition at line 165 of file template.h.

                                                 {
    DEBUG_ASSERT(self);
    return self->size;
}

Here is the call graph for this function:

try_pop()

bool try_pop ( SELF * self, T * destination )

static

Definition at line 149 of file template.h.

                                                            {
    DEBUG_ASSERT(self);
    if (LIKELY(self->size > 0)) {
        self->size--;
        *destination = self->data[self->size];
        return true;
    }
    return false;
}

Here is the call graph for this function:

try_read()

T const * try_read ( SELF const * self, size_t index )

static

Definition at line 91 of file template.h.

                                                                     {
    DEBUG_ASSERT(self);
    if (LIKELY(index < self->size)) {
        return &self->data[index];
    }
    return NULL;
}

Here is the call graph for this function:

try_write()

T * try_write ( SELF * self, size_t index )

static

Definition at line 105 of file template.h.

                                                          {
    DEBUG_ASSERT(self);
    if (LIKELY(index < self->size)) {
        return &self->data[index];
    }
    return NULL;
}

Here is the call graph for this function:

write()

T * write ( SELF * self, size_t index )

static

Definition at line 113 of file template.h.

                                                      {
    T* value = NAME(SELF, try_write)(self, index);
    ASSERT(value);
    return value;
}

Here is the call graph for this function: