1/*	$OpenBSD: mdef.h,v 1.33 2015/11/03 16:21:47 deraadt Exp $	*/
2/*	$NetBSD: mdef.h,v 1.7 1996/01/13 23:25:27 pk Exp $	*/
3
4/*-
5 * SPDX-License-Identifier: BSD-3-Clause
6 *
7 * Copyright (c) 1989, 1993
8 *	The Regents of the University of California.  All rights reserved.
9 *
10 * This code is derived from software contributed to Berkeley by
11 * Ozan Yigit at York University.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 * 1. Redistributions of source code must retain the above copyright
17 *    notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 *    notice, this list of conditions and the following disclaimer in the
20 *    documentation and/or other materials provided with the distribution.
21 * 3. Neither the name of the University nor the names of its contributors
22 *    may be used to endorse or promote products derived from this software
23 *    without specific prior written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * SUCH DAMAGE.
36 */
37
38#ifdef __GNUC__
39# define UNUSED	__attribute__((__unused__))
40#else
41# define UNUSED
42#endif
43
44#define MACRTYPE        1
45#define DEFITYPE        2
46#define EXPRTYPE        3
47#define SUBSTYPE        4
48#define IFELTYPE        5
49#define LENGTYPE        6
50#define CHNQTYPE        7
51#define SYSCTYPE        8
52#define UNDFTYPE        9
53#define INCLTYPE        10
54#define SINCTYPE        11
55#define PASTTYPE        12
56#define SPASTYPE        13
57#define INCRTYPE        14
58#define IFDFTYPE        15
59#define PUSDTYPE        16
60#define POPDTYPE        17
61#define SHIFTYPE        18
62#define DECRTYPE        19
63#define DIVRTYPE        20
64#define UNDVTYPE        21
65#define DIVNTYPE        22
66#define MKTMTYPE        23
67#define ERRPTYPE        24
68#define M4WRTYPE        25
69#define TRNLTYPE        26
70#define DNLNTYPE        27
71#define DUMPTYPE        28
72#define CHNCTYPE        29
73#define INDXTYPE        30
74#define SYSVTYPE        31
75#define EXITTYPE        32
76#define DEFNTYPE        33
77#define SELFTYPE	34
78#define INDIRTYPE	35
79#define BUILTINTYPE	36
80#define PATSTYPE	37
81#define FILENAMETYPE	38
82#define LINETYPE	39
83#define REGEXPTYPE	40
84#define ESYSCMDTYPE	41
85#define TRACEONTYPE	42
86#define TRACEOFFTYPE	43
87#define FORMATTYPE	44
88
89#define BUILTIN_MARKER	"__builtin_"
90
91#define TYPEMASK	63	/* Keep bits really corresponding to a type. */
92#define RECDEF		256	/* Pure recursive def, don't expand it */
93#define NOARGS		512	/* builtin needs no args */
94#define NEEDARGS	1024	/* mark builtin that need args with this */
95
96/*
97 * m4 special characters
98 */
99
100#define ARGFLAG         '$'
101#define LPAREN          '('
102#define RPAREN          ')'
103#define LQUOTE          '`'
104#define RQUOTE          '\''
105#define COMMA           ','
106#define SCOMMT          '#'
107#define ECOMMT          '\n'
108
109/*
110 * other important constants
111 */
112
113#define EOS             '\0'
114#define MAXINP          10              /* maximum include files	    */
115#define MAXOUT          10              /* maximum # of diversions	    */
116#define BUFSIZE         4096            /* starting size of pushback buffer */
117#define INITSTACKMAX    4096		/* starting size of call stack      */
118#define STRSPMAX        4096            /* starting size of string space    */
119#define MAXTOK          512		/* maximum chars in a tokn	    */
120#define MAXCCHARS	5		/* max size of comment/quote delim  */
121
122#define ALL             1
123#define TOP             0
124
125#define TRUE            1
126#define FALSE           0
127#define cycle           for(;;)
128
129/*
130 * m4 data structures
131 */
132
133typedef struct ndblock *ndptr;
134
135struct macro_definition {
136	struct macro_definition *next;
137	char		*defn;	/* definition..               */
138	unsigned int	type;	/* type of the entry..        */
139};
140
141
142struct ndblock {			/* hashtable structure         */
143	unsigned int		builtin_type;
144	unsigned int		trace_flags;
145	struct macro_definition *d;
146	char		name[1];	/* entry name..               */
147};
148
149typedef union {			/* stack structure */
150	int	sfra;		/* frame entry  */
151	char	*sstr;		/* string entry */
152} stae;
153
154struct input_file {
155	FILE		*file;
156	char		*name;
157	unsigned long	lineno;
158	unsigned long   synch_lineno;	/* used for -s */
159	int		c;
160};
161
162#define STORAGE_STRSPACE 0
163#define STORAGE_MACRO 1
164#define STORAGE_OTHER 2
165
166#define CURRENT_NAME	(infile[ilevel].name)
167#define CURRENT_LINE	(infile[ilevel].lineno)
168/*
169 * macros for readibility and/or speed
170 *
171 *      gpbc()  - get a possibly pushed-back character
172 *      pushf() - push a call frame entry onto stack
173 *      pushs() - push a string pointer onto stack
174 */
175#define gpbc()	 (bp > bufbase) ? *--bp : obtain_char(infile+ilevel)
176#define pushf(x)			\
177	do {				\
178		if (++sp == (int)STACKMAX)	\
179			enlarge_stack();\
180		mstack[sp].sfra = (x);	\
181		sstack[sp] = STORAGE_OTHER; \
182	} while (0)
183
184#define pushs(x)			\
185	do {				\
186		if (++sp == (int)STACKMAX)	\
187			enlarge_stack();\
188		mstack[sp].sstr = (x);	\
189		sstack[sp] = STORAGE_STRSPACE; \
190	} while (0)
191
192#define pushs1(x)			\
193	do {				\
194		if (++sp == (int)STACKMAX)	\
195			enlarge_stack();\
196		mstack[sp].sstr = (x);	\
197		sstack[sp] = STORAGE_OTHER; \
198	} while (0)
199
200#define pushdef(p)			\
201	do {				\
202		if (++sp == (int)STACKMAX)	\
203			enlarge_stack();\
204		mstack[sp].sstr = macro_getdef(p)->defn;\
205		sstack[sp] = STORAGE_MACRO; \
206	} while (0)
207
208
209/*
210 *	    .				   .
211 *	|   .	|  <-- sp		|  .  |
212 *	+-------+			+-----+
213 *	| arg 3 ----------------------->| str |
214 *	+-------+			|  .  |
215 *	| arg 2 ---PREVEP-----+		   .
216 *	+-------+	      |
217 *	    .		      |		|     |
218 *	+-------+	      |		+-----+
219 *	| plev	|  PARLEV     +-------->| str |
220 *	+-------+			|  .  |
221 *	| type	|  CALTYP		   .
222 *	+-------+
223 *	| prcf	---PREVFP--+
224 *	+-------+	   |
225 *	|   .	|  PREVSP  |
226 *	    .		   |
227 *	+-------+	   |
228 *	|	<----------+
229 *	+-------+
230 *
231 */
232#define PARLEV  (mstack[fp].sfra)
233#define CALTYP  (mstack[fp-2].sfra)
234#define TRACESTATUS (mstack[fp-1].sfra)
235#define PREVEP	(mstack[fp+3].sstr)
236#define PREVSP	(fp-4)
237#define PREVFP	(mstack[fp-3].sfra)
238