clist.h

Go to the documentation of this file.

/*
 * The MIT License (MIT)
 * Copyright (c) 2022 Zhengli Wang
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
 
#include <stdlib.h>
 
#ifndef __CLIST_H
#define __CLIST_H
struct node
{
    struct node *prev;
    void *item;
    struct node *next;
};
 
struct clist
{
    struct node *begin;
    struct node *current;
    struct node *end;
    size_t item_size;
    unsigned long current_index;
    size_t list_length;
};
 
struct clist *clist_init(size_t item_size);
 
size_t clist_free(struct clist *clist);
 
void *clist_append(struct clist *clist, const void *item);
 
void *clist_pop(struct clist *clist);
 
size_t clist_length(const struct clist *clist);
 
void *clist_jump(struct clist *clist, unsigned long index);
 
void *clist_read(const struct clist *clist);
 
void *clist_write(const struct clist *clist, void *item);
 
void *clist_insert(struct clist *clist, void *item, unsigned long index);
 
void *clist_remove(struct clist *clist, unsigned long index);
 
#endif