formatter.h

Go to the documentation of this file.

 
#ifndef GHOSTTY_VT_FORMATTER_H
#define GHOSTTY_VT_FORMATTER_H
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <ghostty/vt/allocator.h>
#include <ghostty/vt/selection.h>
#include <ghostty/vt/types.h>
#include <ghostty/vt/terminal.h>
 
#ifdef __cplusplus
extern "C" {
#endif


typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_FORMATTER_FORMAT_PLAIN,

  GHOSTTY_FORMATTER_FORMAT_VT,

  GHOSTTY_FORMATTER_FORMAT_HTML,
  GHOSTTY_FORMATTER_FORMAT_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyFormatterFormat;

typedef struct {
  size_t size;

  bool cursor;

  bool style;

  bool hyperlink;

  bool protection;

  bool kitty_keyboard;

  bool charsets;
} GhosttyFormatterScreenExtra;

typedef struct {
  size_t size;

  bool palette;

  bool modes;

  bool scrolling_region;

  bool tabstops;

  bool pwd;

  bool keyboard;

  GhosttyFormatterScreenExtra screen;
} GhosttyFormatterTerminalExtra;

typedef struct {
  size_t size;

  GhosttyFormatterFormat emit;

  bool unwrap;

  bool trim;

  GhosttyFormatterTerminalExtra extra;

  const GhosttySelection *selection;
} GhosttyFormatterTerminalOptions;

GHOSTTY_API GhosttyResult ghostty_formatter_terminal_new(
    const GhosttyAllocator* allocator,
    GhosttyFormatter* formatter,
    GhosttyTerminal terminal,
    GhosttyFormatterTerminalOptions options);

GHOSTTY_API GhosttyResult ghostty_formatter_format_buf(GhosttyFormatter formatter,
                                           uint8_t* buf,
                                           size_t buf_len,
                                           size_t* out_written);

GHOSTTY_API GhosttyResult ghostty_formatter_format_alloc(GhosttyFormatter formatter,
                                             const GhosttyAllocator* allocator,
                                             uint8_t** out_ptr,
                                             size_t* out_len);

GHOSTTY_API void ghostty_formatter_free(GhosttyFormatter formatter);

 
#ifdef __cplusplus
}
#endif
 
#endif /* GHOSTTY_VT_FORMATTER_H */