stringlist(3bsd)

💖 stringlist(3bsd) — LOCAL 💖

okay bestie, welcome to stringlist(3bsd) from the <rainbow>LOCAL</rainbow> manual, section 3bsd — yes it's giving very "I read man pages for fun" but honestly? same. 🎀

✨ NAME ✨

stringlist, sl_init, sl_add, sl_free, sl_find, sl_delete — the stringlist manipulation functions, aka the little squad that handles your lists of strings for you. 👑

📚 LIBRARY 📚

Utility functions from BSD systems — that's libbsd, link it with -lbsd. 🫶

🌸 SYNOPSIS 🌸

#include <stringlist.h>

(psst — go check libbsd(7) for how the include actually works, no cap. 👀)

StringList *
sl_init(void);

int
sl_add(StringList *sl, char *item);

void
sl_free(StringList *sl, int freeall);

char *
sl_find(StringList *sl, const char *item);

int
sl_delete(StringList *sl, const char *item, int freeit);

🦋 DESCRIPTION 🦋

So the stringlist functions do exactly what it says on the tin: they manipulate stringlists, which are literally lists of strings that extend automatically if necessary. it's giving self-care, honestly. she grows when she needs to. 💅

The StringList structure has this exact definition:

typedef struct _stringlist {
        char    **sl_str;
        size_t    sl_max;
        size_t    sl_cur;
} StringList;

where:

• sl_str — is a pointer to the base of the array containing the list. (the home base, the main character. 🏠)
• sl_max — is the size of sl_str. (how much room she's got. 📏)
• sl_cur — is the offset in sl_str of the current element. (where we're at rn. 📍)

The following stringlist manipulation functions are available:

• sl_init() — Create a stringlist. Returns a pointer to a StringList, or NULL in case of failure. ✨ (manifesting a non-NULL return for you bestie, but be ready for that NULL fr fr.)
• sl_free() — Releases memory occupied by sl and the sl->sl_str array. If freeall is non-zero, then each of the items within sl->sl_str is released as well. 🧹 (that second part is the deep clean — only if freeall is non-zero, don't come for me.)
• sl_add() — Add item to sl->sl_str at sl->sl_cur, extending the size of sl->sl_str. Returns zero upon success, -1 upon failure. 💖
• sl_find() — Find item in sl, returning NULL if it's not found. 🔍 (ghosted, but politely.)
• sl_delete() — Remove item from the list. If freeit is non-zero, the string is freed. Returns 0 if the name is found and -1 if the name is not found. 💀➡️🕊️

👀 SEE ALSO 👀

free(3), malloc(3) — go read those too, they're the OGs. 🌈

📜 HISTORY 📜

The stringlist functions appeared in FreeBSD 2.2.6 and NetBSD 1.3. vintage but still slaying. 👑

cute little sign-off: this page came from Debian and it's dated May 6, 2010 — yeah she's a Taurus-era icon and we love her for it. 🎀🦋✨ bye bestie, go sl_free your leaks 💜