list.h

Go to the documentation of this file.

/*
 
Copyright (c) 2005-2008, Simon Howard
 
Permission to use, copy, modify, and/or distribute this software 
for any purpose with or without fee is hereby granted, provided 
that the above copyright notice and this permission notice appear 
in all copies. 
 
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL 
WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED 
WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE 
AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR 
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, 
NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN      
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 
 
 */
 
#ifndef ALGORITHM_LIST_H
#define ALGORITHM_LIST_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct _ListEntry ListEntry;
 
typedef struct _ListIterator ListIterator;
 
typedef void *ListValue;
 
struct _ListIterator {
    ListEntry **prev_next;
    ListEntry *current;
};
 
#define LIST_NULL ((void *) 0)
 
typedef int (*ListCompareFunc)(ListValue value1, ListValue value2);
 
typedef int (*ListEqualFunc)(ListValue value1, ListValue value2);
 
void list_free(ListEntry *list);
 
ListEntry *list_prepend(ListEntry **list, ListValue data);
 
ListEntry *list_append(ListEntry **list, ListValue data);
 
ListEntry *list_prev(ListEntry *listentry);
 
ListEntry *list_next(ListEntry *listentry);
 
ListValue list_data(ListEntry *listentry);
 
ListEntry *list_nth_entry(ListEntry *list, int n);
 
ListValue list_nth_data(ListEntry *list, int n);
 
int list_length(ListEntry *list);
 
ListValue *list_to_array(ListEntry *list);
 
int list_remove_entry(ListEntry **list, ListEntry *entry);
 
int list_remove_data(ListEntry **list, ListEqualFunc callback, ListValue data);
 
void list_sort(ListEntry **list, ListCompareFunc compare_func);
 
ListEntry *list_find_data(ListEntry *list, 
                          ListEqualFunc callback,
                          ListValue data);
 
void list_iterate(ListEntry **list, ListIterator *iter);
 
int list_iter_has_more(ListIterator *iterator);
 
ListValue list_iter_next(ListIterator *iterator);
 
void list_iter_remove(ListIterator *iterator);
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef ALGORITHM_LIST_H */