1 /* 2 * NOTE: This is a MODIFIED version of libvterm, see the README file. 3 */ 4 #ifndef __VTERM_H__ 5 #define __VTERM_H__ 6 7 #ifdef __cplusplus 8 extern "C" { 9 #endif 10 11 #include <stdint.h> 12 #include <stdlib.h> 13 14 #include "vterm_keycodes.h" 15 16 #define TRUE 1 17 #define FALSE 0 18 19 typedef struct VTerm VTerm; 20 typedef struct VTermState VTermState; 21 typedef struct VTermScreen VTermScreen; 22 23 /* Specifies a screen point. */ 24 typedef struct { 25 int row; 26 int col; 27 } VTermPos; 28 29 /* 30 * Some small utility functions; we can just keep these static here. 31 */ 32 33 /* 34 * Order points by on-screen flow order: 35 * Return < 0 if "a" is before "b" 36 * Return 0 if "a" and "b" are equal 37 * Return > 0 if "a" is after "b". 38 */ 39 int vterm_pos_cmp(VTermPos a, VTermPos b); 40 41 #if defined(DEFINE_INLINES) || USE_INLINE 42 INLINE int vterm_pos_cmp(VTermPos a, VTermPos b) 43 { 44 return (a.row == b.row) ? a.col - b.col : a.row - b.row; 45 } 46 #endif 47 48 /* Specifies a rectangular screen area. */ 49 typedef struct { 50 int start_row; 51 int end_row; 52 int start_col; 53 int end_col; 54 } VTermRect; 55 56 /* Return true if the rect "r" contains the point "p". */ 57 int vterm_rect_contains(VTermRect r, VTermPos p); 58 59 #if defined(DEFINE_INLINES) || USE_INLINE 60 INLINE int vterm_rect_contains(VTermRect r, VTermPos p) 61 { 62 return p.row >= r.start_row && p.row < r.end_row && 63 p.col >= r.start_col && p.col < r.end_col; 64 } 65 #endif 66 67 /* Move "rect" "row_delta" down and "col_delta" right. 68 * Does not check boundaries. */ 69 void vterm_rect_move(VTermRect *rect, int row_delta, int col_delta); 70 71 #if defined(DEFINE_INLINES) || USE_INLINE 72 INLINE void vterm_rect_move(VTermRect *rect, int row_delta, int col_delta) 73 { 74 rect->start_row += row_delta; rect->end_row += row_delta; 75 rect->start_col += col_delta; rect->end_col += col_delta; 76 } 77 #endif 78 79 typedef struct { 80 uint8_t red, green, blue; 81 } VTermColor; 82 83 typedef enum { 84 /* VTERM_VALUETYPE_NONE = 0 */ 85 VTERM_VALUETYPE_BOOL = 1, 86 VTERM_VALUETYPE_INT, 87 VTERM_VALUETYPE_STRING, 88 VTERM_VALUETYPE_COLOR 89 } VTermValueType; 90 91 typedef union { 92 int boolean; 93 int number; 94 char *string; 95 VTermColor color; 96 } VTermValue; 97 98 typedef enum { 99 /* VTERM_ATTR_NONE = 0 */ 100 VTERM_ATTR_BOLD = 1, /* bool: 1, 22 */ 101 VTERM_ATTR_UNDERLINE, /* number: 4, 21, 24 */ 102 VTERM_ATTR_ITALIC, /* bool: 3, 23 */ 103 VTERM_ATTR_BLINK, /* bool: 5, 25 */ 104 VTERM_ATTR_REVERSE, /* bool: 7, 27 */ 105 VTERM_ATTR_STRIKE, /* bool: 9, 29 */ 106 VTERM_ATTR_FONT, /* number: 10-19 */ 107 VTERM_ATTR_FOREGROUND, /* color: 30-39 90-97 */ 108 VTERM_ATTR_BACKGROUND /* color: 40-49 100-107 */ 109 } VTermAttr; 110 111 typedef enum { 112 /* VTERM_PROP_NONE = 0 */ 113 VTERM_PROP_CURSORVISIBLE = 1, /* bool */ 114 VTERM_PROP_CURSORBLINK, /* bool */ 115 VTERM_PROP_ALTSCREEN, /* bool */ 116 VTERM_PROP_TITLE, /* string */ 117 VTERM_PROP_ICONNAME, /* string */ 118 VTERM_PROP_REVERSE, /* bool */ 119 VTERM_PROP_CURSORSHAPE, /* number */ 120 VTERM_PROP_MOUSE /* number */ 121 } VTermProp; 122 123 enum { 124 VTERM_PROP_CURSORSHAPE_BLOCK = 1, 125 VTERM_PROP_CURSORSHAPE_UNDERLINE, 126 VTERM_PROP_CURSORSHAPE_BAR_LEFT 127 }; 128 129 enum { 130 VTERM_PROP_MOUSE_NONE = 0, 131 VTERM_PROP_MOUSE_CLICK, 132 VTERM_PROP_MOUSE_DRAG, 133 VTERM_PROP_MOUSE_MOVE 134 }; 135 136 typedef struct { 137 const uint32_t *chars; 138 int width; 139 unsigned int protected_cell:1; /* DECSCA-protected against DECSEL/DECSED */ 140 unsigned int dwl:1; /* DECDWL or DECDHL double-width line */ 141 unsigned int dhl:2; /* DECDHL double-height line (1=top 2=bottom) */ 142 } VTermGlyphInfo; 143 144 typedef struct { 145 unsigned int doublewidth:1; /* DECDWL or DECDHL line */ 146 unsigned int doubleheight:2; /* DECDHL line (1=top 2=bottom) */ 147 } VTermLineInfo; 148 149 typedef struct { 150 /* libvterm relies on the allocated memory to be zeroed out before it is 151 * returned by the allocator. */ 152 void *(*malloc)(size_t size, void *allocdata); 153 void (*free)(void *ptr, void *allocdata); 154 } VTermAllocatorFunctions; 155 156 /* Allocate and initialize a new terminal with default allocators. */ 157 VTerm *vterm_new(int rows, int cols); 158 159 /* Allocate and initialize a new terminal with specified allocators. */ 160 VTerm *vterm_new_with_allocator(int rows, int cols, VTermAllocatorFunctions *funcs, void *allocdata); 161 162 /* Free and cleanup a terminal and all its data. */ 163 void vterm_free(VTerm* vt); 164 165 /* Get the current size of the terminal and store in "rowsp" and "colsp". */ 166 void vterm_get_size(const VTerm *vt, int *rowsp, int *colsp); 167 168 void vterm_set_size(VTerm *vt, int rows, int cols); 169 170 int vterm_get_utf8(const VTerm *vt); 171 void vterm_set_utf8(VTerm *vt, int is_utf8); 172 173 size_t vterm_input_write(VTerm *vt, const char *bytes, size_t len); 174 175 size_t vterm_output_get_buffer_size(const VTerm *vt); 176 size_t vterm_output_get_buffer_current(const VTerm *vt); 177 size_t vterm_output_get_buffer_remaining(const VTerm *vt); 178 179 size_t vterm_output_read(VTerm *vt, char *buffer, size_t len); 180 181 void vterm_keyboard_unichar(VTerm *vt, uint32_t c, VTermModifier mod); 182 void vterm_keyboard_key(VTerm *vt, VTermKey key, VTermModifier mod); 183 184 void vterm_keyboard_start_paste(VTerm *vt); 185 void vterm_keyboard_end_paste(VTerm *vt); 186 187 void vterm_mouse_move(VTerm *vt, int row, int col, VTermModifier mod); 188 void vterm_mouse_button(VTerm *vt, int button, int pressed, VTermModifier mod); 189 190 /* ------------ 191 * Parser layer 192 * ------------ */ 193 194 /* Flag to indicate non-final subparameters in a single CSI parameter. 195 * Consider 196 * CSI 1;2:3:4;5a 197 * 1 4 and 5 are final. 198 * 2 and 3 are non-final and will have this bit set 199 * 200 * Don't confuse this with the final byte of the CSI escape; 'a' in this case. 201 */ 202 #define CSI_ARG_FLAG_MORE (1<<30) 203 #define CSI_ARG_MASK (~(1<<30)) 204 205 #define CSI_ARG_HAS_MORE(a) ((a) & CSI_ARG_FLAG_MORE) 206 #define CSI_ARG(a) ((a) & CSI_ARG_MASK) 207 208 /* Can't use -1 to indicate a missing argument; use this instead */ 209 #define CSI_ARG_MISSING ((1<<30)-1) 210 211 #define CSI_ARG_IS_MISSING(a) (CSI_ARG(a) == CSI_ARG_MISSING) 212 #define CSI_ARG_OR(a,def) (CSI_ARG(a) == CSI_ARG_MISSING ? (def) : CSI_ARG(a)) 213 #define CSI_ARG_COUNT(a) (CSI_ARG(a) == CSI_ARG_MISSING || CSI_ARG(a) == 0 ? 1 : CSI_ARG(a)) 214 215 typedef struct { 216 int (*text)(const char *bytes, size_t len, void *user); 217 int (*control)(unsigned char control, void *user); 218 int (*escape)(const char *bytes, size_t len, void *user); 219 int (*csi)(const char *leader, const long args[], int argcount, const char *intermed, char command, void *user); 220 int (*osc)(const char *command, size_t cmdlen, void *user); 221 int (*dcs)(const char *command, size_t cmdlen, void *user); 222 int (*resize)(int rows, int cols, void *user); 223 } VTermParserCallbacks; 224 225 void vterm_parser_set_callbacks(VTerm *vt, const VTermParserCallbacks *callbacks, void *user); 226 void *vterm_parser_get_cbdata(VTerm *vt); 227 228 /* ----------- 229 * State layer 230 * ----------- */ 231 232 typedef struct { 233 int (*putglyph)(VTermGlyphInfo *info, VTermPos pos, void *user); 234 int (*movecursor)(VTermPos pos, VTermPos oldpos, int visible, void *user); 235 int (*scrollrect)(VTermRect rect, int downward, int rightward, void *user); 236 int (*moverect)(VTermRect dest, VTermRect src, void *user); 237 int (*erase)(VTermRect rect, int selective, void *user); 238 int (*initpen)(void *user); 239 int (*setpenattr)(VTermAttr attr, VTermValue *val, void *user); 240 /* Callback for setting various properties. Must return 1 if the property 241 * was accepted, 0 otherwise. */ 242 int (*settermprop)(VTermProp prop, VTermValue *val, void *user); 243 int (*bell)(void *user); 244 int (*resize)(int rows, int cols, VTermPos *delta, void *user); 245 int (*setlineinfo)(int row, const VTermLineInfo *newinfo, const VTermLineInfo *oldinfo, void *user); 246 } VTermStateCallbacks; 247 248 VTermState *vterm_obtain_state(VTerm *vt); 249 250 void vterm_state_set_callbacks(VTermState *state, const VTermStateCallbacks *callbacks, void *user); 251 void *vterm_state_get_cbdata(VTermState *state); 252 253 /* Only invokes control, csi, osc, dcs */ 254 void vterm_state_set_unrecognised_fallbacks(VTermState *state, const VTermParserCallbacks *fallbacks, void *user); 255 void *vterm_state_get_unrecognised_fbdata(VTermState *state); 256 257 /* Initialize the state. */ 258 void vterm_state_reset(VTermState *state, int hard); 259 260 void vterm_state_get_cursorpos(const VTermState *state, VTermPos *cursorpos); 261 void vterm_state_get_default_colors(const VTermState *state, VTermColor *default_fg, VTermColor *default_bg); 262 void vterm_state_get_palette_color(const VTermState *state, int index, VTermColor *col); 263 void vterm_state_set_default_colors(VTermState *state, const VTermColor *default_fg, const VTermColor *default_bg); 264 void vterm_state_set_palette_color(VTermState *state, int index, const VTermColor *col); 265 void vterm_state_set_bold_highbright(VTermState *state, int bold_is_highbright); 266 int vterm_state_get_penattr(const VTermState *state, VTermAttr attr, VTermValue *val); 267 int vterm_state_set_termprop(VTermState *state, VTermProp prop, VTermValue *val); 268 const VTermLineInfo *vterm_state_get_lineinfo(const VTermState *state, int row); 269 270 /* ------------ 271 * Screen layer 272 * ------------ */ 273 274 typedef struct { 275 unsigned int bold : 1; 276 unsigned int underline : 2; 277 unsigned int italic : 1; 278 unsigned int blink : 1; 279 unsigned int reverse : 1; 280 unsigned int strike : 1; 281 unsigned int font : 4; /* 0 to 9 */ 282 unsigned int dwl : 1; /* On a DECDWL or DECDHL line */ 283 unsigned int dhl : 2; /* On a DECDHL line (1=top 2=bottom) */ 284 } VTermScreenCellAttrs; 285 286 typedef struct { 287 #define VTERM_MAX_CHARS_PER_CELL 6 288 uint32_t chars[VTERM_MAX_CHARS_PER_CELL]; 289 char width; 290 VTermScreenCellAttrs attrs; 291 VTermColor fg, bg; 292 } VTermScreenCell; 293 294 /* All fields are optional, NULL when not used. */ 295 typedef struct { 296 int (*damage)(VTermRect rect, void *user); 297 int (*moverect)(VTermRect dest, VTermRect src, void *user); 298 int (*movecursor)(VTermPos pos, VTermPos oldpos, int visible, void *user); 299 int (*settermprop)(VTermProp prop, VTermValue *val, void *user); 300 int (*bell)(void *user); 301 int (*resize)(int rows, int cols, void *user); 302 int (*sb_pushline)(int cols, const VTermScreenCell *cells, void *user); 303 int (*sb_popline)(int cols, VTermScreenCell *cells, void *user); 304 } VTermScreenCallbacks; 305 306 /* Return the screen of the vterm. */ 307 VTermScreen *vterm_obtain_screen(VTerm *vt); 308 309 /* 310 * Install screen callbacks. These are invoked when the screen contents is 311 * changed. "user" is passed into to the callback. 312 */ 313 void vterm_screen_set_callbacks(VTermScreen *screen, const VTermScreenCallbacks *callbacks, void *user); 314 void *vterm_screen_get_cbdata(VTermScreen *screen); 315 316 /* Only invokes control, csi, osc, dcs */ 317 void vterm_screen_set_unrecognised_fallbacks(VTermScreen *screen, const VTermParserCallbacks *fallbacks, void *user); 318 void *vterm_screen_get_unrecognised_fbdata(VTermScreen *screen); 319 320 void vterm_screen_enable_altscreen(VTermScreen *screen, int altscreen); 321 322 typedef enum { 323 VTERM_DAMAGE_CELL, /* every cell */ 324 VTERM_DAMAGE_ROW, /* entire rows */ 325 VTERM_DAMAGE_SCREEN, /* entire screen */ 326 VTERM_DAMAGE_SCROLL /* entire screen + scrollrect */ 327 } VTermDamageSize; 328 329 /* Invoke the relevant callbacks to update the screen. */ 330 void vterm_screen_flush_damage(VTermScreen *screen); 331 332 void vterm_screen_set_damage_merge(VTermScreen *screen, VTermDamageSize size); 333 334 /* 335 * Reset the screen. Also invokes vterm_state_reset(). 336 * Must be called before the terminal can be used. 337 */ 338 void vterm_screen_reset(VTermScreen *screen, int hard); 339 340 /* Neither of these functions NUL-terminate the buffer */ 341 size_t vterm_screen_get_chars(const VTermScreen *screen, uint32_t *chars, size_t len, const VTermRect rect); 342 size_t vterm_screen_get_text(const VTermScreen *screen, char *str, size_t len, const VTermRect rect); 343 344 typedef enum { 345 VTERM_ATTR_BOLD_MASK = 1 << 0, 346 VTERM_ATTR_UNDERLINE_MASK = 1 << 1, 347 VTERM_ATTR_ITALIC_MASK = 1 << 2, 348 VTERM_ATTR_BLINK_MASK = 1 << 3, 349 VTERM_ATTR_REVERSE_MASK = 1 << 4, 350 VTERM_ATTR_STRIKE_MASK = 1 << 5, 351 VTERM_ATTR_FONT_MASK = 1 << 6, 352 VTERM_ATTR_FOREGROUND_MASK = 1 << 7, 353 VTERM_ATTR_BACKGROUND_MASK = 1 << 8 354 } VTermAttrMask; 355 356 int vterm_screen_get_attrs_extent(const VTermScreen *screen, VTermRect *extent, VTermPos pos, VTermAttrMask attrs); 357 358 int vterm_screen_get_cell(const VTermScreen *screen, VTermPos pos, VTermScreenCell *cell); 359 360 int vterm_screen_is_eol(const VTermScreen *screen, VTermPos pos); 361 362 /* --------- 363 * Utilities 364 * --------- */ 365 366 VTermValueType vterm_get_attr_type(VTermAttr attr); 367 VTermValueType vterm_get_prop_type(VTermProp prop); 368 369 void vterm_scroll_rect(VTermRect rect, 370 int downward, 371 int rightward, 372 int (*moverect)(VTermRect src, VTermRect dest, void *user), 373 int (*eraserect)(VTermRect rect, int selective, void *user), 374 void *user); 375 376 void vterm_copy_cells(VTermRect dest, 377 VTermRect src, 378 void (*copycell)(VTermPos dest, VTermPos src, void *user), 379 void *user); 380 381 #ifdef __cplusplus 382 } 383 #endif 384 385 #endif 386