← Back to branch summary

~ubuntu-branches/ubuntu/trusty/mysql-5.6/trusty

« back to all changes in this revision

Viewing changes to cmd-line-utils/libedit/histedit.h

  • Committer: Package Import Robot
  • Author(s): James Page
  • Date: 2014-02-12 11:54:27 UTC
  • Revision ID: package-import@ubuntu.com-20140212115427-oq6tfsqxl1wuwehi
Tags: upstream-5.6.15
Import upstream version 5.6.15

Show diffs side-by-side

added added

removed removed

Lines of Context:
cmd-line-utils/libedit/histedit.h
 
1
/*      $NetBSD: histedit.h,v 1.48 2011/07/28 20:50:55 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. 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.
 
21
 *
 
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
 
32
 * SUCH DAMAGE.
 
33
 *
 
34
 *      @(#)histedit.h  8.2 (Berkeley) 1/3/94
 
35
 */
 
36
 
 
37
/*
 
38
 * histedit.h: Line editor and history interface.
 
39
 */
 
40
#ifndef _HISTEDIT_H_
 
41
#define _HISTEDIT_H_
 
42
 
 
43
#define LIBEDIT_MAJOR 2
 
44
#define LIBEDIT_MINOR 11
 
45
 
 
46
/* XXXMYSQL : stdint.h might not be available on older Solaris platforms. */
 
47
#if defined(__sun) || defined(__sun__)
 
48
#include <sys/inttypes.h>
 
49
#else
 
50
#include <stdint.h>
 
51
#endif
 
52
 
 
53
#include <sys/types.h>
 
54
#include <stdio.h>
 
55
 
 
56
#ifdef __cplusplus
 
