xref: /freebsd/bin/ed/ed.h (revision 5df6aca10906f669bc7095ff735eba6b8fe95ff0)
1 /* ed.h: type and constant definitions for the ed editor. */
2 /*-
3  * SPDX-License-Identifier: BSD-2-Clause
4  *
5  * Copyright (c) 1993 Andrew Moore
6  * All rights reserved.
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  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #include <sys/param.h>
31 #include <errno.h>
32 #include <limits.h>
33 #include <regex.h>
34 #include <signal.h>
35 #include <stdio.h>
36 #include <stdlib.h>
37 #include <string.h>
38 #include <unistd.h>
39 #include <wchar.h>
40 #include <wctype.h>
41 
42 #define ERR		(-2)
43 #define EMOD		(-3)
44 #define FATAL		(-4)
45 
46 #define MINBUFSZ 512		/* minimum buffer size - must be > 0 */
47 #define SE_MAX 30		/* max subexpressions in a regular expression */
48 #ifdef INT_MAX
49 # define LINECHARS INT_MAX	/* max chars per line */
50 #else
51 # define LINECHARS MAXINT	/* max chars per line */
52 #endif
53 
54 /* gflags */
55 #define GLB 001		/* global command */
56 #define GPR 002		/* print after command */
57 #define GLS 004		/* list after command */
58 #define GNP 010		/* enumerate after command */
59 #define GSG 020		/* global substitute */
60 
61 typedef regex_t pattern_t;
62 
63 /* Line node */
64 typedef struct	line {
65 	struct line	*q_forw;
66 	struct line	*q_back;
67 	off_t		seek;		/* address of line in scratch buffer */
68 	int		len;		/* length of line */
69 } line_t;
70 
71 
72 typedef struct undo {
73 
74 /* type of undo nodes */
75 #define UADD	0
76 #define UDEL 	1
77 #define UMOV	2
78 #define VMOV	3
79 
80 	int type;			/* command type */
81 	line_t	*h;			/* head of list */
82 	line_t  *t;			/* tail of list */
83 } undo_t;
84 
85 #ifndef max
86 # define max(a,b) ((a) > (b) ? (a) : (b))
87 #endif
88 #ifndef min
89 # define min(a,b) ((a) < (b) ? (a) : (b))
90 #endif
91 
92 #define INC_MOD(l, k)	((l) + 1 > (k) ? 0 : (l) + 1)
93 #define DEC_MOD(l, k)	((l) - 1 < 0 ? (k) : (l) - 1)
94 
95 /* SPL1: disable some interrupts (requires reliable signals) */
96 #define SPL1() mutex++
97 
98 /* SPL0: enable all interrupts; check sigflags (requires reliable signals) */
99 #define SPL0() \
100 if (--mutex == 0) { \
101 	if (sigflags & (1 << (SIGHUP - 1))) handle_hup(SIGHUP); \
102 	if (sigflags & (1 << (SIGINT - 1))) handle_int(SIGINT); \
103 }
104 
105 /* STRTOL: convert a string to long */
106 #define STRTOL(i, p) { \
107 	if (((i = strtol(p, &p, 10)) == LONG_MIN || i == LONG_MAX) && \
108 	    errno == ERANGE) { \
109 		errmsg = "number out of range"; \
110 	    	i = 0; \
111 		return ERR; \
112 	} \
113 }
114 
115 #if defined(sun) || defined(NO_REALLOC_NULL)
116 /* REALLOC: assure at least a minimum size for buffer b */
117 #define REALLOC(b,n,i,err) \
118 if ((i) > (n)) { \
119 	size_t ti = (n); \
120 	char *ts; \
121 	SPL1(); \
122 	if ((b) != NULL) { \
123 		if ((ts = (char *) realloc((b), ti += max((i), MINBUFSZ))) == NULL) { \
124 			fprintf(stderr, "%s\n", strerror(errno)); \
125 			errmsg = "out of memory"; \
126 			SPL0(); \
127 			return err; \
128 		} \
129 	} else { \
130 		if ((ts = (char *) malloc(ti += max((i), MINBUFSZ))) == NULL) { \
131 			fprintf(stderr, "%s\n", strerror(errno)); \
132 			errmsg = "out of memory"; \
133 			SPL0(); \
134 			return err; \
135 		} \
136 	} \
137 	(n) = ti; \
138 	(b) = ts; \
139 	SPL0(); \
140 }
141 #else /* NO_REALLOC_NULL */
142 /* REALLOC: assure at least a minimum size for buffer b */
143 #define REALLOC(b,n,i,err) \
144 if ((i) > (n)) { \
145 	size_t ti = (n); \
146 	char *ts; \
147 	SPL1(); \
148 	if ((ts = (char *) realloc((b), ti += max((i), MINBUFSZ))) == NULL) { \
149 		fprintf(stderr, "%s\n", strerror(errno)); \
150 		errmsg = "out of memory"; \
151 		SPL0(); \
152 		return err; \
153 	} \
154 	(n) = ti; \
155 	(b) = ts; \
156 	SPL0(); \
157 }
158 #endif /* NO_REALLOC_NULL */
159 
160 /* REQUE: link pred before succ */
161 #define REQUE(pred, succ) (pred)->q_forw = (succ), (succ)->q_back = (pred)
162 
163 /* INSQUE: insert elem in circular queue after pred */
164 #define INSQUE(elem, pred) \
165 { \
166 	REQUE((elem), (pred)->q_forw); \
167 	REQUE((pred), elem); \
168 }
169 
170 /* REMQUE: remove_lines elem from circular queue */
171 #define REMQUE(elem) REQUE((elem)->q_back, (elem)->q_forw);
172 
173 /* NUL_TO_NEWLINE: overwrite ASCII NULs with newlines */
174 #define NUL_TO_NEWLINE(s, l) translit_text(s, l, '\0', '\n')
175 
176 /* NEWLINE_TO_NUL: overwrite newlines with ASCII NULs */
177 #define NEWLINE_TO_NUL(s, l) translit_text(s, l, '\n', '\0')
178 
179 
180 /* Local Function Declarations */
181 void add_line_node(line_t *);
182 int append_lines(long);
183 int apply_subst_template(const char *, regmatch_t *, int, int);
184 int build_active_list(int);
185 int cbc_decode(unsigned char *, FILE *);
186 int cbc_encode(unsigned char *, int, FILE *);
187 int check_addr_range(long, long);
188 void clear_active_list(void);
189 void clear_undo_stack(void);
190 int close_sbuf(void);
191 int copy_lines(long);
192 int delete_lines(long, long);
193 int display_lines(long, long, int);
194 line_t *dup_line_node(line_t *);
195 int exec_command(void);
196 long exec_global(int, int);
197 int extract_addr_range(void);
198 char *extract_pattern(int);
199 int extract_subst_tail(int *, long *);
200 char *extract_subst_template(void);
201 int filter_lines(long, long, char *);
202 line_t *get_addressed_line_node(long);
203 pattern_t *get_compiled_pattern(void);
204 char *get_extended_line(int *, int);
205 char *get_filename(void);
206 int get_keyword(void);
207 long get_line_node_addr(line_t *);
208 long get_matching_node_addr(pattern_t *, int);
209 long get_marked_node_addr(int);
210 char *get_sbuf_line(line_t *);
211 int get_shell_command(void);
212 int get_stream_line(FILE *);
213 int get_tty_line(void);
214 void handle_hup(int);
215 void handle_int(int);
216 void handle_winch(int);
217 int has_trailing_escape(char *, char *);
218 int hex_to_binary(int, int);
219 void init_buffers(void);
220 int is_legal_filename(char *);
221 int join_lines(long, long);
222 int mark_line_node(line_t *, int);
223 int move_lines(long);
224 line_t *next_active_node(void);
225 long next_addr(void);
226 int open_sbuf(void);
227 char *parse_char_class(char *);
228 int pop_undo_stack(void);
229 undo_t *push_undo_stack(int, long, long);
230 const char *put_sbuf_line(const char *);
231 int put_stream_line(FILE *, const char *, int);
232 int put_tty_line(const char *, int, long, int);
233 void quit(int);
234 long read_file(char *, long);
235 long read_stream(FILE *, long);
236 int search_and_replace(pattern_t *, int, int);
237 int set_active_node(line_t *);
238 void signal_hup(int);
239 void signal_int(int);
240 char *strip_escapes(char *);
241 int substitute_matching_text(pattern_t *, line_t *, int, int);
242 char *translit_text(char *, int, int, int);
243 void unmark_line_node(line_t *);
244 void unset_active_nodes(line_t *, line_t *);
245 long write_file(char *, const char *, long, long);
246 long write_stream(FILE *, long, long);
247 
248 /* global buffers */
249 extern char stdinbuf[];
250 extern char *ibuf;
251 extern char *ibufp;
252 extern int ibufsz;
253 
254 /* global flags */
255 extern int isbinary;
256 extern int isglobal;
257 extern int modified;
258 extern int mutex;
259 extern int sigflags;
260 
261 /* global vars */
262 extern long addr_last;
263 extern long current_addr;
264 extern const char *errmsg;
265 extern long first_addr;
266 extern int lineno;
267 extern long second_addr;
268 extern long u_addr_last;
269 extern long u_current_addr;
270 extern long rows;
271 extern int cols;
272 extern int newline_added;
273 extern int scripted;
274 extern int patlock;
275