libalpm_list(3)

📦
version 7.1.0.r9.g54d9411 · 4 versions
, in arch rolling, fedora 44

✨ NAME ✨

libalpm_list — libalpm_list(3), no cap. 💅

🌸 SYNOPSIS 🌸

Okay bestie, here's the whole cast of characters. No cap, every single signature is here. 💖

🎀 Data Structures 🎀

  • struct alpm_list_t — a doubly linked list. She's connected both ways, iykyk. 🔗

🦋 Macros 🦋

  • #define FREELIST(p) — frees a list and its contents. Cleanup queen. 🧹

💖 Typedefs 💖

  • typedef void(* alpm_list_fn_free) (void *item) — item deallocation callback. Say bye to an item. 👋
  • typedef int(* alpm_list_fn_cmp) (const void *, const void *) — item comparison callback. Compare girlies. ⚖️

👑 Functions 👑

Now the main event, bestie. Every function, every signature, exactly as she is. ✨

  • void alpm_list_free (alpm_list_t *list) — free a list, but not the contained data. The list dips, the data stays. 💅
  • void alpm_list_free_inner (alpm_list_t *list, alpm_list_fn_free fn) — free the internal data of a list structure but not the list itself. Contents gone, skeleton remains. 🦴
  • alpm_list_t * alpm_list_add (alpm_list_t *list, void *data) — add a new item to the end of the list. Append era. 🍓
  • alpm_list_t * alpm_list_append (alpm_list_t **list, void *data) — add a new item to the end of the list. Same energy, different pointer-to-pointer signature. 💫
  • alpm_list_t * alpm_list_append_strdup (alpm_list_t **list, const char *data) — duplicate and append a string to a list. Copy queen behavior. 👑
  • 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. Order is the moment. 📏
  • alpm_list_t * alpm_list_join (alpm_list_t *first, alpm_list_t *second) — join two lists. Union vibes. 🤝
  • 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. Merge sort core, bestie. 🧬
  • 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. Algorithmically iconic. 🧠
  • alpm_list_t * alpm_list_remove_item (alpm_list_t *haystack, alpm_list_t *item) — remove an item from the list. Bye bye. 🗑️
  • 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. Needle, fn, and data out-param, iykyk. 🎯
  • alpm_list_t * alpm_list_remove_str (alpm_list_t *haystack, const char *needle, char **data) — remove a string from a list. String removal slay. ✂️
  • alpm_list_t * alpm_list_remove_dupes (const alpm_list_t *list) — create a new list without any duplicates. Dedupe queen. 🧼
  • alpm_list_t * alpm_list_strdup (const alpm_list_t *list) — copy a string list, including data. Copy the whole vibe, data included. 💖
  • alpm_list_t * alpm_list_copy (const alpm_list_t *list) — copy a list, without copying data. She's not duplicating the contents. 🪞
  • alpm_list_t * alpm_list_copy_data (const alpm_list_t *list, size_t size) — copy a list and copy the data. She's duplicating everything. 🧚
  • alpm_list_t * alpm_list_reverse (alpm_list_t *list) — create a new list in reverse order. Backwards but make it fashion. 🔄
  • alpm_list_t * alpm_list_nth (const alpm_list_t *list, size_t n) — return nth element from list (starting from 0). Zero-indexed, as she should. 0️⃣
  • alpm_list_t * alpm_list_next (const alpm_list_t *list) — get the next element of a list. Next up. ➡️
  • alpm_list_t * alpm_list_previous (const alpm_list_t *list) — get the previous element of a list. Rewind. ⬅️
  • alpm_list_t * alpm_list_last (const alpm_list_t *list) — get the last item in the list. Final boss. 🏁
  • size_t alpm_list_count (const alpm_list_t *list) — get the number of items in a list. Count her. 🔢
  • void * alpm_list_find (const alpm_list_t *haystack, const void *needle, alpm_list_fn_cmp fn) — find an item in a list. Search era. 🔍
  • void * alpm_list_find_ptr (const alpm_list_t *haystack, const void *needle) — find an item in a list. Pointer edition. 📍
  • char * alpm_list_find_str (const alpm_list_t *haystack, const char *needle) — find a string in a list. String search, bestie. 🔎
  • int alpm_list_cmp_unsorted (const alpm_list_t *left, const alpm_list_t *right, alpm_list_fn_cmp fn) — check if two lists contain the same data, ignoring order. Order is not the moment. 🌀
  • 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. Diff era, but sorted. 🧮
  • 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. Left has, right doesn't. 🕵️
  • 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. C array glow-up. 📦

💫 Detailed Description 💫

Okay so, these are the functions to manipulate alpm_list_t lists. Literally the whole point. 💅

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. So she's internal but also out here, iykyk. ✨

It is exposed so front ends can use it to prevent the need to reimplement lists of their own; however, it is not required that the front end uses it. No pressure, bestie. 🫶

🦋 Data Structure Documentation 🦋

🌸 struct alpm_list_t 🌸

A doubly linked list. She's linked both ways, no cap. 🔗

