aniani/icecast-common
1
0
Fork 0
mirror of https://gitlab.xiph.org/xiph/icecast-common.git synced 2024-12-04 14:46:31 -05:00
Code

Feature: Added some comments on how the igloo_list_t API is to be used

Browse Source
This commit is contained in:
Philipp Schafft 2018-11-08 13:52:30 +00:00
parent 7b73af07a9
commit 97f1652f7d
1 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
include/igloo/list.h
View File

@ -45,22 +45,54 @@ struct igloo_list_iterator_tag {
};
/* ---[ END PRIVATE ]--- */
/* To create lists use: igloo_ro_new(igloo_list_t)
*/
/* Clear a list (remove all elements). */
int igloo_list_clear(igloo_list_t *list);
/* Preallocate space for later mass-adding of elements. */
void igloo_list_preallocate(igloo_list_t *list, size_t request);
/* Limit elements to those of the given type. */
int igloo_list_set_type__real(igloo_list_t *list, const igloo_ro_type_t *type);
#define igloo_list_set_type(list,type) igloo_list_set_type__real((list),(igloo_ro__type__ ## type))
/* Add an element at the end of the list. */
int igloo_list_push(igloo_list_t *list, igloo_ro_t element);
/* Add an element at the begin of a list. */
int igloo_list_unshift(igloo_list_t *list, igloo_ro_t element);
/* Get and remove the first element from the list. */
igloo_ro_t igloo_list_shift(igloo_list_t *list);
/* Get and remove the last element from the list. */
igloo_ro_t igloo_list_pop(igloo_list_t *list);
/* Merge the content of the list elements into the list list. The list elements is not changed. */
int igloo_list_merge(igloo_list_t *list, igloo_list_t *elements);
/* Creates a new iterator that can be used to walk the list.
* The memory pointed to by storage of size storage_length is used to store the iterator's internal
* values. It must be allocated (e.g. on stack) untill igloo_list_iterator_end() is called.
* igloo_list_iterator_storage_t is provided to be used as storage object.
* Example:
* igloo_list_iterator_storage_t storage;
* igloo_list_iterator_t *iterator = igloo_list_iterator_start(list, &storage, sizeof(storage));
*/
igloo_list_iterator_t * igloo_list_iterator_start(igloo_list_t *list, void *storage, size_t storage_length);
/* Get next element from iterator. */
igloo_ro_t igloo_list_iterator_next(igloo_list_iterator_t *iterator);
/* Destory iterator. */
void igloo_list_iterator_end(igloo_list_iterator_t *iterator);
/* Rewind iterator. The next call to igloo_list_iterator_next() will return the first element again. */
int igloo_list_iterator_rewind(igloo_list_iterator_t *iterator);
/* Go thru all elements in the list.
* Parameters:
* list: the list to use.
* type: the type of elements in the list
* var: the variable to store the current element in.
* code: the code block to be used in the loop.
*
* Note: This can only be used on lists that contain only one type of objects.
* See also: igloo_list_set_type()
*/
#define igloo_list_foreach(list,type,var,code) \
do { \
igloo_list_iterator_storage_t __igloo_list_iterator_storage; \