mercury_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 MERCURY_LIST_H
#define MERCURY_LIST_H

#include "mercury_util_config.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct hg_list_entry hg_list_entry_t;

typedef struct hg_list_iter hg_list_iter_t;

typedef void *hg_list_value_t;

struct hg_list_iter {
    hg_list_entry_t **prev_next;
    hg_list_entry_t *current;
};

#define HG_LIST_NULL ((void *) 0)

typedef int (*hg_list_compare_func_t)(hg_list_value_t value1, hg_list_value_t value2);

typedef int (*hg_list_equal_func_t)(hg_list_value_t value1, hg_list_value_t value2);

HG_UTIL_EXPORT void
hg_list_free(hg_list_entry_t *list);

HG_UTIL_EXPORT hg_list_entry_t *
hg_list_prepend(hg_list_entry_t **list, hg_list_value_t data);

HG_UTIL_EXPORT hg_list_entry_t *
hg_list_append(hg_list_entry_t **list, hg_list_value_t data);

HG_UTIL_EXPORT hg_list_entry_t *
hg_list_prev(hg_list_entry_t *listentry);

HG_UTIL_EXPORT hg_list_entry_t *
hg_list_next(hg_list_entry_t *listentry);

HG_UTIL_EXPORT hg_list_value_t
hg_list_data(hg_list_entry_t *listentry);

HG_UTIL_EXPORT hg_list_entry_t *
hg_list_nth_entry(hg_list_entry_t *list, unsigned int n);

HG_UTIL_EXPORT hg_list_value_t
hg_list_nth_data(hg_list_entry_t *list, unsigned int n);

HG_UTIL_EXPORT unsigned int
hg_list_length(hg_list_entry_t *list);

HG_UTIL_EXPORT hg_list_value_t *
hg_list_to_array(hg_list_entry_t *list);

HG_UTIL_EXPORT int
hg_list_remove_entry(hg_list_entry_t **list, hg_list_entry_t *entry);

HG_UTIL_EXPORT unsigned int
hg_list_remove_data(hg_list_entry_t **list, hg_list_equal_func_t callback,
        hg_list_value_t data);

HG_UTIL_EXPORT void
hg_list_sort(hg_list_entry_t **list, hg_list_compare_func_t compare_func);

HG_UTIL_EXPORT hg_list_entry_t *
hg_list_find_data(hg_list_entry_t *list,
                          hg_list_equal_func_t callback,
                          hg_list_value_t data);

HG_UTIL_EXPORT void
hg_list_iterate(hg_list_entry_t **list, hg_list_iter_t *iter);

HG_UTIL_EXPORT int
hg_list_iter_has_more(hg_list_iter_t *iterator);

HG_UTIL_EXPORT hg_list_value_t
hg_list_iter_next(hg_list_iter_t *iterator);

HG_UTIL_EXPORT void
hg_list_iter_remove(hg_list_iter_t *iterator);

#ifdef __cplusplus
}
#endif

#endif /* MERCURY_LIST_H */