Data Fields:

  • void * data — data held by the list node. Her contents. 💖
  • struct _alpm_list_t * next — pointer to the next node. Forward. ➡️
  • struct _alpm_list_t * prev — pointer to the previous node. Backward. ⬅️

💅 Macro Definition Documentation 💅

🎀 #define FREELIST( p) 🎀

Value:

do { alpm_list_free_inner(p, free); alpm_list_free(p); p = NULL; } while(0)

Frees a list and its contents. Cleanup, cleanup, everybody everywhere. 🧹✨

🧚 Typedef Documentation 🧚

⚖️ typedef int(* alpm_list_fn_cmp) (const void *, const void *) ⚖️

Item comparison callback. Compare girlies. 💅

👋 typedef void(* alpm_list_fn_free) (void *item) 👋

Item deallocation callback. Say bye to an item. 🫶

Parameters

  • item — the item to free. She's leaving the chat. 💀

✨ Function Documentation ✨

okay so these are the functions, and yes, we're doing every single one. no skips, no cap. let's get into it 💅

🌸 alpm_list_t * alpm_list_add (alpm_list_t * list, void * data) 🌸

Adds a brand-new item to the end of the list. it's giving "the list said yes to plus-one energy."

Parameters

  • list — the list to add to
  • data — the new item to be added to the list

Returns

  • the resultant list

🌸 alpm_list_t * alpm_list_add_sorted (alpm_list_t * list, void * data, alpm_list_fn_cmp fn) 🌸

Adds items to a list in sorted order. no chaos, just order, bestie.

Parameters

  • list — the list to add to
  • data — the new item to be added to the list
  • fn — the comparison function to use to determine order

Returns

  • the resultant list

🌸 alpm_list_t * alpm_list_append (alpm_list_t ** list, void * data) 🌸

Adds a new item to the end of the list. this one is lowkey different from alpm_list_add because it hands you back the newly added item, not the whole list. main character energy for real.

Parameters

  • list — the list to add to
  • data — the new item to be added to the list

Returns

  • the newly added item

🌸 alpm_list_t * alpm_list_append_strdup (alpm_list_t ** list, const char * data) 🌸

Duplicates a string and appends it to a list. it's giving "copy then attach, no cap."

Parameters

  • list — the list to append to
  • data — the string to duplicate and append

Returns

  • the newly added item

🌸 int alpm_list_cmp_unsorted (const alpm_list_t * left, const alpm_list_t * right, alpm_list_fn_cmp fn) 🌸

Checks if two lists contain the same data, ignoring order. Lists are considered equal if they both contain the same data regardless of order. so order is not the vibe here, just the contents.

Parameters

  • left — the first list
  • right — the second list
  • fn — the comparison function

Returns

  • 1 if the lists are equal, 0 if not equal, -1 on error. periodt.

🌸 alpm_list_t * alpm_list_copy (const alpm_list_t * list) 🌸

Copies a list, without copying data. so the list structure is duplicated, but the data itself is not. iykyk.

Parameters

  • list — the list to copy

Returns

  • a copy of the original list

🌸 alpm_list_t * alpm_list_copy_data (const alpm_list_t * list, size_t size) 🌸

Copies a list and copies the data. note that the data elements to be copied should not contain pointers and should also be of constant size. so if your data is pointer-y or variable-size, this is not the one, bestie.

Parameters

  • list — the list to copy
  • size — the size of each data element

Returns

  • a copy of the original list, data copied as well

🌸 size_t alpm_list_count (const alpm_list_t * list) 🌸

Gets the number of items in a list. it's the vibe check for how many besties are in the list.

Parameters

  • list — the list

Returns

  • the number of list items

🌸 alpm_list_t * alpm_list_diff (const alpm_list_t * lhs, const alpm_list_t * rhs, alpm_list_fn_cmp fn) 🌸

Finds the items in list lhs that are not present in list rhs. it's giving "what's in left but not right," periodt.

Parameters

  • lhs — the first list
  • rhs — the second list
  • fn — the comparison function

Returns

  • a list containing all items in lhs not present in rhs

🌸 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) 🌸

Finds the differences between list 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. so sorted vibes only, no cap.

Parameters

  • left — the first 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) 🌸

Finds an item in a list. it's the classic haystack-and-needle situation, but make it C.

Parameters

  • needle — the item to search
  • haystack — the list
  • fn — the comparison function for searching (!= NULL)

Returns

  • needle if found, NULL otherwise

🌸 void * alpm_list_find_ptr (const alpm_list_t * haystack, const void * needle) 🌸

Finds an item in a list. searches for the item whose data matches that of the needle. it's an == comparison situation.

Parameters

  • needle — the data to search for (== comparison)
  • haystack — the list

Returns

  • needle if found, NULL otherwise

🌸 char * alpm_list_find_str (const alpm_list_t * haystack, const char * needle) 🌸

Finds a string in a list. string search but make it alpm.

Parameters

  • needle — the string to search for
  • haystack — the list

Returns

  • needle if found, NULL otherwise

