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