types.h

Go to the documentation of this file.

 
#ifndef GHOSTTY_VT_TYPES_H
#define GHOSTTY_VT_TYPES_H
 
#include <limits.h>
#include <stddef.h>
#include <stdint.h>
 
// Symbol visibility for shared library builds. On Windows, functions
// are exported from the DLL when building and imported when consuming.
// On other platforms with GCC/Clang, functions are marked with default
// visibility so they remain accessible when the library is built with
// -fvisibility=hidden. For static library builds, define GHOSTTY_STATIC
// before including this header to make this a no-op.
#ifndef GHOSTTY_API
#if defined(GHOSTTY_STATIC)
  #define GHOSTTY_API
#elif defined(_WIN32) || defined(_WIN64)
  #ifdef GHOSTTY_BUILD_SHARED
    #define GHOSTTY_API __declspec(dllexport)
  #else
    #define GHOSTTY_API __declspec(dllimport)
  #endif
#elif defined(__GNUC__) && __GNUC__ >= 4
  #define GHOSTTY_API __attribute__((visibility("default")))
#else
  #define GHOSTTY_API
#endif
#endif

#ifndef GHOSTTY_DEPRECATED
#if defined(__GNUC__) || defined(__clang__)
  #define GHOSTTY_DEPRECATED(msg) __attribute__((deprecated(msg)))
#elif defined(_MSC_VER)
  #define GHOSTTY_DEPRECATED(msg) __declspec(deprecated(msg))
#else
  #define GHOSTTY_DEPRECATED(msg)
#endif
#endif

#if defined(__cplusplus) && \
    (__cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1700))
#define GHOSTTY_ENUM_TYPED : int
#elif defined(__STDC_VERSION__) && __STDC_VERSION__ >= 202311L
#define GHOSTTY_ENUM_TYPED : int
#else
#define GHOSTTY_ENUM_TYPED
#endif
#define GHOSTTY_ENUM_MAX_VALUE INT_MAX

typedef enum GHOSTTY_ENUM_TYPED {
    GHOSTTY_SUCCESS = 0,
    GHOSTTY_OUT_OF_MEMORY = -1,
    GHOSTTY_INVALID_VALUE = -2,
    GHOSTTY_OUT_OF_SPACE = -3,
    GHOSTTY_NO_VALUE = -4,
    GHOSTTY_IO_ERROR = -5,
    GHOSTTY_LIMIT_EXCEEDED = -6,
    GHOSTTY_REJECTED = -7,
    GHOSTTY_UNSUPPORTED = -8,
    GHOSTTY_RESULT_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyResult;
 
/* ---- Opaque handles ---- */

typedef struct GhosttyTerminalImpl* GhosttyTerminal;

typedef struct GhosttySnapshotDecoderImpl* GhosttySnapshotDecoder;

typedef struct GhosttyTrackedGridRefImpl* GhosttyTrackedGridRef;

typedef struct GhosttyKittyGraphicsImpl* GhosttyKittyGraphics;

typedef const struct GhosttyKittyGraphicsImageImpl* GhosttyKittyGraphicsImage;

typedef struct GhosttyKittyGraphicsPlacementIteratorImpl* GhosttyKittyGraphicsPlacementIterator;

typedef struct GhosttyRenderStateImpl* GhosttyRenderState;

typedef struct GhosttyRenderStateRowIteratorImpl* GhosttyRenderStateRowIterator;

typedef struct GhosttyRenderStateRowCellsImpl* GhosttyRenderStateRowCells;

typedef struct GhosttyRenderStateImageIteratorImpl* GhosttyRenderStateImageIterator;

typedef struct GhosttySearchImpl* GhosttySearch;

typedef struct GhosttySgrParserImpl* GhosttySgrParser;

typedef struct GhosttyFormatterImpl* GhosttyFormatter;

typedef struct GhosttyOscParserImpl* GhosttyOscParser;

typedef struct GhosttyOscCommandImpl* GhosttyOscCommand;
 
/* ---- Common value types ---- */

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_FORMATTER_FORMAT_PLAIN = 0,

  GHOSTTY_FORMATTER_FORMAT_VT = 1,

  GHOSTTY_FORMATTER_FORMAT_HTML = 2,
  GHOSTTY_FORMATTER_FORMAT_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyFormatterFormat;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_CURSOR_STYLE_BAR = 0,

  GHOSTTY_CURSOR_STYLE_BLOCK = 1,

  GHOSTTY_CURSOR_STYLE_UNDERLINE = 2,

  GHOSTTY_CURSOR_STYLE_BLOCK_HOLLOW = 3,
  GHOSTTY_CURSOR_STYLE_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyCursorStyle;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_IMAGE_LAYER_BELOW_BACKGROUND = 0,

  GHOSTTY_IMAGE_LAYER_BELOW_TEXT = 1,

  GHOSTTY_IMAGE_LAYER_ABOVE_TEXT = 2,
  GHOSTTY_IMAGE_LAYER_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyImageLayer;

#define GHOSTTY_IMAGE_LAYER_MASK_BELOW_BACKGROUND \
  (1u << GHOSTTY_IMAGE_LAYER_BELOW_BACKGROUND)

#define GHOSTTY_IMAGE_LAYER_MASK_BELOW_TEXT \
  (1u << GHOSTTY_IMAGE_LAYER_BELOW_TEXT)

#define GHOSTTY_IMAGE_LAYER_MASK_ABOVE_TEXT \
  (1u << GHOSTTY_IMAGE_LAYER_ABOVE_TEXT)

typedef struct {
  const uint8_t* ptr;

  size_t len;
} GhosttyString;

typedef struct {
  uint8_t* ptr;

  size_t cap;

  size_t len;
} GhosttyBuffer;

typedef struct {
  double x;

  double y;
} GhosttySurfacePosition;

typedef struct {
  const uint32_t* ptr;

  size_t len;
} GhosttyCodepoints;

typedef struct {
  uint32_t* ptr;

  size_t cap;

  size_t len;
} GhosttyCodepointBuffer;

#ifdef __cplusplus
#define GHOSTTY_INIT_SIZED(type)                                      \
  ([]() noexcept {                                                    \
    type value{};                                                     \
    value.size = sizeof(value);                                       \
    return value;                                                     \
  }())
#else
#define GHOSTTY_INIT_SIZED(type) \
  ((type){ .size = sizeof(type) })
#endif

GHOSTTY_API void ghostty_sized_init(void* ptr, size_t size);

GHOSTTY_API const char *ghostty_type_json(void);
 
#endif /* GHOSTTY_VT_TYPES_H */