template.h File Reference

#include <derive-c/core/includes/def.h>
#include "includes.h"
#include <derive-c/core/self/def.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	item_t
	A queue comprised of an extendable circular buffer. More...
struct	SELF
	An allocator that prints to stdout when it allocates or frees memory. More...

Macros
#define	ITEM   item_t
#define	ITEM_DELETE   item_delete
#define	ITEM_CLONE   item_clone
#define	ITEM_EQ   item_eq
#define	ITEM_DEBUG   item_debug

Functions
static void	ITEM_DELETE (item_t *)
static item_t	ITEM_CLONE (item_t const *self)
static bool	ITEM_EQ (item_t const *a, item_t const *b)
static void	ITEM_DEBUG (ITEM const *, dc_debug_fmt, FILE *)
static DC_PUBLIC SELF	from (ITEM value)
static DC_PUBLIC SELF	empty ()
static DC_PUBLIC SELF	clone (SELF const *self)
static DC_PUBLIC ITEM *	get (SELF *self)
static DC_PUBLIC ITEM const *	get_const (SELF const *self)
static DC_PUBLIC ITEM const *	get_const_or (SELF const *self, ITEM const *default_value)
static DC_PUBLIC ITEM	get_value_or (SELF const *self, ITEM const default_value)
static DC_PUBLIC bool	is_present (SELF const *self)
static DC_PUBLIC void	delete (SELF *self)
static DC_PUBLIC bool	replace (SELF *self, ITEM value)
static DC_PUBLIC void	debug (SELF *self, dc_debug_fmt fmt, FILE *stream)

Macro Definition Documentation

ITEM

#define ITEM   item_t

Definition at line 18 of file template.h.

ITEM_CLONE

#define ITEM_CLONE   item_clone

Definition at line 21 of file template.h.

ITEM_DEBUG

#define ITEM_DEBUG   item_debug

Definition at line 25 of file template.h.

ITEM_DELETE

#define ITEM_DELETE   item_delete

Definition at line 19 of file template.h.

ITEM_EQ

#define ITEM_EQ   item_eq

Definition at line 23 of file template.h.

Function Documentation

clone()

DC_PUBLIC SELF clone ( SELF const * self )

static

Definition at line 53 of file template.h.

                                                        {
    DC_ASSUME(self);
    if (self->present) {
        return NS(SELF, from)(ITEM_CLONE(&self->item));
    }
    return NS(SELF, empty)();
}

debug()

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

static

Definition at line 119 of file template.h.

                                                                                  {
    if (self->present) {
        fprintf(stream, DC_EXPAND_STRING(SELF) "@%p { ", (void*)self);
        fmt = dc_debug_fmt_scope_begin(fmt);
        ITEM_DEBUG(&self->item, fmt, stream);
        fprintf(stream, " }");
    } else {
        fprintf(stream, DC_EXPAND_STRING(SELF) "@%p { NONE }", (void*)self);
    }
}

delete()

DC_PUBLIC void delete ( SELF * self )

static

Definition at line 98 of file template.h.

                                                   {
    DC_ASSUME(self);
    if (self->present) {
        ITEM_DELETE(&self->item);
    }
}

empty()

DC_PUBLIC SELF empty ( )

static

Definition at line 51 of file template.h.

{ return (SELF){.present = false}; }

from()

DC_PUBLIC SELF from ( ITEM value )

static

Definition at line 49 of file template.h.

{ return (SELF){.item = value, .present = true}; }

get()

DC_PUBLIC ITEM * get ( SELF * self )

static

Definition at line 61 of file template.h.

                                                 {
    DC_ASSUME(self);
    if (self->present) {
        return &self->item;
    }
    return NULL;
}

get_const()

DC_PUBLIC ITEM const * get_const ( SELF const * self )

static

Definition at line 69 of file template.h.

                                                                   {
    DC_ASSUME(self);
    if (self->present) {
        return &self->item;
    }
    return NULL;
}

get_const_or()

DC_PUBLIC ITEM const * get_const_or ( SELF const * self, ITEM const * default_value )

static

Definition at line 77 of file template.h.

                                                                                                 {
    DC_ASSUME(self);
    if (self->present) {
        return &self->item;
    }
    return default_value;
}

get_value_or()

DC_PUBLIC ITEM get_value_or ( SELF const * self, ITEM const default_value )

static

Definition at line 85 of file template.h.

                                                                                         {
    DC_ASSUME(self);
    if (self->present) {
        return self->item;
    }
    return default_value;
}

is_present()

DC_PUBLIC bool is_present ( SELF const * self )

static

Definition at line 93 of file template.h.

                                                             {
    DC_ASSUME(self);
    return self->present;
}

ITEM_CLONE()

item_t ITEM_CLONE ( item_t const * self )

static

Definition at line 22 of file template.h.

{ return *self; }

ITEM_DEBUG()

void ITEM_DEBUG ( ITEM const * , dc_debug_fmt , FILE *  )

static

Definition at line 26 of file template.h.

{}

ITEM_DELETE()

void ITEM_DELETE ( item_t * )

static

Definition at line 20 of file template.h.

{}

ITEM_EQ()

bool ITEM_EQ ( item_t const * a, item_t const * b )

static

Definition at line 24 of file template.h.

{ return a->x == b->x; }

replace()

DC_PUBLIC bool replace ( SELF * self, ITEM value )

static

Definition at line 105 of file template.h.

                                                                {
    DC_ASSUME(self);
    bool was_present;
    if (self->present) {
        ITEM_DELETE(&self->item);
        was_present = true;
    } else {
        was_present = false;
    }
    self->item = value;
    self->present = true;
    return was_present;
}