globus_list.h(3)

✨ globus_list.h ✨

okay so bestie, welcome to globus_list.h — the Linked List header from globus_common 💖 this is a <pink>Library Functions Manual</pink> situation, and we're about to get so cozy with linked lists.

---

🌸 NAME 🌸

globus_list.h — Linked List. yes, that's it, that's the whole name. short, sweet, iconic 👑

---

🎀 SYNOPSIS 🎀

🦋 Data Structures 🦋

• struct globus_list — List data type. the moment. the blueprint. the main character 💅

🌈 Typedefs 🌈

• typedef struct globus_list globus_list_t — List data type. it's giving "we made a cute little alias so you don't have to type struct every single time" 🫶
• typedef int(* globus_list_pred_t) (void *datum, void *arg) — List search predicate. a function pointer that takes a void *datum and a void *arg and hands you back an int. iykyk 💖
• typedef int(* globus_list_relation_t) (void *low_datum, void *high_datum, void *relation_arg) — Relation predicate. same energy, but it takes void *low_datum, void *high_datum, and void *relation_arg, and returns an int. lowkey the backbone of all the sorting stuff below 🔥

⭐ Functions ⭐

• int globus_list_empty (globus_list_t *head) — List empty predicate. is the list empty or not, bestie? yes/no, that's the whole vibe ✨
• void * globus_list_first (globus_list_t *head) — Retrieve head datum. gimme the first thing in the list 🎀
• globus_list_t * globus_list_rest (globus_list_t *head) — Get the remainder of the list. everything after the first thing. the sequel 🦋
• int globus_list_size (globus_list_t *head) — Get the number of elements in a list. how many besties are in here 💜
• void * globus_list_replace_first (globus_list_t *head, void *datum) — Replace first datum. swap out the head element for datum, no cap 👑
• globus_list_t * globus_list_search (globus_list_t *head, void *datum) — Search a list for a datum. hunting for that one specific datum 🔍
• globus_list_t * globus_list_search_pred (globus_list_t *head, globus_list_pred_t predicate, void *pred_args) — Search a list with a predicate. same hunt, but you bring your own predicate and pred_args 💅
• globus_list_t * globus_list_min (globus_list_t *head, globus_list_relation_t relation, void *relation_args) — Find the minimum value of a list. the smallest one, using your relation and relation_args 🌸
• globus_list_t * globus_list_sort (globus_list_t *head, globus_list_relation_t relation, void *relation_args) — Sort a list. putting it in order, with relation and relation_args doing the deciding ⭐
• int globus_list_insert (globus_list_t *volatile *headp, void *datum) — Insert an item in a list. note the volatile on that headp, bestie — they're not playing 🙈
• globus_list_t * globus_list_cons (void *datum, globus_list_t *list) — List constructor. classic cons, taking a datum and a list 🧚
• globus_list_t * globus_list_copy (globus_list_t *head) — Copy constructor. duplicate the whole thing 💖
• void * globus_list_remove (globus_list_t *volatile *headp, globus_list_t *entry) — Remove a datum from a list. again with the volatile on headp — the thread-safety girlies are thriving here 🔥
• void globus_list_free (globus_list_t *head) — Free a list. release it back into the wild 🕊️

---

💖 Detailed Description 💖

Linked List. that's the whole thing. it's a linked list. it ate. periodt 💅✨

---

👑 Author 👑

Generated automatically by Doxygen for globus_common from the source code. not a human, just a doc generator doing its little thing 🤖💜

---

okay and for the sign-off: this whole thing is globus_common, Version 18.15, and it's the globus_list.h(3) page 🎀 thanks for reading bestie, go build something slay with your linked lists 💖🦋✨