key.h revision 84260 
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 *	$NetBSD: key.h,v 1.4 2000/09/04 22:06:30 lukem Exp $
38 * $FreeBSD: head/lib/libedit/key.h 84260 2001-10-01 08:41:27Z obrien $
39 */
40
41/*
42 * el.key.h: Key macro header
43 */
44#ifndef _h_el_key
45#define	_h_el_key
46
47typedef 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
52typedef struct key_node_t key_node_t;
53
54typedef 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
65protected int		 key_init(EditLine *);
66protected void		 key_end(EditLine *);
67protected key_value_t	*key_map_cmd(EditLine *, int);
68protected key_value_t	*key_map_str(EditLine *, char *);
69protected void		 key_reset(EditLine *);
70protected int		 key_get(EditLine *, char *, key_value_t *);
71protected void		 key_add(EditLine *, const char *, key_value_t *, int);
72protected void		 key_clear(EditLine *, el_action_t *, char *);
73protected int		 key_delete(EditLine *, char *);
74protected void		 key_print(EditLine *, char *);
75protected void	         key_kprint(EditLine *, char *, key_value_t *, int);
76protected char		*key__decode_str(char *, char *, char *);
77
78#endif /* _h_el_key */
79