xref: /openbsd/lib/libedit/keymacro.h (revision 274d7c50)
1 /*	$OpenBSD: keymacro.h,v 1.4 2016/04/12 09:04:02 schwarze Exp $	*/
2 /*	$NetBSD: keymacro.h,v 1.5 2016/04/12 00:16:06 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  *	@(#)key.h	8.1 (Berkeley) 6/4/93
36  */
37 
38 /*
39  * el.keymacro.h: Key macro header
40  */
41 #ifndef _h_el_keymacro
42 #define	_h_el_keymacro
43 
44 typedef union keymacro_value_t {
45 	el_action_t	 cmd;	/* If it is a command the #	*/
46 	wchar_t		*str;	/* If it is a string...		*/
47 } keymacro_value_t;
48 
49 typedef struct keymacro_node_t keymacro_node_t;
50 
51 typedef struct el_keymacro_t {
52 	wchar_t		*buf;	/* Key print buffer		*/
53 	keymacro_node_t	*map;	/* Key map			*/
54 	keymacro_value_t val;	/* Local conversion buffer	*/
55 } el_keymacro_t;
56 
57 #define	XK_CMD	0
58 #define	XK_STR	1
59 #define	XK_NOD	2
60 
61 protected int keymacro_init(EditLine *);
62 protected void keymacro_end(EditLine *);
63 protected keymacro_value_t *keymacro_map_cmd(EditLine *, int);
64 protected keymacro_value_t *keymacro_map_str(EditLine *, wchar_t *);
65 protected void keymacro_reset(EditLine *);
66 protected int keymacro_get(EditLine *, wchar_t *, keymacro_value_t *);
67 protected void keymacro_add(EditLine *, const wchar_t *,
68     keymacro_value_t *, int);
69 protected void keymacro_clear(EditLine *, el_action_t *, const wchar_t *);
70 protected int keymacro_delete(EditLine *, const wchar_t *);
71 protected void keymacro_print(EditLine *, const wchar_t *);
72 protected void keymacro_kprint(EditLine *, const wchar_t *,
73     keymacro_value_t *, int);
74 protected size_t keymacro__decode_str(const wchar_t *, char *, size_t,
75     const char *);
76 
77 #endif /* _h_el_keymacro */
78