1 /* $NetBSD: histedit.h,v 1.18 2001/10/09 13:50:30 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. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the University of 21 * California, Berkeley and its contributors. 22 * 4. Neither the name of the University nor the names of its contributors 23 * may be used to endorse or promote products derived from this software 24 * without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 36 * SUCH DAMAGE. 37 * 38 * @(#)histedit.h 8.2 (Berkeley) 1/3/94 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 /* 51 * ==== Editing ==== 52 */ 53 typedef struct editline EditLine; 54 55 /* 56 * For user-defined function interface 57 */ 58 typedef struct lineinfo { 59 const char *buffer; 60 const char *cursor; 61 const char *lastchar; 62 } LineInfo; 63 64 65 /* 66 * EditLine editor function return codes. 67 * For user-defined function interface 68 */ 69 #define CC_NORM 0 70 #define CC_NEWLINE 1 71 #define CC_EOF 2 72 #define CC_ARGHACK 3 73 #define CC_REFRESH 4 74 #define CC_CURSOR 5 75 #define CC_ERROR 6 76 #define CC_FATAL 7 77 #define CC_REDISPLAY 8 78 #define CC_REFRESH_BEEP 9 79 80 /* 81 * Initialization, cleanup, and resetting 82 */ 83 EditLine *el_init(const char *, FILE *, FILE *, FILE *); 84 void el_reset(EditLine *); 85 void el_end(EditLine *); 86 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 *, const 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, char **); 105 106 /* 107 * Low level editline access functions 108 */ 109 int el_set(EditLine *, int, ...); 110 int el_get(EditLine *, int, void *); 111 112 /* 113 * el_set/el_get parameters 114 */ 115 #define EL_PROMPT 0 /* , el_pfunc_t); */ 116 #define EL_TERMINAL 1 /* , const char *); */ 117 #define EL_EDITOR 2 /* , const char *); */ 118 #define EL_SIGNAL 3 /* , int); */ 119 #define EL_BIND 4 /* , const char *, ..., NULL); */ 120 #define EL_TELLTC 5 /* , const char *, ..., NULL); */ 121 #define EL_SETTC 6 /* , const char *, ..., NULL); */ 122 #define EL_ECHOTC 7 /* , const char *, ..., NULL); */ 123 #define EL_SETTY 8 /* , const char *, ..., NULL); */ 124 #define EL_ADDFN 9 /* , const char *, const char * */ 125 /* , el_func_t); */ 126 #define EL_HIST 10 /* , hist_fun_t, const char *); */ 127 #define EL_EDITMODE 11 /* , int); */ 128 #define EL_RPROMPT 12 /* , el_pfunc_t); */ 129 #define EL_GETCFN 13 /* , el_rfunc_t); */ 130 #define EL_CLIENTDATA 14 /* , void *); */ 131 132 #define EL_BUILTIN_GETCFN (NULL) 133 134 /* 135 * Source named file or $PWD/.editrc or $HOME/.editrc 136 */ 137 int el_source(EditLine *, const char *); 138 139 /* 140 * Must be called when the terminal changes size; If EL_SIGNAL 141 * is set this is done automatically otherwise it is the responsibility 142 * of the application 143 */ 144 void el_resize(EditLine *); 145 146 147 /* 148 * User-defined function interface. 149 */ 150 const LineInfo *el_line(EditLine *); 151 int el_insertstr(EditLine *, const char *); 152 void el_deletestr(EditLine *, int); 153 154 /* 155 * ==== History ==== 156 */ 157 158 typedef struct history History; 159 160 typedef struct HistEvent { 161 int num; 162 const char *str; 163 } HistEvent; 164 165 /* 166 * History access functions. 167 */ 168 History * history_init(void); 169 void history_end(History *); 170 171 int history(History *, HistEvent *, int, ...); 172 173 #define H_FUNC 0 /* , UTSL */ 174 #define H_SETSIZE 1 /* , const int); */ 175 #define H_GETSIZE 2 /* , void); */ 176 #define H_FIRST 3 /* , void); */ 177 #define H_LAST 4 /* , void); */ 178 #define H_PREV 5 /* , void); */ 179 #define H_NEXT 6 /* , void); */ 180 #define H_CURR 8 /* , const int); */ 181 #define H_SET 7 /* , void); */ 182 #define H_ADD 9 /* , const char *); */ 183 #define H_ENTER 10 /* , const char *); */ 184 #define H_APPEND 11 /* , const char *); */ 185 #define H_END 12 /* , void); */ 186 #define H_NEXT_STR 13 /* , const char *); */ 187 #define H_PREV_STR 14 /* , const char *); */ 188 #define H_NEXT_EVENT 15 /* , const int); */ 189 #define H_PREV_EVENT 16 /* , const int); */ 190 #define H_LOAD 17 /* , const char *); */ 191 #define H_SAVE 18 /* , const char *); */ 192 #define H_CLEAR 19 /* , void); */ 193 194 #endif /* _HISTEDIT_H_ */ 195