mctr2/editline/libedit/src/histedit.h

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