src/cx/list.h

/*
 * 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.
 */
/**
 * \file list.h
 * \brief Interface for list implementations.
 * \author Mike Becker
 * \author Olaf Wintermann
 * \version 3.0
 * \copyright 2-Clause BSD License
 */

#ifndef UCX_LIST_H
#define UCX_LIST_H

#include <stdlib.h>
#include "allocator.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef int(*CxListComparator)(void const *left, void const *right);

typedef struct cx_list_s cx_list_s;

typedef struct {
    int (*add)(cx_list_s *list, void *elem);

    int (*insert)(cx_list_s *list, size_t index, void *elem);

    int (*remove)(cx_list_s *list, size_t index);

    void *(*at)(cx_list_s *list, size_t index);

    size_t (*find)(cx_list_s *list, void *elem);

    void *(*last)(cx_list_s *list);
} cx_list_class;

struct cx_list_s {
    cx_list_class *cl;
    CxAllocator allocator;
    CxListComparator cmpfunc;
    size_t itemsize;
    size_t size;
    size_t capacity;
};

typedef cx_list_s *CxList;

int cxListAdd(CxList list, void *elem);

int cxListInsert(CxList list, size_t index, void *elem);

int cxListRemove(CxList list, size_t index);

void *cxListAt(CxList list, size_t index);

size_t cxListFind(CxList list, void *elem);

void *cxListLast(CxList list);

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif /* UCX_LIST_H */