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$ 27186681Sed */ 28186681Sed 29186681Sed#ifndef _TEKEN_H_ 30186681Sed#define _TEKEN_H_ 31186681Sed 32221698Sed#include <sys/types.h> 33221698Sed 34186681Sed/* 35186681Sed * libteken: terminal emulation library. 36186681Sed * 37186681Sed * This library converts an UTF-8 stream of bytes to terminal drawing 38187367Sed * commands. 39186681Sed */ 40186681Sed 41186681Sedtypedef uint32_t teken_char_t; 42186681Sedtypedef unsigned short teken_unit_t; 43186681Sedtypedef unsigned char teken_format_t; 44263817Sray#define TF_BOLD 0x01 /* Bold character. */ 45263817Sray#define TF_UNDERLINE 0x02 /* Underline character. */ 46263817Sray#define TF_BLINK 0x04 /* Blinking character. */ 47263817Sray#define TF_REVERSE 0x08 /* Reverse rendered character. */ 48263817Sray#define TF_CJK_RIGHT 0x10 /* Right-hand side of CJK character. */ 49186681Sedtypedef unsigned char teken_color_t; 50186681Sed#define TC_BLACK 0 51186681Sed#define TC_RED 1 52186681Sed#define TC_GREEN 2 53186681Sed#define TC_BROWN 3 54186681Sed#define TC_BLUE 4 55186681Sed#define TC_MAGENTA 5 56186681Sed#define TC_CYAN 6 57186681Sed#define TC_WHITE 7 58186681Sed#define TC_NCOLORS 8 59186681Sed 60186681Sedtypedef struct { 61186681Sed teken_unit_t tp_row; 62186681Sed teken_unit_t tp_col; 63186681Sed} teken_pos_t; 64186681Sedtypedef struct { 65186681Sed teken_pos_t tr_begin; 66186681Sed teken_pos_t tr_end; 67186681Sed} teken_rect_t; 68186681Sedtypedef struct { 69186681Sed teken_format_t ta_format; 70186681Sed teken_color_t ta_fgcolor; 71186681Sed teken_color_t ta_bgcolor; 72186681Sed} teken_attr_t; 73186681Sedtypedef struct { 74186681Sed teken_unit_t ts_begin; 75186681Sed teken_unit_t ts_end; 76186681Sed} teken_span_t; 77186681Sed 78186681Sedtypedef struct __teken teken_t; 79186681Sed 80186681Sedtypedef void teken_state_t(teken_t *, teken_char_t); 81186681Sed 82186681Sed/* 83186681Sed * Drawing routines supplied by the user. 84186681Sed */ 85186681Sed 86186681Sedtypedef void tf_bell_t(void *); 87186681Sedtypedef void tf_cursor_t(void *, const teken_pos_t *); 88186681Sedtypedef void tf_putchar_t(void *, const teken_pos_t *, teken_char_t, 89186681Sed const teken_attr_t *); 90186681Sedtypedef void tf_fill_t(void *, const teken_rect_t *, teken_char_t, 91186681Sed const teken_attr_t *); 92186681Sedtypedef void tf_copy_t(void *, const teken_rect_t *, const teken_pos_t *); 93193184Sedtypedef void tf_param_t(void *, int, unsigned int); 94186681Sed#define TP_SHOWCURSOR 0 95199171Sed#define TP_KEYPADAPP 1 96199171Sed#define TP_AUTOREPEAT 2 97199171Sed#define TP_SWITCHVT 3 98199171Sed#define TP_132COLS 4 99199171Sed#define TP_SETBELLPD 5 100193184Sed#define TP_SETBELLPD_PITCH(pd) ((pd) >> 16) 101193184Sed#define TP_SETBELLPD_DURATION(pd) ((pd) & 0xffff) 102199171Sed#define TP_MOUSE 6 103186681Sedtypedef void tf_respond_t(void *, const void *, size_t); 104186681Sed 105186681Sedtypedef struct { 106186681Sed tf_bell_t *tf_bell; 107186681Sed tf_cursor_t *tf_cursor; 108186681Sed tf_putchar_t *tf_putchar; 109186681Sed tf_fill_t *tf_fill; 110186681Sed tf_copy_t *tf_copy; 111186681Sed tf_param_t *tf_param; 112186681Sed tf_respond_t *tf_respond; 113186681Sed} teken_funcs_t; 114186681Sed 115197470Sedtypedef teken_char_t teken_scs_t(teken_t *, teken_char_t); 116187469Sed 117186681Sed/* 118186681Sed * Terminal state. 119186681Sed */ 120186681Sed 121186681Sedstruct __teken { 122186681Sed const teken_funcs_t *t_funcs; 123186681Sed void *t_softc; 124186681Sed 125186681Sed teken_state_t *t_nextstate; 126186681Sed unsigned int t_stateflags; 127186681Sed 128186681Sed#define T_NUMSIZE 8 129186681Sed unsigned int t_nums[T_NUMSIZE]; 130186681Sed unsigned int t_curnum; 131186681Sed 132186681Sed teken_pos_t t_cursor; 133186681Sed teken_attr_t t_curattr; 134186681Sed teken_pos_t t_saved_cursor; 135186681Sed teken_attr_t t_saved_curattr; 136186681Sed 137186681Sed teken_attr_t t_defattr; 138186681Sed teken_pos_t t_winsize; 139186681Sed 140186681Sed /* For DECSTBM. */ 141186681Sed teken_span_t t_scrollreg; 142186681Sed /* For DECOM. */ 143186681Sed teken_span_t t_originreg; 144186681Sed 145186681Sed#define T_NUMCOL 160 146187469Sed unsigned int t_tabstops[T_NUMCOL / (sizeof(unsigned int) * 8)]; 147186681Sed 148197117Sed unsigned int t_utf8_left; 149187469Sed teken_char_t t_utf8_partial; 150187469Sed 151187469Sed unsigned int t_curscs; 152187469Sed teken_scs_t *t_saved_curscs; 153187469Sed teken_scs_t *t_scs[2]; 154186681Sed}; 155186681Sed 156186681Sed/* Initialize teken structure. */ 157186681Sedvoid teken_init(teken_t *, const teken_funcs_t *, void *); 158186681Sed 159186681Sed/* Deliver character input. */ 160186681Sedvoid teken_input(teken_t *, const void *, size_t); 161186681Sed 162188391Sed/* Get/set teken attributes. */ 163197117Sedconst teken_pos_t *teken_get_cursor(teken_t *); 164188391Sedconst teken_attr_t *teken_get_curattr(teken_t *); 165188391Sedconst teken_attr_t *teken_get_defattr(teken_t *); 166197117Sedvoid teken_get_defattr_cons25(teken_t *, int *, int *); 167197117Sedconst teken_pos_t *teken_get_winsize(teken_t *); 168186681Sedvoid teken_set_cursor(teken_t *, const teken_pos_t *); 169189617Sedvoid teken_set_curattr(teken_t *, const teken_attr_t *); 170186681Sedvoid teken_set_defattr(teken_t *, const teken_attr_t *); 171186681Sedvoid teken_set_winsize(teken_t *, const teken_pos_t *); 172263817Srayvoid teken_set_winsize_noreset(teken_t *, const teken_pos_t *); 173186681Sed 174199171Sed/* Key input escape sequences. */ 175199171Sed#define TKEY_UP 0x00 176199171Sed#define TKEY_DOWN 0x01 177199171Sed#define TKEY_LEFT 0x02 178199171Sed#define TKEY_RIGHT 0x03 179199171Sed 180199175Sed#define TKEY_HOME 0x04 181199175Sed#define TKEY_END 0x05 182199175Sed#define TKEY_INSERT 0x06 183199175Sed#define TKEY_DELETE 0x07 184199171Sed#define TKEY_PAGE_UP 0x08 185199171Sed#define TKEY_PAGE_DOWN 0x09 186199171Sed 187199171Sed#define TKEY_F1 0x0a 188199171Sed#define TKEY_F2 0x0b 189199171Sed#define TKEY_F3 0x0c 190199171Sed#define TKEY_F4 0x0d 191199171Sed#define TKEY_F5 0x0e 192199171Sed#define TKEY_F6 0x0f 193199171Sed#define TKEY_F7 0x10 194199171Sed#define TKEY_F8 0x11 195199171Sed#define TKEY_F9 0x12 196199171Sed#define TKEY_F10 0x13 197199171Sed#define TKEY_F11 0x14 198199171Sed#define TKEY_F12 0x15 199199171Sedconst char *teken_get_sequence(teken_t *, unsigned int); 200199171Sed 201197115Sed/* Legacy features. */ 202197115Sedvoid teken_set_8bit(teken_t *); 203197117Sedvoid teken_set_cons25(teken_t *); 204197115Sed 205197522Sed/* Color conversion. */ 206197522Sedteken_color_t teken_256to8(teken_color_t); 207197522Sed 208186681Sed#endif /* !_TEKEN_H_ */ 209