xref: /freebsd/contrib/libedit/hist.h (revision 61c1328eb016476ee7ff5ad65d8224bb43e572db)
1 /*	$NetBSD: hist.h,v 1.23 2017/09/01 10:19:10 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  *	@(#)hist.h	8.1 (Berkeley) 6/4/93
35  */
36 
37 /*
38  * el.hist.c: History functions
39  */
40 #ifndef _h_el_hist
41 #define	_h_el_hist
42 
43 typedef int (*hist_fun_t)(void *, HistEventW *, int, ...);
44 
45 typedef struct el_history_t {
46 	wchar_t		*buf;		/* The history buffer		*/
47 	size_t		 sz;		/* Size of history buffer	*/
48 	wchar_t		*last;		/* The last character		*/
49 	int		 eventno;	/* Event we are looking for	*/
50 	void		*ref;		/* Argument for history fcns	*/
51 	hist_fun_t	 fun;		/* Event access			*/
52 	HistEventW	 ev;		/* Event cookie			*/
53 } el_history_t;
54 
55 #define	HIST_FUN_INTERNAL(el, fn, arg)	\
56     ((((*(el)->el_history.fun) ((el)->el_history.ref, &(el)->el_history.ev, \
57 	fn, arg)) == -1) ? NULL : (el)->el_history.ev.str)
58 #define HIST_FUN(el, fn, arg) \
59     (((el)->el_flags & NARROW_HISTORY) ? hist_convert(el, fn, arg) : \
60 	HIST_FUN_INTERNAL(el, fn, arg))
61 
62 #define	HIST_NEXT(el)			HIST_FUN(el, H_NEXT, NULL)
63 #define	HIST_FIRST(el)			HIST_FUN(el, H_FIRST, NULL)
64 #define	HIST_LAST(el)			HIST_FUN(el, H_LAST, NULL)
65 #define	HIST_PREV(el)			HIST_FUN(el, H_PREV, NULL)
66 #define	HIST_SET(el, num)		HIST_FUN(el, H_SET, num)
67 #define	HIST_LOAD(el, fname)		HIST_FUN(el, H_LOAD fname)
68 #define	HIST_SAVE(el, fname)		HIST_FUN(el, H_SAVE fname)
69 #define	HIST_SAVE_FP(el, fp)		HIST_FUN(el, H_SAVE_FP, fp)
70 #define	HIST_NSAVE_FP(el, n, fp)	HIST_FUN(el, H_NSAVE_FP, n, fp)
71 
72 libedit_private int		hist_init(EditLine *);
73 libedit_private void		hist_end(EditLine *);
74 libedit_private el_action_t	hist_get(EditLine *);
75 libedit_private int		hist_set(EditLine *, hist_fun_t, void *);
76 libedit_private int		hist_command(EditLine *, int, const wchar_t **);
77 libedit_private int		hist_enlargebuf(EditLine *, size_t, size_t);
78 libedit_private wchar_t	*hist_convert(EditLine *, int, void *);
79 
80 #endif /* _h_el_hist */
81