template.h File Reference

#include "derive-c/core/panic.h"
#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	OK
struct	ERROR
struct	SELF
	An allocator that prints to stdout when it allocates or frees memory. More...

Macros
#define	OK   ok_t
	A simple result type, using the (already) optional pointer type.
#define	OK_DELETE   DC_NO_DELETE
#define	OK_EQ   DC_MEM_EQ
#define	OK_CLONE   DC_COPY_CLONE
#define	OK_DEBUG   DC_DEFAULT_DEBUG
#define	ERROR   error_t
#define	ERROR_THROW(_)
#define	ERROR_DELETE   DC_NO_DELETE
#define	ERROR_EQ   DC_MEM_EQ
#define	ERROR_CLONE   DC_COPY_CLONE
#define	ERROR_DEBUG   DC_DEFAULT_DEBUG

Functions
static DC_PUBLIC SELF	from_ok (OK value)
static DC_PUBLIC SELF	from_error (ERROR value)
static DC_PUBLIC bool	is_error (SELF const *self)
static DC_PUBLIC OK const *	strict_get_const (SELF const *self)
static DC_PUBLIC OK const *	get_okay (SELF const *self)
static DC_PUBLIC ERROR const *	get_error (SELF const *self)
static DC_PUBLIC void	debug (SELF const *self, dc_debug_fmt fmt, FILE *stream)
static DC_PUBLIC void	delete (SELF *self)

Macro Definition Documentation

ERROR

#define ERROR   error_t

Definition at line 42 of file template.h.

ERROR_CLONE

#define ERROR_CLONE   DC_COPY_CLONE

Definition at line 61 of file template.h.

ERROR_DEBUG

#define ERROR_DEBUG   DC_DEFAULT_DEBUG

Definition at line 65 of file template.h.

ERROR_DELETE

#define ERROR_DELETE   DC_NO_DELETE

Definition at line 53 of file template.h.

ERROR_EQ

#define ERROR_EQ   DC_MEM_EQ

Definition at line 57 of file template.h.

ERROR_THROW

#define ERROR_THROW

(

_

)

Value:

DC_PANIC("Unexpected error in " DC_EXPAND_STRING(SELF))

Definition at line 49 of file template.h.

OK

#define OK   ok_t

A simple result type, using the (already) optional pointer type.

Definition at line 16 of file template.h.

OK_CLONE

#define OK_CLONE   DC_COPY_CLONE

Definition at line 31 of file template.h.

OK_DEBUG

#define OK_DEBUG   DC_DEFAULT_DEBUG

Definition at line 35 of file template.h.

OK_DELETE

#define OK_DELETE   DC_NO_DELETE

Definition at line 23 of file template.h.

OK_EQ

#define OK_EQ   DC_MEM_EQ

Definition at line 27 of file template.h.

Function Documentation

debug()

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

static

Definition at line 120 of file template.h.

                                                                                        {
    fprintf(stream, DC_EXPAND_STRING(SELF) "@%p {\n", (void*)self);
    fmt = dc_debug_fmt_scope_begin(fmt);
    if (self->success) {
        dc_debug_fmt_print(fmt, stream, "ok: ");
        OK_DEBUG(&self->result.ok, fmt, stream);
        fprintf(stream, ",\n");
    } else {
        dc_debug_fmt_print(fmt, stream, "error: ");
        ERROR_DEBUG(&self->result.error, fmt, stream);
        fprintf(stream, ",\n");
    }
    fmt = dc_debug_fmt_scope_end(fmt);
    dc_debug_fmt_print(fmt, stream, "}");
}

delete()

DC_PUBLIC void delete ( SELF * self )

static

Definition at line 136 of file template.h.

                                                   {
    if (self->success) {
        OK_DELETE(&self->result.ok);
    } else {
        ERROR_DELETE(&self->result.error);
    }
}

from_error()

DC_PUBLIC SELF from_error ( ERROR value )

static

Definition at line 86 of file template.h.

                                                        {
    return (SELF){
        .success = false,
        .result =
            {
                .error = value,
            },
    };
}

from_ok()

DC_PUBLIC SELF from_ok ( OK value )

static

Definition at line 76 of file template.h.

                                                  {
    return (SELF){
        .success = true,
        .result =
            {
                .ok = value,
            },
    };
}

get_error()

DC_PUBLIC ERROR const * get_error ( SELF const * self )

static

Definition at line 113 of file template.h.

                                                                    {
    if (!self->success) {
        return &self->result.error;
    }
    return NULL;
}

get_okay()

DC_PUBLIC OK const * get_okay ( SELF const * self )

static

Definition at line 106 of file template.h.

                                                                {
    if (self->success) {
        return &self->result.ok;
    }
    return NULL;
}

is_error()

DC_PUBLIC bool is_error ( SELF const * self )

static

Definition at line 96 of file template.h.

{ return !self->success; }

strict_get_const()

DC_PUBLIC OK const * strict_get_const ( SELF const * self )

static

Definition at line 98 of file template.h.

                                                                        {
    if (!self->success) {
        ERROR_THROW(&self->result.error);
        DC_UNREACHABLE("Error has already thrown");
    }
    return &self->result.ok;
}