xref: /freebsd/usr.bin/sed/defs.h (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1992 Diomidis Spinellis.
5  * Copyright (c) 1992, 1993
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * This code is derived from software contributed to Berkeley by
9  * Diomidis Spinellis of Imperial College, University of London.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. Neither the name of the University nor the names of its contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  */
35 
36 /*
37  * Types of address specifications
38  */
39 enum e_atype {
40 	AT_RE	    = 1,			/* Line that match RE */
41 	AT_LINE,				/* Specific line */
42 	AT_RELLINE,				/* Relative line */
43 	AT_LAST,				/* Last line */
44 };
45 
46 /*
47  * Format of an address
48  */
49 struct s_addr {
50 	enum e_atype type;			/* Address type */
51 	union {
52 		u_long l;			/* Line number */
53 		regex_t *r;			/* Regular expression */
54 	} u;
55 };
56 
57 /*
58  * Substitution command
59  */
60 struct s_subst {
61 	int n;					/* Occurrence to subst. */
62 	int p;					/* True if p flag */
63 	int icase;				/* True if I flag */
64 	char *wfile;				/* NULL if no wfile */
65 	int wfd;				/* Cached file descriptor */
66 	regex_t *re;				/* Regular expression */
67 	unsigned int maxbref;			/* Largest backreference. */
68 	u_long linenum;				/* Line number. */
69 	char *new;				/* Replacement text */
70 };
71 
72 /*
73  * Translate command.
74  */
75 struct s_tr {
76 	unsigned char bytetab[256];
77 	struct trmulti {
78 		size_t fromlen;
79 		char from[MB_LEN_MAX];
80 		size_t tolen;
81 		char to[MB_LEN_MAX];
82 	} *multis;
83 	int nmultis;
84 };
85 
86 /*
87  * An internally compiled command.
88  * Initially, label references are stored in t, on a second pass they
89  * are updated to pointers.
90  */
91 struct s_command {
92 	struct s_command *next;			/* Pointer to next command */
93 	struct s_addr *a1, *a2;			/* Start and end address */
94 	u_long startline;			/* Start line number or zero */
95 	char *t;				/* Text for : a c i r w */
96 	union {
97 		struct s_command *c;		/* Command(s) for b t { */
98 		struct s_subst *s;		/* Substitute command */
99 		struct s_tr *y;			/* Replace command array */
100 		int fd;				/* File descriptor for w */
101 	} u;
102 	char code;				/* Command code */
103 	u_int nonsel:1;				/* True if ! */
104 };
105 
106 /*
107  * Types of command arguments recognised by the parser
108  */
109 enum e_args {
110 	EMPTY,			/* d D g G h H l n N p P q x = \0 */
111 	TEXT,			/* a c i */
112 	NONSEL,			/* ! */
113 	GROUP,			/* { */
114 	ENDGROUP,		/* } */
115 	COMMENT,		/* # */
116 	BRANCH,			/* b t */
117 	LABEL,			/* : */
118 	RFILE,			/* r */
119 	WFILE,			/* w */
120 	SUBST,			/* s */
121 	TR			/* y */
122 };
123 
124 /*
125  * Structure containing things to append before a line is read
126  */
127 struct s_appends {
128 	enum {AP_STRING, AP_FILE} type;
129 	char *s;
130 	size_t len;
131 };
132 
133 enum e_spflag {
134 	APPEND,					/* Append to the contents. */
135 	REPLACE,				/* Replace the contents. */
136 };
137 
138 /*
139  * Structure for a space (process, hold, otherwise).
140  */
141 typedef struct {
142 	char *space;		/* Current space pointer. */
143 	size_t len;		/* Current length. */
144 	int deleted;		/* If deleted. */
145 	int append_newline;	/* If originally terminated by \n. */
146 	char *back;		/* Backing memory. */
147 	size_t blen;		/* Backing memory length. */
148 } SPACE;
149