xref: /openbsd-src/lib/libedit/el.h (revision 43003dfe3ad45d1698bed8a37f2b0f5b14f20d4f)
1 /*	$OpenBSD: el.h,v 1.6 2003/11/25 20:12:38 otto Exp $	*/
2 /*	$NetBSD: el.h,v 1.16 2003/10/18 23:48:42 christos 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  *	@(#)el.h	8.1 (Berkeley) 6/4/93
36  */
37 
38 /*
39  * el.h: Internal structures.
40  */
41 #ifndef _h_el
42 #define	_h_el
43 /*
44  * Local defaults
45  */
46 #define	KSHVI
47 #define	VIDEFAULT
48 #define	ANCHOR
49 
50 #include <stdio.h>
51 #include <sys/types.h>
52 
53 #define	EL_BUFSIZ	1024		/* Maximum line size		*/
54 
55 #define	HANDLE_SIGNALS	0x01
56 #define	NO_TTY		0x02
57 #define	EDIT_DISABLED	0x04
58 #define	UNBUFFERED	0x08
59 
60 typedef int bool_t;			/* True or not			*/
61 
62 typedef unsigned char el_action_t;	/* Index to command array	*/
63 
64 typedef struct coord_t {		/* Position on the screen	*/
65 	int	h;
66 	int	v;
67 } coord_t;
68 
69 typedef struct el_line_t {
70 	char	*buffer;		/* Input line			*/
71 	char	*cursor;		/* Cursor position		*/
72 	char	*lastchar;		/* Last character		*/
73 	const char	*limit;		/* Max position			*/
74 } el_line_t;
75 
76 /*
77  * Editor state
78  */
79 typedef struct el_state_t {
80 	int		inputmode;	/* What mode are we in?		*/
81 	int		doingarg;	/* Are we getting an argument?	*/
82 	int		argument;	/* Numeric argument		*/
83 	int		metanext;	/* Is the next char a meta char */
84 	el_action_t	lastcmd;	/* Previous command		*/
85 	el_action_t	thiscmd;	/* this command 		*/
86 	char		thisch;		/* char that generated it	*/
87 } el_state_t;
88 
89 /*
90  * Until we come up with something better...
91  */
92 #define	el_strdup(a)	strdup(a)
93 #define	el_malloc(a)	malloc(a)
94 #define	el_realloc(a,b)	realloc(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 #include "read.h"
111 
112 struct editline {
113 	char		 *el_prog;	/* the program name		*/
114 	FILE		 *el_outfile;	/* Stdio stuff			*/
115 	FILE		 *el_errfile;	/* Stdio stuff			*/
116 	int		  el_infd;	/* Input file descriptor	*/
117 	int		  el_flags;	/* Various flags.		*/
118 	coord_t		  el_cursor;	/* Cursor location		*/
119 	char		**el_display;	/* Real screen image = what is there */
120 	char		**el_vdisplay;	/* Virtual screen image = what we see */
121 	void		 *el_data;	/* Client data			*/
122 	el_line_t	  el_line;	/* The current line information	*/
123 	el_state_t	  el_state;	/* Current editor state		*/
124 	el_term_t	  el_term;	/* Terminal dependent stuff	*/
125 	el_tty_t	  el_tty;	/* Tty dependent stuff		*/
126 	el_refresh_t	  el_refresh;	/* Refresh stuff		*/
127 	el_prompt_t	  el_prompt;	/* Prompt stuff			*/
128 	el_prompt_t	  el_rprompt;	/* Prompt stuff			*/
129 	el_chared_t	  el_chared;	/* Characted editor stuff	*/
130 	el_map_t	  el_map;	/* Key mapping stuff		*/
131 	el_key_t	  el_key;	/* Key binding stuff		*/
132 	el_history_t	  el_history;	/* History stuff		*/
133 	el_search_t	  el_search;	/* Search stuff			*/
134 	el_signal_t	  el_signal;	/* Signal handling stuff	*/
135 	el_read_t	  el_read;	/* Character reading stuff	*/
136 };
137 
138 protected int	el_editmode(EditLine *, int, const char **);
139 
140 #ifdef DEBUG
141 #define	EL_ABORT(a)	do { \
142 				fprintf(el->el_errfile, "%s, %d: ", \
143 					 __FILE__, __LINE__); \
144 				fprintf a; \
145 				abort(); \
146 			} while( /*CONSTCOND*/0);
147 #else
148 #define EL_ABORT(a)	abort()
149 #endif
150 #endif /* _h_el */
151