histedit.h revision 1841
1251876Speter/*- 2251876Speter * Copyright (c) 1992, 1993 3251876Speter * The Regents of the University of California. All rights reserved. 4251876Speter * 5251876Speter * This code is derived from software contributed to Berkeley by 6251876Speter * Christos Zoulas of Cornell University. 7251876Speter * 8251876Speter * Redistribution and use in source and binary forms, with or without 9251876Speter * modification, are permitted provided that the following conditions 10251876Speter * are met: 11251876Speter * 1. Redistributions of source code must retain the above copyright 12251876Speter * notice, this list of conditions and the following disclaimer. 13251876Speter * 2. Redistributions in binary form must reproduce the above copyright 14251876Speter * notice, this list of conditions and the following disclaimer in the 15251876Speter * documentation and/or other materials provided with the distribution. 16251876Speter * 3. All advertising materials mentioning features or use of this software 17251876Speter * must display the following acknowledgement: 18251876Speter * This product includes software developed by the University of 19251876Speter * California, Berkeley and its contributors. 20251876Speter * 4. Neither the name of the University nor the names of its contributors 21251876Speter * may be used to endorse or promote products derived from this software 22251876Speter * without specific prior written permission. 23251876Speter * 24251876Speter * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25251876Speter * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26251876Speter * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27251876Speter * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28251876Speter * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29251876Speter * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30251876Speter * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31251876Speter * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32251876Speter * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33251876Speter * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34251876Speter * SUCH DAMAGE. 35251876Speter * 36251876Speter * @(#)histedit.h 8.2 (Berkeley) 1/3/94 37251876Speter */ 38251876Speter 39251876Speter/* 40251876Speter * histedit.h: Line editor and history interface. 41251876Speter */ 42251876Speter#ifndef _h_editline 43251876Speter#define _h_editline 44251876Speter 45251876Speter#include <sys/types.h> 46251876Speter#include <stdio.h> 47251876Speter 48251876Speter/* 49251876Speter * ==== Editing ==== 50251876Speter */ 51251876Spetertypedef struct editline EditLine; 52251876Speter 53251876Speter/* 54251876Speter * For user-defined function interface 55251876Speter */ 56251876Spetertypedef struct lineinfo { 57251876Speter __const char *buffer; 58251876Speter __const char *cursor; 59251876Speter __const char *lastchar; 60251876Speter} LineInfo; 61251876Speter 62251876Speter 63251876Speter/* 64251876Speter * EditLine editor function return codes. 65251876Speter * For user-defined function interface 66251876Speter */ 67251876Speter#define CC_NORM 0 68251876Speter#define CC_NEWLINE 1 69251876Speter#define CC_EOF 2 70251876Speter#define CC_ARGHACK 3 71251876Speter#define CC_REFRESH 4 72251876Speter#define CC_CURSOR 5 73251876Speter#define CC_ERROR 6 74251876Speter#define CC_FATAL 7 75251876Speter 76251876Speter/* 77251876Speter * Initialization, cleanup, and resetting 78251876Speter */ 79251876SpeterEditLine *el_init __P((const char *, FILE *, FILE *)); 80251876Spetervoid el_reset __P((EditLine *)); 81251876Spetervoid el_end __P((EditLine *)); 82251876Speter 83251876Speter 84251876Speter/* 85251876Speter * Get a line, a character or push a string back in the input queue 86251876Speter */ 87251876Speter__const char *el_gets __P((EditLine *, int *)); 88251876Speterint el_getc __P((EditLine *, char *)); 89251876Spetervoid el_push __P((EditLine *, const char *)); 90251876Speter 91251876Speter/* 92251876Speter * High level function internals control 93251876Speter * Parses argc, argv array and executes builtin editline commands 94251876Speter */ 95251876Speterint el_parse __P((EditLine *, int, char **)); 96251876Speter 97251876Speter/* 98251876Speter * Low level editline access function 99251876Speter */ 100251876Speterint el_set __P((EditLine *, int, ...)); 101251876Speter 102251876Speter/* 103251876Speter * el_set/el_get parameters 104251876Speter */ 105251876Speter#define EL_PROMPT 0 /* , el_pfunc_t); */ 106251876Speter#define EL_TERMINAL 1 /* , const char *); */ 107251876Speter#define EL_EDITOR 2 /* , const char *); */ 108251876Speter#define EL_SIGNAL 3 /* , int); */ 109251876Speter#define EL_BIND 4 /* , const char *, ..., NULL); */ 110251876Speter#define EL_TELLTC 5 /* , const char *, ..., NULL); */ 111251876Speter#define EL_SETTC 6 /* , const char *, ..., NULL); */ 112251876Speter#define EL_ECHOTC 7 /* , const char *, ..., NULL); */ 113251876Speter#define EL_SETTY 8 /* , const char *, ..., NULL); */ 114251876Speter#define EL_ADDFN 9 /* , const char *, const char * */ 115251876Speter /* , el_func_t); */ 116251876Speter#define EL_HIST 10 /* , hist_fun_t, const char *); */ 117251876Speter 118251876Speter/* 119251876Speter * Source named file or $PWD/.editrc or $HOME/.editrc 120251876Speter */ 121251876Speterint el_source __P((EditLine *, const char *)); 122251876Speter 123251876Speter/* 124251876Speter * Must be called when the terminal changes size; If EL_SIGNAL 125251876Speter * is set this is done automatically otherwise it is the responsibility 126251876Speter * of the application 127251876Speter */ 128251876Spetervoid el_resize __P((EditLine *)); 129251876Speter 130251876Speter 131251876Speter/* 132251876Speter * User-defined function interface. 133251876Speter */ 134251876Speter__const LineInfo *el_line __P((EditLine *)); 135251876Speterint el_insertstr __P((EditLine *, char *)); 136251876Spetervoid el_deletestr __P((EditLine *, int)); 137251876Speter 138251876Speter/* 139251876Speter * ==== History ==== 140251876Speter */ 141251876Speter 142251876Spetertypedef struct history History; 143251876Speter 144251876Spetertypedef struct HistEvent { 145251876Speter int num; 146251876Speter __const char *str; 147251876Speter} HistEvent; 148251876Speter 149251876Speter/* 150251876Speter * History access functions. 151251876Speter */ 152251876SpeterHistory * history_init __P((void)); 153251876Spetervoid history_end __P((History *)); 154251876Speter 155251876Speter__const HistEvent * history __P((History *, int, ...)); 156251876Speter 157251876Speter#define H_FUNC 0 /* , UTSL */ 158251876Speter#define H_EVENT 1 /* , const int); */ 159251876Speter#define H_FIRST 2 /* , void); */ 160251876Speter#define H_LAST 3 /* , void); */ 161251876Speter#define H_PREV 4 /* , void); */ 162251876Speter#define H_NEXT 5 /* , void); */ 163251876Speter#define H_CURR 6 /* , void); */ 164251876Speter#define H_ADD 7 /* , const char*); */ 165251876Speter#define H_ENTER 8 /* , const char*); */ 166251876Speter#define H_END 9 /* , void); */ 167251876Speter#define H_NEXT_STR 10 /* , const char*); */ 168251876Speter#define H_PREV_STR 11 /* , const char*); */ 169251876Speter#define H_NEXT_EVENT 12 /* , const int); */ 170251876Speter#define H_PREV_EVENT 13 /* , const int); */ 171251876Speter 172251876Speter#endif /* _h_editline */ 173251876Speter