el.h revision 84260 
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 *	@(#)el.h	8.1 (Berkeley) 6/4/93
37 *	$NetBSD: el.h,v 1.7 2000/11/11 22:18:57 christos Exp $
38 * $FreeBSD: head/lib/libedit/el.h 84260 2001-10-01 08:41:27Z obrien $
39 */
40
41/*
42 * el.h: Internal structures.
43 */
44#ifndef _h_el
45#define	_h_el
46/*
47 * Local defaults
48 */
49#define	KSHVI
50#define	VIDEFAULT
51#define	ANCHOR
52
53#include <stdio.h>
54#include <sys/types.h>
55
56#define	EL_BUFSIZ	1024		/* Maximum line size		*/
57
58#define	HANDLE_SIGNALS	1<<0
59#define	NO_TTY		1<<1
60#define	EDIT_DISABLED	1<<2
61
62typedef int bool_t;			/* True or not			*/
63
64typedef unsigned char el_action_t;	/* Index to command array	*/
65
66typedef struct coord_t {		/* Position on the screen	*/
67	int	h;
68	int	v;
69} coord_t;
70
71typedef struct el_line_t {
72	char	*buffer;		/* Input line			*/
73	char	*cursor;		/* Cursor position		*/
74	char	*lastchar;		/* Last character		*/
75	const char	*limit;			/* Max position			*/
76} el_line_t;
77
78/*
79 * Editor state
80 */
81typedef struct el_state_t {
82	int		inputmode;	/* What mode are we in?		*/
83	int		doingarg;	/* Are we getting an argument?	*/
84	int		argument;	/* Numeric argument		*/
85	int		metanext;	/* Is the next char a meta char */
86	el_action_t	lastcmd;	/* Previous command		*/
87} el_state_t;
88
89/*
90 * Until we come up with something better...
91 */
92#define	el_malloc(a)	malloc(a)
93#define	el_realloc(a,b)	realloc(a, b)
94#define el_reallocf(a,b) reallocf(a, b)
95#define	el_free(a)	free(a)
96
97#include "tty.h"
98#include "prompt.h"
99#include "key.h"
100#include "term.h"
101#include "refresh.h"
102#include "chared.h"
103#include "common.h"
104#include "search.h"
105#include "hist.h"
106#include "map.h"
107#include "parse.h"
108#include "sig.h"
109#include "help.h"
110
111struct editline {
112	char		 *el_prog;	/* the program name		*/
113	FILE		 *el_outfile;	/* Stdio stuff			*/
114	FILE		 *el_errfile;	/* Stdio stuff			*/
115	int		  el_infd;	/* Input file descriptor	*/
116	int		  el_flags;	/* Various flags.		*/
117	coord_t		  el_cursor;	/* Cursor location		*/
118	char		**el_display;	/* Real screen image = what is there */
119	char		**el_vdisplay;	/* Virtual screen image = what we see */
120	el_line_t	  el_line;	/* The current line information	*/
121	el_state_t	  el_state;	/* Current editor state		*/
122	el_term_t	  el_term;	/* Terminal dependent stuff	*/
123	el_tty_t	  el_tty;	/* Tty dependent stuff		*/
124	el_refresh_t	  el_refresh;	/* Refresh stuff		*/
125	el_prompt_t	  el_prompt;	/* Prompt stuff			*/
126	el_prompt_t	  el_rprompt;	/* Prompt stuff			*/
127	el_chared_t	  el_chared;	/* Characted editor stuff	*/
128	el_map_t	  el_map;	/* Key mapping stuff		*/
129	el_key_t	  el_key;	/* Key binding stuff		*/
130	el_history_t	  el_history;	/* History stuff		*/
131	el_search_t	  el_search;	/* Search stuff			*/
132	el_signal_t	  el_signal;	/* Signal handling stuff	*/
133
134	void		 *data;		/* user data */
135};
136
137protected int	el_editmode(EditLine *, int, char **);
138
139#ifdef DEBUG
140#define EL_ABORT(a)	(void) (fprintf(el->el_errfile, "%s, %d: ", \
141				__FILE__, __LINE__), fprintf a, abort())
142#else
143#define EL_ABORT(a)	abort()
144#endif
145#endif /* _h_el */
146