xref: /openbsd-src/lib/libedit/hist.h (revision b2ea75c1b17e1a9a339660e7ed45cd24946b230e)
1 /*	$OpenBSD: hist.h,v 1.4 1997/03/14 05:12:49 millert Exp $	*/
2 /*	$NetBSD: hist.h,v 1.3 1997/01/11 06:47:56 lukem 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. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *	This product includes software developed by the University of
22  *	California, Berkeley and its contributors.
23  * 4. Neither the name of the University nor the names of its contributors
24  *    may be used to endorse or promote products derived from this software
25  *    without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37  * SUCH DAMAGE.
38  *
39  *	@(#)hist.h	8.1 (Berkeley) 6/4/93
40  */
41 
42 /*
43  * el.hist.c: History functions
44  */
45 #ifndef _h_el_hist
46 #define _h_el_hist
47 
48 #include "histedit.h"
49 
50 typedef const HistEvent *	(*hist_fun_t) __P((ptr_t, int, ...));
51 
52 typedef struct el_history_t {
53     char *buf;				/* The history buffer		*/
54     char *last;				/* The last character		*/
55     int eventno;			/* Event we are looking for	*/
56     ptr_t ref;				/* Argument for history fcns	*/
57     hist_fun_t fun;			/* Event access			*/
58     const HistEvent *ev;		/* Event cookie			*/
59 } el_history_t;
60 
61 #define HIST_FUN(el, fn, arg)	\
62     ((((el)->el_history.ev = \
63        (*(el)->el_history.fun)((el)->el_history.ref, fn, arg)) == NULL) ? \
64      NULL : (el)->el_history.ev->str)
65 
66 #define	HIST_NEXT(el)		HIST_FUN(el, H_NEXT, NULL)
67 #define	HIST_FIRST(el)		HIST_FUN(el, H_FIRST, NULL)
68 #define	HIST_LAST(el)		HIST_FUN(el, H_LAST, NULL)
69 #define	HIST_PREV(el)		HIST_FUN(el, H_PREV, NULL)
70 #define	HIST_EVENT(el, num)	HIST_FUN(el, H_EVENT, num)
71 #define	HIST_LOAD(el, fname)	HIST_FUN(el, H_LOAD fname)
72 #define	HIST_SAVE(el, fname)	HIST_FUN(el, H_SAVE fname)
73 
74 protected int 		hist_init	__P((EditLine *));
75 protected void 		hist_end	__P((EditLine *));
76 protected el_action_t	hist_get	__P((EditLine *));
77 protected int		hist_set	__P((EditLine *, hist_fun_t, ptr_t));
78 protected int		hist_list	__P((EditLine *, int, char **));
79 
80 #endif /* _h_el_hist */
81