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