xref: /freebsd/contrib/libedit/el.h (revision e6bfd18d21b225af6a0ed67ceeaf1293b7b9eba5)
1 /*	$NetBSD: el.h,v 1.46 2021/08/15 10:08:41 christos Exp $	*/
2 
3 /*-
4  * Copyright (c) 1992, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Christos Zoulas of Cornell University.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *	@(#)el.h	8.1 (Berkeley) 6/4/93
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 "histedit.h"
50 #include "chartype.h"
51 
52 #define	EL_BUFSIZ	((size_t)1024)	/* Maximum line size		*/
53 
54 #define	HANDLE_SIGNALS	0x001
55 #define	NO_TTY		0x002
56 #define	EDIT_DISABLED	0x004
57 #define	UNBUFFERED	0x008
58 #define	NARROW_HISTORY	0x040
59 #define	NO_RESET	0x080
60 #define	FIXIO		0x100
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 	wchar_t		*buffer;	/* Input line			*/
71 	wchar_t	        *cursor;	/* Cursor position		*/
72 	wchar_t	        *lastchar;	/* Last character		*/
73 	const wchar_t	*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 	wchar_t		thisch;		/* char that generated it	*/
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_calloc(a,b)	calloc(a, b)
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 "literal.h"
100 #include "keymacro.h"
101 #include "terminal.h"
102 #include "refresh.h"
103 #include "chared.h"
104 #include "search.h"
105 #include "hist.h"
106 #include "map.h"
107 #include "sig.h"
108 
109 struct el_read_t;
110 
111 struct editline {
112 	wchar_t		 *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_outfd;	/* Output file descriptor	*/
118 	int		  el_errfd;	/* Error file descriptor	*/
119 	int		  el_flags;	/* Various flags.		*/
120 	coord_t		  el_cursor;	/* Cursor location		*/
121 	wint_t		**el_display;	/* Real screen image = what is there */
122 	wint_t		**el_vdisplay;	/* Virtual screen image = what we see */
123 	void		 *el_data;	/* Client data			*/
124 	el_line_t	  el_line;	/* The current line information	*/
125 	el_state_t	  el_state;	/* Current editor state		*/
126 	el_terminal_t	  el_terminal;	/* Terminal dependent stuff	*/
127 	el_tty_t	  el_tty;	/* Tty dependent stuff		*/
128 	el_refresh_t	  el_refresh;	/* Refresh stuff		*/
129 	el_prompt_t	  el_prompt;	/* Prompt stuff			*/
130 	el_prompt_t	  el_rprompt;	/* Prompt stuff			*/
131 	el_literal_t	  el_literal;	/* prompt literal bits		*/
132 	el_chared_t	  el_chared;	/* Characted editor stuff	*/
133 	el_map_t	  el_map;	/* Key mapping stuff		*/
134 	el_keymacro_t	  el_keymacro;	/* Key binding stuff		*/
135 	el_history_t	  el_history;	/* History stuff		*/
136 	el_search_t	  el_search;	/* Search stuff			*/
137 	el_signal_t	  el_signal;	/* Signal handling stuff	*/
138 	struct el_read_t *el_read;	/* Character reading stuff	*/
139 	ct_buffer_t       el_visual;    /* Buffer for displayable str	*/
140 	ct_buffer_t       el_scratch;   /* Scratch conversion buffer    */
141 	ct_buffer_t       el_lgcyconv;  /* Buffer for legacy wrappers   */
142 	LineInfo          el_lgcylinfo; /* Legacy LineInfo buffer       */
143 };
144 
145 libedit_private int	el_editmode(EditLine *, int, const wchar_t **);
146 libedit_private EditLine *el_init_internal(const char *, FILE *, FILE *,
147     FILE *, int, int, int, int);
148 
149 #ifdef DEBUG
150 #define	EL_ABORT(a)	do { \
151 				fprintf(el->el_errfile, "%s, %d: ", \
152 					 __FILE__, __LINE__); \
153 				fprintf a; \
154 				abort(); \
155 			} while( /*CONSTCOND*/0);
156 #else
157 #define EL_ABORT(a)	abort()
158 #endif
159 #endif /* _h_el */
160