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