Forced commit:
[dragonfly.git] / bin / ed / ed.h
CommitLineData
984263bc
MD
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: src/bin/ed/ed.h,v 1.13.2.1 2001/08/01 02:36:03 obrien Exp $
ea391a08 29 * $DragonFly: src/bin/ed/ed.h,v 1.7 2004/09/26 16:32:47 asmodai Exp $
984263bc
MD
30 */
31
32#include <sys/param.h>
33#include <errno.h>
34#include <limits.h>
35#include <regex.h>
36#include <signal.h>
37#include <stdio.h>
38#include <stdlib.h>
39#include <string.h>
40#include <unistd.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
61typedef regex_t pattern_t;
62
63/* Line node */
64typedef 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
72typedef 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() \
100if (--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 sprintf(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) \
118if ((i) > (n)) { \
119 int 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 sprintf(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 sprintf(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) \
144if ((i) > (n)) { \
145 int 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 sprintf(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#ifdef sun
180# define strerror(n) sys_errlist[n]
181#endif
182
984263bc 183/* Local Function Declarations */
9dbf638f
DR
184void add_line_node (line_t *);
185int append_lines (long);
186int apply_subst_template (char *, regmatch_t *, int, int);
187int build_active_list (int);
188int cbc_decode (char *, FILE *);
189int cbc_encode (char *, int, FILE *);
190int check_addr_range (long, long);
191void clear_active_list (void);
192void clear_undo_stack (void);
193int close_sbuf (void);
194int copy_lines (long);
195int delete_lines (long, long);
c443019b 196void des_error (const char *);
9dbf638f
DR
197int display_lines (long, long, int);
198line_t *dup_line_node (line_t *);
199int exec_command (void);
200long exec_global (int, int);
201void expand_des_key (char *, char *);
202int extract_addr_range (void);
203char *extract_pattern (int);
204int extract_subst_tail (int *, long *);
205char *extract_subst_template (void);
206int filter_lines (long, long, char *);
207int flush_des_file (FILE *);
208line_t *get_addressed_line_node (long);
209pattern_t *get_compiled_pattern (void);
210int get_des_char (FILE *);
211char *get_extended_line (int *, int);
212char *get_filename (void);
213int get_keyword (void);
214long get_line_node_addr (line_t *);
215long get_matching_node_addr (pattern_t *, int);
216long get_marked_node_addr (int);
217char *get_sbuf_line (line_t *);
218int get_shell_command (void);
219int get_stream_line (FILE *);
220int get_tty_line (void);
221void handle_hup (int);
222void handle_int (int);
223void handle_winch (int);
224int has_trailing_escape (char *, char *);
225int hex_to_binary (int, int);
226void init_buffers (void);
227void init_des_cipher (void);
228int is_legal_filename (char *);
229int join_lines (long, long);
230int mark_line_node (line_t *, int);
231int move_lines (long);
c443019b 232line_t *next_active_node (void);
9dbf638f
DR
233long next_addr (void);
234int open_sbuf (void);
235char *parse_char_class (char *);
236int pop_undo_stack (void);
237undo_t *push_undo_stack (int, long, long);
238int put_des_char (int, FILE *);
239char *put_sbuf_line (char *);
240int put_stream_line (FILE *, char *, int);
241int put_tty_line (char *, int, long, int);
242void quit (int);
243long read_file (char *, long);
244long read_stream (FILE *, long);
245int search_and_replace (pattern_t *, int, int);
246int set_active_node (line_t *);
247void set_des_key (char *);
248void signal_hup (int);
249void signal_int (int);
c443019b 250char *strip_escapes (const char *);
9dbf638f
DR
251int substitute_matching_text (pattern_t *, line_t *, int, int);
252char *translit_text (char *, int, int, int);
253void unmark_line_node (line_t *);
254void unset_active_nodes (line_t *, line_t *);
c443019b 255long write_file (const char *, const char *, long, long);
9dbf638f 256long write_stream (FILE *, long, long);
984263bc
MD
257
258/* global buffers */
259extern char stdinbuf[];
260extern char *ibuf;
261extern char *ibufp;
262extern int ibufsz;
263
264/* global flags */
265extern int isbinary;
266extern int isglobal;
267extern int modified;
268extern int mutex;
269extern int sigflags;
270
271/* global vars */
272extern long addr_last;
c196ede8 273extern long u_addr_last;
984263bc 274extern long current_addr;
c196ede8 275extern long u_current_addr;
984263bc
MD
276extern char errmsg[];
277extern long first_addr;
278extern int lineno;
279extern long second_addr;
280#ifdef sun
281extern char *sys_errlist[];
282#endif