xref: /freebsd-12.1/lib/libedit/keymacro.h (revision c1a66a97)
1 /*	$NetBSD: keymacro.h,v 1.3 2016/01/29 19:59:11 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  *	@(#)key.h	8.1 (Berkeley) 6/4/93
35  * $FreeBSD$
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 	Char		*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 	Char		*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 #define	XK_EXE	3
61 
62 protected int keymacro_init(EditLine *);
63 protected void keymacro_end(EditLine *);
64 protected keymacro_value_t *keymacro_map_cmd(EditLine *, int);
65 protected keymacro_value_t *keymacro_map_str(EditLine *, Char *);
66 protected void keymacro_reset(EditLine *);
67 protected int keymacro_get(EditLine *, Char *, keymacro_value_t *);
68 protected void keymacro_add(EditLine *, const Char *, keymacro_value_t *, int);
69 protected void keymacro_clear(EditLine *, el_action_t *, const Char *);
70 protected int keymacro_delete(EditLine *, const Char *);
71 protected void keymacro_print(EditLine *, const Char *);
72 protected void keymacro_kprint(EditLine *, const Char *, keymacro_value_t *,
73     int);
74 protected size_t keymacro__decode_str(const Char *, char *, size_t,
75     const char *);
76 
77 #endif /* _h_el_keymacro */
78