teken.h revision 187367 
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/dev/syscons/teken/teken.h 187367 2009-01-17 16:37:13Z 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 * Configuration switches:
39 * - TEKEN_UTF8: Enable/disable UTF-8 handling.
40 * - TEKEN_XTERM: Enable xterm-style emulation, instead of cons25.
41 */
42
43#if defined(__FreeBSD__) && defined(_KERNEL)
44#include "opt_teken.h"
45#endif /* __FreeBSD__ && _KERNEL */
46
47#ifdef TEKEN_UTF8
48typedef uint32_t teken_char_t;
49#else /* !TEKEN_UTF8 */
50typedef unsigned char teken_char_t;
51#endif /* TEKEN_UTF8 */
52typedef unsigned short teken_unit_t;
53typedef unsigned char teken_format_t;
54#define	TF_BOLD		0x01
55#define	TF_UNDERLINE	0x02
56#define	TF_BLINK	0x04
57typedef unsigned char teken_color_t;
58#define	TC_BLACK	0
59#define	TC_RED		1
60#define	TC_GREEN	2
61#define	TC_BROWN	3
62#define	TC_BLUE		4
63#define	TC_MAGENTA	5
64#define	TC_CYAN		6
65#define	TC_WHITE	7
66#define	TC_NCOLORS	8
67
68typedef struct {
69	teken_unit_t	tp_row;
70	teken_unit_t	tp_col;
71} teken_pos_t;
72typedef struct {
73	teken_pos_t	tr_begin;
74	teken_pos_t	tr_end;
75} teken_rect_t;
76typedef struct {
77	teken_format_t	ta_format;
78	teken_color_t	ta_fgcolor;
79	teken_color_t	ta_bgcolor;
80} teken_attr_t;
81typedef struct {
82	teken_unit_t	ts_begin;
83	teken_unit_t	ts_end;
84} teken_span_t;
85
86typedef struct __teken teken_t;
87
88typedef void teken_state_t(teken_t *, teken_char_t);
89
90/*
91 * Drawing routines supplied by the user.
92 */
93
94typedef void tf_bell_t(void *);
95typedef void tf_cursor_t(void *, const teken_pos_t *);
96typedef void tf_putchar_t(void *, const teken_pos_t *, teken_char_t,
97    const teken_attr_t *);
98typedef void tf_fill_t(void *, const teken_rect_t *, teken_char_t,
99    const teken_attr_t *);
100typedef void tf_copy_t(void *, const teken_rect_t *, const teken_pos_t *);
101typedef void tf_param_t(void *, int, int);
102#define	TP_SHOWCURSOR	0
103#define	TP_CURSORKEYS	1
104#define	TP_KEYPADAPP	2
105#define	TP_AUTOREPEAT	3
106#define	TP_SWITCHVT	4
107#define	TP_132COLS	5
108typedef void tf_respond_t(void *, const void *, size_t);
109
110typedef struct {
111	tf_bell_t	*tf_bell;
112	tf_cursor_t	*tf_cursor;
113	tf_putchar_t	*tf_putchar;
114	tf_fill_t	*tf_fill;
115	tf_copy_t	*tf_copy;
116	tf_param_t	*tf_param;
117	tf_respond_t	*tf_respond;
118} teken_funcs_t;
119
120/*
121 * Terminal state.
122 */
123
124struct __teken {
125	const teken_funcs_t *t_funcs;
126	void		*t_softc;
127
128	teken_state_t	*t_nextstate;
129	unsigned int	 t_stateflags;
130
131#define T_NUMSIZE	8
132	unsigned int	 t_nums[T_NUMSIZE];
133	unsigned int	 t_curnum;
134
135	teken_pos_t	 t_cursor;
136	teken_attr_t	 t_curattr;
137	teken_pos_t	 t_saved_cursor;
138	teken_attr_t	 t_saved_curattr;
139
140	teken_attr_t	 t_defattr;
141	teken_pos_t	 t_winsize;
142
143	/* For DECSTBM. */
144	teken_span_t	 t_scrollreg;
145	/* For DECOM. */
146	teken_span_t	 t_originreg;
147
148#define	T_NUMCOL	160
149	unsigned int	t_tabstops[T_NUMCOL / (sizeof(unsigned int) * 8)];
150
151#ifdef TEKEN_UTF8
152	unsigned int	t_utf8_left;
153	teken_char_t	t_utf8_partial;
154#endif /* TEKEN_UTF8 */
155};
156
157/* Initialize teken structure. */
158void	teken_init(teken_t *, const teken_funcs_t *, void *);
159
160/* Deliver character input. */
161void	teken_input(teken_t *, const void *, size_t);
162
163/* Set teken attributes. */
164void	teken_set_cursor(teken_t *, const teken_pos_t *);
165void	teken_set_defattr(teken_t *, const teken_attr_t *);
166void	teken_set_winsize(teken_t *, const teken_pos_t *);
167
168#endif /* !_TEKEN_H_ */
169