template.h File Reference

#include <derive-c/core/includes/def.h>
#include "includes.h"
#include <derive-c/core/self/def.h>
#include <derive-c/container/bitset/static/template.h>
#include <derive-c/core/self/undef.h>
#include <derive-c/core/includes/undef.h>

Go to the source code of this file.

Data Structures
struct	value_t
struct	SELF
	An allocator that prints to stdout when it allocates or frees memory. More...
struct	ITER_CONST
struct	KV_PAIR_CONST
struct	ITER
struct	KV_PAIR

Macros
#define	CAPACITY   32
	A statically allocated hashmap that linearly looks up keys.
#define	KEY   map_key_t
#define	KEY_EQ   DC_MEM_EQ
#define	KEY_DELETE   DC_NO_DELETE
#define	KEY_CLONE   DC_COPY_CLONE
#define	KEY_DEBUG   DC_DEFAULT_DEBUG
#define	VALUE   value_t
#define	VALUE_DELETE   DC_NO_DELETE
#define	VALUE_CLONE   DC_COPY_CLONE
#define	VALUE_DEBUG   DC_DEFAULT_DEBUG
#define	BITSET   NS(NAME, bitset)
#define	EXCLUSIVE_END_INDEX   CAPACITY
#define	INTERNAL_NAME   BITSET
#define	INDEX_TYPE   NS(BITSET, index_t)
#define	INVARIANT_CHECK(self)
#define	ITER_CONST   NS(SELF, iter_const)
#define	KV_PAIR_CONST   NS(ITER_CONST, item)
#define	ITER   NS(SELF, iter)
#define	KV_PAIR   NS(ITER, item)

Functions
static size_t	capacity ()
static SELF	new ()
static VALUE const *	try_read (SELF const *self, KEY key)
static VALUE const *	read (SELF const *self, KEY key)
static VALUE *	try_write (SELF *self, KEY key)
static VALUE *	write (SELF *self, KEY key)
static VALUE *	try_insert (SELF *self, KEY key, VALUE value)
static VALUE *	insert (SELF *self, KEY key, VALUE value)
static bool	try_remove (SELF *self, KEY key, VALUE *dest)
static VALUE	remove (SELF *self, KEY key)
static void	delete_entry (SELF *self, KEY key)
static size_t	size (SELF const *self)
static SELF	clone (SELF const *self)
static void	delete (SELF *self)
static void	debug (SELF const *self, dc_debug_fmt fmt, FILE *stream)
static bool	empty_item (KV_PAIR_CONST const *item)
static KV_PAIR_CONST	next (ITER_CONST *iter)
static ITER_CONST	get_iter_const (SELF const *self)
static bool	empty_item (KV_PAIR const *item)
static KV_PAIR	next (ITER *iter)
static ITER	get_iter (SELF *self)
	DC_TRAIT_MAP (SELF)

Macro Definition Documentation

BITSET

#define BITSET   NS(NAME, bitset)

Definition at line 68 of file template.h.

CAPACITY

#define CAPACITY   32

A statically allocated hashmap that linearly looks up keys.

Definition at line 14 of file template.h.

EXCLUSIVE_END_INDEX

#define EXCLUSIVE_END_INDEX   CAPACITY

Definition at line 70 of file template.h.

INDEX_TYPE

#define INDEX_TYPE   NS(BITSET, index_t)

Definition at line 74 of file template.h.

INTERNAL_NAME

#define INTERNAL_NAME   BITSET

Definition at line 71 of file template.h.

INVARIANT_CHECK

#define INVARIANT_CHECK

(

self

)

Value:

DC_ASSUME(self);

Definition at line 85 of file template.h.

ITER

#define ITER   NS(SELF, iter)

Definition at line 292 of file template.h.

ITER_CONST

#define ITER_CONST   NS(SELF, iter_const)

Definition at line 233 of file template.h.

KEY

#define KEY   map_key_t

Definition at line 21 of file template.h.

KEY_CLONE

#define KEY_CLONE   DC_COPY_CLONE

Definition at line 34 of file template.h.

KEY_DEBUG

#define KEY_DEBUG   DC_DEFAULT_DEBUG

Definition at line 38 of file template.h.

KEY_DELETE

#define KEY_DELETE   DC_NO_DELETE

Definition at line 30 of file template.h.

KEY_EQ

#define KEY_EQ   DC_MEM_EQ

Definition at line 26 of file template.h.

KV_PAIR

#define KV_PAIR   NS(ITER, item)

Definition at line 293 of file template.h.

KV_PAIR_CONST

#define KV_PAIR_CONST   NS(ITER_CONST, item)

Definition at line 234 of file template.h.

VALUE

#define VALUE   value_t

Definition at line 48 of file template.h.

VALUE_CLONE

#define VALUE_CLONE   DC_COPY_CLONE

Definition at line 56 of file template.h.

