xref: /freebsd-12.1/lib/libedit/hist.h (revision 1f37f0f1)
1 /*	$NetBSD: hist.h,v 1.18 2016/02/17 19:47:49 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  * $FreeBSD$
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 *, TYPE(HistEvent) *, int, ...);
45 
46 typedef struct el_history_t {
47 	Char		*buf;		/* The history buffer		*/
48 	size_t		 sz;		/* Size of history buffer	*/
49 	Char		*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 	TYPE(HistEvent)	 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 #ifdef WIDECHAR
60 #define HIST_FUN(el, fn, arg) \
61     (((el)->el_flags & NARROW_HISTORY) ? hist_convert(el, fn, arg) : \
62 	HIST_FUN_INTERNAL(el, fn, arg))
63 #else
64 #define HIST_FUN(el, fn, arg) HIST_FUN_INTERNAL(el, fn, arg)
65 #endif
66 
67 
68 #define	HIST_NEXT(el)		HIST_FUN(el, H_NEXT, NULL)
69 #define	HIST_FIRST(el)		HIST_FUN(el, H_FIRST, NULL)
70 #define	HIST_LAST(el)		HIST_FUN(el, H_LAST, NULL)
71 #define	HIST_PREV(el)		HIST_FUN(el, H_PREV, NULL)
72 #define	HIST_SET(el, num)	HIST_FUN(el, H_SET, num)
73 #define	HIST_LOAD(el, fname)	HIST_FUN(el, H_LOAD fname)
74 #define	HIST_SAVE(el, fname)	HIST_FUN(el, H_SAVE fname)
75 #define	HIST_SAVE_FP(el, fp)	HIST_FUN(el, H_SAVE_FP fp)
76 
77 protected int		hist_init(EditLine *);
78 protected void		hist_end(EditLine *);
79 protected el_action_t	hist_get(EditLine *);
80 protected int		hist_set(EditLine *, hist_fun_t, void *);
81 protected int		hist_command(EditLine *, int, const Char **);
82 protected int		hist_enlargebuf(EditLine *, size_t, size_t);
83 #ifdef WIDECHAR
84 protected wchar_t	*hist_convert(EditLine *, int, void *);
85 #endif
86 
87 #endif /* _h_el_hist */
88