xref: /openbsd-src/lib/libedit/map.h (revision db3296cf5c1dd9058ceecc3a29fe4aaa0bd26000)
1 /*	$OpenBSD: map.h,v 1.6 2003/06/02 20:18:40 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. Neither the name of the University nor the names of its contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  *
35  *	@(#)map.h	8.1 (Berkeley) 6/4/93
36  */
37 
38 /*
39  * el.map.h:	Editor maps
40  */
41 #ifndef _h_el_map
42 #define _h_el_map
43 
44 typedef struct el_bindings_t {	/* for the "bind" shell command */
45     const char   *name;		/* function name for bind command */
46     int     func;		/* function numeric value */
47     const char   *description;	/* description of function */
48 } el_bindings_t;
49 
50 
51 typedef struct el_map_t {
52     el_action_t   *alt;		/* The current alternate key map	*/
53     el_action_t   *key;		/* The current normal key map		*/
54     el_action_t   *current;	/* The keymap we are using		*/
55     el_action_t   *emacs;	/* The default emacs key map		*/
56     el_action_t   *vic;		/* The vi command mode key map		*/
57     el_action_t   *vii;		/* The vi insert mode key map		*/
58     int		   type;	/* Emacs or vi				*/
59     el_bindings_t *help;	/* The help for the editor functions	*/
60     el_func_t     *func;	/* List of available functions		*/
61     int  	   nfunc;	/* The number of functions/help items	*/
62 } el_map_t;
63 
64 #define MAP_EMACS	0
65 #define MAP_VI		1
66 
67 protected int	map_bind(EditLine *, int, char **);
68 protected int	map_init(EditLine *);
69 protected void	map_end(EditLine *);
70 protected void	map_init_vi(EditLine *);
71 protected void	map_init_emacs(EditLine *);
72 protected int	map_set_editor(EditLine *, char *);
73 protected int	map_addfunc(EditLine *, const char *, const char *, el_func_t);
74 
75 #endif /* _h_el_map */
76