sys/dev/syscons/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 /*
  33  * libteken: terminal emulation library.
  34  *
  35  * This library converts an UTF-8 stream of bytes to terminal drawing
  36  * commands.
  37  *
  38  * Configuration switches:
  39  * - TEKEN_UTF8: Enable/disable UTF-8 handling.
  40  * - TEKEN_XTERM: Enable xterm-style emulation, instead of cons25.
  41  */
  42
  43 #if defined(__FreeBSD__) && defined(_KERNEL)
  44 #include "opt_teken.h"
  45 #endif /* __FreeBSD__ && _KERNEL */
  46
  47 #ifdef TEKEN_UTF8
  48 typedef uint32_t teken_char_t;
  49 #else /* !TEKEN_UTF8 */
  50 typedef unsigned char teken_char_t;
  51 #endif /* TEKEN_UTF8 */
  52 typedef unsigned short teken_unit_t;
  53 typedef unsigned char teken_format_t;
  54 #define TF_BOLD         0x01
  55 #define TF_UNDERLINE    0x02
  56 #define TF_BLINK        0x04
  57 typedef unsigned char teken_color_t;
  58 #define TC_BLACK        0
  59 #define TC_RED          1
  60 #define TC_GREEN        2
  61 #define TC_BROWN        3
  62 #define TC_BLUE         4
  63 #define TC_MAGENTA      5
  64 #define TC_CYAN         6
  65 #define TC_WHITE        7
  66 #define TC_NCOLORS      8
  67
  68 typedef struct {
  69         teken_unit_t    tp_row;
  70         teken_unit_t    tp_col;
  71 } teken_pos_t;
  72 typedef struct {
  73         teken_pos_t     tr_begin;
  74         teken_pos_t     tr_end;
  75 } teken_rect_t;
  76 typedef struct {
  77         teken_format_t  ta_format;
  78         teken_color_t   ta_fgcolor;
  79         teken_color_t   ta_bgcolor;
  80 } teken_attr_t;
  81 typedef struct {
  82         teken_unit_t    ts_begin;
  83         teken_unit_t    ts_end;
  84 } teken_span_t;
  85
  86 typedef struct __teken teken_t;
  87
  88 typedef void teken_state_t(teken_t *, teken_char_t);
  89
  90 /*
  91  * Drawing routines supplied by the user.
  92  */
  93
  94 typedef void tf_bell_t(void *);
  95 typedef void tf_cursor_t(void *, const teken_pos_t *);
  96 typedef void tf_putchar_t(void *, const teken_pos_t *, teken_char_t,
  97     const teken_attr_t *);
  98 typedef void tf_fill_t(void *, const teken_rect_t *, teken_char_t,
  99     const teken_attr_t *);
 100 typedef void tf_copy_t(void *, const teken_rect_t *, const teken_pos_t *);
 101 typedef void tf_param_t(void *, int, unsigned int);
 102 #define TP_SHOWCURSOR   0
 103 #define TP_CURSORKEYS   1
 104 #define TP_KEYPADAPP    2
 105 #define TP_AUTOREPEAT   3
 106 #define TP_SWITCHVT     4
 107 #define TP_132COLS      5
 108 #define TP_SETBELLPD    6
 109 #define TP_SETBELLPD_PITCH(pd)          ((pd) >> 16)
 110 #define TP_SETBELLPD_DURATION(pd)       ((pd) & 0xffff)
 111 typedef void tf_respond_t(void *, const void *, size_t);
 112
 113 typedef struct {
 114         tf_bell_t       *tf_bell;
 115         tf_cursor_t     *tf_cursor;
 116         tf_putchar_t    *tf_putchar;
 117         tf_fill_t       *tf_fill;
 118         tf_copy_t       *tf_copy;
 119         tf_param_t      *tf_param;
 120         tf_respond_t    *tf_respond;
 121 } teken_funcs_t;
 122
 123 #if defined(TEKEN_XTERM) && defined(TEKEN_UTF8)
 124 typedef teken_char_t teken_scs_t(teken_char_t);
 125 #endif /* TEKEN_XTERM && TEKEN_UTF8 */
 126
 127 /*
 128  * Terminal state.
 129  */
 130
 131 struct __teken {
 132         const teken_funcs_t *t_funcs;
 133         void            *t_softc;
 134
 135         teken_state_t   *t_nextstate;
 136         unsigned int     t_stateflags;
 137
 138 #define T_NUMSIZE       8
 139         unsigned int     t_nums[T_NUMSIZE];
 140         unsigned int     t_curnum;
 141
 142         teken_pos_t      t_cursor;
 143         teken_attr_t     t_curattr;
 144         teken_pos_t      t_saved_cursor;
 145         teken_attr_t     t_saved_curattr;
 146
 147         teken_attr_t     t_defattr;
 148         teken_pos_t      t_winsize;
 149
 150         /* For DECSTBM. */
 151         teken_span_t     t_scrollreg;
 152         /* For DECOM. */
 153         teken_span_t     t_originreg;
 154
 155 #define T_NUMCOL        160
 156         unsigned int     t_tabstops[T_NUMCOL / (sizeof(unsigned int) * 8)];
 157
 158 #ifdef TEKEN_UTF8
 159         unsigned int     t_utf8_left;
 160         teken_char_t     t_utf8_partial;
 161 #endif /* TEKEN_UTF8 */
 162
 163 #if defined(TEKEN_XTERM) && defined(TEKEN_UTF8)
 164         unsigned int     t_curscs;
 165         teken_scs_t     *t_saved_curscs;
 166         teken_scs_t     *t_scs[2];
 167 #endif /* TEKEN_XTERM && TEKEN_UTF8 */
 168 };
 169
 170 /* Initialize teken structure. */
 171 void    teken_init(teken_t *, const teken_funcs_t *, void *);
 172
 173 /* Deliver character input. */
 174 void    teken_input(teken_t *, const void *, size_t);
 175
 176 /* Get/set teken attributes. */
 177 const teken_attr_t *teken_get_curattr(teken_t *);
 178 const teken_attr_t *teken_get_defattr(teken_t *);
 179 void    teken_set_cursor(teken_t *, const teken_pos_t *);
 180 void    teken_set_curattr(teken_t *, const teken_attr_t *);
 181 void    teken_set_defattr(teken_t *, const teken_attr_t *);
 182 void    teken_set_winsize(teken_t *, const teken_pos_t *);
 183
 184 #endif /* !_TEKEN_H_ */