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