xref: /freebsd/sys/teken/teken.h (revision 95ee2897)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
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 
29 #ifndef _TEKEN_H_
30 #define	_TEKEN_H_
31 
32 #include <sys/types.h>
33 
34 /*
35  * libteken: terminal emulation library.
36  *
37  * This library converts an UTF-8 stream of bytes to terminal drawing
38  * commands.
39  */
40 
41 typedef uint32_t teken_char_t;
42 typedef unsigned short teken_unit_t;
43 typedef unsigned char teken_format_t;
44 #define	TF_BOLD		0x01	/* Bold character. */
45 #define	TF_UNDERLINE	0x02	/* Underline character. */
46 #define	TF_BLINK	0x04	/* Blinking character. */
47 #define	TF_REVERSE	0x08	/* Reverse rendered character. */
48 #define	TF_CJK_RIGHT	0x10	/* Right-hand side of CJK character. */
49 #define	TF_IMAGE	0x20	/* This character space has image. */
50 typedef unsigned char teken_color_t;
51 #define	TC_BLACK	0
52 #define	TC_RED		1
53 #define	TC_GREEN	2
54 #define	TC_YELLOW	3
55 #define	TC_BLUE		4
56 #define	TC_MAGENTA	5
57 #define	TC_CYAN		6
58 #define	TC_WHITE	7
59 #define	TC_NCOLORS	8
60 #define	TC_LIGHT	8	/* ORed with the others. */
61 
62 typedef struct {
63 	teken_unit_t	tp_row;
64 	teken_unit_t	tp_col;
65 } teken_pos_t;
66 typedef struct {
67 	teken_pos_t	tr_begin;
68 	teken_pos_t	tr_end;
69 } teken_rect_t;
70 typedef struct {
71 	teken_format_t	ta_format;
72 	teken_color_t	ta_fgcolor;
73 	teken_color_t	ta_bgcolor;
74 } teken_attr_t;
75 typedef struct {
76 	teken_unit_t	ts_begin;
77 	teken_unit_t	ts_end;
78 } teken_span_t;
79 
80 typedef struct __teken teken_t;
81 
82 typedef void teken_state_t(teken_t *, teken_char_t);
83 
84 /*
85  * Drawing routines supplied by the user.
86  */
87 
88 typedef void tf_bell_t(void *);
89 typedef void tf_cursor_t(void *, const teken_pos_t *);
90 typedef void tf_putchar_t(void *, const teken_pos_t *, teken_char_t,
91     const teken_attr_t *);
92 typedef void tf_fill_t(void *, const teken_rect_t *, teken_char_t,
93     const teken_attr_t *);
94 typedef void tf_copy_t(void *, const teken_rect_t *, const teken_pos_t *);
95 typedef void tf_pre_input_t(void *);
96 typedef void tf_post_input_t(void *);
97 typedef void tf_param_t(void *, int, unsigned int);
98 #define	TP_SHOWCURSOR	0
99 #define	TP_KEYPADAPP	1
100 #define	TP_AUTOREPEAT	2
101 #define	TP_SWITCHVT	3
102 #define	TP_132COLS	4
103 #define	TP_SETBELLPD	5
104 #define	TP_SETBELLPD_PITCH(pd)		((pd) >> 16)
105 #define	TP_SETBELLPD_DURATION(pd)	((pd) & 0xffff)
106 #define	TP_MOUSE	6
107 #define	TP_SETBORDER	7
108 #define	TP_SETLOCALCURSOR	8
109 #define	TP_SETGLOBALCURSOR	9
110 typedef void tf_respond_t(void *, const void *, size_t);
111 
112 typedef struct {
113 	tf_bell_t	*tf_bell;
114 	tf_cursor_t	*tf_cursor;
115 	tf_putchar_t	*tf_putchar;
116 	tf_fill_t	*tf_fill;
117 	tf_copy_t	*tf_copy;
118 	tf_pre_input_t	*tf_pre_input;
119 	tf_post_input_t	*tf_post_input;
120 	tf_param_t	*tf_param;
121 	tf_respond_t	*tf_respond;
122 } teken_funcs_t;
123 
124 typedef teken_char_t teken_scs_t(const teken_t *, teken_char_t);
125 
126 /*
127  * Terminal state.
128  */
129 
130 struct __teken {
131 	const teken_funcs_t *t_funcs;
132 	void		*t_softc;
133 
134 	teken_state_t	*t_nextstate;
135 	unsigned int	 t_stateflags;
136 
137 #define T_NUMSIZE	8
138 	unsigned int	 t_nums[T_NUMSIZE];
139 	unsigned int	 t_curnum;
140 
141 	teken_pos_t	 t_cursor;
142 	teken_attr_t	 t_curattr;
143 	teken_pos_t	 t_saved_cursor;
144 	teken_attr_t	 t_saved_curattr;
145 
146 	teken_attr_t	 t_defattr;
147 	teken_pos_t	 t_winsize;
148 
149 	/* For DECSTBM. */
150 	teken_span_t	 t_scrollreg;
151 	/* For DECOM. */
152 	teken_span_t	 t_originreg;
153 
154 #define	T_NUMCOL	160
155 	unsigned int	 t_tabstops[T_NUMCOL / (sizeof(unsigned int) * 8)];
156 
157 	unsigned int	 t_utf8_left;
158 	teken_char_t	 t_utf8_partial;
159 	teken_char_t	 t_last;
160 
161 	unsigned int	 t_curscs;
162 	teken_scs_t	*t_saved_curscs;
163 	teken_scs_t	*t_scs[2];
164 };
165 
166 /* Initialize teken structure. */
167 void	teken_init(teken_t *, const teken_funcs_t *, void *);
168 
169 /* Deliver character input. */
170 void	teken_input(teken_t *, const void *, size_t);
171 
172 /* Get/set teken attributes. */
173 const teken_pos_t *teken_get_cursor(const teken_t *);
174 const teken_attr_t *teken_get_curattr(const teken_t *);
175 const teken_attr_t *teken_get_defattr(const teken_t *);
176 void	teken_get_defattr_cons25(const teken_t *, int *, int *);
177 const teken_pos_t *teken_get_winsize(const teken_t *);
178 void	teken_set_cursor(teken_t *, const teken_pos_t *);
179 void	teken_set_curattr(teken_t *, const teken_attr_t *);
180 void	teken_set_defattr(teken_t *, const teken_attr_t *);
181 void	teken_set_winsize(teken_t *, const teken_pos_t *);
182 void	teken_set_winsize_noreset(teken_t *, const teken_pos_t *);
183 
184 /* Key input escape sequences. */
185 #define	TKEY_UP		0x00
186 #define	TKEY_DOWN	0x01
187 #define	TKEY_LEFT	0x02
188 #define	TKEY_RIGHT	0x03
189 
190 #define	TKEY_HOME	0x04
191 #define	TKEY_END	0x05
192 #define	TKEY_INSERT	0x06
193 #define	TKEY_DELETE	0x07
194 #define	TKEY_PAGE_UP	0x08
195 #define	TKEY_PAGE_DOWN	0x09
196 
197 #define	TKEY_F1		0x0a
198 #define	TKEY_F2		0x0b
199 #define	TKEY_F3		0x0c
200 #define	TKEY_F4		0x0d
201 #define	TKEY_F5		0x0e
202 #define	TKEY_F6		0x0f
203 #define	TKEY_F7		0x10
204 #define	TKEY_F8		0x11
205 #define	TKEY_F9		0x12
206 #define	TKEY_F10	0x13
207 #define	TKEY_F11	0x14
208 #define	TKEY_F12	0x15
209 const char *teken_get_sequence(const teken_t *, unsigned int);
210 
211 /* Legacy features. */
212 void	teken_set_8bit(teken_t *);
213 void	teken_set_cons25(teken_t *);
214 void	teken_set_cons25keys(teken_t *);
215 
216 /* Color conversion. */
217 teken_color_t teken_256to16(teken_color_t);
218 teken_color_t teken_256to8(teken_color_t);
219 
220 #endif /* !_TEKEN_H_ */
221