selection.h

Go to the documentation of this file.

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


typedef struct GhosttySelectionGestureImpl* GhosttySelectionGesture;

typedef struct GhosttySelectionGestureEventImpl* GhosttySelectionGestureEvent;

typedef struct {
  size_t size;

  GhosttyGridRef start;

  GhosttyGridRef end;

  bool rectangle;
} GhosttySelection;

typedef struct {
  size_t size;

  GhosttyGridRef ref;

  const uint32_t* boundary_codepoints;

  size_t boundary_codepoints_len;
} GhosttyTerminalSelectWordOptions;

typedef struct {
  size_t size;

  GhosttyGridRef start;

  GhosttyGridRef end;

  const uint32_t* boundary_codepoints;

  size_t boundary_codepoints_len;
} GhosttyTerminalSelectWordBetweenOptions;

typedef struct {
  size_t size;

  GhosttyGridRef ref;

  const uint32_t* whitespace;

  size_t whitespace_len;

  bool semantic_prompt_boundary;
} GhosttyTerminalSelectLineOptions;

typedef struct {
  size_t size;

  GhosttyFormatterFormat emit;

  bool unwrap;

  bool trim;

  const GhosttySelection *selection;
} GhosttyTerminalSelectionFormatOptions;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_SELECTION_ORDER_FORWARD = 0,

  GHOSTTY_SELECTION_ORDER_REVERSE = 1,

  GHOSTTY_SELECTION_ORDER_MIRRORED_FORWARD = 2,

  GHOSTTY_SELECTION_ORDER_MIRRORED_REVERSE = 3,
 
  GHOSTTY_SELECTION_ORDER_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttySelectionOrder;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_SELECTION_ADJUST_LEFT = 0,

  GHOSTTY_SELECTION_ADJUST_RIGHT = 1,

  GHOSTTY_SELECTION_ADJUST_UP = 2,

  GHOSTTY_SELECTION_ADJUST_DOWN = 3,

  GHOSTTY_SELECTION_ADJUST_HOME = 4,

  GHOSTTY_SELECTION_ADJUST_END = 5,

  GHOSTTY_SELECTION_ADJUST_PAGE_UP = 6,

  GHOSTTY_SELECTION_ADJUST_PAGE_DOWN = 7,

  GHOSTTY_SELECTION_ADJUST_BEGINNING_OF_LINE = 8,

  GHOSTTY_SELECTION_ADJUST_END_OF_LINE = 9,
 
  GHOSTTY_SELECTION_ADJUST_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttySelectionAdjust;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_SELECTION_GESTURE_BEHAVIOR_CELL = 0,

  GHOSTTY_SELECTION_GESTURE_BEHAVIOR_WORD = 1,

  GHOSTTY_SELECTION_GESTURE_BEHAVIOR_LINE = 2,

  GHOSTTY_SELECTION_GESTURE_BEHAVIOR_OUTPUT = 3,
 
  GHOSTTY_SELECTION_GESTURE_BEHAVIOR_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttySelectionGestureBehavior;

typedef struct {
  GhosttySelectionGestureBehavior single_click;

  GhosttySelectionGestureBehavior double_click;

  GhosttySelectionGestureBehavior triple_click;
} GhosttySelectionGestureBehaviors;

typedef struct {
  uint32_t columns;

  uint32_t cell_width;

  uint32_t padding_left;

  uint32_t screen_height;
} GhosttySelectionGestureGeometry;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_SELECTION_GESTURE_AUTOSCROLL_NONE = 0,

  GHOSTTY_SELECTION_GESTURE_AUTOSCROLL_UP = 1,

  GHOSTTY_SELECTION_GESTURE_AUTOSCROLL_DOWN = 2,
 
  GHOSTTY_SELECTION_GESTURE_AUTOSCROLL_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttySelectionGestureAutoscroll;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_SELECTION_GESTURE_DATA_CLICK_COUNT = 0,

  GHOSTTY_SELECTION_GESTURE_DATA_DRAGGED = 1,

  GHOSTTY_SELECTION_GESTURE_DATA_AUTOSCROLL = 2,

  GHOSTTY_SELECTION_GESTURE_DATA_BEHAVIOR = 3,

  GHOSTTY_SELECTION_GESTURE_DATA_ANCHOR = 4,
 
  GHOSTTY_SELECTION_GESTURE_DATA_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttySelectionGestureData;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_SELECTION_GESTURE_EVENT_TYPE_PRESS = 0,

  GHOSTTY_SELECTION_GESTURE_EVENT_TYPE_RELEASE = 1,

  GHOSTTY_SELECTION_GESTURE_EVENT_TYPE_DRAG = 2,

  GHOSTTY_SELECTION_GESTURE_EVENT_TYPE_AUTOSCROLL_TICK = 3,

  GHOSTTY_SELECTION_GESTURE_EVENT_TYPE_DEEP_PRESS = 4,
 
  GHOSTTY_SELECTION_GESTURE_EVENT_TYPE_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttySelectionGestureEventType;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_SELECTION_GESTURE_EVENT_OPT_REF = 0,

  GHOSTTY_SELECTION_GESTURE_EVENT_OPT_POSITION = 1,

  GHOSTTY_SELECTION_GESTURE_EVENT_OPT_REPEAT_DISTANCE = 2,

  GHOSTTY_SELECTION_GESTURE_EVENT_OPT_TIME_NS = 3,

  GHOSTTY_SELECTION_GESTURE_EVENT_OPT_REPEAT_INTERVAL_NS = 4,

  GHOSTTY_SELECTION_GESTURE_EVENT_OPT_WORD_BOUNDARY_CODEPOINTS = 5,

  GHOSTTY_SELECTION_GESTURE_EVENT_OPT_BEHAVIORS = 6,

  GHOSTTY_SELECTION_GESTURE_EVENT_OPT_RECTANGLE = 7,

  GHOSTTY_SELECTION_GESTURE_EVENT_OPT_GEOMETRY = 8,

  GHOSTTY_SELECTION_GESTURE_EVENT_OPT_VIEWPORT = 9,
 
  GHOSTTY_SELECTION_GESTURE_EVENT_OPT_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttySelectionGestureEventOption;

