1/* $NetBSD: histedit.h,v 1.3 2005/05/31 02:07:02 lukem Exp $ */ 2/* from NetBSD: histedit.h,v 1.26 2005/05/07 16:01:25 dsl 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 9 46 47#include <sys/types.h> 48#include <stdio.h> 49 50/* 51 * ==== Editing ==== 52 */ 53 54typedef struct editline EditLine; 55 56/* 57 * For user-defined function interface 58 */ 59typedef struct lineinfo { 60 const char *buffer; 61 const char *cursor; 62 const char *lastchar; 63} LineInfo; 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 */ 83EditLine *el_init(const char *, FILE *, FILE *, FILE *); 84void el_end(EditLine *); 85void el_reset(EditLine *); 86 87/* 88 * Get a line, a character or push a string back in the input queue 89 */ 90const char *el_gets(EditLine *, int *); 91int el_getc(EditLine *, char *); 92void el_push(EditLine *, char *); 93 94/* 95 * Beep! 96 */ 97void el_beep(EditLine *); 98 99/* 100 * High level function internals control 101 * Parses argc, argv array and executes builtin editline commands 102 */ 103int el_parse(EditLine *, int, const char **); 104 105/* 106 * Low level editline access functions 107 */ 108int el_set(EditLine *, int, ...); 109int el_get(EditLine *, int, void *); 110unsigned char _el_fn_complete(EditLine *, int); 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#define EL_UNBUFFERED 15 /* , int); */ 132#define EL_PREP_TERM 16 /* , int); */ 133 134#define EL_BUILTIN_GETCFN (NULL) 135 136/* 137 * Source named file or $PWD/.editrc or $HOME/.editrc 138 */ 139int el_source(EditLine *, const char *); 140 141/* 142 * Must be called when the terminal changes size; If EL_SIGNAL 143 * is set this is done automatically otherwise it is the responsibility 144 * of the application 145 */ 146void el_resize(EditLine *); 147 148/* 149 * User-defined function interface. 150 */ 151const LineInfo *el_line(EditLine *); 152int el_insertstr(EditLine *, const char *); 153void el_deletestr(EditLine *, int); 154 155 156/* 157 * ==== History ==== 158 */ 159 160typedef struct history History; 161 162typedef struct HistEvent { 163 int num; 164 const char *str; 165} HistEvent; 166 167/* 168 * History access functions. 169 */ 170History * history_init(void); 171void history_end(History *); 172 173int history(History *, HistEvent *, int, ...); 174 175#define H_FUNC 0 /* , UTSL */ 176#define H_SETSIZE 1 /* , const int); */ 177#define H_GETSIZE 2 /* , void); */ 178#define H_FIRST 3 /* , void); */ 179#define H_LAST 4 /* , void); */ 180#define H_PREV 5 /* , void); */ 181#define H_NEXT 6 /* , void); */ 182#define H_CURR 8 /* , const int); */ 183#define H_SET 7 /* , int); */ 184#define H_ADD 9 /* , const char *); */ 185#define H_ENTER 10 /* , const char *); */ 186#define H_APPEND 11 /* , const char *); */ 187#define H_END 12 /* , void); */ 188#define H_NEXT_STR 13 /* , const char *); */ 189#define H_PREV_STR 14 /* , const char *); */ 190#define H_NEXT_EVENT 15 /* , const int); */ 191#define H_PREV_EVENT 16 /* , const int); */ 192#define H_LOAD 17 /* , const char *); */ 193#define H_SAVE 18 /* , const char *); */ 194#define H_CLEAR 19 /* , void); */ 195#define H_SETUNIQUE 20 /* , int); */ 196#define H_GETUNIQUE 21 /* , void); */ 197 198 199/* 200 * ==== Tokenization ==== 201 */ 202 203typedef struct tokenizer Tokenizer; 204 205/* 206 * String tokenization functions, using simplified sh(1) quoting rules 207 */ 208Tokenizer *tok_init(const char *); 209void tok_end(Tokenizer *); 210void tok_reset(Tokenizer *); 211int tok_line(Tokenizer *, const LineInfo *, 212 int *, const char ***, int *, int *); 213int tok_str(Tokenizer *, const char *, 214 int *, const char ***); 215 216#endif /* _HISTEDIT_H_ */ 217