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