GHOSTTY_API GhosttyResult ghostty_selection_gesture_event_new(
                                    const GhosttyAllocator* allocator,
                                    GhosttySelectionGestureEvent* out_event,
                                    GhosttySelectionGestureEventType type);

GHOSTTY_API void ghostty_selection_gesture_event_free(
                                    GhosttySelectionGestureEvent event);

GHOSTTY_API GhosttyResult ghostty_selection_gesture_event_set(
                                    GhosttySelectionGestureEvent event,
                                    GhosttySelectionGestureEventOption option,
                                    const void* value);

GHOSTTY_API GhosttyResult ghostty_selection_gesture_event(
                                    GhosttySelectionGesture gesture,
                                    GhosttyTerminal terminal,
                                    GhosttySelectionGestureEvent event,
                                    GhosttySelection* out_selection);

GHOSTTY_API GhosttyResult ghostty_selection_gesture_new(
                                    const GhosttyAllocator* allocator,
                                    GhosttySelectionGesture* out_gesture);

GHOSTTY_API void ghostty_selection_gesture_free(
                                    GhosttySelectionGesture gesture,
                                    GhosttyTerminal terminal);

GHOSTTY_API void ghostty_selection_gesture_reset(
                                    GhosttySelectionGesture gesture,
                                    GhosttyTerminal terminal);

GHOSTTY_API GhosttyResult ghostty_selection_gesture_get(
                                    GhosttySelectionGesture gesture,
                                    GhosttyTerminal terminal,
                                    GhosttySelectionGestureData data,
                                    void* value);

GHOSTTY_API GhosttyResult ghostty_selection_gesture_get_multi(
                                    GhosttySelectionGesture gesture,
                                    GhosttyTerminal terminal,
                                    size_t count,
                                    const GhosttySelectionGestureData* keys,
                                    void** values,
                                    size_t* out_written);

GHOSTTY_API GhosttyResult ghostty_terminal_select_word(
                                    GhosttyTerminal terminal,
                                    const GhosttyTerminalSelectWordOptions* options,
                                    GhosttySelection* out_selection);

GHOSTTY_API GhosttyResult ghostty_terminal_select_word_between(
                                    GhosttyTerminal terminal,
                                    const GhosttyTerminalSelectWordBetweenOptions* options,
                                    GhosttySelection* out_selection);

GHOSTTY_API GhosttyResult ghostty_terminal_select_line(
                                    GhosttyTerminal terminal,
                                    const GhosttyTerminalSelectLineOptions* options,
                                    GhosttySelection* out_selection);

GHOSTTY_API GhosttyResult ghostty_terminal_select_all(
                                    GhosttyTerminal terminal,
                                    GhosttySelection* out_selection);

GHOSTTY_API GhosttyResult ghostty_terminal_select_output(
                                    GhosttyTerminal terminal,
                                    GhosttyGridRef ref,
                                    GhosttySelection* out_selection);

GHOSTTY_API GhosttyResult ghostty_terminal_selection_format_buf(
                                    GhosttyTerminal terminal,
                                    GhosttyTerminalSelectionFormatOptions options,
                                    uint8_t* buf,
                                    size_t buf_len,
                                    size_t* out_written);

GHOSTTY_API GhosttyResult ghostty_terminal_selection_format_alloc(
                                    GhosttyTerminal terminal,
                                    const GhosttyAllocator* allocator,
                                    GhosttyTerminalSelectionFormatOptions options,
                                    uint8_t** out_ptr,
                                    size_t* out_len);

GHOSTTY_API GhosttyResult ghostty_terminal_selection_adjust(
                                    GhosttyTerminal terminal,
                                    GhosttySelection* selection,
                                    GhosttySelectionAdjust adjustment);

GHOSTTY_API GhosttyResult ghostty_terminal_selection_order(
                                    GhosttyTerminal terminal,
                                    const GhosttySelection* selection,
                                    GhosttySelectionOrder* out_order);

GHOSTTY_API GhosttyResult ghostty_terminal_selection_ordered(
                                    GhosttyTerminal terminal,
                                    const GhosttySelection* selection,
                                    GhosttySelectionOrder desired,
                                    GhosttySelection* out_selection);

GHOSTTY_API GhosttyResult ghostty_terminal_selection_contains(
                                    GhosttyTerminal terminal,
                                    const GhosttySelection* selection,
                                    GhosttyPoint point,
                                    bool* out_contains);

GHOSTTY_API GhosttyResult ghostty_terminal_selection_equal(
                                    GhosttyTerminal terminal,
                                    const GhosttySelection* a,
                                    const GhosttySelection* b,
                                    bool* out_equal);

 
#ifdef __cplusplus
}
#endif
 
#endif /* GHOSTTY_VT_SELECTION_H */