LOWDOWN_TREE_RNDR(3)

💅 lowdown_tree_rndr — the manual page bestie 💅

okay so real talk, this is LOWDOWN_TREE_RNDR from section 3 of the manual (Library Functions Manual), and it lives in the liblowdown library. she's a little niche but she is iconic for debugging. let's get into it ✨

---

🌸 NAME 🌸

lowdown_tree_rndr — render Markdown into debugging output 🐛✨

---

📚 LIBRARY 📚

library “liblowdown” 🫶

---

✨ SYNOPSIS ✨

#include <sys/queue.h>
#include <stdio.h>
#include <lowdown.h>

int
lowdown_tree_rndr(struct lowdown_buf *out, const struct lowdown_node *n,
    const struct lowdown_opts *opts);

like look at that signature. gorgeous. no notes 💅

---

🦋 DESCRIPTION 🦋

okay so what she does is render a node tree n — and bestie, that tree has to have been made by lowdown_doc_parse(3) or lowdown_diff(3), no bootleg trees allowed 🙅‍♀️ — and the whole thing gets written into out. heads up: out must be initialised and freed by the caller. that's on you, not her. main character energy means knowing your own responsibilities 💖

the output? it's a whole UTF-8 tree 🌳 ngl the format is not standardised and is subject to change, so don't go building your entire personality around parsing it, k? it's giving "just for the vibes, just for debugging."

and here's the tea: unlike every other renderer in the family, lowdown_tree_rndr() accepts no options — so she has no context. literally zero. she's just here to show you the tree. periodt. 🌈

---

👑 RETURN VALUES 👑

• returns zero when it fails to allocate memory 😭 (yes, zero = bad, it's giving chaotic but that's the rule)
• returns non-zero on success ✨ slay

---

🎀 EXAMPLES 🎀

okay bestie here's the whole routine: this parses b of length bsz and outputs the parse tree. copy it exactly, no improvising 🫶

struct lowdown_buf *out;
struct lowdown_doc *doc;
struct lowdown_node *n;
void *rndr;

if ((doc = lowdown_doc_new(NULL)) == NULL)
        err(1, NULL);
if ((n = lowdown_doc_parse(doc, NULL, b, bsz, NULL)) == NULL)
        err(1, NULL);
if ((out = lowdown_buf_new(256)) == NULL)
        err(1, NULL);
if (!lowdown_tree_rndr(out, n))
        err(1, NULL);

fwrite(out->data, 1, out->size, stdout);

lowdown_buf_free(out);
lowdown_node_free(n);
lowdown_doc_free(doc);

see how every single allocation gets checked and every single thing gets freed? that's the vibe check passing with flying colors 💯 don't skip the frees, i'm begging 🙈

---

🔥 SEE ALSO 🔥

• lowdown(3)

iykyk, go read the main page for the whole lore 🌸

---

k bye, this page is from Debian, version $Mdocdate$, and yes the title really is LOWDOWN_TREE_RNDR(3) — go forth and debug ur trees bestie 💖🌳✨