output_buffer.h

Go to the documentation of this file.

#pragma once
 
#include <stdio.h>
#include <string.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "util/number.h" // For digits_u32()
 
/* ============================================================================
 * Data Structures
 * ============================================================================
 */
 
typedef struct {
  char *buf;  
  size_t len; 
  size_t cap; 
} outbuf_t;
 
/* ============================================================================
 * Buffer Management Functions
 * @{
 */
 
void ob_reserve(outbuf_t *ob, size_t need);
 
void ob_putc(outbuf_t *ob, char c);
 
void ob_write(outbuf_t *ob, const char *s, size_t n);
 
void ob_term(outbuf_t *ob);
 
/* ============================================================================
 * Integer Formatting Functions
 * @{
 */
 
void ob_u8(outbuf_t *ob, uint8_t v);
 
void ob_u32(outbuf_t *ob, uint32_t v);
 
/* ============================================================================
 * ANSI Escape Sequence Emission Functions
 * @{
 */
 
void emit_set_truecolor_fg(outbuf_t *ob, uint8_t r, uint8_t g, uint8_t b);
 
void emit_set_truecolor_bg(outbuf_t *ob, uint8_t r, uint8_t g, uint8_t b);
 
void emit_set_256_color_fg(outbuf_t *ob, uint8_t color_idx);
 
void emit_set_256_color_bg(outbuf_t *ob, uint8_t color_idx);
 
void emit_reset(outbuf_t *ob);
 
/* ============================================================================
 * Run-Length Encoding (RLE) Functions
 * @{
 */
 
bool rep_is_profitable(uint32_t runlen);
 
void emit_rep(outbuf_t *ob, uint32_t extra);
 
/* ============================================================================
 * Auto-Select Color Mode Functions
 * @{
 */
 
void emit_set_fg(outbuf_t *ob, uint8_t r, uint8_t g, uint8_t b);
 
void emit_set_bg(outbuf_t *ob, uint8_t r, uint8_t g, uint8_t b);
 
/* ============================================================================
 * Utility Functions
 * ============================================================================
 */
 
/* digits_u32() is now in util/number.h - include above for access */