histedit.h revision 278411
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. Neither the name of the University nor the names of its contributors 17 * may be used to endorse or promote products derived from this software 18 * without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 * 32 * @(#)histedit.h 8.2 (Berkeley) 1/3/94 33 * $NetBSD: histedit.h,v 1.41 2009/09/07 21:24:33 christos Exp $ 34 * $FreeBSD: stable/10/lib/libedit/histedit.h 278411 2015-02-08 22:11:24Z bapt $ 35 */ 36 37/* 38 * histedit.h: Line editor and history interface. 39 */ 40#ifndef _HISTEDIT_H_ 41#define _HISTEDIT_H_ 42 43#include <sys/types.h> 44#include <stdio.h> 45 46__BEGIN_DECLS 47#ifdef __cplusplus 48extern "C" { 49#endif 50 51/* 52 * ==== Editing ==== 53 */ 54 55typedef struct editline EditLine; 56 57/* 58 * For user-defined function interface 59 */ 60typedef struct lineinfo { 61 const char *buffer; 62 const char *cursor; 63 const char *lastchar; 64} LineInfo; 65 66/* 67 * EditLine editor function return codes. 68 * For user-defined function interface 69 */ 70#define CC_NORM 0 71#define CC_NEWLINE 1 72#define CC_EOF 2 73#define CC_ARGHACK 3 74#define CC_REFRESH 4 75#define CC_CURSOR 5 76#define CC_ERROR 6 77#define CC_FATAL 7 78#define CC_REDISPLAY 8 79#define CC_REFRESH_BEEP 9 80 81/* 82 * Initialization, cleanup, and resetting 83 */ 84EditLine *el_init(const char *, FILE *, FILE *, FILE *); 85void el_end(EditLine *); 86void el_reset(EditLine *); 87 88/* 89 * Get a line, a character or push a string back in the input queue 90 */ 91const char *el_gets(EditLine *, int *); 92int el_getc(EditLine *, char *); 93void el_push(EditLine *, const char *); 94 95/* 96 * Beep! 97 */ 98void el_beep(EditLine *); 99 100/* 101 * High level function internals control 102 * Parses argc, argv array and executes builtin editline commands 103 */ 104int el_parse(EditLine *, int, const char **); 105 106/* 107 * Low level editline access functions 108 */ 109int el_set(EditLine *, int, ...); 110int el_get(EditLine *, int, ...); 111unsigned char _el_fn_complete(EditLine *, int); 112unsigned char _el_fn_sh_complete(EditLine *, int); 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#define EL_GETCFN 13 /* , el_rfunc_t); */ 132#define EL_CLIENTDATA 14 /* , void *); */ 133#define EL_UNBUFFERED 15 /* , int); */ 134#define EL_PREP_TERM 16 /* , int); */ 135#define EL_GETTC 17 /* , const char *, ..., NULL); */ 136#define EL_GETFP 18 /* , int, FILE **); */ 137#define EL_SETFP 19 /* , int, FILE *); */ 138#define EL_REFRESH 20 /* , void); set */ 139#define EL_PROMPT_ESC 21 /* , prompt_func, Char); set/get */ 140#define EL_RPROMPT_ESC 22 /* , prompt_func, Char); set/get */ 141#define EL_RESIZE 23 /* , el_zfunc_t, void *); set */ 142 143#define EL_BUILTIN_GETCFN (NULL) 144 145/* 146 * Source named file or $PWD/.editrc or $HOME/.editrc 147 */ 148int el_source(EditLine *, const char *); 149 150/* 151 * Must be called when the terminal changes size; If EL_SIGNAL 152 * is set this is done automatically otherwise it is the responsibility 153 * of the application 154 */ 155void el_resize(EditLine *); 156 157/* 158 * User-defined function interface. 159 */ 160const LineInfo *el_line(EditLine *); 161int el_insertstr(EditLine *, const char *); 162void el_deletestr(EditLine *, int); 163 164 165/* 166 * ==== History ==== 167 */ 168 169typedef struct history History; 170 171typedef struct HistEvent { 172 int num; 173 const char *str; 174} HistEvent; 175 176/* 177 * History access functions. 178 */ 179History * history_init(void); 180void history_end(History *); 181 182int history(History *, HistEvent *, int, ...); 183 184#define H_FUNC 0 /* , UTSL */ 185#define H_SETSIZE 1 /* , const int); */ 186#define H_EVENT 1 /* , const int); */ 187#define H_GETSIZE 2 /* , void); */ 188#define H_FIRST 3 /* , void); */ 189#define H_LAST 4 /* , void); */ 190#define H_PREV 5 /* , void); */ 191#define H_NEXT 6 /* , void); */ 192#define H_CURR 8 /* , const int); */ 193#define H_SET 7 /* , int); */ 194#define H_ADD 9 /* , const char *); */ 195#define H_ENTER 10 /* , const char *); */ 196#define H_APPEND 11 /* , const char *); */ 197#define H_END 12 /* , void); */ 198#define H_NEXT_STR 13 /* , const char *); */ 199#define H_PREV_STR 14 /* , const char *); */ 200#define H_NEXT_EVENT 15 /* , const int); */ 201#define H_PREV_EVENT 16 /* , const int); */ 202#define H_LOAD 17 /* , const char *); */ 203#define H_SAVE 18 /* , const char *); */ 204#define H_CLEAR 19 /* , void); */ 205#define H_SETUNIQUE 20 /* , int); */ 206#define H_GETUNIQUE 21 /* , void); */ 207#define H_DEL 22 /* , int); */ 208#define H_NEXT_EVDATA 23 /* , const int, histdata_t *); */ 209#define H_DELDATA 24 /* , int, histdata_t *);*/ 210#define H_REPLACE 25 /* , const char *, histdata_t); */ 211#define H_SAVE_FP 26 /* , FILE*); */ 212 213 214/* 215 * ==== Tokenization ==== 216 */ 217 218typedef struct tokenizer Tokenizer; 219 220/* 221 * String tokenization functions, using simplified sh(1) quoting rules 222 */ 223Tokenizer *tok_init(const char *); 224void tok_end(Tokenizer *); 225void tok_reset(Tokenizer *); 226int tok_line(Tokenizer *, const LineInfo *, 227 int *, const char ***, int *, int *); 228int tok_str(Tokenizer *, const char *, 229 int *, const char ***); 230 231__END_DECLS 232#ifdef __cplusplus 233} 234#endif 235 236#endif /* _HISTEDIT_H_ */ 237