teken.h revision 197522
1186681Sed/*- 2186681Sed * Copyright (c) 2008-2009 Ed Schouten <ed@FreeBSD.org> 3186681Sed * All rights reserved. 4186681Sed * 5186681Sed * Redistribution and use in source and binary forms, with or without 6186681Sed * modification, are permitted provided that the following conditions 7186681Sed * are met: 8186681Sed * 1. Redistributions of source code must retain the above copyright 9186681Sed * notice, this list of conditions and the following disclaimer. 10186681Sed * 2. Redistributions in binary form must reproduce the above copyright 11186681Sed * notice, this list of conditions and the following disclaimer in the 12186681Sed * documentation and/or other materials provided with the distribution. 13186681Sed * 14186681Sed * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15186681Sed * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16186681Sed * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17186681Sed * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18186681Sed * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19186681Sed * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20186681Sed * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21186681Sed * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22186681Sed * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23186681Sed * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24186681Sed * SUCH DAMAGE. 25186681Sed * 26186681Sed * $FreeBSD: head/sys/teken/teken.h 197522 2009-09-26 15:26:32Z ed $ 27186681Sed */ 28186681Sed 29186681Sed#ifndef _TEKEN_H_ 30186681Sed#define _TEKEN_H_ 31186681Sed 32186681Sed/* 33186681Sed * libteken: terminal emulation library. 34186681Sed * 35186681Sed * This library converts an UTF-8 stream of bytes to terminal drawing 36187367Sed * commands. 37186681Sed */ 38186681Sed 39186681Sedtypedef uint32_t teken_char_t; 40186681Sedtypedef unsigned short teken_unit_t; 41186681Sedtypedef unsigned char teken_format_t; 42186681Sed#define TF_BOLD 0x01 43186681Sed#define TF_UNDERLINE 0x02 44186681Sed#define TF_BLINK 0x04 45196786Sed#define TF_REVERSE 0x08 46186681Sedtypedef unsigned char teken_color_t; 47186681Sed#define TC_BLACK 0 48186681Sed#define TC_RED 1 49186681Sed#define TC_GREEN 2 50186681Sed#define TC_BROWN 3 51186681Sed#define TC_BLUE 4 52186681Sed#define TC_MAGENTA 5 53186681Sed#define TC_CYAN 6 54186681Sed#define TC_WHITE 7 55186681Sed#define TC_NCOLORS 8 56186681Sed 57186681Sedtypedef struct { 58186681Sed teken_unit_t tp_row; 59186681Sed teken_unit_t tp_col; 60186681Sed} teken_pos_t; 61186681Sedtypedef struct { 62186681Sed teken_pos_t tr_begin; 63186681Sed teken_pos_t tr_end; 64186681Sed} teken_rect_t; 65186681Sedtypedef struct { 66186681Sed teken_format_t ta_format; 67186681Sed teken_color_t ta_fgcolor; 68186681Sed teken_color_t ta_bgcolor; 69186681Sed} teken_attr_t; 70186681Sedtypedef struct { 71186681Sed teken_unit_t ts_begin; 72186681Sed teken_unit_t ts_end; 73186681Sed} teken_span_t; 74186681Sed 75186681Sedtypedef struct __teken teken_t; 76186681Sed 77186681Sedtypedef void teken_state_t(teken_t *, teken_char_t); 78186681Sed 79186681Sed/* 80186681Sed * Drawing routines supplied by the user. 81186681Sed */ 82186681Sed 83186681Sedtypedef void tf_bell_t(void *); 84186681Sedtypedef void tf_cursor_t(void *, const teken_pos_t *); 85186681Sedtypedef void tf_putchar_t(void *, const teken_pos_t *, teken_char_t, 86186681Sed const teken_attr_t *); 87186681Sedtypedef void tf_fill_t(void *, const teken_rect_t *, teken_char_t, 88186681Sed const teken_attr_t *); 89186681Sedtypedef void tf_copy_t(void *, const teken_rect_t *, const teken_pos_t *); 90193184Sedtypedef void tf_param_t(void *, int, unsigned int); 91186681Sed#define TP_SHOWCURSOR 0 92186681Sed#define TP_CURSORKEYS 1 93186681Sed#define TP_KEYPADAPP 2 94186681Sed#define TP_AUTOREPEAT 3 95186681Sed#define TP_SWITCHVT 4 96186681Sed#define TP_132COLS 5 97193184Sed#define TP_SETBELLPD 6 98193184Sed#define TP_SETBELLPD_PITCH(pd) ((pd) >> 16) 99193184Sed#define TP_SETBELLPD_DURATION(pd) ((pd) & 0xffff) 100186681Sedtypedef void tf_respond_t(void *, const void *, size_t); 101186681Sed 102186681Sedtypedef struct { 103186681Sed tf_bell_t *tf_bell; 104186681Sed tf_cursor_t *tf_cursor; 105186681Sed tf_putchar_t *tf_putchar; 106186681Sed tf_fill_t *tf_fill; 107186681Sed tf_copy_t *tf_copy; 108186681Sed tf_param_t *tf_param; 109186681Sed tf_respond_t *tf_respond; 110186681Sed} teken_funcs_t; 111186681Sed 112197470Sedtypedef teken_char_t teken_scs_t(teken_t *, teken_char_t); 113187469Sed 114186681Sed/* 115186681Sed * Terminal state. 116186681Sed */ 117186681Sed 118186681Sedstruct __teken { 119186681Sed const teken_funcs_t *t_funcs; 120186681Sed void *t_softc; 121186681Sed 122186681Sed teken_state_t *t_nextstate; 123186681Sed unsigned int t_stateflags; 124186681Sed 125186681Sed#define T_NUMSIZE 8 126186681Sed unsigned int t_nums[T_NUMSIZE]; 127186681Sed unsigned int t_curnum; 128186681Sed 129186681Sed teken_pos_t t_cursor; 130186681Sed teken_attr_t t_curattr; 131186681Sed teken_pos_t t_saved_cursor; 132186681Sed teken_attr_t t_saved_curattr; 133186681Sed 134186681Sed teken_attr_t t_defattr; 135186681Sed teken_pos_t t_winsize; 136186681Sed 137186681Sed /* For DECSTBM. */ 138186681Sed teken_span_t t_scrollreg; 139186681Sed /* For DECOM. */ 140186681Sed teken_span_t t_originreg; 141186681Sed 142186681Sed#define T_NUMCOL 160 143187469Sed unsigned int t_tabstops[T_NUMCOL / (sizeof(unsigned int) * 8)]; 144186681Sed 145197117Sed unsigned int t_utf8_left; 146187469Sed teken_char_t t_utf8_partial; 147187469Sed 148187469Sed unsigned int t_curscs; 149187469Sed teken_scs_t *t_saved_curscs; 150187469Sed teken_scs_t *t_scs[2]; 151186681Sed}; 152186681Sed 153186681Sed/* Initialize teken structure. */ 154186681Sedvoid teken_init(teken_t *, const teken_funcs_t *, void *); 155186681Sed 156186681Sed/* Deliver character input. */ 157186681Sedvoid teken_input(teken_t *, const void *, size_t); 158186681Sed 159188391Sed/* Get/set teken attributes. */ 160197117Sedconst teken_pos_t *teken_get_cursor(teken_t *); 161188391Sedconst teken_attr_t *teken_get_curattr(teken_t *); 162188391Sedconst teken_attr_t *teken_get_defattr(teken_t *); 163197117Sedvoid teken_get_defattr_cons25(teken_t *, int *, int *); 164197117Sedconst teken_pos_t *teken_get_winsize(teken_t *); 165186681Sedvoid teken_set_cursor(teken_t *, const teken_pos_t *); 166189617Sedvoid teken_set_curattr(teken_t *, const teken_attr_t *); 167186681Sedvoid teken_set_defattr(teken_t *, const teken_attr_t *); 168186681Sedvoid teken_set_winsize(teken_t *, const teken_pos_t *); 169186681Sed 170197115Sed/* Legacy features. */ 171197115Sedvoid teken_set_8bit(teken_t *); 172197117Sedvoid teken_set_cons25(teken_t *); 173197115Sed 174197522Sed/* Color conversion. */ 175197522Sedteken_color_t teken_256to8(teken_color_t); 176197522Sed 177186681Sed#endif /* !_TEKEN_H_ */ 178