libinn_list(3)

🌸 NAME 🌸

okay so welcome to libinn_list(3), straight outta the InterNetNews documentation 💖 — this is the page for the list routines. The official name vibe is list - list routines, and yes bestie, that’s literally what it says. 🎀

---

✨ SYNOPSIS ✨

           #include <inn/list.h>

           struct node {
               struct node *succ;
               struct node *pred;
           };

           struct list {
               struct node *head;
               struct node *tail;
               struct node *tailpred;
           };

           void list_new(struct list *list);

           struct node *list_addhead(struct list *list, struct node *node);

           struct node *list_addtail(struct list *list, struct node *node);

           struct node *list_head(struct list *list);

           struct node *list_tail(struct list *list);

           struct node *list_succ(struct node *node);

           struct node *list_pred(struct node *node);

           struct node *list_remhead(struct list *list);

           struct node *list_remtail(struct list *list);

           struct node *list_remove(struct node *node);

           struct node *list_insert(struct list *list, struct node *node,
                                    struct node *pred);

           bool list_isempty(struct list *list);

---

💅 DESCRIPTION 💅

okay so here’s the group-chat rundown of what each of these does — no cap, every detail stays. 🫶

• list_new — initialises the list header list so as to create an empty list. Fresh start, clean slate, main character energy. ✨
• list_addhead — adds node to the head of list, returning the node just added. front-of-the-line behavior, honestly. 💅
• list_addtail — adds node to the tail of list, returning the node just added. it’s giving “end of the queue but make it iconic.” 🎀
• list_head — returns a pointer to the node at the head of list or NULL if the list is empty. 💖
• list_tail — returns a pointer to the node at the tail of list or NULL if the list is empty. 🦋
• list_succ — returns the next (successor) node on the list after node or NULL if node was the final node. respectfully, the “what comes next” function. 🌸
• list_pred — returns the previous (predecessor) node on the list before node or NULL if node was the first node. the “look back” function, lowkey. 🌈
• list_remhead — removes the first node from list and returns it to the caller. If the list is empty NULL is returned. bye bestie 👋
• list_remtail — removes the last node from list and returns it to the caller. If the list is empty NULL is returned. last one out, etc. 💀
• list_remove — removes node from the list it is on and returns it to the caller. uninvited from the list, but returned safely. 🫶
• list_insert — inserts node onto list after the node pred. If pred is NULL then node is added to the head of list. insertion drama, but make it organized. ✨

little sidebar bestie: the synopsis declares bool list_isempty(struct list *list);, and the DESCRIPTION genuinely doesn’t give it its own entry. that’s not me skipping it — that’s literally what’s on the page. 💀

---

🦋 HISTORY 🦋

This was written by Alex Kiernan <alex.kiernan@thus.net> for InterNetNews 2.4.0 — iconic origin story, fr fr. 👑

---

and that’s the page, bestie: INN 2.7.4, dated 2023-03-07 — mwah 💋✨