test: Sync with FreeBSD.
[dragonfly.git] / include / histedit.h
blob7b56ede439d81b29fb026842e21f4ce27068e552
1 /* $DragonFly: src/include/histedit.h,v 1.7 2008/05/17 22:48:04 pavalos Exp $ */
2 /* $NetBSD: histedit.h,v 1.34 2008/04/05 23:53:26 christos Exp $ */
4 /*-
5 * Copyright (c) 1992, 1993
6 * The Regents of the University of California. All rights reserved.
8 * This code is derived from software contributed to Berkeley by
9 * Christos Zoulas of Cornell University.
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. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
35 * @(#)histedit.h 8.2 (Berkeley) 1/3/94
39 * histedit.h: Line editor and history interface.
41 #ifndef _HISTEDIT_H_
42 #define _HISTEDIT_H_
44 #define LIBEDIT_MAJOR 2
45 #define LIBEDIT_MINOR 11
47 #include <sys/types.h>
48 #include <stdio.h>
50 #ifdef __cplusplus
51 extern "C" {
52 #endif
55 * ==== Editing ====
58 typedef struct editline EditLine;
61 * For user-defined function interface
63 typedef struct lineinfo {
64 const char *buffer;
65 const char *cursor;
66 const char *lastchar;
67 } LineInfo;
70 * EditLine editor function return codes.
71 * For user-defined function interface
73 #define CC_NORM 0
74 #define CC_NEWLINE 1
75 #define CC_EOF 2
76 #define CC_ARGHACK 3
77 #define CC_REFRESH 4
78 #define CC_CURSOR 5
79 #define CC_ERROR 6
80 #define CC_FATAL 7
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 void el_end(EditLine *);
89 void el_reset(EditLine *);
92 * Get a line, a character or push a string back in the input queue
94 const char *el_gets(EditLine *, int *);
95 int el_getc(EditLine *, char *);
96 void el_push(EditLine *, char *);
99 * Beep!
101 void el_beep(EditLine *);
104 * High level function internals control
105 * Parses argc, argv array and executes builtin editline commands
107 int el_parse(EditLine *, int, const char **);
110 * Low level editline access functions
112 int el_set(EditLine *, int, ...);
113 int el_get(EditLine *, int, ...);
114 unsigned char _el_fn_complete(EditLine *, int);
117 * el_set/el_get parameters
119 #define EL_PROMPT 0 /* , el_pfunc_t); */
120 #define EL_TERMINAL 1 /* , const char *); */
121 #define EL_EDITOR 2 /* , const char *); */
122 #define EL_SIGNAL 3 /* , int); */
123 #define EL_BIND 4 /* , const char *, ..., NULL); */
124 #define EL_TELLTC 5 /* , const char *, ..., NULL); */
125 #define EL_SETTC 6 /* , const char *, ..., NULL); */
126 #define EL_ECHOTC 7 /* , const char *, ..., NULL); */
127 #define EL_SETTY 8 /* , const char *, ..., NULL); */
128 #define EL_ADDFN 9 /* , const char *, const char * */
129 /* , el_func_t); */
130 #define EL_HIST 10 /* , hist_fun_t, const char *); */
131 #define EL_EDITMODE 11 /* , int); */
132 #define EL_RPROMPT 12 /* , el_pfunc_t); */
133 #define EL_GETCFN 13 /* , el_rfunc_t); */
134 #define EL_CLIENTDATA 14 /* , void *); */
135 #define EL_UNBUFFERED 15 /* , int); */
136 #define EL_PREP_TERM 16 /* , int); */
137 #define EL_GETTC 17 /* , const char *, ..., NULL); */
138 #define EL_GETFP 18 /* , int, FILE **); */
139 #define EL_SETFP 19 /* , int, FILE *); */
140 #define EL_REFRESH 20 /* , void); */
142 #define EL_BUILTIN_GETCFN (NULL)
145 * Source named file or $PWD/.editrc or $HOME/.editrc
147 int el_source(EditLine *, const char *);
150 * Must be called when the terminal changes size; If EL_SIGNAL
151 * is set this is done automatically otherwise it is the responsibility
152 * of the application
154 void el_resize(EditLine *);
157 * User-defined function interface.
159 const LineInfo *el_line(EditLine *);
160 int el_insertstr(EditLine *, const char *);
161 void el_deletestr(EditLine *, int);
165 * ==== History ====
168 typedef struct history History;
170 typedef struct HistEvent {
171 int num;
172 const char *str;
173 } HistEvent;
176 * History access functions.
178 History * history_init(void);
179 void history_end(History *);
181 int history(History *, HistEvent *, int, ...);
183 #define H_FUNC 0 /* , UTSL */
184 #define H_SETSIZE 1 /* , const int); */
185 #define H_GETSIZE 2 /* , void); */
186 #define H_FIRST 3 /* , void); */
187 #define H_LAST 4 /* , void); */
188 #define H_PREV 5 /* , void); */
189 #define H_NEXT 6 /* , void); */
190 #define H_CURR 8 /* , const int); */
191 #define H_SET 7 /* , int); */
192 #define H_ADD 9 /* , const char *); */
193 #define H_ENTER 10 /* , const char *); */
194 #define H_APPEND 11 /* , const char *); */
195 #define H_END 12 /* , void); */
196 #define H_NEXT_STR 13 /* , const char *); */
197 #define H_PREV_STR 14 /* , const char *); */
198 #define H_NEXT_EVENT 15 /* , const int); */
199 #define H_PREV_EVENT 16 /* , const int); */
200 #define H_LOAD 17 /* , const char *); */
201 #define H_SAVE 18 /* , const char *); */
202 #define H_CLEAR 19 /* , void); */
203 #define H_SETUNIQUE 20 /* , int); */
204 #define H_GETUNIQUE 21 /* , void); */
205 #define H_DEL 22 /* , int); */
209 * ==== Tokenization ====
212 typedef struct tokenizer Tokenizer;
215 * String tokenization functions, using simplified sh(1) quoting rules
217 Tokenizer *tok_init(const char *);
218 void tok_end(Tokenizer *);
219 void tok_reset(Tokenizer *);
220 int tok_line(Tokenizer *, const LineInfo *,
221 int *, const char ***, int *, int *);
222 int tok_str(Tokenizer *, const char *,
223 int *, const char ***);
225 #ifdef __cplusplus
227 #endif
229 #endif /* _HISTEDIT_H_ */