linked_list.h

Go to the documentation of this file.

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2021 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_LINKED_LIST_H
#define UCX_LINKED_LIST_H
 
#include "common.h"
#include "list.h"

typedef struct cx_linked_list_s {
    struct cx_list_s base;
    off_t loc_prev;
    off_t loc_next;
    off_t loc_data;
    off_t loc_extra;
    size_t extra_data_len;
    void *begin;
    void *end;
} cx_linked_list;

CX_EXTERN CX_NODISCARD CX_MALLOC CX_DEALLOC(cxListFree, 1)
CxList *cxLinkedListCreate(const CxAllocator *allocator,
        size_t elem_size);

CX_EXTERN CX_NONNULL
void cx_linked_list_extra_data(cx_linked_list *list, size_t len);

CX_EXTERN CX_NONNULL CX_NODISCARD
void *cx_linked_list_at(const void *start,size_t start_index,
        ptrdiff_t loc_advance, size_t index);

CX_EXTERN CX_NONNULL_ARG(1, 4, 6)
void *cx_linked_list_find(const void *start, ptrdiff_t loc_advance,
        ptrdiff_t loc_data, const void *elem, size_t *found_index,
        cx_compare_func cmp_func);

CX_EXTERN CX_NONNULL_ARG(1, 4, 6)
void *cx_linked_list_find_c(const void *start, ptrdiff_t loc_advance,
        ptrdiff_t loc_data, const void *elem, size_t *found_index,
        cx_compare_func2 cmp_func, void *context);

CX_EXTERN CX_NONNULL CX_RETURNS_NONNULL
void *cx_linked_list_first(const void *node, ptrdiff_t loc_prev);

CX_EXTERN CX_NONNULL CX_RETURNS_NONNULL
void *cx_linked_list_last(const void *node, ptrdiff_t loc_next);

CX_EXTERN CX_NONNULL
void *cx_linked_list_prev(const void *begin, ptrdiff_t loc_next, const void *node);

CX_EXTERN CX_NONNULL_ARG(5)
void cx_linked_list_add(void **begin, void **end, ptrdiff_t loc_prev, ptrdiff_t loc_next, void *new_node);

CX_EXTERN CX_NONNULL_ARG(5)
void cx_linked_list_prepend(void **begin, void **end, ptrdiff_t loc_prev, ptrdiff_t loc_next, void *new_node);

CX_EXTERN CX_NONNULL
void cx_linked_list_link(void *left, void *right, ptrdiff_t loc_prev, ptrdiff_t loc_next);

CX_EXTERN CX_NONNULL
void cx_linked_list_unlink(void *left, void *right, ptrdiff_t loc_prev, ptrdiff_t loc_next);

CX_EXTERN CX_NONNULL_ARG(6)
void cx_linked_list_insert(void **begin, void **end,
        ptrdiff_t loc_prev, ptrdiff_t loc_next, void *node, void *new_node);

CX_EXTERN CX_NONNULL_ARG(6)
void cx_linked_list_insert_chain(void **begin, void **end,
        ptrdiff_t loc_prev, ptrdiff_t loc_next, void *node, void *insert_begin, void *insert_end);

CX_EXTERN CX_NONNULL_ARG(1, 5, 6)
void cx_linked_list_insert_sorted(void **begin, void **end,
        ptrdiff_t loc_prev, ptrdiff_t loc_next, void *new_node, cx_compare_func cmp_func);

CX_EXTERN CX_NONNULL_ARG(1, 5, 6)
void cx_linked_list_insert_sorted_chain(void **begin, void **end,
        ptrdiff_t loc_prev, ptrdiff_t loc_next, void *insert_begin, cx_compare_func cmp_func);

CX_EXTERN CX_NONNULL_ARG(1, 5, 6)
int cx_linked_list_insert_unique(void **begin, void **end,
        ptrdiff_t loc_prev, ptrdiff_t loc_next, void *new_node, cx_compare_func cmp_func);

CX_EXTERN CX_NONNULL_ARG(1, 5, 6) CX_NODISCARD
void *cx_linked_list_insert_unique_chain(void **begin, void **end,
        ptrdiff_t loc_prev, ptrdiff_t loc_next, void *insert_begin, cx_compare_func cmp_func);

CX_EXTERN CX_NONNULL_ARG(1, 5, 6)
void cx_linked_list_insert_sorted_c(void **begin, void **end,
        ptrdiff_t loc_prev, ptrdiff_t loc_next, void *new_node, cx_compare_func2 cmp_func, void *context);

CX_EXTERN CX_NONNULL_ARG(1, 5, 6)
void cx_linked_list_insert_sorted_chain_c(void **begin, void **end,
        ptrdiff_t loc_prev, ptrdiff_t loc_next, void *insert_begin, cx_compare_func2 cmp_func, void *context);

CX_EXTERN CX_NONNULL_ARG(1, 5, 6)
int cx_linked_list_insert_unique_c(void **begin, void **end,
        ptrdiff_t loc_prev, ptrdiff_t loc_next, void *new_node, cx_compare_func2 cmp_func, void *context);

CX_EXTERN CX_NONNULL_ARG(1, 5, 6) CX_NODISCARD
void *cx_linked_list_insert_unique_chain_c(void **begin, void **end,
        ptrdiff_t loc_prev, ptrdiff_t loc_next, void *insert_begin, cx_compare_func2 cmp_func, void *context);

CX_EXTERN CX_NONNULL_ARG(5)
size_t cx_linked_list_remove_chain(void **begin, void **end,
        ptrdiff_t loc_prev, ptrdiff_t loc_next, void *node, size_t num);

CX_EXTERN CX_NONNULL_ARG(5)
void cx_linked_list_remove(void **begin, void **end,
        ptrdiff_t loc_prev, ptrdiff_t loc_next, void *node);

CX_EXTERN CX_NODISCARD
size_t cx_linked_list_size(const void *node, ptrdiff_t loc_next);

CX_EXTERN CX_NONNULL_ARG(1, 6)
void cx_linked_list_sort(void **begin, void **end,
        ptrdiff_t loc_prev, ptrdiff_t loc_next, ptrdiff_t loc_data, cx_compare_func cmp_func);

CX_EXTERN CX_NONNULL_ARG(1, 6)
void cx_linked_list_sort_c(void **begin, void **end,
        ptrdiff_t loc_prev, ptrdiff_t loc_next, ptrdiff_t loc_data, cx_compare_func2 cmp_func, void *context);

CX_EXTERN CX_NONNULL_ARG(5)
int cx_linked_list_compare(const void *begin_left, const void *begin_right,
        ptrdiff_t loc_advance, ptrdiff_t loc_data, cx_compare_func cmp_func);

CX_EXTERN CX_NONNULL_ARG(5)
int cx_linked_list_compare_c(const void *begin_left, const void *begin_right,
        ptrdiff_t loc_advance, ptrdiff_t loc_data, cx_compare_func2 cmp_func, void *context);

CX_EXTERN CX_NONNULL_ARG(1)
void cx_linked_list_reverse(void **begin, void **end, ptrdiff_t loc_prev, ptrdiff_t loc_next);
 
#endif // UCX_LINKED_LIST_H