xref: /openbsd/lib/libedit/map.h (revision 09467b48)
1 /*	$OpenBSD: map.h,v 1.10 2016/05/06 13:12:52 schwarze Exp $	*/
2 /*	$NetBSD: map.h,v 1.12 2016/04/18 17:01:19 christos 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 el_action_t (*el_func_t)(EditLine *, wint_t);
45 
46 typedef struct el_bindings_t {	/* for the "bind" shell command */
47 	const wchar_t	*name;		/* function name for bind command */
48 	int		 func;		/* function numeric value */
49 	const wchar_t	*description;	/* description of function */
50 } el_bindings_t;
51 
52 typedef struct el_map_t {
53 	el_action_t	*alt;		/* The current alternate key map */
54 	el_action_t	*key;		/* The current normal key map	*/
55 	el_action_t	*current;	/* The keymap we are using	*/
56 	const el_action_t *emacs;	/* The default emacs key map	*/
57 	const el_action_t *vic;		/* The vi command mode key map	*/
58 	const el_action_t *vii;		/* The vi insert mode key map	*/
59 	int		 type;		/* Emacs or vi			*/
60 	el_bindings_t	*help;		/* The help for the editor functions */
61 	el_func_t	*func;		/* List of available functions	*/
62 	int		 nfunc;		/* The number of functions/help items */
63 } el_map_t;
64 
65 #define	MAP_EMACS	0
66 #define	MAP_VI		1
67 
68 #define N_KEYS      256
69 
70 protected int	map_bind(EditLine *, int, const wchar_t **);
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 *, wchar_t *);
76 protected int	map_get_editor(EditLine *, const wchar_t **);
77 protected int	map_addfunc(EditLine *, const wchar_t *, const wchar_t *,
78     el_func_t);
79 
80 #endif /* _h_el_map */
81