include/histedit.h

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