sys/teken/teken.h

   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$
  27  */
  28
  29 #ifndef _TEKEN_H_
  30 #define _TEKEN_H_
  31
  32 #include <sys/types.h>
  33
  34 /*
  35  * libteken: terminal emulation library.
  36  *
  37  * This library converts an UTF-8 stream of bytes to terminal drawing
  38  * commands.
  39  */
  40
  41 typedef uint32_t teken_char_t;
  42 typedef unsigned short teken_unit_t;
  43 typedef unsigned char teken_format_t;
  44 #define TF_BOLD         0x01    /* Bold character. */
  45 #define TF_UNDERLINE    0x02    /* Underline character. */
  46 #define TF_BLINK        0x04    /* Blinking character. */
  47 #define TF_REVERSE      0x08    /* Reverse rendered character. */
  48 #define TF_CJK_RIGHT    0x10    /* Right-hand side of CJK character. */
  49 typedef unsigned char teken_color_t;
  50 #define TC_BLACK        0
  51 #define TC_RED          1
  52 #define TC_GREEN        2
  53 #define TC_BROWN        3
  54 #define TC_BLUE         4
  55 #define TC_MAGENTA      5
  56 #define TC_CYAN         6
  57 #define TC_WHITE        7
  58 #define TC_NCOLORS      8
  59 #define TC_LIGHT        8       /* ORed with the others. */
  60
  61 typedef struct {
  62         teken_unit_t    tp_row;
  63         teken_unit_t    tp_col;
  64 } teken_pos_t;
  65 typedef struct {
  66         teken_pos_t     tr_begin;
  67         teken_pos_t     tr_end;
  68 } teken_rect_t;
  69 typedef struct {
  70         teken_format_t  ta_format;
  71         teken_color_t   ta_fgcolor;
  72         teken_color_t   ta_bgcolor;
  73 } teken_attr_t;
  74 typedef struct {
  75         teken_unit_t    ts_begin;
  76         teken_unit_t    ts_end;
  77 } teken_span_t;
  78
  79 typedef struct __teken teken_t;
  80
  81 typedef void teken_state_t(teken_t *, teken_char_t);
  82
  83 /*
  84  * Drawing routines supplied by the user.
  85  */
  86
  87 typedef void tf_bell_t(void *);
  88 typedef void tf_cursor_t(void *, const teken_pos_t *);
  89 typedef void tf_putchar_t(void *, const teken_pos_t *, teken_char_t,
  90     const teken_attr_t *);
  91 typedef void tf_fill_t(void *, const teken_rect_t *, teken_char_t,
  92     const teken_attr_t *);
  93 typedef void tf_copy_t(void *, const teken_rect_t *, const teken_pos_t *);
  94 typedef void tf_param_t(void *, int, unsigned int);
  95 #define TP_SHOWCURSOR   0
  96 #define TP_KEYPADAPP    1
  97 #define TP_AUTOREPEAT   2
  98 #define TP_SWITCHVT     3
  99 #define TP_132COLS      4
 100 #define TP_SETBELLPD    5
 101 #define TP_SETBELLPD_PITCH(pd)          ((pd) >> 16)
 102 #define TP_SETBELLPD_DURATION(pd)       ((pd) & 0xffff)
 103 #define TP_MOUSE        6
 104 typedef void tf_respond_t(void *, const void *, size_t);
 105
 106 typedef struct {
 107         tf_bell_t       *tf_bell;
 108         tf_cursor_t     *tf_cursor;
 109         tf_putchar_t    *tf_putchar;
 110         tf_fill_t       *tf_fill;
 111         tf_copy_t       *tf_copy;
 112         tf_param_t      *tf_param;
 113         tf_respond_t    *tf_respond;
 114 } teken_funcs_t;
 115
 116 typedef teken_char_t teken_scs_t(teken_t *, teken_char_t);
 117
 118 /*
 119  * Terminal state.
 120  */
 121
 122 struct __teken {
 123         const teken_funcs_t *t_funcs;
 124         void            *t_softc;
 125
 126         teken_state_t   *t_nextstate;
 127         unsigned int     t_stateflags;
 128
 129 #define T_NUMSIZE       8
 130         unsigned int     t_nums[T_NUMSIZE];
 131         unsigned int     t_curnum;
 132
 133         teken_pos_t      t_cursor;
 134         teken_attr_t     t_curattr;
 135         teken_pos_t      t_saved_cursor;
 136         teken_attr_t     t_saved_curattr;
 137
 138         teken_attr_t     t_defattr;
 139         teken_pos_t      t_winsize;
 140
 141         /* For DECSTBM. */
 142         teken_span_t     t_scrollreg;
 143         /* For DECOM. */
 144         teken_span_t     t_originreg;
 145
 146 #define T_NUMCOL        160
 147         unsigned int     t_tabstops[T_NUMCOL / (sizeof(unsigned int) * 8)];
 148
 149         unsigned int     t_utf8_left;
 150         teken_char_t     t_utf8_partial;
 151
 152         unsigned int     t_curscs;
 153         teken_scs_t     *t_saved_curscs;
 154         teken_scs_t     *t_scs[2];
 155 };
 156
 157 /* Initialize teken structure. */
 158 void    teken_init(teken_t *, const teken_funcs_t *, void *);
 159
 160 /* Deliver character input. */
 161 void    teken_input(teken_t *, const void *, size_t);
 162
 163 /* Get/set teken attributes. */
 164 const teken_pos_t *teken_get_cursor(teken_t *);
 165 const teken_attr_t *teken_get_curattr(teken_t *);
 166 const teken_attr_t *teken_get_defattr(teken_t *);
 167 void    teken_get_defattr_cons25(teken_t *, int *, int *);
 168 const teken_pos_t *teken_get_winsize(teken_t *);
 169 void    teken_set_cursor(teken_t *, const teken_pos_t *);
 170 void    teken_set_curattr(teken_t *, const teken_attr_t *);
 171 void    teken_set_defattr(teken_t *, const teken_attr_t *);
 172 void    teken_set_winsize(teken_t *, const teken_pos_t *);
 173 void    teken_set_winsize_noreset(teken_t *, const teken_pos_t *);
 174
 175 /* Key input escape sequences. */
 176 #define TKEY_UP         0x00
 177 #define TKEY_DOWN       0x01
 178 #define TKEY_LEFT       0x02
 179 #define TKEY_RIGHT      0x03
 180
 181 #define TKEY_HOME       0x04
 182 #define TKEY_END        0x05
 183 #define TKEY_INSERT     0x06
 184 #define TKEY_DELETE     0x07
 185 #define TKEY_PAGE_UP    0x08
 186 #define TKEY_PAGE_DOWN  0x09
 187
 188 #define TKEY_F1         0x0a
 189 #define TKEY_F2         0x0b
 190 #define TKEY_F3         0x0c
 191 #define TKEY_F4         0x0d
 192 #define TKEY_F5         0x0e
 193 #define TKEY_F6         0x0f
 194 #define TKEY_F7         0x10
 195 #define TKEY_F8         0x11
 196 #define TKEY_F9         0x12
 197 #define TKEY_F10        0x13
 198 #define TKEY_F11        0x14
 199 #define TKEY_F12        0x15
 200 const char *teken_get_sequence(teken_t *, unsigned int);
 201
 202 /* Legacy features. */
 203 void    teken_set_8bit(teken_t *);
 204 void    teken_set_cons25(teken_t *);
 205
 206 /* Color conversion. */
 207 teken_color_t teken_256to16(teken_color_t);
 208 teken_color_t teken_256to8(teken_color_t);
 209
 210 #endif /* !_TEKEN_H_ */