ringbuf.h

Go to the documentation of this file.

#ifndef CSNIP_RINGBUF_H
#define CSNIP_RINGBUF_H
 
#include <stddef.h>
 
#include <csnip/err.h>
#include <csnip/preproc.h>
 
#define csnip_ringbuf_Init(head, len, N) \
    do { \
        (head) = 0; \
        (len) = 0; \
    } while (0)
 
#define csnip_ringbuf_GetHeadIdx(head, len, N, ret, err) \
    do { \
        if ((len) == 0) { \
            csnip_err_Raise(csnip_err_UNDERFLOW, err); \
            break; \
        } \
        (ret) = (head); \
    } while (0)
 
#define csnip_ringbuf_GetTailIdx(head, len, N, ret, err) \
    csnip_ringbuf__GetTailIdx((head), (len), (N), (ret), (err))
 
#define csnip_ringbuf__GetTailIdx(head, len, N, ret, err) \
    do { \
        if (len == 0) { \
            csnip_err_Raise(csnip_err_UNDERFLOW, err); \
            break; \
        } \
        ret = csnip_ringbuf__AddWrap(N, (len - 1), head); \
    } while (0)
#define csnip_ringbuf_PushHeadIdx(head, len, N, err) \
    csnip_ringbuf__PushHeadIdx((head), (len), (N), (err))
 
#define csnip_ringbuf__PushHeadIdx(head, len, N, err) \
    do { \
        if (len == N) { \
            csnip_err_Raise(csnip_err_NOMEM, err); \
            break; \
        } \
        csnip_ringbuf__SubWrapSet(N, 1, head); \
        ++len; \
    } while (0)
#define csnip_ringbuf_PopHeadIdx(head, len, N, err) \
    csnip_ringbuf__PopHeadIdx((head), (len), (N), (err))
 
#define csnip_ringbuf__PopHeadIdx(head, len, N, err) \
    do { \
        if (len == 0) { \
            csnip_err_Raise(csnip_err_UNDERFLOW, err); \
            break; \
        } \
        csnip_ringbuf__AddWrapSet(N, 1, head); \
        --len; \
    } while (0)
#define csnip_ringbuf_PushTailIdx(head, len, N, err) \
    csnip_ringbuf__PushTailIdx((head), (len), (N), (err))
 
#define csnip_ringbuf__PushTailIdx(head, len, N, err) \
    do { \
        if (len == N) { \
            csnip_err_Raise(csnip_err_NOMEM, err); \
            break; \
        } \
        ++len; \
    } while (0)
#define csnip_ringbuf_PopTailIdx(head, len, N, err) \
    csnip_ringbuf__PopTailIdx((head), (len), (N), (err))
 
#define csnip_ringbuf__PopTailIdx(head, len, N, err) \
    do { \
        if (len == 0) { \
            csnip_err_Raise(csnip_err_UNDERFLOW, err); \
            break; \
        } \
        --len; \
    } while (0)
#define csnip_ringbuf_IsFull(head, len, N) ((len) == (N))
 
#define csnip_ringbuf_IsEmpty(head, len, N) ((len) == 0)
 
#define csnip_ringbuf_CheckIdx(head, len, N, idx, err) \
    csnip_ringbuf__CheckIdx((head), (len), (N), (idx), (err))
 
#define csnip_ringbuf__CheckIdx(head, len, N, idx, err) \
    do { \
        if ((idx) >= (head)) { \
            if ((idx) - (head) >= (len)) { \
                csnip_err_Raise(csnip_err_RANGE, err); \
            } \
        } else { \
            if ((idx) - (head) + (N)  >= (len)) { \
                csnip_err_Raise(csnip_err_RANGE, err); \
            } \
        } \
    } while (0)
#define csnip_ringbuf_AddWrap(N, amount, idx) \
    ((amount) >= 0 ? csnip_ringbuf__AddWrap((N), (amount), (idx)) \
        : csnip_ringbuf__SubWrap((N), -(amount), (idx)))
 
#define csnip_ringbuf_AddWrapSet(N, amount, idx) \
    ((amount) >= 0 ? csnip_ringbuf__AddWrapSet((N), (amount), (idx)) \
        : csnip_ringbuf__SubWrapSet((N), -(amount), (idx)))
 
#define csnip_ringbuf_SubWrap(N, amount, idx) \
    ((amount) >= 0 ? csnip_ringbuf__SubWrap((N), (amount), (idx)) \
        : csnip_ringbuf__AddWrap((N), -(amount), (idx)))
 
#define csnip_ringbuf_SubWrapSet(N, amount, idx) \
    ((amount) >= 0 ? csnip_ringbuf__SubWrapSet((N), (amount), (idx)) \
        : csnip_ringbuf__AddWrapSet((N), -(amount), (idx)sebase))
 
