Deleted Added
sdiff udiff text old ( 117556 ) new ( 148834 )
full compact
histedit.h (117556) histedit.h (148834)
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.
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. All advertising materials mentioning features or use of this software
17 * must display the following acknowledgement:
18 * This product includes software developed by the University of
19 * California, Berkeley and its contributors.
20 * 4. Neither the name of the University nor the names of its contributors
16 * 3. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 *
36 * @(#)histedit.h 8.2 (Berkeley) 1/3/94
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
37 * $NetBSD: histedit.h,v 1.15 2000/02/28 17:41:05 chopps Exp $
38 * $FreeBSD: head/include/histedit.h 117556 2003-07-14 16:31:20Z imp $
33 * $NetBSD: histedit.h,v 1.28 2005/07/14 15:00:58 christos Exp $
34 * $FreeBSD: head/include/histedit.h 148834 2005-08-07 20:55:59Z stefanf $
39 */
40
41/*
42 * histedit.h: Line editor and history interface.
43 */
44#ifndef _HISTEDIT_H_
45#define _HISTEDIT_H_
46
47#include <sys/types.h>
48#include <stdio.h>
49
50__BEGIN_DECLS
51
52/*
53 * ==== Editing ====
54 */
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
55typedef struct editline EditLine;
56
57/*
58 * For user-defined function interface
59 */
60typedef struct lineinfo {
61 const char *buffer;
62 const char *cursor;
63 const char *lastchar;
64} LineInfo;
65
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
66
67/*
68 * EditLine editor function return codes.
69 * For user-defined function interface
70 */
71#define CC_NORM 0
72#define CC_NEWLINE 1
73#define CC_EOF 2
74#define CC_ARGHACK 3
75#define CC_REFRESH 4
76#define CC_CURSOR 5
77#define CC_ERROR 6
78#define CC_FATAL 7
79#define CC_REDISPLAY 8
80#define CC_REFRESH_BEEP 9
81
82/*
83 * Initialization, cleanup, and resetting
84 */
85EditLine *el_init(const char *, FILE *, FILE *, FILE *);
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 *);
86void el_reset(EditLine *);
87void el_end(EditLine *);
82void el_end(EditLine *);
83void el_reset(EditLine *);
88
84
89
90/*
91 * Get a line, a character or push a string back in the input queue
92 */
93const char *el_gets(EditLine *, int *);
94int el_getc(EditLine *, char *);
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 *);
95void el_push(EditLine *, const char *);
90void el_push(EditLine *, char *);
96
97/*
98 * Beep!
99 */
100void el_beep(EditLine *);
101
102/*
103 * High level function internals control
104 * Parses argc, argv array and executes builtin editline commands
105 */
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 */
106int el_parse(EditLine *, int, char **);
101int el_parse(EditLine *, int, const char **);
107
108/*
109 * Low level editline access functions
110 */
111int el_set(EditLine *, int, ...);
112int el_get(EditLine *, int, void *);
102
103/*
104 * Low level editline access functions
105 */
106int el_set(EditLine *, int, ...);
107int el_get(EditLine *, int, void *);
108#if 0
109unsigned char _el_fn_complete(EditLine *, int);
110#endif
113
114/*
115 * el_set/el_get parameters
116 */
117#define EL_PROMPT 0 /* , el_pfunc_t); */
118#define EL_TERMINAL 1 /* , const char *); */
119#define EL_EDITOR 2 /* , const char *); */
120#define EL_SIGNAL 3 /* , int); */
121#define EL_BIND 4 /* , const char *, ..., NULL); */
122#define EL_TELLTC 5 /* , const char *, ..., NULL); */
123#define EL_SETTC 6 /* , const char *, ..., NULL); */
124#define EL_ECHOTC 7 /* , const char *, ..., NULL); */
125#define EL_SETTY 8 /* , const char *, ..., NULL); */
126#define EL_ADDFN 9 /* , const char *, const char * */
127 /* , el_func_t); */
128#define EL_HIST 10 /* , hist_fun_t, const char *); */
129#define EL_EDITMODE 11 /* , int); */
130#define EL_RPROMPT 12 /* , el_pfunc_t); */
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); */
131
133
134#define EL_BUILTIN_GETCFN (NULL)
135
132/*
133 * Source named file or $PWD/.editrc or $HOME/.editrc
134 */
135int el_source(EditLine *, const char *);
136
137/*
138 * Must be called when the terminal changes size; If EL_SIGNAL
139 * is set this is done automatically otherwise it is the responsibility

--- 10 unchanged lines hidden (view full) ---

150
151/*
152 * User-defined function interface.
153 */
154const LineInfo *el_line(EditLine *);
155int el_insertstr(EditLine *, const char *);
156void el_deletestr(EditLine *, int);
157
136/*
137 * Source named file or $PWD/.editrc or $HOME/.editrc
138 */
139int el_source(EditLine *, const char *);
140
141/*
142 * Must be called when the terminal changes size; If EL_SIGNAL
143 * is set this is done automatically otherwise it is the responsibility

--- 10 unchanged lines hidden (view full) ---

154
155/*
156 * User-defined function interface.
157 */
158const LineInfo *el_line(EditLine *);
159int el_insertstr(EditLine *, const char *);
160void el_deletestr(EditLine *, int);
161
162
158/*
159 * ==== History ====
160 */
161
162typedef struct history History;
163
164typedef struct HistEvent {
165 int num;

--- 12 unchanged lines hidden (view full) ---

178#define H_SETSIZE 1 /* , const int); */
179#define H_EVENT 1 /* , const int); */
180#define H_GETSIZE 2 /* , void); */
181#define H_FIRST 3 /* , void); */
182#define H_LAST 4 /* , void); */
183#define H_PREV 5 /* , void); */
184#define H_NEXT 6 /* , void); */
185#define H_CURR 8 /* , const int); */
163/*
164 * ==== History ====
165 */
166
167typedef struct history History;
168
169typedef struct HistEvent {
170 int num;

--- 12 unchanged lines hidden (view full) ---

183#define H_SETSIZE 1 /* , const int); */
184#define H_EVENT 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); */
186#define H_SET 7 /* , void); */
191#define H_SET 7 /* , int); */
187#define H_ADD 9 /* , const char *); */
188#define H_ENTER 10 /* , const char *); */
189#define H_APPEND 11 /* , const char *); */
190#define H_END 12 /* , void); */
191#define H_NEXT_STR 13 /* , const char *); */
192#define H_PREV_STR 14 /* , const char *); */
193#define H_NEXT_EVENT 15 /* , const int); */
194#define H_PREV_EVENT 16 /* , const int); */
195#define H_LOAD 17 /* , const char *); */
196#define H_SAVE 18 /* , const char *); */
197#define H_CLEAR 19 /* , void); */
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); */
198
206
207
208/*
209 * ==== Tokenization ====
210 */
211
212typedef struct tokenizer Tokenizer;
213
214/*
215 * String tokenization functions, using simplified sh(1) quoting rules
216 */
217Tokenizer *tok_init(const char *);
218void tok_end(Tokenizer *);
219void tok_reset(Tokenizer *);
220int tok_line(Tokenizer *, const LineInfo *,
221 int *, const char ***, int *, int *);
222int tok_str(Tokenizer *, const char *,
223 int *, const char ***);
224
199__END_DECLS
200
201#endif /* _HISTEDIT_H_ */
225__END_DECLS
226
227#endif /* _HISTEDIT_H_ */