include/histedit.h

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