1#ifndef __VTERM_H__
2#define __VTERM_H__
3
4#include <stdint.h>
5#include <stdlib.h>
6
7#include "vterm_input.h"
8
9typedef struct VTerm VTerm;
10typedef struct VTermState VTermState;
11typedef struct VTermScreen VTermScreen;
12
13typedef struct {
14  int row;
15  int col;
16} VTermPos;
17
18/* some small utility functions; we can just keep these static here */
19
20/* order points by on-screen flow order */
21static inline int vterm_pos_cmp(VTermPos a, VTermPos b)
22{
23  return (a.row == b.row) ? a.col - b.col : a.row - b.row;
24}
25
26typedef struct {
27  int start_row;
28  int end_row;
29  int start_col;
30  int end_col;
31} VTermRect;
32
33/* true if the rect contains the point */
34static inline int vterm_rect_contains(VTermRect r, VTermPos p)
35{
36  return p.row >= r.start_row && p.row < r.end_row &&
37         p.col >= r.start_col && p.col < r.end_col;
38}
39
40/* move a rect */
41static inline void vterm_rect_move(VTermRect *rect, int row_delta, int col_delta)
42{
43  rect->start_row += row_delta; rect->end_row += row_delta;
44  rect->start_col += col_delta; rect->end_col += col_delta;
45}
46
47/* Flag to indicate non-final subparameters in a single CSI parameter.
48 * Consider
49 *   CSI 1;2:3:4;5a
50 * 1 4 and 5 are final.
51 * 2 and 3 are non-final and will have this bit set
52 *
53 * Don't confuse this with the final byte of the CSI escape; 'a' in this case.
54 */
55#define CSI_ARG_FLAG_MORE (1<<31)
56#define CSI_ARG_MASK      (~(1<<31))
57
58#define CSI_ARG_HAS_MORE(a) ((a) & CSI_ARG_FLAG_MORE)
59#define CSI_ARG(a)          ((a) & CSI_ARG_MASK)
60
61/* Can't use -1 to indicate a missing argument; use this instead */
62#define CSI_ARG_MISSING ((1UL<<31)-1)
63
64#define CSI_ARG_IS_MISSING(a) (CSI_ARG(a) == CSI_ARG_MISSING)
65#define CSI_ARG_OR(a,def)     (CSI_ARG(a) == CSI_ARG_MISSING ? (def) : CSI_ARG(a))
66#define CSI_ARG_COUNT(a)      (CSI_ARG(a) == CSI_ARG_MISSING || CSI_ARG(a) == 0 ? 1 : CSI_ARG(a))
67
68typedef struct {
69  int (*text)(const char *bytes, size_t len, void *user);
70  int (*control)(unsigned char control, void *user);
71  int (*escape)(const char *bytes, size_t len, void *user);
72  int (*csi)(const char *leader, const long args[], int argcount, const char *intermed, char command, void *user);
73  int (*osc)(const char *command, size_t cmdlen, void *user);
74  int (*dcs)(const char *command, size_t cmdlen, void *user);
75  int (*resize)(int rows, int cols, void *user);
76} VTermParserCallbacks;
77
78typedef struct {
79  uint8_t red, green, blue;
80} VTermColor;
81
82typedef enum {
83  /* VTERM_VALUETYPE_NONE = 0 */
84  VTERM_VALUETYPE_BOOL = 1,
85  VTERM_VALUETYPE_INT,
86  VTERM_VALUETYPE_STRING,
87  VTERM_VALUETYPE_COLOR,
88} VTermValueType;
89
90typedef union {
91  int boolean;
92  int number;
93  char *string;
94  VTermColor color;
95} VTermValue;
96
97typedef enum {
98  /* VTERM_ATTR_NONE = 0 */
99  VTERM_ATTR_BOLD = 1,   // bool:   1, 22
100  VTERM_ATTR_UNDERLINE,  // number: 4, 21, 24
101  VTERM_ATTR_ITALIC,     // bool:   3, 23
102  VTERM_ATTR_BLINK,      // bool:   5, 25
103  VTERM_ATTR_REVERSE,    // bool:   7, 27
104  VTERM_ATTR_STRIKE,     // bool:   9, 29
105  VTERM_ATTR_FONT,       // number: 10-19
106  VTERM_ATTR_FOREGROUND, // color:  30-39 90-97
107  VTERM_ATTR_BACKGROUND, // color:  40-49 100-107
108} VTermAttr;
109
110typedef enum {
111  /* VTERM_PROP_NONE = 0 */
112  VTERM_PROP_CURSORVISIBLE = 1, // bool
113  VTERM_PROP_CURSORBLINK,       // bool
114  VTERM_PROP_ALTSCREEN,         // bool
115  VTERM_PROP_TITLE,             // string
116  VTERM_PROP_ICONNAME,          // string
117  VTERM_PROP_REVERSE,           // bool
118  VTERM_PROP_CURSORSHAPE,       // number
119} VTermProp;
120
121enum {
122  VTERM_PROP_CURSORSHAPE_BLOCK = 1,
123  VTERM_PROP_CURSORSHAPE_UNDERLINE,
124  VTERM_PROP_CURSORSHAPE_BAR_LEFT,
125};
126
127typedef void (*VTermMouseFunc)(int x, int y, int button, int pressed, int modifiers, void *data);
128
129typedef struct {
130  const uint32_t *chars;
131  int             width;
132  int             protected_cell;  /* DECSCA-protected against DECSEL/DECSED */
133} VTermGlyphInfo;
134
135typedef struct {
136  int (*putglyph)(VTermGlyphInfo *info, VTermPos pos, void *user);
137  int (*movecursor)(VTermPos pos, VTermPos oldpos, int visible, void *user);
138  int (*scrollrect)(VTermRect rect, int downward, int rightward, void *user);
139  int (*moverect)(VTermRect dest, VTermRect src, void *user);
140  int (*erase)(VTermRect rect, int selective, void *user);
141  int (*initpen)(void *user);
142  int (*setpenattr)(VTermAttr attr, VTermValue *val, void *user);
143  int (*settermprop)(VTermProp prop, VTermValue *val, void *user);
144  int (*setmousefunc)(VTermMouseFunc func, void *data, void *user);
145  int (*bell)(void *user);
146  int (*resize)(int rows, int cols, void *user);
147} VTermStateCallbacks;
148
149typedef struct {
150  int (*damage)(VTermRect rect, void *user);
151  int (*prescroll)(VTermRect rect, void *user);
152  int (*moverect)(VTermRect dest, VTermRect src, void *user);
153  int (*movecursor)(VTermPos pos, VTermPos oldpos, int visible, void *user);
154  int (*settermprop)(VTermProp prop, VTermValue *val, void *user);
155  int (*setmousefunc)(VTermMouseFunc func, void *data, void *user);
156  int (*bell)(void *user);
157  int (*resize)(int rows, int cols, void *user);
158} VTermScreenCallbacks;
159
160typedef struct {
161  /* libvterm relies on this memory to be zeroed out before it is returned
162   * by the allocator. */
163  void *(*malloc)(size_t size, void *allocdata);
164  void  (*free)(void *ptr, void *allocdata);
165} VTermAllocatorFunctions;
166
167VTerm *vterm_new(int rows, int cols);
168VTerm *vterm_new_with_allocator(int rows, int cols, VTermAllocatorFunctions *funcs, void *allocdata);
169void   vterm_free(VTerm* vt);
170
171void vterm_get_size(VTerm *vt, int *rowsp, int *colsp);
172void vterm_set_size(VTerm *vt, int rows, int cols);
173
174void vterm_set_parser_callbacks(VTerm *vt, const VTermParserCallbacks *callbacks, void *user);
175
176VTermState *vterm_obtain_state(VTerm *vt);
177
178void vterm_state_reset(VTermState *state, int hard);
179void vterm_state_set_callbacks(VTermState *state, const VTermStateCallbacks *callbacks, void *user);
180void vterm_state_get_cursorpos(VTermState *state, VTermPos *cursorpos);
181void vterm_state_set_default_colors(VTermState *state, VTermColor *default_fg, VTermColor *default_bg);
182void vterm_state_set_bold_highbright(VTermState *state, int bold_is_highbright);
183int  vterm_state_get_penattr(VTermState *state, VTermAttr attr, VTermValue *val);
184int  vterm_state_set_termprop(VTermState *state, VTermProp prop, VTermValue *val);
185
186VTermValueType vterm_get_attr_type(VTermAttr attr);
187VTermValueType vterm_get_prop_type(VTermProp prop);
188
189VTermScreen *vterm_obtain_screen(VTerm *vt);
190
191void vterm_screen_enable_altscreen(VTermScreen *screen, int altscreen);
192void vterm_screen_set_callbacks(VTermScreen *screen, const VTermScreenCallbacks *callbacks, void *user);
193
194typedef enum {
195  VTERM_DAMAGE_CELL,    /* every cell */
196  VTERM_DAMAGE_ROW,     /* entire rows */
197  VTERM_DAMAGE_SCREEN,  /* entire screen */
198  VTERM_DAMAGE_SCROLL,  /* entire screen + scrollrect */
199} VTermDamageSize;
200
201void vterm_screen_flush_damage(VTermScreen *screen);
202void vterm_screen_set_damage_merge(VTermScreen *screen, VTermDamageSize size);
203
204void   vterm_screen_reset(VTermScreen *screen, int hard);
205size_t vterm_screen_get_chars(VTermScreen *screen, uint32_t *chars, size_t len, const VTermRect rect);
206size_t vterm_screen_get_text(VTermScreen *screen, char *str, size_t len, const VTermRect rect);
207
208typedef struct {
209#define VTERM_MAX_CHARS_PER_CELL 6
210  uint32_t chars[VTERM_MAX_CHARS_PER_CELL];
211  char     width;
212  struct {
213    unsigned int bold      : 1;
214    unsigned int underline : 2;
215    unsigned int italic    : 1;
216    unsigned int blink     : 1;
217    unsigned int reverse   : 1;
218    unsigned int strike    : 1;
219    unsigned int font      : 4; /* 0 to 9 */
220  } attrs;
221  VTermColor fg, bg;
222} VTermScreenCell;
223
224int vterm_screen_get_cell(VTermScreen *screen, VTermPos pos, VTermScreenCell *cell);
225
226int vterm_screen_is_eol(VTermScreen *screen, VTermPos pos);
227
228void vterm_input_push_char(VTerm *vt, VTermModifier state, uint32_t c);
229void vterm_input_push_key(VTerm *vt, VTermModifier state, VTermKey key);
230
231void vterm_parser_set_utf8(VTerm *vt, int is_utf8);
232void vterm_push_bytes(VTerm *vt, const char *bytes, size_t len);
233
234size_t vterm_output_bufferlen(VTerm *vt); /* deprecated */
235
236size_t vterm_output_get_buffer_size(VTerm *vt);
237size_t vterm_output_get_buffer_current(VTerm *vt);
238size_t vterm_output_get_buffer_remaining(VTerm *vt);
239
240size_t vterm_output_bufferread(VTerm *vt, char *buffer, size_t len);
241
242void vterm_scroll_rect(VTermRect rect,
243                       int downward,
244                       int rightward,
245                       int (*moverect)(VTermRect src, VTermRect dest, void *user),
246                       int (*eraserect)(VTermRect rect, int selective, void *user),
247                       void *user);
248
249void vterm_copy_cells(VTermRect dest,
250                      VTermRect src,
251                      void (*copycell)(VTermPos dest, VTermPos src, void *user),
252                      void *user);
253
254#endif
255