152 lines
4.5 KiB
C
152 lines
4.5 KiB
C
/*
|
|
* This file Copyright (C) 2007-2010 Mnemosyne LLC
|
|
*
|
|
* This file is licensed by the GPL version 2. Works owned by the
|
|
* Transmission project are granted a special exemption to clause 2(b)
|
|
* so that the bulk of its code can remain under the MIT license.
|
|
* This exemption does not extend to derived works not owned by
|
|
* the Transmission project.
|
|
*
|
|
* $Id$
|
|
*/
|
|
|
|
#ifndef __TRANSMISSION__
|
|
#error only libtransmission should #include this header.
|
|
#endif
|
|
|
|
#ifndef TR_LIST_H
|
|
#define TR_LIST_H
|
|
|
|
/**
|
|
* @addtogroup utils Utilities
|
|
* @{
|
|
*/
|
|
|
|
#include "transmission.h" /* inline */
|
|
|
|
/** @brief simple list structure similar to glib's GList */
|
|
typedef struct tr_list
|
|
{
|
|
void * data;
|
|
struct tr_list * next;
|
|
struct tr_list * prev;
|
|
}
|
|
tr_list;
|
|
|
|
typedef int ( *TrListCompareFunc )( const void * a, const void * b );
|
|
typedef void ( *TrListForeachFunc )( void * );
|
|
|
|
/**
|
|
* @brief return the number of items in the list
|
|
* @return the number of items in the list
|
|
*/
|
|
int tr_list_size( const tr_list * list );
|
|
|
|
/**
|
|
* @brief free the specified list and set its pointer to NULL
|
|
* @param list pointer to the list to be freed
|
|
* @param func optional function to invoke on each item in the list
|
|
*/
|
|
void tr_list_free( tr_list ** list, TrListForeachFunc data_free_func );
|
|
|
|
/**
|
|
* @brief append an item to the specified list
|
|
* @param list pointer to the list
|
|
* @param item the item to append
|
|
*/
|
|
void tr_list_append( tr_list ** list, void * data );
|
|
|
|
/**
|
|
* @brief prepend an item to the specified list
|
|
* @param list pointer to the list
|
|
* @param item the item to prepend
|
|
*/
|
|
void tr_list_prepend( tr_list ** list, void * data );
|
|
|
|
/**
|
|
* @brief remove the next item in the list
|
|
* @return the next item in the list, or NULL if the list is empty
|
|
* @param list pointer to the list
|
|
*/
|
|
void* tr_list_pop_front( tr_list ** list );
|
|
|
|
/**
|
|
* @brief remove the list's node that contains the specified data pointer
|
|
* @param list pointer to the list
|
|
* @param data data to remove
|
|
* @return the removed data pointer, or NULL if no match was found
|
|
*/
|
|
void* tr_list_remove_data( tr_list ** list, const void * data );
|
|
|
|
/**
|
|
* @brief remove the list's node that compares equal to "b" when compared with "compare_func"
|
|
* @param list pointer to the list
|
|
* @param b the comparison key
|
|
* @param compare_func the comparison function. The arguments passed to it will be the list's pointers and the comparison key "b"
|
|
* @return the removed data pointer, or NULL if no match was found
|
|
*/
|
|
void* tr_list_remove( tr_list ** list,
|
|
const void * b,
|
|
TrListCompareFunc compare_func );
|
|
|
|
/**
|
|
* @brief find the list node whose data that compares equal to "b" when compared with "compare_func"
|
|
* @param list pointer to the list
|
|
* @param b the comparison key
|
|
* @param compare_func the comparison function. The arguments passed to it will be the list's pointers and the comparison key "b"
|
|
* @return the matching list node, or NULL if not match was found
|
|
*/
|
|
tr_list* tr_list_find( tr_list * list,
|
|
const void * b,
|
|
TrListCompareFunc compare_func );
|
|
|
|
|
|
/** @brief Double-linked list with easy memory management and fast insert/remove operations */
|
|
struct __tr_list
|
|
{
|
|
struct __tr_list * next, * prev;
|
|
};
|
|
|
|
/**
|
|
* @brief Given a __tr_list node that's embedded in a struct, returns a pointer to the struct.
|
|
* @param ptr pointer to the embedded __tr_list
|
|
* @param type struct type that has contains the __tr_list
|
|
* @param field the name of the struct's _tr_list field
|
|
*/
|
|
#define __tr_list_entry(ptr,type,field) ((type*) (((char*)ptr) - offsetof(type,field)))
|
|
|
|
typedef int ( *__tr_list_cmp_t ) ( const void * a, const void * b );
|
|
typedef void ( *__tr_list_free_t )( void * );
|
|
|
|
|
|
/** @brief Init @head as an empty list. */
|
|
static inline void
|
|
__tr_list_init( struct __tr_list * head )
|
|
{
|
|
head->next = head->prev = head;
|
|
}
|
|
|
|
|
|
/** @brief Insert @list between @prev and @next. */
|
|
void
|
|
__tr_list_insert( struct __tr_list * list,
|
|
struct __tr_list * prev,
|
|
struct __tr_list * next);
|
|
|
|
/** @brief Append @list to the end of @head. */
|
|
static inline void
|
|
__tr_list_append( struct __tr_list * head, struct __tr_list * list)
|
|
{
|
|
__tr_list_insert( list, head->prev, head );
|
|
}
|
|
|
|
/** @brief Remove @head from the list it is in. */
|
|
void __tr_list_remove( struct __tr_list * head );
|
|
|
|
/** @brief Destroy the list and free all nodes */
|
|
void __tr_list_destroy( struct __tr_list * head, __tr_list_free_t func );
|
|
|
|
/* @} */
|
|
#endif /* TR_LIST_H */
|
|
|