xref: /trueos/lib/libedit/el.h (revision bc4be3dff1bc1b0cdc3ea30df0fd3e83998cf9eb)
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. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  *	@(#)el.h	8.1 (Berkeley) 6/4/93
33  *	$NetBSD: el.h,v 1.17 2006/12/15 22:13:33 christos Exp $
34  * $FreeBSD$
35  */
36 
37 /*
38  * el.h: Internal structures.
39  */
40 #ifndef _h_el
41 #define	_h_el
42 /*
43  * Local defaults
44  */
45 #define	KSHVI
46 #define	VIDEFAULT
47 #define	ANCHOR
48 
49 #include <stdio.h>
50 #include <sys/types.h>
51 
52 #define	EL_BUFSIZ	1024		/* Maximum line size		*/
53 
54 #define	HANDLE_SIGNALS	0x01
55 #define	NO_TTY		0x02
56 #define	EDIT_DISABLED	0x04
57 #define	UNBUFFERED	0x08
58 
59 typedef int bool_t;			/* True or not			*/
60 
61 typedef unsigned char el_action_t;	/* Index to command array	*/
62 
63 typedef struct coord_t {		/* Position on the screen	*/
64 	int	h;
65 	int	v;
66 } coord_t;
67 
68 typedef struct el_line_t {
69 	char	*buffer;		/* Input line			*/
70 	char	*cursor;		/* Cursor position		*/
71 	char	*lastchar;		/* Last character		*/
72 	const char	*limit;		/* Max position			*/
73 } el_line_t;
74 
75 /*
76  * Editor state
77  */
78 typedef struct el_state_t {
79 	int		inputmode;	/* What mode are we in?		*/
80 	int		doingarg;	/* Are we getting an argument?	*/
81 	int		argument;	/* Numeric argument		*/
82 	int		metanext;	/* Is the next char a meta char */
83 	el_action_t	lastcmd;	/* Previous command		*/
84 	el_action_t	thiscmd;	/* this command 		*/
85 	char		thisch;		/* char that generated it	*/
86 } el_state_t;
87 
88 /*
89  * Until we come up with something better...
90  */
91 #define	el_strdup(a)	strdup(a)
92 #define	el_malloc(a)	malloc(a)
93 #define	el_realloc(a,b)	realloc(a, b)
94 #define	el_free(a)	free(a)
95 
96 #include "tty.h"
97 #include "prompt.h"
98 #include "key.h"
99 #include "term.h"
100 #include "refresh.h"
101 #include "chared.h"
102 #include "common.h"
103 #include "search.h"
104 #include "hist.h"
105 #include "map.h"
106 #include "parse.h"
107 #include "sig.h"
108 #include "help.h"
109 #include "read.h"
110 
111 struct editline {
112 	char		 *el_prog;	/* the program name		*/
113 	FILE		 *el_infile;	/* Stdio stuff			*/
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 	int		  el_errno;	/* Local copy of errno		*/
119 	coord_t		  el_cursor;	/* Cursor location		*/
120 	char		**el_display;	/* Real screen image = what is there */
121 	char		**el_vdisplay;	/* Virtual screen image = what we see */
122 	void		 *el_data;	/* Client data			*/
123 	el_line_t	  el_line;	/* The current line information	*/
124 	el_state_t	  el_state;	/* Current editor state		*/
125 	el_term_t	  el_term;	/* Terminal dependent stuff	*/
126 	el_tty_t	  el_tty;	/* Tty dependent stuff		*/
127 	el_refresh_t	  el_refresh;	/* Refresh stuff		*/
128 	el_prompt_t	  el_prompt;	/* Prompt stuff			*/
129 	el_prompt_t	  el_rprompt;	/* Prompt stuff			*/
130 	el_chared_t	  el_chared;	/* Characted editor stuff	*/
131 	el_map_t	  el_map;	/* Key mapping stuff		*/
132 	el_key_t	  el_key;	/* Key binding stuff		*/
133 	el_history_t	  el_history;	/* History stuff		*/
134 	el_search_t	  el_search;	/* Search stuff			*/
135 	el_signal_t	  el_signal;	/* Signal handling stuff	*/
136 	el_read_t	  el_read;	/* Character reading stuff	*/
137 };
138 
139 protected int	el_editmode(EditLine *, int, const char **);
140 
141 #ifdef DEBUG
142 #define	EL_ABORT(a)	do { \
143 				fprintf(el->el_errfile, "%s, %d: ", \
144 					 __FILE__, __LINE__); \
145 				fprintf a; \
146 				abort(); \
147 			} while( /*CONSTCOND*/0);
148 #else
149 #define EL_ABORT(a)	abort()
150 #endif
151 #endif /* _h_el */
152