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_LIST_H
#define UCX_LIST_H
 
#include "common.h"
#include "collection.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct cx_list_class_s cx_list_class;
 
struct cx_list_s {
    CX_COLLECTION_BASE;
    const cx_list_class *cl;
    const cx_list_class *climpl;
};
 
struct cx_list_class_s {
    void (*deallocate)(struct cx_list_s *list);
 
    int (*insert_element)(
            struct cx_list_s *list,
            size_t index,
            const void *data
    );
 
    size_t (*insert_array)(
            struct cx_list_s *list,
            size_t index,
            const void *data,
            size_t n
    );
 
    size_t (*insert_sorted)(
            struct cx_list_s *list,
            const void *sorted_data,
            size_t n
    );
 
    int (*insert_iter)(
            struct cx_iterator_s *iter,
            const void *elem,
            int prepend
    );
 
    size_t (*remove)(
            struct cx_list_s *list,
            size_t index,
            size_t num,
            void *targetbuf
    );
 
    void (*clear)(struct cx_list_s *list);
 
    int (*swap)(
            struct cx_list_s *list,
            size_t i,
            size_t j
    );
 
    void *(*at)(
            const struct cx_list_s *list,
            size_t index
    );
 
    size_t (*find_remove)(
            struct cx_list_s *list,
            const void *elem,
            bool remove
    );
 
    void (*sort)(struct cx_list_s *list);
 
    cx_attr_nonnull
    int (*compare)(
            const struct cx_list_s *list,
            const struct cx_list_s *other
    );
 
    void (*reverse)(struct cx_list_s *list);
 
    struct cx_iterator_s (*iterator)(
            const struct cx_list_s *list,
            size_t index,
            bool backward
    );
};
 
cx_attr_nonnull
cx_attr_export
size_t cx_list_default_insert_array(
        struct cx_list_s *list,
        size_t index,
        const void *data,
        size_t n
);
 
cx_attr_nonnull
cx_attr_export
size_t cx_list_default_insert_sorted(
        struct cx_list_s *list,
        const void *sorted_data,
        size_t n
);
 
cx_attr_nonnull
cx_attr_export
void cx_list_default_sort(struct cx_list_s *list);
 
cx_attr_nonnull
cx_attr_export
int cx_list_default_swap(struct cx_list_s *list, size_t i, size_t j);
 
cx_attr_nonnull_arg(1, 2, 3)
cx_attr_export
void cx_list_init(
    struct cx_list_s *list,
    struct cx_list_class_s *cl,
    const struct cx_allocator_s *allocator,
    cx_compare_func comparator,
    size_t elem_size
);
 
typedef struct cx_list_s CxList;
 
cx_attr_nonnull
static inline size_t cxListSize(const CxList *list) {
    return list->collection.size;
}
 
cx_attr_nonnull
static inline int cxListAdd(
        CxList *list,
        const void *elem
) {
    list->collection.sorted = false;
    return list->cl->insert_element(list, list->collection.size, elem);
}
 
cx_attr_nonnull
static inline size_t cxListAddArray(
        CxList *list,
        const void *array,
        size_t n
) {
    list->collection.sorted = false;
    return list->cl->insert_array(list, list->collection.size, array, n);
}
 
cx_attr_nonnull
static inline int cxListInsert(
        CxList *list,
        size_t index,
        const void *elem
) {
    list->collection.sorted = false;
    return list->cl->insert_element(list, index, elem);
}
 
cx_attr_nonnull
static inline int cxListInsertSorted(
        CxList *list,
        const void *elem
) {
    list->collection.sorted = true; // guaranteed by definition
    const void *data = list->collection.store_pointer ? &elem : elem;
    return list->cl->insert_sorted(list, data, 1) == 0;
}
 
cx_attr_nonnull
static inline size_t cxListInsertArray(
        CxList *list,
        size_t index,
        const void *array,
        size_t n
) {
    list->collection.sorted = false;
    return list->cl->insert_array(list, index, array, n);
}
 
cx_attr_nonnull
static inline size_t cxListInsertSortedArray(
        CxList *list,
        const void *array,
        size_t n
) {
    list->collection.sorted = true; // guaranteed by definition
    return list->cl->insert_sorted(list, array, n);
}
 
cx_attr_nonnull
static inline int cxListInsertAfter(
        CxIterator *iter,
        const void *elem
) {
    CxList* list = (CxList*)iter->src_handle.m;
    list->collection.sorted = false;
    return list->cl->insert_iter(iter, elem, 0);
}
 
