GhosttyFormatterTerminalOptions Struct Reference

#include <ghostty/vt/formatter.h>

Data Fields
size_t	size
GhosttyFormatterFormat	emit
bool	unwrap
bool	trim
GhosttyFormatterTerminalExtra	extra
const GhosttySelection *	selection

Detailed Description

Options for creating a terminal formatter.

Examples

c-vt-formatter/src/main.c.

Definition at line 100 of file formatter.h.

Field Documentation

emit

GhosttyFormatterFormat emit

Output format to emit.

Examples

c-vt-formatter/src/main.c.

Definition at line 105 of file formatter.h.

extra

GhosttyFormatterTerminalExtra extra

Extra terminal state to include in styled output.

Definition at line 118 of file formatter.h.

selection

const GhosttySelection* selection

Optional selection to restrict output to a range. If NULL, the entire screen is formatted.

Definition at line 122 of file formatter.h.

size

size_t size

Size of this struct in bytes. Must be set to sizeof(GhosttyFormatterTerminalOptions).

Definition at line 102 of file formatter.h.

trim

bool trim

Whether to trim trailing whitespace on non-blank lines. Trailing blank lines are always trimmed, except in VT output without trimming, where they are kept as part of the layout.

Examples

c-vt-formatter/src/main.c.

Definition at line 115 of file formatter.h.

unwrap

bool unwrap

Whether to unwrap soft-wrapped lines.

Definition at line 108 of file formatter.h.

---

The documentation for this struct was generated from the following file:

• formatter.h