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 *	@(#)mdef.h	8.1 (Berkeley) 6/6/93
38 * $FreeBSD$
39 */
40
41#ifdef __GNUC__
42# define UNUSED	__attribute__((__unused__))
43#else
44# define UNUSED
45#endif
46
47#define MACRTYPE        1
48#define DEFITYPE        2
49#define EXPRTYPE        3
50#define SUBSTYPE        4
51#define IFELTYPE        5
52#define LENGTYPE        6
53#define CHNQTYPE        7
54#define SYSCTYPE        8
55#define UNDFTYPE        9
56#define INCLTYPE        10
57#define SINCTYPE        11
58#define PASTTYPE        12
59#define SPASTYPE        13
60#define INCRTYPE        14
61#define IFDFTYPE        15
62#define PUSDTYPE        16
63#define POPDTYPE        17
64#define SHIFTYPE        18
65#define DECRTYPE        19
66#define DIVRTYPE        20
67#define UNDVTYPE        21
68#define DIVNTYPE        22
69#define MKTMTYPE        23
70#define ERRPTYPE        24
71#define M4WRTYPE        25
72#define TRNLTYPE        26
73#define DNLNTYPE        27
74#define DUMPTYPE        28
75#define CHNCTYPE        29
76#define INDXTYPE        30
77#define SYSVTYPE        31
78#define EXITTYPE        32
79#define DEFNTYPE        33
80#define SELFTYPE	34
81#define INDIRTYPE	35
82#define BUILTINTYPE	36
83#define PATSTYPE	37
84#define FILENAMETYPE	38
85#define LINETYPE	39
86#define REGEXPTYPE	40
87#define ESYSCMDTYPE	41
88#define TRACEONTYPE	42
89#define TRACEOFFTYPE	43
90#define FORMATTYPE	44
91
92#define BUILTIN_MARKER	"__builtin_"
93
94#define TYPEMASK	63	/* Keep bits really corresponding to a type. */
95#define RECDEF		256	/* Pure recursive def, don't expand it */
96#define NOARGS		512	/* builtin needs no args */
97#define NEEDARGS	1024	/* mark builtin that need args with this */
98
99/*
100 * m4 special characters
101 */
102
103#define ARGFLAG         '$'
104#define LPAREN          '('
105#define RPAREN          ')'
106#define LQUOTE          '`'
107#define RQUOTE          '\''
108#define COMMA           ','
109#define SCOMMT          '#'
110#define ECOMMT          '\n'
111
112/*
113 * other important constants
114 */
115
116#define EOS             '\0'
117#define MAXINP          10              /* maximum include files	    */
118#define MAXOUT          10              /* maximum # of diversions	    */
119#define BUFSIZE         4096            /* starting size of pushback buffer */
120#define INITSTACKMAX    4096		/* starting size of call stack      */
121#define STRSPMAX        4096            /* starting size of string space    */
122#define MAXTOK          512		/* maximum chars in a tokn	    */
123#define MAXCCHARS	5		/* max size of comment/quote delim  */
124
125#define ALL             1
126#define TOP             0
127
128#define TRUE            1
129#define FALSE           0
130#define cycle           for(;;)
131
132/*
133 * m4 data structures
134 */
135
136typedef struct ndblock *ndptr;
137
138struct macro_definition {
139	struct macro_definition *next;
140	char		*defn;	/* definition..               */
141	unsigned int	type;	/* type of the entry..        */
142};
143
144
145struct ndblock {			/* hashtable structure         */
146	unsigned int		builtin_type;
147	unsigned int		trace_flags;
148	struct macro_definition *d;
149	char		name[1];	/* entry name..               */
150};
151
152typedef union {			/* stack structure */
153	int	sfra;		/* frame entry  */
154	char	*sstr;		/* string entry */
155} stae;
156
157struct input_file {
158	FILE		*file;
159	char		*name;
160	unsigned long	lineno;
161	unsigned long   synch_lineno;	/* used for -s */
162	int		c;
163};
164
165#define STORAGE_STRSPACE 0
166#define STORAGE_MACRO 1
167#define STORAGE_OTHER 2
168
169#define CURRENT_NAME	(infile[ilevel].name)
170#define CURRENT_LINE	(infile[ilevel].lineno)
171/*
172 * macros for readibility and/or speed
173 *
174 *      gpbc()  - get a possibly pushed-back character
175 *      pushf() - push a call frame entry onto stack
176 *      pushs() - push a string pointer onto stack
177 */
178#define gpbc()	 (bp > bufbase) ? *--bp : obtain_char(infile+ilevel)
179#define pushf(x)			\
180	do {				\
181		if (++sp == (int)STACKMAX)	\
182			enlarge_stack();\
183		mstack[sp].sfra = (x);	\
184		sstack[sp] = STORAGE_OTHER; \
185	} while (0)
186
187#define pushs(x)			\
188	do {				\
189		if (++sp == (int)STACKMAX)	\
190			enlarge_stack();\
191		mstack[sp].sstr = (x);	\
192		sstack[sp] = STORAGE_STRSPACE; \
193	} while (0)
194
195#define pushs1(x)			\
196	do {				\
197		if (++sp == (int)STACKMAX)	\
198			enlarge_stack();\
199		mstack[sp].sstr = (x);	\
200		sstack[sp] = STORAGE_OTHER; \
201	} while (0)
202
203#define pushdef(p)			\
204	do {				\
205		if (++sp == (int)STACKMAX)	\
206			enlarge_stack();\
207		mstack[sp].sstr = macro_getdef(p)->defn;\
208		sstack[sp] = STORAGE_MACRO; \
209	} while (0)
210
211
212/*
213 *	    .				   .
214 *	|   .	|  <-- sp		|  .  |
215 *	+-------+			+-----+
216 *	| arg 3 ----------------------->| str |
217 *	+-------+			|  .  |
218 *	| arg 2 ---PREVEP-----+		   .
219 *	+-------+	      |
220 *	    .		      |		|     |
221 *	+-------+	      |		+-----+
222 *	| plev	|  PARLEV     +-------->| str |
223 *	+-------+			|  .  |
224 *	| type	|  CALTYP		   .
225 *	+-------+
226 *	| prcf	---PREVFP--+
227 *	+-------+	   |
228 *	|   .	|  PREVSP  |
229 *	    .		   |
230 *	+-------+	   |
231 *	|	<----------+
232 *	+-------+
233 *
234 */
235#define PARLEV  (mstack[fp].sfra)
236#define CALTYP  (mstack[fp-2].sfra)
237#define TRACESTATUS (mstack[fp-1].sfra)
238#define PREVEP	(mstack[fp+3].sstr)
239#define PREVSP	(fp-4)
240#define PREVFP	(mstack[fp-3].sfra)
241