teken.h revision 186729
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/dev/syscons/teken/teken.h 186729 2009-01-03 22:51:54Z ed $ 27 */ 28 29#ifndef _TEKEN_H_ 30#define _TEKEN_H_ 31 32/* 33 * libteken: terminal emulation library. 34 * 35 * This library converts an UTF-8 stream of bytes to terminal drawing 36 * commands. It implements commands similar to xterm-color. 37 */ 38 39#if 0 40/* 41 * XXX: Disable UTF-8 support for now. It requires UTF-8 keyboard input 42 * and rendering, which we do not yet support. 43 */ 44#define TEKEN_UTF8 45#endif 46/* Emulate cons25-like behaviour. */ 47#define TEKEN_CONS25 48 49#ifdef TEKEN_UTF8 50typedef uint32_t teken_char_t; 51#else /* !TEKEN_UTF8 */ 52typedef unsigned char teken_char_t; 53#endif /* TEKEN_UTF8 */ 54typedef unsigned short teken_unit_t; 55typedef unsigned char teken_format_t; 56#define TF_BOLD 0x01 57#define TF_UNDERLINE 0x02 58#define TF_BLINK 0x04 59typedef unsigned char teken_color_t; 60#define TC_BLACK 0 61#define TC_RED 1 62#define TC_GREEN 2 63#define TC_BROWN 3 64#define TC_BLUE 4 65#define TC_MAGENTA 5 66#define TC_CYAN 6 67#define TC_WHITE 7 68#define TC_NCOLORS 8 69 70typedef struct { 71 teken_unit_t tp_row; 72 teken_unit_t tp_col; 73} teken_pos_t; 74typedef struct { 75 teken_pos_t tr_begin; 76 teken_pos_t tr_end; 77} teken_rect_t; 78typedef struct { 79 teken_format_t ta_format; 80 teken_color_t ta_fgcolor; 81 teken_color_t ta_bgcolor; 82} teken_attr_t; 83typedef struct { 84 teken_unit_t ts_begin; 85 teken_unit_t ts_end; 86} teken_span_t; 87 88typedef struct __teken teken_t; 89 90typedef void teken_state_t(teken_t *, teken_char_t); 91 92/* 93 * Drawing routines supplied by the user. 94 */ 95 96typedef void tf_bell_t(void *); 97typedef void tf_cursor_t(void *, const teken_pos_t *); 98typedef void tf_putchar_t(void *, const teken_pos_t *, teken_char_t, 99 const teken_attr_t *); 100typedef void tf_fill_t(void *, const teken_rect_t *, teken_char_t, 101 const teken_attr_t *); 102typedef void tf_copy_t(void *, const teken_rect_t *, const teken_pos_t *); 103typedef void tf_param_t(void *, int, int); 104#define TP_SHOWCURSOR 0 105#define TP_CURSORKEYS 1 106#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