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