xref: /openbsd-src/lib/libedit/map.h (revision b2ea75c1b17e1a9a339660e7ed45cd24946b230e)
1 /*	$OpenBSD: map.h,v 1.3 1997/03/14 05:12:55 millert Exp $	*/
2 /*	$NetBSD: map.h,v 1.2 1997/01/11 06:48:01 lukem Exp $	*/
3 
4 /*-
5  * Copyright (c) 1992, 1993
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * This code is derived from software contributed to Berkeley by
9  * Christos Zoulas of Cornell University.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *	This product includes software developed by the University of
22  *	California, Berkeley and its contributors.
23  * 4. Neither the name of the University nor the names of its contributors
24  *    may be used to endorse or promote products derived from this software
25  *    without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37  * SUCH DAMAGE.
38  *
39  *	@(#)map.h	8.1 (Berkeley) 6/4/93
40  */
41 
42 /*
43  * el.map.h:	Editor maps
44  */
45 #ifndef _h_el_map
46 #define _h_el_map
47 
48 typedef struct el_bindings_t {	/* for the "bind" shell command */
49     const char   *name;		/* function name for bind command */
50     int     func;		/* function numeric value */
51     const char   *description;	/* description of function */
52 } el_bindings_t;
53 
54 
55 typedef struct el_map_t {
56     el_action_t   *alt;		/* The current alternate key map	*/
57     el_action_t   *key;		/* The current normal key map		*/
58     el_action_t   *current;	/* The keymap we are using		*/
59     el_action_t   *emacs;	/* The default emacs key map		*/
60     el_action_t   *vic;		/* The vi command mode key map		*/
61     el_action_t   *vii;		/* The vi insert mode key map		*/
62     int		   type;	/* Emacs or vi				*/
63     el_bindings_t *help;	/* The help for the editor functions	*/
64     el_func_t     *func;	/* List of available functions		*/
65     int  	   nfunc;	/* The number of functions/help items	*/
66 } el_map_t;
67 
68 #define MAP_EMACS	0
69 #define MAP_VI		1
70 
71 protected int	map_bind		__P((EditLine *, int, char **));
72 protected int	map_init		__P((EditLine *));
73 protected void	map_end			__P((EditLine *));
74 protected void	map_init_vi		__P((EditLine *));
75 protected void	map_init_emacs		__P((EditLine *));
76 protected int	map_set_editor		__P((EditLine *, char *));
77 protected int	map_addfunc		__P((EditLine *, const char *,
78 					     const char *, el_func_t));
79 
80 #endif /* _h_el_map */
81