90cc1fbc53
would expect. (Allow user data to be associated with an EditLine context). As this changes no existing interfaces and doesn't alter any structs visable to the user I've been told that its not necessary to bump the version of the library.
183 lines
5.4 KiB
C
183 lines
5.4 KiB
C
/* $Id: histedit.h,v 1.3 1997/06/25 09:47:31 msmith Exp $ */
|
|
/* $NetBSD: histedit.h,v 1.5 1997/04/11 17:52:45 christos Exp $ */
|
|
|
|
/*-
|
|
* Copyright (c) 1992, 1993
|
|
* The Regents of the University of California. All rights reserved.
|
|
*
|
|
* This code is derived from software contributed to Berkeley by
|
|
* Christos Zoulas of Cornell University.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* 3. All advertising materials mentioning features or use of this software
|
|
* must display the following acknowledgement:
|
|
* This product includes software developed by the University of
|
|
* California, Berkeley and its contributors.
|
|
* 4. Neither the name of the University nor the names of its contributors
|
|
* may be used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*
|
|
* @(#)histedit.h 8.2 (Berkeley) 1/3/94
|
|
*/
|
|
|
|
/*
|
|
* histedit.h: Line editor and history interface.
|
|
*/
|
|
#ifndef _h_editline
|
|
#define _h_editline
|
|
|
|
#include <sys/types.h>
|
|
#include <stdio.h>
|
|
|
|
/*
|
|
* ==== Editing ====
|
|
*/
|
|
typedef struct editline EditLine;
|
|
|
|
/*
|
|
* For user-defined function interface
|
|
*/
|
|
typedef struct lineinfo {
|
|
const char *buffer;
|
|
const char *cursor;
|
|
const char *lastchar;
|
|
} LineInfo;
|
|
|
|
|
|
/*
|
|
* EditLine editor function return codes.
|
|
* For user-defined function interface
|
|
*/
|
|
#define CC_NORM 0
|
|
#define CC_NEWLINE 1
|
|
#define CC_EOF 2
|
|
#define CC_ARGHACK 3
|
|
#define CC_REFRESH 4
|
|
#define CC_CURSOR 5
|
|
#define CC_ERROR 6
|
|
#define CC_FATAL 7
|
|
#define CC_REDISPLAY 8
|
|
|
|
/*
|
|
* Initialization, cleanup, and resetting
|
|
*/
|
|
EditLine *el_init __P((const char *, FILE *, FILE *));
|
|
void el_reset __P((EditLine *));
|
|
void el_end __P((EditLine *));
|
|
|
|
|
|
/*
|
|
* Get a line, a character or push a string back in the input queue
|
|
*/
|
|
const char *el_gets __P((EditLine *, int *));
|
|
int el_getc __P((EditLine *, char *));
|
|
void el_push __P((EditLine *, const char *));
|
|
|
|
/*
|
|
* High level function internals control
|
|
* Parses argc, argv array and executes builtin editline commands
|
|
*/
|
|
int el_parse __P((EditLine *, int, char **));
|
|
|
|
/*
|
|
* Low level editline access function
|
|
*/
|
|
int el_set __P((EditLine *, int, ...));
|
|
|
|
/*
|
|
* el_set/el_get parameters
|
|
*/
|
|
#define EL_PROMPT 0 /* , el_pfunc_t); */
|
|
#define EL_TERMINAL 1 /* , const char *); */
|
|
#define EL_EDITOR 2 /* , const char *); */
|
|
#define EL_SIGNAL 3 /* , int); */
|
|
#define EL_BIND 4 /* , const char *, ..., NULL); */
|
|
#define EL_TELLTC 5 /* , const char *, ..., NULL); */
|
|
#define EL_SETTC 6 /* , const char *, ..., NULL); */
|
|
#define EL_ECHOTC 7 /* , const char *, ..., NULL); */
|
|
#define EL_SETTY 8 /* , const char *, ..., NULL); */
|
|
#define EL_ADDFN 9 /* , const char *, const char * */
|
|
/* , el_func_t); */
|
|
#define EL_HIST 10 /* , hist_fun_t, const char *); */
|
|
|
|
/*
|
|
* Source named file or $PWD/.editrc or $HOME/.editrc
|
|
*/
|
|
int el_source __P((EditLine *, const char *));
|
|
|
|
/*
|
|
* Must be called when the terminal changes size; If EL_SIGNAL
|
|
* is set this is done automatically otherwise it is the responsibility
|
|
* of the application
|
|
*/
|
|
void el_resize __P((EditLine *));
|
|
|
|
void el_data_set __P((EditLine *, void *));
|
|
void * el_data_get __P((EditLine *));
|
|
|
|
|
|
/*
|
|
* User-defined function interface.
|
|
*/
|
|
const LineInfo *el_line __P((EditLine *));
|
|
int el_insertstr __P((EditLine *, char *));
|
|
void el_deletestr __P((EditLine *, int));
|
|
|
|
/*
|
|
* ==== History ====
|
|
*/
|
|
|
|
typedef struct history History;
|
|
|
|
typedef struct HistEvent {
|
|
int num;
|
|
const char *str;
|
|
} HistEvent;
|
|
|
|
/*
|
|
* History access functions.
|
|
*/
|
|
History * history_init __P((void));
|
|
void history_end __P((History *));
|
|
|
|
const HistEvent * history __P((History *, int, ...));
|
|
|
|
#define H_FUNC 0 /* , UTSL */
|
|
#define H_EVENT 1 /* , const int); */
|
|
#define H_FIRST 2 /* , void); */
|
|
#define H_LAST 3 /* , void); */
|
|
#define H_PREV 4 /* , void); */
|
|
#define H_NEXT 5 /* , void); */
|
|
#define H_CURR 6 /* , void); */
|
|
#define H_ADD 7 /* , const char*); */
|
|
#define H_ENTER 8 /* , const char*); */
|
|
#define H_END 9 /* , void); */
|
|
#define H_NEXT_STR 10 /* , const char*); */
|
|
#define H_PREV_STR 11 /* , const char*); */
|
|
#define H_NEXT_EVENT 12 /* , const int); */
|
|
#define H_PREV_EVENT 13 /* , const int); */
|
|
#define H_LOAD 14 /* , const char *); */
|
|
#define H_SAVE 15 /* , const char *); */
|
|
#define H_CLEAR 16 /* , void); */
|
|
|
|
#endif /* _h_editline */
|