alpm_list man page
alpm_list — Functions to manipulate alpm_list_t lists. void alpm_list_free (alpm_list_t *list) Functions to manipulate alpm_list_t lists. These functions are designed to create, destroy, and modify lists of type alpm_list_t. This is an internal list type used by libalpm that is publicly exposed for use by frontends if desired. Add a new item to the end of the list. list the list to add to the resultant list References alpm_list_append(). Referenced by alpm_checkdeps(), alpm_initialize(), alpm_list_add_sorted(), alpm_list_copy(), alpm_list_copy_data(), alpm_list_diff_sorted(), alpm_list_remove_dupes(), alpm_list_reverse(), and alpm_list_strdup(). Add items to a list in sorted order. list the list to add to the resultant list References alpm_list_add(), __alpm_list_t::data, __alpm_list_t::next, and __alpm_list_t::prev. Add a new item to the end of the list. list the list to add to the newly added item References alpm_list_last(), __alpm_list_t::data, __alpm_list_t::next, and __alpm_list_t::prev. Referenced by alpm_list_add(). Copy a list, without copying data. list the list to copy a copy of the original list References alpm_list_add(), __alpm_list_t::data, and __alpm_list_t::next. Referenced by alpm_list_diff(). Copy a list and copy the data. Note that the data elements to be copied should not contain pointers and should also be of constant size. list the list to copy a copy of the original list, data copied as well References alpm_list_add(), __alpm_list_t::data, and __alpm_list_t::next. Get the number of items in a list. list the list the number of list items References __alpm_list_t::next. Referenced by alpm_list_diff(). Find the items in list lhs the first list a list containing all items in References alpm_list_copy(), alpm_list_count(), alpm_list_diff_sorted(), alpm_list_free(), and alpm_list_msort(). Find the differences between list left the first list References alpm_list_add(), __alpm_list_t::data, and __alpm_list_t::next. Referenced by alpm_list_diff(). Find an item in a list. needle the item to search References __alpm_list_t::data, and __alpm_list_t::next. Referenced by alpm_list_find_ptr(), alpm_list_find_str(), and alpm_pkg_should_ignore(). Find an item in a list. Search for the item whose data matches that of the needle the data to search for (== comparison) References alpm_list_find(). Referenced by alpm_list_remove_dupes(). Find a string in a list. needle the string to search for References alpm_list_find(). Free a list, but not the contained data. list the list to free References __alpm_list_t::next. Referenced by alpm_list_diff(). Free the internal data of a list structure. list the list to free References __alpm_list_t::data, and __alpm_list_t::next. Join two lists. The two lists must be independent. Do not free the original lists after calling this function, as this is not a copy operation. The list pointers passed in should be considered invalid after calling this function. first the first list the resultant joined list References __alpm_list_t::next, and __alpm_list_t::prev. Get the last item in the list. list the list the last element in the list References __alpm_list_t::prev. Referenced by alpm_list_append(), and alpm_list_reverse(). Merge the two sorted sublists into one sorted list. left the first list the resultant list References __alpm_list_t::data, __alpm_list_t::next, and __alpm_list_t::prev. Referenced by alpm_list_msort(). Sort a list of size list the list to sort the resultant list References alpm_list_mmerge(), alpm_list_msort(), __alpm_list_t::next, and __alpm_list_t::prev. Referenced by alpm_list_diff(), and alpm_list_msort(). Get the next element of a list. node the list node the next element, or NULL when no more elements exist References __alpm_list_t::next. Return nth element from list (starting from 0). list the list an alpm_list_t node for index References __alpm_list_t::next. Get the previous element of a list. list the list head the previous element, or NULL when no previous element exist References __alpm_list_t::next, and __alpm_list_t::prev. Remove an item from the list. haystack the list to remove the item from the resultant list References alpm_list_remove_item(), __alpm_list_t::data, and __alpm_list_t::next. Referenced by alpm_list_remove_str(). Create a new list without any duplicates. This does NOT copy data members. list the list to copy a new list containing non-duplicate items References alpm_list_add(), alpm_list_find_ptr(), __alpm_list_t::data, and __alpm_list_t::next. Remove an item from the list. item is not freed; this is the responsibility of the caller. haystack the list to remove the item from the resultant list References __alpm_list_t::next, and __alpm_list_t::prev. Referenced by alpm_list_remove(). Remove a string from a list. haystack the list to remove the item from the resultant list References alpm_list_remove(). Create a new list in reverse order. list the list to copy a new list in reverse order References alpm_list_add(), alpm_list_last(), __alpm_list_t::data, and __alpm_list_t::prev. Copy a string list, including data. list the list to copy a copy of the original list References alpm_list_add(), __alpm_list_t::data, and __alpm_list_t::next. Copy a list and data into a standard C array of fixed length. Note that the data elements are shallow copied so any contained pointers will point to the original data. list the list to copy an array version of the original list, data copied as well References __alpm_list_t::next. Generated automatically by Doxygen for libalpm from the source code.Synopsis
Functions
Free a list, but not the contained data.
void alpm_list_free_inner (alpm_list_t *list, alpm_list_fn_free fn)
Free the internal data of a list structure.
alpm_list_t * alpm_list_add (alpm_list_t *list, void *data)
Add a new item to the end of the list.
alpm_list_t * alpm_list_append (alpm_list_t **list, void *data)
Add a new item to the end of the list.
alpm_list_t * alpm_list_add_sorted (alpm_list_t *list, void *data, alpm_list_fn_cmp fn)
Add items to a list in sorted order.
alpm_list_t * alpm_list_join (alpm_list_t *first, alpm_list_t *second)
Join two lists.
alpm_list_t * alpm_list_mmerge (alpm_list_t *left, alpm_list_t *right, alpm_list_fn_cmp fn)
Merge the two sorted sublists into one sorted list.
alpm_list_t * alpm_list_msort (alpm_list_t *list, size_t n, alpm_list_fn_cmp fn)
Sort a list of size n using mergesort algorithm.
alpm_list_t * alpm_list_remove_item (alpm_list_t *haystack, alpm_list_t *item)
Remove an item from the list.
alpm_list_t * alpm_list_remove (alpm_list_t *haystack, const void *needle, alpm_list_fn_cmp fn, void **data)
Remove an item from the list.
alpm_list_t * alpm_list_remove_str (alpm_list_t *haystack, const char *needle, char **data)
Remove a string from a list.
alpm_list_t * alpm_list_remove_dupes (const alpm_list_t *list)
Create a new list without any duplicates.
alpm_list_t * alpm_list_strdup (const alpm_list_t *list)
Copy a string list, including data.
alpm_list_t * alpm_list_copy (const alpm_list_t *list)
Copy a list, without copying data.
alpm_list_t * alpm_list_copy_data (const alpm_list_t *list, size_t size)
Copy a list and copy the data.
alpm_list_t * alpm_list_reverse (alpm_list_t *list)
Create a new list in reverse order.
alpm_list_t * alpm_list_nth (const alpm_list_t *list, size_t n)
Return nth element from list (starting from 0).
alpm_list_t * alpm_list_next (const alpm_list_t *node)
Get the next element of a list.
alpm_list_t * alpm_list_previous (const alpm_list_t *list)
Get the previous element of a list.
alpm_list_t * alpm_list_last (const alpm_list_t *list)
Get the last item in the list.
size_t alpm_list_count (const alpm_list_t *list)
Get the number of items in a list.
void * alpm_list_find (const alpm_list_t *haystack, const void *needle, alpm_list_fn_cmp fn)
Find an item in a list.
void * alpm_list_find_ptr (const alpm_list_t *haystack, const void *needle)
Find an item in a list.
char * alpm_list_find_str (const alpm_list_t *haystack, const char *needle)
Find a string in a list.
void alpm_list_diff_sorted (const alpm_list_t *left, const alpm_list_t *right, alpm_list_fn_cmp fn, alpm_list_t **onlyleft, alpm_list_t **onlyright)
Find the differences between list left and list right
alpm_list_t * alpm_list_diff (const alpm_list_t *lhs, const alpm_list_t *rhs, alpm_list_fn_cmp fn)
Find the items in list lhs that are not present in list rhs.
void * alpm_list_to_array (const alpm_list_t *list, size_t n, size_t size)
Copy a list and data into a standard C array of fixed length. Detailed Description
Function Documentation
alpm_list_t* alpm_list_add (alpm_list_t * list, void * data)
data the new item to be added to the listalpm_list_t* alpm_list_add_sorted (alpm_list_t * list, void * data, alpm_list_fn_cmp fn)
data the new item to be added to the list
fn the comparison function to use to determine orderalpm_list_t* alpm_list_append (alpm_list_t ** list, void * data)
data the new item to be added to the listalpm_list_t* alpm_list_copy (const alpm_list_t * list)
alpm_list_t* alpm_list_copy_data (const alpm_list_t * list, size_t size)
size the size of each data elementsize_t alpm_list_count (const alpm_list_t * list)
alpm_list_t* alpm_list_diff (const alpm_list_t * lhs, const alpm_list_t * rhs, alpm_list_fn_cmp fn)
lhs that are not present in list rhs.
rhs the second list
fn the comparison functionlhs not present in rhsvoid alpm_list_diff_sorted (const alpm_list_t * left, const alpm_list_t * right, alpm_list_fn_cmp fn, alpm_list_t ** onlyleft, alpm_list_t ** onlyright)
left and list right The two lists must be sorted. Items only in list left are added to the onlyleft list. Items only in list right are added to the onlyright list.
right the second list
fn the comparison function
onlyleft pointer to the first result list
onlyright pointer to the second result list void* alpm_list_find (const alpm_list_t * haystack, const void * needle, alpm_list_fn_cmp fn)
haystack the list
fn the comparison function for searching (!= NULL)needle if found, NULL otherwise void* alpm_list_find_ptr (const alpm_list_t * haystack, const void * needle)
needle.
haystack the listneedle if found, NULL otherwise char* alpm_list_find_str (const alpm_list_t * haystack, const char * needle)
haystack the listneedle if found, NULL otherwise void alpm_list_free (alpm_list_t * list)
void alpm_list_free_inner (alpm_list_t * list, alpm_list_fn_free fn)
fn a free function for the internal data alpm_list_t* alpm_list_join (alpm_list_t * first, alpm_list_t * second)
second the second listalpm_list_t* alpm_list_last (const alpm_list_t * list)
alpm_list_t* alpm_list_mmerge (alpm_list_t * left, alpm_list_t * right, alpm_list_fn_cmp fn)
right the second list
fn comparison function for determining merge orderalpm_list_t* alpm_list_msort (alpm_list_t * list, size_t n, alpm_list_fn_cmp fn)
n using mergesort algorithm.
n the size of the list
fn the comparison function for determining orderalpm_list_t* alpm_list_next (const alpm_list_t * node) [inline]
alpm_list_t* alpm_list_nth (const alpm_list_t * list, size_t n)
n the index of the item to find (n < alpm_list_count(list) IS needed)nalpm_list_t* alpm_list_previous (const alpm_list_t * list) [inline]
alpm_list_t* alpm_list_remove (alpm_list_t * haystack, const void * needle, alpm_list_fn_cmp fn, void ** data)
needle the data member of the item we're removing
fn the comparison function for searching
data output parameter containing data of the removed itemalpm_list_t* alpm_list_remove_dupes (const alpm_list_t * list)
alpm_list_t* alpm_list_remove_item (alpm_list_t * haystack, alpm_list_t * item)
item the item to remove from the listalpm_list_t* alpm_list_remove_str (alpm_list_t * haystack, const char * needle, char ** data)
needle the data member of the item we're removing
data output parameter containing data of the removed itemalpm_list_t* alpm_list_reverse (alpm_list_t * list)
alpm_list_t* alpm_list_strdup (const alpm_list_t * list)
void* alpm_list_to_array (const alpm_list_t * list, size_t n, size_t size)
n the size of the list
size the size of each data elementAuthor
Info