lib/libedit/histedit.h

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