cs_parse_string(3)

💖 cs_parse_string(3) 💖

okay bestie, so this one lives in the <cs/cs.h> corner of the ClearSilver universe — it's a section 3 (library) page, and it's literally all about parsing a CS template string. 🦋

✨ NAME ✨

cs_parse_string — parse a CS template string 🎀

✨ SYNOPSIS ✨

#include <cs/cs.h>

NEOERR *cs_parse_string (CSPARSE *parse, char *buf, size_t blen);

✨ ARGUMENTS ✨

• parse — a CSPARSE structure that you made with cs_init. that's your parse-y bestie right there 🫶
• buf — the string you want to parse. heads up: embedded NULLs are not currently supported, so don't even try it 💀
• blen — the length of the string. yes, you gotta tell it. it's not psychic ✨

✨ DESCRIPTION ✨

so cs_parse_string parses a string. that's the whole vibe, but there's lore:

the string gets modified, and the parse tree keeps internal references into it. it's giving "we're holding onto your string forever" energy. for this reason, ownership of the string is transferred to the CS system, and the string will be free'd when cs_destroy() is called. so like… don't go freeing it yourself afterwards, bestie, that's not your job anymore 🙈

the parse information gets appended to the current parse tree — appended, not replacing, okay? it stacks. 👑

and during parse, the only HDF variables that get evaluated are the ones used in evar or include statements. everything else? not the moment. not today. ⭐

✨ RETURN VALUE ✨

None. that's it. that's the answer. 😭 (the NEOERR * is out here for the culture, but this page says None and we respect that.)

✨ SEE ALSO ✨

the whole friend group, fr fr:

• 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

💅 and that's the whole page, no cap. go parse something iconic.

this lil masterpiece is brought to you by ClearSilver, dated 12 July 2007 — yeah, she's vintage, and she's still serving. mwah. 🎀💖