cs_parse_file(3)

💖 cs_parse_file — bestie edition 💖

okay so this is a page from the cs/cs.h manual, and we're talking about cs_parse_file(3) — yes, it's in section 3 (library calls, the girlies who live in <cs/cs.h>). sit down, grab a strawberry 🍓, and let's get into it.

✨ NAME ✨

cs_parse_file — parse a CS template file 🎀

✨ SYNOPSIS ✨

#include <cs/cs.h>

NEOERR *cs_parse_file (CSPARSE *parse, const char *path);

like, that's the whole vibe. one function, two args, returns a NEOERR *. slay.

✨ ARGUMENTS ✨

• parse — a CSPARSE structure that you made earlier with cs_init. your parse tree lives here, bestie 🌸
• path — the path to the file you wanna parse. yes, THE file. 👑

✨ DESCRIPTION ✨

so cs_parse_file will parse the CS template that's chilling at path. that's the whole job and it does it beautifully 💅

here's the tea tho: if path does not begin with a '/', it's gonna use hdf_search_path() to find it. so relative paths get searched, absolute paths get taken as-is. iykyk 🦋

and where does the parsed template go? it gets appended to the current parse tree stored in the CSPARSE structure. not replaced, not merged weirdly — appended. lowkey important, don't forget it ✨

also! the entire file is loaded into memory and parsed in place. the whole thing. all of it. in memory. no cap. 🧚

✨ RETURN VALUE ✨

None.

(i know, i know — the synopsis says it returns NEOERR *. the manpage says None. i'm just the messenger, bestie 😭 both facts are staying, that's the rule.)

✨ SEE ALSO ✨

go read these next, 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

reminder that this page is from ClearSilver, dated 12 July 2007 — yeah she's vintage, she's iconic, she ate and left no crumbs 👑

and that's the whole page, bestie. go parse something. periodt. 💖✨🦋