teken.h revision 197117 
1/*-
2 * Copyright (c) 2008-2009 Ed Schouten <ed@FreeBSD.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 *
26 * $FreeBSD: head/sys/teken/teken.h 197117 2009-09-12 12:44:21Z ed $
27 */
28
29#ifndef _TEKEN_H_
30#define	_TEKEN_H_
31
32/*
33 * libteken: terminal emulation library.
34 *
35 * This library converts an UTF-8 stream of bytes to terminal drawing
36 * commands.
37 */
38
39typedef uint32_t teken_char_t;
40typedef unsigned short teken_unit_t;
41typedef unsigned char teken_format_t;
42#define	TF_BOLD		0x01
43#define	TF_UNDERLINE	0x02
44#define	TF_BLINK	0x04
45#define	TF_REVERSE	0x08
46typedef unsigned char teken_color_t;
47#define	TC_BLACK	0
48#define	TC_RED		1
49#define	TC_GREEN	2
50#define	TC_BROWN	3
51#define	TC_BLUE		4
52#define	TC_MAGENTA	5
53#define	TC_CYAN		6
54#define	TC_WHITE	7
55#define	TC_NCOLORS	8
56
57typedef struct {
58	teken_unit_t	tp_row;
59	teken_unit_t	tp_col;
60} teken_pos_t;
61typedef struct {
62	teken_pos_t	tr_begin;
63	teken_pos_t	tr_end;
64} teken_rect_t;
65typedef struct {
66	teken_format_t	ta_format;
67	teken_color_t	ta_fgcolor;
68	teken_color_t	ta_bgcolor;
69} teken_attr_t;
70typedef struct {
71	teken_unit_t	ts_begin;
72	teken_unit_t	ts_end;
73} teken_span_t;
74
75typedef struct __teken teken_t;
76
77typedef void teken_state_t(teken_t *, teken_char_t);
78
79/*
80 * Drawing routines supplied by the user.
81 */
82
83typedef void tf_bell_t(void *);
84typedef void tf_cursor_t(void *, const teken_pos_t *);
85typedef void tf_putchar_t(void *, const teken_pos_t *, teken_char_t,
86    const teken_attr_t *);
87typedef void tf_fill_t(void *, const teken_rect_t *, teken_char_t,
88    const teken_attr_t *);
89typedef void tf_copy_t(void *, const teken_rect_t *, const teken_pos_t *);
90typedef void tf_param_t(void *, int, unsigned int);
91#define	TP_SHOWCURSOR	0
92#define	TP_CURSORKEYS	1
93#define	TP_KEYPADAPP	2
94#define	TP_AUTOREPEAT	3
95#define	TP_SWITCHVT	4
96#define	TP_132COLS	5
97#define	TP_SETBELLPD	6
98#define	TP_SETBELLPD_PITCH(pd)		((pd) >> 16)
99#define	TP_SETBELLPD_DURATION(pd)	((pd) & 0xffff)
100typedef void tf_respond_t(void *, const void *, size_t);
101
102typedef struct {
103	tf_bell_t	*tf_bell;
104	tf_cursor_t	*tf_cursor;
105	tf_putchar_t	*tf_putchar;
106	tf_fill_t	*tf_fill;
107	tf_copy_t	*tf_copy;
108	tf_param_t	*tf_param;
109	tf_respond_t	*tf_respond;
110} teken_funcs_t;
111
112typedef teken_char_t teken_scs_t(teken_char_t);
113
114/*
115 * Terminal state.
116 */
117
118struct __teken {
119	const teken_funcs_t *t_funcs;
120	void		*t_softc;
121
122	teken_state_t	*t_nextstate;
123	unsigned int	 t_stateflags;
124
125#define T_NUMSIZE	8
126	unsigned int	 t_nums[T_NUMSIZE];
127	unsigned int	 t_curnum;
128
129	teken_pos_t	 t_cursor;
130	teken_attr_t	 t_curattr;
131	teken_pos_t	 t_saved_cursor;
132	teken_attr_t	 t_saved_curattr;
133
134	teken_attr_t	 t_defattr;
135	teken_pos_t	 t_winsize;
136
137	/* For DECSTBM. */
138	teken_span_t	 t_scrollreg;
139	/* For DECOM. */
140	teken_span_t	 t_originreg;
141
142#define	T_NUMCOL	160
143	unsigned int	 t_tabstops[T_NUMCOL / (sizeof(unsigned int) * 8)];
144
145	unsigned int	 t_utf8_left;
146	teken_char_t	 t_utf8_partial;
147
148	unsigned int	 t_curscs;
149	teken_scs_t	*t_saved_curscs;
150	teken_scs_t	*t_scs[2];
151};
152
153/* Initialize teken structure. */
154void	teken_init(teken_t *, const teken_funcs_t *, void *);
155
156/* Deliver character input. */
157void	teken_input(teken_t *, const void *, size_t);
158
159/* Get/set teken attributes. */
160const teken_pos_t *teken_get_cursor(teken_t *);
161const teken_attr_t *teken_get_curattr(teken_t *);
162const teken_attr_t *teken_get_defattr(teken_t *);
163void	teken_get_defattr_cons25(teken_t *, int *, int *);
164const teken_pos_t *teken_get_winsize(teken_t *);
165void	teken_set_cursor(teken_t *, const teken_pos_t *);
166void	teken_set_curattr(teken_t *, const teken_attr_t *);
167void	teken_set_defattr(teken_t *, const teken_attr_t *);
168void	teken_set_winsize(teken_t *, const teken_pos_t *);
169
170/* Legacy features. */
171void	teken_set_8bit(teken_t *);
172void	teken_set_cons25(teken_t *);
173
174#endif /* !_TEKEN_H_ */
175