Code Coverage: vinyl-cache/bin/vinyltest/vtest2/src/teken.h
 
82217aa4fc7094b3610340078afaf78cd95a8ec9
 
0
/*-
1
 * SPDX-License-Identifier: BSD-2-Clause
2
 *
3
 * Copyright (c) 2008-2009 Ed Schouten <ed@FreeBSD.org>
4
 * All rights reserved.
5
 *
6
 * Redistribution and use in source and binary forms, with or without
7
 * modification, are permitted provided that the following conditions
8
 * are met:
9
 * 1. Redistributions of source code must retain the above copyright
10
 *    notice, this list of conditions and the following disclaimer.
11
 * 2. Redistributions in binary form must reproduce the above copyright
12
 *    notice, this list of conditions and the following disclaimer in the
13
 *    documentation and/or other materials provided with the distribution.
14
 *
15
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25
 * SUCH DAMAGE.
26
 */
27
28
#ifndef _TEKEN_H_
29
#define _TEKEN_H_
30
31
#include <sys/types.h>
32
33
/*
34
 * libteken: terminal emulation library.
35
 *
36
 * This library converts an UTF-8 stream of bytes to terminal drawing
37
 * commands.
38
 */
39
40
typedef uint32_t teken_char_t;
41
typedef unsigned short teken_unit_t;
42
typedef unsigned char teken_format_t;
43 226
#define TF_BOLD         0x01    /* Bold character. */
44 30
#define TF_UNDERLINE    0x02    /* Underline character. */
45 30
#define TF_BLINK        0x04    /* Blinking character. */
46 100
#define TF_REVERSE      0x08    /* Reverse rendered character. */
47 4
#define TF_CJK_RIGHT    0x10    /* Right-hand side of CJK character. */
48
#define TF_IMAGE        0x20    /* This character space has image. */
49
typedef unsigned char teken_color_t;
50 59
#define TC_BLACK        0
51
#define TC_RED          1
52
#define TC_GREEN        2
53
#define TC_YELLOW       3
54
#define TC_BLUE         4
55
#define TC_MAGENTA      5
56
#define TC_CYAN         6
57 59
#define TC_WHITE        7
58
#define TC_NCOLORS      8
59
#define TC_LIGHT        8       /* ORed with the others. */
60
61
typedef struct {
62
        teken_unit_t    tp_row;
63
        teken_unit_t    tp_col;
64
} teken_pos_t;
65
typedef struct {
66
        teken_pos_t     tr_begin;
67
        teken_pos_t     tr_end;
68
} teken_rect_t;
69
typedef struct {
70
        teken_format_t  ta_format;
71
        teken_color_t   ta_fgcolor;
72
        teken_color_t   ta_bgcolor;
73
} teken_attr_t;
74
typedef struct {
75
        teken_unit_t    ts_begin;
76
        teken_unit_t    ts_end;
77
} teken_span_t;
78
79
typedef struct __teken teken_t;
80
81
typedef void teken_state_t(teken_t *, teken_char_t);
82
83
/*
84
 * Drawing routines supplied by the user.
85
 */
86
87
typedef void tf_bell_t(void *);
88
typedef void tf_cursor_t(void *, const teken_pos_t *);
89
typedef void tf_putchar_t(void *, const teken_pos_t *, teken_char_t,
90
    const teken_attr_t *);
91
typedef void tf_fill_t(void *, const teken_rect_t *, teken_char_t,
92
    const teken_attr_t *);
93
typedef void tf_copy_t(void *, const teken_rect_t *, const teken_pos_t *);
94
typedef void tf_pre_input_t(void *);
95
typedef void tf_post_input_t(void *);
96
typedef void tf_param_t(void *, int, unsigned int);
97 66
#define TP_SHOWCURSOR   0
98 23
#define TP_KEYPADAPP    1
99 4
#define TP_AUTOREPEAT   2
100 2
#define TP_SWITCHVT     3
101 592
#define TP_132COLS      4
102 2
#define TP_SETBELLPD    5
103
#define TP_SETBELLPD_PITCH(pd)          ((pd) >> 16)
104
#define TP_SETBELLPD_DURATION(pd)       ((pd) & 0xffff)
105 0
#define TP_MOUSE        6
106 2
#define TP_SETBORDER    7
107 2
#define TP_SETLOCALCURSOR       8
108 2
#define TP_SETGLOBALCURSOR      9
109
typedef void tf_respond_t(void *, const void *, size_t);
110
111
typedef struct {
112
        tf_bell_t       *tf_bell;
113
        tf_cursor_t     *tf_cursor;
114
        tf_putchar_t    *tf_putchar;
115
        tf_fill_t       *tf_fill;
116
        tf_copy_t       *tf_copy;
117
        tf_pre_input_t  *tf_pre_input;
118
        tf_post_input_t *tf_post_input;
119
        tf_param_t      *tf_param;
120
        tf_respond_t    *tf_respond;
121
} teken_funcs_t;
122
123
typedef teken_char_t teken_scs_t(const teken_t *, teken_char_t);
124
125
/*
126
 * Terminal state.
127
 */
