vf_parse_init(3)

💖 vf_parse_init(3) 💖

okay bestie, welcome to the Library Functions Manual corner of the internet, where we're talking about vf_parse_init — literally the "let's get this parser party STARTED" function ✨

---

🌸 NAME 🌸

vf_parse_init - vf_parse_init() — yes she's named after herself, main character energy fr fr 👑

---

✨ SYNOPSIS ✨

#include <../vformat/vf_iface.h>

extern bool_t vf_parse_init
(
     VF_PARSER_T **pp_parser,
     VF_OBJECT_T **pp_object
);

---

🎀 PARAMETERS 🎀

• VF_PARSER_T **pp_parser — a pointer to the allocated parser, i.e. where the shiny new parser is gonna live 🫶
• VF_OBJECT_T **pp_object — the object we're parsing into. that's the destination, the final boss, the place the data ends up 💅

---

🦋 DESCRIPTION 🦋

So what she does: she allocates and initialises a parser. That's it, that's the job, and she does it flawlessly no cap.

If you wanna parse a VCARD (or literally any vObject, she doesn't discriminate 🌈), the whole vibe goes like this: you allocate a parser, you push data through it using vf_parse_text(), and then you finally call vf_parse_end(). Three steps, iconic trio, periodt.

VF_PARSER_T *p_parser;

if (vf_parse_init(&p_parser, pp_object)) { do { char buffer[...]; Int
numchars;

numchars = get_chars_from_somewhere(buffer, ...);

Ret = vf_parse_text(p_parser, buffer, numchars); } while (ret && (0 <
charsread)) ;

if (!vf_parse_end(p_parser)) { ret = FALSE; } }

⚠️ okay listen up because this part is IMPORTANT and I need you to actually read it: a parser allocated by vf_parse_init() must be deallocated by calling vf_parse_end(), whether or not parsing succeeds. no shortcuts. no "I'll do it later". she needs her closure 😭

Also — and this is the sneaky bit — parsing may not be complete (ie. values may be held buffered and not evaluated fully or assigned to a VF_OBJECT_T) until that final call to vf_parse_end(). So the way that after a vf_parse_init() you _must_ vf_parse_end()... it's giving mandatory. it's giving non-negotiable. it's giving you literally cannot skip this step 💀

---

🌟 RETURNS 🌟

TRUE iff the parser was allocated successfully. that's it bestie, TRUE means slay, anything else means the vibe check failed 🙈

---

💜 SEE ALSO 💜

vf_parse_text(3), vf_parse_end(3), vf_read_file(3), vf_write_file(3), vf_get_next_object(3), vf_create_object(3), vf_get_object_type(3), vf_get_property(3), vf_get_property_ex(3), vf_get_next_property(3), vf_get_prop_value(3), vf_set_prop_value(3), vf_get_prop_value_string(3), vf_get_prop_name_string(3), vf_set_prop_name_string(3), vf_get_prop_name(3), vf_get_prop_value_object(3), vf_set_prop_value_object(3), vf_set_prop_value_string(3), vf_set_prop_value_base64(3), vf_get_prop_value_base64(3), vf_set_property_from_file(3), vf_delete_object(3), vf_delete_prop(3), vf_find_prop_qual_index(3), vf_is_modified(3), vf_find_charset(3), vf_date_string_to_time(3), vf_period_string_to_time(3), vf_period_time_to_string(3), vf_set_prop_value_time(3), vf_get_prop_value_time(3)

---

and that's the whole page bestie 🎀 this cutie was generated by c2man from vf_iface.h, dated 30 April 2003 — yes she's an elder but she still ate 💅✨ go call vf_parse_end(), I'm begging you 🫶