Annotation of src/usr.bin/m4/mdef.h, Revision 1.24
1.24 ! espie 1: /* $OpenBSD: mdef.h,v 1.23 2003/06/03 02:56:10 millert Exp $ */
1.2 deraadt 2: /* $NetBSD: mdef.h,v 1.7 1996/01/13 23:25:27 pk Exp $ */
1.1 deraadt 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.
1.23 millert 19: * 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 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: */
1.24 ! espie 37:
! 38: #ifdef __GNUC__
! 39: # define UNUSED __attribute__((__unused__))
! 40: #else
! 41: # define UNUSED
! 42: #endif
1.1 deraadt 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
1.10 espie 77: #define SELFTYPE 34
1.14 espie 78: #define INDIRTYPE 35
79: #define BUILTINTYPE 36
80: #define PATSTYPE 37
81: #define FILENAMETYPE 38
82: #define LINETYPE 39
83: #define REGEXPTYPE 40
1.17 espie 84: #define ESYSCMDTYPE 41
1.21 espie 85: #define TRACEONTYPE 42
86: #define TRACEOFFTYPE 43
87:
1.1 deraadt 88:
1.9 espie 89: #define TYPEMASK 63 /* Keep bits really corresponding to a type. */
90: #define RECDEF 256 /* Pure recursive def, don't expand it */
1.11 espie 91: #define NOARGS 512 /* builtin needs no args */
92: #define NEEDARGS 1024 /* mark builtin that need args with this */
1.1 deraadt 93:
94: /*
95: * m4 special characters
96: */
97:
98: #define ARGFLAG '$'
99: #define LPAREN '('
100: #define RPAREN ')'
101: #define LQUOTE '`'
102: #define RQUOTE '\''
103: #define COMMA ','
104: #define SCOMMT '#'
105: #define ECOMMT '\n'
106:
107: #ifdef msdos
108: #define system(str) (-1)
109: #endif
110:
111: /*
112: * other important constants
113: */
114:
1.5 espie 115: #define EOS '\0'
1.6 espie 116: #define MAXINP 10 /* maximum include files */
117: #define MAXOUT 10 /* maximum # of diversions */
118: #define BUFSIZE 4096 /* starting size of pushback buffer */
1.15 espie 119: #define INITSTACKMAX 4096 /* starting size of call stack */
1.16 espie 120: #define STRSPMAX 4096 /* starting size of string space */
1.18 espie 121: #define MAXTOK 512 /* maximum chars in a tokn */
1.6 espie 122: #define HASHSIZE 199 /* maximum size of hashtab */
123: #define MAXCCHARS 5 /* max size of comment/quote delim */
1.1 deraadt 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:
136: typedef struct ndblock *ndptr;
137:
1.9 espie 138: struct ndblock { /* hastable structure */
139: char *name; /* entry name.. */
140: char *defn; /* definition.. */
141: unsigned int type; /* type of the entry.. */
142: unsigned int hv; /* hash function value.. */
143: ndptr nxtptr; /* link to next entry.. */
1.1 deraadt 144: };
145:
146: #define nil ((ndptr) 0)
147:
148: struct keyblk {
149: char *knam; /* keyword name */
150: int ktyp; /* keyword type */
151: };
152:
153: typedef union { /* stack structure */
154: int sfra; /* frame entry */
155: char *sstr; /* string entry */
156: } stae;
157:
1.12 espie 158: struct input_file {
159: FILE *file;
160: char *name;
161: unsigned long lineno;
1.22 espie 162: unsigned long synch_lineno; /* used for -s */
1.12 espie 163: int c;
164: };
165:
166: #define CURRENT_NAME (infile[ilevel].name)
167: #define CURRENT_LINE (infile[ilevel].lineno)
1.1 deraadt 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: */
1.12 espie 175: #define gpbc() (bp > bufbase) ? *--bp : obtain_char(infile+ilevel)
1.15 espie 176: #define pushf(x) \
177: do { \
178: if (++sp == STACKMAX) \
179: enlarge_stack();\
180: mstack[sp].sfra = (x); \
181: sstack[sp] = 0; \
1.20 espie 182: } while (0)
1.15 espie 183:
184: #define pushs(x) \
185: do { \
186: if (++sp == STACKMAX) \
187: enlarge_stack();\
188: mstack[sp].sstr = (x); \
189: sstack[sp] = 1; \
1.20 espie 190: } while (0)
1.15 espie 191:
192: #define pushs1(x) \
193: do { \
194: if (++sp == STACKMAX) \
195: enlarge_stack();\
196: mstack[sp].sstr = (x); \
197: sstack[sp] = 0; \
1.20 espie 198: } while (0)
1.1 deraadt 199:
200: /*
201: * . .
202: * | . | <-- sp | . |
203: * +-------+ +-----+
204: * | arg 3 ----------------------->| str |
205: * +-------+ | . |
206: * | arg 2 ---PREVEP-----+ .
207: * +-------+ |
208: * . | | |
209: * +-------+ | +-----+
210: * | plev | PARLEV +-------->| str |
211: * +-------+ | . |
212: * | type | CALTYP .
213: * +-------+
214: * | prcf ---PREVFP--+
215: * +-------+ |
216: * | . | PREVSP |
217: * . |
218: * +-------+ |
219: * | <----------+
220: * +-------+
221: *
222: */
223: #define PARLEV (mstack[fp].sfra)
224: #define CALTYP (mstack[fp-1].sfra)
1.15 espie 225: #define PREVEP (mstack[fp+3].sstr)
1.1 deraadt 226: #define PREVSP (fp-3)
227: #define PREVFP (mstack[fp-2].sfra)