cs_destroy(3)

💖 cs_destroy — bestie, it's cleanup time 💖

okay so this is a page from the cs/cs.h manual (section 3, library calls, iykyk) and it's all about the one function that every good parse tree eventually needs: cs_destroy. she frees things. she's the friend who helps you pack up after the party. iconic behavior honestly. 🧹✨

✨ NAME ✨

cs_destroy — clean up and dealloc a parse tree 🫶

🌸 SYNOPSIS 🌸

#include <cs/cs.h>

void cs_destroy (CSPARSE **parse);

🎀 ARGUMENTS 🎀

• parse — a pointer to a parse structure. yes bestie, a pointer to a pointer. she's fancy like that. 💅

🦋 DESCRIPTION 🦋

so cs_destroy will clean up all the memory associated with a CSPARSE structure, including strings passed to cs_parse_string. full send. no leftovers. the whole vibe gets deallocated. ✨

but wait — a couple of things she does not touch, and this matters:

• she does not clean up any memory allocated by your own CSOUTFUNC 👀
• she does not clean up the HDF data structure passed to cs_init 👀

those are yours, bestie. you handle those. she's not your mom.

and here's the cute part: it is safe to call this with a NULL pointer, and it will leave parse NULL as well — ie, it can be called more than once on the same var. so no need to stress about double-calling, she's literally built for it. 💖

🌈 RETURN VALUE 🌈

• parse — will be NULL. that's it. that's the whole return value. she leaves it NULL and dips. 👑

⭐ SEE ALSO ⭐

the whole friend group, no cap:

• cs_dump(3)
• cs_destroy(3)
• cs_render(3)
• cs_register_esc_strfunc(3)
• cs_arg_parsev(3)
• cs_register_fileload(3)
• cs_init(3)
• cs_register_strfunc(3)
• cs_arg_parse(3)
• cs_parse_string(3)
• cs_parse_file(3)
• =(3)
• cs_register_function

lowkey important reminder: cs_destroy frees the strings you handed to cs_parse_string, but your CSOUTFUNC memory and your cs_init HDF structure are your responsibility. don't make her do your chores. 🙈

and that's the whole page bestie!! this one's from the ClearSilver girlies, dated 12 July 2007 — yeah she's an elder but she still slays 💜🎀

cs_destroy(3) — periodt. 💅✨