histedit.h revision 170511 
1/*-
2 * Copyright (c) 1992, 1993
3 *	The Regents of the University of California.  All rights reserved.
4 *
5 * This code is derived from software contributed to Berkeley by
6 * Christos Zoulas of Cornell University.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of the University nor the names of its contributors
17 *    may be used to endorse or promote products derived from this software
18 *    without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 *
32 *	@(#)histedit.h	8.2 (Berkeley) 1/3/94
33 *	$NetBSD: histedit.h,v 1.31 2006/12/15 22:13:33 christos Exp $
34 * $FreeBSD: head/include/histedit.h 170511 2007-06-10 19:06:09Z stefanf $
35 */
36
37/*
38 * histedit.h: Line editor and history interface.
39 */
40#ifndef _HISTEDIT_H_
41#define	_HISTEDIT_H_
42
43#include <sys/types.h>
44#include <stdio.h>
45
46__BEGIN_DECLS
47
48/*
49 * ==== Editing ====
50 */
51
52typedef struct editline EditLine;
53
54/*
55 * For user-defined function interface
56 */
57typedef struct lineinfo {
58	const char	*buffer;
59	const char	*cursor;
60	const char	*lastchar;
61} LineInfo;
62
63/*
64 * EditLine editor function return codes.
65 * For user-defined function interface
66 */
67#define	CC_NORM		0
68#define	CC_NEWLINE	1
69#define	CC_EOF		2
70#define	CC_ARGHACK	3
71#define	CC_REFRESH	4
72#define	CC_CURSOR	5
73#define	CC_ERROR	6
74#define	CC_FATAL	7
75#define	CC_REDISPLAY	8
76#define	CC_REFRESH_BEEP	9
77
78/*
79 * Initialization, cleanup, and resetting
80 */
81EditLine	*el_init(const char *, FILE *, FILE *, FILE *);
82void		 el_end(EditLine *);
83void		 el_reset(EditLine *);
84
85/*
86 * Get a line, a character or push a string back in the input queue
87 */
88const char	*el_gets(EditLine *, int *);
89int		 el_getc(EditLine *, char *);
90void		 el_push(EditLine *, char *);
91
92/*
93 * Beep!
94 */
95void		 el_beep(EditLine *);
96
97/*
98 * High level function internals control
99 * Parses argc, argv array and executes builtin editline commands
100 */
101int		 el_parse(EditLine *, int, const char **);
102
103/*
104 * Low level editline access functions
105 */
106int		 el_set(EditLine *, int, ...);
107int		 el_get(EditLine *, int, ...);
108#if 0
109unsigned char	_el_fn_complete(EditLine *, int);
110#endif
111
112/*
113 * el_set/el_get parameters
114 */
115#define	EL_PROMPT	0	/* , el_pfunc_t);		*/
116#define	EL_TERMINAL	1	/* , const char *);		*/
117#define	EL_EDITOR	2	/* , const char *);		*/
118#define	EL_SIGNAL	3	/* , int);			*/
119#define	EL_BIND		4	/* , const char *, ..., NULL);	*/
120#define	EL_TELLTC	5	/* , const char *, ..., NULL);	*/
121#define	EL_SETTC	6	/* , const char *, ..., NULL);	*/
122#define	EL_ECHOTC	7	/* , const char *, ..., NULL);	*/
123#define	EL_SETTY	8	/* , const char *, ..., NULL);	*/
124#define	EL_ADDFN	9	/* , const char *, const char *	*/
125				/* , el_func_t);		*/
126#define	EL_HIST		10	/* , hist_fun_t, const char *);	*/
127#define	EL_EDITMODE	11	/* , int);			*/
128#define	EL_RPROMPT	12	/* , el_pfunc_t);		*/
129#define	EL_GETCFN	13	/* , el_rfunc_t);		*/
130#define	EL_CLIENTDATA	14	/* , void *);			*/
131#define	EL_UNBUFFERED	15	/* , int);			*/
132#define	EL_PREP_TERM    16      /* , int);                      */
133#define	EL_GETTC	17	/* , const char *, ..., NULL);	*/
134#define EL_GETFP	18	/* , int, FILE **)		*/
135#define EL_SETFP	19	/* , int, FILE *)		*/
136
137#define EL_BUILTIN_GETCFN	(NULL)
138
139/*
140 * Source named file or $PWD/.editrc or $HOME/.editrc
141 */
142int		el_source(EditLine *, const char *);
143
144/*
145 * Must be called when the terminal changes size; If EL_SIGNAL
146 * is set this is done automatically otherwise it is the responsibility
147 * of the application
148 */
149void		 el_resize(EditLine *);
150
151
152/*
153 * Set user private data.
154 */
155void            el_data_set    __P((EditLine *, void *));
156void *          el_data_get    __P((EditLine *));
157
158/*
159 * User-defined function interface.
160 */
161const LineInfo	*el_line(EditLine *);
162int		 el_insertstr(EditLine *, const char *);
163void		 el_deletestr(EditLine *, int);
164
165
166/*
167 * ==== History ====
168 */
169
170typedef struct history History;
171
172typedef struct HistEvent {
173	int		 num;
174	const char	*str;
175} HistEvent;
176
177/*
178 * History access functions.
179 */
180History *	history_init(void);
181void		history_end(History *);
182
183int		history(History *, HistEvent *, int, ...);
184
185#define	H_FUNC		 0	/* , UTSL		*/
186#define	H_SETSIZE	 1	/* , const int);	*/
187#define H_EVENT		 1	/* , const int);	*/
188#define	H_GETSIZE	 2	/* , void);		*/
189#define	H_FIRST		 3	/* , void);		*/
190#define	H_LAST		 4	/* , void);		*/
191#define	H_PREV		 5	/* , void);		*/
192#define	H_NEXT		 6	/* , void);		*/
193#define	H_CURR		 8	/* , const int);	*/
194#define	H_SET		 7	/* , int);		*/
195#define	H_ADD		 9	/* , const char *);	*/
196#define	H_ENTER		10	/* , const char *);	*/
197#define	H_APPEND	11	/* , const char *);	*/
198#define	H_END		12	/* , void);		*/
199#define	H_NEXT_STR	13	/* , const char *);	*/
200#define	H_PREV_STR	14	/* , const char *);	*/
201#define	H_NEXT_EVENT	15	/* , const int);	*/
202#define	H_PREV_EVENT	16	/* , const int);	*/
203#define	H_LOAD		17	/* , const char *);	*/
204#define	H_SAVE		18	/* , const char *);	*/
205#define	H_CLEAR		19	/* , void);		*/
206#define	H_SETUNIQUE	20	/* , int);		*/
207#define	H_GETUNIQUE	21	/* , void);		*/
208#define	H_DEL		22	/* , int);		*/
209
210
211/*
212 * ==== Tokenization ====
213 */
214
215typedef struct tokenizer Tokenizer;
216
217/*
218 * String tokenization functions, using simplified sh(1) quoting rules
219 */
220Tokenizer	*tok_init(const char *);
221void		 tok_end(Tokenizer *);
222void		 tok_reset(Tokenizer *);
223int		 tok_line(Tokenizer *, const LineInfo *,
224		    int *, const char ***, int *, int *);
225int		 tok_str(Tokenizer *, const char *,
226		    int *, const char ***);
227
228__END_DECLS
229
230#endif /* _HISTEDIT_H_ */
231