list.h

Go to the documentation of this file.

/***************************************************************************
    begin........: June 2012
    copyright....: Sebastian Fedrau
    email........: sebastian.fedrau@gmail.com
 ***************************************************************************/
 
/***************************************************************************
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License v3 as published by
    the Free Software Foundation.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
    General Public License v3 for more details.
 ***************************************************************************/
#ifndef LIST_H
#define LIST_H
 
#include <stdint.h>
#include <stdbool.h>
 
#include "datatypes.h"
#include "pool.h"
 
typedef struct _ListItem
{
    void *data;
    struct _ListItem *next;
    struct _ListItem *prev;
} ListItem;
 
typedef struct
{
    ListItem *head;
    ListItem *tail;
    size_t count;
    CompareFunc compare;
    FreeFunc free;
    Pool *pool;
} List;
 
List *list_new(CompareFunc compare, FreeFunc free, Pool *pool);
 
void list_init(List *list, CompareFunc compare, FreeFunc free, Pool *pool);
 
void list_destroy(List *list);
 
void list_free(List *list);
 
ListItem *list_append(List *list, void *data);
 
ListItem *list_prepend(List *list, void *data);
 
ListItem *list_insert_sorted(List *list, void *data);
 
ListItem *list_head(const List *list);
 
ListItem *list_tail(const List *list);
 
size_t list_count(const List *list);
 
bool list_empty(const List *list);
 
void list_remove(List *list, ListItem *item);
 
void list_remove_by_data(List *list, void *data, bool remove_all);
 
void *list_pop(List *list);
 
bool list_contains(const List *list, const void *data);
 
void list_clear(List *list);
 
ListItem *list_find(const List *list, ListItem *offset, void const *data);
 
#define list_item_next(item) item->next
 
#define list_item_prev(item) item->prev
 
#define list_item_get_data(item) item->data
 
#define list_item_set_data(item, value) item->data = value
 
void list_item_free_data(const List *list, ListItem *item);
 
#endif