teken.h revision 186729
1178825Sdfr/*- 2178825Sdfr * Copyright (c) 2008-2009 Ed Schouten <ed@FreeBSD.org> 3178825Sdfr * All rights reserved. 4178825Sdfr * 5178825Sdfr * Redistribution and use in source and binary forms, with or without 6178825Sdfr * modification, are permitted provided that the following conditions 7178825Sdfr * are met: 8178825Sdfr * 1. Redistributions of source code must retain the above copyright 9178825Sdfr * notice, this list of conditions and the following disclaimer. 10178825Sdfr * 2. Redistributions in binary form must reproduce the above copyright 11178825Sdfr * notice, this list of conditions and the following disclaimer in the 12178825Sdfr * documentation and/or other materials provided with the distribution. 13178825Sdfr * 14178825Sdfr * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15178825Sdfr * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16178825Sdfr * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17178825Sdfr * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18178825Sdfr * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19178825Sdfr * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20178825Sdfr * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21178825Sdfr * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22178825Sdfr * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23178825Sdfr * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24178825Sdfr * SUCH DAMAGE. 25178825Sdfr * 26178825Sdfr * $FreeBSD: head/sys/dev/syscons/teken/teken.h 186729 2009-01-03 22:51:54Z ed $ 27178825Sdfr */ 28178825Sdfr 29178825Sdfr#ifndef _TEKEN_H_ 30178825Sdfr#define _TEKEN_H_ 31178825Sdfr 32178825Sdfr/* 33178825Sdfr * libteken: terminal emulation library. 34178825Sdfr * 35178825Sdfr * This library converts an UTF-8 stream of bytes to terminal drawing 36178825Sdfr * commands. It implements commands similar to xterm-color. 37178825Sdfr */ 38178825Sdfr 39178825Sdfr#if 0 40178825Sdfr/* 41178825Sdfr * XXX: Disable UTF-8 support for now. It requires UTF-8 keyboard input 42178825Sdfr * and rendering, which we do not yet support. 43178825Sdfr */ 44178825Sdfr#define TEKEN_UTF8 45178825Sdfr#endif 46178825Sdfr/* Emulate cons25-like behaviour. */ 47178825Sdfr#define TEKEN_CONS25 48178825Sdfr 49178825Sdfr#ifdef TEKEN_UTF8 50178825Sdfrtypedef uint32_t teken_char_t; 51178825Sdfr#else /* !TEKEN_UTF8 */ 52178825Sdfrtypedef unsigned char teken_char_t; 53178825Sdfr#endif /* TEKEN_UTF8 */ 54178825Sdfrtypedef unsigned short teken_unit_t; 55178825Sdfrtypedef unsigned char teken_format_t; 56178825Sdfr#define TF_BOLD 0x01 57178825Sdfr#define TF_UNDERLINE 0x02 58178825Sdfr#define TF_BLINK 0x04 59178825Sdfrtypedef unsigned char teken_color_t; 60178825Sdfr#define TC_BLACK 0 61178825Sdfr#define TC_RED 1 62178825Sdfr#define TC_GREEN 2 63178825Sdfr#define TC_BROWN 3 64178825Sdfr#define TC_BLUE 4 65178825Sdfr#define TC_MAGENTA 5 66178825Sdfr#define TC_CYAN 6 67178825Sdfr#define TC_WHITE 7 68178825Sdfr#define TC_NCOLORS 8 69178825Sdfr 70178825Sdfrtypedef struct { 71178825Sdfr teken_unit_t tp_row; 72178825Sdfr teken_unit_t tp_col; 73178825Sdfr} teken_pos_t; 74178825Sdfrtypedef struct { 75178825Sdfr teken_pos_t tr_begin; 76178825Sdfr teken_pos_t tr_end; 77178825Sdfr} teken_rect_t; 78178825Sdfrtypedef struct { 79178825Sdfr teken_format_t ta_format; 80178825Sdfr teken_color_t ta_fgcolor; 81178825Sdfr teken_color_t ta_bgcolor; 82178825Sdfr} teken_attr_t; 83178825Sdfrtypedef struct { 84178825Sdfr teken_unit_t ts_begin; 85178825Sdfr teken_unit_t ts_end; 86178825Sdfr} teken_span_t; 87178825Sdfr 88178825Sdfrtypedef struct __teken teken_t; 89178825Sdfr 90178825Sdfrtypedef void teken_state_t(teken_t *, teken_char_t); 91178825Sdfr 92178825Sdfr/* 93178825Sdfr * Drawing routines supplied by the user. 94178825Sdfr */ 95178825Sdfr 96178825Sdfrtypedef void tf_bell_t(void *); 97178825Sdfrtypedef void tf_cursor_t(void *, const teken_pos_t *); 98178825Sdfrtypedef void tf_putchar_t(void *, const teken_pos_t *, teken_char_t, 99178825Sdfr const teken_attr_t *); 100178825Sdfrtypedef void tf_fill_t(void *, const teken_rect_t *, teken_char_t, 101178825Sdfr const teken_attr_t *); 102178825Sdfrtypedef void tf_copy_t(void *, const teken_rect_t *, const teken_pos_t *); 103178825Sdfrtypedef void tf_param_t(void *, int, int); 104178825Sdfr#define TP_SHOWCURSOR 0 105178825Sdfr#define TP_CURSORKEYS 1 106178825Sdfr#define TP_KEYPADAPP 2 107#define TP_AUTOREPEAT 3 108#define TP_SWITCHVT 4 109#define TP_132COLS 5 110typedef void tf_respond_t(void *, const void *, size_t); 111 112typedef struct { 113 tf_bell_t *tf_bell; 114 tf_cursor_t *tf_cursor; 115 tf_putchar_t *tf_putchar; 116 tf_fill_t *tf_fill; 117 tf_copy_t *tf_copy; 118 tf_param_t *tf_param; 119 tf_respond_t *tf_respond; 120} teken_funcs_t; 121 122/* 123 * Terminal state. 124 */ 125 126struct __teken { 127 const teken_funcs_t *t_funcs; 128 void *t_softc; 129 130 teken_state_t *t_nextstate; 131 unsigned int t_stateflags; 132 133#define T_NUMSIZE 8 134 unsigned int t_nums[T_NUMSIZE]; 135 unsigned int t_curnum; 136 137 teken_pos_t t_cursor; 138 teken_attr_t t_curattr; 139 teken_pos_t t_saved_cursor; 140 teken_attr_t t_saved_curattr; 141 142 teken_attr_t t_defattr; 143 teken_pos_t t_winsize; 144 145 /* For DECSTBM. */ 146 teken_span_t t_scrollreg; 147 /* For DECOM. */ 148 teken_span_t t_originreg; 149 150#define T_NUMCOL 160 151 unsigned int t_tabstops[T_NUMCOL / (sizeof(unsigned int) * 8)]; 152 153#ifdef TEKEN_UTF8 154 unsigned int t_utf8_left; 155 teken_char_t t_utf8_partial; 156#endif /* TEKEN_UTF8 */ 157}; 158 159/* Initialize teken structure. */ 160void teken_init(teken_t *, const teken_funcs_t *, void *); 161 162/* Deliver character input. */ 163void teken_input(teken_t *, const void *, size_t); 164 165/* Set teken attributes. */ 166void teken_set_cursor(teken_t *, const teken_pos_t *); 167void teken_set_defattr(teken_t *, const teken_attr_t *); 168void teken_set_winsize(teken_t *, const teken_pos_t *); 169 170#endif /* !_TEKEN_H_ */ 171