teken.h revision 259016
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 259016 2013-12-05 22:38:53Z ray $ 27 */ 28 29#ifndef _TEKEN_H_ 30#define _TEKEN_H_ 31 32#include <sys/types.h> 33 34/* 35 * libteken: terminal emulation library. 36 * 37 * This library converts an UTF-8 stream of bytes to terminal drawing 38 * commands. 39 */ 40 41typedef uint32_t teken_char_t; 42typedef unsigned short teken_unit_t; 43typedef unsigned char teken_format_t; 44#define TF_BOLD 0x01 45#define TF_UNDERLINE 0x02 46#define TF_BLINK 0x04 47#define TF_REVERSE 0x08 48typedef unsigned char teken_color_t; 49#define TC_BLACK 0 50#define TC_RED 1 51#define TC_GREEN 2 52#define TC_BROWN 3 53#define TC_BLUE 4 54#define TC_MAGENTA 5 55#define TC_CYAN 6 56#define TC_WHITE 7 57#define TC_NCOLORS 8 58 59typedef struct { 60 teken_unit_t tp_row; 61 teken_unit_t tp_col; 62} teken_pos_t; 63typedef struct { 64 teken_pos_t tr_begin; 65 teken_pos_t tr_end; 66} teken_rect_t; 67typedef struct { 68 teken_format_t ta_format; 69 teken_color_t ta_fgcolor; 70 teken_color_t ta_bgcolor; 71} teken_attr_t; 72typedef struct { 73 teken_unit_t ts_begin; 74 teken_unit_t ts_end; 75} teken_span_t; 76 77typedef struct __teken teken_t; 78 79typedef void teken_state_t(teken_t *, teken_char_t); 80 81/* 82 * Drawing routines supplied by the user. 83 */ 84 85typedef void tf_bell_t(void *); 86typedef void tf_cursor_t(void *, const teken_pos_t *); 87typedef void tf_putchar_t(void *, const teken_pos_t *, teken_char_t, 88 const teken_attr_t *); 89typedef void tf_fill_t(void *, const teken_rect_t *, teken_char_t, 90 const teken_attr_t *); 91typedef void tf_copy_t(void *, const teken_rect_t *, const teken_pos_t *); 92typedef void tf_param_t(void *, int, unsigned int); 93#define TP_SHOWCURSOR 0 94#define TP_KEYPADAPP 1 95#define TP_AUTOREPEAT 2 96#define TP_SWITCHVT 3 97#define TP_132COLS 4 98#define TP_SETBELLPD 5 99#define TP_SETBELLPD_PITCH(pd) ((pd) >> 16) 100#define TP_SETBELLPD_DURATION(pd) ((pd) & 0xffff) 101#define TP_MOUSE 6 102typedef void tf_respond_t(void *, const void *, size_t); 103 104typedef struct { 105 tf_bell_t *tf_bell; 106 tf_cursor_t *tf_cursor; 107 tf_putchar_t *tf_putchar; 108 tf_fill_t *tf_fill; 109 tf_copy_t *tf_copy; 110 tf_param_t *tf_param; 111 tf_respond_t *tf_respond; 112} teken_funcs_t; 113 114typedef teken_char_t teken_scs_t(teken_t *, teken_char_t); 115 116/* 117 * Terminal state. 118 */ 119 120struct __teken { 121 const teken_funcs_t *t_funcs; 122 void *t_softc; 123 124 teken_state_t *t_nextstate; 125 unsigned int t_stateflags; 126 127#define T_NUMSIZE 8 128 unsigned int t_nums[T_NUMSIZE]; 129 unsigned int t_curnum; 130 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; 135 136 teken_attr_t t_defattr; 137 teken_pos_t t_winsize; 138 139 /* For DECSTBM. */ 140 teken_span_t t_scrollreg; 141 /* For DECOM. */ 142 teken_span_t t_originreg; 143 144#define T_NUMCOL 160 145 unsigned int t_tabstops[T_NUMCOL / (sizeof(unsigned int) * 8)]; 146 147 unsigned int t_utf8_left; 148 teken_char_t t_utf8_partial; 149 150 unsigned int t_curscs; 151 teken_scs_t *t_saved_curscs; 152 teken_scs_t *t_scs[2]; 153}; 154 155/* Initialize teken structure. */ 156void teken_init(teken_t *, const teken_funcs_t *, void *); 157 158/* Deliver character input. */ 159void teken_input(teken_t *, const void *, size_t); 160 161/* Get/set teken attributes. */ 162const teken_pos_t *teken_get_cursor(teken_t *); 163const teken_attr_t *teken_get_curattr(teken_t *); 164const teken_attr_t *teken_get_defattr(teken_t *); 165void teken_get_defattr_cons25(teken_t *, int *, int *); 166const teken_pos_t *teken_get_winsize(teken_t *); 167void teken_set_cursor(teken_t *, const teken_pos_t *); 168void teken_set_curattr(teken_t *, const teken_attr_t *); 169void teken_set_defattr(teken_t *, const teken_attr_t *); 170void teken_set_winsize(teken_t *, const teken_pos_t *); 171void teken_set_winsize_noreset(teken_t *, const teken_pos_t *); 172 173/* Key input escape sequences. */ 174#define TKEY_UP 0x00 175#define TKEY_DOWN 0x01 176#define TKEY_LEFT 0x02 177#define TKEY_RIGHT 0x03 178 179#define TKEY_HOME 0x04 180#define TKEY_END 0x05 181#define TKEY_INSERT 0x06 182#define TKEY_DELETE 0x07 183#define TKEY_PAGE_UP 0x08 184#define TKEY_PAGE_DOWN 0x09 185 186#define TKEY_F1 0x0a 187#define TKEY_F2 0x0b 188#define TKEY_F3 0x0c 189#define TKEY_F4 0x0d 190#define TKEY_F5 0x0e 191#define TKEY_F6 0x0f 192#define TKEY_F7 0x10 193#define TKEY_F8 0x11 194#define TKEY_F9 0x12 195#define TKEY_F10 0x13 196#define TKEY_F11 0x14 197#define TKEY_F12 0x15 198const char *teken_get_sequence(teken_t *, unsigned int); 199 200/* Legacy features. */ 201void teken_set_8bit(teken_t *); 202void teken_set_cons25(teken_t *); 203 204/* Color conversion. */ 205teken_color_t teken_256to8(teken_color_t); 206 207#endif /* !_TEKEN_H_ */ 208