Fix mdoc(7)/man(7) mix up.
[netbsd-mini2440.git] / lib / libedit / key.h
blobd456df0412d211520daf42e4a4cb25861a82b214
1 /* $NetBSD: key.h,v 1.12 2009/02/21 23:31:56 christos Exp $ */
3 /*-
4 * Copyright (c) 1992, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
8 * Christos Zoulas of Cornell University.
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. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
34 * @(#)key.h 8.1 (Berkeley) 6/4/93
38 * el.key.h: Key macro header
40 #ifndef _h_el_key
41 #define _h_el_key
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;
48 typedef struct key_node_t key_node_t;
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;
56 #define XK_CMD 0
57 #define XK_STR 1
58 #define XK_NOD 2
59 #define XK_EXE 3
61 #undef key_end
62 #undef key_clear
63 #undef key_print
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 size_t key__decode_str(const Char *, char *, size_t,
78 const char *);
80 #endif /* _h_el_key */