Annotation of src/usr.bin/m4/mdef.h, Revision 1.17
1.17 ! espie 1: /* $OpenBSD: mdef.h,v 1.16 2000/07/04 17:28:38 espie 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.
19: * 3. All advertising materials mentioning features or use of this software
20: * must display the following acknowledgement:
21: * This product includes software developed by the University of
22: * California, Berkeley and its contributors.
23: * 4. Neither the name of the University nor the names of its contributors
24: * may be used to endorse or promote products derived from this software
25: * without specific prior written permission.
26: *
27: * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30: * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37: * SUCH DAMAGE.
38: *
39: * @(#)mdef.h 8.1 (Berkeley) 6/6/93
40: */
41:
42: #define MACRTYPE 1
43: #define DEFITYPE 2
44: #define EXPRTYPE 3
45: #define SUBSTYPE 4
46: #define IFELTYPE 5
47: #define LENGTYPE 6
48: #define CHNQTYPE 7
49: #define SYSCTYPE 8
50: #define UNDFTYPE 9
51: #define INCLTYPE 10
52: #define SINCTYPE 11
53: #define PASTTYPE 12
54: #define SPASTYPE 13
55: #define INCRTYPE 14
56: #define IFDFTYPE 15
57: #define PUSDTYPE 16
58: #define POPDTYPE 17
59: #define SHIFTYPE 18
60: #define DECRTYPE 19
61: #define DIVRTYPE 20
62: #define UNDVTYPE 21
63: #define DIVNTYPE 22
64: #define MKTMTYPE 23
65: #define ERRPTYPE 24
66: #define M4WRTYPE 25
67: #define TRNLTYPE 26
68: #define DNLNTYPE 27
69: #define DUMPTYPE 28
70: #define CHNCTYPE 29
71: #define INDXTYPE 30
72: #define SYSVTYPE 31
73: #define EXITTYPE 32
74: #define DEFNTYPE 33
1.10 espie 75: #define SELFTYPE 34
1.14 espie 76: #define INDIRTYPE 35
77: #define BUILTINTYPE 36
78: #define PATSTYPE 37
79: #define FILENAMETYPE 38
80: #define LINETYPE 39
81: #define REGEXPTYPE 40
1.17 ! espie 82: #define ESYSCMDTYPE 41
1.1 deraadt 83:
1.9 espie 84: #define TYPEMASK 63 /* Keep bits really corresponding to a type. */
85: #define STATIC 128 /* Name is statically allocated, don't free. */
86: #define RECDEF 256 /* Pure recursive def, don't expand it */
1.11 espie 87: #define NOARGS 512 /* builtin needs no args */
88: #define NEEDARGS 1024 /* mark builtin that need args with this */
1.1 deraadt 89:
90: /*
91: * m4 special characters
92: */
93:
94: #define ARGFLAG '$'
95: #define LPAREN '('
96: #define RPAREN ')'
97: #define LQUOTE '`'
98: #define RQUOTE '\''
99: #define COMMA ','
100: #define SCOMMT '#'
101: #define ECOMMT '\n'
102:
103: #ifdef msdos
104: #define system(str) (-1)
105: #endif
106:
107: /*
108: * other important constants
109: */
110:
1.5 espie 111: #define EOS '\0'
1.6 espie 112: #define MAXINP 10 /* maximum include files */
113: #define MAXOUT 10 /* maximum # of diversions */
114: #define MAXSTR 512 /* maximum size of string */
115: #define BUFSIZE 4096 /* starting size of pushback buffer */
1.15 espie 116: #define INITSTACKMAX 4096 /* starting size of call stack */
1.16 espie 117: #define STRSPMAX 4096 /* starting size of string space */
1.6 espie 118: #define MAXTOK MAXSTR /* maximum chars in a tokn */
119: #define HASHSIZE 199 /* maximum size of hashtab */
120: #define MAXCCHARS 5 /* max size of comment/quote delim */
1.1 deraadt 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:
133: typedef struct ndblock *ndptr;
134:
1.9 espie 135: struct ndblock { /* hastable structure */
136: char *name; /* entry name.. */
137: char *defn; /* definition.. */
138: unsigned int type; /* type of the entry.. */
139: unsigned int hv; /* hash function value.. */
140: ndptr nxtptr; /* link to next entry.. */
1.1 deraadt 141: };
142:
143: #define nil ((ndptr) 0)
144:
145: struct keyblk {
146: char *knam; /* keyword name */
147: int ktyp; /* keyword type */
148: };
149:
150: typedef union { /* stack structure */
151: int sfra; /* frame entry */
152: char *sstr; /* string entry */
153: } stae;
154:
1.12 espie 155: struct input_file {
156: FILE *file;
157: char *name;
158: unsigned long lineno;
159: int c;
160: };
161:
162: #define CURRENT_NAME (infile[ilevel].name)
163: #define CURRENT_LINE (infile[ilevel].lineno)
1.1 deraadt 164: /*
165: * macros for readibility and/or speed
166: *
167: * gpbc() - get a possibly pushed-back character
168: * pushf() - push a call frame entry onto stack
169: * pushs() - push a string pointer onto stack
170: */
1.12 espie 171: #define gpbc() (bp > bufbase) ? *--bp : obtain_char(infile+ilevel)
1.15 espie 172: #define pushf(x) \
173: do { \
174: if (++sp == STACKMAX) \
175: enlarge_stack();\
176: mstack[sp].sfra = (x); \
177: sstack[sp] = 0; \
178: } while (0);
179:
180: #define pushs(x) \
181: do { \
182: if (++sp == STACKMAX) \
183: enlarge_stack();\
184: mstack[sp].sstr = (x); \
185: sstack[sp] = 1; \
186: } while (0);
187:
188: #define pushs1(x) \
189: do { \
190: if (++sp == STACKMAX) \
191: enlarge_stack();\
192: mstack[sp].sstr = (x); \
193: sstack[sp] = 0; \
194: } while (0);
1.1 deraadt 195:
196: /*
197: * . .
198: * | . | <-- sp | . |
199: * +-------+ +-----+
200: * | arg 3 ----------------------->| str |
201: * +-------+ | . |
202: * | arg 2 ---PREVEP-----+ .
203: * +-------+ |
204: * . | | |
205: * +-------+ | +-----+
206: * | plev | PARLEV +-------->| str |
207: * +-------+ | . |
208: * | type | CALTYP .
209: * +-------+
210: * | prcf ---PREVFP--+
211: * +-------+ |
212: * | . | PREVSP |
213: * . |
214: * +-------+ |
215: * | <----------+
216: * +-------+
217: *
218: */
219: #define PARLEV (mstack[fp].sfra)
220: #define CALTYP (mstack[fp-1].sfra)
1.15 espie 221: #define PREVEP (mstack[fp+3].sstr)
1.1 deraadt 222: #define PREVSP (fp-3)
223: #define PREVFP (mstack[fp-2].sfra)