128
129
struct __teken {
130
        const teken_funcs_t *t_funcs;
131
        void            *t_softc;
132
133
        teken_state_t   *t_nextstate;
134
        unsigned int     t_stateflags;
135
136 4085
#define T_NUMSIZE       8
137
        unsigned int     t_nums[T_NUMSIZE];
138
        unsigned int     t_curnum;
139
140
        teken_pos_t      t_cursor;
141
        teken_attr_t     t_curattr;
142
        teken_pos_t      t_saved_cursor;
143
        teken_attr_t     t_saved_curattr;
144
145
        teken_attr_t     t_defattr;
146
        teken_pos_t      t_winsize;
147
148
        /* For DECSTBM. */
149
        teken_span_t     t_scrollreg;
150
        /* For DECOM. */
151
        teken_span_t     t_originreg;
152
153 11248
#define T_NUMCOL        160
154
        unsigned int     t_tabstops[T_NUMCOL / (sizeof(unsigned int) * 8)];
155
156
        unsigned int     t_utf8_left;
157
        teken_char_t     t_utf8_partial;
158
        teken_char_t     t_last;
159
160
        unsigned int     t_curscs;
161
        teken_scs_t     *t_saved_curscs;
162
        teken_scs_t     *t_scs[2];
163
};
164
165
/* Initialize teken structure. */
166
void    teken_init(teken_t *, const teken_funcs_t *, void *);
167
168
/* Deliver character input. */
169
void    teken_input(teken_t *, const void *, size_t);
170
171
/* Get/set teken attributes. */
172
const teken_pos_t *teken_get_cursor(const teken_t *);
173
const teken_attr_t *teken_get_curattr(const teken_t *);
174
const teken_attr_t *teken_get_defattr(const teken_t *);
175
void    teken_get_defattr_cons25(const teken_t *, int *, int *);
176
const teken_pos_t *teken_get_winsize(const teken_t *);
177
void    teken_set_cursor(teken_t *, const teken_pos_t *);
178
void    teken_set_curattr(teken_t *, const teken_attr_t *);
179
void    teken_set_defattr(teken_t *, const teken_attr_t *);
180
void    teken_set_winsize(teken_t *, const teken_pos_t *);
181
void    teken_set_winsize_noreset(teken_t *, const teken_pos_t *);
182
183
/* Key input escape sequences. */
184 59
#define TKEY_UP         0x00
185
#define TKEY_DOWN       0x01
186
#define TKEY_LEFT       0x02
187
#define TKEY_RIGHT      0x03
188
189
#define TKEY_HOME       0x04
190
#define TKEY_END        0x05
191
#define TKEY_INSERT     0x06
192
#define TKEY_DELETE     0x07
193
#define TKEY_PAGE_UP    0x08
194
#define TKEY_PAGE_DOWN  0x09
195
196 59
#define TKEY_F1         0x0a
197
#define TKEY_F2         0x0b
198
#define TKEY_F3         0x0c
199
#define TKEY_F4         0x0d
200
#define TKEY_F5         0x0e
201
#define TKEY_F6         0x0f
202
#define TKEY_F7         0x10
203
#define TKEY_F8         0x11
204
#define TKEY_F9         0x12
205
#define TKEY_F10        0x13
206
#define TKEY_F11        0x14
207
#define TKEY_F12        0x15
208
const char *teken_get_sequence(const teken_t *, unsigned int);
209
210
/* Legacy features. */
211
void    teken_set_8bit(teken_t *);
212
void    teken_set_cons25(teken_t *);
213
214
/* Color conversion. */
215
teken_color_t teken_256to16(teken_color_t);
216
teken_color_t teken_256to8(teken_color_t);
217
218
#endif /* !_TEKEN_H_ */