mirror of
https://github.com/transmission/transmission
synced 2024-12-26 01:27:28 +00:00
879a2afcbd
The Berne Convention says that the copyright year is moot, so instead of adding another year to each file as in previous years, I've removed the year altogether from the source code comments in libtransmission, gtk, qt, utils, daemon, and cli. Juliusz's copyright notice in tr-dht and Johannes' copyright notice in tr-lpd have been left alone; it didn't seem appropriate to modify them.
117 lines
3.4 KiB
C
117 lines
3.4 KiB
C
/*
|
|
* This file Copyright (C) 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 Insert in an ordered list
|
|
* @param list pointer to the list
|
|
* @param item the item to be inserted
|
|
* @param compare the comparison function.
|
|
*/
|
|
void tr_list_insert_sorted( tr_list ** list,
|
|
void * data,
|
|
TrListCompareFunc compare );
|
|
|
|
|
|
|
|
/* @} */
|
|
#endif /* TR_LIST_H */
|
|
|