VALUE_DEBUG

#define VALUE_DEBUG   DC_DEFAULT_DEBUG

Definition at line 60 of file template.h.

VALUE_DELETE

#define VALUE_DELETE   DC_NO_DELETE

Definition at line 52 of file template.h.

Function Documentation

capacity()

size_t capacity ( )

static

Definition at line 66 of file template.h.

{ return CAPACITY; };

clone()

SELF clone ( SELF const * self )

static

Definition at line 182 of file template.h.

                                              {
    INVARIANT_CHECK(self);
 
    SELF new_self = (SELF){
        .presence = NS(BITSET, clone)(&self->presence),
        .derive_c_map_staticlinear = dc_gdb_marker_new(),
        .iterator_invalidation_tracker = mutation_tracker_new(),
    };
    for (INDEX_TYPE index = 0; index < CAPACITY; index++) {
        if (NS(BITSET, get)(&self->presence, index)) {
            new_self.keys[index] = KEY_CLONE(&self->keys[index]);
            new_self.values[index] = VALUE_CLONE(&self->values[index]);
        }
    }
    return new_self;
}

DC_TRAIT_MAP()

DC_TRAIT_MAP

(

SELF

)

debug()

void debug ( SELF const * self, dc_debug_fmt fmt, FILE * stream )

static

Definition at line 211 of file template.h.

                                                                              {
    fprintf(stream, EXPAND_STRING(SELF) "@%p {\n", self);
    fmt = dc_debug_fmt_scope_begin(fmt);
 
    dc_debug_fmt_print(fmt, stream, "entries: [");
    fmt = dc_debug_fmt_scope_begin(fmt);
    for (INDEX_TYPE index = 0; index < CAPACITY; index++) {
        if (NS(BITSET, get)(&self->presence, index)) {
            dc_debug_fmt_print(fmt, stream, "(index: %lu, key: ", (size_t)index);
            KEY_DEBUG(&self->keys[index], fmt, stream);
            dc_debug_fmt_print(fmt, stream, ", value: ");
            VALUE_DEBUG(&self->values[index], fmt, stream);
            dc_debug_fmt_print(fmt, stream, "), ");
        }
    }
    fmt = dc_debug_fmt_scope_end(fmt);
    dc_debug_fmt_print(fmt, stream, "],\n");
 
    fmt = dc_debug_fmt_scope_end(fmt);
    dc_debug_fmt_print(fmt, stream, "}");
}

delete()

void delete ( SELF * self )

static

Definition at line 199 of file template.h.

                                         {
    INVARIANT_CHECK(self);
 
    for (INDEX_TYPE index = 0; index < CAPACITY; index++) {
        if (NS(BITSET, get)(&self->presence, index)) {
            KEY_DELETE(&self->keys[index]);
            VALUE_DELETE(&self->values[index]);
        }
    }
    NS(BITSET, delete)(&self->presence);
}

delete_entry()

void delete_entry ( SELF * self, KEY key )

static

Definition at line 175 of file template.h.

                                                        {
    VALUE val = NS(SELF, remove)(self, key);
    VALUE_DELETE(&val);
}

empty_item() [1/2]

bool empty_item ( KV_PAIR const * item )

static

Definition at line 306 of file template.h.

                                                      {
    return item->key == NULL && item->value == NULL;
}

empty_item() [2/2]

bool empty_item ( KV_PAIR_CONST const * item )

static

Definition at line 247 of file template.h.

                                                                  {
    return item->key == NULL && item->value == NULL;
}

get_iter()

ITER get_iter ( SELF * self )

static

Definition at line 333 of file template.h.

                                           {
    INVARIANT_CHECK(self);
 
    INDEX_TYPE next_index = 0;
    while (next_index < CAPACITY && !NS(BITSET, get)(&self->presence, next_index)) {
        next_index++;
    }
 
    return (ITER){
        .map = self,
        .next_index = next_index,
        .version = mutation_tracker_get(&self->iterator_invalidation_tracker),
    };
}

get_iter_const()

ITER_CONST get_iter_const ( SELF const * self )

static

Definition at line 274 of file template.h.

                                                             {
    INVARIANT_CHECK(self);
 
    INDEX_TYPE next_index = 0;
    while (next_index < CAPACITY && !NS(BITSET, get)(&self->presence, next_index)) {
        next_index++;
    }
 
    return (ITER_CONST){
        .map = self,
        .next_index = next_index,
        .version = mutation_tracker_get(&self->iterator_invalidation_tracker),
    };
}

insert()

VALUE * insert ( SELF * self, KEY key, VALUE value )

static

Definition at line 148 of file template.h.

                                                                 {
    VALUE* placed = NS(SELF, try_insert)(self, key, value);
    DC_ASSERT(placed);
    return placed;
}

new()

SELF new ( )

static

