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