lib/libedit/term.h

   1 /*-
   2  * Copyright (c) 1992, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * This code is derived from software contributed to Berkeley by
   6  * Christos Zoulas of Cornell University.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. All advertising materials mentioning features or use of this software
  17  *    must display the following acknowledgement:
  18  *      This product includes software developed by the University of
  19  *      California, Berkeley and its contributors.
  20  * 4. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)term.h      8.1 (Berkeley) 6/4/93
  37  *
  38  * $FreeBSD: src/lib/libedit/term.h,v 1.3.8.1 2000/08/16 14:43:40 ache Exp $
  39  * $DragonFly: src/lib/libedit/term.h,v 1.2 2003/06/17 04:26:49 dillon Exp $
  40  */
  41
  42 /*
  43  * el.term.h: Termcap header
  44  */
  45 #ifndef _h_el_term
  46 #define _h_el_term
  47
  48 #include "histedit.h"
  49
  50 typedef struct {        /* Symbolic function key bindings       */
  51     char       *name;   /* name of the key                      */
  52     int         key;    /* Index in termcap table               */
  53     key_value_t fun;    /* Function bound to it                 */
  54     int         type;   /* Type of function                     */
  55 } fkey_t;
  56
  57 typedef struct {
  58     coord_t t_size;                     /* # lines and cols     */
  59     bool_t  t_flags;
  60 #define TERM_CAN_INSERT         0x01    /* Has insert cap       */
  61 #define TERM_CAN_DELETE         0x02    /* Has delete cap       */
  62 #define TERM_CAN_CEOL           0x04    /* Has CEOL cap         */
  63 #define TERM_CAN_TAB            0x08    /* Can use tabs         */
  64 #define TERM_CAN_ME             0x10    /* Can turn all attrs.  */
  65 #define TERM_CAN_UP             0x20    /* Can move up          */
  66 #define TERM_HAS_META           0x40    /* Has a meta key       */
  67     char   *t_buf;                      /* Termcap buffer       */
  68     int     t_loc;                      /* location used        */
  69     char  **t_str;                      /* termcap strings      */
  70     int    *t_val;                      /* termcap values       */
  71     char   *t_cap;                      /* Termcap buffer       */
  72     fkey_t *t_fkey;                     /* Array of keys        */
  73 } el_term_t;
  74
  75 /*
  76  * fKey indexes
  77  */
  78 #define A_K_DN          0
  79 #define A_K_UP          1
  80 #define A_K_LT          2
  81 #define A_K_RT          3
  82 #define A_K_HO          4
  83 #define A_K_EN          5
  84 #define A_K_NKEYS       6
  85
  86 protected void term_move_to_line        __P((EditLine *, int));
  87 protected void term_move_to_char        __P((EditLine *, int));
  88 protected void term_clear_EOL           __P((EditLine *, int));
  89 protected void term_overwrite           __P((EditLine *, char *, int));
  90 protected void term_insertwrite         __P((EditLine *, char *, int));
  91 protected void term_deletechars         __P((EditLine *, int));
  92 protected void term_clear_screen        __P((EditLine *));
  93 protected void term_beep                __P((EditLine *));
  94 protected void term_change_size         __P((EditLine *, int, int));
  95 protected int  term_get_size            __P((EditLine *, int *, int *));
  96 protected int  term_init                __P((EditLine *));
  97 protected void term_bind_arrow          __P((EditLine *));
  98 protected void term_print_arrow         __P((EditLine *, char *));
  99 protected int  term_clear_arrow         __P((EditLine *, char *));
 100 protected int  term_set_arrow           __P((EditLine *, char *,
 101                                              key_value_t *, int));
 102 protected void term_end                 __P((EditLine *));
 103 protected int  term_set                 __P((EditLine *, char *));
 104 protected int  term_settc               __P((EditLine *, int, char **));
 105 protected int  term_telltc              __P((EditLine *, int, char **));
 106 protected int  term_echotc              __P((EditLine *, int, char **));
 107
 108 protected int  term__putc               __P((int));
 109 protected void term__flush              __P((void));
 110
 111 /*
 112  * Easy access macros
 113  */
 114 #define EL_FLAGS        (el)->el_term.t_flags
 115
 116 #define EL_CAN_INSERT   (EL_FLAGS & TERM_CAN_INSERT)
 117 #define EL_CAN_DELETE   (EL_FLAGS & TERM_CAN_DELETE)
 118 #define EL_CAN_CEOL     (EL_FLAGS & TERM_CAN_CEOL)
 119 #define EL_CAN_TAB      (EL_FLAGS & TERM_CAN_TAB)
 120 #define EL_CAN_ME       (EL_FLAGS & TERM_CAN_ME)
 121 #define EL_HAS_META     (EL_FLAGS & TERM_HAS_META)
 122
 123 #endif /* _h_el_term */