main/editline/key.h

   1 /*      $NetBSD: key.h,v 1.6 2002/03/18 16:00:55 christos Exp $ */
   2
   3 /*-
   4  * Copyright (c) 1992, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * Christos Zoulas of Cornell University.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by the University of
  21  *      California, Berkeley and its contributors.
  22  * 4. Neither the name of the University nor the names of its contributors
  23  *    may be used to endorse or promote products derived from this software
  24  *    without specific prior written permission.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36  * SUCH DAMAGE.
  37  *
  38  *      @(#)key.h       8.1 (Berkeley) 6/4/93
  39  */
  40
  41 /*
  42  * el.key.h: Key macro header
  43  */
  44 #ifndef _h_el_key
  45 #define _h_el_key
  46
  47 typedef union key_value_t {
  48         el_action_t      cmd;   /* If it is a command the #     */
  49         char            *str;   /* If it is a string...         */
  50 } key_value_t;
  51
  52 typedef struct key_node_t key_node_t;
  53
  54 typedef struct el_key_t {
  55         char            *buf;   /* Key print buffer             */
  56         key_node_t      *map;   /* Key map                      */
  57         key_value_t      val;   /* Local conversion buffer      */
  58 } el_key_t;
  59
  60 #define XK_CMD  0
  61 #define XK_STR  1
  62 #define XK_NOD  2
  63 #define XK_EXE  3
  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 char          *key__decode_str(const char *, char *, const char *);
  78
  79 #endif /* _h_el_key */