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