2 * Copyright (c) 2008-2009 Ed Schouten <ed@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
32 #include <sys/types.h>
35 * libteken: terminal emulation library.
37 * This library converts an UTF-8 stream of bytes to terminal drawing
41 typedef uint32_t teken_char_t;
42 typedef unsigned short teken_unit_t;
43 typedef unsigned char teken_format_t;
45 #define TF_UNDERLINE 0x02
47 #define TF_REVERSE 0x08
48 typedef unsigned char teken_color_t;
68 teken_format_t ta_format;
69 teken_color_t ta_fgcolor;
70 teken_color_t ta_bgcolor;
73 teken_unit_t ts_begin;
77 typedef struct __teken teken_t;
79 typedef void teken_state_t(teken_t *, teken_char_t);
82 * Drawing routines supplied by the user.
85 typedef void tf_bell_t(void *);
86 typedef void tf_cursor_t(void *, const teken_pos_t *);
87 typedef void tf_putchar_t(void *, const teken_pos_t *, teken_char_t,
88 const teken_attr_t *);
89 typedef void tf_fill_t(void *, const teken_rect_t *, teken_char_t,
90 const teken_attr_t *);
91 typedef void tf_copy_t(void *, const teken_rect_t *, const teken_pos_t *);
92 typedef void tf_param_t(void *, int, unsigned int);
93 #define TP_SHOWCURSOR 0
94 #define TP_KEYPADAPP 1
95 #define TP_AUTOREPEAT 2
98 #define TP_SETBELLPD 5
99 #define TP_SETBELLPD_PITCH(pd) ((pd) >> 16)
100 #define TP_SETBELLPD_DURATION(pd) ((pd) & 0xffff)
102 typedef void tf_respond_t(void *, const void *, size_t);
106 tf_cursor_t *tf_cursor;
107 tf_putchar_t *tf_putchar;
110 tf_param_t *tf_param;
111 tf_respond_t *tf_respond;
114 typedef teken_char_t teken_scs_t(teken_t *, teken_char_t);
121 const teken_funcs_t *t_funcs;
124 teken_state_t *t_nextstate;
125 unsigned int t_stateflags;
128 unsigned int t_nums[T_NUMSIZE];
129 unsigned int t_curnum;
131 teken_pos_t t_cursor;
132 teken_attr_t t_curattr;
133 teken_pos_t t_saved_cursor;
134 teken_attr_t t_saved_curattr;
136 teken_attr_t t_defattr;
137 teken_pos_t t_winsize;
140 teken_span_t t_scrollreg;
142 teken_span_t t_originreg;
145 unsigned int t_tabstops[T_NUMCOL / (sizeof(unsigned int) * 8)];
147 unsigned int t_utf8_left;
148 teken_char_t t_utf8_partial;
150 unsigned int t_curscs;
151 teken_scs_t *t_saved_curscs;
152 teken_scs_t *t_scs[2];
155 /* Initialize teken structure. */
156 void teken_init(teken_t *, const teken_funcs_t *, void *);
158 /* Deliver character input. */
159 void teken_input(teken_t *, const void *, size_t);
161 /* Get/set teken attributes. */
162 const teken_pos_t *teken_get_cursor(teken_t *);
163 const teken_attr_t *teken_get_curattr(teken_t *);
164 const teken_attr_t *teken_get_defattr(teken_t *);
165 void teken_get_defattr_cons25(teken_t *, int *, int *);
166 const teken_pos_t *teken_get_winsize(teken_t *);
167 void teken_set_cursor(teken_t *, const teken_pos_t *);
168 void teken_set_curattr(teken_t *, const teken_attr_t *);
169 void teken_set_defattr(teken_t *, const teken_attr_t *);
170 void teken_set_winsize(teken_t *, const teken_pos_t *);
172 /* Key input escape sequences. */
174 #define TKEY_DOWN 0x01
175 #define TKEY_LEFT 0x02
176 #define TKEY_RIGHT 0x03
178 #define TKEY_HOME 0x04
179 #define TKEY_END 0x05
180 #define TKEY_INSERT 0x06
181 #define TKEY_DELETE 0x07
182 #define TKEY_PAGE_UP 0x08
183 #define TKEY_PAGE_DOWN 0x09
194 #define TKEY_F10 0x13
195 #define TKEY_F11 0x14
196 #define TKEY_F12 0x15
197 const char *teken_get_sequence(teken_t *, unsigned int);
199 /* Legacy features. */
200 void teken_set_8bit(teken_t *);
201 void teken_set_cons25(teken_t *);
203 /* Color conversion. */
204 teken_color_t teken_256to8(teken_color_t);
206 #endif /* !_TEKEN_H_ */