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;
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 typedef unsigned char teken_color_t;
59 #define TC_LIGHT 8 /* ORed with the others. */
70 teken_format_t ta_format;
71 teken_color_t ta_fgcolor;
72 teken_color_t ta_bgcolor;
75 teken_unit_t ts_begin;
79 typedef struct __teken teken_t;
81 typedef void teken_state_t(teken_t *, teken_char_t);
84 * Drawing routines supplied by the user.
87 typedef void tf_bell_t(void *);
88 typedef void tf_cursor_t(void *, const teken_pos_t *);
89 typedef void tf_putchar_t(void *, const teken_pos_t *, teken_char_t,
90 const teken_attr_t *);
91 typedef void tf_fill_t(void *, const teken_rect_t *, teken_char_t,
92 const teken_attr_t *);
93 typedef void tf_copy_t(void *, const teken_rect_t *, const teken_pos_t *);
94 typedef void tf_param_t(void *, int, unsigned int);
95 #define TP_SHOWCURSOR 0
96 #define TP_KEYPADAPP 1
97 #define TP_AUTOREPEAT 2
100 #define TP_SETBELLPD 5
101 #define TP_SETBELLPD_PITCH(pd) ((pd) >> 16)
102 #define TP_SETBELLPD_DURATION(pd) ((pd) & 0xffff)
104 #define TP_SETBORDER 7
105 #define TP_SETLOCALCURSOR 8
106 #define TP_SETGLOBALCURSOR 9
107 typedef void tf_respond_t(void *, const void *, size_t);
111 tf_cursor_t *tf_cursor;
112 tf_putchar_t *tf_putchar;
115 tf_param_t *tf_param;
116 tf_respond_t *tf_respond;
119 typedef teken_char_t teken_scs_t(teken_t *, teken_char_t);
126 const teken_funcs_t *t_funcs;
129 teken_state_t *t_nextstate;
130 unsigned int t_stateflags;
133 unsigned int t_nums[T_NUMSIZE];
134 unsigned int t_curnum;
136 teken_pos_t t_cursor;
137 teken_attr_t t_curattr;
138 teken_pos_t t_saved_cursor;
139 teken_attr_t t_saved_curattr;
141 teken_attr_t t_defattr;
142 teken_pos_t t_winsize;
145 teken_span_t t_scrollreg;
147 teken_span_t t_originreg;
150 unsigned int t_tabstops[T_NUMCOL / (sizeof(unsigned int) * 8)];
152 unsigned int t_utf8_left;
153 teken_char_t t_utf8_partial;
155 unsigned int t_curscs;
156 teken_scs_t *t_saved_curscs;
157 teken_scs_t *t_scs[2];
160 /* Initialize teken structure. */
161 void teken_init(teken_t *, const teken_funcs_t *, void *);
163 /* Deliver character input. */
164 void teken_input(teken_t *, const void *, size_t);
166 /* Get/set teken attributes. */
167 const teken_pos_t *teken_get_cursor(teken_t *);
168 const teken_attr_t *teken_get_curattr(teken_t *);
169 const teken_attr_t *teken_get_defattr(teken_t *);
170 void teken_get_defattr_cons25(teken_t *, int *, int *);
171 const teken_pos_t *teken_get_winsize(teken_t *);
172 void teken_set_cursor(teken_t *, const teken_pos_t *);
173 void teken_set_curattr(teken_t *, const teken_attr_t *);
174 void teken_set_defattr(teken_t *, const teken_attr_t *);
175 void teken_set_winsize(teken_t *, const teken_pos_t *);
176 void teken_set_winsize_noreset(teken_t *, const teken_pos_t *);
178 /* Key input escape sequences. */
180 #define TKEY_DOWN 0x01
181 #define TKEY_LEFT 0x02
182 #define TKEY_RIGHT 0x03
184 #define TKEY_HOME 0x04
185 #define TKEY_END 0x05
186 #define TKEY_INSERT 0x06
187 #define TKEY_DELETE 0x07
188 #define TKEY_PAGE_UP 0x08
189 #define TKEY_PAGE_DOWN 0x09
200 #define TKEY_F10 0x13
201 #define TKEY_F11 0x14
202 #define TKEY_F12 0x15
203 const char *teken_get_sequence(teken_t *, unsigned int);
205 /* Legacy features. */
206 void teken_set_8bit(teken_t *);
207 void teken_set_cons25(teken_t *);
209 /* Color conversion. */
210 teken_color_t teken_256to16(teken_color_t);
211 teken_color_t teken_256to8(teken_color_t);
213 #endif /* !_TEKEN_H_ */