The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/teken/teken.h

Version: -  FREEBSD  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    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: releng/11.0/sys/teken/teken.h 259667 2013-12-20 21:31:50Z ed $
   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 
   60 typedef struct {
   61         teken_unit_t    tp_row;
   62         teken_unit_t    tp_col;
   63 } teken_pos_t;
   64 typedef struct {
   65         teken_pos_t     tr_begin;
   66         teken_pos_t     tr_end;
   67 } teken_rect_t;
   68 typedef struct {
   69         teken_format_t  ta_format;
   70         teken_color_t   ta_fgcolor;
   71         teken_color_t   ta_bgcolor;
   72 } teken_attr_t;
   73 typedef struct {
   74         teken_unit_t    ts_begin;
   75         teken_unit_t    ts_end;
   76 } teken_span_t;
   77 
   78 typedef struct __teken teken_t;
   79 
   80 typedef void teken_state_t(teken_t *, teken_char_t);
   81 
   82 /*
   83  * Drawing routines supplied by the user.
   84  */
   85 
   86 typedef void tf_bell_t(void *);
   87 typedef void tf_cursor_t(void *, const teken_pos_t *);
   88 typedef void tf_putchar_t(void *, const teken_pos_t *, teken_char_t,
   89     const teken_attr_t *);
   90 typedef void tf_fill_t(void *, const teken_rect_t *, teken_char_t,
   91     const teken_attr_t *);
   92 typedef void tf_copy_t(void *, const teken_rect_t *, const teken_pos_t *);
   93 typedef void tf_param_t(void *, int, unsigned int);
   94 #define TP_SHOWCURSOR   0
   95 #define TP_KEYPADAPP    1
   96 #define TP_AUTOREPEAT   2
   97 #define TP_SWITCHVT     3
   98 #define TP_132COLS      4
   99 #define TP_SETBELLPD    5
  100 #define TP_SETBELLPD_PITCH(pd)          ((pd) >> 16)
  101 #define TP_SETBELLPD_DURATION(pd)       ((pd) & 0xffff)
  102 #define TP_MOUSE        6
  103 typedef void tf_respond_t(void *, const void *, size_t);
  104 
  105 typedef struct {
  106         tf_bell_t       *tf_bell;
  107         tf_cursor_t     *tf_cursor;
  108         tf_putchar_t    *tf_putchar;
  109         tf_fill_t       *tf_fill;
  110         tf_copy_t       *tf_copy;
  111         tf_param_t      *tf_param;
  112         tf_respond_t    *tf_respond;
  113 } teken_funcs_t;
  114 
  115 typedef teken_char_t teken_scs_t(teken_t *, teken_char_t);
  116 
  117 /*
  118  * Terminal state.
  119  */
  120 
  121 struct __teken {
  122         const teken_funcs_t *t_funcs;
  123         void            *t_softc;
  124 
  125         teken_state_t   *t_nextstate;
  126         unsigned int     t_stateflags;
  127 
  128 #define T_NUMSIZE       8
  129         unsigned int     t_nums[T_NUMSIZE];
  130         unsigned int     t_curnum;
  131 
  132         teken_pos_t      t_cursor;
  133         teken_attr_t     t_curattr;
  134         teken_pos_t      t_saved_cursor;
  135         teken_attr_t     t_saved_curattr;
  136 
  137         teken_attr_t     t_defattr;
  138         teken_pos_t      t_winsize;
  139 
  140         /* For DECSTBM. */
  141         teken_span_t     t_scrollreg;
  142         /* For DECOM. */
  143         teken_span_t     t_originreg;
  144 
  145 #define T_NUMCOL        160
  146         unsigned int     t_tabstops[T_NUMCOL / (sizeof(unsigned int) * 8)];
  147 
  148         unsigned int     t_utf8_left;
  149         teken_char_t     t_utf8_partial;
  150 
  151         unsigned int     t_curscs;
  152         teken_scs_t     *t_saved_curscs;
  153         teken_scs_t     *t_scs[2];
  154 };
  155 
  156 /* Initialize teken structure. */
  157 void    teken_init(teken_t *, const teken_funcs_t *, void *);
  158 
  159 /* Deliver character input. */
  160 void    teken_input(teken_t *, const void *, size_t);
  161 
  162 /* Get/set teken attributes. */
  163 const teken_pos_t *teken_get_cursor(teken_t *);
  164 const teken_attr_t *teken_get_curattr(teken_t *);
  165 const teken_attr_t *teken_get_defattr(teken_t *);
  166 void    teken_get_defattr_cons25(teken_t *, int *, int *);
  167 const teken_pos_t *teken_get_winsize(teken_t *);
  168 void    teken_set_cursor(teken_t *, const teken_pos_t *);
  169 void    teken_set_curattr(teken_t *, const teken_attr_t *);
  170 void    teken_set_defattr(teken_t *, const teken_attr_t *);
  171 void    teken_set_winsize(teken_t *, const teken_pos_t *);
  172 void    teken_set_winsize_noreset(teken_t *, const teken_pos_t *);
  173 
  174 /* Key input escape sequences. */
  175 #define TKEY_UP         0x00
  176 #define TKEY_DOWN       0x01
  177 #define TKEY_LEFT       0x02
  178 #define TKEY_RIGHT      0x03
  179 
  180 #define TKEY_HOME       0x04
  181 #define TKEY_END        0x05
  182 #define TKEY_INSERT     0x06
  183 #define TKEY_DELETE     0x07
  184 #define TKEY_PAGE_UP    0x08
  185 #define TKEY_PAGE_DOWN  0x09
  186 
  187 #define TKEY_F1         0x0a
  188 #define TKEY_F2         0x0b
  189 #define TKEY_F3         0x0c
  190 #define TKEY_F4         0x0d
  191 #define TKEY_F5         0x0e
  192 #define TKEY_F6         0x0f
  193 #define TKEY_F7         0x10
  194 #define TKEY_F8         0x11
  195 #define TKEY_F9         0x12
  196 #define TKEY_F10        0x13
  197 #define TKEY_F11        0x14
  198 #define TKEY_F12        0x15
  199 const char *teken_get_sequence(teken_t *, unsigned int);
  200 
  201 /* Legacy features. */
  202 void    teken_set_8bit(teken_t *);
  203 void    teken_set_cons25(teken_t *);
  204 
  205 /* Color conversion. */
  206 teken_color_t teken_256to8(teken_color_t);
  207 
  208 #endif /* !_TEKEN_H_ */

Cache object: 7375d833c4e5f6bc3e3808a8d649da45


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.