writer.h File Reference

Write ANSI ASCII frames to file descriptor. More...

Go to the source code of this file.

Functions
asciichat_error_t	terminal_fd_writer_create (int fd, terminal_fd_writer_t **out)
	Create a terminal FD writer to a file descriptor.
asciichat_error_t	terminal_fd_writer_write (terminal_fd_writer_t *writer, const char *frame)
	Write a frame to the file descriptor.
void	terminal_fd_writer_destroy (terminal_fd_writer_t *writer)
	Destroy terminal FD writer.

Detailed Description

Write ANSI ASCII frames to file descriptor.

Writes ASCII frames with ANSI color codes to any file descriptor (stdout, file, pipe). Supports batching frames with proper newline handling.

Author

Zachary Fogg me@zf.nosp@m.o.gg

Date

March 2026

Definition in file writer.h.

Function Documentation

terminal_fd_writer_create()

asciichat_error_t terminal_fd_writer_create	(	int	fd,
		terminal_fd_writer_t **	out )

Create a terminal FD writer to a file descriptor.

Parameters

fd	File descriptor to write to (e.g., STDOUT_FILENO, open file)
out	Pointer to store writer context

Returns

ASCIICHAT_OK on success

Definition at line 25 of file writer.c.

                                                                                {
  if (fd < 0 || !out) {
    return SET_ERRNO(ERROR_INVALID_PARAM, "Invalid writer parameters: fd=%d, output=%p", fd, (void *)out);
  }
 
  FILE *fp = platform_fdopen("terminal_fd_writer", fd, "w");
  if (!fp) {
    return SET_ERRNO_SYS(ERROR_INVALID_PARAM, "fdopen failed for FD %d", fd);
  }
 
  terminal_fd_writer_t *writer = SAFE_CALLOC(1, sizeof(*writer), terminal_fd_writer_t *);
  writer->fp = fp;
 
  log_debug("created with fd=%d", fd);
  *out = writer;
  return ASCIICHAT_OK;
}

References ASCIICHAT_OK, ERROR_INVALID_PARAM, terminal_fd_writer_s::fp, log_debug, out, SAFE_CALLOC, SET_ERRNO, and SET_ERRNO_SYS.

terminal_fd_writer_destroy()

void terminal_fd_writer_destroy

(

terminal_fd_writer_t *

writer

)

Destroy terminal FD writer.

Parameters

writer

Writer context to destroy

Definition at line 64 of file writer.c.

                                                              {
  if (!writer)
    return;
  if (writer->fp) {
    fclose(writer->fp);
    writer->fp = NULL;
  }
  SAFE_FREE(writer);
}

References terminal_fd_writer_s::fp, and SAFE_FREE.

terminal_fd_writer_write()

asciichat_error_t terminal_fd_writer_write	(	terminal_fd_writer_t *	writer,
		const char *	frame )

Write a frame to the file descriptor.

Writes the frame data followed by a newline. Frame should contain ANSI-colored ASCII art, typically from rendering output.

Parameters

writer	Writer context
frame	Frame data to write (NULL is no-op)

Returns

ASCIICHAT_OK on success

Definition at line 43 of file writer.c.

                                                                                            {
  if (!writer) {
    return SET_ERRNO(ERROR_INVALID_PARAM, "Invalid writer context");
  }
 
  if (!frame) {
    return ASCIICHAT_OK; // No-op for NULL frame
  }
 
  // Write frame and newline
  asciichat_error_t err = stdout_writer_write(writer->fp, frame, strlen(frame));
  if (err != ASCIICHAT_OK)
    return err;
  err = stdout_writer_write(writer->fp, "\n", 1);
  if (err != ASCIICHAT_OK)
    return err;
 
  log_debug_every(NS_PER_SEC_INT, "wrote frame (%zu bytes)", strlen(frame));
  return ASCIICHAT_OK;
}

References ASCIICHAT_OK, ERROR_INVALID_PARAM, terminal_fd_writer_s::fp, log_debug_every, NS_PER_SEC_INT, SET_ERRNO, and stdout_writer_write().