slist.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_SLIST_H
#define ALGORITHM_SLIST_H
 
#ifdef __cplusplus
extern "C" {
#endif

 
typedef struct _SListEntry SListEntry;

 
typedef struct _SListIterator SListIterator;

 
typedef void *SListValue;

 
struct _SListIterator {
    SListEntry **prev_next;
    SListEntry *current;
};

 
#define SLIST_NULL ((void *) 0)

 
typedef int (*SListCompareFunc)(SListValue value1, SListValue value2);

 
typedef int (*SListEqualFunc)(SListValue value1, SListValue value2);

 
void slist_free(SListEntry *list);

 
SListEntry *slist_prepend(SListEntry **list, SListValue data);

 
SListEntry *slist_append(SListEntry **list, SListValue data);

 
SListEntry *slist_next(SListEntry *listentry);

 
SListValue slist_data(SListEntry *listentry);

 
SListEntry *slist_nth_entry(SListEntry *list, int n);

 
SListValue slist_nth_data(SListEntry *list, int n);

 
int slist_length(SListEntry *list);

 
SListValue *slist_to_array(SListEntry *list);

 
int slist_remove_entry(SListEntry **list, SListEntry *entry);

 
int slist_remove_data(SListEntry **list,
                      SListEqualFunc callback,
                      SListValue data);

 
void slist_sort(SListEntry **list, SListCompareFunc compare_func);

 
SListEntry *slist_find_data(SListEntry *list, 
                            SListEqualFunc callback,
                            SListValue data);

 
void slist_iterate(SListEntry **list, SListIterator *iter);

 
int slist_iter_has_more(SListIterator *iterator);

    
SListValue slist_iter_next(SListIterator *iterator);

 
void slist_iter_remove(SListIterator *iterator);
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef ALGORITHM_SLIST_H */