1 /* $NetBSD: histedit.h,v 1.22 2003/08/07 16:44:31 agc 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 6 45 46 #include <sys/types.h> 47 #include <stdio.h> 48 49 /* 50 * ==== Editing ==== 51 */ 52 typedef struct editline EditLine; 53 54 /* 55 * For user-defined function interface 56 */ 57 typedef struct lineinfo { 58 const char *buffer; 59 const char *cursor; 60 const char *lastchar; 61 } LineInfo; 62 63 64 /* 65 * EditLine editor function return codes. 66 * For user-defined function interface 67 */ 68 #define CC_NORM 0 69 #define CC_NEWLINE 1 70 #define CC_EOF 2 71 #define CC_ARGHACK 3 72 #define CC_REFRESH 4 73 #define CC_CURSOR 5 74 #define CC_ERROR 6 75 #define CC_FATAL 7 76 #define CC_REDISPLAY 8 77 #define CC_REFRESH_BEEP 9 78 79 /* 80 * Initialization, cleanup, and resetting 81 */ 82 EditLine *el_init(const char *, FILE *, FILE *, FILE *); 83 void el_reset(EditLine *); 84 void el_end(EditLine *); 85 86 87 /* 88 * Get a line, a character or push a string back in the input queue 89 */ 90 const char *el_gets(EditLine *, int *); 91 int el_getc(EditLine *, char *); 92 void el_push(EditLine *, char *); 93 94 /* 95 * Beep! 96 */ 97 void el_beep(EditLine *); 98 99 /* 100 * High level function internals control 101 * Parses argc, argv array and executes builtin editline commands 102 */ 103 int el_parse(EditLine *, int, const char **); 104 105 /* 106 * Low level editline access functions 107 */ 108 int el_set(EditLine *, int, ...); 109 int el_get(EditLine *, int, void *); 110 111 /* 112 * el_set/el_get parameters 113 */ 114 #define EL_PROMPT 0 /* , el_pfunc_t); */ 115 #define EL_TERMINAL 1 /* , const char *); */ 116 #define EL_EDITOR 2 /* , const char *); */ 117 #define EL_SIGNAL 3 /* , int); */ 118 #define EL_BIND 4 /* , const char *, ..., NULL); */ 119 #define EL_TELLTC 5 /* , const char *, ..., NULL); */ 120 #define EL_SETTC 6 /* , const char *, ..., NULL); */ 121 #define EL_ECHOTC 7 /* , const char *, ..., NULL); */ 122 #define EL_SETTY 8 /* , const char *, ..., NULL); */ 123 #define EL_ADDFN 9 /* , const char *, const char * */ 124 /* , el_func_t); */ 125 #define EL_HIST 10 /* , hist_fun_t, const char *); */ 126 #define EL_EDITMODE 11 /* , int); */ 127 #define EL_RPROMPT 12 /* , el_pfunc_t); */ 128 #define EL_GETCFN 13 /* , el_rfunc_t); */ 129 #define EL_CLIENTDATA 14 /* , void *); */ 130 131 #define EL_BUILTIN_GETCFN (NULL) 132 133 /* 134 * Source named file or $PWD/.editrc or $HOME/.editrc 135 */ 136 int el_source(EditLine *, const char *); 137 138 /* 139 * Must be called when the terminal changes size; If EL_SIGNAL 140 * is set this is done automatically otherwise it is the responsibility 141 * of the application 142 */ 143 void el_resize(EditLine *); 144 145 146 /* 147 * User-defined function interface. 148 */ 149 const LineInfo *el_line(EditLine *); 150 int el_insertstr(EditLine *, const char *); 151 void el_deletestr(EditLine *, int); 152 153 /* 154 * ==== History ==== 155 */ 156 157 typedef struct history History; 158 159 typedef struct HistEvent { 160 int num; 161 const char *str; 162 } HistEvent; 163 164 /* 165 * History access functions. 166 */ 167 History * history_init(void); 168 void history_end(History *); 169 170 int history(History *, HistEvent *, int, ...); 171 172 #define H_FUNC 0 /* , UTSL */ 173 #define H_SETSIZE 1 /* , const int); */ 174 #define H_GETSIZE 2 /* , void); */ 175 #define H_FIRST 3 /* , void); */ 176 #define H_LAST 4 /* , void); */ 177 #define H_PREV 5 /* , void); */ 178 #define H_NEXT 6 /* , void); */ 179 #define H_CURR 8 /* , const int); */ 180 #define H_SET 7 /* , int); */ 181 #define H_ADD 9 /* , const char *); */ 182 #define H_ENTER 10 /* , const char *); */ 183 #define H_APPEND 11 /* , const char *); */ 184 #define H_END 12 /* , void); */ 185 #define H_NEXT_STR 13 /* , const char *); */ 186 #define H_PREV_STR 14 /* , const char *); */ 187 #define H_NEXT_EVENT 15 /* , const int); */ 188 #define H_PREV_EVENT 16 /* , const int); */ 189 #define H_LOAD 17 /* , const char *); */ 190 #define H_SAVE 18 /* , const char *); */ 191 #define H_CLEAR 19 /* , void); */ 192 #define H_SETUNIQUE 20 /* , int); */ 193 #define H_GETUNIQUE 21 /* , void); */ 194 195 #endif /* _HISTEDIT_H_ */ 196