terminal.h

Go to the documentation of this file.

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


typedef struct GhosttyTerminal* GhosttyTerminal;

typedef struct {
  uint16_t cols;

  uint16_t rows;

  size_t max_scrollback;
 
  // TODO: Consider ABI compatibility implications of this struct.
  // We may want to artificially pad it significantly to support
  // future options.
} GhosttyTerminalOptions;

typedef enum {
  GHOSTTY_SCROLL_VIEWPORT_TOP,

  GHOSTTY_SCROLL_VIEWPORT_BOTTOM,

  GHOSTTY_SCROLL_VIEWPORT_DELTA,
} GhosttyTerminalScrollViewportTag;

typedef union {
  intptr_t delta;

  uint64_t _padding[2];
} GhosttyTerminalScrollViewportValue;

typedef struct {
  GhosttyTerminalScrollViewportTag tag;
  GhosttyTerminalScrollViewportValue value;
} GhosttyTerminalScrollViewport;

GhosttyResult ghostty_terminal_new(const GhosttyAllocator* allocator,
                                   GhosttyTerminal* terminal,
                                   GhosttyTerminalOptions options);

void ghostty_terminal_free(GhosttyTerminal terminal);

void ghostty_terminal_reset(GhosttyTerminal terminal);

GhosttyResult ghostty_terminal_resize(GhosttyTerminal terminal,
                                      uint16_t cols,
                                      uint16_t rows);

void ghostty_terminal_vt_write(GhosttyTerminal terminal,
                                const uint8_t* data,
                                size_t len);

void ghostty_terminal_scroll_viewport(GhosttyTerminal terminal,
                                      GhosttyTerminalScrollViewport behavior);

 
#ifdef __cplusplus
}
#endif
 
#endif /* GHOSTTY_VT_TERMINAL_H */