🌸 void alpm_list_free (alpm_list_t * list) 🌸

Frees a list, but not the contained data. so the list says bye, but the data is still there. don't @ me.

Parameters

  • list — the list to free

🌸 void alpm_list_free_inner (alpm_list_t * list, alpm_list_fn_free fn) 🌸

Frees the internal data of a list structure but not the list itself. so it's the inner cleanup, not the whole breakup.

Parameters

  • list — the list to free
  • fn — a free function for the internal data

🌸 alpm_list_t * alpm_list_join (alpm_list_t * first, alpm_list_t * second) 🌸

Joins 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. so like, they're married now, don't try to date them separately, bestie. 💀

Parameters

  • first — the first list
  • second — the second list

Returns

  • the resultant joined list

🌸 alpm_list_t * alpm_list_last (const alpm_list_t * list) 🌸

Gets the last item in the list. it's the final boss of the list.

Parameters

  • list — the list

Returns

  • the last element in the list

🌸 alpm_list_t * alpm_list_mmerge (alpm_list_t * left, alpm_list_t * right, alpm_list_fn_cmp fn) 🌸

Merges the two sorted sublists into one sorted list. it's giving merge energy, sorted and iconic.

Parameters

  • left — the first list
  • right — the second list
  • fn — comparison function for determining merge order

Returns

  • the resultant list

🌸 alpm_list_t * alpm_list_msort (alpm_list_t * list, size_t n, alpm_list_fn_cmp fn) 🌸

Sorts a list of size n using the mergesort algorithm. no cap, mergesort is the moment.

Parameters

  • list — the list to sort
  • n — the size of the list
  • fn — the comparison function for determining order

Returns

  • the resultant list

🌸 alpm_list_t * alpm_list_next (const alpm_list_t * list) 🌸

Gets the next element of a list. it's the "who's next" of list nodes.

Parameters

  • list — the list node

Returns

  • the next element, or NULL when no more elements exist

🌸 alpm_list_t * alpm_list_nth (const alpm_list_t * list, size_t n) 🌸

Returns the nth element from list (starting from 0). note: n < alpm_list_count(list) IS needed. so check your index, bestie, or it's not gonna work.

Parameters

  • list — the list
  • n — the index of the item to find (n < alpm_list_count(list) IS needed)

Returns

  • an alpm_list_t node for index n

🌸 alpm_list_t * alpm_list_previous (const alpm_list_t * list) 🌸

Gets the previous element of a list. it's the "look back" energy.

Parameters

  • list — the list head

Returns

  • the previous element, or NULL when no previous element exist

🌸 alpm_list_t * alpm_list_remove (alpm_list_t * haystack, const void * needle, alpm_list_fn_cmp fn, void ** data) 🌸

Removes an item from the list. it's giving "bye, bestie" to one item.

Parameters

  • haystack — the list to remove the item from
  • needle — the data member of the item we're removing
  • fn — the comparison function for searching
  • data — output parameter containing data of the removed item

Returns

  • the resultant list

🌸 alpm_list_t * alpm_list_remove_dupes (const alpm_list_t * list) 🌸

Creates a new list without any duplicates. this does NOT copy data members. so it's a fresh list, but the data is still the same data. no cap.

Parameters

  • list — the list to copy

Returns

  • a new list containing non-duplicate items

🌸 alpm_list_t * alpm_list_remove_item (alpm_list_t * haystack, alpm_list_t * item) 🌸

Removes an item from the list. item is not freed; this is the responsibility of the caller. so you gotta clean up after yourself, bestie. don't leave that memory hanging.

Parameters

  • haystack — the list to remove the item from
  • item — the item to remove from the list

Returns

  • the resultant list

🌸 alpm_list_t * alpm_list_remove_str (alpm_list_t * haystack, const char * needle, char ** data) 🌸

Removes a string from a list. string removal, but make it alpm.

Parameters

  • haystack — the list to remove the item from
  • needle — the data member of the item we're removing
  • data — output parameter containing data of the removed item

Returns

  • the resultant list

🌸 alpm_list_t * alpm_list_reverse (alpm_list_t * list) 🌸

Creates a new list in reverse order. it's giving "backwards but make it fashion."

Parameters

  • list — the list to copy

Returns

  • a new list in reverse order

🌸 alpm_list_t * alpm_list_strdup (const alpm_list_t * list) 🌸

Copies a string list, including data. so strings get duplicated too. periodt.

Parameters

  • list — the list to copy

Returns

  • a copy of the original list

🌸 void * alpm_list_to_array (const alpm_list_t * list, size_t n, size_t size) 🌸

Copies 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. so be careful with pointers, bestie, they're not cloned.

Parameters

  • list — the list to copy
  • n — the size of the list
  • size — the size of each data element

Returns

  • an array version of the original list, data copied as well

✨ Author ✨

Generated automatically by Doxygen for libalpm from the source code.

💖 so that's the whole function documentation, bestie. source/version: libalpm · page: libalpm_list(3) · date: not shown in this footer, but the vibe is forever. mwah 💋

📦 where this page comes from