57
extern "C" {
 
58
#endif
 
59
 
 
60
/*
 
61
 * ==== Editing ====
 
62
 */
 
63
 
 
64
typedef struct editline EditLine;
 
65
 
 
66
/*
 
67
 * For user-defined function interface
 
68
 */
 
69
typedef struct lineinfo {
 
70
        const char      *buffer;
 
71
        const char      *cursor;
 
72
        const char      *lastchar;
 
73
} LineInfo;
 
74
 
 
75
/*
 
76
 * EditLine editor function return codes.
 
77
 * For user-defined function interface
 
78
 */
 
79
#define CC_NORM         0
 
80
#define CC_NEWLINE      1
 
81
#define CC_EOF          2
 
82
#define CC_ARGHACK      3
 
83
#define CC_REFRESH      4
 
84
#define CC_CURSOR       5
 
85
#define CC_ERROR        6
 
86
#define CC_FATAL        7
 
87
#define CC_REDISPLAY    8
 
88
#define CC_REFRESH_BEEP 9
 
89
 
 
90
/*
 
91
 * Initialization, cleanup, and resetting
 
92
 */
 
93
EditLine        *el_init(const char *, FILE *, FILE *, FILE *);
 
94
void             el_end(EditLine *);
 
95
void             el_reset(EditLine *);
 
96
 
 
97
/*
 
98
 * Get a line, a character or push a string back in the input queue
 
99
 */
 
100
const char      *el_gets(EditLine *, int *);
 
101
int              el_getc(EditLine *, char *);
 
102
void             el_push(EditLine *, const char *);
 
103
 
 
104
/*
 
105
 * Beep!
 
106
 */
 
107
void             el_beep(EditLine *);
 
108
 
 
109
/*
 
110
 * High level function internals control
 
111
 * Parses argc, argv array and executes builtin editline commands
 
112
 */
 
113
int              el_parse(EditLine *, int, const char **);
 
114
 
 
115
/*
 
116
 * Low level editline access functions
 
117
 */
 
118
int              el_set(EditLine *, int, ...);
 
119
int              el_get(EditLine *, int, ...);
 
120
unsigned char   _el_fn_complete(EditLine *, int);
 
121
 
 
122
/*
 
123
 * el_set/el_get parameters
 
124
 *
 
125
 * When using el_wset/el_wget (as opposed to el_set/el_get):
 
126
 *   Char is wchar_t, otherwise it is char.
 
127
 *   prompt_func is el_wpfunc_t, otherwise it is el_pfunc_t .
 
128
 
 
129
 * Prompt function prototypes are:
 
130
 *   typedef char    *(*el_pfunct_t)  (EditLine *);
 
131
 *   typedef wchar_t *(*el_wpfunct_t) (EditLine *);
 
132
 *
 
133
 * For operations that support set or set/get, the argument types listed are for
 
134
 * the "set" operation. For "get", each listed type must be a pointer.
 
135
 * E.g. EL_EDITMODE takes an int when set, but an int* when get.
 
136
 * 
 
137
 * Operations that only support "get" have the correct argument types listed.
 
138
 */
 
139
#define EL_PROMPT       0       /* , prompt_func);                    set/get */
 
140
#define EL_TERMINAL     1       /* , const char *);                   set/get */
 
141
#define EL_EDITOR       2       /* , const Char *);                   set/get */
 
142
#define EL_SIGNAL       3       /* , int);                            set/get */
 
143
#define EL_BIND         4       /* , const Char *, ..., NULL);        set     */
 
144
#define EL_TELLTC       5       /* , const Char *, ..., NULL);        set     */
 
145
#define EL_SETTC        6       /* , const Char *, ..., NULL);        set     */
 
146
#define EL_ECHOTC       7       /* , const Char *, ..., NULL);        set     */
 
147
#define EL_SETTY        8       /* , const Char *, ..., NULL);        set     */
 
148
#define EL_ADDFN        9       /* , const Char *, const Char,        set     */
 
149
                                /*   el_func_t);                              */
 
150
#define EL_HIST         10      /* , hist_fun_t, const void *);       set     */
 
151
#define EL_EDITMODE     11      /* , int);                            set/get */
 
152
#define EL_RPROMPT      12      /* , prompt_func);                    set/get */
 
153
#define EL_GETCFN       13      /* , el_rfunc_t);                     set/get */
 
154
#define EL_CLIENTDATA   14      /* , void *);                         set/get */
 
155
#define EL_UNBUFFERED   15      /* , int);                            set/get */
 
156
#define EL_PREP_TERM    16      /* , int);                            set     */
 
157
#define EL_GETTC        17      /* , const Char *, ..., NULL);            get */
 
158
#define EL_GETFP        18      /* , int, FILE **);                       get */
 
159
#define EL_SETFP        19      /* , int, FILE *);                    set     */
 
160
#define EL_REFRESH      20      /* , void);                           set     */
 
161
#define EL_PROMPT_ESC   21      /* , prompt_func, Char);              set/get */
 
162
#define EL_RPROMPT_ESC  22      /* , prompt_func, Char);              set/get */
 
163
#define EL_RESIZE       23      /* , el_zfunc_t, void *);             set     */
 
164
 
 
165
#define EL_BUILTIN_GETCFN       (NULL)
 
166
 
 
167
/*
 
168
 * Source named file or $PWD/.editrc or $HOME/.editrc
 
169
 */
 
170
int             el_source(EditLine *, const char *);
 
171
 
 
172
/*
 
173
 * Must be called when the terminal changes size; If EL_SIGNAL
 
174
 * is set this is done automatically otherwise it is the responsibility
 
175
 * of the application
 
176
 */
 
177
void             el_resize(EditLine *);
 
178
 
 
179
/*
 
180
 * User-defined function interface.
 
181
 */
 
182
const LineInfo  *el_line(EditLine *);
 
183
int              el_insertstr(EditLine *, const char *);
 
184
void             el_deletestr(EditLine *, int);
 
185
 
 
186
 
 
187
/*
 
188
 * ==== History ====
 
189
 */
 
190
 
 
191
typedef struct history History;
 
192
 
 
193
typedef struct HistEvent {
 
194
        int              num;
 
195
        const char      *str;
 
196
} HistEvent;
 
197
 
 
198
/*
 
199
 * History access functions.
 
200
 */
 
201
History *       history_init(void);
 
202
void            history_end(History *);
 
203
 
 
204
int             history(History *, HistEvent *, int, ...);
 
205
 
 
206
#define H_FUNC           0      /* , UTSL               */
 
207
#define H_SETSIZE        1      /* , const int);        */
 
208
#define H_GETSIZE        2      /* , void);             */
 
209
#define H_FIRST          3      /* , void);             */
 
210
#define H_LAST           4      /* , void);             */
 
211
#define H_PREV           5      /* , void);             */
 
212
#define H_NEXT           6      /* , void);             */
 
213
#define H_CURR           8      /* , const int);        */
 
214
#define H_SET            7      /* , int);              */
 
215
#define H_ADD            9      /* , const wchar_t *);  */
 
216
#define H_ENTER         10      /* , const wchar_t *);  */
 
217
#define H_APPEND        11      /* , const wchar_t *);  */
 
218
#define H_END           12      /* , void);             */
 
219
#define H_NEXT_STR      13      /* , const wchar_t *);  */
 
220
#define H_PREV_STR      14      /* , const wchar_t *);  */
 
221
#define H_NEXT_EVENT    15      /* , const int);        */
 
222
#define H_PREV_EVENT    16      /* , const int);        */
 
223
#define H_LOAD          17      /* , const char *);     */
 
224
#define H_SAVE          18      /* , const char *);     */
 
225
#define H_CLEAR         19      /* , void);             */
 
226
#define H_SETUNIQUE     20      /* , int);              */
 
227
#define H_GETUNIQUE     21      /* , void);             */
 
228
#define H_DEL           22      /* , int);              */
 
229
#define H_NEXT_EVDATA   23      /* , const int, histdata_t *);  */
 
230
#define H_DELDATA       24      /* , int, histdata_t *);*/
 
231
#define H_REPLACE       25      /* , const char *, histdata_t); */
 
232
 
 
233
 
 
234
 
 
235
/*
 
236
 * ==== Tokenization ====
 
237
 */
 
238
 
 
239
typedef struct tokenizer Tokenizer;
 
240
 
 
241
/*
 
242
 * String tokenization functions, using simplified sh(1) quoting rules
 
243
 */
 
244
Tokenizer       *tok_init(const char *);
 
245
void             tok_end(Tokenizer *);
 
246
void             tok_reset(Tokenizer *);
 
247
int              tok_line(Tokenizer *, const LineInfo *,
 
248
                    int *, const char ***, int *, int *);
 
249
int              tok_str(Tokenizer *, const char *,
 
250
                    int *, const char ***);
 
251
 
 
252
/*
 
253
 * Begin Wide Character Support
 
254
 */
 
255
 
 
256
/*
 
257
 * Wide character versions
 
258
 */
 
259
 
 
260
/*
 
261
 * ==== Editing ====
 
262
 */
 
263
typedef struct lineinfow {
 
264
        const wchar_t   *buffer;
 
265
        const wchar_t   *cursor;
 
266
        const wchar_t   *lastchar;
 
267
} LineInfoW;
 
268
 
 
269
const wchar_t   *el_wgets(EditLine *, int *);
 
270
int              el_wgetc(EditLine *, wchar_t *);
 
271
void             el_wpush(EditLine *, const wchar_t *);
 
272
 
 
273
int              el_wparse(EditLine *, int, const wchar_t **);
 
274
 
 
275
int              el_wset(EditLine *, int, ...);
 
276
int              el_wget(EditLine *, int, ...);
 
277
 
 
278
const LineInfoW *el_wline(EditLine *);
 
279
int              el_winsertstr(EditLine *, const wchar_t *);
 
280
#define          el_wdeletestr  el_deletestr
 
281
 
 
282
/*
 
283
 * ==== History ====
 
284
 */
 
285
typedef struct histeventW {
 
286
        int              num;
 
287
        const wchar_t   *str;
 
288
} HistEventW;
 
289
 
 
290
typedef struct historyW HistoryW;
 
291
 
 
292
HistoryW *      history_winit(void);
 
293
void            history_wend(HistoryW *);
 
294
 
 
295
int             history_w(HistoryW *, HistEventW *, int, ...);
 
296
 
 
297
/*
 
298
 * ==== Tokenization ====
 
299
 */
 
300
typedef struct tokenizerW TokenizerW;
 
301
 
 
302
/* Wide character tokenizer support */
 
303
TokenizerW      *tok_winit(const wchar_t *);
 
304
void             tok_wend(TokenizerW *);
 
305
void             tok_wreset(TokenizerW *);
 
306
int              tok_wline(TokenizerW *, const LineInfoW *,
 
307
                    int *, const wchar_t ***, int *, int *);
 
308
int              tok_wstr(TokenizerW *, const wchar_t *,
 
309
                    int *, const wchar_t ***);
 
310
 
 
311
#ifdef __cplusplus
 
312
}
 
313
#endif
 
314
 
 
315
#endif /* _HISTEDIT_H_ */