histedit.h revision 84326
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. All advertising materials mentioning features or use of this software 17 * must display the following acknowledgement: 18 * This product includes software developed by the University of 19 * California, Berkeley and its contributors. 20 * 4. Neither the name of the University nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 * 36 * @(#)histedit.h 8.2 (Berkeley) 1/3/94 37 * $NetBSD: histedit.h,v 1.15 2000/02/28 17:41:05 chopps Exp $ 38 * $FreeBSD: head/include/histedit.h 84326 2001-10-01 21:07:33Z obrien $ 39 */ 40 41/* 42 * histedit.h: Line editor and history interface. 43 */ 44#ifndef _HISTEDIT_H_ 45#define _HISTEDIT_H_ 46 47#include <sys/types.h> 48#include <stdio.h> 49 50/* 51 * ==== Editing ==== 52 */ 53typedef struct editline EditLine; 54 55/* 56 * For user-defined function interface 57 */ 58typedef struct lineinfo { 59 const char *buffer; 60 const char *cursor; 61 const char *lastchar; 62} LineInfo; 63 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_reset(EditLine *); 85void el_end(EditLine *); 86 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, char **); 105 106/* 107 * Low level editline access functions 108 */ 109int el_set(EditLine *, int, ...); 110int el_get(EditLine *, int, void *); 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 130/* 131 * Source named file or $PWD/.editrc or $HOME/.editrc 132 */ 133int el_source(EditLine *, const char *); 134 135/* 136 * Must be called when the terminal changes size; If EL_SIGNAL 137 * is set this is done automatically otherwise it is the responsibility 138 * of the application 139 */ 140void el_resize(EditLine *); 141 142 143/* 144 * User-defined function interface. 145 */ 146const LineInfo *el_line(EditLine *); 147int el_insertstr(EditLine *, const char *); 148void el_deletestr(EditLine *, int); 149 150/* 151 * ==== History ==== 152 */ 153 154typedef struct history History; 155 156typedef struct HistEvent { 157 int num; 158 const char *str; 159} HistEvent; 160 161/* 162 * History access functions. 163 */ 164History * history_init(void); 165void history_end(History *); 166 167int history(History *, HistEvent *, int, ...); 168 169#define H_FUNC 0 /* , UTSL */ 170#define H_SETSIZE 1 /* , const int); */ 171#define H_EVENT 1 /* , const int); */ 172#define H_GETSIZE 2 /* , void); */ 173#define H_FIRST 3 /* , void); */ 174#define H_LAST 4 /* , void); */ 175#define H_PREV 5 /* , void); */ 176#define H_NEXT 6 /* , void); */ 177#define H_CURR 8 /* , const int); */ 178#define H_SET 7 /* , void); */ 179#define H_ADD 9 /* , const char *); */ 180#define H_ENTER 10 /* , const char *); */ 181#define H_APPEND 11 /* , const char *); */ 182#define H_END 12 /* , void); */ 183#define H_NEXT_STR 13 /* , const char *); */ 184#define H_PREV_STR 14 /* , const char *); */ 185#define H_NEXT_EVENT 15 /* , const int); */ 186#define H_PREV_EVENT 16 /* , const int); */ 187#define H_LOAD 17 /* , const char *); */ 188#define H_SAVE 18 /* , const char *); */ 189#define H_CLEAR 19 /* , void); */ 190 191#endif /* _HISTEDIT_H_ */ 192