lib/libedit/key.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  *      @(#)key.h       8.1 (Berkeley) 6/4/93
  37  */
  38
  39 /*
  40  * el.key.h: Key macro header
  41  */
  42 #ifndef _h_el_key
  43 #define _h_el_key
  44
  45 typedef union key_value_t {
  46     el_action_t  cmd;   /* If it is a command the #     */
  47     char        *str;   /* If it is a string...         */
  48 } key_value_t;
  49
  50 typedef struct key_node_t key_node_t;
  51
  52 typedef struct el_key_t {
  53     char        *buf;   /* Key print buffer             */
  54     key_node_t  *map;   /* Key map                      */
  55     key_value_t  val;   /* Local conversion buffer      */
  56 } el_key_t;
  57
  58 #define XK_CMD  0
  59 #define XK_STR  1
  60 #define XK_NOD  2
  61 #define XK_EXE  3
  62
  63 protected int           key_init        __P((EditLine *));
  64 protected void          key_end         __P((EditLine *));
  65 protected key_value_t * key_map_cmd     __P((EditLine *, int));
  66 protected key_value_t * key_map_str     __P((EditLine *, char *));
  67 protected void          key_reset       __P((EditLine *));
  68 protected int           key_get         __P((EditLine *, char *,
  69                                              key_value_t *));
  70 protected void          key_add         __P((EditLine *, char *, key_value_t *,
  71                                              int));
  72 protected void          key_clear       __P((EditLine *, el_action_t *,
  73                                              char *));
  74 protected int           key_delete      __P((EditLine *, char *));
  75 protected void          key_print       __P((EditLine *, char *));
  76 protected void          key_kprint      __P((EditLine *, char *,
  77                                              key_value_t *, int));
  78 protected char         *key__decode_str __P((char *, char *, char *));
  79
  80 #endif /* _h_el_key */