#define csnip_ringbuf__AddWrap(N, amount, idx) \
    (idx < N - amount ? idx + amount : amount - (N - idx))
 
#define csnip_ringbuf__AddWrapSet(N, amount, idx) \
    (idx < N - amount ? (idx += amount) \
                : (idx = amount - (N - idx)))
 
#define csnip_ringbuf__SubWrap(N, amount, idx) \
    (idx >= amount ? idx - amount : idx - amount + N)
 
#define csnip_ringbuf__SubWrapSet(N, amount, idx) \
    (idx >= amount ? (idx -= amount) : (idx = idx - amount + N))
#define csnip_ringbuf_PushHead(head, len, N, arr, val, err) \
    do { \
        int csnip__err2 = 0; \
        csnip_ringbuf_PushHeadIdx(head, len, N, csnip__err2); \
        if (csnip__err2 != 0) { \
            csnip_err_Raise(csnip__err2, err); \
            break; \
        } \
        (arr)[head] = (val); \
    } while (0)
 
#define csnip_ringbuf_PopHead(head, len, N, arr, ret, err) \
    do { \
        (ret) = (arr)[head]; \
        csnip_ringbuf_PopHeadIdx(head, len, N, err); \
    } while (0)
 
#define csnip_ringbuf_PushTail(head, len, N, arr, val, err) \
    do { \
        int csnip__err2 = 0; \
        size_t csnip__i; \
        csnip_ringbuf_PushTailIdx(head, len, N, csnip__err2); \
        if (csnip__err2 != 0) { \
            csnip_err_Raise(csnip__err2, err); \
            break; \
        } \
        csnip_ringbuf_GetTailIdx(head, len, N, csnip__i, csnip__err2); \
        if (csnip__err2 != 0) { \
            csnip_err_Raise(csnip__err2, err); \
            break; \
        } \
        (arr)[csnip__i] = (val); \
    } while (0)
 
#define csnip_ringbuf_PopTail(head, len, N, arr, ret, err) \
    do { \
        int csnip__err2 = 0; \
        size_t csnip__i; \
        csnip_ringbuf_GetTailIdx(head, len, N, csnip__i, csnip__err2); \
        if (csnip__err2 != 0) { \
            csnip_err_Raise(csnip__err2, err); \
            break; \
        } \
        (ret) = (arr)[csnip__i]; \
        csnip_ringbuf_PopTailIdx(head, len, N, err); \
    } while (0)
 
#define CSNIP_RINGBUF_DECL_IDX_FUNCS(scope, prefix, idx_type, gen_args) \
    scope void prefix##init(csnip_pp_list_##gen_args); \
    scope idx_type prefix##get_head_idx(csnip_pp_list_##gen_args); \
    scope idx_type prefix##get_tail_idx(csnip_pp_list_##gen_args); \
    scope void prefix##push_head_idx(csnip_pp_list_##gen_args); \
    scope void prefix##pop_head_idx(csnip_pp_list_##gen_args); \
    scope void prefix##push_tail_idx(csnip_pp_list_##gen_args); \
    scope void prefix##pop_tail_idx(csnip_pp_list_##gen_args); \
    scope int prefix##is_full(csnip_pp_list_##gen_args); \
    scope int prefix##is_empty(csnip_pp_list_##gen_args); \
    scope void prefix##check_idx(csnip_pp_prepend_##gen_args idx_type); \
    scope idx_type prefix##add_wrap(csnip_pp_prepend_##gen_args \
                idx_type, idx_type); \
    scope idx_type prefix##sub_wrap(csnip_pp_prepend_##gen_args \
                idx_type, idx_type); \
 
#define CSNIP_RINGBUF_DECL_VAL_FUNCS(scope, prefix, val_type, gen_args) \
    scope void prefix##push_head(csnip_pp_prepend_##gen_args \
                    val_type val); \
    scope val_type prefix##pop_head(csnip_pp_list_##gen_args); \
    scope void prefix##push_tail(csnip_pp_prepend_##gen_args \
                    val_type val); \
    scope val_type prefix##pop_tail(csnip_pp_list_##gen_args);
 
#define CSNIP_RINGBUF_DEF_IDX_FUNCS(scope, prefix, idx_type, gen_args, \
    head, len, N, err) \
    scope void prefix##init(csnip_pp_list_##gen_args) { \
        csnip_ringbuf_Init(head, len, N); \
    } \
    scope idx_type prefix##get_head_idx(csnip_pp_list_##gen_args) { \
        idx_type csnip__ret; \
        csnip_ringbuf_GetHeadIdx(head, len, N, csnip__ret, err); \
        return csnip__ret; \
    } \
    scope idx_type prefix##get_tail_idx(csnip_pp_list_##gen_args) { \
        idx_type csnip__ret; \
        csnip_ringbuf_GetTailIdx(head, len, N, csnip__ret, err); \
        return csnip__ret; \
    } \
    scope void prefix##push_head_idx(csnip_pp_list_##gen_args) { \
        csnip_ringbuf_PushHeadIdx(head, len, N, err); \
    } \
    scope void prefix##pop_head_idx(csnip_pp_list_##gen_args) { \
        csnip_ringbuf_PopHeadIdx(head, len, N, err); \
    } \
    scope void prefix##push_tail_idx(csnip_pp_list_##gen_args) { \
        csnip_ringbuf_PushTailIdx(head, len, N, err); \
    } \
    scope void prefix##pop_tail_idx(csnip_pp_list_##gen_args) { \
        csnip_ringbuf_PopTailIdx(head, len, N, err); \
    } \
    scope int prefix##is_full(csnip_pp_list_##gen_args) { \
        return csnip_ringbuf_IsFull(head, len, N); \
    } \
    scope int prefix##is_empty(csnip_pp_list_##gen_args) { \
        return csnip_ringbuf_IsEmpty(head, len, N); \
    } \
    scope void prefix##check_idx(csnip_pp_prepend_##gen_args \
                    idx_type csnip__i) \
    { \
        csnip_ringbuf_CheckIdx(head, len, N, csnip__i, err); \
    } \
    scope idx_type prefix##add_wrap(csnip_pp_prepend_##gen_args \
            idx_type csnip__amount, idx_type csnip__base) \
    { \
        return csnip_ringbuf_AddWrap(N, csnip__amount, csnip__base); \
    } \
    scope idx_type prefix##sub_wrap(csnip_pp_prepend_##gen_args \
            idx_type csnip__amount, idx_type csnip__base) \
    { \
        return csnip_ringbuf_SubWrap(N, csnip__amount, csnip__base); \
    }
 
#define CSNIP_RINGBUF_DEF_VAL_FUNCS(scope, prefix, val_type, \
    gen_args, head, len, N, arr, err) \
    scope void prefix##push_head(csnip_pp_prepend_##gen_args \
                    val_type val) { \
        csnip_ringbuf_PushHead(head, len, N, arr, val, err); \
    } \
    scope val_type prefix##pop_head(csnip_pp_list_##gen_args) { \
        val_type csnip__ret; \
        csnip_ringbuf_PopHead(head, len, N, arr, csnip__ret, err); \
        return csnip__ret; \
    } \
    scope void prefix##push_tail(csnip_pp_prepend_##gen_args \
                    val_type val) { \
        csnip_ringbuf_PushTail(head, len, N, arr, val, err); \
    } \
    scope val_type prefix##pop_tail(csnip_pp_list_##gen_args) { \
        val_type csnip__ret; \
        csnip_ringbuf_PopTail(head, len, N, arr, csnip__ret, err); \
        return csnip__ret; \
    }
 
#endif /* CSNIP_RINGBUF_H */
 
#if defined(CSNIP_SHORT_NAMES) && !defined(CSNIP_RINGBUF_HAVE_SHORT_NAMES)
#define ringbuf_Init        csnip_ringbuf_Init
#define ringbuf_GetHeadIdx  csnip_ringbuf_GetHeadIdx
#define ringbuf_GetTailIdx  csnip_ringbuf_GetTailIdx
#define ringbuf_PushHeadIdx csnip_ringbuf_PushHeadIdx
#define ringbuf_PopHeadIdx  csnip_ringbuf_PopHeadIdx
#define ringbuf_PushTailIdx csnip_ringbuf_PushTailIdx
#define ringbuf_PopTailIdx  csnip_ringbuf_PopTailIdx
#define ringbuf_CheckIdx    csnip_ringbuf_CheckIdx
#define ringbuf_AddWrap     csnip_ringbuf_AddWrap
#define ringbuf_AddWrapSet  csnip_ringbuf_AddWrapSet
#define ringbuf_SubWrap     csnip_ringbuf_SubWrap
#define ringbuf_SubWrapSet  csnip_ringbuf_SubWrapSet
#define ringbuf_PushHead    csnip_ringbuf_PushHead
#define ringbuf_PopHead     csnip_ringbuf_PopHead
#define ringbuf_PushTail    csnip_ringbuf_PushTail
#define ringbuf_PopTail     csnip_ringbuf_PopTail
#define CSNIP_RINGBUF_HAVE_SHORT_NAMES
#endif /* CSNIP_SHORT_NAMES && !CSNIP_RINGBUF_HAVE_SHORT_NAMES */