cx_attr_nonnull
static inline int cxListInsertBefore(
        CxIterator *iter,
        const void *elem
) {
    CxList* list = (CxList*)iter->src_handle.m;
    list->collection.sorted = false;
    return list->cl->insert_iter(iter, elem, 1);
}
 
cx_attr_nonnull
static inline int cxListRemove(
        CxList *list,
        size_t index
) {
    return list->cl->remove(list, index, 1, NULL) == 0;
}
 
cx_attr_nonnull
cx_attr_access_w(3)
static inline int cxListRemoveAndGet(
        CxList *list,
        size_t index,
        void *targetbuf
) {
    return list->cl->remove(list, index, 1, targetbuf) == 0;
}
 
cx_attr_nonnull
static inline size_t cxListRemoveArray(
        CxList *list,
        size_t index,
        size_t num
) {
    return list->cl->remove(list, index, num, NULL);
}
 
cx_attr_nonnull
cx_attr_access_w(4)
static inline size_t cxListRemoveArrayAndGet(
        CxList *list,
        size_t index,
        size_t num,
        void *targetbuf
) {
    return list->cl->remove(list, index, num, targetbuf);
}
 
cx_attr_nonnull
static inline void cxListClear(CxList *list) {
    list->collection.sorted = true; // empty lists are always sorted
    list->cl->clear(list);
}
 
cx_attr_nonnull
static inline int cxListSwap(
        CxList *list,
        size_t i,
        size_t j
) {
    list->collection.sorted = false;
    return list->cl->swap(list, i, j);
}
 
cx_attr_nonnull
static inline void *cxListAt(
        const CxList *list,
        size_t index
) {
    return list->cl->at(list, index);
}
 
cx_attr_nonnull
cx_attr_nodiscard
static inline CxIterator cxListIteratorAt(
        const CxList *list,
        size_t index
) {
    return list->cl->iterator(list, index, false);
}
 
cx_attr_nonnull
cx_attr_nodiscard
static inline CxIterator cxListBackwardsIteratorAt(
        const CxList *list,
        size_t index
) {
    return list->cl->iterator(list, index, true);
}
 
cx_attr_nonnull
cx_attr_nodiscard
cx_attr_export
CxIterator cxListMutIteratorAt(
        CxList *list,
        size_t index
);
 
cx_attr_nonnull
cx_attr_nodiscard
cx_attr_export
CxIterator cxListMutBackwardsIteratorAt(
        CxList *list,
        size_t index
);
 
cx_attr_nonnull
cx_attr_nodiscard
static inline CxIterator cxListIterator(const CxList *list) {
    return list->cl->iterator(list, 0, false);
}
 
cx_attr_nonnull
cx_attr_nodiscard
static inline CxIterator cxListMutIterator(CxList *list) {
    return cxListMutIteratorAt(list, 0);
}
 
 
cx_attr_nonnull
cx_attr_nodiscard
static inline CxIterator cxListBackwardsIterator(const CxList *list) {
    return list->cl->iterator(list, list->collection.size - 1, true);
}
 
cx_attr_nonnull
cx_attr_nodiscard
static inline CxIterator cxListMutBackwardsIterator(CxList *list) {
    return cxListMutBackwardsIteratorAt(list, list->collection.size - 1);
}
 
cx_attr_nonnull
cx_attr_nodiscard
static inline size_t cxListFind(
        const CxList *list,
        const void *elem
) {
    return list->cl->find_remove((CxList*)list, elem, false);
}
 
cx_attr_nonnull
cx_attr_nodiscard
static inline bool cxListIndexValid(const CxList *list, size_t index) {
    return index < list->collection.size;
}
 
cx_attr_nonnull
static inline size_t cxListFindRemove(
        CxList *list,
        const void *elem
) {
    return list->cl->find_remove(list, elem, true);
}
 
cx_attr_nonnull
static inline void cxListSort(CxList *list) {
    if (list->collection.sorted) return;
    list->cl->sort(list);
    list->collection.sorted = true;
}
 
cx_attr_nonnull
static inline void cxListReverse(CxList *list) {
    // still sorted, but not according to the cmp_func
    list->collection.sorted = false;
    list->cl->reverse(list);
}
 
cx_attr_nonnull
cx_attr_nodiscard
cx_attr_export
int cxListCompare(
        const CxList *list,
        const CxList *other
);
 
cx_attr_export
void cxListFree(CxList *list);
 
cx_attr_export
extern CxList *const cxEmptyList;
 
 
#ifdef __cplusplus
} // extern "C"
#endif
 
#endif // UCX_LIST_H