1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2008-2009 Ed Schouten <ed@FreeBSD.org> 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * $FreeBSD$ 29 */ 30 31 #ifndef _TEKEN_H_ 32 #define _TEKEN_H_ 33 34 #include <sys/types.h> 35 36 /* 37 * libteken: terminal emulation library. 38 * 39 * This library converts an UTF-8 stream of bytes to terminal drawing 40 * commands. 41 */ 42 43 typedef uint32_t teken_char_t; 44 typedef unsigned short teken_unit_t; 45 typedef unsigned char teken_format_t; 46 #define TF_BOLD 0x01 /* Bold character. */ 47 #define TF_UNDERLINE 0x02 /* Underline character. */ 48 #define TF_BLINK 0x04 /* Blinking character. */ 49 #define TF_REVERSE 0x08 /* Reverse rendered character. */ 50 #define TF_CJK_RIGHT 0x10 /* Right-hand side of CJK character. */ 51 typedef unsigned char teken_color_t; 52 #define TC_BLACK 0 53 #define TC_RED 1 54 #define TC_GREEN 2 55 #define TC_BROWN 3 56 #define TC_BLUE 4 57 #define TC_MAGENTA 5 58 #define TC_CYAN 6 59 #define TC_WHITE 7 60 #define TC_NCOLORS 8 61 #define TC_LIGHT 8 /* ORed with the others. */ 62 63 typedef struct { 64 teken_unit_t tp_row; 65 teken_unit_t tp_col; 66 } teken_pos_t; 67 typedef struct { 68 teken_pos_t tr_begin; 69 teken_pos_t tr_end; 70 } teken_rect_t; 71 typedef struct { 72 teken_format_t ta_format; 73 teken_color_t ta_fgcolor; 74 teken_color_t ta_bgcolor; 75 } teken_attr_t; 76 typedef struct { 77 teken_unit_t ts_begin; 78 teken_unit_t ts_end; 79 } teken_span_t; 80 81 typedef struct __teken teken_t; 82 83 typedef void teken_state_t(teken_t *, teken_char_t); 84 85 /* 86 * Drawing routines supplied by the user. 87 */ 88 89 typedef void tf_bell_t(void *); 90 typedef void tf_cursor_t(void *, const teken_pos_t *); 91 typedef void tf_putchar_t(void *, const teken_pos_t *, teken_char_t, 92 const teken_attr_t *); 93 typedef void tf_fill_t(void *, const teken_rect_t *, teken_char_t, 94 const teken_attr_t *); 95 typedef void tf_copy_t(void *, const teken_rect_t *, const teken_pos_t *); 96 typedef void tf_pre_input_t(void *); 97 typedef void tf_post_input_t(void *); 98 typedef void tf_param_t(void *, int, unsigned int); 99 #define TP_SHOWCURSOR 0 100 #define TP_KEYPADAPP 1 101 #define TP_AUTOREPEAT 2 102 #define TP_SWITCHVT 3 103 #define TP_132COLS 4 104 #define TP_SETBELLPD 5 105 #define TP_SETBELLPD_PITCH(pd) ((pd) >> 16) 106 #define TP_SETBELLPD_DURATION(pd) ((pd) & 0xffff) 107 #define TP_MOUSE 6 108 #define TP_SETBORDER 7 109 #define TP_SETLOCALCURSOR 8 110 #define TP_SETGLOBALCURSOR 9 111 typedef void tf_respond_t(void *, const void *, size_t); 112 113 typedef struct { 114 tf_bell_t *tf_bell; 115 tf_cursor_t *tf_cursor; 116 tf_putchar_t *tf_putchar; 117 tf_fill_t *tf_fill; 118 tf_copy_t *tf_copy; 119 tf_pre_input_t *tf_pre_input; 120 tf_post_input_t *tf_post_input; 121 tf_param_t *tf_param; 122 tf_respond_t *tf_respond; 123 } teken_funcs_t; 124 125 typedef teken_char_t teken_scs_t(const teken_t *, teken_char_t); 126 127 /* 128 * Terminal state. 129 */ 130 131 struct __teken { 132 const teken_funcs_t *t_funcs; 133 void *t_softc; 134 135 teken_state_t *t_nextstate; 136 unsigned int t_stateflags; 137 138 #define T_NUMSIZE 8 139 unsigned int t_nums[T_NUMSIZE]; 140 unsigned int t_curnum; 141 142 teken_pos_t t_cursor; 143 teken_attr_t t_curattr; 144 teken_pos_t t_saved_cursor; 145 teken_attr_t t_saved_curattr; 146 147 teken_attr_t t_defattr; 148 teken_pos_t t_winsize; 149 150 /* For DECSTBM. */ 151 teken_span_t t_scrollreg; 152 /* For DECOM. */ 153 teken_span_t t_originreg; 154 155 #define T_NUMCOL 160 156 unsigned int t_tabstops[T_NUMCOL / (sizeof(unsigned int) * 8)]; 157 158 unsigned int t_utf8_left; 159 teken_char_t t_utf8_partial; 160 161 unsigned int t_curscs; 162 teken_scs_t *t_saved_curscs; 163 teken_scs_t *t_scs[2]; 164 }; 165 166 /* Initialize teken structure. */ 167 void teken_init(teken_t *, const teken_funcs_t *, void *); 168 169 /* Deliver character input. */ 170 void teken_input(teken_t *, const void *, size_t); 171 172 /* Get/set teken attributes. */ 173 const teken_pos_t *teken_get_cursor(const teken_t *); 174 const teken_attr_t *teken_get_curattr(const teken_t *); 175 const teken_attr_t *teken_get_defattr(const teken_t *); 176 void teken_get_defattr_cons25(const teken_t *, int *, int *); 177 const teken_pos_t *teken_get_winsize(const teken_t *); 178 void teken_set_cursor(teken_t *, const teken_pos_t *); 179 void teken_set_curattr(teken_t *, const teken_attr_t *); 180 void teken_set_defattr(teken_t *, const teken_attr_t *); 181 void teken_set_winsize(teken_t *, const teken_pos_t *); 182 void teken_set_winsize_noreset(teken_t *, const teken_pos_t *); 183 184 /* Key input escape sequences. */ 185 #define TKEY_UP 0x00 186 #define TKEY_DOWN 0x01 187 #define TKEY_LEFT 0x02 188 #define TKEY_RIGHT 0x03 189 190 #define TKEY_HOME 0x04 191 #define TKEY_END 0x05 192 #define TKEY_INSERT 0x06 193 #define TKEY_DELETE 0x07 194 #define TKEY_PAGE_UP 0x08 195 #define TKEY_PAGE_DOWN 0x09 196 197 #define TKEY_F1 0x0a 198 #define TKEY_F2 0x0b 199 #define TKEY_F3 0x0c 200 #define TKEY_F4 0x0d 201 #define TKEY_F5 0x0e 202 #define TKEY_F6 0x0f 203 #define TKEY_F7 0x10 204 #define TKEY_F8 0x11 205 #define TKEY_F9 0x12 206 #define TKEY_F10 0x13 207 #define TKEY_F11 0x14 208 #define TKEY_F12 0x15 209 const char *teken_get_sequence(const teken_t *, unsigned int); 210 211 /* Legacy features. */ 212 void teken_set_8bit(teken_t *); 213 void teken_set_cons25(teken_t *); 214 215 /* Color conversion. */ 216 teken_color_t teken_256to16(teken_color_t); 217 teken_color_t teken_256to8(teken_color_t); 218 219 #endif /* !_TEKEN_H_ */ 220