record(3)

🎀 record(3) — the Recorder Library, bestie edition 🎀

okay so you found yourself in the record(3) zone of the Recorder Library and honestly? iconic. this page is all about the three lil config functions that let you tell the recorder where to write stuff, how to write stuff, and how to make it look cute. sit down, grab a boba, we're doing this. 💖

The three stars of the show are record_configure_output, record_configure_show, and record_configure_format. Say hi. 👋

---

✨ NAME ✨

• record_configure_output — configures the recorder output
• record_configure_show — configures the recorder output function
• record_configure_format — configures recorder event formatting

---

🌈 SYNOPSIS 🌈

#include <recorder/recorder.h>

typedef unsigned (*recorder_show_fn) (const char *text,
                                      size_tlen,
                                      void *output);
typedef void (*recorder_format_fn)(recorder_show_fn show,
                                   void *output,
                                   const char * label,
                                   const char *location,
                                   uintptr_torder,
                                   uintptr_ttimestamp,
                                   const char *message);

void *recorder_configure_output(void *output);
recorder_show_fn   recorder_configure_show(recorder_show_fnshow);
recorder_format_fn recorder_configure_format(recorder_format_fnformat);

no cap, that's the whole cast. 🫶

---

💅 DESCRIPTION 💅

recorder_configure_output() — where do the words go

this one sets the output for the recorder's output function. here's the tea: the default output function just assumes that output is a FILE *, and if you pass NULL it falls back to stderr. classic. 🍓

and because recorder tracing is often a debugging thing — like, you're in the trenches, bestie — it might be a genuinely good idea to make that output non-buffered, like this:

setvbuf(output,NULL,_IONBF,0);

so it hits the screen immediately instead of ghosting you until the buffer decides to flush. 😭

recorder_configure_show() — who does the writing

this sets the output function for the recorder. and the way that works is: this output function receives the output value that you already defined with recorder_configure_output. they're a duo, they're a package deal, main character energy for both. 👑

recorder_configure_format() — how it looks

this one sets the event record formatting function. that's it, that's the vibe. ✨

---

⭐ RETURN VALUE ⭐

all three of them hand you back the previously configured value. so like, they're giving you receipts. keep them if you ever wanna restore the old setup. 💜

---

💀 BUGS 💀

found a bug? do NOT suffer in silence, bestie. report it here:

https://github.com/c3d/recorder/issues

we love a good bug report. 🌸

---

👀 SEE ALSO 👀

• record(3), record_fast(3)
• RECORDER_DEFINE(3), RECORDER_DECLARE(3)
• recorder_trace_set(3) RECORDER_TRACE(3)
• recorder_dump(3), recorder_dump_for(3)

and if you want additional documentation and tutorials, they live right here:

https://github.com/c3d/recorder

iykyk. go read them. 🔥

---

🧚 AUTHOR 🧚

Written by Christophe de Dinechin. king behavior fr fr. 👑

---

okay that's the whole page, you ate that. 💅✨ this was version 1.0, dated 2019-03-09, and yes it's the record(3) page from the Recorder Library — mwah, bye bestie! 🦋💖🌈