osc.h

Go to the documentation of this file.

 
#ifndef GHOSTTY_VT_OSC_H
#define GHOSTTY_VT_OSC_H
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <ghostty/vt/types.h>
#include <ghostty/vt/allocator.h>


typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_OSC_COMMAND_INVALID = 0,
  GHOSTTY_OSC_COMMAND_CHANGE_WINDOW_TITLE = 1,
  GHOSTTY_OSC_COMMAND_CHANGE_WINDOW_ICON = 2,
  GHOSTTY_OSC_COMMAND_SEMANTIC_PROMPT = 3,
  GHOSTTY_OSC_COMMAND_CLIPBOARD_CONTENTS = 4,
  GHOSTTY_OSC_COMMAND_REPORT_PWD = 5,
  GHOSTTY_OSC_COMMAND_MOUSE_SHAPE = 6,
  GHOSTTY_OSC_COMMAND_COLOR_OPERATION = 7,
  GHOSTTY_OSC_COMMAND_KITTY_COLOR_PROTOCOL = 8,
  GHOSTTY_OSC_COMMAND_SHOW_DESKTOP_NOTIFICATION = 9,
  GHOSTTY_OSC_COMMAND_HYPERLINK_START = 10,
  GHOSTTY_OSC_COMMAND_HYPERLINK_END = 11,
  GHOSTTY_OSC_COMMAND_CONEMU_SLEEP = 12,
  GHOSTTY_OSC_COMMAND_CONEMU_SHOW_MESSAGE_BOX = 13,
  GHOSTTY_OSC_COMMAND_CONEMU_CHANGE_TAB_TITLE = 14,
  GHOSTTY_OSC_COMMAND_CONEMU_PROGRESS_REPORT = 15,
  GHOSTTY_OSC_COMMAND_CONEMU_WAIT_INPUT = 16,
  GHOSTTY_OSC_COMMAND_CONEMU_GUIMACRO = 17,
  GHOSTTY_OSC_COMMAND_CONEMU_RUN_PROCESS = 18,
  GHOSTTY_OSC_COMMAND_CONEMU_OUTPUT_ENVIRONMENT_VARIABLE = 19,
  GHOSTTY_OSC_COMMAND_CONEMU_XTERM_EMULATION = 20,
  GHOSTTY_OSC_COMMAND_CONEMU_COMMENT = 21,
  GHOSTTY_OSC_COMMAND_KITTY_TEXT_SIZING = 22,
  GHOSTTY_OSC_COMMAND_KITTY_CLIPBOARD_PROTOCOL = 23,
  GHOSTTY_OSC_COMMAND_KITTY_DND_PROTOCOL = 24,
  GHOSTTY_OSC_COMMAND_HIERARCHICAL_CONTEXT = 25,
  GHOSTTY_OSC_COMMAND_KITTY_DESKTOP_NOTIFICATION = 26,

  GHOSTTY_OSC_COMMAND_UNKNOWN = 27,

  GHOSTTY_OSC_COMMAND_PROGRAM_STATUS = 28,
  GHOSTTY_OSC_COMMAND_TYPE_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyOscCommandType;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_OSC_TERMINATOR_ST = 0,

  GHOSTTY_OSC_TERMINATOR_BEL = 1,
  GHOSTTY_OSC_TERMINATOR_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyOscTerminator;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_OSC_OPT_INVALID = 0,

  GHOSTTY_OSC_OPT_UNKNOWN_MAX_BYTES = 1,
  GHOSTTY_OSC_OPT_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyOscOption;

typedef enum GHOSTTY_ENUM_TYPED {
  GHOSTTY_OSC_DATA_INVALID = 0,
  
  GHOSTTY_OSC_DATA_CHANGE_WINDOW_TITLE_STR = 1,

  GHOSTTY_OSC_DATA_UNKNOWN_CONTENT = 2,

  GHOSTTY_OSC_DATA_UNKNOWN_TRUNCATED = 3,

  GHOSTTY_OSC_DATA_UNKNOWN_TERMINATOR = 4,
  GHOSTTY_OSC_DATA_MAX_VALUE = GHOSTTY_ENUM_MAX_VALUE,
} GhosttyOscCommandData;

GHOSTTY_API GhosttyResult ghostty_osc_new(const GhosttyAllocator *allocator, GhosttyOscParser *parser);

GHOSTTY_API void ghostty_osc_free(GhosttyOscParser parser);

GHOSTTY_API void ghostty_osc_reset(GhosttyOscParser parser);

GHOSTTY_API GhosttyResult ghostty_osc_set(GhosttyOscParser parser,
                                          GhosttyOscOption option,
                                          const void* value);

GHOSTTY_API void ghostty_osc_next(GhosttyOscParser parser, uint8_t byte);

GHOSTTY_API GhosttyOscCommand ghostty_osc_end(GhosttyOscParser parser, uint8_t terminator);

GHOSTTY_API GhosttyOscCommandType ghostty_osc_command_type(GhosttyOscCommand command);

GHOSTTY_API GhosttyResult ghostty_osc_command_data(GhosttyOscCommand command, GhosttyOscCommandData data, void *out);

 
#endif /* GHOSTTY_VT_OSC_H */