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