xref: /netbsd/lib/libedit/map.h (revision bf9ec67e)
1 /*	$NetBSD: map.h,v 1.7 2002/03/18 16:00:56 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  *	@(#)map.h	8.1 (Berkeley) 6/4/93
39  */
40 
41 /*
42  * el.map.h:	Editor maps
43  */
44 #ifndef _h_el_map
45 #define	_h_el_map
46 
47 typedef struct el_bindings_t {	/* for the "bind" shell command */
48 	const char	*name;		/* function name for bind command */
49 	int		 func;		/* function numeric value */
50 	const char	*description;	/* description of function */
51 } el_bindings_t;
52 
53 
54 typedef struct el_map_t {
55 	el_action_t	*alt;		/* The current alternate key map */
56 	el_action_t	*key;		/* The current normal key map	*/
57 	el_action_t	*current;	/* The keymap we are using	*/
58 	const el_action_t *emacs;	/* The default emacs key map	*/
59 	const el_action_t *vic;		/* The vi command mode key map	*/
60 	const el_action_t *vii;		/* The vi insert mode key map	*/
61 	int		 type;		/* Emacs or vi			*/
62 	el_bindings_t	*help;		/* The help for the editor functions */
63 	el_func_t	*func;		/* List of available functions	*/
64 	int		 nfunc;		/* The number of functions/help items */
65 } el_map_t;
66 
67 #define	MAP_EMACS	0
68 #define	MAP_VI		1
69 
70 protected int	map_bind(EditLine *, int, const char **);
71 protected int	map_init(EditLine *);
72 protected void	map_end(EditLine *);
73 protected void	map_init_vi(EditLine *);
74 protected void	map_init_emacs(EditLine *);
75 protected int	map_set_editor(EditLine *, char *);
76 protected int	map_get_editor(EditLine *, const char **);
77 protected int	map_addfunc(EditLine *, const char *, const char *, el_func_t);
78 
79 #endif /* _h_el_map */
80