mouse/encoder.h

Go to the documentation of this file.

 
#ifndef GHOSTTY_VT_MOUSE_ENCODER_H
#define GHOSTTY_VT_MOUSE_ENCODER_H
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <ghostty/vt/allocator.h>
#include <ghostty/vt/mouse/event.h>
#include <ghostty/vt/terminal.h>
#include <ghostty/vt/types.h>

typedef struct GhosttyMouseEncoderImpl *GhosttyMouseEncoder;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_MOUSE_TRACKING_NONE = 0,

  GHOSTTY_MOUSE_TRACKING_X10 = 1,

  GHOSTTY_MOUSE_TRACKING_NORMAL = 2,

  GHOSTTY_MOUSE_TRACKING_BUTTON = 3,

  GHOSTTY_MOUSE_TRACKING_ANY = 4,
  GHOSTTY_MOUSE_TRACKING_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyMouseTrackingMode;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_MOUSE_FORMAT_X10 = 0,
  GHOSTTY_MOUSE_FORMAT_UTF8 = 1,
  GHOSTTY_MOUSE_FORMAT_SGR = 2,
  GHOSTTY_MOUSE_FORMAT_URXVT = 3,
  GHOSTTY_MOUSE_FORMAT_SGR_PIXELS = 4,
  GHOSTTY_MOUSE_FORMAT_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyMouseFormat;

typedef struct {
  size_t size;

  uint32_t screen_width;

  uint32_t screen_height;

  uint32_t cell_width;

  uint32_t cell_height;

  uint32_t padding_top;

  uint32_t padding_bottom;

  uint32_t padding_right;

  uint32_t padding_left;
} GhosttyMouseEncoderSize;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_MOUSE_ENCODER_OPT_INVALID = 0,

  GHOSTTY_MOUSE_ENCODER_OPT_EVENT = 1,

  GHOSTTY_MOUSE_ENCODER_OPT_FORMAT = 2,

  GHOSTTY_MOUSE_ENCODER_OPT_SIZE = 3,

  GHOSTTY_MOUSE_ENCODER_OPT_ANY_BUTTON_PRESSED = 4,

  GHOSTTY_MOUSE_ENCODER_OPT_TRACK_LAST_CELL = 5,
  GHOSTTY_MOUSE_ENCODER_OPT_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyMouseEncoderOption;

GHOSTTY_API GhosttyResult ghostty_mouse_encoder_new(const GhosttyAllocator *allocator,
                                        GhosttyMouseEncoder *encoder);

GHOSTTY_API void ghostty_mouse_encoder_free(GhosttyMouseEncoder encoder);

GHOSTTY_API GhosttyResult ghostty_mouse_encoder_set(GhosttyMouseEncoder encoder,
                                  GhosttyMouseEncoderOption option,
                                  const void *value);

GHOSTTY_API GhosttyResult ghostty_mouse_encoder_set_from_terminal(GhosttyMouseEncoder encoder,
                                                GhosttyTerminal terminal);

GHOSTTY_API GhosttyResult ghostty_mouse_encoder_reset(GhosttyMouseEncoder encoder);

GHOSTTY_API GhosttyResult ghostty_mouse_encoder_encode(GhosttyMouseEncoder encoder,
                                           GhosttyMouseEvent event,
                                           uint8_t *buf,
                                           size_t buf_len,
                                           size_t *out_written);
 
#endif /* GHOSTTY_VT_MOUSE_ENCODER_H */