Definition at line 87 of file template.h.

                            {
    return (SELF){
        .presence = NS(BITSET, new)(),
        .keys = {},
        .values = {},
        .derive_c_map_staticlinear = dc_gdb_marker_new(),
        .iterator_invalidation_tracker = mutation_tracker_new(),
    };
}

next() [1/2]

KV_PAIR next ( ITER * iter )

static

Definition at line 310 of file template.h.

                                          {
    mutation_version_check(&iter->version);
    INDEX_TYPE const next_index = iter->next_index;
 
    if (next_index == CAPACITY) {
        return (KV_PAIR){.key = NULL, .value = NULL};
    }
 
    iter->next_index++;
    while (iter->next_index < CAPACITY &&
           !NS(BITSET, get)(&iter->map->presence, iter->next_index)) {
        iter->next_index++;
    }
 
    if (next_index == CAPACITY) {
        return (KV_PAIR){.key = NULL, .value = NULL};
    }
    return (KV_PAIR){
        .key = &iter->map->keys[next_index],
        .value = &iter->map->values[next_index],
    };
}

next() [2/2]

KV_PAIR_CONST next ( ITER_CONST * iter )

static

Definition at line 251 of file template.h.

                                                            {
    mutation_version_check(&iter->version);
    INDEX_TYPE const next_index = iter->next_index;
 
    if (next_index == CAPACITY) {
        return (KV_PAIR_CONST){.key = NULL, .value = NULL};
    }
 
    iter->next_index++;
    while (iter->next_index < CAPACITY &&
           !NS(BITSET, get)(&iter->map->presence, iter->next_index)) {
        iter->next_index++;
    }
 
    if (next_index == CAPACITY) {
        return (KV_PAIR_CONST){.key = NULL, .value = NULL};
    }
    return (KV_PAIR_CONST){
        .key = &iter->map->keys[next_index],
        .value = &iter->map->values[next_index],
    };
}

read()

VALUE const * read ( SELF const * self, KEY key )

static

Definition at line 107 of file template.h.

                                                              {
    VALUE const* value = NS(SELF, try_read)(self, key);
    DC_ASSERT(value);
    return value;
}

remove()

VALUE remove ( SELF * self, KEY key )

static

Definition at line 169 of file template.h.

                                                   {
    VALUE dest;
    DC_ASSERT(NS(SELF, try_remove)(self, key, &dest));
    return dest;
}

size()

size_t size ( SELF const * self )

static

Definition at line 180 of file template.h.

{ return (size_t)NS(BITSET, size)(&self->presence); }

try_insert()

VALUE * try_insert ( SELF * self, KEY key, VALUE value )

static

Definition at line 123 of file template.h.

                                                                     {
    INVARIANT_CHECK(self);
    mutation_tracker_mutate(&self->iterator_invalidation_tracker);
 
    if (NS(BITSET, size)(&self->presence) + 1 > CAPACITY) {
        return NULL;
    }
 
    VALUE const* existing_value = NS(SELF, try_read)(self, key);
    if (existing_value) {
        return NULL;
    }
 
    for (INDEX_TYPE index = 0; index < CAPACITY; index++) {
        if (!NS(BITSET, get)(&self->presence, index)) {
            NS(BITSET, set)(&self->presence, index, true);
            self->keys[index] = key;
            self->values[index] = value;
            return &self->values[index];
        }
    }
 
    DC_UNREACHABLE("A space must exist for insert");
}

try_read()

VALUE const * try_read ( SELF const * self, KEY key )

static

Definition at line 97 of file template.h.

                                                                  {
    INVARIANT_CHECK(self);
    for (INDEX_TYPE index = 0; index < CAPACITY; index++) {
        if (NS(BITSET, get)(&self->presence, index) && KEY_EQ(&self->keys[index], &key)) {
            return &self->values[index];
        }
    }
    return NULL;
}

try_remove()

bool try_remove ( SELF * self, KEY key, VALUE * dest )

static

Definition at line 154 of file template.h.

                                                                   {
    INVARIANT_CHECK(self);
    mutation_tracker_mutate(&self->iterator_invalidation_tracker);
 
    for (INDEX_TYPE index = 0; index < CAPACITY; index++) {
        if (NS(BITSET, get)(&self->presence, index) && KEY_EQ(&self->keys[index], &key)) {
            NS(BITSET, set)(&self->presence, index, false);
            KEY_DELETE(&self->keys[index]);
            *dest = self->values[index];
            return true;
        }
    }
    return false;
}

try_write()

VALUE * try_write ( SELF * self, KEY key )

static

Definition at line 113 of file template.h.

                                                       {
    return (VALUE*)(NS(SELF, try_read)(self, key));
}

write()

VALUE * write ( SELF * self, KEY key )

static

Definition at line 117 of file template.h.

                                                   {
    VALUE* value = NS(SELF, try_write)(self, key);
    DC_ASSERT(value);
    return value;
}