1 /* $NetBSD: histedit.h,v 1.55 2016/02/17 19:47:49 christos Exp $ */
4 * Copyright (c) 1992, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
8 * Christos Zoulas of Cornell University.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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.
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
34 * @(#)histedit.h 8.2 (Berkeley) 1/3/94
39 * histedit.h: Line editor and history interface.
44 #define LIBEDIT_MAJOR 2
45 #define LIBEDIT_MINOR 11
47 #include <sys/types.h>
58 typedef struct editline EditLine;
61 * For user-defined function interface
63 typedef struct lineinfo {
70 * EditLine editor function return codes.
71 * For user-defined function interface
81 #define CC_REDISPLAY 8
82 #define CC_REFRESH_BEEP 9
85 * Initialization, cleanup, and resetting
87 EditLine *el_init(const char *, FILE *, FILE *, FILE *);
88 EditLine *el_init_fd(const char *, FILE *, FILE *, FILE *,
90 void el_end(EditLine *);
91 void el_reset(EditLine *);
94 * Get a line, a character or push a string back in the input queue
96 const char *el_gets(EditLine *, int *);
97 int el_getc(EditLine *, char *);
98 void el_push(EditLine *, const char *);
103 void el_beep(EditLine *);
106 * High level function internals control
107 * Parses argc, argv array and executes builtin editline commands
109 int el_parse(EditLine *, int, const char **);
112 * Low level editline access functions
114 int el_set(EditLine *, int, ...);
115 int el_get(EditLine *, int, ...);
116 unsigned char _el_fn_complete(EditLine *, int);
117 unsigned char _el_fn_sh_complete(EditLine *, int);
120 * el_set/el_get parameters
122 * When using el_wset/el_wget (as opposed to el_set/el_get):
123 * Char is wchar_t, otherwise it is char.
124 * prompt_func is el_wpfunc_t, otherwise it is el_pfunc_t .
126 * Prompt function prototypes are:
127 * typedef char *(*el_pfunct_t) (EditLine *);
128 * typedef wchar_t *(*el_wpfunct_t) (EditLine *);
130 * For operations that support set or set/get, the argument types listed are for
131 * the "set" operation. For "get", each listed type must be a pointer.
132 * E.g. EL_EDITMODE takes an int when set, but an int* when get.
134 * Operations that only support "get" have the correct argument types listed.
136 #define EL_PROMPT 0 /* , prompt_func); set/get */
137 #define EL_TERMINAL 1 /* , const char *); set/get */
138 #define EL_EDITOR 2 /* , const Char *); set/get */
139 #define EL_SIGNAL 3 /* , int); set/get */
140 #define EL_BIND 4 /* , const Char *, ..., NULL); set */
141 #define EL_TELLTC 5 /* , const Char *, ..., NULL); set */
142 #define EL_SETTC 6 /* , const Char *, ..., NULL); set */
143 #define EL_ECHOTC 7 /* , const Char *, ..., NULL); set */
144 #define EL_SETTY 8 /* , const Char *, ..., NULL); set */
145 #define EL_ADDFN 9 /* , const Char *, const Char, set */
147 #define EL_HIST 10 /* , hist_fun_t, const void *); set */
148 #define EL_EDITMODE 11 /* , int); set/get */
149 #define EL_RPROMPT 12 /* , prompt_func); set/get */
150 #define EL_GETCFN 13 /* , el_rfunc_t); set/get */
151 #define EL_CLIENTDATA 14 /* , void *); set/get */
152 #define EL_UNBUFFERED 15 /* , int); set/get */
153 #define EL_PREP_TERM 16 /* , int); set */
154 #define EL_GETTC 17 /* , const Char *, ..., NULL); get */
155 #define EL_GETFP 18 /* , int, FILE **); get */
156 #define EL_SETFP 19 /* , int, FILE *); set */
157 #define EL_REFRESH 20 /* , void); set */
158 #define EL_PROMPT_ESC 21 /* , prompt_func, Char); set/get */
159 #define EL_RPROMPT_ESC 22 /* , prompt_func, Char); set/get */
160 #define EL_RESIZE 23 /* , el_zfunc_t, void *); set */
161 #define EL_ALIAS_TEXT 24 /* , el_afunc_t, void *); set */
163 #define EL_BUILTIN_GETCFN (NULL)
166 * Source named file or $PWD/.editrc or $HOME/.editrc
168 int el_source(EditLine *, const char *);
171 * Must be called when the terminal changes size; If EL_SIGNAL
172 * is set this is done automatically otherwise it is the responsibility
175 void el_resize(EditLine *);
178 * User-defined function interface.
180 const LineInfo *el_line(EditLine *);
181 int el_insertstr(EditLine *, const char *);
182 void el_deletestr(EditLine *, int);
189 typedef struct history History;
191 typedef struct HistEvent {
197 * History access functions.
199 History * history_init(void);
200 void history_end(History *);
202 int history(History *, HistEvent *, int, ...);
204 #define H_FUNC 0 /* , UTSL */
205 #define H_SETSIZE 1 /* , const int); */
206 #define H_GETSIZE 2 /* , void); */
207 #define H_FIRST 3 /* , void); */
208 #define H_LAST 4 /* , void); */
209 #define H_PREV 5 /* , void); */
210 #define H_NEXT 6 /* , void); */
211 #define H_CURR 8 /* , const int); */
212 #define H_SET 7 /* , int); */
213 #define H_ADD 9 /* , const wchar_t *); */
214 #define H_ENTER 10 /* , const wchar_t *); */
215 #define H_APPEND 11 /* , const wchar_t *); */
216 #define H_END 12 /* , void); */
217 #define H_NEXT_STR 13 /* , const wchar_t *); */
218 #define H_PREV_STR 14 /* , const wchar_t *); */
219 #define H_NEXT_EVENT 15 /* , const int); */
220 #define H_PREV_EVENT 16 /* , const int); */
221 #define H_LOAD 17 /* , const char *); */
222 #define H_SAVE 18 /* , const char *); */
223 #define H_CLEAR 19 /* , void); */
224 #define H_SETUNIQUE 20 /* , int); */
225 #define H_GETUNIQUE 21 /* , void); */
226 #define H_DEL 22 /* , int); */
227 #define H_NEXT_EVDATA 23 /* , const int, histdata_t *); */
228 #define H_DELDATA 24 /* , int, histdata_t *);*/
229 #define H_REPLACE 25 /* , const char *, histdata_t); */
230 #define H_SAVE_FP 26 /* , FILE *); */
235 * ==== Tokenization ====
238 typedef struct tokenizer Tokenizer;
241 * String tokenization functions, using simplified sh(1) quoting rules
243 Tokenizer *tok_init(const char *);
244 void tok_end(Tokenizer *);
245 void tok_reset(Tokenizer *);
246 int tok_line(Tokenizer *, const LineInfo *,
247 int *, const char ***, int *, int *);
248 int tok_str(Tokenizer *, const char *,
249 int *, const char ***);
252 * Begin Wide Character Support
260 typedef struct lineinfow {
261 const wchar_t *buffer;
262 const wchar_t *cursor;
263 const wchar_t *lastchar;
266 const wchar_t *el_wgets(EditLine *, int *);
267 int el_wgetc(EditLine *, wchar_t *);
268 void el_wpush(EditLine *, const wchar_t *);
270 int el_wparse(EditLine *, int, const wchar_t **);
272 int el_wset(EditLine *, int, ...);
273 int el_wget(EditLine *, int, ...);
275 int el_cursor(EditLine *, int);
276 const LineInfoW *el_wline(EditLine *);
277 int el_winsertstr(EditLine *, const wchar_t *);
278 #define el_wdeletestr el_deletestr
283 typedef struct histeventW {
288 typedef struct historyW HistoryW;
290 HistoryW * history_winit(void);
291 void history_wend(HistoryW *);
293 int history_w(HistoryW *, HistEventW *, int, ...);
296 * ==== Tokenization ====
298 typedef struct tokenizerW TokenizerW;
300 /* Wide character tokenizer support */
301 TokenizerW *tok_winit(const wchar_t *);
302 void tok_wend(TokenizerW *);
303 void tok_wreset(TokenizerW *);
304 int tok_wline(TokenizerW *, const LineInfoW *,
305 int *, const wchar_t ***, int *, int *);
306 int tok_wstr(TokenizerW *, const wchar_t *,
307 int *, const wchar_t ***);
313 #endif /* _HISTEDIT_H_ */