2 * Copyright (c) 1992, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
6 * Christos Zoulas of Cornell University.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
32 * @(#)histedit.h 8.2 (Berkeley) 1/3/94
33 * $NetBSD: histedit.h,v 1.32 2007/06/10 20:20:28 christos Exp $
38 * histedit.h: Line editor and history interface.
43 #include <sys/types.h>
52 typedef struct editline EditLine;
55 * For user-defined function interface
57 typedef struct lineinfo {
64 * EditLine editor function return codes.
65 * For user-defined function interface
75 #define CC_REDISPLAY 8
76 #define CC_REFRESH_BEEP 9
79 * Initialization, cleanup, and resetting
81 EditLine *el_init(const char *, FILE *, FILE *, FILE *);
82 void el_end(EditLine *);
83 void el_reset(EditLine *);
86 * Get a line, a character or push a string back in the input queue
88 const char *el_gets(EditLine *, int *);
89 int el_getc(EditLine *, char *);
90 void el_push(EditLine *, char *);
95 void el_beep(EditLine *);
98 * High level function internals control
99 * Parses argc, argv array and executes builtin editline commands
101 int el_parse(EditLine *, int, const char **);
104 * Low level editline access functions
106 int el_set(EditLine *, int, ...);
107 int el_get(EditLine *, int, ...);
109 unsigned char _el_fn_complete(EditLine *, int);
113 * el_set/el_get parameters
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 * */
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 *) */
137 #define EL_BUILTIN_GETCFN (NULL)
140 * Source named file or $PWD/.editrc or $HOME/.editrc
142 int el_source(EditLine *, const char *);
145 * Must be called when the terminal changes size; If EL_SIGNAL
146 * is set this is done automatically otherwise it is the responsibility
149 void el_resize(EditLine *);
153 * Set user private data.
155 void el_data_set __P((EditLine *, void *));
156 void * el_data_get __P((EditLine *));
159 * User-defined function interface.
161 const LineInfo *el_line(EditLine *);
162 int el_insertstr(EditLine *, const char *);
163 void el_deletestr(EditLine *, int);
170 typedef struct history History;
172 typedef struct HistEvent {
178 * History access functions.
180 History * history_init(void);
181 void history_end(History *);
183 int history(History *, HistEvent *, int, ...);
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); */
212 * ==== Tokenization ====
215 typedef struct tokenizer Tokenizer;
218 * String tokenization functions, using simplified sh(1) quoting rules
220 Tokenizer *tok_init(const char *);
221 void tok_end(Tokenizer *);
222 void tok_reset(Tokenizer *);
223 int tok_line(Tokenizer *, const LineInfo *,
224 int *, const char ***, int *, int *);
225 int tok_str(Tokenizer *, const char *,
226 int *, const char ***);
230 #endif /* _HISTEDIT_H_ */