template.h File Reference

#include <stddef.h>
#include <stdint.h>
#include <derive-c/core.h>
#include <derive-c/panic.h>
#include <derive-c/self.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	T   derive_c_parameter_t
#define	T_DELETE   derive_c_parameter_t_delete
#define	INPLACE_CAPACITY   8
#define	INPLACE_TYPE   uint8_t

Functions
static SELF	new ()
static SELF	shallow_clone (SELF const *self)
static T const *	try_read (SELF const *self, INPLACE_TYPE index)
static T const *	read (SELF const *self, INPLACE_TYPE index)
static T *	try_write (SELF *self, INPLACE_TYPE index)
static T *	write (SELF *self, INPLACE_TYPE index)
static T *	try_push (SELF *self, T value)
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

INPLACE_CAPACITY

#define INPLACE_CAPACITY   8

Definition at line 31 of file template.h.

INPLACE_TYPE

#define INPLACE_TYPE   uint8_t

Definition at line 35 of file template.h.

T

#define T   derive_c_parameter_t

Definition at line 18 of file template.h.

T_DELETE

#define T_DELETE   derive_c_parameter_t_delete

Definition at line 20 of file template.h.

Function Documentation

delete()

void delete ( SELF * self )

static

Definition at line 129 of file template.h.

                                           {
    DEBUG_ASSERT(self);
    for (INPLACE_TYPE i = 0; i < self->size; i++) {
        T_DELETE(&self->data[i]);
    }
}

empty() [1/2]

bool empty ( ITER const * iter )

static

Definition at line 158 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 195 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 163 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 200 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 ( )

static

Definition at line 49 of file template.h.

{ return (SELF){.size = 0}; }

next() [1/2]

T * next ( ITER * iter )

static

Definition at line 143 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 180 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 118 of file template.h.

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

Here is the call graph for this function:

Here is the caller graph for this function:

position() [1/2]

size_t position ( ITER const * iter )

static

Definition at line 153 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 190 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 102 of file template.h.

                                                {
    T* slot = NAME(SELF, try_push)(self, value);
    ASSERT(slot);
    return slot;
}

Here is the call graph for this function:

Here is the caller graph for this function:

read()

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

static

Definition at line 71 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 51 of file template.h.

                                                        {
    SELF new_self = NAME(SELF, new)();
    new_self.size = self->size;
    // TODO(oliverkillane): premature optimization, only copy the data needed.
    // If this is already a very small vector, may be better to just
    // `return *self` and copy the entire buffer
    for (INPLACE_TYPE i = 0; i < self->size; i++) {
        new_self.data[i] = self->data[i];
    }
    return new_self;
}

Here is the call graph for this function:

size()

size_t size ( SELF const * self )

static

Definition at line 124 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 108 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:

Here is the caller graph for this function:

try_push()

T * try_push ( SELF * self, T value )

static

Definition at line 91 of file template.h.

                                                    {
    DEBUG_ASSERT(self);
    if (self->size < INPLACE_CAPACITY) {
        T* slot = &self->data[self->size];
        *slot = value;
        self->size++;
        return slot;
    }
    return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

try_read()

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

static

Definition at line 63 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, INPLACE_TYPE index )

static

Definition at line 77 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, INPLACE_TYPE index )

static

Definition at line 85 of file template.h.

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

Here is the call graph for this function: