stack.h

Go to the documentation of this file.

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2017 Mike Becker, Olaf Wintermann All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef UCX_STACK_H
#define UCX_STACK_H

#include "ucx.h"
#include "allocator.h"

#ifdef  __cplusplus
extern "C" {
#endif


typedef struct {
    UcxAllocator allocator;
    
    size_t size;
    
    char *space;
    
    char *top;
} UcxStack;

struct ucx_stack_metadata {
    char *prev;
    
    size_t size;
};

void ucx_stack_init(UcxStack *stack, char* space, size_t size);

void *ucx_stack_malloc(UcxStack *stack, size_t n);

void *ucx_stack_push(UcxStack *stack, size_t n, const void *data);

void *ucx_stack_calloc(UcxStack *stack, size_t nelem, size_t elsize);

void *ucx_stack_pusharr(UcxStack *stack,
        size_t nelem, size_t elsize, const void *data);

void *ucx_stack_realloc(UcxStack *stack, void *ptr, size_t n);

void ucx_stack_free(UcxStack *stack, void *ptr);


#define ucx_stack_topsize(stack) ((stack)->top ? ((struct ucx_stack_metadata*)\
                                  (stack)->top - 1)->size : 0)

#define ucx_stack_pop(stack, dest) ucx_stack_popn(stack, dest, (size_t)-1)

void ucx_stack_popn(UcxStack *stack, void *dest, size_t n);

size_t ucx_stack_avail(UcxStack *stack);

#define ucx_stack_empty(stack) (!(stack)->top)

#define ucx_stack_dim(size, elems) (size+sizeof(struct ucx_stack_metadata) * \
                                    (elems + 1))


#ifdef  __cplusplus
}
#endif

#endif  /* UCX_STACK_H */