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. Neither the name of the University nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  * @(#)key.h    8.1 (Berkeley) 6/4/93
  33  * $NetBSD: key.h,v 1.10 2006/03/23 20:22:51 christos Exp $
  34  * $DragonFly: src/lib/libedit/key.h,v 1.5 2007/05/05 00:27:39 pavalos Exp $
  35  */
  36
  37 /*
  38  * el.key.h: Key macro header
  39  */
  40 #ifndef _h_el_key
  41 #define _h_el_key
  42
  43 typedef union key_value_t {
  44         el_action_t      cmd;   /* If it is a command the #     */
  45         char            *str;   /* If it is a string...         */
  46 } key_value_t;
  47
  48 typedef struct key_node_t key_node_t;
  49
  50 typedef struct el_key_t {
  51         char            *buf;   /* Key print buffer             */
  52         key_node_t      *map;   /* Key map                      */
  53         key_value_t      val;   /* Local conversion buffer      */
  54 } el_key_t;
  55
  56 #define XK_CMD  0
  57 #define XK_STR  1
  58 #define XK_NOD  2
  59 #define XK_EXE  3
  60
  61 #undef key_end
  62 #undef key_clear
  63 #undef key_print
  64
  65 protected int            key_init(EditLine *);
  66 protected void           key_end(EditLine *);
  67 protected key_value_t   *key_map_cmd(EditLine *, int);
  68 protected key_value_t   *key_map_str(EditLine *, char *);
  69 protected void           key_reset(EditLine *);
  70 protected int            key_get(EditLine *, char *, key_value_t *);
  71 protected void           key_add(EditLine *, const char *, key_value_t *, int);
  72 protected void           key_clear(EditLine *, el_action_t *, const char *);
  73 protected int            key_delete(EditLine *, const char *);
  74 protected void           key_print(EditLine *, const char *);
  75 protected void           key_kprint(EditLine *, const char *, key_value_t *,
  76     int);
  77 protected int            key__decode_str(const char *, char *, int,
  78     const char *);
  79 protected int            key__decode_char(char *, int, int, int);
  80
  81 #endif /* _h_el_key */