teken.h revision 197115
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 197115 2009-09-12 10:34:34Z 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. 37187367Sed * 38187367Sed * Configuration switches: 39187367Sed * - TEKEN_XTERM: Enable xterm-style emulation, instead of cons25. 40186681Sed */ 41186681Sed 42187367Sed#if defined(__FreeBSD__) && defined(_KERNEL) 43187367Sed#include "opt_teken.h" 44187367Sed#endif /* __FreeBSD__ && _KERNEL */ 45186681Sed 46186681Sedtypedef uint32_t teken_char_t; 47186681Sedtypedef unsigned short teken_unit_t; 48186681Sedtypedef unsigned char teken_format_t; 49186681Sed#define TF_BOLD 0x01 50186681Sed#define TF_UNDERLINE 0x02 51186681Sed#define TF_BLINK 0x04 52196786Sed#define TF_REVERSE 0x08 53186681Sedtypedef unsigned char teken_color_t; 54186681Sed#define TC_BLACK 0 55186681Sed#define TC_RED 1 56186681Sed#define TC_GREEN 2 57186681Sed#define TC_BROWN 3 58186681Sed#define TC_BLUE 4 59186681Sed#define TC_MAGENTA 5 60186681Sed#define TC_CYAN 6 61186681Sed#define TC_WHITE 7 62186681Sed#define TC_NCOLORS 8 63186681Sed 64186681Sedtypedef struct { 65186681Sed teken_unit_t tp_row; 66186681Sed teken_unit_t tp_col; 67186681Sed} teken_pos_t; 68186681Sedtypedef struct { 69186681Sed teken_pos_t tr_begin; 70186681Sed teken_pos_t tr_end; 71186681Sed} teken_rect_t; 72186681Sedtypedef struct { 73186681Sed teken_format_t ta_format; 74186681Sed teken_color_t ta_fgcolor; 75186681Sed teken_color_t ta_bgcolor; 76186681Sed} teken_attr_t; 77186681Sedtypedef struct { 78186681Sed teken_unit_t ts_begin; 79186681Sed teken_unit_t ts_end; 80186681Sed} teken_span_t; 81186681Sed 82186681Sedtypedef struct __teken teken_t; 83186681Sed 84186681Sedtypedef void teken_state_t(teken_t *, teken_char_t); 85186681Sed 86186681Sed/* 87186681Sed * Drawing routines supplied by the user. 88186681Sed */ 89186681Sed 90186681Sedtypedef void tf_bell_t(void *); 91186681Sedtypedef void tf_cursor_t(void *, const teken_pos_t *); 92186681Sedtypedef void tf_putchar_t(void *, const teken_pos_t *, teken_char_t, 93186681Sed const teken_attr_t *); 94186681Sedtypedef void tf_fill_t(void *, const teken_rect_t *, teken_char_t, 95186681Sed const teken_attr_t *); 96186681Sedtypedef void tf_copy_t(void *, const teken_rect_t *, const teken_pos_t *); 97193184Sedtypedef void tf_param_t(void *, int, unsigned int); 98186681Sed#define TP_SHOWCURSOR 0 99186681Sed#define TP_CURSORKEYS 1 100186681Sed#define TP_KEYPADAPP 2 101186681Sed#define TP_AUTOREPEAT 3 102186681Sed#define TP_SWITCHVT 4 103186681Sed#define TP_132COLS 5 104193184Sed#define TP_SETBELLPD 6 105193184Sed#define TP_SETBELLPD_PITCH(pd) ((pd) >> 16) 106193184Sed#define TP_SETBELLPD_DURATION(pd) ((pd) & 0xffff) 107186681Sedtypedef void tf_respond_t(void *, const void *, size_t); 108186681Sed 109186681Sedtypedef struct { 110186681Sed tf_bell_t *tf_bell; 111186681Sed tf_cursor_t *tf_cursor; 112186681Sed tf_putchar_t *tf_putchar; 113186681Sed tf_fill_t *tf_fill; 114186681Sed tf_copy_t *tf_copy; 115186681Sed tf_param_t *tf_param; 116186681Sed tf_respond_t *tf_respond; 117186681Sed} teken_funcs_t; 118186681Sed 119197115Sed#ifdef TEKEN_XTERM 120187469Sedtypedef teken_char_t teken_scs_t(teken_char_t); 121197115Sed#endif /* TEKEN_XTERM */ 122187469Sed 123186681Sed/* 124186681Sed * Terminal state. 125186681Sed */ 126186681Sed 127186681Sedstruct __teken { 128186681Sed const teken_funcs_t *t_funcs; 129186681Sed void *t_softc; 130186681Sed 131186681Sed teken_state_t *t_nextstate; 132186681Sed unsigned int t_stateflags; 133186681Sed 134186681Sed#define T_NUMSIZE 8 135186681Sed unsigned int t_nums[T_NUMSIZE]; 136186681Sed unsigned int t_curnum; 137186681Sed 138186681Sed teken_pos_t t_cursor; 139186681Sed teken_attr_t t_curattr; 140186681Sed teken_pos_t t_saved_cursor; 141186681Sed teken_attr_t t_saved_curattr; 142186681Sed 143186681Sed teken_attr_t t_defattr; 144186681Sed teken_pos_t t_winsize; 145186681Sed 146186681Sed /* For DECSTBM. */ 147186681Sed teken_span_t t_scrollreg; 148186681Sed /* For DECOM. */ 149186681Sed teken_span_t t_originreg; 150186681Sed 151186681Sed#define T_NUMCOL 160 152187469Sed unsigned int t_tabstops[T_NUMCOL / (sizeof(unsigned int) * 8)]; 153186681Sed 154197115Sed int t_utf8_left; 155187469Sed teken_char_t t_utf8_partial; 156187469Sed 157197115Sed#ifdef TEKEN_XTERM 158187469Sed unsigned int t_curscs; 159187469Sed teken_scs_t *t_saved_curscs; 160187469Sed teken_scs_t *t_scs[2]; 161197115Sed#endif /* TEKEN_XTERM */ 162186681Sed}; 163186681Sed 164186681Sed/* Initialize teken structure. */ 165186681Sedvoid teken_init(teken_t *, const teken_funcs_t *, void *); 166186681Sed 167186681Sed/* Deliver character input. */ 168186681Sedvoid teken_input(teken_t *, const void *, size_t); 169186681Sed 170188391Sed/* Get/set teken attributes. */ 171188391Sedconst teken_attr_t *teken_get_curattr(teken_t *); 172188391Sedconst teken_attr_t *teken_get_defattr(teken_t *); 173186681Sedvoid teken_set_cursor(teken_t *, const teken_pos_t *); 174189617Sedvoid teken_set_curattr(teken_t *, const teken_attr_t *); 175186681Sedvoid teken_set_defattr(teken_t *, const teken_attr_t *); 176186681Sedvoid teken_set_winsize(teken_t *, const teken_pos_t *); 177186681Sed 178197115Sed/* Legacy features. */ 179197115Sedvoid teken_set_8bit(teken_t *); 180197115Sed 181186681Sed#endif /* !_TEKEN_H_ */ 182