libghostty: C api to stream formatter output through a GhosttyWriter

Add `ghostty_formatter_format` which uses a streaming GhosttyWriter
type to write. Update the example to show this.
This commit is contained in:
Mitchell Hashimoto
2026-08-17 09:33:43 -07:00
parent b97b17f06b
commit 924c8a90de
5 changed files with 165 additions and 12 deletions

View File

@@ -4,6 +4,24 @@
#include <string.h>
#include <ghostty/vt.h>
typedef struct {
FILE *file;
size_t written;
} OutputWriter;
static bool write_output(void *userdata, const uint8_t *data, size_t len) {
OutputWriter *output = userdata;
size_t offset = 0;
while (offset < len) {
size_t written = fwrite(data + offset, 1, len - offset, output->file);
output->written += written;
offset += written;
if (written == 0) return false;
}
return true;
}
int main() {
// Create a terminal with a small grid
GhosttyTerminal terminal;
@@ -14,8 +32,8 @@ int main() {
// cursor movement and styling sequences.
const char *commands[] = {
"Line 1: Hello World!\r\n", // Simple text on row 1
"Line 2: \033[1mBold\033[0m and " // Bold text on row 2
"\033[4mUnderline\033[0m\r\n",
("Line 2: \033[1mBold\033[0m and " // Bold text on row 2
"\033[4mUnderline\033[0m\r\n"),
"Line 3: placeholder\r\n", // Will be overwritten below
"\033[3;1H", // CUP: move cursor back to row 3, col 1
"\033[2K", // EL: erase the entire line
@@ -39,19 +57,16 @@ int main() {
result = ghostty_formatter_terminal_new(NULL, &formatter, terminal, fmt_opts);
assert(result == GHOSTTY_SUCCESS);
// Format into an allocated buffer
uint8_t *buf = NULL;
size_t len = 0;
result = ghostty_formatter_format_alloc(formatter, NULL, &buf, &len);
// Stream the formatted output directly to stdout. The writer retains the
// exact byte count and reports destination errors through its return value.
OutputWriter output = {.file = stdout};
GhosttyWriter writer = {.write = write_output, .userdata = &output};
printf("Formatted output:\n");
result = ghostty_formatter_format(formatter, writer);
assert(result == GHOSTTY_SUCCESS);
// Print the formatted output
printf("Formatted output (%zu bytes):\n", len);
fwrite(buf, 1, len, stdout);
printf("\n");
printf("\n(%zu bytes)\n", output.written);
// Clean up
ghostty_free(NULL, buf, len);
ghostty_formatter_free(formatter);
ghostty_terminal_free(terminal);
return 0;